[12.x] Better support for multi-dbs in the RefreshDatabase trait (#53231)

* Tweaks the RefreshDatabase trait for better support of multi-dbs

When working with multiple databases and some of them are in-memory
while others are regular disk-based databases, we usually have to
override some of the traits methods to make it work. Also, the database
restoration process doesn't handle multiple DBs that well.

With these changes, when an app needs to support multiple databases, the
user will have to do a few steps:

1. Set the `$connectionsToTransact` protected property on the TestCase
listing all connections they use
1. Override the `migrateDatabase` method and call all the migrate:fresh
commands for all their connections

Restoring the databases between tests should now be completely handled
by the trait, no matter which database connection uses in-memory
databases or not.

* formatting

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: tonysm

src/Illuminate/Foundation/Testing/RefreshDatabase.php

@@ -18,7 +18,7 @@ public function refreshDatabase()
     {
         $this->beforeRefreshingDatabase();
 
-        if ($this->usingInMemoryDatabase()) {
+        if ($this->usingInMemoryDatabases()) {
             $this->restoreInMemoryDatabase();
         }
 
@@ -28,15 +28,29 @@ public function refreshDatabase()
     }
 
     /**
-     * Determine if an in-memory database is being used.
+     * Determine if any of the connections transacting is using in-memory databases.
      *
      * @return bool
      */
-    protected function usingInMemoryDatabase()
+    protected function usingInMemoryDatabases()
     {
-        $default = config('database.default');
+        foreach ($this->connectionsToTransact() as $name) {
+            if ($this->usingInMemoryDatabase($name)) {
+                return true;
+            }
+        }
 
-        return config("database.connections.$default.database") === ':memory:';
+        return false;
+    }
+
+    /**
+     * Determine if a given database connection is an in-memory database.
+     *
+     * @return bool
+     */
+    protected function usingInMemoryDatabase(string $name)
+    {
+        return config("database.connections.{$name}.database") === ':memory:';
     }
 
     /**
@@ -63,7 +77,7 @@ protected function restoreInMemoryDatabase()
     protected function refreshTestDatabase()
     {
         if (! RefreshDatabaseState::$migrated) {
-            $this->artisan('migrate:fresh', $this->migrateFreshUsing());
+            $this->migrateDatabases();
 
             $this->app[Kernel::class]->setArtisan(null);
 
@@ -73,6 +87,16 @@ protected function refreshTestDatabase()
         $this->beginDatabaseTransaction();
     }
 
+    /**
+     * Migrate the database.
+     *
+     * @return void
+     */
+    protected function migrateDatabases()
+    {
+        $this->artisan('migrate:fresh', $this->migrateFreshUsing());
+    }
+
     /**
      * Begin a database transaction on the testing database.
      *
@@ -89,7 +113,7 @@ public function beginDatabaseTransaction()
 
             $connection->setTransactionManager($transactionsManager);
 
-            if ($this->usingInMemoryDatabase()) {
+            if ($this->usingInMemoryDatabase($name)) {
                 RefreshDatabaseState::$inMemoryConnections[$name] ??= $connection->getPdo();
             }
 
@@ -121,7 +145,7 @@ public function beginDatabaseTransaction()
     protected function connectionsToTransact()
     {
         return property_exists($this, 'connectionsToTransact')
-                            ? $this->connectionsToTransact : [null];
+                            ? $this->connectionsToTransact : [config('database.default')];
     }
 
     /**