CodeMirror
/
bulk-downloader-for-reddit
mirror of
1
0
Fork 0
Code Issues Releases Wiki Activity

CONTRIBUTING.md: explain test_config.cfg (#294)

This commit is contained in:
Ali Parlakçı 2021-04-20 23:26:45 +03:00 committed by GitHub
parent aa43ebd1b8
commit bd5afe5333
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/CONTRIBUTING.md
View File

@ -104,7 +104,13 @@ To exclude one or more marks, the following command can be used, substituting th
pytest -m "not online"
pytest -m "not reddit and not authenticated"
```
### Configuration for authenticated tests
There should be configuration file `test_config.cfg` in the project's root directory to be able to run the integration tests with reddit authentication. See how to create such files [here](../README.md#configuration). The easiest way of creating this file is copying your existing `default_config.cfg` file from the path stated in the previous link and renaming it to `test_config.cfg` Be sure that user_token key exists in test_config.cfg.
---
For more details, review the pytest documentation that is freely available online.
Many IDEs also provide integrated functionality to run and display the results from tests, and almost all of them support pytest in some capacity. This would be the recommended method due to the additional debugging and general capabilities.