Install and configure pytest-cov to measure/report coverage

microbiomedata · Jul 15, 2024 · 95e9705 · 95e9705
1 parent e897827
commit 95e9705
Show file tree

Hide file tree

Showing 3 changed files with 96 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -13,6 +13,9 @@ __pycache__
 # Performance profiling files.
 /*.prof
 
+# File generated by `coverage` package.
+/.coverage
+
 # Schema files.
 /*.yaml
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -39,11 +39,18 @@ pyinstrument = "^4.6.2"
 # Usage: $ poetry run pytest
 # Docs: https://docs.pytest.org/en/stable/contents.html
 pytest = "^8.2.2"
+pytest-cov = "^5.0.0"
 
 [tool.poetry.scripts]
 # Reference: https://python-poetry.org/docs/pyproject#scripts
 refscan = "refscan.refscan:app"
 
+[tool.pytest.ini_options]
+# Make it so that, when `$ poetry run pytest` runs, in addition to running the tests, it
+# also (via the `pytest-cov` plugin) measures test coverage of the source code directory.
+# Reference: https://pytest-cov.readthedocs.io/en/latest/config.html#configuration
+addopts = "--cov=refscan"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"