Ensures robust code coverage generation in CI

Updates Composer install to use `--ignore-platform-req=php` on PHP 8.x, ensuring PHPUnit 9.6 is installed for compatible code coverage. Explicitly enables Xdebug coverage mode and passes `--coverage-clover` to PHPUnit within `wp-env` for the coverage matrix cell, guaranteeing reliable report generation. Refines comments regarding atomic file retrieval via `docker cp`.
masteradhoc · Sep 24, 2026 · Mar 28, 2026 · Mar 28, 2026 · Mar 28, 2026 · Mar 28, 2026
commit 367f8049cc5ccb37e20856e6da56faa5326e4f05
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -123,7 +123,16 @@ jobs:
             - name: Composer install
               run: |
                 rm composer.lock || true # We need to install fresh.
-                npm run composer install
+                # On PHP 8+, the composer.json platform override (php: 7.2.24) causes PHPUnit 8.5 to
+                # be installed. PHPUnit 8.5 explicitly refuses to generate code coverage on PHP 8 with
+                # the message "This version of PHPUnit does not support code coverage on PHP 8". Pass
+                # --ignore-platform-req=php so Composer resolves against the actual PHP runtime and
+                # installs PHPUnit 9.6, which supports coverage on PHP 8.x.
+                if [[ "${WP_ENV_PHP_VERSION}" == 8.* ]]; then
+                  npm run composer -- install --ignore-platform-req=php
+                else
+                  npm run composer install
+                fi
 
             - name: Versions
               run: |
@@ -133,27 +142,36 @@ jobs:
             - name: Test
               run: |
                 npm run env run tests-cli --env-cwd=wp-content/plugins/two-factor -- mkdir -p tests/logs
-                npm run test
+                # For the coverage matrix cell, set XDEBUG_MODE=coverage explicitly via env var
+                # (Xdebug 3 feature) rather than relying on the ini configuration that wp-env
+                # applies to persistent containers — ephemeral wp-env run containers may not
+                # inherit it. Pass --coverage-clover in addition to what phpunit.xml.dist configures
+                # so the clover output is guaranteed regardless of XML config format differences
+                # between PHPUnit versions.
+                if [[ "${{ matrix.php }}" == "8.3" && "${{ matrix.wp }}" == "latest" ]]; then
+                  npm run env run tests-cli --env-cwd=wp-content/plugins/two-factor -- \
+                    sh -c 'XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-text --coverage-clover tests/logs/clover.xml'
+                else
+                  npm run test
+                fi
 
             - name: Retrieve coverage report from container
               if: ${{ matrix.php == '8.3' && matrix.wp == 'latest' }}
               run: |
-                # PHPUnit writes clover.xml into the named Docker volume shared between the
-                # tests-wordpress and tests-cli containers. The plugin directory is NOT bind-mounted
-                # from the workspace in CI, so the file does not appear on the host filesystem after
-                # npm run test. We use docker cp (not 'docker exec cat > file') because docker cp is
-                # an atomic Docker API call that reads from the container's merged filesystem without
-                # a shell redirect that would pre-truncate the destination and cause a self-overwrite.
+                # PHPUnit writes clover.xml into the Docker volume shared between tests-cli and
+                # tests-wordpress. We use docker cp (not 'docker exec cat > file') because docker cp
+                # is an atomic Docker API call that avoids a shell redirect pre-truncating the
+                # destination — which would zero-out the file before cat can read it.
                 CONTAINER=$(docker ps --filter "name=tests-wordpress" --format "{{.Names}}" | head -1)
                 if [ -z "$CONTAINER" ]; then
                   echo "Error: tests-wordpress container not found"
                   exit 1
                 fi
                 mkdir -p tests/logs
                 docker cp "$CONTAINER:/var/www/html/wp-content/plugins/two-factor/tests/logs/clover.xml" tests/logs/clover.xml
-                echo "=== xdebug mode reported by tests-wordpress ==="
+                echo "=== xdebug mode in tests-wordpress ==="
                 docker exec "$CONTAINER" php -r "echo ini_get('xdebug.mode') . PHP_EOL;"
-                echo "=== clover.xml size and summary ==="
+                echo "=== clover.xml size and first 10 lines ==="
                 wc -c tests/logs/clover.xml
                 head -10 tests/logs/clover.xml
                 if [ ! -s tests/logs/clover.xml ]; then