ci: add coverage report and summary to tests workflow (closes #3) (#6)

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

Author: 3 people

.github/workflows/tests.yml

@@ -3,6 +3,10 @@ on:
   push:
     branches: ["**"]
 
+permissions:
+  contents: write
+  pull-requests: write
+
 jobs:
   tests:
     runs-on: ubuntu-latest
@@ -24,5 +28,95 @@ jobs:
       - name: Install project (editable)
         run: uv pip install -e .
 
-      - name: Run pytest
-        run: uv run pytest -v tests/
+      - name: Run tests with coverage
+        run: uv run pytest -v --cov=openhands --cov-report=xml:coverage.xml --cov-report=term-missing tests/
+
+      - name: Code Coverage Summary
+        if: always()
+        uses: irongut/CodeCoverageSummary@v1.3.0
+        with:
+          filename: coverage.xml
+          badge: true
+          fail_below_min: false
+          format: markdown
+          hide_branch_rate: false
+          hide_complexity: true
+          indicators: true
+          output: both
+
+      - name: Add Coverage PR Comment
+        if: ${{ always() && github.event_name == 'pull_request' }}
+        continue-on-error: true
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          recreate: true
+          path: code-coverage-results.md
+
+      - name: Upload coverage artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-artifacts
+          path: |
+            coverage.xml
+            code-coverage-results.md
+          if-no-files-found: ignore
+      - name: Parse coverage percent
+        if: always()
+        id: parsecov
+        run: |
+          python - << 'PY'
+          import xml.etree.ElementTree as ET
+          import math
+          p = 'coverage.xml'
+          try:
+              root = ET.parse(p).getroot()
+              lr = root.attrib.get('line-rate')
+              pct = int(round(float(lr) * 100)) if lr is not None else 0
+          except Exception:
+              pct = 0
+          print(f"coverage_percent={pct}")
+          with open("coverage_percent.txt", "w") as f:
+              f.write(str(pct))
+          PY
+
+      - name: Determine badge color
+        if: always()
+        id: color
+        run: |
+          PCT=$(cat coverage_percent.txt || echo 0)
+          if [ "$PCT" -ge 90 ]; then COLOR=brightgreen; 
+          elif [ "$PCT" -ge 75 ]; then COLOR=green; 
+          elif [ "$PCT" -ge 60 ]; then COLOR=yellowgreen; 
+          elif [ "$PCT" -ge 50 ]; then COLOR=yellow; 
+          else COLOR=red; fi
+          echo "color=$COLOR" >> $GITHUB_OUTPUT
+          echo "pct=$PCT" >> $GITHUB_OUTPUT
+
+      - name: Ensure badges directory
+        if: always()
+        run: mkdir -p badges
+
+      - name: Generate coverage badge
+        if: always()
+        uses: emibcn/badge-action@v2.0.2
+        with:
+          label: coverage
+          status: "${{ steps.color.outputs.pct }}%"
+          color: "${{ steps.color.outputs.color }}"
+          path: badges/coverage.svg
+
+      - name: Upload badge artifact (PRs)
+        if: ${{ always() && github.event_name == 'pull_request' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-badge
+          path: badges/coverage.svg
+
+      - name: Commit coverage badge (push builds)
+        if: ${{ always() && github.event_name == 'push' }}
+        uses: EndBug/add-and-commit@v9
+        with:
+          add: "badges/coverage.svg"
+          message: "docs: update coverage badge [skip ci]"
+          default_author: github_actions

README.md

@@ -1,5 +1,7 @@
 # Prototype for OpenHands V1
 
+[![Coverage](badges/coverage.svg)](./badges/coverage.svg)
+
 This folder contains my tasks of completely refactor [OpenHands](https://github.com/All-Hands-AI/OpenHands) project V0 into the new V1 version. There's a lot of changes, including (non-exhausive):
 
 - Switching from poetry to uv as package manager

badges/coverage.svg

@@ -18,5 +18,6 @@ dev = [
     "psutil>=7.0.0",
     "pyright>=1.1.404",
     "pytest>=8.4.1",
+    "pytest-cov>=5.0.0",
     "ruff>=0.12.10",
 ]