ConnectionTest.php
Same filename in this branch
Same filename in other branches
- 9 core/modules/sqlite/tests/src/Unit/ConnectionTest.php
- 9 core/modules/mysql/tests/src/Unit/ConnectionTest.php
- 9 core/modules/mysql/tests/src/Kernel/mysql/ConnectionTest.php
- 9 core/tests/Drupal/KernelTests/Core/Database/ConnectionTest.php
- 9 core/tests/Drupal/Tests/Core/Database/ConnectionTest.php
- 8.9.x core/tests/Drupal/KernelTests/Core/Database/ConnectionTest.php
- 8.9.x core/tests/Drupal/Tests/Core/Database/Driver/sqlite/ConnectionTest.php
- 8.9.x core/tests/Drupal/Tests/Core/Database/ConnectionTest.php
- 11.x core/modules/sqlite/tests/src/Unit/ConnectionTest.php
- 11.x core/modules/mysql/tests/src/Unit/ConnectionTest.php
- 11.x core/modules/mysql/tests/src/Kernel/mysql/ConnectionTest.php
- 11.x core/tests/Drupal/KernelTests/Core/Database/ConnectionTest.php
- 11.x core/tests/Drupal/Tests/Core/Database/ConnectionTest.php
Namespace
Drupal\KernelTests\Core\DatabaseFile
-
core/
tests/ Drupal/ KernelTests/ Core/ Database/ ConnectionTest.php
View source
<?php
declare (strict_types=1);
namespace Drupal\KernelTests\Core\Database;
use Drupal\Core\Database\Database;
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() : void {
// 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->assertNotSame($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() : void {
// 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() : void {
// 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->assertNotSame($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() : void {
$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->assertEquals($connection_info['default']['driver'], $connectionOptions['driver'], 'The default connection info driver matches the current connection options driver.');
$this->assertEquals($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');
$connectionOptions2 = $db2->getConnectionOptions();
// Get a fresh copy of the default connection options.
$connectionOptions = $db->getConnectionOptions();
$this->assertSame($connectionOptions2, $connectionOptions, '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->assertNotEquals($connection_info['default']['database'], $connectionOptions['database'], 'The test connection info database does not match the current connection options database.');
}
/**
* Tests per-table prefix connection option.
*/
public function testPerTablePrefixOption() : void {
$connection_info = Database::getConnectionInfo('default');
$new_connection_info = $connection_info['default'];
$new_connection_info['prefix'] = [
'default' => $connection_info['default']['prefix'],
'test_table' => $connection_info['default']['prefix'] . '_bar',
];
Database::addConnectionInfo('default', 'foo', $new_connection_info);
$this->expectException(\AssertionError::class);
$foo_connection = Database::getConnection('foo', 'default');
}
/**
* Tests the prefix connection option in array form.
*/
public function testPrefixArrayOption() : void {
$connection_info = Database::getConnectionInfo('default');
$new_connection_info = $connection_info['default'];
$new_connection_info['prefix'] = [
'default' => $connection_info['default']['prefix'],
];
Database::addConnectionInfo('default', 'foo', $new_connection_info);
$this->expectException(\AssertionError::class);
$foo_connection = Database::getConnection('foo', 'default');
}
/**
* Ensure that you cannot execute multiple statements in a query.
*/
public function testMultipleStatementsQuery() : void {
$this->expectException(\InvalidArgumentException::class);
Database::getConnection('default', 'default')->query('SELECT * FROM {test}; SELECT * FROM {test_people}');
}
/**
* Ensure that you cannot prepare multiple statements.
*/
public function testMultipleStatements() : void {
$this->expectException(\InvalidArgumentException::class);
Database::getConnection('default', 'default')->prepareStatement('SELECT * FROM {test}; SELECT * FROM {test_people}', []);
}
/**
* Tests that the method ::condition() returns a Condition object.
*/
public function testCondition() : void {
$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));
}
/**
* Tests deprecation of ::getUnprefixedTablesMap().
*
* @group legacy
*/
public function testDeprecatedGetUnprefixedTablesMap() : void {
$this->expectDeprecation('Drupal\\Core\\Database\\Connection::getUnprefixedTablesMap() is deprecated in drupal:10.0.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3257198');
$this->assertIsArray($this->connection
->getUnprefixedTablesMap());
}
/**
* Tests that the method ::hasJson() returns TRUE.
*/
public function testHasJson() : void {
$this->assertTrue($this->connection
->hasJson());
}
/**
* Tests deprecation of ::tablePrefix().
*
* @group legacy
*/
public function testDeprecatedTablePrefix() : void {
$this->expectDeprecation('Drupal\\Core\\Database\\Connection::tablePrefix() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Instead, you should just use Connection::getPrefix(). See https://www.drupal.org/node/3260849');
$this->assertIsString($this->connection
->tablePrefix());
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
ConnectionTest | Tests of the core database system. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.