@wordpress/env 4.7.0 → 5.0.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 ## Unreleased
 
+## 5.0.0 (2022-07-27)
+
+### Breaking Changes
+-   Removed the `WP_PHPUNIT__TESTS_CONFIG` environment variable from the `phpunit` container. **This removes automatic support for the `wp-phpunit/wp-phpunit` Composer package. To continue using the package, set the following two environment variables in your `phpunit.xml` file or similar: `WP_TESTS_DIR=""` and `WP_PHPUNIT__TESTS_CONFIG="/wordpress-phpunit/wp-tests-config.php"`.**
+-   Removed the generated `/var/www/html/phpunit-wp-config.php` file from the environment.
+
+### Enhancement
+-   Read WordPress' version and include the corresponding PHPUnit test files in the environment.
+-   Set the `WP_TESTS_DIR` environment variable in all containers to point at the PHPUnit test files.
+
+### Bug Fix
+-   Restrict `WP_TESTS_DOMAIN` constant to just hostname rather than an entire URL (e.g. it now excludes scheme, port, etc.) ([#41039](https://github.com/WordPress/gutenberg/pull/41039)).
+
+## 4.8.0 (2022-06-01)
+
+### Enhancement
+-   Removed the need for quotation marks when passing options to `wp-env run`.
+-   Setting a `config` key to `null` will prevent adding the constant to `wp-config.php` even if a default value is defined by `wp-env`.
+
 ## 4.7.0 (2022-05-18)
 
 ### Enhancement

package/README.md

@@ -188,6 +188,14 @@ wp-env start --debug
 	...
 ```
 
+## Using included WordPress PHPUnit test files
+
+Out of the box `wp-env` includes the [WordPress' PHPUnit test files](https://develop.svn.wordpress.org/trunk/tests/phpunit/) corresponding to the version of WordPress installed. There is an environment variable, `WP_TESTS_DIR`, which points to the location of these files within each container. By including these files in the environment, we remove the need for you to use a package or install and mount them yourself. If you do not want to use these files, you should ignore the `WP_TESTS_DIR` environment variable and load them from the location of your choosing.
+
+### Customizing the `wp-tests-config.php` file
+
+While we do provide a default `wp-tests-config.php` file within the environment, there may be cases where you want to use your own. WordPress provides a `WP_TESTS_CONFIG_FILE_PATH` constant that you can use to change the `wp-config.php` file used for testing. Set this to a desired path in your `bootstrap.php` file and the file you've chosen will be used instead of the one included in the environment.
+
 ## Using Xdebug
 
 Xdebug is installed in the wp-env environment, but it is turned off by default. To enable Xdebug, you can use the `--xdebug` flag with the `wp-env start` command. Here is a reference to how the flag works:
@@ -300,21 +308,23 @@ Positionals:
 The run command can be used to open shell sessions or invoke WP-CLI commands.
 
 <div class="callout callout-alert">
-To run a WP-CLI command that includes optional arguments, enclose the WP-CLI command in quotation marks; otherwise, the optional arguments are ignored. This is because flags are normally passed to `wp-env` itself, meaning that the flags are not considered part of the argument that specifies the WP-CLI command. With quotation marks, `wp-env` considers everything inside quotation marks the WP-CLI command argument.
+In some cases, `wp-env` may consume options that you are attempting to pass to 
+the container. This happens with options that `wp-env` has already declared,
+such as `--debug`, `--help`, and `--version`. When this happens, you should fall
+back to using quotation marks; `wp-env` considers everything inside the
+quotation marks to be command argument.
 
-For example, to list cron schedules with optional arguments that specify the fields returned and the format of the output:
+For example, to ask `WP-CLI` for its help text:
 
 ```sh
-wp-env run cli "wp cron schedule list --fields=name --format=csv"
+wp-env run cli "wp --help"
 ```
 
-Without the quotation marks, WP-CLI lists the schedule in its default format, ignoring the `fields` and `format` arguments.
+Without the quotation marks, `wp-env` will print its own help text instead of
+passing it to the container. If you experience any problems where the command
+is not being passed correctly, fall back to using quotation marks.
 </div>
 
-Note that quotation marks are not required for a WP-CLI command that excludes optional arguments, although it does not hurt to include them. For example, the following command syntaxes return identical results: `wp-env run cli "wp cron schedule list"` or `wp-env run cli wp cron schedule list`.
-
-For more information about all the available commands, see [WP-CLI Commands](https://developer.wordpress.org/cli/commands/).
-
 ```sh
 wp-env run <container> [command..]
 
@@ -323,11 +333,7 @@ Runs an arbitrary command in one of the underlying Docker containers. The
 "development", "tests", or "cli". To run a wp-cli command, use the "cli" or
 "tests-cli" service. You can also use this command to open shell sessions like
 bash and the WordPress shell in the WordPress instance. For example, `wp-env run
-cli bash` will open bash in the development WordPress instance. When using long
-commands with arguments and quotation marks, you need to wrap the "command"
-param in quotation marks. For example: `wp-env run tests-cli "wp post create
---post_type=page --post_title='Test'"` will create a post on the tests WordPress
-instance.
+cli bash` will open bash in the development WordPress instance.
 
 Positionals:
   container  The container to run the command on.            [string] [required]
@@ -464,7 +470,7 @@ Several types of strings can be passed into the `core`, `plugins`, `themes`, and
 | ----------------- | -------------------------------------------- | -------------------------------------------------------- |
 | Relative path     | `.<path>\|~<path>`                           | `"./a/directory"`, `"../a/directory"`, `"~/a/directory"` |
 | Absolute path     | `/<path>\|<letter>:\<path>`                  | `"/a/directory"`, `"C:\\a\\directory"`                   |
-| GitHub repository | `<owner>/<repo>[#<ref>]`                     | `"WordPress/WordPress"`, `"WordPress/gutenberg#trunk"`   |
+| GitHub repository | `<owner>/<repo>[#<ref>]`                     | `"WordPress/WordPress"`, `"WordPress/gutenberg#trunk"`, if no branch is provided wp-env will fall back to the repos default branch |
 | SSH repository    | `ssh://user@host/<owner>/<repo>.git[#<ref>]` | `"ssh://git@github.com/WordPress/WordPress.git"`         |
 | ZIP File          | `http[s]://<host>/<path>.zip`                | `"https://wordpress.org/wordpress-5.4-beta2.zip"`        |
 
@@ -513,13 +519,15 @@ SCRIPT_DEBUG: true,
 WP_PHP_BINARY: 'php',
 WP_TESTS_EMAIL: 'admin@example.org',
 WP_TESTS_TITLE: 'Test Blog',
-WP_TESTS_DOMAIN: 'http://localhost',
+WP_TESTS_DOMAIN: 'localhost',
 WP_SITEURL: 'http://localhost',
 WP_HOME: 'http://localhost',
 ```
 
 On the test instance, all of the above are still defined, but `WP_DEBUG` and `SCRIPT_DEBUG` are set to false.
 
+These can be overridden by setting a value within the `config` configuration. Setting it to `null` will prevent the constant being defined entirely.
+
 Additionally, the values referencing a URL include the specified port for the given environment. So if you set `testsPort: 3000, port: 2000`, `WP_HOME` (for example) will be `http://localhost:3000` on the tests instance and `http://localhost:2000` on the development instance.
 
 ### Examples

package/lib/build-docker-compose-config.js

@@ -19,13 +19,18 @@ const { dbEnv } = require( './config' );
 /**
  * Gets the volume mounts for an individual service.
  *
- * @param {WPServiceConfig} config           The service config to get the mounts from.
- * @param {string}          wordpressDefault The default internal path for the WordPress
- *                                           source code (such as tests-wordpress).
+ * @param {string}          workDirectoryPath The working directory for wp-env.
+ * @param {WPServiceConfig} config            The service config to get the mounts from.
+ * @param {string}          wordpressDefault  The default internal path for the WordPress
+ *                                            source code (such as tests-wordpress).
  *
  * @return {string[]} An array of volumes to mount in string format.
  */
-function getMounts( config, wordpressDefault = 'wordpress' ) {
+function getMounts(
+	workDirectoryPath,
+	config,
+	wordpressDefault = 'wordpress'
+) {
 	// Top-level WordPress directory mounts (like wp-content/themes)
 	const directoryMounts = Object.entries( config.mappings ).map(
 		( [ wpDir, source ] ) => `${ source.path }:/var/www/html/${ wpDir }`
@@ -45,9 +50,19 @@ function getMounts( config, wordpressDefault = 'wordpress' ) {
 		config.coreSource ? config.coreSource.path : wordpressDefault
 	}:/var/www/html`;
 
+	const corePHPUnitMount = `${ path.join(
+		workDirectoryPath,
+		wordpressDefault === 'wordpress'
+			? 'WordPress-PHPUnit'
+			: 'tests-WordPress-PHPUnit',
+		'tests',
+		'phpunit'
+	) }:/wordpress-phpunit`;
+
 	return [
 		...new Set( [
 			coreMount,
+			corePHPUnitMount,
 			...directoryMounts,
 			...pluginMounts,
 			...themeMounts,
@@ -64,8 +79,15 @@ function getMounts( config, wordpressDefault = 'wordpress' ) {
  * @return {Object} A docker-compose config object, ready to serialize into YAML.
  */
 module.exports = function buildDockerComposeConfig( config ) {
-	const developmentMounts = getMounts( config.env.development );
-	const testsMounts = getMounts( config.env.tests, 'tests-wordpress' );
+	const developmentMounts = getMounts(
+		config.workDirectoryPath,
+		config.env.development
+	);
+	const testsMounts = getMounts(
+		config.workDirectoryPath,
+		config.env.tests,
+		'tests-wordpress'
+	);
 
 	// When both tests and development reference the same WP source, we need to
 	// ensure that tests pulls from a copy of the files so that it maintains
@@ -208,6 +230,7 @@ module.exports = function buildDockerComposeConfig( config ) {
 				environment: {
 					...dbEnv.credentials,
 					...dbEnv.development,
+					WP_TESTS_DIR: '/wordpress-phpunit',
 				},
 				volumes: developmentMounts,
 			},
@@ -218,6 +241,7 @@ module.exports = function buildDockerComposeConfig( config ) {
 				environment: {
 					...dbEnv.credentials,
 					...dbEnv.tests,
+					WP_TESTS_DIR: '/wordpress-phpunit',
 				},
 				volumes: testsMounts,
 			},
@@ -229,6 +253,7 @@ module.exports = function buildDockerComposeConfig( config ) {
 				environment: {
 					...dbEnv.credentials,
 					...dbEnv.development,
+					WP_TESTS_DIR: '/wordpress-phpunit',
 				},
 			},
 			'tests-cli': {
@@ -239,6 +264,7 @@ module.exports = function buildDockerComposeConfig( config ) {
 				environment: {
 					...dbEnv.credentials,
 					...dbEnv.tests,
+					WP_TESTS_DIR: '/wordpress-phpunit',
 				},
 			},
 			composer: {
@@ -256,8 +282,7 @@ module.exports = function buildDockerComposeConfig( config ) {
 				],
 				environment: {
 					LOCAL_DIR: 'html',
-					WP_PHPUNIT__TESTS_CONFIG:
-						'/var/www/html/phpunit-wp-config.php',
+					WP_TESTS_DIR: '/wordpress-phpunit',
 					...dbEnv.credentials,
 					...dbEnv.tests,
 				},

package/lib/cli.js

@@ -22,57 +22,61 @@ const wpRed = boldWhite.bgHex( '#d94f4f' );
 const wpYellow = boldWhite.bgHex( '#f0b849' );
 
 // Spinner.
-const withSpinner = ( command ) => ( ...args ) => {
-	const spinner = ora().start();
-	args[ 0 ].spinner = spinner;
-	let time = process.hrtime();
-	return command( ...args ).then(
-		( message ) => {
-			time = process.hrtime( time );
-			spinner.succeed(
-				`${ message || spinner.text } (in ${ time[ 0 ] }s ${ (
-					time[ 1 ] / 1e6
-				).toFixed( 0 ) }ms)`
-			);
-			process.exit( 0 );
-		},
-		( error ) => {
-			if ( error instanceof env.ValidationError ) {
-				// Error is a validation error. That means the user did something wrong.
-				spinner.fail( error.message );
-				process.exit( 1 );
-			} else if (
-				error &&
-				typeof error === 'object' &&
-				'exitCode' in error &&
-				'err' in error &&
-				'out' in error
-			) {
-				// Error is a docker-compose error. That means something docker-related failed.
-				// https://github.com/PDMLab/docker-compose/blob/HEAD/src/index.ts
-				spinner.fail( 'Error while running docker-compose command.' );
-				if ( error.out ) {
-					process.stdout.write( error.out );
-				}
-				if ( error.err ) {
-					process.stderr.write( error.err );
-				}
-				process.exit( error.exitCode );
-			} else if ( error ) {
-				// Error is an unknown error. That means there was a bug in our code.
-				spinner.fail(
-					typeof error === 'string' ? error : error.message
+const withSpinner =
+	( command ) =>
+	( ...args ) => {
+		const spinner = ora().start();
+		args[ 0 ].spinner = spinner;
+		let time = process.hrtime();
+		return command( ...args ).then(
+			( message ) => {
+				time = process.hrtime( time );
+				spinner.succeed(
+					`${ message || spinner.text } (in ${ time[ 0 ] }s ${ (
+						time[ 1 ] / 1e6
+					).toFixed( 0 ) }ms)`
 				);
-				// Disable reason: Using console.error() means we get a stack trace.
-				console.error( error );
-				process.exit( 1 );
-			} else {
-				spinner.fail( 'An unknown error occured.' );
-				process.exit( 1 );
+				process.exit( 0 );
+			},
+			( error ) => {
+				if ( error instanceof env.ValidationError ) {
+					// Error is a validation error. That means the user did something wrong.
+					spinner.fail( error.message );
+					process.exit( 1 );
+				} else if (
+					error &&
+					typeof error === 'object' &&
+					'exitCode' in error &&
+					'err' in error &&
+					'out' in error
+				) {
+					// Error is a docker-compose error. That means something docker-related failed.
+					// https://github.com/PDMLab/docker-compose/blob/HEAD/src/index.ts
+					spinner.fail(
+						'Error while running docker-compose command.'
+					);
+					if ( error.out ) {
+						process.stdout.write( error.out );
+					}
+					if ( error.err ) {
+						process.stderr.write( error.err );
+					}
+					process.exit( error.exitCode );
+				} else if ( error ) {
+					// Error is an unknown error. That means there was a bug in our code.
+					spinner.fail(
+						typeof error === 'string' ? error : error.message
+					);
+					// Disable reason: Using console.error() means we get a stack trace.
+					console.error( error );
+					process.exit( 1 );
+				} else {
+					spinner.fail( 'An unknown error occured.' );
+					process.exit( 1 );
+				}
 			}
-		}
-	);
-};
+		);
+	};
 
 module.exports = function cli() {
 	// Do nothing if Docker is unavailable.
@@ -92,6 +96,10 @@ module.exports = function cli() {
 		default: false,
 	} );
 
+	// Make sure any unknown arguments are passed to the command as arguments.
+	// This allows options to be passed to "run" without being quoted.
+	yargs.parserConfiguration( { 'unknown-options-as-args': true } );
+
 	yargs.command(
 		'start',
 		wpGreen(
@@ -171,7 +179,7 @@ module.exports = function cli() {
 				describe: 'The container to run the command on.',
 			} );
 			args.positional( 'command', {
-				type: 'string',
+				type: 'array',
 				describe: 'The command to run.',
 			} );
 		},
@@ -189,6 +197,7 @@ module.exports = function cli() {
 		'$0 run tests-cli bash',
 		'Open a bash session in the WordPress tests instance.'
 	);
+
 	yargs.command(
 		'destroy',
 		wpRed(

package/lib/commands/run.js

@@ -9,7 +9,7 @@ const { spawn } = require( 'child_process' );
 const initConfig = require( '../init-config' );
 
 /**
- * @typedef {import('../config').Config} Config
+ * @typedef {import('../config').WPConfig} WPConfig
  */
 
 /**
@@ -42,11 +42,11 @@ module.exports = async function run( { container, command, spinner, debug } ) {
 /**
  * Runs an arbitrary command on the given Docker container.
  *
- * @param {Object} options
- * @param {string} options.container The Docker container to run the command on.
- * @param {string} options.command   The command to run.
- * @param {Config} options.config    The wp-env configuration.
- * @param {Object} options.spinner   A CLI spinner which indicates progress.
+ * @param {Object}   options
+ * @param {string}   options.container The Docker container to run the command on.
+ * @param {string}   options.command   The command to run.
+ * @param {WPConfig} options.config    The wp-env configuration.
+ * @param {Object}   options.spinner   A CLI spinner which indicates progress.
  */
 function spawnCommandDirectly( { container, command, config, spinner } ) {
 	const composeCommand = [

package/lib/commands/start.js

@@ -21,16 +21,18 @@ const retry = require( '../retry' );
 const stop = require( './stop' );
 const initConfig = require( '../init-config' );
 const downloadSources = require( '../download-sources' );
+const downloadWPPHPUnit = require( '../download-wp-phpunit' );
 const {
 	checkDatabaseConnection,
 	configureWordPress,
 	setupWordPressDirectories,
+	readWordPressVersion,
 } = require( '../wordpress' );
 const { didCacheChange, setCache } = require( '../cache' );
 const md5 = require( '../md5' );
 
 /**
- * @typedef {import('../config').Config} Config
+ * @typedef {import('../config').WPConfig} WPConfig
  */
 const CONFIG_CACHE_KEY = 'config_checksum';
 
@@ -127,7 +129,25 @@ module.exports = async function start( { spinner, debug, update, xdebug } ) {
 	] );
 
 	if ( shouldConfigureWp ) {
+		spinner.text = 'Setting up WordPress directories';
+
 		await setupWordPressDirectories( config );
+
+		// Use the WordPress versions to download the PHPUnit suite.
+		const wpVersions = await Promise.all( [
+			readWordPressVersion(
+				config.env.development.coreSource,
+				spinner,
+				debug
+			),
+			readWordPressVersion( config.env.tests.coreSource, spinner, debug ),
+		] );
+		await downloadWPPHPUnit(
+			config,
+			{ development: wpVersions[ 0 ], tests: wpVersions[ 1 ] },
+			spinner,
+			debug
+		);
 	}
 
 	spinner.text = 'Starting WordPress.';
@@ -173,7 +193,7 @@ module.exports = async function start( { spinner, debug, update, xdebug } ) {
 	}
 
 	const siteUrl = config.env.development.config.WP_SITEURL;
-	const e2eSiteUrl = config.env.tests.config.WP_TESTS_DOMAIN;
+	const e2eSiteUrl = `http://${ config.env.tests.config.WP_TESTS_DOMAIN }:${ config.env.tests.port }/`;
 
 	const { out: mySQLAddress } = await dockerCompose.port(
 		'mysql',

package/lib/config/config.js

@@ -83,7 +83,7 @@ module.exports = async function readConfig( configPath ) {
 			WP_PHP_BINARY: 'php',
 			WP_TESTS_EMAIL: 'admin@example.org',
 			WP_TESTS_TITLE: 'Test Blog',
-			WP_TESTS_DOMAIN: 'http://localhost',
+			WP_TESTS_DOMAIN: 'localhost',
 			WP_SITEURL: 'http://localhost',
 			WP_HOME: 'http://localhost',
 		},
@@ -297,7 +297,6 @@ function withOverrides( config ) {
 	};
 
 	// Update wp config options to include the correct port number in the URL.
-	updateEnvUrl( 'WP_TESTS_DOMAIN' );
 	updateEnvUrl( 'WP_SITEURL' );
 	updateEnvUrl( 'WP_HOME' );
 

package/lib/config/parse-config.js

@@ -133,7 +133,7 @@ function parseSourceString( sourceString, { workDirectoryPath } ) {
 			return {
 				type: 'git',
 				url: sshUrl.href.split( '#' )[ 0 ],
-				ref: sshUrl.hash.slice( 1 ) || 'master',
+				ref: sshUrl.hash.slice( 1 ) || undefined,
 				path: workingPath,
 				clonePath: workingPath,
 				basename,
@@ -144,11 +144,12 @@ function parseSourceString( sourceString, { workDirectoryPath } ) {
 	const gitHubFields = sourceString.match(
 		/^([^\/]+)\/([^#\/]+)(\/([^#]+))?(?:#(.+))?$/
 	);
+
 	if ( gitHubFields ) {
 		return {
 			type: 'git',
 			url: `https://github.com/${ gitHubFields[ 1 ] }/${ gitHubFields[ 2 ] }.git`,
-			ref: gitHubFields[ 5 ] || 'master',
+			ref: gitHubFields[ 5 ],
 			path: path.resolve(
 				workDirectoryPath,
 				gitHubFields[ 2 ],

package/lib/config/test/__snapshots__/config.js.snap

@@ -17,7 +17,7 @@ Object {
         "WP_HOME": "http://localhost:2000/",
         "WP_PHP_BINARY": "php",
         "WP_SITEURL": "http://localhost:2000/",
-        "WP_TESTS_DOMAIN": "http://localhost:2000/",
+        "WP_TESTS_DOMAIN": "localhost",
         "WP_TESTS_EMAIL": "admin@example.org",
         "WP_TESTS_TITLE": "Test Blog",
       },
@@ -40,7 +40,7 @@ Object {
         "WP_HOME": "http://localhost:1000/",
         "WP_PHP_BINARY": "php",
         "WP_SITEURL": "http://localhost:1000/",
-        "WP_TESTS_DOMAIN": "http://localhost:1000/",
+        "WP_TESTS_DOMAIN": "localhost",
         "WP_TESTS_EMAIL": "admin@example.org",
         "WP_TESTS_TITLE": "Test Blog",
       },
@@ -64,7 +64,7 @@ Object {
   "WP_HOME": "http://localhost:8889/",
   "WP_PHP_BINARY": "php",
   "WP_SITEURL": "http://localhost:8889/",
-  "WP_TESTS_DOMAIN": "http://localhost:8889/",
+  "WP_TESTS_DOMAIN": "localhost",
   "WP_TESTS_EMAIL": "admin@example.org",
   "WP_TESTS_TITLE": "Test Blog",
 }
@@ -78,7 +78,7 @@ Object {
   "WP_HOME": "http://localhost:8888/",
   "WP_PHP_BINARY": "php",
   "WP_SITEURL": "http://localhost:8888/",
-  "WP_TESTS_DOMAIN": "http://localhost:8888/",
+  "WP_TESTS_DOMAIN": "localhost",
   "WP_TESTS_EMAIL": "admin@example.org",
   "WP_TESTS_TITLE": "Test Blog",
 }

package/lib/config/test/config.js

@@ -265,17 +265,17 @@ describe( 'readConfig', () => {
 				pluginSources: [
 					{
 						type: 'local',
-						path: expect.stringMatching( /^(\/||\\).*relative$/ ),
+						path: expect.stringMatching( /^(\/|\\).*relative$/ ),
 						basename: 'relative',
 					},
 					{
 						type: 'local',
-						path: expect.stringMatching( /^(\/||\\).*parent$/ ),
+						path: expect.stringMatching( /^(\/|\\).*parent$/ ),
 						basename: 'parent',
 					},
 					{
 						type: 'local',
-						path: expect.stringMatching( /^(\/||\\).*home$/ ),
+						path: expect.stringMatching( /^(\/|\\).*home$/ ),
 						basename: 'home',
 					},
 				],
@@ -284,17 +284,17 @@ describe( 'readConfig', () => {
 				pluginSources: [
 					{
 						type: 'local',
-						path: expect.stringMatching( /^(\/||\\).*relative$/ ),
+						path: expect.stringMatching( /^(\/|\\).*relative$/ ),
 						basename: 'relative',
 					},
 					{
 						type: 'local',
-						path: expect.stringMatching( /^(\/||\\).*parent$/ ),
+						path: expect.stringMatching( /^(\/|\\).*parent$/ ),
 						basename: 'parent',
 					},
 					{
 						type: 'local',
-						path: expect.stringMatching( /^(\/||\\).*home$/ ),
+						path: expect.stringMatching( /^(\/|\\).*home$/ ),
 						basename: 'home',
 					},
 				],
@@ -324,28 +324,28 @@ describe( 'readConfig', () => {
 			expect( config.env.development.pluginSources ).toEqual( [
 				{
 					type: 'local',
-					path: expect.stringMatching( /^(\/||\\).*test1a$/ ),
+					path: expect.stringMatching( /^(\/|\\).*test1a$/ ),
 					basename: 'test1a',
 				},
 			] );
 			expect( config.env.development.themeSources ).toEqual( [
 				{
 					type: 'local',
-					path: expect.stringMatching( /^(\/||\\).*test2a$/ ),
+					path: expect.stringMatching( /^(\/|\\).*test2a$/ ),
 					basename: 'test2a',
 				},
 			] );
 			expect( config.env.tests.pluginSources ).toEqual( [
 				{
 					type: 'local',
-					path: expect.stringMatching( /^(\/||\\).*test1b$/ ),
+					path: expect.stringMatching( /^(\/|\\).*test1b$/ ),
 					basename: 'test1b',
 				},
 			] );
 			expect( config.env.tests.themeSources ).toEqual( [
 				{
 					type: 'local',
-					path: expect.stringMatching( /^(\/||\\).*test2b$/ ),
+					path: expect.stringMatching( /^(\/|\\).*test2b$/ ),
 					basename: 'test2b',
 				},
 			] );
@@ -359,18 +359,18 @@ describe( 'readConfig', () => {
 			expect( config.env.development ).toMatchObject( {
 				coreSource: {
 					type: 'local',
-					path: expect.stringMatching( /^(\/||\\).*relative$/ ),
+					path: expect.stringMatching( /^(\/|\\).*relative$/ ),
 					testsPath: expect.stringMatching(
-						/^(\/||\\).*tests-relative$/
+						/^(\/|\\).*tests-relative$/
 					),
 				},
 			} );
 			expect( config.env.tests ).toMatchObject( {
 				coreSource: {
 					type: 'local',
-					path: expect.stringMatching( /^(\/||\\).*relative$/ ),
+					path: expect.stringMatching( /^(\/|\\).*relative$/ ),
 					testsPath: expect.stringMatching(
-						/^(\/||\\).*tests-relative$/
+						/^(\/|\\).*tests-relative$/
 					),
 				},
 			} );
@@ -395,31 +395,30 @@ describe( 'readConfig', () => {
 					{
 						type: 'git',
 						url: 'https://github.com/WordPress/gutenberg.git',
-						ref: 'master',
-						path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
+						ref: undefined,
+						path: expect.stringMatching( /^(\/|\\).*gutenberg$/ ),
 						basename: 'gutenberg',
 					},
 					{
 						type: 'git',
 						url: 'https://github.com/WordPress/gutenberg.git',
 						ref: 'trunk',
-						path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
+						path: expect.stringMatching( /^(\/|\\).*gutenberg$/ ),
 						basename: 'gutenberg',
 					},
 					{
 						type: 'git',
 						url: 'https://github.com/WordPress/gutenberg.git',
 						ref: '5.0',
-						path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
+						path: expect.stringMatching( /^(\/|\\).*gutenberg$/ ),
 						basename: 'gutenberg',
 					},
 					{
 						type: 'git',
-						url:
-							'https://github.com/WordPress/theme-experiments.git',
+						url: 'https://github.com/WordPress/theme-experiments.git',
 						ref: 'tt1-blocks@0.4.3',
 						path: expect.stringMatching(
-							/^(\/||\\).*theme-experiments(\/||\\)tt1-blocks$/
+							/^(\/|\\).*theme-experiments(\/|\\)tt1-blocks$/
 						),
 						basename: 'tt1-blocks',
 					},
@@ -447,33 +446,29 @@ describe( 'readConfig', () => {
 				pluginSources: [
 					{
 						type: 'zip',
-						url:
-							'https://downloads.wordpress.org/plugin/gutenberg.zip',
-						path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
+						url: 'https://downloads.wordpress.org/plugin/gutenberg.zip',
+						path: expect.stringMatching( /^(\/|\\).*gutenberg$/ ),
 						basename: 'gutenberg',
 					},
 					{
 						type: 'zip',
-						url:
-							'https://downloads.wordpress.org/plugin/gutenberg.8.1.0.zip',
-						path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
+						url: 'https://downloads.wordpress.org/plugin/gutenberg.8.1.0.zip',
+						path: expect.stringMatching( /^(\/|\\).*gutenberg$/ ),
 						basename: 'gutenberg',
 					},
 					{
 						type: 'zip',
-						url:
-							'https://downloads.wordpress.org/theme/twentytwenty.zip',
+						url: 'https://downloads.wordpress.org/theme/twentytwenty.zip',
 						path: expect.stringMatching(
-							/^(\/||\\).*twentytwenty$/
+							/^(\/|\\).*twentytwenty$/
 						),
 						basename: 'twentytwenty',
 					},
 					{
 						type: 'zip',
-						url:
-							'https://downloads.wordpress.org/theme/twentytwenty.1.3.zip',
+						url: 'https://downloads.wordpress.org/theme/twentytwenty.1.3.zip',
 						path: expect.stringMatching(
-							/^(\/||\\).*twentytwenty$/
+							/^(\/|\\).*twentytwenty$/
 						),
 						basename: 'twentytwenty',
 					},
@@ -502,35 +497,31 @@ describe( 'readConfig', () => {
 				pluginSources: [
 					{
 						type: 'zip',
-						url:
-							'https://www.example.com/test/path/to/gutenberg.zip',
-						path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
+						url: 'https://www.example.com/test/path/to/gutenberg.zip',
+						path: expect.stringMatching( /^(\/|\\).*gutenberg$/ ),
 						basename: 'gutenberg',
 					},
 					{
 						type: 'zip',
-						url:
-							'https://www.example.com/test/path/to/gutenberg.8.1.0.zip',
+						url: 'https://www.example.com/test/path/to/gutenberg.8.1.0.zip',
 						path: expect.stringMatching(
-							/^(\/||\\).*gutenberg.8.1.0$/
+							/^(\/|\\).*gutenberg.8.1.0$/
 						),
 						basename: 'gutenberg.8.1.0',
 					},
 					{
 						type: 'zip',
-						url:
-							'https://www.example.com/test/path/to/twentytwenty.zip',
+						url: 'https://www.example.com/test/path/to/twentytwenty.zip',
 						path: expect.stringMatching(
-							/^(\/||\\).*twentytwenty$/
+							/^(\/|\\).*twentytwenty$/
 						),
 						basename: 'twentytwenty',
 					},
 					{
 						type: 'zip',
-						url:
-							'https://www.example.com/test/path/to/twentytwenty.1.3.zip',
+						url: 'https://www.example.com/test/path/to/twentytwenty.1.3.zip',
 						path: expect.stringMatching(
-							/^(\/||\\).*twentytwenty.1.3$/
+							/^(\/|\\).*twentytwenty.1.3$/
 						),
 						basename: 'twentytwenty.1.3',
 					},
@@ -538,7 +529,7 @@ describe( 'readConfig', () => {
 						type: 'zip',
 						url: 'https://example.com/twentytwenty.1.3.zip',
 						path: expect.stringMatching(
-							/^(\/||\\).*twentytwenty.1.3$/
+							/^(\/|\\).*twentytwenty.1.3$/
 						),
 						basename: 'twentytwenty.1.3',
 					},
@@ -580,12 +571,12 @@ describe( 'readConfig', () => {
 			const matchObj = {
 				test: {
 					type: 'local',
-					path: expect.stringMatching( /^(\/||\\).*relative$/ ),
+					path: expect.stringMatching( /^(\/|\\).*relative$/ ),
 					basename: 'relative',
 				},
 				test2: {
 					type: 'git',
-					path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
+					path: expect.stringMatching( /^(\/|\\).*gutenberg$/ ),
 					basename: 'gutenberg',
 				},
 			};
@@ -813,7 +804,7 @@ describe( 'readConfig', () => {
 					development: {
 						port: 1000,
 						config: {
-							WP_TESTS_DOMAIN: 'http://localhost:1000/',
+							WP_TESTS_DOMAIN: 'localhost',
 							WP_SITEURL: 'http://localhost:1000/',
 							WP_HOME: 'http://localhost:1000/',
 						},
@@ -821,7 +812,7 @@ describe( 'readConfig', () => {
 					tests: {
 						port: 2000,
 						config: {
-							WP_TESTS_DOMAIN: 'http://localhost:2000/',
+							WP_TESTS_DOMAIN: 'localhost',
 							WP_SITEURL: 'http://localhost:2000/',
 							WP_HOME: 'http://localhost:2000/',
 						},
@@ -849,7 +840,7 @@ describe( 'readConfig', () => {
 					development: {
 						port: 1000,
 						config: {
-							WP_TESTS_DOMAIN: 'http://localhost:1000/',
+							WP_TESTS_DOMAIN: 'localhost',
 							WP_SITEURL: 'http://localhost:1000/',
 							WP_HOME: 'http://localhost:3000/',
 						},
@@ -857,7 +848,7 @@ describe( 'readConfig', () => {
 					tests: {
 						port: 2000,
 						config: {
-							WP_TESTS_DOMAIN: 'http://localhost:2000/',
+							WP_TESTS_DOMAIN: 'localhost',
 							WP_SITEURL: 'http://localhost:2000/',
 							WP_HOME: 'http://localhost:3000/',
 						},
@@ -1112,7 +1103,7 @@ describe( 'readConfig', () => {
 				WP_PHP_BINARY: 'php',
 				WP_TESTS_EMAIL: 'admin@example.org',
 				WP_TESTS_TITLE: 'Test Blog',
-				WP_TESTS_DOMAIN: 'http://localhost:8889/',
+				WP_TESTS_DOMAIN: 'localhost',
 				WP_SITEURL: 'http://localhost:8889/',
 				WP_HOME: 'http://localhost:8889/',
 			} );
@@ -1126,7 +1117,7 @@ describe( 'readConfig', () => {
 				WP_PHP_BINARY: 'php',
 				WP_TESTS_EMAIL: 'admin@example.org',
 				WP_TESTS_TITLE: 'Test Blog',
-				WP_TESTS_DOMAIN: 'http://localhost:8888/',
+				WP_TESTS_DOMAIN: 'localhost',
 				WP_SITEURL: 'http://localhost:8888/',
 				WP_HOME: 'http://localhost:8888/',
 			} );

package/lib/download-sources.js

@@ -16,7 +16,7 @@ const extractZip = util.promisify( require( 'extract-zip' ) );
 const rimraf = util.promisify( require( 'rimraf' ) );
 
 /**
- * @typedef {import('./config').Config} Config
+ * @typedef {import('./config').WPConfig} WPConfig
  * @typedef {import('./config').WPSource} WPSource
  */
 
@@ -24,8 +24,8 @@ const rimraf = util.promisify( require( 'rimraf' ) );
  * Download each source for each environment. If the same source is used in
  * multiple environments, it will only be downloaded once.
  *
- * @param {Config} config  The wp-env configuration object.
- * @param {Object} spinner The spinner object to show progress.
+ * @param {WPConfig} config  The wp-env configuration object.
+ * @param {Object}   spinner The spinner object to show progress.
  * @return {Promise} Returns a promise which resolves when the downloads finish.
  */
 module.exports = function downloadSources( config, spinner ) {

package/lib/download-wp-phpunit.js

@@ -0,0 +1,140 @@
+'use strict';
+/**
+ * External dependencies
+ */
+const SimpleGit = require( 'simple-git' );
+const fs = require( 'fs' );
+const path = require( 'path' );
+
+/**
+ * @typedef {import('./config').WPConfig} WPConfig
+ */
+
+/**
+ * Downloads the WordPress PHPUnit files for each environment into the appropriate directories.
+ *
+ * @param {WPConfig} config     The wp-env config object.
+ * @param {Object}   wpVersions The WordPress versions for each environment.
+ * @param {Object}   spinner    The spinner object to show progress.
+ * @param {boolean}  debug      Indicates whether or not debug mode is active.
+ * @return {Promise} Returns a promise which resolves when the downloads finish.
+ */
+module.exports = function downloadWPPHPUnit(
+	config,
+	wpVersions,
+	spinner,
+	debug
+) {
+	const progresses = {};
+	const getProgressSetter = ( id ) => ( progress ) => {
+		progresses[ id ] = progress;
+		spinner.text =
+			'Downloading WordPress PHPUnit Suite.\n' +
+			Object.entries( progresses )
+				.map(
+					( [ key, value ] ) =>
+						`  - ${ key }: ${ ( value * 100 ).toFixed( 0 ) }/100%`
+				)
+				.join( '\n' );
+	};
+
+	const promises = [];
+	for ( const env in config.env ) {
+		const wpVersion = wpVersions[ env ] ? wpVersions[ env ] : null;
+		const directory = path.join(
+			config.workDirectoryPath,
+			env === 'development'
+				? 'WordPress-PHPUnit'
+				: 'tests-WordPress-PHPUnit'
+		);
+		promises.push(
+			downloadTestSuite( directory, wpVersion, {
+				onProgress: getProgressSetter,
+				spinner,
+				debug,
+			} )
+		);
+	}
+
+	return Promise.all( promises );
+};
+
+/**
+ * Downloads the PHPUnit tests for a given WordPress version into the appropriate directory.
+ *
+ * @param {string}   directory          The directory to place the PHPUnit tests in.
+ * @param {string}   wpVersion          The version of WordPress to install PHPUnit tests for. Trunk when empty.
+ * @param {Object}   options
+ * @param {Function} options.onProgress A function called with download progress. Will be invoked with one argument: a number that ranges from 0 to 1 which indicates current download progress for this source.
+ * @param {Object}   options.spinner    A CLI spinner which indicates progress.
+ * @param {boolean}  options.debug      True if debug mode is enabled.
+ */
+async function downloadTestSuite(
+	directory,
+	wpVersion,
+	{ onProgress, spinner, debug }
+) {
+	const log = debug
+		? ( message ) => {
+				spinner.info( `SimpleGit: ${ message }` );
+				spinner.start();
+		  }
+		: () => {};
+	onProgress( 0 );
+
+	const progressHandler = ( { progress } ) => {
+		onProgress( progress / 100 );
+	};
+
+	// Make sure that the version is in X.X.X format. This is required
+	// because WordPress/wordpress-develop uses X.X.X tags but
+	// WordPress uses X.X for non-patch releases.
+	if ( wpVersion && wpVersion.match( /^[0-9]+.[0-9]+$/ ) ) {
+		wpVersion += '.0';
+	}
+
+	log( 'Cloning or getting the PHPUnit suite from GitHub.' );
+	const git = SimpleGit( { progress: progressHandler } );
+
+	const isRepo =
+		fs.existsSync( directory ) &&
+		( await git.cwd( directory ).checkIsRepo( 'root' ) );
+
+	if ( isRepo ) {
+		log( 'Repo already exists, using it.' );
+	} else {
+		await git.clone(
+			'https://github.com/WordPress/wordpress-develop.git',
+			directory,
+			{
+				'--depth': '1',
+				'--no-checkout': null,
+			}
+		);
+		await git.cwd( directory );
+
+		// We use a sparse checkout to minimize the amount of data we need to download.
+		log( 'Enabling sparse checkout.' );
+		await git.raw( 'sparse-checkout', 'set', '--cone', 'tests/phpunit' );
+	}
+
+	// Figure out the ref that we need to checkout to get the correct version of the PHPUnit library.
+	// Alpha, Beta, and RC versions are bleeding edge and should pull from trunk.
+	let ref;
+	const fetchRaw = [];
+	if ( ! wpVersion || wpVersion.match( /-(?:alpha|beta|rc)/ ) ) {
+		ref = 'trunk';
+		fetchRaw.push( 'fetch', 'origin', ref, '--depth', '1' );
+	} else {
+		ref = `tags/${ wpVersion }`;
+		fetchRaw.push( 'fetch', 'origin', 'tag', wpVersion, '--depth', '1' );
+	}
+
+	log( `Fetching ${ ref }.` );
+	await git.raw( fetchRaw );
+
+	log( `Checking out ${ ref }.` );
+	await git.checkout( ref );
+
+	onProgress( 1 );
+}

package/lib/wordpress.js

@@ -14,6 +14,7 @@ const copyDir = util.promisify( require( 'copy-dir' ) );
 /**
  * @typedef {import('./config').WPConfig} WPConfig
  * @typedef {import('./config').WPServiceConfig} WPServiceConfig
+ * @typedef {import('./config').WPSource} WPSource
  * @typedef {'development'|'tests'} WPEnvironment
  * @typedef {'development'|'tests'|'all'} WPEnvironmentSelection
  */
@@ -64,6 +65,11 @@ async function configureWordPress( environment, config, spinner ) {
 	for ( let [ key, value ] of Object.entries(
 		config.env[ environment ].config
 	) ) {
+		// Allow the configuration to skip a default constant by specifying it as null.
+		if ( null === value ) {
+			continue;
+		}
+
 		// Add quotes around string values to work with multi-word strings better.
 		value = typeof value === 'string' ? `"${ value }"` : value;
 		setupCommands.push(
@@ -96,25 +102,15 @@ async function configureWordPress( environment, config, spinner ) {
 		}
 	);
 
-	/**
-	 * Since wp-phpunit loads wp-settings.php at the end of its wp-config.php
-	 * file, we need to avoid loading it too early in our own wp-config.php. If
-	 * we load it too early, then some things (like MULTISITE) will be defined
-	 * before wp-phpunit has a chance to configure them. To avoid this, create a
-	 * copy of wp-config.php for phpunit which doesn't require wp-settings.php.
-	 *
-	 * Note that This needs to be executed using `exec` on the wordpress service
-	 * so that file permissions work properly.
-	 *
-	 * This will be removed in the future. @see https://github.com/WordPress/gutenberg/issues/23171
-	 *
-	 */
+	// WordPress' PHPUnit suite expects a `wp-tests-config.php` in
+	// the directory that the test suite is contained within.
+	// Make sure ABSPATH points to the WordPress install.
 	await dockerCompose.exec(
 		environment === 'development' ? 'wordpress' : 'tests-wordpress',
 		[
 			'sh',
 			'-c',
-			'sed "/^require.*wp-settings.php/d" /var/www/html/wp-config.php > /var/www/html/phpunit-wp-config.php && chmod 777 /var/www/html/phpunit-wp-config.php',
+			`sed -e "/^require.*wp-settings.php/d" -e "s/define( 'ABSPATH', __DIR__ . '\\/' );/define( 'ABSPATH', '\\/var\\/www\\/html\\/' );\\n\\tdefine( 'WP_DEFAULT_THEME', 'default' );/" /var/www/html/wp-config.php > /wordpress-phpunit/wp-tests-config.php`,
 		],
 		{
 			config: config.dockerComposeConfigPath,
@@ -241,10 +237,49 @@ async function copyCoreFiles( fromPath, toPath ) {
 	} );
 }
 
+/**
+ * Scans through a WordPress source to find the version of WordPress it contains.
+ *
+ * @param {WPSource} coreSource The WordPress source.
+ * @param {Object}   spinner    A CLI spinner which indicates progress.
+ * @param {boolean}  debug      Indicates whether or not the CLI is in debug mode.
+ * @return {string} The version of WordPress the source is for.
+ */
+async function readWordPressVersion( coreSource, spinner, debug ) {
+	// No source means they're using the bleeding edge.
+	if ( coreSource === null ) {
+		return null;
+	}
+
+	const versionFilePath = path.join(
+		coreSource.path,
+		'wp-includes',
+		'version.php'
+	);
+	const versionFile = await fs.readFile( versionFilePath, {
+		encoding: 'utf-8',
+	} );
+	const versionMatch = versionFile.match(
+		/\$wp_version = '([A-Za-z\-0-9.]+)'/
+	);
+	if ( ! versionMatch ) {
+		throw new Error( `Failed to find version in ${ versionFilePath }` );
+	}
+
+	if ( debug ) {
+		spinner.info(
+			`Found WordPress ${ versionMatch[ 1 ] } in ${ versionFilePath }.`
+		);
+	}
+
+	return versionMatch[ 1 ];
+}
+
 module.exports = {
 	hasSameCoreSource,
 	checkDatabaseConnection,
 	configureWordPress,
 	resetDatabase,
 	setupWordPressDirectories,
+	readWordPressVersion,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/env",
-	"version": "4.7.0",
+	"version": "5.0.0",
 	"description": "A zero-config, self contained local WordPress environment for development and testing.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -36,7 +36,7 @@
 		"copy-dir": "^1.3.0",
 		"docker-compose": "^0.22.2",
 		"extract-zip": "^1.6.7",
-		"got": "^10.7.0",
+		"got": "^11.8.5",
 		"inquirer": "^7.1.0",
 		"js-yaml": "^3.13.1",
 		"ora": "^4.0.2",
@@ -51,5 +51,5 @@
 	"scripts": {
 		"test": "echo \"Error: run tests from root\" && exit 1"
 	},
-	"gitHead": "198fa129cf1af8dc615918987ea6795cd40ab7df"
+	"gitHead": "0315dbc240cb2aa146d7c1bafd251f004b88300e"
 }