#397: Fixed handling empty coverage (#398)

* #397: Fixed handling empty coverage
* project:fix
* Ignored failure when reporting empty coverage
* moved double dash to front
* Updated template for file .gitignore

Co-authored-by: Ariel Schulz <43442541+ArBridgeman@users.noreply.github.com>

Author: ckunki

.github/workflows/report.yml

@@ -52,6 +52,6 @@ jobs:
           poetry run -- nox -s project:report -- --format markdown >> $GITHUB_STEP_SUMMARY
           poetry run -- nox -s dependency:licenses >> $GITHUB_STEP_SUMMARY
           echo -e "\n\n# Coverage\n" >> $GITHUB_STEP_SUMMARY
-          poetry run coverage report -- --format markdown >> $GITHUB_STEP_SUMMARY
+          poetry run -- coverage report --format markdown >> $GITHUB_STEP_SUMMARY || true
           poetry run -- tbx lint pretty-print >> $GITHUB_STEP_SUMMARY
           poetry run -- tbx security pretty-print .security.json >> $GITHUB_STEP_SUMMARY

doc/changes/unreleased.md

@@ -1 +1,5 @@
 # Unreleased
+
+## Bugfixes
+
+* #397: Fix handling empty coverage

exasol/toolbox/metrics.py

@@ -1,6 +1,8 @@
 import datetime
 import json
 import re
+import subprocess
+import sys
 from collections import defaultdict
 from dataclasses import (
     asdict,
@@ -13,7 +15,6 @@
 from functools import singledispatch
 from inspect import cleandoc
 from pathlib import Path
-from subprocess import run
 from tempfile import TemporaryDirectory
 from typing import (
     Any,
@@ -104,11 +105,23 @@ def total_coverage(file: Union[str, Path]) -> float:
     with TemporaryDirectory() as tmpdir:
         tmp_dir = Path(tmpdir)
         report = tmp_dir / "coverage.json"
-        run(
+        p = subprocess.run(
             ["coverage", "json", f"--data-file={file}", "-o", f"{report}"],
             capture_output=True,
-            check=True,
+            check=False,
+            encoding="utf-8",
         )
+        stdout = p.stdout.strip()
+        if (p.returncode == 1) and (stdout == "No data to report."):
+            print(
+                f"The following command"
+                f" returned non-zero exit status {p.returncode}:\n"
+                f'  {" ".join(p.args)}\n'
+                f"{stdout}\n"
+                "Returning total coverage 100 %.",
+                file=sys.stderr,
+            )
+            return 100.0
         with open(report, encoding="utf-8") as r:
             data = json.load(r)
             total: float = data["totals"]["percent_covered"]

exasol/toolbox/templates/github/workflows/report.yml

@@ -31,7 +31,7 @@ jobs:
           # Errors during copying are ignored because they are checked in the next step
           cp .coverage ../ || true
           cp lint-python3.9/.lint.txt ../ || true
-          cp lint-python3.9/.lint.txt ../ || true
+          cp lint-python3.9/.lint.json ../ || true
           cp security-python3.9/.security.json ../ || true
 
       - name: Validate Artifacts
@@ -52,6 +52,6 @@ jobs:
           poetry run -- nox -s project:report -- --format markdown >> $GITHUB_STEP_SUMMARY
           poetry run -- nox -s dependency:licenses >> $GITHUB_STEP_SUMMARY
           echo -e "\n\n# Coverage\n" >> $GITHUB_STEP_SUMMARY
-          poetry run coverage report -- --format markdown >> $GITHUB_STEP_SUMMARY
+          poetry run -- coverage report --format markdown >> $GITHUB_STEP_SUMMARY || true
           poetry run -- tbx lint pretty-print >> $GITHUB_STEP_SUMMARY
           poetry run -- tbx security pretty-print .security.json >> $GITHUB_STEP_SUMMARY

project-template/{{cookiecutter.repo_name}}/.gitignore

@@ -142,4 +142,10 @@ doc/api
 itde/
 
 # Emacs
-TAGS
+/TAGS
+
+# PTB
+/.lint.json
+/.lint.txt
+/.security.json
+