<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[60305] trunk: Build/Test Tools: Improve `env:install` command with better configurability and error handling.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/60305">60305</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/60305","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-06-12 21:00:24 +0000 (Thu, 12 Jun 2025)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/63543">#63543</a>.
Props westonruter, jorbin, SirLouen.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkdockercomposeyml">trunk/docker-compose.yml</a></li>
<li><a href="#trunktoolslocalenvscriptsinstalljs">trunk/tools/local-env/scripts/install.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkdockercomposeyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/docker-compose.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docker-compose.yml 2025-06-12 20:45:40 UTC (rev 60304)
+++ trunk/docker-compose.yml 2025-06-12 21:00:24 UTC (rev 60305)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -106,6 +106,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> PHP_FPM_UID: ${PHP_FPM_UID-1000}
</span><span class="cx" style="display: block; padding: 0 10px"> PHP_FPM_GID: ${PHP_FPM_GID-1000}
</span><span class="cx" style="display: block; padding: 0 10px"> HOST_PATH: ${PWD-}/${LOCAL_DIR-src}
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ WP_CONFIG_PATH: /var/www/wp-config.php
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> volumes:
</span><span class="cx" style="display: block; padding: 0 10px"> - ./:/var/www
</span></span></pre></div>
<a id="trunktoolslocalenvscriptsinstalljs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tools/local-env/scripts/install.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tools/local-env/scripts/install.js 2025-06-12 20:45:40 UTC (rev 60304)
+++ trunk/tools/local-env/scripts/install.js 2025-06-12 21:00:24 UTC (rev 60305)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,8 +1,10 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/* jshint node:true */
+
</ins><span class="cx" style="display: block; padding: 0 10px"> const dotenv = require( 'dotenv' );
</span><span class="cx" style="display: block; padding: 0 10px"> const dotenvExpand = require( 'dotenv-expand' );
</span><span class="cx" style="display: block; padding: 0 10px"> const wait_on = require( 'wait-on' );
</span><span class="cx" style="display: block; padding: 0 10px"> const { execSync } = require( 'child_process' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-const { renameSync, readFileSync, writeFileSync } = require( 'fs' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+const { readFileSync, writeFileSync } = require( 'fs' );
</ins><span class="cx" style="display: block; padding: 0 10px"> const local_env_utils = require( './utils' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> dotenvExpand.expand( dotenv.config() );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -11,7 +13,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> local_env_utils.determine_auth_option();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Create wp-config.php.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-wp_cli( 'config create --dbname=wordpress_develop --dbuser=root --dbpass=password --dbhost=mysql --force' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+wp_cli( `config create --dbname=wordpress_develop --dbuser=root --dbpass=password --dbhost=mysql --force --config-file=${process.env.LOCAL_DIR}/../wp-config.php` );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add the debug settings to wp-config.php.
</span><span class="cx" style="display: block; padding: 0 10px"> // Windows requires this to be done as an additional step, rather than using the --extra-php option in the previous step.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,9 +24,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cli( `config set WP_ENVIRONMENT_TYPE ${process.env.LOCAL_WP_ENVIRONMENT_TYPE} --type=constant` );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cli( `config set WP_DEVELOPMENT_MODE ${process.env.LOCAL_WP_DEVELOPMENT_MODE} --type=constant` );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// 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' );
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Read in wp-tests-config-sample.php, edit it to work with our config, then write it to wp-tests-config.php.
</span><span class="cx" style="display: block; padding: 0 10px"> const testConfig = readFileSync( 'wp-tests-config-sample.php', 'utf8' )
</span><span class="cx" style="display: block; padding: 0 10px"> .replace( 'youremptytestdbnamehere', 'wordpress_develop_tests' )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,17 +30,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> .replace( 'yourusernamehere', 'root' )
</span><span class="cx" style="display: block; padding: 0 10px"> .replace( 'yourpasswordhere', 'password' )
</span><span class="cx" style="display: block; padding: 0 10px"> .replace( 'localhost', 'mysql' )
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- .replace( "'WP_TESTS_DOMAIN', 'example.org'", `'WP_TESTS_DOMAIN', '${process.env.LOCAL_WP_TESTS_DOMAIN}'` )
- .concat( "\ndefine( 'FS_METHOD', 'direct' );\n" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ .replace( `'WP_TESTS_DOMAIN', 'example.org'`, `'WP_TESTS_DOMAIN', '${process.env.LOCAL_WP_TESTS_DOMAIN}'` )
+ .concat( `\ndefine( 'FS_METHOD', 'direct' );\n` );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> writeFileSync( 'wp-tests-config.php', testConfig );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Once the site is available, install WordPress!
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-wait_on( { resources: [ `tcp:localhost:${process.env.LOCAL_PORT}`] } )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+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 );
+ } )
</ins><span class="cx" style="display: block; padding: 0 10px"> .then( () => {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cli( 'db reset --yes' );
</span><span class="cx" style="display: block; padding: 0 10px"> const installCommand = process.env.LOCAL_MULTISITE === 'true' ? 'multisite-install' : 'install';
</span><span class="cx" style="display: block; padding: 0 10px"> 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}` );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } )
+ .catch( err => {
+ console.error( `Error: Unable to reset DB and install WordPress. Message: ${ err.message }` );
+ process.exit( 1 );
</ins><span class="cx" style="display: block; padding: 0 10px"> } );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre>
</div>
</div>
</body>
</html>