Merge pull request #6 from shoptet/claude/switch-to-phpunit-xml-format

[WIP] Switch coverage format from Clover to PHPUnit XML

Author: simonjur

.github/workflows/pr-check.yml

@@ -13,25 +13,30 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Verify clover.xml exists
+      - name: Verify coverage-xml exists
         run: |
-          if [ ! -f php-files/coverage/clover.xml ]; then
-            echo "Error: clover.xml was not generated"
+          if [ ! -d php-files/coverage-xml ]; then
+            echo "Error: coverage-xml directory was not created"
             exit 1
           fi
-          echo "✓ clover.xml exists"
-          echo "Coverage file size: $(wc -c < php-files/coverage/clover.xml) bytes"
+          if [ ! -f php-files/coverage-xml/index.xml ]; then
+            echo "Error: coverage-xml/index.xml was not generated"
+            exit 1
+          fi
+          echo "✓ coverage-xml directory exists"
+          echo "✓ coverage-xml/index.xml exists"
+          echo "Coverage index file size: $(wc -c < php-files/coverage-xml/index.xml) bytes"
 
-      - name: Display coverage file snippet
+      - name: Display coverage index file snippet
         run: |
-          echo "First 50 lines of clover.xml:"
-          head -n 50 php-files/coverage/clover.xml
+          echo "First 50 lines of coverage-xml/index.xml:"
+          head -n 50 php-files/coverage-xml/index.xml
 
       - name: Test PR Coverage Action
         id: coverage
         uses: ./
         with:
-          clover-file: php-files/coverage/clover.xml
+          coverage-xml-dir: php-files/coverage-xml
           github-token: ${{ secrets.GITHUB_TOKEN }}
           all-files-minimum-coverage: 0
           changed-files-minimum-coverage: 0
@@ -46,29 +51,77 @@ jobs:
           echo "Changed files lines: ${{ steps.coverage.outputs.changed-files-lines-hit }}/${{ steps.coverage.outputs.changed-files-lines-total }}"
           echo ""
 
-          # Validate outputs are not empty
-          if [ -z "${{ steps.coverage.outputs.all-files-coverage }}" ]; then
-            echo "❌ Error: all-files-coverage output is empty"
+          # Expected values based on test data
+          # All files: index.php (6/12) + service1.php (5/15) + service2.php (12/48) = 23/75 = 30.67%
+          # Changed files detected by GitHub: index.php (6/12) + service2.php (12/48) = 18/60 = 30.00%
+          # Note: service1.php appears in coverage but not detected as changed by GitHub in PR context
+          EXPECTED_ALL_FILES_COVERAGE="30.67"
+          EXPECTED_ALL_FILES_LINES_HIT="23"
+          EXPECTED_ALL_FILES_LINES_TOTAL="75"
+          EXPECTED_CHANGED_FILES_COVERAGE="30.00"
+          EXPECTED_CHANGED_FILES_LINES_HIT="18"
+          EXPECTED_CHANGED_FILES_LINES_TOTAL="60"
+
+          # Verify all-files-coverage
+          ACTUAL_ALL_FILES_COVERAGE="${{ steps.coverage.outputs.all-files-coverage }}"
+          if [ "$ACTUAL_ALL_FILES_COVERAGE" != "$EXPECTED_ALL_FILES_COVERAGE" ]; then
+            echo "❌ Error: all-files-coverage mismatch"
+            echo "   Expected: $EXPECTED_ALL_FILES_COVERAGE"
+            echo "   Actual: $ACTUAL_ALL_FILES_COVERAGE"
+            exit 1
+          fi
+          echo "✓ all-files-coverage: $ACTUAL_ALL_FILES_COVERAGE (matches expected)"
+
+          # Verify all-files-lines-hit
+          ACTUAL_ALL_FILES_LINES_HIT="${{ steps.coverage.outputs.all-files-lines-hit }}"
+          if [ "$ACTUAL_ALL_FILES_LINES_HIT" != "$EXPECTED_ALL_FILES_LINES_HIT" ]; then
+            echo "❌ Error: all-files-lines-hit mismatch"
+            echo "   Expected: $EXPECTED_ALL_FILES_LINES_HIT"
+            echo "   Actual: $ACTUAL_ALL_FILES_LINES_HIT"
             exit 1
           fi
+          echo "✓ all-files-lines-hit: $ACTUAL_ALL_FILES_LINES_HIT (matches expected)"
 
-          if [ -z "${{ steps.coverage.outputs.changed-files-coverage }}" ]; then
-            echo "❌ Error: changed-files-coverage output is empty"
+          # Verify all-files-lines-total
+          ACTUAL_ALL_FILES_LINES_TOTAL="${{ steps.coverage.outputs.all-files-lines-total }}"
+          if [ "$ACTUAL_ALL_FILES_LINES_TOTAL" != "$EXPECTED_ALL_FILES_LINES_TOTAL" ]; then
+            echo "❌ Error: all-files-lines-total mismatch"
+            echo "   Expected: $EXPECTED_ALL_FILES_LINES_TOTAL"
+            echo "   Actual: $ACTUAL_ALL_FILES_LINES_TOTAL"
             exit 1
           fi
+          echo "✓ all-files-lines-total: $ACTUAL_ALL_FILES_LINES_TOTAL (matches expected)"
 
-          # Validate coverage values are numeric and in valid range
-          all_coverage="${{ steps.coverage.outputs.all-files-coverage }}"
-          if ! [[ "$all_coverage" =~ ^[0-9]+\.?[0-9]*$ ]]; then
-            echo "❌ Error: all-files-coverage is not a valid number: $all_coverage"
+          # Verify changed-files-coverage
+          ACTUAL_CHANGED_FILES_COVERAGE="${{ steps.coverage.outputs.changed-files-coverage }}"
+          if [ "$ACTUAL_CHANGED_FILES_COVERAGE" != "$EXPECTED_CHANGED_FILES_COVERAGE" ]; then
+            echo "❌ Error: changed-files-coverage mismatch"
+            echo "   Expected: $EXPECTED_CHANGED_FILES_COVERAGE"
+            echo "   Actual: $ACTUAL_CHANGED_FILES_COVERAGE"
             exit 1
           fi
+          echo "✓ changed-files-coverage: $ACTUAL_CHANGED_FILES_COVERAGE (matches expected)"
 
-          # Check if coverage is reasonable (0-100%)
-          if (( $(echo "$all_coverage > 100" | bc -l) )); then
-            echo "❌ Error: all-files-coverage exceeds 100%: $all_coverage"
+          # Verify changed-files-lines-hit
+          ACTUAL_CHANGED_FILES_LINES_HIT="${{ steps.coverage.outputs.changed-files-lines-hit }}"
+          if [ "$ACTUAL_CHANGED_FILES_LINES_HIT" != "$EXPECTED_CHANGED_FILES_LINES_HIT" ]; then
+            echo "❌ Error: changed-files-lines-hit mismatch"
+            echo "   Expected: $EXPECTED_CHANGED_FILES_LINES_HIT"
+            echo "   Actual: $ACTUAL_CHANGED_FILES_LINES_HIT"
             exit 1
           fi
+          echo "✓ changed-files-lines-hit: $ACTUAL_CHANGED_FILES_LINES_HIT (matches expected)"
 
-          echo "✓ All coverage outputs are valid"
-          echo "✓ PR Test Coverage action completed successfully"
+          # Verify changed-files-lines-total
+          ACTUAL_CHANGED_FILES_LINES_TOTAL="${{ steps.coverage.outputs.changed-files-lines-total }}"
+          if [ "$ACTUAL_CHANGED_FILES_LINES_TOTAL" != "$EXPECTED_CHANGED_FILES_LINES_TOTAL" ]; then
+            echo "❌ Error: changed-files-lines-total mismatch"
+            echo "   Expected: $EXPECTED_CHANGED_FILES_LINES_TOTAL"
+            echo "   Actual: $ACTUAL_CHANGED_FILES_LINES_TOTAL"
+            exit 1
+          fi
+          echo "✓ changed-files-lines-total: $ACTUAL_CHANGED_FILES_LINES_TOTAL (matches expected)"
+
+          echo ""
+          echo "✅ All coverage outputs match expected values!"
+          echo "✅ PR Test Coverage action completed successfully"

README.md

@@ -1,12 +1,12 @@
 # PR Test Coverage
 
-A Github Action to report the test coverage of changed files in a pull request. All it needs is a clover.xml file. It provides a summary of the coverage for all files and changed files separately, and a detailed table with coverage metrics per changed file.
+A Github Action to report the test coverage of changed files in a pull request. It uses PHPUnit XML coverage format. It provides a summary of the coverage for all files and changed files separately, and a detailed table with coverage metrics per changed file.
 
 <img width="924" height="761" alt="image" src="https://github.com/user-attachments/assets/d0e61fa6-46c6-40b1-b9ce-b3c71a10321b" />
 
 ## Features
 
-- 📊 Generates comprehensive coverage reports from Clover XML files
+- 📊 Generates comprehensive coverage reports from PHPUnit XML coverage format
 - 💬 Posts coverage summaries as PR comments
 - 🔄 Updates existing comments or creates new ones
 - 📈 Shows coverage for all files and changed files separately
@@ -37,13 +37,13 @@ jobs:
 
       - name: Run tests and generate coverage
         run: |
-          # Your test commands here that generate Clover XML report
-          npm test -- --coverage --coverageReporters=clover
+          # Your test commands here that generate PHPUnit XML coverage report
+          vendor/bin/phpunit --coverage-xml coverage-xml
 
       - name: PR Test Coverage
         uses: jbaczuk/pr-test-coverage@v1
         with:
-          clover-file: coverage/clover.xml
+          coverage-xml-dir: coverage-xml
           github-token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
@@ -53,8 +53,8 @@ jobs:
 - name: PR Test Coverage
   uses: jbaczuk/pr-test-coverage@v1
   with:
-    # Required: Path to Clover XML file
-    clover-file: coverage/clover.xml
+    # Required: Path to PHPUnit XML coverage directory
+    coverage-xml-dir: coverage-xml
 
     # Required: GitHub token for API access
     github-token: ${{ secrets.GITHUB_TOKEN }}
@@ -79,7 +79,7 @@ jobs:
 
 | Input | Description | Required | Default |
 |-------|-------------|----------|---------|
-| `clover-file` | Path to the Clover XML file (e.g., `coverage/clover.xml`) | ✅ | - |
+| `coverage-xml-dir` | Path to the PHPUnit XML coverage directory (e.g., `coverage-xml`) | ✅ | - |
 | `github-token` | GitHub token for API access and posting comments | ✅ | `${{ github.token }}` |
 | `working-directory` | Working directory to run the action from | ❌ | `''` (repository root) |
 | `all-files-minimum-coverage` | Minimum coverage percentage for all files (0-100) | ❌ | `0` |
@@ -107,7 +107,7 @@ The action provides the following outputs that can be used in subsequent workflo
   id: coverage
   uses: jbaczuk/pr-test-coverage@v1
   with:
-    clover-file: coverage/clover.xml
+    coverage-xml-dir: coverage-xml
     github-token: ${{ secrets.GITHUB_TOKEN }}
 
 - name: Check coverage threshold
@@ -174,19 +174,19 @@ The action uses visual indicators to quickly show coverage status:
 
 The action will fail if:
 
-1. **Clover file not found** - The specified Clover XML file doesn't exist
+1. **Coverage XML directory not found** - The specified PHPUnit XML coverage directory doesn't exist
 2. **Not a pull request** - The action is not running in a PR context
 3. **Coverage below threshold** - When coverage falls below specified minimums:
    - All files coverage below `all-files-minimum-coverage`
    - Changed files coverage below `changed-files-minimum-coverage`
 
-## Supported Clover Format
+## Supported PHPUnit XML Format
 
-The action supports standard Clover XML format with the following metrics:
+The action supports PHPUnit XML coverage format (generated with `--coverage-xml`) with the following metrics:
 
-- **Lines**: `statements` (total lines) and `coveredstatements` (lines hit)
-- **Functions**: `methods` (total methods) and `coveredmethods` (methods hit)
-- **Branches**: `conditionals` (total branches) and `coveredconditionals` (branches hit)
+- **Lines**: `executable` (total lines) and `executed` (lines hit)
+- **Methods**: `count` (total methods) and `tested` (methods hit)
+- **Functions**: `count` (total functions) and `tested` (functions hit)
 
 ## Common Integration Examples
 
@@ -202,10 +202,12 @@ The action supports standard Clover XML format with the following metrics:
 - name: PR Test Coverage
   uses: jbaczuk/pr-test-coverage@v1
   with:
-    clover-file: coverage/clover.xml
+    coverage-xml-dir: coverage/clover.xml
     github-token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
+Note: Jest generates Clover format, not PHPUnit XML. This action now primarily supports PHPUnit XML format. For Jest, you may need to convert the format or use a different action.
+
 ### Python with pytest-cov
 
 ```yaml
@@ -219,21 +221,23 @@ The action supports standard Clover XML format with the following metrics:
 - name: PR Test Coverage
   uses: jbaczuk/pr-test-coverage@v1
   with:
-    clover-file: coverage.xml
+    coverage-xml-dir: coverage.xml
     github-token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
+Note: pytest-cov generates Cobertura XML format, not PHPUnit XML. This action now primarily supports PHPUnit XML format.
+
 ### PHP with PHPUnit
 
 ```yaml
 - name: Run tests with coverage
   run: |
-    vendor/bin/phpunit --coverage-clover coverage/clover.xml
+    vendor/bin/phpunit --coverage-xml coverage-xml
 
 - name: PR Test Coverage
   uses: jbaczuk/pr-test-coverage@v1
   with:
-    clover-file: coverage/clover.xml
+    coverage-xml-dir: coverage-xml
     github-token: ${{ secrets.GITHUB_TOKEN }}
 ```
 

action.yml

@@ -6,8 +6,8 @@ branding:
   color: 'green'
 
 inputs:
-  clover-file:
-    description: 'Path to the Clover XML file (e.g., coverage/clover.xml)'
+  coverage-xml-dir:
+    description: 'Path to the PHPUnit XML coverage directory (e.g., coverage-xml)'
     required: true
   github-token:
     description: 'GitHub token for accessing API and posting comments'

dist/PhpUnitXmlParser.d.ts

@@ -0,0 +1,9 @@
+import { CoverageData } from './types';
+export declare class PhpUnitXmlParser {
+    parse(coverageXmlDir: string): Promise<CoverageData>;
+    /**
+     * Extracts the source file path from a PHPUnit XML file
+     * This reads the individual file XML to get the path attribute and combines it with the project source prefix
+     */
+    private extractSourcePath;
+}

dist/PhpUnitXmlParser.d.ts.map

@@ -5,7 +5,7 @@ export declare class PrTestCoverageAction {
     private readonly inputs;
     private readonly context;
     private readonly githubService;
-    private readonly cloverParser;
+    private readonly phpunitXmlParser;
     private readonly coverageReporter;
     constructor(inputs: ActionInputs, context: Context);
     execute(): Promise<void>;