class ConnectionTest in Drupal 9
Same name in this branch
- 9 core/tests/Drupal/Tests/Core/Database/ConnectionTest.php \Drupal\Tests\Core\Database\ConnectionTest
- 9 core/tests/Drupal/KernelTests/Core/Database/ConnectionTest.php \Drupal\KernelTests\Core\Database\ConnectionTest
- 9 core/tests/Drupal/Tests/Core/Database/Driver/sqlite/ConnectionTest.php \Drupal\Tests\Core\Database\Driver\sqlite\ConnectionTest
- 9 core/tests/Drupal/Tests/Core/Database/Driver/mysql/ConnectionTest.php \Drupal\Tests\Core\Database\Driver\mysql\ConnectionTest
Same name and namespace in other branches
- 8 core/tests/Drupal/KernelTests/Core/Database/ConnectionTest.php \Drupal\KernelTests\Core\Database\ConnectionTest
Tests of the core database system.
@group Database
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\KernelTests\Core\Database\DatabaseTestBase
- class \Drupal\KernelTests\Core\Database\ConnectionTest
- class \Drupal\KernelTests\Core\Database\DatabaseTestBase
Expanded class hierarchy of ConnectionTest
File
- core/
tests/ Drupal/ KernelTests/ Core/ Database/ ConnectionTest.php, line 16
Namespace
Drupal\KernelTests\Core\DatabaseView source
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
->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() {
// 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
->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() {
$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');
// 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
->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 the deprecation of the 'transactions' connection option.
*
* @group legacy
*/
public function testTransactionsOptionDeprecation() {
$this
->expectDeprecation('Passing a \'transactions\' connection option to Drupal\\Core\\Database\\Connection::__construct is deprecated in drupal:9.1.0 and is removed in drupal:10.0.0. All database drivers must support transactions. See https://www.drupal.org/node/2278745');
$this
->expectDeprecation('Drupal\\Core\\Database\\Connection::supportsTransactions is deprecated in drupal:9.1.0 and is removed in drupal:10.0.0. All database drivers must support transactions. See https://www.drupal.org/node/2278745');
$connection_info = Database::getConnectionInfo('default');
$connection_info['default']['transactions'] = FALSE;
Database::addConnectionInfo('default', 'foo', $connection_info['default']);
$foo_connection = Database::getConnection('foo', 'default');
$this
->assertInstanceOf(Connection::class, $foo_connection);
$this
->assertTrue($foo_connection
->supportsTransactions());
}
/**
* Tests the deprecation of passing a statement object to ::query.
*
* @group legacy
*/
public function testStatementQueryDeprecation() : void {
$this
->expectDeprecation('Passing a StatementInterface object as a $query argument to Drupal\\Core\\Database\\Connection::query is deprecated in drupal:9.2.0 and is removed in drupal:10.0.0. Call the execute method from the StatementInterface object directly instead. See https://www.drupal.org/node/3154439');
$db = Database::getConnection();
$stmt = $db
->prepareStatement('SELECT * FROM {test}', []);
$this
->assertNotNull($db
->query($stmt));
}
/**
* Tests the deprecation of passing a PDOStatement object to ::query.
*
* @group legacy
*/
public function testPDOStatementQueryDeprecation() : void {
$db = Database::getConnection();
$stmt = $db
->prepareStatement('SELECT * FROM {test}', []);
if (!$stmt instanceof StatementWrapper) {
$this
->markTestSkipped("This test only runs for db drivers using StatementWrapper.");
}
if (!$stmt
->getClientStatement() instanceof \PDOStatement) {
$this
->markTestSkipped("This test only runs for PDO-based db drivers.");
}
$this
->expectDeprecation('Passing a \\PDOStatement object as a $query argument to Drupal\\Core\\Database\\Connection::query is deprecated in drupal:9.2.0 and is removed in drupal:10.0.0. Call the execute method from the StatementInterface object directly instead. See https://www.drupal.org/node/3154439');
$this
->assertNotNull($db
->query($stmt
->getClientStatement()));
}
/**
* Tests per-table prefix connection option.
*/
public function testPerTablePrefixOption() {
$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);
$foo_connection = Database::getConnection('foo', 'default');
$this
->assertInstanceOf(Connection::class, $foo_connection);
$this
->assertIsString($foo_connection
->getConnectionOptions()['prefix']);
$this
->assertSame($connection_info['default']['prefix'], $foo_connection
->getConnectionOptions()['prefix']);
$this
->assertSame([
'test_table' => $connection_info['default']['prefix'] . '_bar',
], $foo_connection
->getConnectionOptions()['extra_prefix']);
}
/**
* Tests the prefix connection option in array form.
*/
public function testPrefixArrayOption() {
$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);
$foo_connection = Database::getConnection('foo', 'default');
$this
->assertInstanceOf(Connection::class, $foo_connection);
$this
->assertIsString($foo_connection
->getConnectionOptions()['prefix']);
$this
->assertSame($connection_info['default']['prefix'], $foo_connection
->getConnectionOptions()['prefix']);
$this
->assertArrayNotHasKey('extra_prefix', $foo_connection
->getConnectionOptions());
}
/**
* 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 in a query.
*/
public function testMultipleStatementsQuery() {
$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() {
$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() {
$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));
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ConnectionTest:: |
public | function | Tests that the method ::condition() returns a Condition object. | |
ConnectionTest:: |
public | function | Tests the closing of a database connection. | |
ConnectionTest:: |
public | function | Tests the connection options of the active database. | |
ConnectionTest:: |
public | function | Tests that connections return appropriate connection objects. | |
ConnectionTest:: |
public | function | Tests that connections return appropriate connection objects. | |
ConnectionTest:: |
public | function | Ensure that you cannot prepare multiple statements. | |
ConnectionTest:: |
public | function | Ensure that you cannot execute multiple statements on MySQL. | |
ConnectionTest:: |
public | function | Ensure that you cannot execute multiple statements in a query. | |
ConnectionTest:: |
public | function | Tests the deprecation of passing a PDOStatement object to ::query. | |
ConnectionTest:: |
public | function | Tests per-table prefix connection option. | |
ConnectionTest:: |
public | function | Tests the prefix connection option in array form. | |
ConnectionTest:: |
public | function | Tests the deprecation of passing a statement object to ::query. | |
ConnectionTest:: |
public | function | Tests the deprecation of the 'transactions' connection option. | |
DatabaseTestBase:: |
protected | property | The database connection for testing. | |
DatabaseTestBase:: |
protected static | property |
Modules to enable. Overrides KernelTestBase:: |
4 |
DatabaseTestBase:: |
public static | function | Sets up our sample data. | |
DatabaseTestBase:: |
public | function | Sets up tables for NULL handling. | |
DatabaseTestBase:: |
protected | function |
Overrides KernelTestBase:: |
3 |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
protected | property | Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 3 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
24 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 4 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. |