Update PHPUnit tests infrastructure #1065
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,89 @@ | ||||||||||||||||||||||||
| /** | ||||||||||||||||||||||||
| * External dependencies | ||||||||||||||||||||||||
| */ | ||||||||||||||||||||||||
| const path = require( 'path' ); | ||||||||||||||||||||||||
| const { spawnSync } = require( 'child_process' ); | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| /** | ||||||||||||||||||||||||
| * Internal dependencies | ||||||||||||||||||||||||
| */ | ||||||||||||||||||||||||
| const { plugins } = require( '../../plugins.json' ); | ||||||||||||||||||||||||
| const { formats } = require( '../plugin/lib/logger' ); | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| const args = process.argv.slice( 2 ); | ||||||||||||||||||||||||
| const { WPP_PLUGIN, WPP_MULTISITE } = process.env; | ||||||||||||||||||||||||
| const pluginBasePath = path.resolve( __dirname, '../../' ); | ||||||||||||||||||||||||
| const pluginBaseName = path.basename( pluginBasePath ); | ||||||||||||||||||||||||
| const pluginsDir = path.resolve( pluginBasePath, 'plugins' ); | ||||||||||||||||||||||||
| const phpunitBin = path.resolve( pluginBasePath, 'vendor/bin/phpunit' ); | ||||||||||||||||||||||||
| const wpEnvBin = path.resolve( pluginBasePath, 'node_modules/.bin/wp-env' ); | ||||||||||||||||||||||||
| const wpPluginsDir = `/var/www/html/wp-content/plugins/${ pluginBaseName }`; | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| const _plugins = []; // Store absolute paths to plugins. | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| if ( WPP_PLUGIN ) { | ||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. @thelovekesh Unrelated to the ongoing discussion in #1012: If we implement new JS tooling scripts like this, I think they should be incorporated into the existing foundation in |
||||||||||||||||||||||||
| if ( | ||||||||||||||||||||||||
| 'performance-lab' !== WPP_PLUGIN && | ||||||||||||||||||||||||
| ! plugins.includes( WPP_PLUGIN ) | ||||||||||||||||||||||||
| ) { | ||||||||||||||||||||||||
| // eslint-disable-next-line no-console | ||||||||||||||||||||||||
| console.error( | ||||||||||||||||||||||||
| formats.error( | ||||||||||||||||||||||||
| `The plugin ${ WPP_PLUGIN } is not a valid plugin managed as part of this project.` | ||||||||||||||||||||||||
| ) | ||||||||||||||||||||||||
| ); | ||||||||||||||||||||||||
|
Comment on lines
+29
to
+34
Member
There was a problem hiding this comment. Can we utilize
Suggested change
Member
There was a problem hiding this comment. I think better to use Otherwise, this could be added to logger as an alias in the same way that was done for |
||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| process.exit( 1 ); | ||||||||||||||||||||||||
| } | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| if ( 'performance-lab' === WPP_PLUGIN ) { | ||||||||||||||||||||||||
| _plugins.push( pluginBasePath ); | ||||||||||||||||||||||||
| } else { | ||||||||||||||||||||||||
| _plugins.push( path.resolve( pluginsDir, WPP_PLUGIN ) ); | ||||||||||||||||||||||||
| } | ||||||||||||||||||||||||
| } else { | ||||||||||||||||||||||||
| plugins.forEach( ( plugin ) => { | ||||||||||||||||||||||||
| _plugins.push( path.resolve( pluginsDir, plugin ) ); | ||||||||||||||||||||||||
| } ); | ||||||||||||||||||||||||
| } | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| const wpEnvRunArgs = {}; // Store plugin name with args provided to wp-env run command. | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| _plugins.forEach( ( plugin ) => { | ||||||||||||||||||||||||
| const command = [ | ||||||||||||||||||||||||
| 'run', | ||||||||||||||||||||||||
| 'tests-cli', | ||||||||||||||||||||||||
| `--env-cwd=${ plugin.replace( pluginBasePath, wpPluginsDir ) }`, | ||||||||||||||||||||||||
| ]; | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| if ( WPP_MULTISITE ) { | ||||||||||||||||||||||||
| command.push( 'env', 'WP_MULTISITE=1' ); | ||||||||||||||||||||||||
| } | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| command.push( phpunitBin.replace( pluginBasePath, wpPluginsDir ) ); | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| if ( WPP_MULTISITE ) { | ||||||||||||||||||||||||
| command.push( '--exclude-group', 'ms-excluded' ); | ||||||||||||||||||||||||
| } | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| if ( args.length ) { | ||||||||||||||||||||||||
| command.push( ...args ); | ||||||||||||||||||||||||
| } | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| wpEnvRunArgs[ path.basename( plugin ) ] = command; | ||||||||||||||||||||||||
| } ); | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| for ( const [ plugin, command ] of Object.entries( wpEnvRunArgs ) ) { | ||||||||||||||||||||||||
| if ( Object.keys( wpEnvRunArgs ).length > 1 ) { | ||||||||||||||||||||||||
| // eslint-disable-next-line no-console | ||||||||||||||||||||||||
| console.log( formats.info( `\n> Running tests for ${ plugin }` ) ); | ||||||||||||||||||||||||
| } | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| // Execute tests synchronously for the sake of async fs.stat in loop. | ||||||||||||||||||||||||
| // fs.stat is used by wp-env to determine if `/snap` is available on user's system. | ||||||||||||||||||||||||
| const _process = spawnSync( wpEnvBin, command, { stdio: 'inherit' } ); | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| if ( _process.signal ) { | ||||||||||||||||||||||||
| process.exit( 1 ); | ||||||||||||||||||||||||
| } | ||||||||||||||||||||||||
| } | ||||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,6 +25,7 @@ | |
| "post-install-cmd": "if php -r 'exit( version_compare( phpversion(), \"8.1\", \">=\" ) ? 0 : 1 );'; then composer --working-dir=build-cs install --no-interaction; else echo 'Skipping composer install for build-cs since not on PHP 8.1+. You are running: '; php -v; fi", | ||
| "post-update-cmd": "if php -r 'exit( version_compare( phpversion(), \"8.1\", \">=\" ) ? 0 : 1 );'; then composer --working-dir=build-cs update --no-interaction; else echo 'Skipping composer update for build-cs since not on PHP 8.1+. You are running: '; php -v; fi", | ||
| "phpstan": "build-cs/vendor/bin/phpstan analyse --memory-limit=2048M", | ||
| "phpunit": "phpunit --verbose", | ||
| "format": "build-cs/vendor/bin/phpcbf --report-summary --report-source", | ||
| "lint": "build-cs/vendor/bin/phpcs", | ||
| "lint:all": [ | ||
|
|
@@ -41,56 +42,13 @@ | |
| "lint:embed-optimizer": "@lint -- ./plugins/embed-optimizer --standard=./plugins/embed-optimizer/phpcs.xml.dist", | ||
| "lint:optimization-detective": "@lint -- ./plugins/optimization-detective --standard=./plugins/optimization-detective/phpcs.xml.dist", | ||
| "lint:speculation-rules": "@lint -- ./plugins/speculation-rules --standard=./plugins/speculation-rules/phpcs.xml.dist", | ||
|
Member
There was a problem hiding this comment. Why remove all of the test scripts from composer? I think it would be better if scripts that rely on PHP functionality were maintained in the composer.json and provide a node script that referenced composer than moving all of these over to the package.json file.
Member
Author
There was a problem hiding this comment. @joemcgill @felixarntz In conjunction with both this and #1065 (comment), I have added a node script to run PHPUnit tests in 0ba78d9 and added the scripts in Now the commands works like: Please LMKWYT.
Member
There was a problem hiding this comment. This is nice. Previously in order to run just the tests for Optimization Detective, I would do this: npm run wp-env run tests-cli bashAnd then in the container: cd wp-content/plugins/performance/
composer run-script test:optimization-detective # (run as many times as needed)Great to have a command to run just one plugin's tests: npm run test:php:plugins --plugin=optimization-detective
Member
Author
There was a problem hiding this comment. One more advantage is, that you can now pass args to PHPUnit by escaping once only like: is makes it more better IMO. |
||
| "lint:webp-uploads": "@lint -- ./plugins/webp-uploads --standard=./plugins/webp-uploads/phpcs.xml.dist" | ||
| }, | ||
| "config": { | ||
| "allow-plugins": { | ||
| "composer/installers": true, | ||
| "phpstan/extension-installer": true, | ||
| "dealerdirect/phpcodesniffer-composer-installer": true | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be reverted as trunk now have latest dependancy.