class DatabaseTestBase

Same name in this branch
  1. 8.9.x core/modules/system/tests/src/Functional/Database/DatabaseTestBase.php \Drupal\Tests\system\Functional\Database\DatabaseTestBase
Same name in other branches
  1. 9 core/modules/system/tests/src/Functional/Database/DatabaseTestBase.php \Drupal\Tests\system\Functional\Database\DatabaseTestBase
  2. 9 core/tests/Drupal/KernelTests/Core/Database/DatabaseTestBase.php \Drupal\KernelTests\Core\Database\DatabaseTestBase
  3. 10 core/modules/system/tests/src/Functional/Database/DatabaseTestBase.php \Drupal\Tests\system\Functional\Database\DatabaseTestBase
  4. 10 core/tests/Drupal/KernelTests/Core/Database/DatabaseTestBase.php \Drupal\KernelTests\Core\Database\DatabaseTestBase
  5. 11.x core/modules/system/tests/src/Functional/Database/DatabaseTestBase.php \Drupal\Tests\system\Functional\Database\DatabaseTestBase
  6. 11.x core/tests/Drupal/KernelTests/Core/Database/DatabaseTestBase.php \Drupal\KernelTests\Core\Database\DatabaseTestBase

Base class for databases database tests.

Because all database tests share the same test data, we can centralize that here.

Hierarchy

Expanded class hierarchy of DatabaseTestBase

2 files declare their use of DatabaseTestBase
DatabaseTestBase.php in core/modules/system/tests/src/Functional/Database/DatabaseTestBase.php
DatabaseWebTestBase.php in core/modules/system/src/Tests/Database/DatabaseWebTestBase.php

File

core/tests/Drupal/KernelTests/Core/Database/DatabaseTestBase.php, line 14

Namespace

Drupal\KernelTests\Core\Database
View source
abstract class DatabaseTestBase extends KernelTestBase {
    public static $modules = [
        'database_test',
    ];
    
    /**
     * The database connection for testing.
     *
     * @var \Drupal\Core\Database\Connection
     */
    protected $connection;
    protected function setUp() {
        parent::setUp();
        $this->connection = Database::getConnection();
        $this->installSchema('database_test', [
            'test',
            'test_classtype',
            'test_people',
            'test_people_copy',
            'test_one_blob',
            'test_two_blobs',
            'test_task',
            'test_null',
            'test_serialized',
            'test_special_columns',
            'TEST_UPPERCASE',
            'virtual',
        ]);
        self::addSampleData();
    }
    
    /**
     * Sets up tables for NULL handling.
     */
    public function ensureSampleDataNull() {
        $this->connection
            ->insert('test_null')
            ->fields([
            'name',
            'age',
        ])
            ->values([
            'name' => 'Kermit',
            'age' => 25,
        ])
            ->values([
            'name' => 'Fozzie',
            'age' => NULL,
        ])
            ->values([
            'name' => 'Gonzo',
            'age' => 27,
        ])
            ->execute();
    }
    
    /**
     * Sets up our sample data.
     */
    public static function addSampleData() {
        $connection = Database::getConnection();
        // We need the IDs, so we can't use a multi-insert here.
        $john = $connection->insert('test')
            ->fields([
            'name' => 'John',
            'age' => 25,
            'job' => 'Singer',
        ])
            ->execute();
        $george = $connection->insert('test')
            ->fields([
            'name' => 'George',
            'age' => 27,
            'job' => 'Singer',
        ])
            ->execute();
        $connection->insert('test')
            ->fields([
            'name' => 'Ringo',
            'age' => 28,
            'job' => 'Drummer',
        ])
            ->execute();
        $paul = $connection->insert('test')
            ->fields([
            'name' => 'Paul',
            'age' => 26,
            'job' => 'Songwriter',
        ])
            ->execute();
        $connection->insert('test_classtype')
            ->fields([
            'classname' => 'Drupal\\Tests\\system\\Functional\\Database\\FakeRecord',
            'name' => 'Kay',
            'age' => 26,
            'job' => 'Web Developer',
        ])
            ->execute();
        $connection->insert('test_people')
            ->fields([
            'name' => 'Meredith',
            'age' => 30,
            'job' => 'Speaker',
        ])
            ->execute();
        $connection->insert('test_task')
            ->fields([
            'pid',
            'task',
            'priority',
        ])
            ->values([
            'pid' => $john,
            'task' => 'eat',
            'priority' => 3,
        ])
            ->values([
            'pid' => $john,
            'task' => 'sleep',
            'priority' => 4,
        ])
            ->values([
            'pid' => $john,
            'task' => 'code',
            'priority' => 1,
        ])
            ->values([
            'pid' => $george,
            'task' => 'sing',
            'priority' => 2,
        ])
            ->values([
            'pid' => $george,
            'task' => 'sleep',
            'priority' => 2,
        ])
            ->values([
            'pid' => $paul,
            'task' => 'found new band',
            'priority' => 1,
        ])
            ->values([
            'pid' => $paul,
            'task' => 'perform at superbowl',
            'priority' => 3,
        ])
            ->execute();
        $connection->insert('test_special_columns')
            ->fields([
            'id' => 1,
            'offset' => 'Offset value 1',
            'function' => 'Function value 1',
        ])
            ->execute();
        $connection->insert('virtual')
            ->fields([
            'id' => 1,
            'function' => 'Function value 1',
        ])
            ->execute();
    }

}

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.
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.