Testing
How to run tests locally.
When a PR is submitted, a series of tests will be run with Github actions. Our tests can be categorised into two:
Backend / Python tests
Frontend tests with Cypress, Selenium and Jest
It is fine to just submit your PR and let the tests run on Github. However, if the tests fail, you may need to run the tests locally to investigate what's going on, then either fix the tests, or fix your code.
Running Python Tests Locally
To run Python tests, simply run at the top folder of the repository:
The pytest command will run both the tests written with pytest and those with the built-in python unittest.
We are aiming to migrate all unittest to pytest. Meanwhile you will see a combination of these. If you write new tests, please use pytest.
For Rapid Router and Portal, pytest also runs Selenium tests. Check the section below for what you need to install to run it.
The Python tests in Portal also include some snapshot tests.
Running pytest will also automatically run the snapshot tests. When needed, the snapshot tests can be updated by running pytest --snapshot-update.
Running Cypress tests locally
Cypress is a frontend test framework that is used on Kurono (aimmo) and part of Portal.
To run Cypress tests locally, you need two shell windows.
Shell #1
The following will run the portal/game on local server.
In aimmo:
In Portal:
Shell #2
This will run the Cypress tests in the terminal.
In aimmo:
In Portal:
If you want to view the tests as they run using Cypress' test runner window, you can run:
Running Selenium tests locally
Selenium is a frontend test framework that is used in Rapid Router and in Portal. We aim to gradually migrate Selenium tests to Cypress.
To run Selenium tests you need to install chromedriver. Please check here on how to install for your OS.
Similar with Cypress, it will launch a browser windows and you should be able to see a series of frontend actions.
Running Jest tests locally
Aimmo also includes some JavaScript frontend tests written in the Jest framework.
These can be run locally with the following:
If needed, the snapshot tests can be updated with the following:
Last updated