doc: run tests with code coverage (#50921)

License: MIT
This commit is contained in:
Loïc Dachary 2021-02-06 14:40:00 +01:00 committed by Benjamin Dauvergne
parent 27c3efc615
commit 0e2117c0aa
1 changed files with 11 additions and 1 deletions

View File

@ -33,10 +33,10 @@ Run the tests
$ echo layout python3 > authentic/.envrc
$ direnv allow authentic
$ cd authentic
$ pip install tox
2. Run::
$ pip install tox
$ pg_virtualenv tox
.. note::
@ -44,6 +44,16 @@ Run the tests
`tests/test_ldap.py` will fail if `apparmor_status` reports that
`/usr/sbin/slapd` is in enforce mode.
2. Run with code coverage::
$ pg_virtualenv tox < /dev/null
$ firefox htmlcov/index.html
.. note::
When running from an interactive shell `< /dev/null` unsets
the `tty` tox sub-type and defines the `COVERAGE` variable.
Build the documentation
=======================