doc: coverage instructions

This commit is contained in:
Éloi Rivard 2023-08-17 14:39:50 +02:00
parent 6e9f1ac0ad
commit b213610903
No known key found for this signature in database
GPG key ID: 7EDA204EA57DD184

View file

@ -113,10 +113,11 @@ Unit tests
To run the tests, you just can run `poetry run pytest` and/or `tox` to test all the supported python environments. To run the tests, you just can run `poetry run pytest` and/or `tox` to test all the supported python environments.
Everything must be green before patches get merged. Everything must be green before patches get merged.
To test a specific backend you can pass `--backend memory` or `--backend ldap` to pytest and tox. To test a specific backend you can pass ``--backend memory`` or ``--backend ldap`` to pytest and tox.
The test coverage is 100%, patches won't be accepted if not entirely covered. You can check the The test coverage is 100%, patches won't be accepted if not entirely covered. You can check the
test coverage with ``tox -e coverage``. test coverage with ``poetry run pytest --cov --cov-report=html`` or ``tox -e coverage -- --cov-report=html``.
You can check the HTML coverage report in the newly created `htmlcov` directory.
Code style Code style
---------- ----------