fix(abstract-testcase) fail on dropped db connection

lucatume · May 24, 2024 · 172b449 · 172b449
1 parent d246940
commit 172b449
Show file tree

Hide file tree

Showing 5 changed files with 94 additions and 6 deletions.
diff --git a/config/patches/core-phpunit/includes/abstract-testcase.php.patch b/config/patches/core-phpunit/includes/abstract-testcase.php.patch
@@ -35,8 +35,8 @@ index f2978644..e092beca 100644
  		$wpdb->show_errors     = true;
 -		$wpdb->db_connect();
 -		ini_set( 'display_errors', 1 );
-+        if ( ! $wpdb->check_connection(false) ) {
-+            $wpdb->db_connect();
++        if ( empty( lucatume\WPBrowser\Utils\Property::readPrivate( $wpdb, 'dbh' ) ) ) {
++            self::fail( 'The database connection went away. A `setUpBeforeClassMethod` likely closed the connection.' );
 +        }
 +        ini_set( 'display_errors', 1 );
 

diff --git a/includes/core-phpunit/includes/abstract-testcase.php b/includes/core-phpunit/includes/abstract-testcase.php
@@ -68,8 +68,8 @@ public static function set_up_before_class() {
 
 		$wpdb->suppress_errors = false;
 		$wpdb->show_errors     = true;
-        if ( ! $wpdb->check_connection(false) ) {
-            $wpdb->db_connect();
+        if ( empty( lucatume\WPBrowser\Utils\Property::readPrivate( $wpdb, 'dbh' ) ) ) {
+            self::fail( 'The database connection went away. A `setUpBeforeClassMethod` likely closed the connection.' );
         }
         ini_set( 'display_errors', 1 );
 

diff --git a/tests/unit/lucatume/WPBrowser/Module/WPLoaderArbitraryPluginLocationTest.php b/tests/unit/lucatume/WPBrowser/Module/WPLoaderArbitraryPluginLocationTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace unit\lucatume\WPBrowser\Module;
+namespace lucatume\WPBrowser\Module;
 
 use Codeception\Lib\Di;
 use Codeception\Lib\ModuleContainer;

diff --git a/tests/unit/lucatume/WPBrowser/Module/WPLoaderArbitraryThemeLocationTest.php b/tests/unit/lucatume/WPBrowser/Module/WPLoaderArbitraryThemeLocationTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace unit\lucatume\WPBrowser\Module;
+namespace lucatume\WPBrowser\Module;
 
 use Codeception\Exception\ModuleConfigException;
 use Codeception\Lib\Di;

diff --git a/tests/unit/lucatume/WPBrowser/Module/WPLoaderDbConnectionClosedTest.php b/tests/unit/lucatume/WPBrowser/Module/WPLoaderDbConnectionClosedTest.php
@@ -0,0 +1,88 @@
+<?php
+
+namespace lucatume\WPBrowser\Module;
+
+use Codeception\Lib\Di;
+use Codeception\Lib\ModuleContainer;
+use Codeception\Test\Unit;
+use lucatume\WPBrowser\Tests\Traits\LoopIsolation;
+use lucatume\WPBrowser\Tests\Traits\TmpFilesCleanup;
+use lucatume\WPBrowser\Utils\Env;
+use lucatume\WPBrowser\Utils\Filesystem as FS;
+use lucatume\WPBrowser\Utils\Random;
+use lucatume\WPBrowser\WordPress\Database\MysqlDatabase;
+use lucatume\WPBrowser\WordPress\Installation;
+use PHPUnit\Framework\Assert;
+use PHPUnit\Framework\TestResult;
+
+class WPLoaderDbConnectionClosedTest extends Unit
+{
+    use LoopIsolation;
+    use TmpFilesCleanup;
+
+    private function module(array $moduleContainerConfig = [], ?array $moduleConfig = null): WPLoader
+    {
+        $this->mockModuleContainer = new ModuleContainer(new Di(), $moduleContainerConfig);
+        return new WPLoader($this->mockModuleContainer, ($moduleConfig ?? $this->config));
+    }
+
+    public function test_will_fail_if_db_connection_closed_during_setup_before_class(): void
+    {
+        $wpRootDir = FS::tmpDir('wploader_');
+        $dbName = Random::dbName();
+        $dbHost = Env::get('WORDPRESS_DB_HOST');
+        $dbUser = Env::get('WORDPRESS_DB_USER');
+        $dbPassword = Env::get('WORDPRESS_DB_PASSWORD');
+        $db = new MysqlDatabase($dbName, $dbUser, $dbPassword, $dbHost);
+        Installation::scaffold($wpRootDir);
+        $db->create();
+        $this->config = [
+            'wpRootFolder' => $wpRootDir,
+            'dbUrl' => $db->getDbUrl()
+        ];
+        $testcaseFile = $wpRootDir . '/BreakingTest.php';
+        $testCaseFileContents = <<< PHP
+            <?php
+            
+            use lucatume\WPBrowser\TestCase\WPTestCase;
+
+            class BreakingTest extends WPTestCase
+            {
+                public static function setUpBeforeClass():void
+                {
+                    global \$wpdb;
+                    \$wpdb->close();
+
+                    parent::set_up_before_class();
+                }
+
+                public function test_something():void{
+                    \$this->assertTrue(true);
+                }
+            }
+        PHP;
+        if(!file_put_contents($testcaseFile, $testCaseFileContents, LOCK_EX)) {
+            throw new \RuntimeException('Could not write BreakingTest.php.');
+        }
+
+        $wpLoader = $this->module();
+
+        $this->assertInIsolation(static function () use ($wpLoader, $testcaseFile) {
+            $wpLoader->_initialize();
+
+            require_once $testcaseFile;
+
+            try {
+                \BreakingTest::setUpBeforeClass();
+            } catch (\Throwable $e) {
+                Assert::assertStringContainsString(
+                    'The database connection went away. A `setUpBeforeClassMethod` likely closed the connection',
+                    $e->getMessage()
+                );
+                return;
+            }
+
+            Assert::fail('The test should have failed.');
+        });
+    }
+}