From 2e2851dc13d73352530dd4495c7e05603b2e520d Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 10 Apr 2024 23:38:38 +0200 Subject: Adding upstream version 2.1.2~dev0+20240219. Signed-off-by: Daniel Baumann --- docs/source/contributing/testing.md | 50 +++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 docs/source/contributing/testing.md (limited to 'docs/source/contributing/testing.md') diff --git a/docs/source/contributing/testing.md b/docs/source/contributing/testing.md new file mode 100644 index 0000000..beb30a4 --- /dev/null +++ b/docs/source/contributing/testing.md @@ -0,0 +1,50 @@ +# Running tests + +Testing uses [PyTest] framework and [PyTest-Twisted] to handle Twisted framework. + +## Testing + +The tests are located in the source folder under `deluge/tests`. +The tests are run from the project root directory. +View the unit test coverage at: [deluge-torrent.github.io](http://deluge-torrent.github.io) + +### Pytest + + pytest deluge/tests + pytest deluge/tests/test_client.py + pytest deluge/tests/test_client.py -k test_connect_localclient + +### Plugin + +Running the tests for a specific plugin (requires [pytest](https://pypi.python.org/pypi/pytest)): + + pytest deluge/plugins/ + +## Tox + +All the tests for Deluge can be run using [Tox](https://pypi.python.org/pypi/tox) + +### See available targets: + + tox -l + py3 + lint + docs + +### Run specific test: + + tox -e py3 + +### Verify code with pre-commit: + + tox -e lint + +## CI + +Deluge develop branch is tested automatically by GitHub actions. + +When creating a pull request (PR) on [github], units tests will be automatically be run. + +[github]: https://github.com/deluge-torrent/deluge/pulls +[pytest]: https://docs.pytest.org/en/ +[pytest-twisted]: https://github.com/pytest-dev/pytest-twisted -- cgit v1.2.3