Changeset 60305

Timestamp:

06/12/2025 09:00:24 PM (7 months ago)

Author:

westonruter

Message:

Build/Test Tools: Improve env:install command with better configurability and error handling.

• Force WP-CLI to use the wp-config.php in the directory above the src directory via the WP_CONFIG_PATH environment variable [read by WP-CLI](​https://github.com/wp-cli/wp-cli/blob/2800ad0a66747a826ae4221b2f022f1df6779cb6/php/utils.php#L328-L329) in the wp_locate_config() function.
• Update the env:install command to write out the config at the repo root instead of writing it inside of the ABSPATH only then to move it one directory up.
• Fix JSHint issues.
• Add error handling to when npm run env:install is executed without having first done npm run env:start, in which case the script will end with an exit code of 1 and emit:

Error: It appears the development environment has not been started. Message: Timed out waiting for: tcp:localhost:8000
Did you forget to do 'npm run env:start'?

Fixes #63543.
Props westonruter, jorbin, SirLouen.

Location:

trunk

Files:

• docker-compose.yml (modified) (1 diff)
• tools/local-env/scripts/install.js (modified) (4 diffs)

trunk/docker-compose.yml

@@ -107 +107 @@
       PHP_FPM_GID: ${PHP_FPM_GID-1000}
       HOST_PATH: ${PWD-}/${LOCAL_DIR-src}
+      WP_CONFIG_PATH: /var/www/wp-config.php
 
     volumes:

trunk/tools/local-env/scripts/install.js

@@ +1 @@
+/* jshint node:true */
+
 const dotenv       = require( 'dotenv' );
 const dotenvExpand = require( 'dotenv-expand' );
 const wait_on = require( 'wait-on' );
 const { execSync } = require( 'child_process' );
-const { renameSync, readFileSync, writeFileSync } = require( 'fs' );
+const { readFileSync, writeFileSync } = require( 'fs' );
 const local_env_utils = require( './utils' );
 
@@ -12 +14 @@
 
 // Create wp-config.php.
-wp_cli( 'config create --dbname=wordpress_develop --dbuser=root --dbpass=password --dbhost=mysql --force' );
+wp_cli( `config create --dbname=wordpress_develop --dbuser=root --dbpass=password --dbhost=mysql --force --config-file=${process.env.LOCAL_DIR}/../wp-config.php` );
 
 // Add the debug settings to wp-config.php.
@@ -23 +25 @@
 wp_cli( `config set WP_DEVELOPMENT_MODE ${process.env.LOCAL_WP_DEVELOPMENT_MODE} --type=constant` );
 
-// Move wp-config.php to the base directory, so it doesn't get mixed up in the src or build directories.
-renameSync( `${process.env.LOCAL_DIR}/wp-config.php`, 'wp-config.php' );
-
 // Read in wp-tests-config-sample.php, edit it to work with our config, then write it to wp-tests-config.php.
 const testConfig = readFileSync( 'wp-tests-config-sample.php', 'utf8' )
@@ -32 +31 @@
     .replace( 'yourpasswordhere', 'password' )
     .replace( 'localhost', 'mysql' )
-    .replace( "'WP_TESTS_DOMAIN', 'example.org'", `'WP_TESTS_DOMAIN', '${process.env.LOCAL_WP_TESTS_DOMAIN}'` )
-    .concat( "\ndefine( 'FS_METHOD', 'direct' );\n" );
+    .replace( `'WP_TESTS_DOMAIN', 'example.org'`, `'WP_TESTS_DOMAIN', '${process.env.LOCAL_WP_TESTS_DOMAIN}'` )
+    .concat( `\ndefine( 'FS_METHOD', 'direct' );\n` );
 
 writeFileSync( 'wp-tests-config.php', testConfig );
 
 // Once the site is available, install WordPress!
-wait_on( { resources: [ `tcp:localhost:${process.env.LOCAL_PORT}`] } )
+wait_on( {
+    resources: [ `tcp:localhost:${process.env.LOCAL_PORT}`],
+    timeout: 3000,
+} )
+    .catch( err => {
+        console.error( `Error: It appears the development environment has not been started. Message: ${ err.message }` );
+        console.error( `Did you forget to do 'npm run env:start'?` );
+        process.exit( 1 );
+    } )
     .then( () => {
         wp_cli( 'db reset --yes' );
         const installCommand = process.env.LOCAL_MULTISITE === 'true'  ? 'multisite-install' : 'install';
         wp_cli( `core ${ installCommand } --title="WordPress Develop" --admin_user=admin --admin_password=password --admin_email=test@example.com --skip-email --url=http://localhost:${process.env.LOCAL_PORT}` );
+    } )
+    .catch( err => {
+        console.error( `Error: Unable to reset DB and install WordPress. Message: ${ err.message }` );
+        process.exit( 1 );
     } );