class ConnectionTest

Same name in this branch
  1. 8.9.x core/tests/Drupal/Tests/Core/Database/Driver/sqlite/ConnectionTest.php \Drupal\Tests\Core\Database\Driver\sqlite\ConnectionTest
  2. 8.9.x core/tests/Drupal/Tests/Core/Database/ConnectionTest.php \Drupal\Tests\Core\Database\ConnectionTest
Same name in other branches
  1. 9 core/modules/sqlite/tests/src/Unit/ConnectionTest.php \Drupal\Tests\sqlite\Unit\ConnectionTest
  2. 9 core/modules/mysql/tests/src/Unit/ConnectionTest.php \Drupal\Tests\mysql\Unit\ConnectionTest
  3. 9 core/modules/mysql/tests/src/Kernel/mysql/ConnectionTest.php \Drupal\Tests\mysql\Kernel\mysql\ConnectionTest
  4. 9 core/tests/Drupal/KernelTests/Core/Database/ConnectionTest.php \Drupal\KernelTests\Core\Database\ConnectionTest
  5. 9 core/tests/Drupal/Tests/Core/Database/ConnectionTest.php \Drupal\Tests\Core\Database\ConnectionTest
  6. 10 core/modules/sqlite/tests/src/Unit/ConnectionTest.php \Drupal\Tests\sqlite\Unit\ConnectionTest
  7. 10 core/modules/sqlite/tests/src/Kernel/sqlite/ConnectionTest.php \Drupal\Tests\sqlite\Kernel\sqlite\ConnectionTest
  8. 10 core/modules/mysql/tests/src/Unit/ConnectionTest.php \Drupal\Tests\mysql\Unit\ConnectionTest
  9. 10 core/modules/mysql/tests/src/Kernel/mysql/ConnectionTest.php \Drupal\Tests\mysql\Kernel\mysql\ConnectionTest
  10. 10 core/tests/Drupal/KernelTests/Core/Database/ConnectionTest.php \Drupal\KernelTests\Core\Database\ConnectionTest
  11. 10 core/tests/Drupal/Tests/Core/Database/ConnectionTest.php \Drupal\Tests\Core\Database\ConnectionTest
  12. 11.x core/modules/sqlite/tests/src/Unit/ConnectionTest.php \Drupal\Tests\sqlite\Unit\ConnectionTest
  13. 11.x core/modules/mysql/tests/src/Unit/ConnectionTest.php \Drupal\Tests\mysql\Unit\ConnectionTest
  14. 11.x core/modules/mysql/tests/src/Kernel/mysql/ConnectionTest.php \Drupal\Tests\mysql\Kernel\mysql\ConnectionTest
  15. 11.x core/tests/Drupal/KernelTests/Core/Database/ConnectionTest.php \Drupal\KernelTests\Core\Database\ConnectionTest
  16. 11.x core/tests/Drupal/Tests/Core/Database/ConnectionTest.php \Drupal\Tests\Core\Database\ConnectionTest

Tests of the core database system.

@group Database

Hierarchy

Expanded class hierarchy of ConnectionTest

File

core/tests/Drupal/KernelTests/Core/Database/ConnectionTest.php, line 15

Namespace

Drupal\KernelTests\Core\Database
View 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->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));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail
otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ConnectionTest::testCondition public function Test that the method ::condition() returns a Condition object.
ConnectionTest::testConnectionClosing public function Tests the closing of a database connection.
ConnectionTest::testConnectionOptions public function Tests the connection options of the active database.
ConnectionTest::testConnectionRouting public function Tests that connections return appropriate connection objects.
ConnectionTest::testConnectionRoutingOverride public function Tests that connections return appropriate connection objects.
ConnectionTest::testMultipleStatements public function Ensure that you cannot execute multiple statements.
ConnectionTest::testMultipleStatementsForNewPhp public function Ensure that you cannot execute multiple statements on MySQL.
ConnectionTest::testPostgresqlReservedWords public function Test the escapeTable(), escapeField() and escapeAlias() methods with all possible reserved words in PostgreSQL.
DatabaseTestBase::$connection protected property The database connection for testing.
DatabaseTestBase::$modules public static property Modules to enable. Overrides KernelTestBase::$modules 4
DatabaseTestBase::addSampleData public static function Sets up our sample data.
DatabaseTestBase::ensureSampleDataNull public function Sets up tables for NULL handling.
DatabaseTestBase::setUp protected function Overrides KernelTestBase::setUp 1
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess 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::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.