Changeset 60432

Timestamp:

07/07/2025 11:40:32 PM (9 months ago)

Author:

westonruter

Message:

Build/Test Tools: Improve dev environment's CLI in speed, non-interactive usage, and argument handling.

• Start cli container when running env:start. This greatly speeds up calls to WP-CLI since the container is already running rather than having to start up for each call.
• Facilitate calls to env:cli in non-interactive context (non-TTY) to allow piping content into commands or use in shell scripts.
• Fix passing arguments to WP-CLI from env:cli so that arguments with spaces are passed as expected.
• Fix JSHint issues.

This aligns the wordpress-develop environment closer to wp-env. See ​https://github.com/WordPress/gutenberg/pull/50007.

Reviewed by audrasjb.
Merges [60308] to the 6.8 branch, minus the change to .github/workflows/reusable-test-local-docker-environment-v1.yml which was made irrelevant in [60092].

Props westonruter, jorbin, SirLouen, sandeepdahiya.
Fixes #63564.

Location:

branches/6.8

Files:

• . (modified) (1 prop)
• docker-compose.yml (modified) (1 diff)
• package.json (modified) (1 diff)
• tools/local-env/scripts/docker.js (modified) (2 diffs)
• tools/local-env/scripts/install.js (modified) (2 diffs)
• tools/local-env/scripts/start.js (modified) (3 diffs)
• tools/local-env/scripts/utils.js (modified) (3 diffs)

branches/6.8/docker-compose.yml

@@ -112 +112 @@
       - ./:/var/www
 
+    # Keeps the service alive.
+    command: 'sleep infinity'
+
     # The init directive ensures the command runs with a PID > 1, so Ctrl+C works correctly.
     init: true

branches/6.8/package.json

@@ -185 +185 @@
         "env:reset": "node ./tools/local-env/scripts/docker.js down --rmi all -v --remove-orphans",
         "env:install": "node ./tools/local-env/scripts/install.js",
-        "env:cli": "node ./tools/local-env/scripts/docker.js run --rm cli",
+        "env:cli": "node ./tools/local-env/scripts/docker.js exec cli wp --allow-root",
         "env:logs": "node ./tools/local-env/scripts/docker.js logs",
         "env:pull": "node ./tools/local-env/scripts/docker.js pull",

branches/6.8/tools/local-env/scripts/docker.js

@@ -1 @@
-const dotenv       = require( 'dotenv' );
+/* jshint node:true */
+
+const dotenv = require( 'dotenv' );
 const dotenvExpand = require( 'dotenv-expand' );
-const { execSync } = require( 'child_process' );
+const { spawnSync } = require( 'child_process' );
 const local_env_utils = require( './utils' );
 
@@ -8 +10 @@
 const composeFiles = local_env_utils.get_compose_files();
 
-if (process.argv.includes('--coverage-html')) {
+if ( process.argv.includes( '--coverage-html' ) ) {
     process.env.LOCAL_PHP_XDEBUG = 'true';
     process.env.LOCAL_PHP_XDEBUG_MODE = 'coverage';
 }
 
-// This try-catch prevents the superfluous Node.js debugging information from being shown if the command fails.
-try {
-    // Execute any Docker compose command passed to this script.
-    execSync( 'docker compose ' + composeFiles + ' ' + process.argv.slice( 2 ).join( ' ' ), { stdio: 'inherit' } );
-} catch ( error ) {
-    process.exit( 1 );
+// Add --no-TTY (-T) arg after exec and run commands when STDIN is not a TTY.
+const dockerCommand = process.argv.slice( 2 );
+if ( [ 'exec', 'run' ].includes( dockerCommand[0] ) && ! process.stdin.isTTY ) {
+    dockerCommand.splice( 1, 0, '--no-TTY' );
 }
+
+// Execute any Docker compose command passed to this script.
+const returns = spawnSync(
+    'docker',
+    [
+        'compose',
+        ...composeFiles
+            .map( ( composeFile ) => [ '-f', composeFile ] )
+            .flat(),
+        ...dockerCommand,
+    ],
+    { stdio: 'inherit' }
+);
+
+process.exit( returns.status );

branches/6.8/tools/local-env/scripts/install.js

@@ -15 +15 @@
 
 // Create wp-config.php.
-wp_cli( `config create --dbname=wordpress_develop --dbuser=root --dbpass=password --dbhost=mysql --force --config-file=${process.env.LOCAL_DIR}/../wp-config.php` );
+wp_cli( `config create --dbname=wordpress_develop --dbuser=root --dbpass=password --dbhost=mysql --force --config-file="wp-config.php"` );
+
+// Since WP-CLI runs as root, the wp-config.php created above will be read-only. This needs to be writable for the sake of E2E tests.
+execSync( 'node ./tools/local-env/scripts/docker.js exec cli chmod 666 wp-config.php' );
 
 // Add the debug settings to wp-config.php.
@@ -63 +66 @@
  */
 function wp_cli( cmd ) {
-    const composeFiles = local_env_utils.get_compose_files();
-
-    execSync( `docker compose ${composeFiles} run --quiet-pull --rm cli ${cmd} --path=/var/www/${process.env.LOCAL_DIR}`, { stdio: 'inherit' } );
+    execSync( `npm --silent run env:cli -- ${cmd} --path=/var/www/${process.env.LOCAL_DIR}`, { stdio: 'inherit' } );
 }

branches/6.8/tools/local-env/scripts/start.js

@@ +1 @@
+/* jshint node:true */
+
 const dotenv       = require( 'dotenv' );
 const dotenvExpand = require( 'dotenv-expand' );
-const { execSync } = require( 'child_process' );
+const { execSync, spawnSync } = require( 'child_process' );
 const local_env_utils = require( './utils' );
 const { constants, copyFile } = require( 'node:fs' );
 
 // Copy the default .env file when one is not present.
-copyFile( '.env.example', '.env', constants.COPYFILE_EXCL, (e) => {
+copyFile( '.env.example', '.env', constants.COPYFILE_EXCL, () => {
     console.log( '.env file already exists. .env.example was not copied.' );
 });
@@ -29 +31 @@
 
 // Start the local-env containers.
-const containers = ( process.env.LOCAL_PHP_MEMCACHED === 'true' )
-    ? 'wordpress-develop memcached'
-    : 'wordpress-develop';
-execSync( `docker compose ${composeFiles} up --quiet-pull -d ${containers}`, { stdio: 'inherit' } );
+const containers = [ 'wordpress-develop', 'cli' ];
+if ( process.env.LOCAL_PHP_MEMCACHED === 'true' ) {
+    containers.push( 'memcached' );
+}
+
+spawnSync(
+    'docker',
+    [
+        'compose',
+        ...composeFiles.map( ( composeFile ) => [ '-f', composeFile ] ).flat(),
+        'up',
+        '--quiet-pull',
+        '-d',
+        ...containers,
+    ],
+    { stdio: 'inherit' }
+);
 
 // If Docker Toolbox is being used, we need to manually forward LOCAL_PORT to the Docker VM.
 if ( process.env.DOCKER_TOOLBOX_INSTALL_PATH ) {
     // VBoxManage is added to the PATH on every platform except Windows.
-    const vboxmanage = process.env.VBOX_MSI_INSTALL_PATH ? `${ process.env.VBOX_MSI_INSTALL_PATH }/VBoxManage` : 'VBoxManage'
+    const vboxmanage = process.env.VBOX_MSI_INSTALL_PATH ? `${ process.env.VBOX_MSI_INSTALL_PATH }/VBoxManage` : 'VBoxManage';
 
     // Check if the port forwarding is already configured for this port.
-    const vminfoBuffer = execSync( `"${ vboxmanage }" showvminfo "${ process.env.DOCKER_MACHINE_NAME }" --machinereadable` );
+    const vminfoBuffer = spawnSync(
+        vboxmanage,
+        [
+            'showvminfo',
+            process.env.DOCKER_MACHINE_NAME,
+            '--machinereadable'
+        ]
+    ).stdout;
     const vminfo = vminfoBuffer.toString().split( /[\r\n]+/ );
 
@@ -54 +76 @@
         // Delete rules that are using the port we need.
         if ( rule[ 3 ] === process.env.LOCAL_PORT || rule[ 5 ] === process.env.LOCAL_PORT ) {
-            execSync( `"${ vboxmanage }" controlvm "${ process.env.DOCKER_MACHINE_NAME }" natpf1 delete ${ rule[ 0 ] }`, { stdio: 'inherit' } );
+            spawnSync(
+                vboxmanage,
+                [
+                    'controlvm',
+                    process.env.DOCKER_MACHINE_NAME,
+                    'natpf1',
+                    'delete',
+                    rule[ 0 ]
+                ],
+                { stdio: 'inherit' }
+            );
         }
     } );
 
     // Add our port forwarding rule.
-    execSync( `"${ vboxmanage }" controlvm "${ process.env.DOCKER_MACHINE_NAME }" natpf1 "tcp-port${ process.env.LOCAL_PORT },tcp,127.0.0.1,${ process.env.LOCAL_PORT },,${ process.env.LOCAL_PORT }"`, { stdio: 'inherit' } );
+    spawnSync(
+        vboxmanage,
+        [
+            'controlvm',
+            process.env.DOCKER_MACHINE_NAME,
+            'natpf1',
+            `tcp-port${ process.env.LOCAL_PORT },tcp,127.0.0.1,${ process.env.LOCAL_PORT },,${ process.env.LOCAL_PORT }`
+        ],
+        { stdio: 'inherit' }
+    );
 }

branches/6.8/tools/local-env/scripts/utils.js

@@ +1 @@
+/* jshint node:true */
+
 const { existsSync } = require( 'node:fs' );
 
@@ -11 +13 @@
      * When PHP 7.2 or 7.3 is used in combination with MySQL 8.4, an override file will also be returned to ensure
      * that the mysql_native_password plugin authentication plugin is on and available for use.
+     *
+     * @return {string[]} Compose files.
      */
     get_compose_files: function() {
-        var composeFiles = '-f docker-compose.yml';
+        const composeFiles = [ 'docker-compose.yml' ];
 
         if ( existsSync( 'docker-compose.override.yml' ) ) {
-            composeFiles = composeFiles + ' -f docker-compose.override.yml';
+            composeFiles.push( 'docker-compose.override.yml' );
         }
 
@@ -29 +33 @@
         // PHP 7.2/7.3 in combination with MySQL 8.4 requires additional configuration to function properly.
         if ( process.env.LOCAL_DB_VERSION === '8.4' ) {
-            composeFiles = composeFiles + ' -f tools/local-env/old-php-mysql-84.override.yml';
+            composeFiles.push( 'tools/local-env/old-php-mysql-84.override.yml' );
         }