Testing: Add PHP code coverage collection for e2e tests (#343)

Author: priethor

.codecov.yml

@@ -2,12 +2,16 @@
 # Reference: https://docs.codecov.com/docs/codecovyml-reference
 
 flags:
-    e2e:
-        carryforward: true # Preserve coverage data across uploads to avoid losing history
+    e2e-js:
+        carryforward: true
         paths:
             - 'assets/src/'
+    e2e-php:
+        carryforward: true
+        paths:
+            - 'includes/'
     phpunit:
-        carryforward: true # Preserve coverage data across uploads to avoid losing history
+        carryforward: true
         paths:
             - 'includes/'
 

.github/workflows/e2e.yml

@@ -64,28 +64,46 @@ jobs:
             - name: Install wp-env
               run: npm install -g @wordpress/env
 
-            - name: Start wp-env
+            - name: Start wp-env and install PCOV
+              env:
+                  PHP_COVERAGE_ENABLED: true
               run: wp-env start
 
             - name: Install Playwright browsers
               run: npx playwright install --with-deps
 
             - name: Run e2e tests with coverage
+              env:
+                  PHP_COVERAGE_ENABLED: true
               run: npm run test:e2e:coverage
 
             - name: Generate LCOV report from Istanbul coverage
               if: always()
               run: npm run test:e2e:coverage:report
 
-            - name: Upload E2E Coverage to Codecov
+            - name: Generate PHP coverage report
+              if: always()
+              run: npm run test:e2e:php-coverage:report
+
+            - name: Upload E2E JS Coverage to Codecov
               if: always()
               uses: codecov/codecov-action@v5
               with:
                   token: ${{ secrets.CODECOV_TOKEN }}
                   files: ./coverage/e2e/lcov.info
-                  flags: e2e
+                  flags: e2e-js
+                  slug: WordPress/secure-custom-fields
+                  name: e2e-js-coverage
+
+            - name: Upload E2E PHP Coverage to Codecov
+              if: always()
+              uses: codecov/codecov-action@v5
+              with:
+                  token: ${{ secrets.CODECOV_TOKEN }}
+                  files: ./coverage/php-e2e/lcov.info
+                  flags: e2e-php
                   slug: WordPress/secure-custom-fields
-                  name: e2e-coverage
+                  name: e2e-php-coverage
 
             - name: Stop wp-env
               if: always()

.gitignore

@@ -62,6 +62,7 @@ assets/build/**/*.php
 # Code Coverage
 /coverage/
 /.nyc_output/
+/.php-coverage/
 
 # Claude settings
 **/.claude/settings.local.json

.wp-env.json

@@ -1,11 +1,15 @@
 {
   "$schema": "./schemas/json/wp-env.json",
   "plugins": ["."],
+  "lifecycleScripts": {
+    "afterStart": "bash ./scripts/install-pcov.sh"
+  },
   "env": {
     "tests": {
       "mappings": {
         "wp-content/plugins/secure-custom-fields": ".",
-        "wp-content/plugins/scf-test-plugins": "./tests/e2e/plugins"
+        "wp-content/plugins/scf-test-plugins": "./tests/e2e/plugins",
+        "wp-content/mu-plugins/php-coverage-collector.php": "./tests/e2e/mu-plugins/php-coverage-collector.php"
       }
     }
   }

package.json

@@ -10,6 +10,9 @@
 		"test:e2e:coverage": "rm -rf .nyc_output && COVERAGE_ENABLED=true wp-scripts test-playwright",
 		"test:e2e:coverage:report": "nyc report --reporter=html --reporter=lcov",
 		"test:e2e:debug": "wp-scripts test-playwright --debug --ui",
+		"test:e2e:php-coverage": "rm -rf .php-coverage && PHP_COVERAGE_ENABLED=true wp-scripts test-playwright",
+		"test:e2e:php-coverage:report": "node scripts/merge-php-coverage.js",
+		"test:e2e:all-coverage": "rm -rf .nyc_output .php-coverage && COVERAGE_ENABLED=true PHP_COVERAGE_ENABLED=true wp-scripts test-playwright",
 		"test:unit": "wp-scripts test-unit-js",
 		"test:unit:watch": "wp-scripts test-unit-js --watch",
 		"watch": "webpack --watch"

scripts/install-pcov.sh

@@ -0,0 +1,54 @@
+#!/bin/bash
+#
+# Install PCOV extension in wp-env Docker container for faster PHP coverage.
+# This script is called by wp-env lifecycleScripts.afterStart.
+#
+# PCOV is ~5-10x faster than Xdebug for coverage collection.
+
+set -e
+
+# Only install if PHP_COVERAGE_ENABLED is set
+if [ -z "$PHP_COVERAGE_ENABLED" ]; then
+    echo "PHP_COVERAGE_ENABLED not set, skipping PCOV installation."
+    exit 0
+fi
+
+echo "Installing PCOV for PHP coverage..."
+
+# Get the wp-env install path
+WP_ENV_PATH=$(wp-env install-path)
+cd "$WP_ENV_PATH"
+
+# Check if PCOV is already installed
+if docker compose exec -T tests-wordpress php -m 2>/dev/null | grep -q "^pcov$"; then
+    echo "PCOV already installed."
+    exit 0
+fi
+
+echo "Installing PCOV extension..."
+
+# Install PCOV using pecl (run as root)
+docker compose exec -T -u root tests-wordpress bash -c '
+    # Install dependencies for pecl
+    apt-get update -qq && apt-get install -qq -y autoconf gcc make > /dev/null 2>&1 || true
+
+    # Install PCOV
+    pecl install pcov > /dev/null 2>&1
+
+    # Enable PCOV
+    docker-php-ext-enable pcov
+
+    # Configure PCOV
+    echo "pcov.enabled=1" >> /usr/local/etc/php/conf.d/docker-php-ext-pcov.ini
+    echo "pcov.directory=/var/www/html/wp-content/plugins/secure-custom-fields" >> /usr/local/etc/php/conf.d/docker-php-ext-pcov.ini
+
+    # Disable Xdebug if enabled (they conflict)
+    if [ -f /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini ]; then
+        mv /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini.disabled || true
+    fi
+'
+
+# Restart Apache to load the new extension
+docker compose exec -T -u root tests-wordpress service apache2 reload > /dev/null 2>&1 || true
+
+echo "PCOV installed successfully."