Modernized MySQL class to allow changing the "current" database connection

- Created a new MySQL::setConnection method
- Basic test for it
- Tests now run MySQL::setConnection('tests-mysql'); during the PHPUnit bootstrap instead of overriding `MySQL::$defaultProductionLabel`.

Author: hparadiz

src/IO/Database/MySQL.php

@@ -9,8 +9,9 @@
  */
 namespace Divergence\IO\Database;
 
-use \PDO as PDO;
-use \Divergence\App as App;
+use PDO as PDO;
+use Exception;
+use Divergence\App as App;
 
 /**
  * MySQL.
@@ -56,6 +57,13 @@ class MySQL
      */
     public static $defaultDevLabel = 'dev-mysql';
 
+    /**
+     * Current connection label
+     *
+     * @var string|null $currentConnection
+     */
+    public static $currentConnection = null;
+
     /**
      * Internal reference list of connections
      *
@@ -84,6 +92,28 @@ class MySQL
      */
     protected static $Config;
 
+
+    /**
+     * Sets the connection that should be returned by getConnection when $label is null
+     *
+     * @param string $label
+     * @return void
+     */
+    public static function setConnection(string $label=null)
+    {
+        if ($label === null && static::$currentConnection === null) {
+            static::$currentConnection = static::getDefaultLabel();
+            return;
+        }
+
+        $config = static::config();
+        if (isset($config[$label])) {
+            static::$currentConnection = $label;
+        } else {
+            throw new Exception('The provided label does not exist in the config.');
+        }
+    }
+
     /**
      * Attempts to make, store, and return a PDO connection.
      * - By default will use the label provided by static::getDefaultLabel()
@@ -95,7 +125,7 @@ class MySQL
      * @param string|null $label A specific connection.
      * @return PDO A PDO connection
      *
-     * @throws \Exception
+     * @throws Exception
      *
      * @uses static::$Connections
      * @uses static::getDefaultLabel()
@@ -104,8 +134,11 @@ class MySQL
      */
     public static function getConnection($label=null)
     {
-        if (!$label) {
-            $label = static::getDefaultLabel();
+        if ($label === null) {
+            if (static::$currentConnection === null) {
+                static::setConnection();
+            }
+            $label = static::$currentConnection;
         }
 
         if (!isset(static::$Connections[$label])) {
@@ -128,7 +161,7 @@ public static function getConnection($label=null)
                 // try to initiate connection
                 static::$Connections[$label] = new PDO($DSN, $config['username'], $config['password']);
             } catch (\PDOException $e) {
-                throw new \Exception('PDO failed to connect on config "'.$label.'" '.$DSN);
+                throw new Exception('PDO failed to connect on config "'.$label.'" '.$DSN);
             }
 
             // set timezone

tests/Divergence/IO/Database/MySQLTest.php

@@ -78,6 +78,17 @@ public function testGetConnection()
         $this->assertInstanceOf(\PDO::class, DB::getConnection('mysql'));
     }
 
+    /**
+     * @covers Divergence\IO\Database\MySQL::setConnection
+     */
+    public function testSetConnection()
+    {
+        TestUtils::requireDB($this);
+        DB::setConnection('tests-mysql-socket');
+        $this->assertEquals('tests-mysql-socket',DB::$currentConnection);
+        DB::setConnection('tests-mysql');
+    }
+
     /**
      * @covers Divergence\IO\Database\MySQL::escape
      *
@@ -96,7 +107,7 @@ public function testEscape()
 
         $littleBobbyTables = 'Robert\'); DROP TABLE Students;--';
         $safeLittleBobbyTables = $z($littleBobbyTables);
-        
+
         $arrayOfBobbies = [
             'lorum ipsum',
             $littleBobbyTables,
@@ -107,7 +118,7 @@ public function testEscape()
         foreach ($arrayOfBobbies as $oneBob) {
             $safeArrayOfBobbies[] = $z($oneBob);
         }
-        
+
         $this->assertEquals($safeLittleBobbyTables, DB::escape($littleBobbyTables));
         $this->assertEquals($safeArrayOfBobbies, DB::escape($arrayOfBobbies));
         $this->assertEquals(new \stdClass(), DB::escape(new \stdClass()));
@@ -126,7 +137,7 @@ public function testAffectedRows()
 
         $this->assertEquals(2, DB::affectedRows());
     }
-    
+
     /**
      * @covers Divergence\IO\Database\MySQL::foundRows
      * @covers Divergence\IO\Database\MySQL::oneValue
@@ -139,7 +150,7 @@ public function testFoundRows()
         $tags = DB::allRecords('select SQL_CALC_FOUND_ROWS * from `tags` LIMIT 1;');
         $foundRows = DB::oneValue('SELECT FOUND_ROWS()');
         $tagsCount = DB::oneValue('SELECT COUNT(*) as `Count` FROM `tags`');
-        
+
         $this->assertEquals($tagsCount, $foundRows);
         $this->assertCount(1, $tags);
 
@@ -149,7 +160,7 @@ public function testFoundRows()
         // valid query. no records found
         $this->assertFalse(DB::oneValue('SELECT * FROM `tags` WHERE 1=0'));
     }
-    
+
     /**
     * @covers Divergence\IO\Database\MySQL::insertID
     * @covers Divergence\IO\Database\MySQL::oneRecord
@@ -335,7 +346,7 @@ public function testNonQueryExceptionDevException()
     public function testNonQueryHandledException()
     {
         TestUtils::requireDB($this);
-        
+
         $Context = $this;
         // another bad query but this time we handle the problem
         DB::nonQuery('UPDATE `%s` SET fake`=%d WHERE `ID`=%d', [
@@ -366,7 +377,7 @@ public function testAllRecords()
         TestUtils::requireDB($this);
 
         $tables = DB::allRecords('SHOW TABLES');
-        
+
         $this->assertCount(9, $tables);
         foreach ($tables as $table) {
             $this->assertNotEmpty($table['Tables_in_test']);
@@ -409,7 +420,7 @@ public function testClearCachedRecord()
             'Tag',
             'Linux',
         ];
-        
+
         $key = sprintf('%s/%s:%s', Tag::$tableName, 'Tag', 'Linux');
         $record = testableDB::oneRecordCached($key, $query, $params);
         $cache = testableDB::getProtected('_record_cache');
@@ -418,7 +429,7 @@ public function testClearCachedRecord()
         $cache = testableDB::getProtected('_record_cache');
         $this->assertNull($cache[$key]);
     }
-    
+
     /**
      * @covers Divergence\IO\Database\MySQL::oneRecordCached
      *
@@ -433,7 +444,7 @@ public function testOneRecordCached()
             'Tag',
             'Linux',
         ];
-        
+
         $key = sprintf('%s/%s:%s', Tag::$tableName, 'Tag', 'Linux');
         $record = testableDB::oneRecordCached($key, $query, $params);
         $cache = testableDB::getProtected('_record_cache');
@@ -504,7 +515,7 @@ public function testFinishQueryLog()
         $result->num_rows = 5;
 
         testableDB::_finishQueryLog($x, $result);
-        
+
         $expected_time_duration_ms = ($x['time_finish'] - $x['time_start']) * 1000;
 
         $this->assertEquals('SELECT corgies', $x['query']);
@@ -539,7 +550,7 @@ public function testConfig()
     public function testGetDefaultLabel()
     {
         TestUtils::requireDB($this);
-        
+
         $this->assertEquals(testableDB::$defaultProductionLabel, testableDB::_getDefaultLabel());
         App::$Config['environment'] = 'dev';
         $this->assertEquals(testableDB::$defaultDevLabel, testableDB::_getDefaultLabel());

tests/Divergence/TestListener.php

@@ -24,7 +24,7 @@ public function addWarning(Test $test, \PHPUnit\Framework\Warning $e, float $tim
     {
         //printf("Warning while running test '%s'.\n", $test->getName());
     }
-    
+
 
     public function addFailure(Test $test, \PHPUnit\Framework\AssertionFailedError $e, float $time): void
     {
@@ -60,8 +60,8 @@ public function startTestSuite(TestSuite $suite): void
     {
         //printf("TestSuite '%s' started.\n", $suite->getName());
         if ($suite->getName() == 'all') {
-            MySQL::$defaultProductionLabel = 'tests-mysql';
             App::init(__DIR__.'/../../');
+            MySQL::setConnection('tests-mysql');
             App::setUp();
             fwrite(STDERR, 'Starting Divergence Mock Environment for PHPUnit'."\n");
         }