test: update 'scripts/run_tests' to generate coverage/lcov.info

Author: feeph

.gitignore

@@ -50,6 +50,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+coverage/
 tests/coverage_report/
 
 # Translations

pdm.lock

@@ -97,13 +97,14 @@ source-includes = ["tests/"]
 dev = [
 ]
 tools = [
-    "autopep8     ~= 2.2",
-    "copier       ~= 9.3",
-    "flake8       ~= 7.0",
-    "mypy         ~= 1.10",
-    "pylint       ~= 3.2",
-    "pytest-cov   ~= 5.0",
-    "pytest-sugar ~= 1.0",
+    "autopep8      ~= 2.2",
+    "copier        ~= 9.3",
+    "coverage-lcov ~= 0.3",
+    "flake8        ~= 7.0",
+    "mypy          ~= 1.10",
+    "pylint        ~= 3.2",
+    "pytest-cov    ~= 5.0",
+    "pytest-sugar  ~= 1.0",
 ]
 
 # during development: fetch all packages in our namespace from TestPyPI

pyproject.toml

@@ -10,6 +10,9 @@ astroid==3.2.4 \
 autopep8==2.3.1 \
     --hash=sha256:8d6c87eba648fdcfc83e29b788910b8643171c395d9c4bcf115ece035b9c9dda \
     --hash=sha256:a203fe0fcad7939987422140ab17a930f684763bf7335bdb6709991dd7ef6c2d
+click==8.1.7 \
+    --hash=sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28 \
+    --hash=sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de
 colorama==0.4.6 \
     --hash=sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44 \
     --hash=sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6
@@ -49,6 +52,9 @@ coverage==7.6.1 \
     --hash=sha256:f5796e664fe802da4f57a168c85359a8fbf3eab5e55cd4e4569fbacecc903959 \
     --hash=sha256:fc5a77d0c516700ebad189b587de289a20a78324bc54baee03dd486f0855d234 \
     --hash=sha256:fd21f6ae3f08b41004dfb433fa895d858f3f5979e7762d052b12aef444e29afc
+coverage-lcov==0.3.0 \
+    --hash=sha256:0b352da0c72eacd555de2e10fa75ec165b8849ab6827218abc3ef6be2ec861f6 \
+    --hash=sha256:23ae34a535f1ed3fa4cdf9682f6c1fe1a40aa98c94aa05614512dbf2da82e749
 coverage[toml]==7.6.1 \
     --hash=sha256:07e2ca0ad381b91350c0ed49d52699b625aab2b44b65e1b4e02fa9df0e92ad2d \
     --hash=sha256:0c0420b573964c760df9e9e86d1a9a622d0d27f417e1a949a8a66dd7bcee7bc6 \

requirements-dev.txt

@@ -23,6 +23,21 @@ if [[ -n $FILES ]] ; then
     pdm run mypy $FILES
 fi
 
+# Generate a coverage report in lcov format even if pytest fails due to
+# lacking coverage. The report can then be used by an IDE to indicate
+# coverage directly in your editor window. Special care must be taken
+# when working on code that isn't covered by unit tests.
+#
+# recommended extension for VS Code:
+# https://marketplace.visualstudio.com/items?itemName=markis.code-coverage
+generate_lcov() {
+    mkdir -p coverage
+    pdm run coverage-lcov --output_file_path=coverage/lcov.info
+}
+trap generate_lcov EXIT
+
+pdm run pytest --cov=feeph.i2c --cov-report= tests/
+
 echo "----------------------------------------------------------------------"
 echo "If you reached this far you passed. Congratulations!"
 echo "----------------------------------------------------------------------"