ConnectionTest.php

<?php

namespace Drupal\KernelTests\Core\Database;

use Drupal\Component\Render\FormattableMarkup;
use Drupal\Core\Database\Database;
use Drupal\Core\Database\DatabaseExceptionWrapper;
use Drupal\Core\Database\Query\Condition;

/**
 * Tests of the core database system.
 *
 * @group Database
 */
class ConnectionTest extends DatabaseTestBase {
    
    /**
     * Tests that connections return appropriate connection objects.
     */
    public function testConnectionRouting() {
        // Clone the primary credentials to a replica connection.
        // Note this will result in two independent connection objects that happen
        // to point to the same place.
        $connection_info = Database::getConnectionInfo('default');
        Database::addConnectionInfo('default', 'replica', $connection_info['default']);
        $db1 = Database::getConnection('default', 'default');
        $db2 = Database::getConnection('replica', 'default');
        $this->assertNotNull($db1, 'default connection is a real connection object.');
        $this->assertNotNull($db2, 'replica connection is a real connection object.');
        $this->assertNotIdentical($db1, $db2, 'Each target refers to a different connection.');
        // Try to open those targets another time, that should return the same objects.
        $db1b = Database::getConnection('default', 'default');
        $db2b = Database::getConnection('replica', 'default');
        $this->assertSame($db1, $db1b, 'A second call to getConnection() returns the same object.');
        $this->assertSame($db2, $db2b, 'A second call to getConnection() returns the same object.');
        // Try to open an unknown target.
        $unknown_target = $this->randomMachineName();
        $db3 = Database::getConnection($unknown_target, 'default');
        $this->assertNotNull($db3, 'Opening an unknown target returns a real connection object.');
        $this->assertSame($db1, $db3, 'An unknown target opens the default connection.');
        // Try to open that unknown target another time, that should return the same object.
        $db3b = Database::getConnection($unknown_target, 'default');
        $this->assertSame($db3, $db3b, 'A second call to getConnection() returns the same object.');
    }
    
    /**
     * Tests that connections return appropriate connection objects.
     */
    public function testConnectionRoutingOverride() {
        // Clone the primary credentials to a replica connection.
        // Note this will result in two independent connection objects that happen
        // to point to the same place.
        $connection_info = Database::getConnectionInfo('default');
        Database::addConnectionInfo('default', 'replica', $connection_info['default']);
        Database::ignoreTarget('default', 'replica');
        $db1 = Database::getConnection('default', 'default');
        $db2 = Database::getConnection('replica', 'default');
        $this->assertSame($db1, $db2, 'Both targets refer to the same connection.');
    }
    
    /**
     * Tests the closing of a database connection.
     */
    public function testConnectionClosing() {
        // Open the default target so we have an object to compare.
        $db1 = Database::getConnection('default', 'default');
        // Try to close the default connection, then open a new one.
        Database::closeConnection('default', 'default');
        $db2 = Database::getConnection('default', 'default');
        // Opening a connection after closing it should yield an object different than the original.
        $this->assertNotIdentical($db1, $db2, 'Opening the default connection after it is closed returns a new object.');
    }
    
    /**
     * Tests the connection options of the active database.
     */
    public function testConnectionOptions() {
        $connection_info = Database::getConnectionInfo('default');
        // Be sure we're connected to the default database.
        $db = Database::getConnection('default', 'default');
        $connectionOptions = $db->getConnectionOptions();
        // In the MySQL driver, the port can be different, so check individual
        // options.
        $this->assertEqual($connection_info['default']['driver'], $connectionOptions['driver'], 'The default connection info driver matches the current connection options driver.');
        $this->assertEqual($connection_info['default']['database'], $connectionOptions['database'], 'The default connection info database matches the current connection options database.');
        // Set up identical replica and confirm connection options are identical.
        Database::addConnectionInfo('default', 'replica', $connection_info['default']);
        $db2 = Database::getConnection('replica', 'default');
        // Getting a driver class ensures the namespace option is set.
        $this->assertEquals($db->getDriverClass('select'), $db2->getDriverClass('select'));
        $connectionOptions2 = $db2->getConnectionOptions();
        // Get a fresh copy of the default connection options.
        $connectionOptions = $db->getConnectionOptions();
        $this->assertIdentical($connectionOptions, $connectionOptions2, 'The default and replica connection options are identical.');
        // Set up a new connection with different connection info.
        $test = $connection_info['default'];
        $test['database'] .= 'test';
        Database::addConnectionInfo('test', 'default', $test);
        $connection_info = Database::getConnectionInfo('test');
        // Get a fresh copy of the default connection options.
        $connectionOptions = $db->getConnectionOptions();
        $this->assertNotEqual($connection_info['default']['database'], $connectionOptions['database'], 'The test connection info database does not match the current connection options database.');
    }
    
    /**
     * Ensure that you cannot execute multiple statements on MySQL.
     */
    public function testMultipleStatementsForNewPhp() {
        // This just tests mysql, as other PDO integrations don't allow disabling
        // multiple statements.
        if (Database::getConnection()->databaseType() !== 'mysql') {
            $this->markTestSkipped("This test only runs for MySQL");
        }
        // Disable the protection at the PHP level.
        $this->expectException(DatabaseExceptionWrapper::class);
        Database::getConnection('default', 'default')->query('SELECT * FROM {test}; SELECT * FROM {test_people}', [], [
            'allow_delimiter_in_query' => TRUE,
        ]);
    }
    
    /**
     * Ensure that you cannot execute multiple statements.
     */
    public function testMultipleStatements() {
        $this->expectException(\InvalidArgumentException::class);
        Database::getConnection('default', 'default')->query('SELECT * FROM {test}; SELECT * FROM {test_people}');
    }
    
    /**
     * Test the escapeTable(), escapeField() and escapeAlias() methods with all possible reserved words in PostgreSQL.
     */
    public function testPostgresqlReservedWords() {
        if (Database::getConnection()->databaseType() !== 'pgsql') {
            $this->markTestSkipped("This test only runs for PostgreSQL");
        }
        $db = Database::getConnection('default', 'default');
        $stmt = $db->query("SELECT word FROM pg_get_keywords() WHERE catcode IN ('R', 'T')");
        $stmt->execute();
        foreach ($stmt->fetchAllAssoc('word') as $word => $row) {
            $expected = '"' . $word . '"';
            $this->assertIdentical($db->escapeTable($word), $expected, new FormattableMarkup('The reserved word %word was correctly escaped when used as a table name.', [
                '%word' => $word,
            ]));
            $this->assertIdentical($db->escapeField($word), $expected, new FormattableMarkup('The reserved word %word was correctly escaped when used as a column name.', [
                '%word' => $word,
            ]));
            $this->assertIdentical($db->escapeAlias($word), $expected, new FormattableMarkup('The reserved word %word was correctly escaped when used as an alias.', [
                '%word' => $word,
            ]));
        }
    }
    
    /**
     * Test that the method ::condition() returns a Condition object.
     */
    public function testCondition() {
        $connection = Database::getConnection('default', 'default');
        $namespace = (new \ReflectionObject($connection))->getNamespaceName() . "\\Condition";
        if (!class_exists($namespace)) {
            $namespace = Condition::class;
        }
        $condition = $connection->condition('AND');
        $this->assertSame($namespace, get_class($condition));
    }

}