66ffc0e29b
Depends on: https://github.com/alphagov/notifications-aws/pull/905 Previously this would print some custom text with each step, and as optionally loading a virtual environment. This moves the actual test commands to the Makefile. While this no longer prints custom text, it does print the command that was run: Before (skipping other output): ./scripts/run_tests.sh Code style check passed Import order check passed ... JavaScript tests have passed ... Unit tests have passed After (skipping other output): flake8 . isort --check-only ./app ./tests npm test ... py.test -n auto --maxfail=10 tests/ ... I think it's more useful to see the command being run, rather than having to wait until it succeeds to know what was happening. Having the command also makes it easier to run it again if it fails, rather than having to go and find it in a script.
notifications-admin
GOV.UK Notify admin application - https://www.notifications.service.gov.uk/
- Register and manage users
- Create and manage services
- Send batch emails and SMS by uploading a CSV
- Show history of notifications
Setting up
Python version
At the moment we run Python 3.6 in production.
NPM packages
brew install node
NPM is Node's package management tool. n is a tool for managing different versions of Node. The following installs n and uses the long term support (LTS) version of Node.
npm install -g n
n lts
environment.sh
In the root directory of the application, run:
echo "
export NOTIFY_ENVIRONMENT='development'
export FLASK_APP=application.py
export FLASK_ENV=development
export WERKZEUG_DEBUG_PIN=off
"> environment.sh
AWS credentials
To run parts of the app, such as uploading letters, you will need appropriate AWS credentials. See the Wiki for more details.
To run the application
# install dependencies, etc.
make bootstrap
# run the web app
make run-flask
Then visit localhost:6012.
Any Python code changes you make should be picked up automatically in development. If you're developing JavaScript code, run npm run watch to achieve the same.
To test the application
# install dependencies, etc.
make bootstrap
# run all the tests
make test
# continuously run js tests
npm run test-watch
To run a specific JavaScript test, you'll need to copy the full command from package.json.
To update application dependencies
requirements.txt is generated from the requirements.in in order to pin versions of all nested dependencies. If requirements.in has been changed, run make freeze-requirements to regenerate it.