[11.x] Allows to persist database connection between tests and only reset PDO in afterClassTearDown()

.github/workflows/databases.yml

@@ -235,3 +235,40 @@ jobs:
           DB_DATABASE: master
           DB_USERNAME: SA
           DB_PASSWORD: Forge123
+
+  sqlite:
+    runs-on: ubuntu-20.04
+
+    strategy:
+      fail-fast: true
+
+    name: SQLite
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, sqlsrv, pdo, pdo_sqlsrv, odbc, pdo_odbc, :php-psr
+          tools: composer:v2
+          coverage: none
+
+      - name: Install dependencies
+        uses: nick-fields/retry@v2
+        with:
+          timeout_minutes: 5
+          max_attempts: 5
+          command: composer update --prefer-stable --prefer-dist --no-interaction --no-progress
+
+      - name: Create database
+        run: vendor/bin/testbench package:create-sqlite-db
+
+      - name: Execute tests
+        run: vendor/bin/phpunit tests/Integration/Database
+        env:
+          DB_CONNECTION: sqlite

composer.json

@@ -106,7 +106,7 @@
         "league/flysystem-sftp-v3": "^3.0",
         "mockery/mockery": "^1.5.1",
         "nyholm/psr7": "^1.2",
-        "orchestra/testbench-core": "^9.0",
+        "orchestra/testbench-core": "dev-persist-db-connections",
         "pda/pheanstalk": "^5.0",
         "phpstan/phpstan": "^1.4.7",
         "phpunit/phpunit": "^10.1",

src/Illuminate/Contracts/Database/Connectors/ConnectionFactory.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Illuminate\Contracts\Database\Connectors;
+
+interface ConnectionFactory
+{
+    /**
+     * Establish a PDO connection based on the configuration.
+     *
+     * @param  array  $config
+     * @param  string  $name
+     * @return \Illuminate\Database\Connection
+     */
+    public function make(array $config, $name);
+}

src/Illuminate/Database/Connectors/ConnectionFactory.php

@@ -3,6 +3,7 @@
 namespace Illuminate\Database\Connectors;
 
 use Illuminate\Contracts\Container\Container;
+use Illuminate\Contracts\Database\Connectors\ConnectionFactory as ConnectionFactoryContract;
 use Illuminate\Database\Connection;
 use Illuminate\Database\MySqlConnection;
 use Illuminate\Database\PostgresConnection;
@@ -12,7 +13,7 @@
 use InvalidArgumentException;
 use PDOException;
 
-class ConnectionFactory
+class ConnectionFactory implements ConnectionFactoryContract
 {
     /**
      * The IoC container instance.
@@ -36,10 +37,10 @@ public function __construct(Container $container)
      * Establish a PDO connection based on the configuration.
      *
      * @param  array  $config
-     * @param  string|null  $name
+     * @param  string  $name
      * @return \Illuminate\Database\Connection
      */
-    public function make(array $config, $name = null)
+    public function make(array $config, $name)
     {
         $config = $this->parseConfig($config, $name);
 

src/Illuminate/Database/DatabaseManager.php

@@ -3,7 +3,7 @@
 namespace Illuminate\Database;
 
 use Doctrine\DBAL\Types\Type;
-use Illuminate\Database\Connectors\ConnectionFactory;
+use Illuminate\Contracts\Database\Connectors\ConnectionFactory;
 use Illuminate\Database\Events\ConnectionEstablished;
 use Illuminate\Support\Arr;
 use Illuminate\Support\ConfigurationUrlParser;
@@ -32,7 +32,7 @@ class DatabaseManager implements ConnectionResolverInterface
     /**
      * The database connection factory instance.
      *
-     * @var \Illuminate\Database\Connectors\ConnectionFactory
+     * @var \Illuminate\Contracts\Database\Connectors\ConnectionFactory
      */
     protected $factory;
 
@@ -68,7 +68,7 @@ class DatabaseManager implements ConnectionResolverInterface
      * Create a new database manager instance.
      *
      * @param  \Illuminate\Contracts\Foundation\Application  $app
-     * @param  \Illuminate\Database\Connectors\ConnectionFactory  $factory
+     * @param  \Illuminate\Contracts\Database\Connectors\ConnectionFactory  $factory
      * @return void
      */
     public function __construct($app, ConnectionFactory $factory)
@@ -149,7 +149,7 @@ protected function makeConnection($name)
             return call_user_func($this->extensions[$driver], $config, $name);
         }
 
-        return $this->factory->make($config, $name);
+        return $this->factory->make($config, $name ?? $this->getDefaultConnection());
     }
 
     /**

src/Illuminate/Foundation/Bootstrap/OverrideProvidersForTesting.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Illuminate\Foundation\Bootstrap;
+
+use Illuminate\Contracts\Foundation\Application;
+use Illuminate\Foundation\Testing\DatabaseConnectionFactory;
+
+class OverrideProvidersForTesting
+{
+    /**
+     * Bootstrap the given application.
+     *
+     * @param  \Illuminate\Contracts\Foundation\Application  $app
+     * @return void
+     */
+    public function bootstrap(Application $app)
+    {
+        if (! $app->runningUnitTests()) {
+            return;
+        }
+
+        if ($app->bound('db.factory')) {
+            tap($app['db.factory'], function ($factory) use ($app) {
+                $app->instance('db.factory', new DatabaseConnectionFactory($app, $factory));
+            });
+        }
+    }
+}

src/Illuminate/Foundation/Console/Kernel.php

@@ -121,6 +121,7 @@ class Kernel implements KernelContract
         \Illuminate\Foundation\Bootstrap\RegisterFacades::class,
         \Illuminate\Foundation\Bootstrap\SetRequestForConsole::class,
         \Illuminate\Foundation\Bootstrap\RegisterProviders::class,
+        \Illuminate\Foundation\Bootstrap\OverrideProvidersForTesting::class,
         \Illuminate\Foundation\Bootstrap\BootProviders::class,
     ];
 

src/Illuminate/Foundation/Testing/Concerns/InteractsWithDatabase.php

@@ -16,6 +16,13 @@
 
 trait InteractsWithDatabase
 {
+    /**
+     * Determine whether database connection should be disconnected between tests.
+     *
+     * @var bool
+     */
+    protected $disconnectDatabaseConnections = false;
+
     /**
      * Assert that a given where condition exists in the database.
      *

src/Illuminate/Foundation/Testing/DatabaseConnectionFactory.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace Illuminate\Foundation\Testing;
+
+use Illuminate\Contracts\Container\Container;
+use Illuminate\Contracts\Database\Connectors\ConnectionFactory as ConnectionFactoryContract;
+use Illuminate\Database\Connectors\ConnectionFactory;
+
+/**
+ * @internal
+ */
+class DatabaseConnectionFactory extends ConnectionFactory
+{
+    /**
+     * List of cached database connections.
+     *
+     * @var array<string, \Illuminate\Database\Connection>
+     */
+    protected static array $cachedConnections = [];
+
+    /**
+     * Create a new connection factory instance.
+     *
+     * @param  \Illuminate\Contracts\Container\Container  $container
+     * @return void
+     */
+    public function __construct(
+        Container $container,
+        protected ConnectionFactoryContract $factory
+    ) {
+        parent::__construct($container);
+    }
+
+    /**
+     * Establish a PDO connection based on the configuration.
+     *
+     * @param  array  $config
+     * @param  string  $name
+     * @return \Illuminate\Database\Connection
+     */
+    #[\Override]
+    public function make(array $config, $name)
+    {
+        $key = $name ?? $config['name'];
+
+        // In-Memory Databases doesn't have any max connections limitation so it should be safe to just create a new connection between tests.
+        // Because some tests may be depend on thier volatile, we should always create new connections to avoid carrying over previous data.
+        if ($config['driver'] === 'sqlite' && $config['database'] === ':memory:') {
+            return $this->factory->make($config, $name);
+        }
+
+        if (! isset(static::$cachedConnections[$key]) || is_null(static::$cachedConnections[$key]->getRawPdo() ?? null)) {
+            return static::$cachedConnections[$key] = $this->factory->make($config, $name);
+        }
+
+        $config = $this->parseConfig($config, $name);
+
+        $connection = $this->createConnection(
+            $config['driver'], static::$cachedConnections[$key]->getRawPdo(), $config['database'], $config['prefix'], $config
+        )->setReadPdo(static::$cachedConnections[$key]->getRawReadPdo());
+
+        return static::$cachedConnections[$key] = $connection;
+    }
+
+    /**
+     * Flush the current state.
+     *
+     * @return void
+     */
+    public static function flushState(): void
+    {
+        foreach (static::$cachedConnections as $connection) {
+            $connection->disconnect();
+        }
+
+        static::$cachedConnections = [];
+    }
+}

src/Illuminate/Foundation/Testing/DatabaseTransactions.php

@@ -33,7 +33,6 @@ public function beginDatabaseTransaction()
                 $connection->unsetEventDispatcher();
                 $connection->rollBack();
                 $connection->setEventDispatcher($dispatcher);
-                $connection->disconnect();
             }
         });
     }

src/Illuminate/Foundation/Testing/DatabaseTransactionsManager.php

@@ -12,6 +12,7 @@ class DatabaseTransactionsManager extends BaseManager
      * @param  callable  $callback
      * @return void
      */
+    #[\Override]
     public function addCallback($callback)
     {
         // If there are no transactions, we'll run the callbacks right away. Also, we'll run it
@@ -29,6 +30,7 @@ public function addCallback($callback)
      *
      * @return \Illuminate\Support\Collection<int, \Illuminate\Database\DatabaseTransactionRecord>
      */
+    #[\Override]
     public function callbackApplicableTransactions()
     {
         return $this->pendingTransactions->skip(1)->values();
@@ -40,6 +42,7 @@ public function callbackApplicableTransactions()
      * @param  int  $level
      * @return bool
      */
+    #[\Override]
     public function afterCommitCallbacksShouldBeExecuted($level)
     {
         return $level === 1;

src/Illuminate/Foundation/Testing/RefreshDatabase.php

@@ -108,7 +108,6 @@ public function beginDatabaseTransaction()
                 $connection->unsetEventDispatcher();
                 $connection->rollBack();
                 $connection->setEventDispatcher($dispatcher);
-                $connection->disconnect();
             }
         });
     }

src/Illuminate/Foundation/Testing/TestCase.php

@@ -189,6 +189,13 @@ protected function tearDown(): void
 
             ParallelTesting::callTearDownTestCaseCallbacks($this);
 
+            if (
+                property_exists($this, 'disconnectDatabaseConnections')
+                && $this->disconnectDatabaseConnections === true
+            ) {
+                DatabaseConnectionFactory::flushState();
+            }
+
             $this->app->flush();
 
             $this->app = null;
@@ -255,6 +262,7 @@ protected function tearDown(): void
     public static function tearDownAfterClass(): void
     {
         static::$latestResponse = null;
+        DatabaseConnectionFactory::flushState();
 
         foreach ([
             \PHPUnit\Util\Annotation\Registry::class,

tests/Integration/Database/DatabaseTestCase.php

@@ -16,17 +16,6 @@ abstract class DatabaseTestCase extends TestCase
      */
     protected $driver;
 
-    protected function setUp(): void
-    {
-        $this->beforeApplicationDestroyed(function () {
-            foreach (array_keys($this->app['db']->getConnections()) as $name) {
-                $this->app['db']->purge($name);
-            }
-        });
-
-        parent::setUp();
-    }
-
     protected function defineEnvironment($app)
     {
         $connection = $app['config']->get('database.default');

tests/Integration/Database/EloquentBelongsToManyTest.php

@@ -15,13 +15,6 @@
 
 class EloquentBelongsToManyTest extends DatabaseTestCase
 {
-    protected function tearDown(): void
-    {
-        parent::tearDown();
-
-        Carbon::setTestNow(null);
-    }
-
     protected function afterRefreshingDatabase()
     {
         Schema::create('users', function (Blueprint $table) {

tests/Integration/Database/EloquentMassPrunableTest.php

@@ -93,15 +93,6 @@ public function testPrunesSoftDeletedRecords()
         $this->assertEquals(0, MassPrunableSoftDeleteTestModel::count());
         $this->assertEquals(2000, MassPrunableSoftDeleteTestModel::withTrashed()->count());
     }
-
-    protected function tearDown(): void
-    {
-        parent::tearDown();
-
-        Container::setInstance(null);
-
-        m::close();
-    }
 }
 
 class MassPrunableTestModel extends Model

tests/Integration/Database/EloquentTransactionWithAfterCommitUsingDatabaseTransactionsTest.php

@@ -19,12 +19,6 @@ class EloquentTransactionWithAfterCommitUsingDatabaseTransactionsTest extends Te
 
     protected function setUp(): void
     {
-        $this->beforeApplicationDestroyed(function () {
-            foreach (array_keys($this->app['db']->getConnections()) as $name) {
-                $this->app['db']->purge($name);
-            }
-        });
-
         parent::setUp();
 
         if ($this->usesSqliteInMemoryDatabaseConnection()) {