Skip to content

Commit cc39ea7

Browse files
authored
Merge pull request #13 from didx-xyz/improvement/test_controllers
Add readme to tests
2 parents b729fcd + 80d84f8 commit cc39ea7

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

tests/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
### Running tests locally
2+
3+
In order to run the tests locally, e.g. for development, make sure you have installed the requirements by running `pip install -r requirements.txt` in the root of the project.
4+
5+
You can now run all tests py running `pytest` in the root of the project. in order to run specific tests you can specifying the test file to run, e.g. `pytest tests/path/to/your/testfile.py`. You can also run individual tests only using the `-k` flag of pytest `pytest tests/path/to/your/testfile.py -k 'test_your_whatever'` where `test_your_whatever` is the name of the test definition. For more information, please, refer to the [pytest docs](https://docs.pytest.org/en/).
6+
7+
It is recommended to run the tests locally (and to add tests to your chnages and code additions). Tests will automatically run when trying to merge into or push to master. The merge or push will be rejected if any test fails.

0 commit comments

Comments
 (0)