@wordpress/env 10.38.1-next.v.0 → 11.0.0

package/lib/{build-docker-compose-config.js → runtime/docker/build-docker-compose-config.js}

@@ -9,12 +9,12 @@ const path = require( 'path' );
  * Internal dependencies
  */
 const { hasSameCoreSource } = require( './wordpress' );
-const { dbEnv } = require( './config' );
+const { dbEnv } = require( '../../config' );
 const getHostUser = require( './get-host-user' );
 
 /**
- * @typedef {import('./config').WPConfig} WPConfig
- * @typedef {import('./config').WPEnvironmentConfig} WPEnvironmentConfig
+ * @typedef {import('../../config').WPConfig} WPConfig
+ * @typedef {import('../../config').WPEnvironmentConfig} WPEnvironmentConfig
  */
 
 /**
@@ -88,6 +88,8 @@ function getMounts(
  * @return {Object} A docker-compose config object, ready to serialize into YAML.
  */
 module.exports = function buildDockerComposeConfig( config ) {
+	const testsEnabled = config.testsEnvironment !== false;
+
 	// Since we are mounting files from the host operating system
 	// we want to create the host user in some of our containers.
 	// This ensures ownership parity and lets us access files
@@ -99,12 +101,14 @@ module.exports = function buildDockerComposeConfig( config ) {
 		config.env.development,
 		hostUser.name
 	);
-	const testsMounts = getMounts(
-		config.workDirectoryPath,
-		config.env.tests,
-		hostUser.name,
-		'tests-wordpress'
-	);
+	const testsMounts = testsEnabled
+		? getMounts(
+				config.workDirectoryPath,
+				config.env.tests,
+				hostUser.name,
+				'tests-wordpress'
+		  )
+		: [];
 
 	// We use a custom Dockerfile in order to make sure that
 	// the current host user exists inside the container.
@@ -135,6 +139,7 @@ module.exports = function buildDockerComposeConfig( config ) {
 	//
 	// https://github.com/WordPress/gutenberg/issues/21164
 	if (
+		testsEnabled &&
 		config.env.development.coreSource &&
 		hasSameCoreSource( [ config.env.development, config.env.tests ] )
 	) {
@@ -169,138 +174,172 @@ module.exports = function buildDockerComposeConfig( config ) {
 	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`;
 
 	const developmentPhpmyadminPorts = `\${WP_ENV_PHPMYADMIN_PORT:-${
 		config.env.development.phpmyadminPort ?? ''
 	}}:80`;
-	const testsPhpmyadminPorts = `\${WP_ENV_TESTS_PHPMYADMIN_PORT:-${
-		config.env.tests.phpmyadminPort ?? ''
-	}}:80`;
 
-	return {
-		services: {
-			mysql: {
-				image: 'mariadb:lts',
-				ports: [ developmentMysqlPorts ],
-				environment: {
-					MYSQL_ROOT_HOST: '%',
-					MYSQL_ROOT_PASSWORD:
-						dbEnv.credentials.WORDPRESS_DB_PASSWORD,
-					MYSQL_DATABASE: dbEnv.development.WORDPRESS_DB_NAME,
-				},
-				volumes: [ 'mysql:/var/lib/mysql' ],
-			},
-			'tests-mysql': {
-				image: 'mariadb:lts',
-				ports: [ testsMysqlPorts ],
-				environment: {
-					MYSQL_ROOT_HOST: '%',
-					MYSQL_ROOT_PASSWORD:
-						dbEnv.credentials.WORDPRESS_DB_PASSWORD,
-					MYSQL_DATABASE: dbEnv.tests.WORDPRESS_DB_NAME,
-				},
-				volumes: [ 'mysql-test:/var/lib/mysql' ],
-			},
-			wordpress: {
-				depends_on: [ 'mysql' ],
-				build: {
-					context: '.',
-					dockerfile: 'WordPress.Dockerfile',
-					args: imageBuildArgs,
-				},
-				ports: [ developmentPorts ],
-				environment: {
-					APACHE_RUN_USER: '#' + hostUser.uid,
-					APACHE_RUN_GROUP: '#' + hostUser.gid,
-					...dbEnv.credentials,
-					...dbEnv.development,
-					WP_TESTS_DIR: '/wordpress-phpunit',
-				},
-				volumes: developmentMounts,
-				extra_hosts: [ 'host.docker.internal:host-gateway' ],
+	// MySQL healthcheck using MariaDB's official healthcheck.sh script.
+	// --connect: verifies TCP connection and that entrypoint has finished
+	// --innodb_initialized: ensures InnoDB storage engine is fully initialized
+	// MARIADB_AUTO_UPGRADE env var ensures healthcheck user exists for existing installations.
+	// Timing is generous to support slow CI environments.
+	const mysqlHealthcheck = {
+		test: [ 'CMD', 'healthcheck.sh', '--connect', '--innodb_initialized' ],
+		interval: '5s',
+		timeout: '10s',
+		retries: 12,
+		start_period: '60s',
+	};
+
+	// Build the services object, conditionally including tests services.
+	const services = {
+		mysql: {
+			image: 'mariadb:lts',
+			ports: [ developmentMysqlPorts ],
+			environment: {
+				MYSQL_ROOT_HOST: '%',
+				MYSQL_ROOT_PASSWORD: dbEnv.credentials.WORDPRESS_DB_PASSWORD,
+				MYSQL_DATABASE: dbEnv.development.WORDPRESS_DB_NAME,
+				// Ensures healthcheck user is created for existing installations.
+				MARIADB_AUTO_UPGRADE: '1',
 			},
-			'tests-wordpress': {
-				depends_on: [ 'tests-mysql' ],
-				build: {
-					context: '.',
-					dockerfile: 'Tests-WordPress.Dockerfile',
-					args: imageBuildArgs,
-				},
-				ports: [ testsPorts ],
-				environment: {
-					APACHE_RUN_USER: '#' + hostUser.uid,
-					APACHE_RUN_GROUP: '#' + hostUser.gid,
-					...dbEnv.credentials,
-					...dbEnv.tests,
-					WP_TESTS_DIR: '/wordpress-phpunit',
+			volumes: [ 'mysql:/var/lib/mysql' ],
+			healthcheck: mysqlHealthcheck,
+		},
+		wordpress: {
+			depends_on: {
+				mysql: {
+					condition: 'service_healthy',
 				},
-				volumes: testsMounts,
-				extra_hosts: [ 'host.docker.internal:host-gateway' ],
 			},
-			cli: {
-				depends_on: [ 'wordpress' ],
-				build: {
-					context: '.',
-					dockerfile: 'CLI.Dockerfile',
-					args: imageBuildArgs,
-				},
-				volumes: developmentMounts,
-				user: hostUser.fullUser,
-				environment: {
-					...dbEnv.credentials,
-					...dbEnv.development,
-					WP_TESTS_DIR: '/wordpress-phpunit',
-				},
-				extra_hosts: [ 'host.docker.internal:host-gateway' ],
+			build: {
+				context: '.',
+				dockerfile: 'WordPress.Dockerfile',
+				args: imageBuildArgs,
 			},
-			'tests-cli': {
-				depends_on: [ 'tests-wordpress' ],
-				build: {
-					context: '.',
-					dockerfile: 'Tests-CLI.Dockerfile',
-					args: imageBuildArgs,
-				},
-				volumes: testsMounts,
-				user: hostUser.fullUser,
-				environment: {
-					...dbEnv.credentials,
-					...dbEnv.tests,
-					WP_TESTS_DIR: '/wordpress-phpunit',
-				},
-				extra_hosts: [ 'host.docker.internal:host-gateway' ],
+			ports: [ developmentPorts ],
+			environment: {
+				APACHE_RUN_USER: '#' + hostUser.uid,
+				APACHE_RUN_GROUP: '#' + hostUser.gid,
+				...dbEnv.credentials,
+				...dbEnv.development,
+				WP_TESTS_DIR: '/wordpress-phpunit',
 			},
-			phpmyadmin: {
-				image: 'phpmyadmin',
-				ports: [ developmentPhpmyadminPorts ],
-				environment: {
-					PMA_PORT: 3306,
-					PMA_HOST: 'mysql',
-					PMA_USER: 'root',
-					PMA_PASSWORD: 'password',
-				},
+			volumes: developmentMounts,
+			extra_hosts: [ 'host.docker.internal:host-gateway' ],
+		},
+		cli: {
+			depends_on: [ 'wordpress' ],
+			build: {
+				context: '.',
+				dockerfile: 'CLI.Dockerfile',
+				args: imageBuildArgs,
 			},
-			'tests-phpmyadmin': {
-				image: 'phpmyadmin',
-				ports: [ testsPhpmyadminPorts ],
-				environment: {
-					PMA_PORT: 3306,
-					PMA_HOST: 'tests-mysql',
-					PMA_USER: 'root',
-					PMA_PASSWORD: 'password',
-				},
+			volumes: developmentMounts,
+			user: hostUser.fullUser,
+			environment: {
+				...dbEnv.credentials,
+				...dbEnv.development,
+				WP_TESTS_DIR: '/wordpress-phpunit',
 			},
+			extra_hosts: [ 'host.docker.internal:host-gateway' ],
 		},
-		volumes: {
-			...( ! config.env.development.coreSource && { wordpress: {} } ),
-			...( ! config.env.tests.coreSource && { 'tests-wordpress': {} } ),
-			mysql: {},
-			'mysql-test': {},
-			'user-home': {},
-			'tests-user-home': {},
+		phpmyadmin: {
+			image: 'phpmyadmin',
+			ports: [ developmentPhpmyadminPorts ],
+			environment: {
+				PMA_PORT: 3306,
+				PMA_HOST: 'mysql',
+				PMA_USER: 'root',
+				PMA_PASSWORD: 'password',
+			},
 		},
 	};
+
+	const volumes = {
+		...( ! config.env.development.coreSource && { wordpress: {} } ),
+		mysql: {},
+		'user-home': {},
+	};
+
+	if ( testsEnabled ) {
+		const testsPorts = `\${WP_ENV_TESTS_PORT:-${ config.env.tests.port }}:80`;
+		const testsMysqlPorts = `\${WP_ENV_TESTS_MYSQL_PORT:-${
+			config.env.tests.mysqlPort ?? ''
+		}}:3306`;
+		const testsPhpmyadminPorts = `\${WP_ENV_TESTS_PHPMYADMIN_PORT:-${
+			config.env.tests.phpmyadminPort ?? ''
+		}}:80`;
+
+		services[ 'tests-mysql' ] = {
+			image: 'mariadb:lts',
+			ports: [ testsMysqlPorts ],
+			environment: {
+				MYSQL_ROOT_HOST: '%',
+				MYSQL_ROOT_PASSWORD: dbEnv.credentials.WORDPRESS_DB_PASSWORD,
+				MYSQL_DATABASE: dbEnv.tests.WORDPRESS_DB_NAME,
+				// Ensures healthcheck user is created for existing installations.
+				MARIADB_AUTO_UPGRADE: '1',
+			},
+			volumes: [ 'mysql-test:/var/lib/mysql' ],
+			healthcheck: mysqlHealthcheck,
+		};
+		services[ 'tests-wordpress' ] = {
+			depends_on: {
+				'tests-mysql': {
+					condition: 'service_healthy',
+				},
+			},
+			build: {
+				context: '.',
+				dockerfile: 'Tests-WordPress.Dockerfile',
+				args: imageBuildArgs,
+			},
+			ports: [ testsPorts ],
+			environment: {
+				APACHE_RUN_USER: '#' + hostUser.uid,
+				APACHE_RUN_GROUP: '#' + hostUser.gid,
+				...dbEnv.credentials,
+				...dbEnv.tests,
+				WP_TESTS_DIR: '/wordpress-phpunit',
+			},
+			volumes: testsMounts,
+			extra_hosts: [ 'host.docker.internal:host-gateway' ],
+		};
+		services[ 'tests-cli' ] = {
+			depends_on: [ 'tests-wordpress' ],
+			build: {
+				context: '.',
+				dockerfile: 'Tests-CLI.Dockerfile',
+				args: imageBuildArgs,
+			},
+			volumes: testsMounts,
+			user: hostUser.fullUser,
+			environment: {
+				...dbEnv.credentials,
+				...dbEnv.tests,
+				WP_TESTS_DIR: '/wordpress-phpunit',
+			},
+			extra_hosts: [ 'host.docker.internal:host-gateway' ],
+		};
+		services[ 'tests-phpmyadmin' ] = {
+			image: 'phpmyadmin',
+			ports: [ testsPhpmyadminPorts ],
+			environment: {
+				PMA_PORT: 3306,
+				PMA_HOST: 'tests-mysql',
+				PMA_USER: 'root',
+				PMA_PASSWORD: 'password',
+			},
+		};
+
+		if ( ! config.env.tests.coreSource ) {
+			volumes[ 'tests-wordpress' ] = {};
+		}
+		volumes[ 'mysql-test' ] = {};
+		volumes[ 'tests-user-home' ] = {};
+	}
+
+	return { services, volumes };
 };

package/lib/runtime/docker/download-sources.js

@@ -0,0 +1,63 @@
+'use strict';
+/**
+ * Internal dependencies
+ */
+const { downloadSource } = require( '../../download-sources' );
+
+/**
+ * @typedef {import('./config').WPConfig} WPConfig
+ * @typedef {import('./config').WPSource} WPSource
+ */
+
+/**
+ * Download each source for each environment. If the same source is used in
+ * multiple environments, it will only be downloaded once.
+ *
+ * @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 ) {
+	const progresses = {};
+	const getProgressSetter = ( id ) => ( progress ) => {
+		progresses[ id ] = progress;
+		spinner.text =
+			'Downloading WordPress.\n' +
+			Object.entries( progresses )
+				.map(
+					( [ key, value ] ) =>
+						`  - ${ key }: ${ ( value * 100 ).toFixed( 0 ) }%`
+				)
+				.join( '\n' );
+	};
+
+	// Will contain a unique array of sources to download.
+	const sources = [];
+	const addedSources = {};
+	const addSource = ( source ) => {
+		if ( source && source.url && ! addedSources[ source.url ] ) {
+			sources.push( source );
+			addedSources[ source.url ] = true;
+		}
+	};
+
+	for ( const envName of Object.keys( config.env ) ) {
+		if ( envName === 'tests' && config.testsEnvironment === false ) {
+			continue;
+		}
+		const env = config.env[ envName ];
+		env.pluginSources.forEach( addSource );
+		env.themeSources.forEach( addSource );
+		Object.values( env.mappings ).forEach( addSource );
+		addSource( env.coreSource );
+	}
+
+	return Promise.all(
+		sources.map( ( source ) =>
+			downloadSource( source, {
+				onProgress: getProgressSetter( source.basename ),
+				spinner,
+			} )
+		)
+	);
+};

package/lib/{download-wp-phpunit.js → runtime/docker/download-wp-phpunit.js}

@@ -2,9 +2,9 @@
 /**
  * External dependencies
  */
-const SimpleGit = require( 'simple-git' );
 const fs = require( 'fs' );
 const path = require( 'path' );
+const SimpleGit = require( 'simple-git' );
 
 /**
  * @typedef {import('./config').WPConfig} WPConfig
@@ -40,6 +40,9 @@ module.exports = function downloadWPPHPUnit(
 
 	const promises = [];
 	for ( const env in config.env ) {
+		if ( env === 'tests' && config.testsEnvironment === false ) {
+			continue;
+		}
 		const wpVersion = wpVersions[ env ] ? wpVersions[ env ] : null;
 		const directory = path.join(
 			config.workDirectoryPath,