@wordpress/env 10.0.0 → 10.1.0

package/README.md

@@ -480,7 +480,7 @@ You can customize the WordPress installation, plugins and themes that the develo
 `.wp-env.json` supports fields for options applicable to both the tests and development instances.
 
 | Field          | Type           | Default                                | Description                                                                                                                      |
-| -------------- | -------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
+|----------------|----------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
 | `"core"`       | `string\|null` | `null`                                 | The WordPress installation to use. If `null` is specified, `wp-env` will use the latest production release of WordPress.         |
 | `"phpVersion"` | `string\|null` | `null`                                 | The PHP version to use. If `null` is specified, `wp-env` will use the default version used with production release of WordPress. |
 | `"plugins"`    | `string[]`     | `[]`                                   | A list of plugins to install and activate in the environment.                                                                    |
@@ -489,6 +489,7 @@ You can customize the WordPress installation, plugins and themes that the develo
 | `"testsPort"`  | `integer`      | `8889`                                 | The port number for the test site. You'll access the instance through the port: 'http://localhost:8889'.                         |
 | `"config"`     | `Object`       | See below.                             | Mapping of wp-config.php constants to their desired values.                                                                      |
 | `"mappings"`   | `Object`       | `"{}"`                                 | Mapping of WordPress directories to local directories to be mounted in the WordPress instance.                                   |
+| `"mysqlPort"`  | `integer`      | `null` (randomly assigned)             | The MySQL port number to expose. The setting is only available in the `env.development` and `env.tests` objects.                 |
 
 _Note: the port number environment variables (`WP_ENV_PORT` and `WP_ENV_TESTS_PORT`) take precedent over the .wp-env.json values._
 
@@ -521,7 +522,8 @@ Additionally, the key `env` is available to override any of the above options on
 			"config": {
 				"KEY_1": false
 			},
-			"port": 3000
+			"port": 3000,
+			"mysqlPort": 13306
 		}
 	}
 }
@@ -686,6 +688,8 @@ You can tell `wp-env` to use a custom port number so that your instance does not
 }
 ```
 
+These can also be set via the environment variables `WP_ENV_PORT`, `WP_ENV_TESTS_PORT`, `WP_ENV_MYSQL_PORT` and `WP_ENV_TESTS_MYSQL_PORT`.
+
 ### Specific PHP Version
 
 You can tell `wp-env` to use a specific PHP version for compatibility and testing. This can also be set via the environment variable `WP_ENV_PHP_VERSION`.

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

@@ -166,14 +166,20 @@ module.exports = function buildDockerComposeConfig( config ) {
 
 	// Set the default ports based on the config values.
 	const developmentPorts = `\${WP_ENV_PORT:-${ config.env.development.port }}:80`;
+	const developmentMysqlPorts = `\${WP_ENV_MYSQL_PORT:-${
+		config.env.development.mysqlPort ?? ''
+	}}:3306`;
 	const testsPorts = `\${WP_ENV_TESTS_PORT:-${ config.env.tests.port }}:80`;
+	const testsMysqlPorts = `\${WP_ENV_TESTS_MYSQL_PORT:-${
+		config.env.tests.mysqlPort ?? ''
+	}}:3306`;
 
 	return {
 		version: '3.7',
 		services: {
 			mysql: {
 				image: 'mariadb:lts',
-				ports: [ '3306' ],
+				ports: [ developmentMysqlPorts ],
 				environment: {
 					MYSQL_ROOT_HOST: '%',
 					MYSQL_ROOT_PASSWORD:
@@ -184,7 +190,7 @@ module.exports = function buildDockerComposeConfig( config ) {
 			},
 			'tests-mysql': {
 				image: 'mariadb:lts',
-				ports: [ '3306' ],
+				ports: [ testsMysqlPorts ],
 				environment: {
 					MYSQL_ROOT_HOST: '%',
 					MYSQL_ROOT_PASSWORD:

package/lib/config/get-config-from-environment-vars.js

@@ -17,7 +17,9 @@ const { checkPort, checkVersion, checkString } = require( './validate-config' );
  *
  * @typedef WPEnvironmentVariableConfig
  * @property {?number}                  port             An override for the development environment's port.
+ * @property {?number}                  mysqlPort        An override for the development environment's MySQL port.
  * @property {?number}                  testsPort        An override for the testing environment's port.
+ * @property {?number}                  testsMysqlPort   An override for the testing environment's MySQL port.
  * @property {?WPSource}                coreSource       An override for all environment's coreSource.
  * @property {?string}                  phpVersion       An override for all environment's PHP version.
  * @property {?Object.<string, string>} lifecycleScripts An override for various lifecycle scripts.
@@ -33,7 +35,11 @@ const { checkPort, checkVersion, checkString } = require( './validate-config' );
 module.exports = function getConfigFromEnvironmentVars( cacheDirectoryPath ) {
 	const environmentConfig = {
 		port: getPortFromEnvironmentVariable( 'WP_ENV_PORT' ),
+		mysqlPort: getPortFromEnvironmentVariable( 'WP_ENV_MYSQL_PORT' ),
 		testsPort: getPortFromEnvironmentVariable( 'WP_ENV_TESTS_PORT' ),
+		testsMysqlPort: getPortFromEnvironmentVariable(
+			'WP_ENV_TESTS_MYSQL_PORT'
+		),
 		lifecycleScripts: getLifecycleScriptOverrides(),
 	};
 

package/lib/config/parse-config.js

@@ -50,6 +50,7 @@ const mergeConfigs = require( './merge-configs' );
  * @property {WPSource[]}                pluginSources Plugins to load in the environment.
  * @property {WPSource[]}                themeSources  Themes to load in the environment.
  * @property {number}                    port          The port to use.
+ * @property {number}                    mysqlPort     The port to use for MySQL. Random if empty.
  * @property {Object}                    config        Mapping of wp-config.php constants to their desired values.
  * @property {Object.<string, WPSource>} mappings      Mapping of WordPress directories to local directories which should be mounted.
  * @property {string|null}               phpVersion    Version of PHP to use in the environments, of the format 0.0.
@@ -85,6 +86,7 @@ const DEFAULT_ENVIRONMENT_CONFIG = {
 	themes: [],
 	port: 8888,
 	testsPort: 8889,
+	mysqlPort: null,
 	mappings: {},
 	config: {
 		FS_METHOD: 'direct',
@@ -276,11 +278,19 @@ function getEnvironmentVarOverrides( cacheDirectoryPath ) {
 		overrideConfig.env.development.port = overrides.port;
 	}
 
+	if ( overrides.mysqlPort ) {
+		overrideConfig.env.development.mysqlPort = overrides.mysqlPort;
+	}
+
 	if ( overrides.testsPort ) {
 		overrideConfig.testsPort = overrides.testsPort;
 		overrideConfig.env.tests.port = overrides.testsPort;
 	}
 
+	if ( overrides.testsMysqlPort ) {
+		overrideConfig.env.tests.mysqlPort = overrides.testsMysqlPort;
+	}
+
 	if ( overrides.coreSource ) {
 		overrideConfig.coreSource = overrides.coreSource;
 		overrideConfig.env.development.coreSource = overrides.coreSource;
@@ -436,6 +446,10 @@ async function parseEnvironmentConfig(
 		parsedConfig.port = config.port;
 	}
 
+	if ( config.mysqlPort !== undefined ) {
+		parsedConfig.mysqlPort = config.mysqlPort;
+	}
+
 	if ( config.phpVersion !== undefined ) {
 		// Support null as a valid input.
 		if ( config.phpVersion !== null ) {

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

@@ -29,6 +29,7 @@ exports[`Config Integration should load local and override configuration files 1
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "mysqlPort": 23306,
       "phpVersion": null,
       "pluginSources": [],
       "port": 999,
@@ -57,6 +58,7 @@ exports[`Config Integration should load local and override configuration files 1
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "mysqlPort": 23307,
       "phpVersion": null,
       "pluginSources": [],
       "port": 456,
@@ -102,6 +104,7 @@ exports[`Config Integration should load local configuration file 1`] = `
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "mysqlPort": 13306,
       "phpVersion": null,
       "pluginSources": [],
       "port": 123,
@@ -130,6 +133,7 @@ exports[`Config Integration should load local configuration file 1`] = `
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "mysqlPort": 23307,
       "phpVersion": null,
       "pluginSources": [],
       "port": 8889,
@@ -175,6 +179,7 @@ exports[`Config Integration should use default configuration 1`] = `
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "mysqlPort": null,
       "phpVersion": null,
       "pluginSources": [],
       "port": 8888,
@@ -203,6 +208,7 @@ exports[`Config Integration should use default configuration 1`] = `
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "mysqlPort": null,
       "phpVersion": null,
       "pluginSources": [],
       "port": 8889,
@@ -248,6 +254,7 @@ exports[`Config Integration should use environment variables over local and over
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "mysqlPort": 23306,
       "phpVersion": null,
       "pluginSources": [],
       "port": 12345,
@@ -277,6 +284,7 @@ exports[`Config Integration should use environment variables over local and over
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "mysqlPort": 23307,
       "phpVersion": null,
       "pluginSources": [],
       "port": 61234,

package/lib/config/test/config-integration.js

@@ -48,7 +48,9 @@ describe( 'Config Integration', () => {
 	afterEach( () => {
 		delete process.env.WP_ENV_HOME;
 		delete process.env.WP_ENV_PORT;
+		delete process.env.WP_ENV_MYSQL_PORT;
 		delete process.env.WP_ENV_TESTS_PORT;
+		delete process.env.WP_ENV_TESTS_MYSQL_PORT;
 		delete process.env.WP_ENV_LIFECYCLE_SCRIPT_AFTER_START;
 	} );
 
@@ -61,6 +63,8 @@ describe( 'Config Integration', () => {
 
 		expect( config.env.development.port ).toEqual( 8888 );
 		expect( config.env.tests.port ).toEqual( 8889 );
+		expect( config.env.development.mysqlPort ).toEqual( null );
+		expect( config.env.tests.mysqlPort ).toEqual( null );
 		expect( config ).toMatchSnapshot();
 	} );
 
@@ -75,6 +79,14 @@ describe( 'Config Integration', () => {
 						afterClean: null,
 						afterDestroy: null,
 					},
+					env: {
+						development: {
+							mysqlPort: 13306,
+						},
+						tests: {
+							mysqlPort: 23307,
+						},
+					},
 				} );
 			}
 
@@ -85,6 +97,8 @@ describe( 'Config Integration', () => {
 
 		expect( config.env.development.port ).toEqual( 123 );
 		expect( config.env.tests.port ).toEqual( 8889 );
+		expect( config.env.development.mysqlPort ).toEqual( 13306 );
+		expect( config.env.tests.mysqlPort ).toEqual( 23307 );
 		expect( config ).toMatchSnapshot();
 	} );
 
@@ -100,6 +114,11 @@ describe( 'Config Integration', () => {
 						afterClean: null,
 						afterDestroy: null,
 					},
+					env: {
+						tests: {
+							mysqlPort: 13306,
+						},
+					},
 				} );
 			}
 
@@ -111,6 +130,14 @@ describe( 'Config Integration', () => {
 						afterClean: null,
 						afterDestroy: 'test',
 					},
+					env: {
+						development: {
+							mysqlPort: 23306,
+						},
+						tests: {
+							mysqlPort: 23307,
+						},
+					},
 				} );
 			}
 
@@ -121,12 +148,16 @@ describe( 'Config Integration', () => {
 
 		expect( config.env.development.port ).toEqual( 999 );
 		expect( config.env.tests.port ).toEqual( 456 );
+		expect( config.env.development.mysqlPort ).toEqual( 23306 );
+		expect( config.env.tests.mysqlPort ).toEqual( 23307 );
 		expect( config ).toMatchSnapshot();
 	} );
 
 	it( 'should use environment variables over local and override configuration files', async () => {
 		process.env.WP_ENV_PORT = 12345;
+		process.env.WP_ENV_MYSQL_PORT = 23306;
 		process.env.WP_ENV_TESTS_PORT = 61234;
+		process.env.WP_ENV_TESTS_MYSQL_PORT = 23307;
 		process.env.WP_ENV_LIFECYCLE_SCRIPT_AFTER_START = 'test';
 
 		readFile.mockImplementation( async ( fileName ) => {
@@ -140,6 +171,11 @@ describe( 'Config Integration', () => {
 						afterClean: null,
 						afterDestroy: null,
 					},
+					env: {
+						tests: {
+							mysqlPort: 13306,
+						},
+					},
 				} );
 			}
 
@@ -156,6 +192,8 @@ describe( 'Config Integration', () => {
 
 		expect( config.env.development.port ).toEqual( 12345 );
 		expect( config.env.tests.port ).toEqual( 61234 );
+		expect( config.env.development.mysqlPort ).toEqual( 23306 );
+		expect( config.env.tests.mysqlPort ).toEqual( 23307 );
 		expect( config.lifecycleScripts ).toHaveProperty(
 			'afterStart',
 			'test'

package/lib/config/test/parse-config.js

@@ -21,6 +21,7 @@ jest.mock( '../../wordpress', () => ( {
 const DEFAULT_CONFIG = {
 	port: 8888,
 	testsPort: 8889,
+	mysqlPort: null,
 	phpVersion: null,
 	coreSource: {
 		type: 'git',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/env",
-	"version": "10.0.0",
+	"version": "10.1.0",
 	"description": "A zero-config, self contained local WordPress environment for development and testing.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -55,5 +55,5 @@
 	"scripts": {
 		"test": "echo \"Error: run tests from root\" && exit 1"
 	},
-	"gitHead": "2f30cddff15723ac7017fd009fc5913b7b419400"
+	"gitHead": "66d3bf12e67d16deddc4b4a9ec42e1d0bed3479a"
 }