mirror of
https://github.com/GSA/notifications-api.git
synced 2026-08-21 14:59:26 -04:00
update readme and ensure makefile up to date
This commit is contained in:
13
README.md
13
README.md
@@ -105,17 +105,20 @@ That will run pycodestyle for code analysis and our unit test suite. If you wish
|
||||
|
||||
|
||||
|
||||
## To remove functional test data
|
||||
## To run one off tasks
|
||||
|
||||
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.
|
||||
Tasks are run through the `flask` command - run `flask --help` for more information. There are two sections we need to
|
||||
care about: `flask db` contains alembic migration commands, and `flask command` contains all of our custom commands. For
|
||||
example, to purge all dynamically generated functional test data, do the following:
|
||||
|
||||
Locally
|
||||
```
|
||||
python application.py purge_functional_test_data -u <functional tests user name prefix> # Remove the user and associated services.
|
||||
flask command purge_functional_test_data -u <functional tests user name prefix>
|
||||
```
|
||||
|
||||
On the server
|
||||
```
|
||||
python server_commands.py purge_functional_test_data -u <functional tests user name prefix> # Remove the user and associated services.
|
||||
cf run-task notify-api "flask command purge_functional_test_data -u <functional tests user name prefix>"
|
||||
```
|
||||
|
||||
All commands and command options have a --help command if you need more information.
|
||||
|
||||
Reference in New Issue
Block a user