Skip to content

Commit bd06769

Browse files
docs: add code coverage documentation to test README
Signed-off-by: Anand Krishnan PK <anandkrishnanpk20031@gmail.com>
1 parent 9134fc4 commit bd06769

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

doc/test/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,24 @@ You can also use all the pytest functionality to run groups of tests. For exampl
174174
```console
175175
pytest -v test/test_checkers.py -k python
176176
```
177+
## Running Code Coverage
178+
179+
The project uses `pytest-cov` for code coverage measurement.
180+
181+
To run the test suite with coverage enabled:
182+
183+
```console
184+
pytest --cov
185+
```
186+
187+
To generate a coverage report in XML format:
188+
189+
```console
190+
pytest --cov --cov-report=xml
191+
```
192+
193+
Coverage settings are configured in `pyproject.toml`. The coverage configuration measures both the `cve_bin_tool` and `test` packages and includes branch coverage.
194+
177195

178196
## Known issues
179197

0 commit comments

Comments
 (0)