add coverage tool for #44

ModischFabrications · Mar 30, 2024 · 55e0e52 · 55e0e52
1 parent c3a0362
commit 55e0e52
Show file tree

Hide file tree

Showing 3 changed files with 79 additions and 2 deletions.
diff --git a/Pipfile b/Pipfile
@@ -11,6 +11,7 @@ GitPython = "==3.1.41"
 flake8 = "==7.0.0"
 httpx = "==0.26.0"
 black = "==24.3.0"
+pytest-cov = "==5.0.0"
 
 [packages]
 fastapi = "==0.109.1"

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -75,7 +75,14 @@ to run manually.
 
 Change version number in main.py:version for newer releases, git tags will be created automatically.
 
-Remember to test your changes using `pytest [--durations=5]`.
+### Testing
+
+Remember to test your changes using `pytest`. This will happen automatically both in pre-commit and in CI/CD, but manual
+tests will reduce iteration times.
+
+Code coverage and runtimes can be checked
+using `pipenv run python -m pytest --durations=5 --cov=app/ --cov-report term-missing`.
+Make sure that all critical parts of the code are covered, at v1.0.1 it is at 94%.
 
 ### Development Docker Images