From cce6b7bb5932dbc71dd86a60890f340dce2d99f9 Mon Sep 17 00:00:00 2001 From: Martin Vrachev Date: Thu, 24 Sep 2020 18:48:46 +0300 Subject: [PATCH] Add doc for the possible cmd args while testing This information could be useful for newcomers to better understand how to debug TUF. Signed-off-by: Martin Vrachev --- docs/CONTRIBUTORS.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/CONTRIBUTORS.rst b/docs/CONTRIBUTORS.rst index cc2704f2..410b8305 100644 --- a/docs/CONTRIBUTORS.rst +++ b/docs/CONTRIBUTORS.rst @@ -125,6 +125,26 @@ increase log level up to DEBUG ('-vvvv'). $ python test_updater.py -vvvv TestUpdater.test_4_refresh # run test with DEBUG log level +All of the log levels and the corresponding options that could be used for testing are: + +.. list-table:: + :widths: 20 25 + :header-rows: 1 + + * - Option + - Log Level + * - default (no argument passed) + - ERROR (test names are not printed) + * - `-v` + - ERROR (test names are printed at this level and above) + * - `-vv` + - WARNING + * - `-vvv` + - INFO + * - `-vvvv` + - DEBUG + + To run the tests and measure their code coverage, the aggregation script can be invoked with the ``coverage`` tool (requires installation of ``coverage``, e.g. via PyPI).