From 4ba61a3fdfb8d5335dea24d9fef2d6cde69ad0cc Mon Sep 17 00:00:00 2001 From: khushi Date: Thu, 27 Mar 2025 18:45:32 +0530 Subject: [PATCH] Update README.md --- test/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/test/README.md b/test/README.md index d04a607a4a..66961d22b7 100644 --- a/test/README.md +++ b/test/README.md @@ -178,3 +178,16 @@ pytest -v test/test_checkers.py -k python ## Known issues If you're using Windows and plan to run PDF tests, we **strongly** recommend also `pdftotext`. We experienced problems running tests without this. The best approach to do this is through [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/windows.html) (click [here](https://anaconda.org/conda-forge/pdftotext) to find out how to install this package with conda). + + +## Code Coverage + +Code coverage helps ensure that our tests cover a sufficient portion of the codebase. +Our goal is to maintain at least **80% coverage** as reported by our coverage tools. + +### Running Coverage Locally + +To check coverage locally, use: + +```bash +pytest --cov=cve_bin_tool --cov-report=html test/{TEST_FILE}.py