class DbDumpTest

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Command/DbDumpTest.php \Drupal\KernelTests\Core\Command\DbDumpTest
  2. 8.9.x core/tests/Drupal/KernelTests/Core/Command/DbDumpTest.php \Drupal\KernelTests\Core\Command\DbDumpTest
  3. 11.x core/modules/mysql/tests/src/Kernel/mysql/DbDumpTest.php \Drupal\Tests\mysql\Kernel\mysql\DbDumpTest

Tests for the database dump commands.

@group Update

Hierarchy

Expanded class hierarchy of DbDumpTest

File

core/modules/mysql/tests/src/Kernel/mysql/DbDumpTest.php, line 23

Namespace

Drupal\Tests\mysql\Kernel\mysql
View source
class DbDumpTest extends DriverSpecificKernelTestBase {
    use PathAliasTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        // @todo system can be removed from this test once
        //   https://www.drupal.org/project/drupal/issues/2851705 is committed.
'system',
        'config',
        'dblog',
        'menu_link_content',
        'link',
        'block_content',
        'file',
        'path_alias',
        'user',
    ];
    
    /**
     * Test data to write into config.
     *
     * @var array
     */
    protected $data;
    
    /**
     * An array of original table schemas.
     *
     * @var array
     */
    protected $originalTableSchemas = [];
    
    /**
     * An array of original table indexes (including primary and unique keys).
     *
     * @var array
     */
    protected $originalTableIndexes = [];
    
    /**
     * Tables that should be part of the exported script.
     *
     * @var array
     */
    protected $tables;
    
    /**
     * {@inheritdoc}
     *
     * Register a database cache backend rather than memory-based.
     */
    public function register(ContainerBuilder $container) {
        parent::register($container);
        $container->register('cache_factory', 'Drupal\\Core\\Cache\\DatabaseBackendFactory')
            ->addArgument(new Reference('database'))
            ->addArgument(new Reference('cache_tags.invalidator.checksum'))
            ->addArgument(new Reference('settings'))
            ->addArgument(new Reference('serialization.phpserialize'))
            ->addArgument(new Reference(TimeInterface::class));
    }
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create some schemas so our export contains tables.
        $this->installSchema('dblog', [
            'watchdog',
        ]);
        $this->installEntitySchema('block_content');
        $this->installEntitySchema('user');
        $this->installEntitySchema('file');
        $this->installEntitySchema('menu_link_content');
        $this->installEntitySchema('path_alias');
        // Place some sample config to test for in the export.
        $this->data = [
            'foo' => $this->randomMachineName(),
            'bar' => $this->randomMachineName(),
        ];
        $storage = new DatabaseStorage(Database::getConnection(), 'config');
        $storage->write('test_config', $this->data);
        // Create user account with some potential syntax issues.
        // cspell:disable-next-line
        $account = User::create([
            'mail' => 'q\'uote$dollar@example.com',
            'name' => '$dollar',
        ]);
        $account->save();
        // Create a path alias.
        $this->createPathAlias('/user/' . $account->id(), '/user/example');
        // Create a cache table (this will create 'cache_discovery').
        \Drupal::cache('discovery')->set('test', $this->data);
        // These are all the tables that should now be in place.
        $this->tables = [
            'block_content',
            'block_content_field_data',
            'block_content_field_revision',
            'block_content_revision',
            'cachetags',
            'config',
            'cache_bootstrap',
            'cache_config',
            'cache_discovery',
            'cache_entity',
            'file_managed',
            'menu_link_content',
            'menu_link_content_data',
            'menu_link_content_revision',
            'menu_link_content_field_revision',
            'path_alias',
            'path_alias_revision',
            'user__roles',
            'users',
            'users_field_data',
            'watchdog',
        ];
    }
    
    /**
     * Tests the command directly.
     */
    public function testDbDumpCommand() : void {
        $application = new DbDumpApplication();
        $command = $application->find('dump-database-d8-mysql');
        $command_tester = new CommandTester($command);
        $command_tester->execute([]);
        // Tables that are schema-only should not have data exported.
        $pattern = preg_quote("\$connection->insert('sessions')");
        $this->assertDoesNotMatchRegularExpression('/' . $pattern . '/', $command_tester->getDisplay(), 'Tables defined as schema-only do not have data exported to the script.');
        // Table data is exported.
        $pattern = preg_quote("\$connection->insert('config')");
        $this->assertMatchesRegularExpression('/' . $pattern . '/', $command_tester->getDisplay(), 'Table data is properly exported to the script.');
        // The test data are in the dump (serialized).
        $pattern = preg_quote(serialize($this->data));
        $this->assertMatchesRegularExpression('/' . $pattern . '/', $command_tester->getDisplay(), 'Generated data is found in the exported script.');
        // Check that the user account name and email address was properly escaped.
        // cspell:disable-next-line
        $pattern = preg_quote('"q\'uote\\$dollar@example.com"');
        $this->assertMatchesRegularExpression('/' . $pattern . '/', $command_tester->getDisplay(), 'The user account email address was properly escaped in the exported script.');
        $pattern = preg_quote('\'$dollar\'');
        $this->assertMatchesRegularExpression('/' . $pattern . '/', $command_tester->getDisplay(), 'The user account name was properly escaped in the exported script.');
    }
    
    /**
     * Tests loading the script back into the database.
     */
    public function testScriptLoad() : void {
        // Generate the script.
        $application = new DbDumpApplication();
        $command = $application->find('dump-database-d8-mysql');
        $command_tester = new CommandTester($command);
        $command_tester->execute([]);
        $script = $command_tester->getDisplay();
        // Store original schemas and drop tables to avoid errors.
        $connection = Database::getConnection();
        $schema = $connection->schema();
        foreach ($this->tables as $table) {
            $this->originalTableSchemas[$table] = $this->getTableSchema($table);
            $this->originalTableIndexes[$table] = $this->getTableIndexes($table);
            $schema->dropTable($table);
        }
        // This will load the data.
        $file = sys_get_temp_dir() . '/' . $this->randomMachineName();
        file_put_contents($file, $script);
        require_once $file;
        // The tables should now exist and the schemas should match the originals.
        foreach ($this->tables as $table) {
            $this->assertTrue($schema->tableExists($table), "Table {$table} created by the database script.");
            $this->assertSame($this->originalTableSchemas[$table], $this->getTableSchema($table), "The schema for {$table} was properly restored.");
            $this->assertSame($this->originalTableIndexes[$table], $this->getTableIndexes($table), "The indexes for {$table} were properly restored.");
        }
        // Ensure the test config has been replaced.
        $config = unserialize($connection->select('config', 'c')
            ->fields('c', [
            'data',
        ])
            ->condition('name', 'test_config')
            ->execute()
            ->fetchField());
        $this->assertSame($this->data, $config, 'Script has properly restored the config table data.');
        // Ensure the cache data was not exported.
        $this->assertFalse(\Drupal::cache('discovery')->get('test'), 'Cache data was not exported to the script.');
    }
    
    /**
     * Helper function to get a simplified schema for a given table.
     *
     * @param string $table
     *   The table name.
     *
     * @return array
     *   Array keyed by field name, with the values being the field type.
     */
    protected function getTableSchema($table) {
        // Verify the field type on the data column in the cache table.
        // @todo this is MySQL specific.
        $query = Database::getConnection()->query("SHOW COLUMNS FROM {" . $table . "}");
        $definition = [];
        while ($row = $query->fetchAssoc()) {
            $definition[$row['Field']] = $row['Type'];
        }
        return $definition;
    }
    
    /**
     * Returns indexes for a given table.
     *
     * @param string $table
     *   The table to find indexes for.
     *
     * @return array
     *   The 'primary key', 'unique keys', and 'indexes' portion of the Drupal
     *   table schema.
     */
    protected function getTableIndexes($table) {
        $query = Database::getConnection()->query("SHOW INDEX FROM {" . $table . "}");
        $definition = [];
        while ($row = $query->fetchAssoc()) {
            $index_name = $row['Key_name'];
            $column = $row['Column_name'];
            // Key the arrays by the index sequence for proper ordering (start at 0).
            $order = $row['Seq_in_index'] - 1;
            // If specified, add length to the index.
            if ($row['Sub_part']) {
                $column = [
                    $column,
                    $row['Sub_part'],
                ];
            }
            if ($index_name === 'PRIMARY') {
                $definition['primary key'][$order] = $column;
            }
            elseif ($row['Non_unique'] == 0) {
                $definition['unique keys'][$index_name][$order] = $column;
            }
            else {
                $definition['indexes'][$index_name][$order] = $column;
            }
        }
        return $definition;
    }

}

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 raw text IS NOT found escaped on 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::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.
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.
DbDumpTest::$data protected property Test data to write into config.
DbDumpTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
DbDumpTest::$originalTableIndexes protected property An array of original table indexes (including primary and unique keys).
DbDumpTest::$originalTableSchemas protected property An array of original table schemas.
DbDumpTest::$tables protected property Tables that should be part of the exported script.
DbDumpTest::getTableIndexes protected function Returns indexes for a given table.
DbDumpTest::getTableSchema protected function Helper function to get a simplified schema for a given table.
DbDumpTest::register public function Register a database cache backend rather than memory-based. Overrides KernelTestBase::register
DbDumpTest::setUp protected function Overrides DriverSpecificKernelTestBase::setUp
DbDumpTest::testDbDumpCommand public function Tests the command directly.
DbDumpTest::testScriptLoad public function Tests loading the script back into the database.
DriverSpecificKernelTestBase::$connection protected property The database connection for testing. 1
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
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. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
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 protected function Bootstraps a kernel for a test. 1
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. 1
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. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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::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 Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
PathAliasTestTrait::assertPathAliasExists protected function Asserts that a path alias exists in the storage.
PathAliasTestTrait::assertPathAliasNotExists protected function Asserts that a path alias does not exist in the storage.
PathAliasTestTrait::createPathAlias protected function Creates a new path alias.
PathAliasTestTrait::loadPathAliasByConditions protected function Gets the first result from a 'load by properties' storage call.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
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 Deprecated 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 Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
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.