auto-archiver/docs/source/development/testing.md

# Testing

`pytest` is used for testing. There are two main types of tests:

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"
# run download tests
pytest -ra -v -m "download"
# run all tests
pytest -ra -v
```
Use a script to auto-generate documentation for the core modules from the manifest file 2025-02-10 22:51:04 +00:00			`# Testing`
Start fleshing out the docs more - rearrange, separate out modules section, move files over to md (from rst) 2025-02-10 16:24:16 +00:00
Use a script to auto-generate documentation for the core modules from the manifest file 2025-02-10 22:51:04 +00:00			`pytest` is used for testing. There are two main types of tests:
Start fleshing out the docs more - rearrange, separate out modules section, move files over to md (from rst) 2025-02-10 16:24:16 +00:00
Use a script to auto-generate documentation for the core modules from the manifest file 2025-02-10 22:51:04 +00:00			`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:`
Start fleshing out the docs more - rearrange, separate out modules section, move files over to md (from rst) 2025-02-10 16:24:16 +00:00			```
Use a script to auto-generate documentation for the core modules from the manifest file 2025-02-10 22:51:04 +00:00			`#### Command prefix of 'poetry run' removed here for simplicity`
Start fleshing out the docs more - rearrange, separate out modules section, move files over to md (from rst) 2025-02-10 16:24:16 +00:00			`# run core tests`
Use a script to auto-generate documentation for the core modules from the manifest file 2025-02-10 22:51:04 +00:00			`pytest -ra -v -m "not download"`
Start fleshing out the docs more - rearrange, separate out modules section, move files over to md (from rst) 2025-02-10 16:24:16 +00:00			`# run download tests`
Use a script to auto-generate documentation for the core modules from the manifest file 2025-02-10 22:51:04 +00:00			`pytest -ra -v -m "download"`
Start fleshing out the docs more - rearrange, separate out modules section, move files over to md (from rst) 2025-02-10 16:24:16 +00:00			`# run all tests`
Use a script to auto-generate documentation for the core modules from the manifest file 2025-02-10 22:51:04 +00:00			`pytest -ra -v`
Start fleshing out the docs more - rearrange, separate out modules section, move files over to md (from rst) 2025-02-10 16:24:16 +00:00			```