Changeset 59356

Timestamp:

11/05/2024 07:59:49 PM (5 weeks ago)

Author:

desrosj

Message:

Build/Test Tools: Add script for generating code coverage report.

This adds documentation for how to generate code coverage reports to the README.md file.

test:coverage has also been added as an npm script to make it easier to generate a report using the local Docker environment. The script will generate an HTML, PHP, and text report file.

Props pbearne, hellofromTonya, netweb.
Fixes #53414.

Location:

trunk

Files:

• . (modified) (1 prop)
• .gitignore (modified) (1 diff)
• README.md (modified) (1 diff)
• package.json (modified) (1 diff)
• tools/local-env/scripts/docker.js (modified) (1 diff)

trunk

@@ -19 +19 @@
 /docker-compose.override.yml
 .env
+coverage

@@ -19 +19 @@
 /docker-compose.override.yml
 .env
+coverage

trunk/.gitignore

@@ -43 +43 @@
 /artifacts
 /setup.log
+/coverage
 
 # Files and folders that get created in wp-content

trunk/README.md

@@ -95 +95 @@
 ```
 
+#### Generating a code coverage report
+PHP code coverage reports are [generated daily](https://github.com/WordPress/wordpress-develop/actions/workflows/test-coverage.yml) and [submitted to Codecov.io](https://app.codecov.io/gh/WordPress/wordpress-develop).
+
+After the local Docker environment has [been installed and started](#to-start-the-development-environment-for-the-first-time), the following command can be used to generate a code coverage report. 
+
+```
+npm run test:coverage
+```
+
+The command will generate three coverage reports in HTML, PHP, and text formats, saving them in the `coverage` folder.
+
+**Note:** xDebug is required to generate a code coverage report, which can slow down PHPUnit significantly. Passing selection-based options such as `--group` or `--filter` can decrease the overall time required but will result in an incomplete report.
+
 #### To restart the development environment
 

trunk/package.json

@@ -191 +191 @@
         "test:performance": "wp-scripts test-playwright --config tests/performance/playwright.config.js",
         "test:php": "node ./tools/local-env/scripts/docker.js run php ./vendor/bin/phpunit",
+        "test:coverage": "npm run test:php -- --coverage-html ./coverage/html/ --coverage-php ./coverage/php/report.php --coverage-text=./coverage/text/report.txt",
         "test:e2e": "wp-scripts test-playwright --config tests/e2e/playwright.config.js",
         "test:visual": "wp-scripts test-playwright --config tests/visual-regression/playwright.config.js",

trunk/tools/local-env/scripts/docker.js

@@ -8 +8 @@
 const composeFiles = local_env_utils.get_compose_files();
 
+if (process.argv.includes('--coverage-html')) {
+    process.env.LOCAL_PHP_XDEBUG = 'true';
+    process.env.LOCAL_PHP_XDEBUG_MODE = 'coverage';
+}
+
 // Execute any docker compose command passed to this script.
 execSync( 'docker compose ' + composeFiles + ' ' + process.argv.slice( 2 ).join( ' ' ), { stdio: 'inherit' } );

@@ -19 +19 @@
 /docker-compose.override.yml
 .env
+coverage