@wordpress/env 7.0.0 → 8.1.0

package/lib/init-config.js

@@ -133,8 +133,8 @@ ARG HOST_USERNAME
 ARG HOST_UID
 ARG HOST_GID
 # When the IDs are already in use we can still safely move on.
-RUN groupadd -g $HOST_GID $HOST_USERNAME || true
-RUN useradd -m -u $HOST_UID -g $HOST_GID $HOST_USERNAME || true
+RUN groupadd -o -g $HOST_GID $HOST_USERNAME || true
+RUN useradd -mlo -u $HOST_UID -g $HOST_GID $HOST_USERNAME || true
 
 # Install any dependencies we need in the container.
 ${ installDependencies( 'wordpress', env, config ) }`;
@@ -202,15 +202,20 @@ RUN apt-get -qy install $PHPIZE_DEPS && touch /usr/local/etc/php/php.ini
 
 # Set up sudo so they can have root access.
 RUN apt-get -qy install sudo
-RUN echo "$HOST_USERNAME ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers`;
+RUN echo "#$HOST_UID ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers`;
 			break;
 		}
 		case 'cli': {
 			dockerFileContent += `
+# Make sure we're working with the latest packages.
 RUN apk update
+
+# Install some basic PHP dependencies.
 RUN apk --no-cache add $PHPIZE_DEPS && touch /usr/local/etc/php/php.ini
+
+# Set up sudo so they can have root access.
 RUN apk --no-cache add sudo linux-headers
-RUN echo "$HOST_USERNAME ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers`;
+RUN echo "#$HOST_UID ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers`;
 			break;
 		}
 		default: {
@@ -238,8 +243,8 @@ RUN rm /tmp/composer-setup.php`;
 	// Install any Composer packages we might need globally.
 	// Make sure to do this as the user and ensure the binaries are available in the $PATH.
 	dockerFileContent += `
-USER $HOST_USERNAME
-ENV PATH="\${PATH}:/home/$HOST_USERNAME/.composer/vendor/bin"
+USER $HOST_UID:$HOST_GID
+ENV PATH="\${PATH}:~/.composer/vendor/bin"
 RUN composer global require --dev yoast/phpunit-polyfills:"^1.0"
 USER root`;
 

package/lib/test/cli.js

@@ -22,7 +22,7 @@ jest.mock( '../env', () => {
 		clean: jest.fn( Promise.resolve.bind( Promise ) ),
 		run: jest.fn( Promise.resolve.bind( Promise ) ),
 		ValidationError: actual.ValidationError,
-		AfterSetupError: actual.AfterSetupError,
+		LifecycleScriptError: actual.LifecycleScriptError,
 	};
 } );
 

package/lib/test/execute-lifecycle-script.js

@@ -0,0 +1,59 @@
+'use strict';
+/* eslint-disable jest/no-conditional-expect */
+/**
+ * Internal dependencies
+ */
+const {
+	LifecycleScriptError,
+	executeLifecycleScript,
+} = require( '../execute-lifecycle-script' );
+
+describe( 'executeLifecycleScript', () => {
+	const spinner = {
+		info: jest.fn(),
+	};
+
+	afterEach( () => {
+		jest.clearAllMocks();
+	} );
+
+	it( 'should do nothing without event option when debugging', async () => {
+		await executeLifecycleScript(
+			'test',
+			{ lifecycleScripts: { test: null }, debug: true },
+			spinner
+		);
+
+		expect( spinner.info ).not.toHaveBeenCalled();
+	} );
+
+	it( 'should run event option and print output when debugging', async () => {
+		await executeLifecycleScript(
+			'test',
+			{ lifecycleScripts: { test: 'node -v' }, debug: true },
+			spinner
+		);
+
+		expect( spinner.info ).toHaveBeenCalledWith(
+			expect.stringMatching( /test Script:\nv[0-9]/ )
+		);
+	} );
+
+	it( 'should throw LifecycleScriptError when process errors', async () => {
+		try {
+			await executeLifecycleScript(
+				'test',
+				{
+					lifecycleScripts: {
+						test: 'node -vvvvvvv',
+					},
+				},
+				spinner
+			);
+		} catch ( error ) {
+			expect( error ).toBeInstanceOf( LifecycleScriptError );
+			expect( error.message ).toMatch( /test Error:\n.*bad option/ );
+		}
+	} );
+} );
+/* eslint-enable jest/no-conditional-expect */

package/lib/validate-run-container.js

@@ -0,0 +1,41 @@
+'use strict';
+
+/**
+ * A list of the containers that we can use `run` on.
+ */
+const RUN_CONTAINERS = [
+	'mysql',
+	'tests-mysql',
+	'wordpress',
+	'tests-wordpress',
+	'cli',
+	'tests-cli',
+];
+
+/**
+ * Custom parsing and validation for the "run" command's container argument.
+ *
+ * @param {string} value The user-set container.
+ *
+ * @return {string} The container name to use.
+ */
+function validateRunContainer( value ) {
+	// Give special errors for deprecated containers.
+	if ( value === 'phpunit' ) {
+		throw new Error(
+			"The 'phpunit' container has been removed. Please use 'wp-env run tests-cli --env-cwd=wp-content/path/to/plugin phpunit' instead."
+		);
+	}
+	if ( value === 'composer' ) {
+		throw new Error(
+			"The 'composer' container has been removed. Please use 'wp-env run cli --env-cwd=wp-content/path/to/plugin composer' instead."
+		);
+	}
+
+	return value;
+}
+
+module.exports = {
+	RUN_CONTAINERS,
+	validateRunContainer,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/env",
-	"version": "7.0.0",
+	"version": "8.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",
@@ -51,5 +51,5 @@
 	"scripts": {
 		"test": "echo \"Error: run tests from root\" && exit 1"
 	},
-	"gitHead": "e936127e1e13881f1a940b7bd1593a9e500147f3"
+	"gitHead": "a92f606309b1541b834ff9b0a76ed2a466fc45ed"
 }

package/lib/execute-after-setup.js

@@ -1,51 +0,0 @@
-'use strict';
-/**
- * External dependencies
- */
-const { execSync } = require( 'child_process' );
-
-/**
- * @typedef {import('./config').WPConfig} WPConfig
- */
-
-/**
- * Error subtype which indicates that the afterSetup command failed.
- */
-class AfterSetupError extends Error {}
-
-/**
- * Executes any defined afterSetup command.
- *
- * @param {WPConfig} config  The config object to use.
- * @param {Object}   spinner A CLI spinner which indciates progress.
- */
-function executeAfterSetup( config, spinner ) {
-	if ( ! config.afterSetup ) {
-		return;
-	}
-
-	spinner.text = 'Executing Script: afterSetup';
-
-	try {
-		let output = execSync( config.afterSetup, {
-			encoding: 'utf-8',
-			stdio: 'pipe',
-			env: process.env,
-		} );
-
-		// Remove any trailing whitespace for nicer output.
-		output = output.trimRight();
-
-		// We don't need to bother with any output if there isn't any.
-		if ( output ) {
-			spinner.info( `After Setup:\n${ output }` );
-		}
-	} catch ( error ) {
-		throw new AfterSetupError( `After Setup:\n${ error.stderr }` );
-	}
-}
-
-module.exports = {
-	AfterSetupError,
-	executeAfterSetup,
-};

package/lib/test/execute-after-setup.js

@@ -1,66 +0,0 @@
-'use strict';
-/**
- * External dependencies
- */
-const { execSync } = require( 'child_process' );
-
-/**
- * Internal dependencies
- */
-const {
-	AfterSetupError,
-	executeAfterSetup,
-} = require( '../execute-after-setup' );
-
-jest.mock( 'child_process', () => ( {
-	execSync: jest.fn(),
-} ) );
-
-describe( 'executeAfterSetup', () => {
-	const spinner = {
-		info: jest.fn(),
-	};
-
-	afterEach( () => {
-		jest.clearAllMocks();
-	} );
-
-	it( 'should do nothing without afterSetup option', () => {
-		executeAfterSetup( { afterSetup: null }, spinner );
-
-		expect( spinner.info ).not.toHaveBeenCalled();
-	} );
-
-	it( 'should run afterSetup option and print output without extra whitespace', () => {
-		execSync.mockReturnValue( 'Test   \n' );
-
-		executeAfterSetup( { afterSetup: 'Test Setup' }, spinner );
-
-		expect( execSync ).toHaveBeenCalled();
-		expect( execSync.mock.calls[ 0 ][ 0 ] ).toEqual( 'Test Setup' );
-		expect( spinner.info ).toHaveBeenCalledWith( 'After Setup:\nTest' );
-	} );
-
-	it( 'should print nothing if afterSetup returns no output', () => {
-		execSync.mockReturnValue( '' );
-
-		executeAfterSetup( { afterSetup: 'Test Setup' }, spinner );
-
-		expect( execSync ).toHaveBeenCalled();
-		expect( execSync.mock.calls[ 0 ][ 0 ] ).toEqual( 'Test Setup' );
-		expect( spinner.info ).not.toHaveBeenCalled();
-	} );
-
-	it( 'should throw AfterSetupError when process errors', () => {
-		execSync.mockImplementation( ( command ) => {
-			expect( command ).toEqual( 'Test Setup' );
-			throw { stderr: 'Something bad happened.' };
-		} );
-
-		expect( () =>
-			executeAfterSetup( { afterSetup: 'Test Setup' }, spinner )
-		).toThrow(
-			new AfterSetupError( 'After Setup:\nSomething bad happened.' )
-		);
-	} );
-} );