Skip to content

Commit 9612ec9

Browse files
committed
Update documentation for security tests
- Added instructions on how to run security tests locally. - Explained the automated testssl.sh dependency management. - Noted the CI trigger condition (including 'security_test' in commit/PR).
1 parent c7bc7b2 commit 9612ec9

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

deluge/tests/test_security.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,6 @@ def testssl_bin():
7272
return str(testssl_sh)
7373

7474

75-
# TODO: This whole module has not been tested since migrating tests fully to pytest
7675
class SecurityBaseTestCase:
7776
@pytest.fixture(autouse=True)
7877
def setvars(self, testssl_bin):

docs/source/contributing/testing.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,16 @@ Running the tests for a specific plugin (requires [pytest](https://pypi.python.o
2020

2121
pytest deluge/plugins/<name-of-plugin>
2222

23+
### Security
24+
25+
Running the security tests requires `testssl.sh`. The test suite will automatically manage this dependency by cloning the repository into `deluge/tests/data/testssl_repo` if it is missing.
26+
27+
To run the security tests locally:
28+
29+
SECURITY_TESTS=true pytest deluge/tests/test_security.py
30+
31+
In CI (GitHub Actions), these tests are skipped by default to save time. To trigger them, include `security_test` in your commit message or pull request body.
32+
2333
## Tox
2434

2535
All the tests for Deluge can be run using [Tox](https://pypi.python.org/pypi/tox)

0 commit comments

Comments
 (0)