bellingcat/auto-archiver
1
0
Fork 0
mirror of https://github.com/bellingcat/auto-archiver.git synced 2026-06-11 04:38:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Use a script to auto-generate documentation for the core modules from the manifest file

Browse Source
This commit is contained in:
Patrick Robertson
2025-02-10 22:51:04 +00:00
parent 824728739a
commit 2650cd8fb2
19 changed files with 216 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/source/development/testing.md
View File

@@ -1,13 +1,21 @@
### Testing
# Testing
Tests are split using `pytest.mark` into 'core' and 'download' tests. Download tests will hit the network and make API calls (e.g. Twitter, Bluesky etc.) and should be run regularly to make sure that APIs have not changed.
`pytest` is used for testing. There are two main types of tests:
Tests can be run as follows:
1. 'core' tests which should be run on every change
2. 'download' tests which hit the network. These tests will do things like make API calls (e.g. Twitter, Bluesky etc.) and should be run regularly to make sure that APIs have not changed.
## Running Tests
1. Make sure you've installed the dev dependencies with `pytest install --with dev`
2. Tests can be run as follows:
```
#### Command prefix of 'poetry run' removed here for simplicity
# run core tests
pytest -ra -v -m "not download" # or poetry run pytest -ra -v -m "not download"
pytest -ra -v -m "not download"
# run download tests
pytest -ra -v -m "download" # or poetry run pytest -ra -v -m "download"
pytest -ra -v -m "download"
# run all tests
pytest -ra -v # or poetry run pytest -ra -v
pytest -ra -v
```