Merge pull request #787 from lucatume/fix-issue-786

lucatume · web-flow · commit 20222b70e795 · 2025-11-05T00:18:10.000+01:00
Support empty db password
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [unreleased] Unreleased
 
+### Fixed
+
+- Fixed `DB_PASSWORD` constant not being defined when `dbPassword` configuration parameter is set to an empty string in `WPLoader` module, fixes #786.
+
 ## [4.5.7] 2025-09-09;
 
 ### Fixed
@@ -408,7 +412,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Set `path` correctly in `WPWebDriver` module setup
 - Set dump file paths correctly on Windows machines
 - Use correct Chrome and Chromedriver binary paths on Windows machines
-- Work around command line length limit on Windows machines to ensure process-based operaitons work correctly
+- Work around command line length limit on Windows machines to ensure process-based operations work correctly
 
 ## [4.0.4] 2023-09-29;
 
diff --git a/docs/migration.md b/docs/migration.md
@@ -3,7 +3,7 @@ Depending on your project PHP compatibility, you have three options to choose fr
 * Your project supports PHP `7.1` to `7.4`: [migrate to wp-browser version `3.5`](#migrate-from-version-3-to-35)
 * Your project supports PHP `8.0` or above: [migrate to wp-browser version `4.0`](#migrate-from-version-3-to-4)
 * You cannot, or do not want, to migrate from version `3` of wp-browser to a new
-  version: [see how you can lock your reuirements to avoid the upgrade](#staying-on-version-3-lower-than-35)
+  version: [see how you can lock your requirements to avoid the upgrade](#staying-on-version-3-lower-than-35)
 
 ## Version 3.5 and 4.0
 
diff --git a/docs/modules/WPBrowser.md b/docs/modules/WPBrowser.md
@@ -145,7 +145,7 @@ $I->amOnAdminAjaxPage(['action' => 'my-action', 'data' => ['id' => 23], 'nonce'
 #### amOnAdminPage
 Signature: `amOnAdminPage(string $page)` : `void`  
 
-Go to a page in the admininstration area of the site.
+Go to a page in the administration area of the site.
 
 This method will **not** handle authentication to the administration area.
 
diff --git a/docs/modules/WPWebDriver.md b/docs/modules/WPWebDriver.md
@@ -159,7 +159,7 @@ $I->amOnAdminAjaxPage(['action' => 'my-action', 'data' => ['id' => 23], 'nonce'
 #### amOnAdminPage
 Signature: `amOnAdminPage(string $page)` : `void`  
 
-Go to a page in the admininstration area of the site.
+Go to a page in the administration area of the site.
 
 This method will **not** handle authentication to the administration area.
 
diff --git a/docs/v3/levels-of-testing.md b/docs/v3/levels-of-testing.md
@@ -140,7 +140,7 @@ class SubmissionHandlingTest extends \Codeception\TestCase\WPTestCase {
         
         $response = $handler->handle( $request );
         
-        $this->assertIntsanceOf( WP_REST_Response::class, $response );
+        $this->assertInstanceOf( WP_REST_Response::class, $response );
         $this->assertEquals( 200, $response->get_status() );
         $this->assertInstanceOf( Acme\Signup\Submission_Good::class, $handler->last_submission() );
         $this->assertEquals( 'luca', $handler->last_submission()->name() );
@@ -154,7 +154,7 @@ class SubmissionHandlingTest extends \Codeception\TestCase\WPTestCase {
         
         $response = $handler->handle( $request );
         
-        $this->assertIntsanceOf( WP_REST_Response::class, $response );
+        $this->assertInstanceOf( WP_REST_Response::class, $response );
         $this->assertEquals( 400, $response->get_status() );
         $this->assertInstanceOf( Acme\Signup\Submission_Bad::class, $handler->last_submission() );
         $this->assertEquals( 'luca', $handler->last_submission()->name() );
diff --git a/docs/v3/modules/WPBrowser.md b/docs/v3/modules/WPBrowser.md
@@ -89,7 +89,7 @@ Since this module extends the `PHPBrowser` module provided by Codeception, pleas
 
 
 * `amOnAdminPage($page)` : `void`  
-  Go to a page in the admininstration area of the site.
+  Go to a page in the administration area of the site.
 
   This method will **not** handle authentication to the administration area.
 
diff --git a/docs/v3/modules/WPWebDriver.md b/docs/v3/modules/WPWebDriver.md
@@ -98,7 +98,7 @@ modules:
 
 
 * `amOnAdminPage($page)` : `void`  
-  Go to a page in the admininstration area of the site.
+  Go to a page in the administration area of the site.
 
   This method will **not** handle authentication to the administration area.
 
diff --git a/docs/v3/modules/WordPress.md b/docs/v3/modules/WordPress.md
@@ -165,7 +165,7 @@ $I->amOnAdminAjaxPage(['action' => 'my-action', 'data' => ['id' => 23], 'nonce'
 
 <hr>
 
-<p>Go to a page in the admininstration area of the site.</p>
+<p>Go to a page in the administration area of the site.</p>
 ```php
 $I->loginAs('user', 'password');
   // Go to the plugins management screen.
diff --git a/docs/v3/tutorials/vvv-setup.md b/docs/v3/tutorials/vvv-setup.md
@@ -44,7 +44,7 @@ If the sanity check above is complete it's time to move to the following part sp
 
 ## In and out, host and guest
 
-The Vagrant box provided by VVV goes beyond a simple MySQL, PHP and Ngnix server stack and provides a complete WordPress development environment; tools like [Composer](https://getcomposer.org/), [grunt-cli][4992-0003], and [wp-cli][4992-0006] are ready to use.  
+The Vagrant box provided by VVV goes beyond a simple MySQL, PHP and Nginx server stack and provides a complete WordPress development environment; tools like [Composer](https://getcomposer.org/), [grunt-cli][4992-0003], and [wp-cli][4992-0006] are ready to use.  
 
 This allows the entire development, when it comes to the CLI tools, to happen **in the virtual machine and not outside of it**.  
 
diff --git a/includes/core-phpunit/wp-tests-config.php b/includes/core-phpunit/wp-tests-config.php
@@ -89,7 +89,9 @@
              'WP_PLUGIN_DIR' => $wpLoaderConfig['WP_PLUGIN_DIR'] ?? null,
              'WPMU_PLUGIN_DIR' => $wpLoaderConfig['WPMU_PLUGIN_DIR'] ?? null,
          ] as $const => $value) {
-    if ($value && !defined($const)) {
+    // DB_PASSWORD can be an empty string for passwordless database users (e.g., root on local development).
+    $shouldDefine = ($const === 'DB_PASSWORD' && array_key_exists('dbPassword', $wpLoaderConfig)) || $value;
+    if ($shouldDefine && !defined($const)) {
         define($const, $value);
     }
 }
diff --git a/src/Module/WPBrowserMethods.php b/src/Module/WPBrowserMethods.php
@@ -379,7 +379,7 @@ public function grabWordPressTestCookie(?string $name = null): ?Cookie
     }
 
     /**
-     * Go to a page in the admininstration area of the site.
+     * Go to a page in the administration area of the site.
      *
      * This method will **not** handle authentication to the administration area.
      *
diff --git a/tests/_support/_generated/AcceptanceTesterActions.php b/tests/_support/_generated/AcceptanceTesterActions.php
@@ -2777,7 +2777,7 @@ public function grabWordPressTestCookie(?string $name = NULL): ?\Symfony\Compone
     /**
      * [!] Method is generated. Documentation taken from corresponding module.
      *
-     * Go to a page in the admininstration area of the site.
+     * Go to a page in the administration area of the site.
      *
      * This method will **not** handle authentication to the administration area.
      *
diff --git a/tests/_support/_generated/ClimoduleTesterActions.php b/tests/_support/_generated/ClimoduleTesterActions.php
@@ -7878,7 +7878,7 @@ public function grabWordPressTestCookie(?string $name = NULL): ?\Symfony\Compone
     /**
      * [!] Method is generated. Documentation taken from corresponding module.
      *
-     * Go to a page in the admininstration area of the site.
+     * Go to a page in the administration area of the site.
      *
      * This method will **not** handle authentication to the administration area.
      *
diff --git a/tests/_support/_generated/WebDriverTesterActions.php b/tests/_support/_generated/WebDriverTesterActions.php
@@ -3480,7 +3480,7 @@ public function grabWordPressTestCookie(?string $name = NULL): ?\Symfony\Compone
     /**
      * [!] Method is generated. Documentation taken from corresponding module.
      *
-     * Go to a page in the admininstration area of the site.
+     * Go to a page in the administration area of the site.
      *
      * This method will **not** handle authentication to the administration area.
      *
diff --git a/tests/_support/_generated/WploaderTesterActions.php b/tests/_support/_generated/WploaderTesterActions.php
@@ -1,4 +1,4 @@
-<?php  //[STAMP] 897ecf22339f109a2db2de00e8fdd4ad
+<?php  //[STAMP] d559fa416da27fd2ef68e674c01259c7
 // phpcs:ignoreFile
 namespace _generated;
 
diff --git a/tests/unit/lucatume/WPBrowser/CorePHPUnit/WpTestsConfigTest.php b/tests/unit/lucatume/WPBrowser/CorePHPUnit/WpTestsConfigTest.php
@@ -0,0 +1,157 @@
+<?php
+
+namespace lucatume\WPBrowser\CorePHPUnit;
+
+use Codeception\Test\Unit;
+
+/**
+ * Test that wp-tests-config.php correctly handles empty DB_PASSWORD.
+ *
+ * This test verifies the fix for issue #786 where an empty dbPassword in WPLoader
+ * configuration would result in an undefined DB_PASSWORD constant.
+ *
+ * @see https://github.com/lucatume/wp-browser/issues/786
+ */
+class WpTestsConfigTest extends Unit
+{
+    /**
+     * @test
+     * Test that DB_PASSWORD constant is defined when dbPassword is empty string.
+     */
+    public function test_db_password_constant_defined_with_empty_password(): void
+    {
+        // Simulate the wp-tests-config.php logic
+        $wpLoaderConfig = [
+            'wpRootFolder' => '/path/to/wordpress',
+            'theme' => 'twentytwentyfour',
+            'multisite' => false,
+            'dbName' => 'test_db',
+            'dbUser' => 'root',
+            'dbPassword' => '', // Empty password - the bug case
+            'dbHost' => 'localhost',
+            'dbCharset' => 'utf8',
+            'dbCollate' => '',
+            'AUTH_KEY' => 'test_key',
+            'SECURE_AUTH_KEY' => 'test_key',
+            'LOGGED_IN_KEY' => 'test_key',
+            'NONCE_KEY' => 'test_key',
+            'AUTH_SALT' => 'test_salt',
+            'SECURE_AUTH_SALT' => 'test_salt',
+            'LOGGED_IN_SALT' => 'test_salt',
+            'NONCE_SALT' => 'test_salt',
+            'domain' => 'test.local',
+            'adminEmail' => 'admin@test.local',
+            'title' => 'Test Site',
+            'phpBinary' => 'php',
+            'language' => '',
+            'AUTOMATIC_UPDATER_DISABLED' => true,
+            'WP_HTTP_BLOCK_EXTERNAL' => false,
+            'WP_CONTENT_DIR' => null,
+            'WP_PLUGIN_DIR' => null,
+            'WPMU_PLUGIN_DIR' => null,
+            'tablePrefix' => 'wp_',
+        ];
+
+        $abspath = rtrim($wpLoaderConfig['wpRootFolder'], '\\/') . '/';
+        $themes = (array)$wpLoaderConfig['theme'];
+        $stylesheet = end($themes);
+
+        $constantsToDefine = [
+            'ABSPATH' => $abspath,
+            'WP_DEFAULT_THEME' => $stylesheet,
+            'WP_TESTS_MULTISITE' => $wpLoaderConfig['multisite'],
+            'WP_DEBUG' => true,
+            'DB_NAME' => $wpLoaderConfig['dbName'],
+            'DB_USER' => $wpLoaderConfig['dbUser'],
+            'DB_PASSWORD' => $wpLoaderConfig['dbPassword'],
+            'DB_HOST' => $wpLoaderConfig['dbHost'],
+            'DB_CHARSET' => $wpLoaderConfig['dbCharset'] ?? 'utf8',
+            'DB_COLLATE' => $wpLoaderConfig['dbCollate'] ?? '',
+        ];
+
+        $definedConstants = [];
+
+        // Apply the fixed logic from wp-tests-config.php
+        foreach ($constantsToDefine as $const => $value) {
+            // DB_PASSWORD can be an empty string for passwordless database users
+            $shouldDefine = ($const === 'DB_PASSWORD' && array_key_exists('dbPassword', $wpLoaderConfig)) || $value;
+            if ($shouldDefine) {
+                $definedConstants[$const] = $value;
+            }
+        }
+
+        // Verify DB_PASSWORD was included even though it's an empty string
+        $this->assertArrayHasKey('DB_PASSWORD', $definedConstants, 'DB_PASSWORD should be defined even when empty');
+        $this->assertSame('', $definedConstants['DB_PASSWORD'], 'DB_PASSWORD should have empty string value');
+
+        // Verify other constants are also defined correctly
+        $this->assertArrayHasKey('DB_NAME', $definedConstants);
+        $this->assertArrayHasKey('DB_USER', $definedConstants);
+        $this->assertArrayHasKey('DB_HOST', $definedConstants);
+        $this->assertSame('test_db', $definedConstants['DB_NAME']);
+        $this->assertSame('root', $definedConstants['DB_USER']);
+        $this->assertSame('localhost', $definedConstants['DB_HOST']);
+    }
+
+    /**
+     * @test
+     * Test that DB_PASSWORD constant is defined when dbPassword is non-empty.
+     */
+    public function test_db_password_constant_defined_with_non_empty_password(): void
+    {
+        $wpLoaderConfig = [
+            'wpRootFolder' => '/path/to/wordpress',
+            'theme' => 'twentytwentyfour',
+            'multisite' => false,
+            'dbName' => 'test_db',
+            'dbUser' => 'testuser',
+            'dbPassword' => 'secret123', // Non-empty password
+            'dbHost' => 'localhost',
+            'dbCharset' => 'utf8',
+            'dbCollate' => '',
+        ];
+
+        $constantsToDefine = [
+            'DB_PASSWORD' => $wpLoaderConfig['dbPassword'],
+        ];
+
+        $definedConstants = [];
+
+        foreach ($constantsToDefine as $const => $value) {
+            $shouldDefine = ($const === 'DB_PASSWORD' && array_key_exists('dbPassword', $wpLoaderConfig)) || $value;
+            if ($shouldDefine) {
+                $definedConstants[$const] = $value;
+            }
+        }
+
+        $this->assertArrayHasKey('DB_PASSWORD', $definedConstants, 'DB_PASSWORD should be defined with non-empty value');
+        $this->assertSame('secret123', $definedConstants['DB_PASSWORD']);
+    }
+
+    /**
+     * @test
+     * Test the old logic (before fix) would fail with empty password.
+     */
+    public function test_old_logic_fails_with_empty_password(): void
+    {
+        $wpLoaderConfig = [
+            'dbPassword' => '', // Empty password
+        ];
+
+        $constantsToDefine = [
+            'DB_PASSWORD' => $wpLoaderConfig['dbPassword'],
+        ];
+
+        $definedConstants = [];
+
+        // Old logic that had the bug
+        foreach ($constantsToDefine as $const => $value) {
+            if ($value) { // This fails for empty string
+                $definedConstants[$const] = $value;
+            }
+        }
+
+        // This demonstrates the bug - DB_PASSWORD was not defined
+        $this->assertArrayNotHasKey('DB_PASSWORD', $definedConstants, 'Old logic should NOT define DB_PASSWORD with empty value');
+    }
+}
diff --git a/tests/unit/lucatume/WPBrowser/Module/WPTestCaseStrictTest.php b/tests/unit/lucatume/WPBrowser/Module/WPTestCaseStrictTest.php
@@ -30,7 +30,7 @@ private function module(array $moduleContainerConfig = [], ?array $moduleConfig
         return new WPLoader($this->mockModuleContainer, ($moduleConfig ?? $this->config));
     }
 
-    public function nonBooleanVAluesProvider(): array
+    public function nonBooleanVValuesProvider(): array
     {
         return [
             'int' => [1],
@@ -43,7 +43,7 @@ public function nonBooleanVAluesProvider(): array
     }
 
     /**
-     * @dataProvider nonBooleanVAluesProvider
+     * @dataProvider nonBooleanVValuesProvider
      */
     public function test_will_throw_if_beStrictAboutWpdbConnectionId_is_not_boolean($value): void
     {
diff --git a/tests/wploadersuite/EmptyDbPasswordTest.php b/tests/wploadersuite/EmptyDbPasswordTest.php
@@ -0,0 +1,43 @@
+<?php
+
+use lucatume\WPBrowser\TestCase\WPTestCase;
+
+/**
+ * Test that DB_PASSWORD constant is defined even when the password is empty.
+ *
+ * This test verifies the fix for issue #786 where an empty dbPassword in WPLoader
+ * configuration would result in an undefined DB_PASSWORD constant.
+ *
+ * @see https://github.com/lucatume/wp-browser/issues/786
+ */
+class EmptyDbPasswordTest extends WPTestCase
+{
+    /**
+     * @test
+     * Test that DB_PASSWORD constant is defined even with empty password.
+     */
+    public function test_db_password_constant_is_defined(): void
+    {
+        $this->assertTrue(defined('DB_PASSWORD'), 'DB_PASSWORD constant should be defined');
+    }
+
+    /**
+     * @test
+     * Test that DB_PASSWORD can be an empty string.
+     */
+    public function test_db_password_constant_can_be_empty(): void
+    {
+        // DB_PASSWORD should be defined even if it's an empty string
+        // This is valid for passwordless database users (e.g., root on local development)
+        $this->assertTrue(
+            defined('DB_PASSWORD'),
+            'DB_PASSWORD constant should be defined even when password is empty'
+        );
+
+        // The value can be empty string or non-empty, both are valid
+        $this->assertTrue(
+            is_string(DB_PASSWORD),
+            'DB_PASSWORD should be a string (empty or non-empty)'
+        );
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,9 @@`
`89`	`89`	`'WP_PLUGIN_DIR' => $wpLoaderConfig['WP_PLUGIN_DIR'] ?? null,`
`90`	`90`	`'WPMU_PLUGIN_DIR' => $wpLoaderConfig['WPMU_PLUGIN_DIR'] ?? null,`
`91`	`91`	`] as $const => $value) {`
`92`		`- if ($value && !defined($const)) {`
	`92`	`+ // DB_PASSWORD can be an empty string for passwordless database users (e.g., root on local development).`
	`93`	`+ $shouldDefine = ($const === 'DB_PASSWORD' && array_key_exists('dbPassword', $wpLoaderConfig)) \|\| $value;`
	`94`	`+ if ($shouldDefine && !defined($const)) {`
`93`	`95`	`define($const, $value);`
`94`	`96`	`}`
`95`	`97`	`}`