Tests for backend code use Pytest and are organized in the backend/test directory
with subdirectories that mirror the package structure.
The file backend/test/conftest.py defines fixtures for automatically setting up and tearing down a test database for backend services to use.
At present, we do not have automated front-end testing instrumented; this remains a goal.
The pytest command-line program will run all tests in the command-line.
To see print output, run Pytest with the special extra output flag pytest -rP.
To limit the scope of your tests to a specific file, include the path to the file following the command, eg:
pytest backend/test/services/user_test.py
To run a specific test within a test suite, use the -k option of pytest to match all or part of the filtered test name(s):
pytest backend/test/services/user_test.py -k test_get
VSCode's Python plugin has great support for testing. Click the test tube icon, configure VSCode to use Pytest and select the workspace.
When you refresh, you will see tests you can run individually, or in the debugger and with breakpoints. When you encounter a bug or failing test and having a difficult time pinning down exactly why it is failing, developing the instinct to run the test in the VSCode debugger, setting a break point, and stepping through is encouraged.
For more, see the official documentation.
We expect 100% test coverage of backend services code and as much coverage for other code in the backend.
To generate a test coverage report, run the following command in your development container:
pytest --cov-report html:coverage --cov=backend/services backend/test/services
This command generates a directory with an HTML report. To view it, on your host machine, open the coverage directory's index.html file. Click on the service file you are working on to see the lines not covered by test cases if you are below 100%. After adding test cases that cover the missing lines, rerun the coverage command to generate a new report and confirm your progress.