Better vis

Author: benflexcompute

.github/scripts/coverage_summary.py

@@ -0,0 +1,73 @@
+#!/usr/bin/env python3
+"""Generate a folder-level coverage summary from Cobertura XML."""
+
+import sys
+import xml.etree.ElementTree as ET
+from collections import defaultdict
+
+
+def make_bar(pct, width=20):
+    filled = round(pct / 100 * width)
+    return "\u2593" * filled + "\u2591" * (width - filled)
+
+
+def main():
+    xml_path = sys.argv[1] if len(sys.argv) > 1 else "coverage.xml"
+    output_path = sys.argv[2] if len(sys.argv) > 2 else "coverage-summary.md"
+    depth = int(sys.argv[3]) if len(sys.argv) > 3 else 2
+
+    tree = ET.parse(xml_path)
+    root = tree.getroot()
+
+    # Aggregate by package at specified depth
+    groups = defaultdict(lambda: {"hits": 0, "lines": 0})
+
+    for pkg in root.findall(".//package"):
+        name = pkg.get("name", "")
+        parts = name.split(".")
+        key = ".".join(parts[:depth]) if len(parts) >= depth else name
+
+        for line in pkg.findall(".//line"):
+            groups[key]["lines"] += 1
+            if int(line.get("hits", "0")) > 0:
+                groups[key]["hits"] += 1
+
+    total_lines = sum(g["lines"] for g in groups.values())
+    total_hits = sum(g["hits"] for g in groups.values())
+    total_pct = (total_hits / total_lines * 100) if total_lines else 0
+
+    # Sort by coverage ascending (worst first)
+    sorted_groups = sorted(
+        groups.items(),
+        key=lambda x: (x[1]["hits"] / x[1]["lines"] * 100) if x[1]["lines"] else 0,
+    )
+
+    lines = []
+    lines.append(f"## Coverage Report \u2014 {total_pct:.0f}%")
+    lines.append("")
+    lines.append(
+        f"`{make_bar(total_pct, 30)}` **{total_pct:.1f}%** ({total_hits} / {total_lines} lines)"
+    )
+    lines.append("")
+    lines.append("| Package | Coverage | Progress | Lines |")
+    lines.append("|:--------|:--------:|:---------|------:|")
+
+    for key, g in sorted_groups:
+        pct = (g["hits"] / g["lines"] * 100) if g["lines"] else 0
+        lines.append(
+            f"| `{key}` | {pct:.1f}% | `{make_bar(pct)}` | {g['hits']} / {g['lines']} |"
+        )
+
+    lines.append(
+        f"| **Total** | **{total_pct:.1f}%** | | **{total_hits} / {total_lines}** |"
+    )
+    lines.append("")
+
+    with open(output_path, "w") as f:
+        f.write("\n".join(lines))
+
+    print(f"Coverage summary written to {output_path}")
+
+
+if __name__ == "__main__":
+    main()

.github/workflows/test.yml

@@ -13,6 +13,10 @@ on:
       AWS_CODEARTIFACT_READ_ACCESS_SECRET:
         required: true
 
+permissions:
+  contents: read
+  pull-requests: write
+
 jobs:
   code-style:
     uses: ./.github/workflows/codestyle.yml
@@ -61,8 +65,30 @@ jobs:
     - name: Install dependencies
       run: poetry install
 
+    # Non-coverage matrix combinations: run tests normally
     - name: Run simulation_params tests
+      if: ${{ !(matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest') }}
       run: poetry run pytest -rA tests/simulation -vv
 
     - name: Run flow360_params tests
+      if: ${{ !(matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest') }}
       run: poetry run pytest -rA --ignore tests/simulation -vv
+
+    # Coverage matrix combination (Python 3.10 + ubuntu-latest)
+    - name: Run simulation_params tests with coverage
+      if: matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest'
+      run: poetry run pytest -rA tests/simulation -vv --cov=flow360 --cov-report=term-missing:skip-covered
+
+    - name: Run flow360_params tests with coverage
+      if: matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest'
+      run: poetry run pytest -rA --ignore tests/simulation -vv --cov=flow360 --cov-append --cov-report=term-missing:skip-covered --cov-report=xml:coverage.xml
+
+    - name: Generate coverage summary
+      if: matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest' && github.event_name == 'pull_request'
+      run: python .github/scripts/coverage_summary.py coverage.xml coverage-summary.md 2
+
+    - name: Post coverage comment
+      if: matrix.python-version == '3.10' && matrix.platform == 'ubuntu-latest' && github.event_name == 'pull_request'
+      uses: marocchino/sticky-pull-request-comment@v2
+      with:
+        path: coverage-summary.md