Make sure you've installed the requirements in requirements-dev.txt, set up a virtual environment, and started Studio's necessary services (postgres, minio, and redis). Then you may use the following command to run backend/Python tests:
make test
Make sure you've installed all frontend requirements (yarn install). Then you may use the following command to run all frontend tests:
yarn run test
You may run either of the above in docker by using docker-compose run studio-app. For example:
docker-compose run studio-app make test
docker-compose run studio-app yarn run test
You may run arbitrary commands in the docker container, including customized test runs like those below, by prepending docker-compose run studio-app to the command.
The Python backend tests use the pytest runner. With the pytest.ini configuration, the command to run these tests is very simple:
pytest
By default, pytest is configured to recreate a fresh database every time. This can be painfully slow! To speed things up, you can ask pytest to recycle table structures between runs:
pytest --reuse-db
To execute a subset of all tests, like a specific test you're modifying, you have a couple of options at your disposal. First, pytest will accept a path to a test file or directory which limits execution to only those tests in the file path:
pytest contentcuration/contentcuration/tests/test_utils.py
Another option is to use the -k switch to filter by matching test names. For instance, to only run the test_we_are_testing in contentcuration/contentcuration/tests/test_utils.py:
pytest -k test_we_are_testing
Or slightly faster if you know which file the test lives:
pytest -k test_we_are_testing contentcuration/contentcuration/tests/test_utils.py
Lastly, sometimes it's nice to use print statements in your tests or code to see what's going on. pytest disables print statements by default, but you can disable pytest suppression of those messages by passing -s to pytest.
For running tests continuously during development, pytest-watch is included. This works well with the --reuse-db option:
ptw contentcuration -- --reuse-db
The JavaScript tests use the jest test runner. The yarn run test command automatically includes the jest configuration in its invocation of tests. To execute a subset of all tests, like a specific test you're modifying, you may pass along a file path:
yarn run test contentcuration/contentcuration/frontend/shared/utils/helpers.spec.js
For running tests continuously during development, we have yarn script which will watch for file changes and re-execute tests when they change:
yarn run test-jest:dev
This also supports only a subset of tests, like passing a file:
yarn run test-jest:dev contentcuration/contentcuration/frontend/shared/utils/helpers.spec.js