From bf2757d1bf760aaa6d8acf3485099e89a35f1dd0 Mon Sep 17 00:00:00 2001
From: Felix Arntz <felixarntz@google.com>
Date: Thu, 21 Mar 2024 09:42:55 -0700
Subject: [PATCH] Remove workflow to test standalone plugins built from modules
 as no longer relevant.

---
 .../workflows/php-test-standalone-plugins.yml |  82 ---
 bin/plugin/cli.js                             |   9 -
 bin/plugin/commands/test-plugins.js           | 533 ------------------
 package.json                                  |   2 -
 4 files changed, 626 deletions(-)
 delete mode 100644 .github/workflows/php-test-standalone-plugins.yml
 delete mode 100644 bin/plugin/commands/test-plugins.js

diff --git a/.github/workflows/php-test-standalone-plugins.yml b/.github/workflows/php-test-standalone-plugins.yml
deleted file mode 100644
index 1f6757d430..0000000000
--- a/.github/workflows/php-test-standalone-plugins.yml
+++ /dev/null
@@ -1,82 +0,0 @@
-name: Integration Tests for Standalone Plugins
-
-on:
-  push:
-    branches:
-      - trunk
-      - 'release/**'
-    # Only run if PHP-related files changed.
-    paths:
-      - '.github/workflows/php-test-standalone-plugins.yml'
-      - 'bin/plugin/commands/test-plugins.js'
-      - 'plugin-tests/**'
-      - '**.php'
-      - '.wp-env.json'
-      - '**/package.json'
-      - 'package-lock.json'
-      - 'phpunit.xml.dist'
-      - 'composer.json'
-      - 'composer.lock'
-  pull_request:
-    branches:
-      - trunk
-      - 'release/**'
-      - 'feature/**'
-    # Only run if PHP-related files changed.
-    paths:
-      - '.github/workflows/php-test-standalone-plugins.yml'
-      - 'bin/plugin/commands/test-plugins.js'
-      - 'plugin-tests/**'
-      - '**.php'
-      - '.wp-env.json'
-      - '**/package.json'
-      - 'package-lock.json'
-      - 'phpunit.xml.dist'
-      - 'composer.json'
-      - 'composer.lock'
-    types:
-      - opened
-      - reopened
-      - synchronize
-
-jobs:
-  php-test:
-    name: PHP Integration Tests for Standalone Plugins
-    runs-on: ubuntu-latest
-    timeout-minutes: 20
-    strategy:
-      fail-fast: false
-      matrix:
-        php: [ '8.2', '8.1', '8.0', '7.4', '7.3', '7.2', '7.1', '7.0' ]
-        wp: [ 'latest' ]
-        include:
-        - php: '7.4'
-          wp: '6.4'
-        - php: '8.3'
-          wp: 'trunk'
-    env:
-      WP_ENV_PHP_VERSION: ${{ matrix.php }}
-      WP_ENV_CORE: ${{ matrix.wp == 'trunk' && 'WordPress/WordPress' || format( 'https://wordpress.org/wordpress-{0}.zip', matrix.wp ) }}
-    steps:
-      - uses: styfle/cancel-workflow-action@0.11.0
-      - uses: actions/checkout@v3
-      - uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php }}
-      - name: Setup Node.js (.nvmrc)
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: '.nvmrc'
-          cache: npm
-      - name: npm install
-        run: npm ci
-      - name: General debug information
-        run: |
-          npm --version
-          node --version
-          composer --version
-          php -v
-      - name: Running single site standalone plugin integration tests
-        run: npm run test-plugins
-      - name: Running multisite standalone plugin integration tests
-        run: npm run test-plugins-multisite
diff --git a/bin/plugin/cli.js b/bin/plugin/cli.js
index e60eb7c1a2..2ef437deda 100755
--- a/bin/plugin/cli.js
+++ b/bin/plugin/cli.js
@@ -34,10 +34,6 @@ const {
 	handler: readmeHandler,
 	options: readmeOptions,
 } = require( './commands/readme' );
-const {
-	handler: testPluginsHandler,
-	options: testPluginsOptions,
-} = require( './commands/test-plugins' );
 const {
 	handler: sinceHandler,
 	options: sinceOptions,
@@ -58,9 +54,4 @@ withOptions( program.command( 'plugin-readme' ), readmeOptions )
 	.description( 'Updates the readme.txt file' )
 	.action( catchException( readmeHandler ) );
 
-withOptions( program.command( 'test-standalone-plugins' ), testPluginsOptions )
-	.alias( 'test-plugins' )
-	.description( 'Test standalone plugins' )
-	.action( catchException( testPluginsHandler ) );
-
 program.parse( process.argv );
diff --git a/bin/plugin/commands/test-plugins.js b/bin/plugin/commands/test-plugins.js
deleted file mode 100644
index bb71e185cc..0000000000
--- a/bin/plugin/commands/test-plugins.js
+++ /dev/null
@@ -1,533 +0,0 @@
-/**
- * External dependencies
- */
-const fs = require( 'fs-extra' );
-const path = require( 'path' );
-const { execSync, spawnSync } = require( 'child_process' );
-
-/**
- * Internal dependencies
- */
-const { log, formats } = require( '../lib/logger' );
-
-/**
- * @typedef WPTestPluginsCommandOptions
- *
- * @property {string=} siteType Optional site type, 'single' or 'multi'. Defaults to single.
- */
-
-/**
- * @typedef WPDoReplaceWpEnvContent
- *
- * @property {string} wpEnvPluginsRegexPattern Regex to match against plugins property of .wp-env.json.
- * @property {string} wpEnvFile                Path to the plugin tests specific .wp-env.json file.
- * @property {string} wpEnvDestinationFile     Path to the final base .wp-env.json file.
- * @property {Object} builtPlugins             Array of plugins slugs from plugins json file.
- */
-
-/**
- * @typedef WPDoRunUnitTests
- *
- * @property {string} siteType             Site type. 'single' or 'multi'.
- * @property {Object} builtPlugins         Array of plugin slugs from plugins json file.
- * @property {Object} disablePlugins       Array of plugin slugs to deactivate on test run.
- * @property {Object} enablePlugins        Array of plugin slugs to activate on test run.
- * @property {string} wpEnvDestinationFile Path to the final base .wp-env.json file.
- */
-
-/**
- * @typedef WPTestPluginsSettings
- *
- * @property {string} pluginsJsonFile       Path to the plugins.json file used for building plugins.
- * @property {string} siteType              Site type. 'single' or 'multi'.
- * @property {string} pluginTestAssets      Path to 'plugin-tests' folder.
- * @property {string} builtPluginsDir       Path to 'build' directory.
- * @property {string} pluginsDir            Path to 'plugins' directory.
- * @property {string} wpEnvFile             Path to the plugin tests specific .wp-env.json file.
- * @property {string} wpEnvDestinationFile  Path to the final base .wp-env.json file.
- * @property {string} performancePluginSlug Slug of the main WPP plugin.
- */
-
-exports.options = [
-	{
-		argname: '-s, --sitetype <siteType>',
-		description: 'Whether to test "single" (default) or "multi" site.',
-	},
-];
-
-// Switch for flagging start of wp-env so it is not started multiple times.
-let isWpEnvStarted = false;
-
-// The Current directory from which the script is executed.
-// This should always be base plugin folder.
-const baseDirectory = process.cwd().match( /([^\/]*)\/*$/ )[ 1 ];
-
-/**
- * Command for testing all built standalone plugins.
- *
- * @param {WPTestPluginsCommandOptions} opt Command options.
- */
-exports.handler = async ( opt ) => {
-	doRunStandalonePluginTests( {
-		pluginsJsonFile: './plugins.json', // Path to plugins.json file.
-		siteType: opt.sitetype || 'single', // Site type.
-		pluginTestAssets: './plugin-tests', // plugin test assets.
-		builtPluginsDir: './build/', // Built plugins directory.
-		pluginsDir: './plugins/', // Plugins directory.
-		wpEnvFile: './plugin-tests/.wp-env.json', // Base .wp-env.json file for testing plugins.
-		wpEnvDestinationFile: './.wp-env.override.json', // Destination .wp-env.override.json file at root level.
-		wpEnvPluginsRegexPattern: '"plugins": \\[(.*)\\],', // Regex to match plugins string in .wp-env.json.
-		performancePluginSlug: baseDirectory, // The plugin slug of the main WPP plugin, should be the base directory.
-	} );
-};
-
-/**
- * Handles replacement of plugins array in .wp-env.json file.
- * Split into separate function in order to easily re-run tests with WPP plugin active.
- *
- * @param {WPDoReplaceWpEnvContent} settings Plugin test settings.
- */
-function doReplaceWpEnvContent( settings ) {
-	// Regex object to match wp-env plugins string.
-	const wpEnvPluginsRegex = new RegExp(
-		settings.wpEnvPluginsRegexPattern,
-		'gm'
-	);
-
-	let wpEnvPluginsRegexReplacement = '';
-
-	// Amend wp-env overrides file to reference built plugins only.
-	// Buffer .wp-env.json content var.
-	let wpEnvFileContent = '';
-
-	try {
-		wpEnvFileContent = fs.readFileSync( settings.wpEnvFile, 'utf-8' );
-	} catch ( e ) {
-		log(
-			formats.error(
-				`Error reading file "${ settings.wpEnvFile }": "${ e }"`
-			)
-		);
-
-		// Return with exit code 1 to trigger a failure in the test pipeline.
-		process.exit( 1 );
-	}
-
-	// If the contents of the file were incorrectly read or exception was not captured and value is blank, abort.
-	if ( '' === wpEnvFileContent ) {
-		log(
-			formats.error(
-				`File content for "${ settings.wpEnvFile }" is empty, aborting.`
-			)
-		);
-
-		// Return with exit code 1 to trigger a failure in the test pipeline.
-		process.exit( 1 );
-	}
-
-	// If we do not have a match on the wp-env enabled plugins regex, abort.
-	if ( ! wpEnvPluginsRegex.test( wpEnvFileContent ) ) {
-		log(
-			formats.error(
-				`Unable to find plugins property/key in WP Env config file: "${ settings.wpEnvFile }". Please ensure that it is present and try again.`
-			)
-		);
-
-		// Return with exit code 1 to trigger a failure in the test pipeline.
-		process.exit( 1 );
-	}
-
-	// Copy the newly modified wp-env overrides file to the root level if it does not exist.
-	if ( ! fs.pathExistsSync( settings.wpEnvDestinationFile ) ) {
-		try {
-			fs.copySync( settings.wpEnvFile, settings.wpEnvDestinationFile, {
-				overwrite: true,
-			} );
-			log(
-				formats.success(
-					`Copied wp-env overrides file to root level, ready to rewrite plugins.`
-				)
-			);
-		} catch ( e ) {
-			log(
-				formats.error(
-					`Error copying wp-env overrides file at "${ settings.wpEnvFile } to root level at "${ settings.wpEnvDestinationFile }". ${ e }`
-				)
-			);
-
-			// Return with exit code 1 to trigger a failure in the test pipeline.
-			process.exit( 1 );
-		}
-	}
-
-	// Let the user know we're re-writing the .wp-env.json file.
-	log(
-		formats.success(
-			`Rewriting plugins property in ${ settings.wpEnvDestinationFile }`
-		)
-	);
-
-	// Attempt replacement of the plugins property in .wp-env.json file to match built plugins.
-	try {
-		// Create plugins property from built plugins.
-		wpEnvPluginsRegexReplacement = `"plugins": [ "${ settings.builtPlugins
-			.map( ( item ) => {
-				if ( '.' === item ) {
-					// Do not append build dir for root plugin.
-					return item;
-				}
-
-				return `${ settings.builtPluginsDir }${ item }`;
-			} )
-			.join( '", "' ) }" ],`;
-
-		fs.writeFileSync(
-			settings.wpEnvDestinationFile,
-			wpEnvFileContent.replace(
-				wpEnvPluginsRegex,
-				wpEnvPluginsRegexReplacement
-			)
-		);
-	} catch ( e ) {
-		log(
-			formats.error(
-				`Error replacing content in ${ settings.wpEnvDestinationFile } using regex "${ wpEnvPluginsRegex }": "${ e }"`
-			)
-		);
-
-		// Return with exit code 1 to trigger a failure in the test pipeline.
-		process.exit( 1 );
-	}
-}
-/**
- * Handles starting of wp-env, running unit tests and stopping of wp-env.
- * Split into separate function in order to easily re-run tests with WPP plugin active.
- *
- * @param {WPDoRunUnitTests} settings Unit testing settings.
- */
-function doRunUnitTests( settings ) {
-	// Only start the wp-env environment if it is not already started.
-	if ( false === isWpEnvStarted ) {
-		// Start the wp-env environment.
-		log(
-			formats.success(
-				`Starting wp-env environment with active plugins: ${ settings.builtPlugins.join(
-					', '
-				) }`
-			)
-		);
-
-		// Exclude the main WPP plugin from actual traversion into build folder during testing.
-		if ( '.' === settings.builtPlugins[ 0 ] ) {
-			settings.builtPlugins.shift();
-		}
-
-		// Execute wp-env start.
-		execSync( `npm run wp-env start`, ( err, output ) => {
-			// once the command has completed, the callback function is called.
-			if ( err ) {
-				log( formats.error( `${ err }` ) );
-
-				// Return with exit code 1 to trigger a failure in the test pipeline.
-				process.exit( 1 );
-			}
-
-			// log the output received from the command.
-			log( output );
-		} );
-
-		// Flag that the env is now started.
-		isWpEnvStarted = true;
-
-		// Remove the wp-env overrides file.
-		try {
-			fs.unlinkSync( settings.wpEnvDestinationFile );
-		} catch ( error ) {
-			log(
-				formats.error(
-					`Error deleting file: ${ settings.wpEnvDestinationFile }. ${ error }`
-				)
-			);
-		}
-	}
-
-	// If there is the presence of an disablePlugins array, disable said plugins prior to testing.
-	if (
-		'undefined' !== typeof settings?.disablePlugins &&
-		settings.disablePlugins.constructor === Array &&
-		settings.disablePlugins.length > 0
-	) {
-		log(
-			formats.success(
-				`Detected plugins that need deactivating prior to running tests: ${ settings.disablePlugins.join(
-					', '
-				) }`
-			)
-		);
-		settings.disablePlugins.forEach( ( plugin ) => {
-			// Disable plugin via wp-cli.
-			execSync(
-				`wp-env run cli wp plugin deactivate ${ plugin }`,
-				( err, output ) => {
-					// once the command has completed, the callback function is called.
-					if ( err ) {
-						log( formats.error( `${ err }` ) );
-						return;
-					}
-					// log the output received from the command.
-					log( output );
-				}
-			);
-		} );
-	}
-
-	// If there is the presence of an enablePlugins array, enable said plugins prior to testing.
-	if (
-		'undefined' !== typeof settings?.enablePlugins &&
-		settings.enablePlugins.constructor === Array &&
-		settings.enablePlugins.length > 0
-	) {
-		log(
-			formats.success(
-				`Detected plugins that need activating prior to running tests: ${ settings.enablePlugins.join(
-					', '
-				) }`
-			)
-		);
-		settings.enablePlugins.forEach( ( plugin ) => {
-			// Disable plugin via wp-cli.
-			execSync(
-				`wp-env run cli wp plugin activate ${ plugin }`,
-				( err, output ) => {
-					// once the command has completed, the callback function is called.
-					if ( err ) {
-						log( formats.error( `${ err }` ) );
-						return;
-					}
-					// log the output received from the command.
-					log( output );
-				}
-			);
-		} );
-	}
-
-	// Run tests per plugin.
-	settings.builtPlugins.forEach( ( plugin ) => {
-		log(
-			formats.success(
-				`Running plugin integration tests for plugin: "${ plugin }"`
-			)
-		);
-
-		execSync(
-			`composer install --working-dir=${ settings.builtPluginsDir }${ plugin } --no-interaction`,
-			( err, output ) => {
-				if ( err ) {
-					log( formats.error( `${ err }` ) );
-					process.exit( 1 );
-				}
-				// log the output received from the command
-				log( output );
-			}
-		);
-
-		// Define multi site flag based on single vs multi sitetype arg.
-		const isMultiSite = 'multi' === settings.siteType;
-		let command = '';
-
-		if ( isMultiSite ) {
-			command = spawnSync(
-				'wp-env',
-				[
-					'run',
-					'tests-cli',
-					`--env-cwd=/var/www/html/wp-content/plugins/${ plugin } vendor/bin/phpunit -c multisite.xml --verbose --testdox`,
-				],
-				{ shell: true, encoding: 'utf8' }
-			);
-		} else {
-			command = spawnSync(
-				'wp-env',
-				[
-					'run',
-					'tests-cli',
-					`--env-cwd=/var/www/html/wp-content/plugins/${ plugin } vendor/bin/phpunit -c phpunit.xml --verbose --testdox`,
-				],
-				{ shell: true, encoding: 'utf8' }
-			);
-		}
-
-		log( command.stdout.replace( '\n', '' ) );
-
-		if ( 1 === command.status ) {
-			// Log error.
-			log( formats.error( command.stderr.replace( '\n', '' ) ) );
-
-			log(
-				formats.error(
-					`One or more tests failed for plugin ${ plugin }`
-				)
-			);
-
-			// Return with exit code 1 to trigger a failure in the test pipeline.
-			process.exit( 1 );
-		}
-	} );
-}
-
-/**
- * Runs standalone plugin tests in single or multisite environments.
- *
- * @param {WPTestPluginsSettings} settings Plugin test settings.
- */
-function doRunStandalonePluginTests( settings ) {
-	// Check if the siteType arg is one of single or multi.
-	if ( 'single' !== settings.siteType && 'multi' !== settings.siteType ) {
-		log(
-			formats.error( `--sitetype must be one of "single" or "multi".` )
-		);
-
-		// Return with exit code 1 to trigger a failure in the test pipeline.
-		process.exit( 1 );
-	}
-
-	// If the base .wp-env.json file for testing plugins is missing, abort.
-	if ( ! fs.pathExistsSync( settings.wpEnvFile ) ) {
-		log(
-			formats.error(
-				`WP Env config file "${ settings.wpEnvFile }" not detected in root of project.`
-			)
-		);
-
-		// Return with exit code 1 to trigger a failure in the test pipeline.
-		process.exit( 1 );
-	}
-
-	// Buffer built plugins array.
-	let builtPlugins = [];
-
-	// Resolve the absolute path to the plugins.json file.
-	const pluginsFile = path.join(
-		__dirname,
-		'../../../' + settings.pluginsJsonFile
-	);
-
-	try {
-		// Read the plugins.json file synchronously.
-		const { plugins } = require( pluginsFile );
-
-		// Create an array of plugins from entries in plugins JSON file.
-		builtPlugins = Object.values( plugins )
-			.filter( ( plugin ) => {
-				try {
-					fs.copySync(
-						`${ settings.pluginsDir }${ plugin }/`,
-						`${ settings.builtPluginsDir }${ plugin }/`,
-						{
-							overwrite: true,
-						}
-					);
-					log( formats.success( `Copied plugin "${ plugin }".\n` ) );
-					return true;
-				} catch ( e ) {
-					// Handle the error appropriately
-					log(
-						formats.error(
-							`Error copying plugin "${ plugin }": ${ e.message }`
-						)
-					);
-					return false;
-				}
-			} )
-			.map( ( plugin ) => plugin );
-	} catch ( error ) {
-		throw Error( `Error reading file at "${ pluginsFile }": ${ error }` );
-	}
-
-	// For each built plugin, copy the test assets.
-	builtPlugins.forEach( ( plugin ) => {
-		log(
-			formats.success(
-				`Detected built plugin "${ plugin }", copying test files for standalone/integration testing.`
-			)
-		);
-
-		// Copy over test files.
-		try {
-			fs.copySync(
-				settings.pluginTestAssets,
-				`${ settings.builtPluginsDir }${ plugin }/`,
-				{
-					overwrite: true,
-				}
-			);
-			log(
-				formats.success(
-					`Copied test assets for plugin "${ plugin }", executing "composer install --no-interaction" on plugin.\n`
-				)
-			);
-		} catch ( e ) {
-			log(
-				formats.error(
-					`Error copying test assets for plugin "${ plugin }". ${ e }`
-				)
-			);
-
-			// Return with exit code 1 to trigger a failure in the test pipeline.
-			process.exit( 1 );
-		}
-
-		// Execute composer install within built plugin following copy.
-		execSync(
-			`composer install --working-dir=${ settings.builtPluginsDir }${ plugin } --no-interaction`,
-			( err, output ) => {
-				if ( err ) {
-					log( formats.error( `${ err }` ) );
-					process.exit( 1 );
-				}
-				// log the output received from the command
-				log( output );
-			}
-		);
-	} );
-
-	// Add the root level WPP plugin to the built plugins array.
-	// This allows us tests with WPP plugin active if desired.
-	builtPlugins.unshift( '.' );
-
-	// Handle replacement of wp-env file content for round 1 of testing without root plugin.
-	doReplaceWpEnvContent( { ...settings, builtPlugins } );
-
-	// Run unit tests with main WPP plugin disabled.
-	const disablePlugins = [ settings.performancePluginSlug ];
-
-	log( 'Running integration tests with main WPP plugin inactive.' );
-	doRunUnitTests( { ...settings, builtPlugins, disablePlugins } );
-
-	// Re-run unit tests against built plugins, with WPP plugin active as well.
-	const enablePlugins = [ settings.performancePluginSlug ];
-
-	log( 'Running integration tests with main WPP plugin active.' );
-	doRunUnitTests( { ...settings, builtPlugins, enablePlugins } );
-
-	// If we've reached this far, all tests have passed.
-	log(
-		formats.success(
-			`All standalone plugin tests appeared to have passed.`
-		)
-	);
-
-	// Stop wp-env.
-	execSync( `wp-env stop`, ( err, output ) => {
-		// once the command has completed, the callback function is called.
-		if ( err ) {
-			log( formats.error( `${ err }` ) );
-			return;
-		}
-		// log the output received from the command.
-		log( output );
-	} );
-
-	// Return with exit code 0 to trigger a success in the test pipeline.
-	process.exit( 0 );
-}
diff --git a/package.json b/package.json
index fc56085139..f292f5aba7 100644
--- a/package.json
+++ b/package.json
@@ -31,8 +31,6 @@
     "build:plugin:dominant-color-images": "webpack --mode production --env plugin=dominant-color-images",
     "build:plugin:speculation-rules": "webpack --mode production --env plugin=speculation-rules",
     "build:plugin:webp-uploads": "webpack --mode production --env plugin=webp-uploads",
-    "test-plugins": "./bin/plugin/cli.js test-plugins",
-    "test-plugins-multisite": "./bin/plugin/cli.js test-plugins --sitetype=multi",
     "format-js": "wp-scripts format",
     "lint-js": "wp-scripts lint-js",
     "format-php": "composer format",