mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-22 00:11:16 -05:00
108 lines
3.7 KiB
Markdown
108 lines
3.7 KiB
Markdown
|
|
[](https://requires.io/github/alphagov/notifications-api/requirements/?branch=master)
|
|
|
|
[](https://github.com/alphagov/notifications-api/compare/staging...master?expand=1&title=Deploy%20to%20staging) [](https://github.com/alphagov/notifications-api/compare/live...staging?expand=1&title=Deploy%20to%20live)
|
|
|
|
# notifications-api
|
|
Notifications api
|
|
Application for the notification api.
|
|
|
|
Read and write notifications/status queue.
|
|
Get and update notification status.
|
|
|
|
## Setting Up
|
|
|
|
```
|
|
mkvirtualenv -p /usr/local/bin/python3 notifications-api
|
|
```
|
|
|
|
Creating the environment.sh file. Replace [unique-to-environment] with your something unique to the environment. Your AWS credentials should be set up for notify-tools (the development/CI AWS account).
|
|
|
|
Create a local environment.sh file containing the following:
|
|
|
|
```
|
|
echo "
|
|
export NOTIFY_ENVIRONMENT='development'
|
|
export ADMIN_BASE_URL='http://localhost:6012'
|
|
export ADMIN_CLIENT_USER_NAME='dev-notify-admin'
|
|
export ADMIN_CLIENT_SECRET='dev-notify-secret-key'
|
|
export API_HOST_NAME='http://localhost:6011'
|
|
|
|
export AWS_REGION='eu-west-1'
|
|
export AWS_ACCESS_KEY_ID=[MY ACCESS KEY]
|
|
export AWS_SECRET_ACCESS_KEY=[MY SECRET]
|
|
|
|
export DANGEROUS_SALT='dev-notify-salt'
|
|
export FIRETEXT_API_KEY=[contact team member for api key]
|
|
export FROM_NUMBER='40605'
|
|
export INVITATION_EMAIL_FROM='invites'
|
|
export INVITATION_EXPIRATION_DAYS=2
|
|
export MMG_API_KEY=mmg=secret-key
|
|
export MMG_URL="https://api.mmg.co.uk/json/api.php"
|
|
export NOTIFICATION_QUEUE_PREFIX='[unique-to-environment]' #
|
|
export NOTIFY_EMAIL_DOMAIN='notify.tools'
|
|
export SECRET_KEY='dev-notify-secret-key'
|
|
export SQLALCHEMY_DATABASE_URI='postgresql://localhost/notification_api'
|
|
export STATSD_ENABLED=True
|
|
export STATSD_HOST="localhost"
|
|
export STATSD_PORT=1000
|
|
export STATSD_PREFIX="stats-prefix"
|
|
"> environment.sh
|
|
```
|
|
|
|
NOTE: The SECRET_KEY and DANGEROUS_SALT should match those in the [notifications-admin](https://github.com/alphagov/notifications-admin) app.
|
|
|
|
NOTE: Also note the unique prefix for the queue names. This prevents clashing with others queues in shared amazon environment and using a prefix enables filtering by queue name in the SQS interface.
|
|
|
|
|
|
|
|
## To run the application
|
|
|
|
You need to run the api application and a local celery instance.
|
|
|
|
There are two run scripts for running all the necessary parts.
|
|
|
|
```
|
|
scripts/run_app.sh
|
|
```
|
|
|
|
```
|
|
scripts/run_celery.sh
|
|
```
|
|
|
|
```
|
|
scripts/run_celery_beat.sh
|
|
```
|
|
|
|
|
|
|
|
## To test the application
|
|
|
|
First, ensure that `scripts/boostrap.sh` has been run, as it creates the test database.
|
|
|
|
Then simply run
|
|
|
|
```
|
|
make test
|
|
```
|
|
|
|
That will run pep8 for code analysis and our unit test suite. If you wish to run our functional tests, instructions can be found in the
|
|
[notifications-functional-test](https://github.com/alphagov/notifications-functional-test) repository.
|
|
|
|
|
|
|
|
## To remove functional test data
|
|
|
|
NOTE: There is assumption that both the server name prefix and user name prefix are followed by a uuid.
|
|
The script will search for all services/users with that prefix and only remove it if the prefix is followed by a uuid otherwise it will be skipped.
|
|
|
|
Locally
|
|
```
|
|
python application.py purge_functional_test_data -u <functional tests user name prefix> # Remove the user and associated services.
|
|
```
|
|
|
|
On the server
|
|
```
|
|
python server_commands.py purge_functional_test_data -u <functional tests user name prefix> # Remove the user and associated services.
|
|
```
|