class SqlBaseTest

Same name in this branch
  1. 10 core/modules/views/tests/src/Unit/Plugin/pager/SqlBaseTest.php \Drupal\Tests\views\Unit\Plugin\pager\SqlBaseTest
  2. 10 core/modules/migrate/tests/src/Unit/SqlBaseTest.php \Drupal\Tests\migrate\Unit\SqlBaseTest
Same name in other branches
  1. 9 core/modules/views/tests/src/Unit/Plugin/pager/SqlBaseTest.php \Drupal\Tests\views\Unit\Plugin\pager\SqlBaseTest
  2. 9 core/modules/migrate/tests/src/Unit/SqlBaseTest.php \Drupal\Tests\migrate\Unit\SqlBaseTest
  3. 9 core/modules/migrate/tests/src/Kernel/SqlBaseTest.php \Drupal\Tests\migrate\Kernel\SqlBaseTest
  4. 8.9.x core/modules/migrate/tests/src/Unit/SqlBaseTest.php \Drupal\Tests\migrate\Unit\SqlBaseTest
  5. 8.9.x core/modules/migrate/tests/src/Kernel/SqlBaseTest.php \Drupal\Tests\migrate\Kernel\SqlBaseTest
  6. 11.x core/modules/views/tests/src/Unit/Plugin/pager/SqlBaseTest.php \Drupal\Tests\views\Unit\Plugin\pager\SqlBaseTest
  7. 11.x core/modules/migrate/tests/src/Unit/SqlBaseTest.php \Drupal\Tests\migrate\Unit\SqlBaseTest
  8. 11.x core/modules/migrate/tests/src/Kernel/SqlBaseTest.php \Drupal\Tests\migrate\Kernel\SqlBaseTest

Tests the functionality of SqlBase.

@group migrate

Hierarchy

Expanded class hierarchy of SqlBaseTest

File

core/modules/migrate/tests/src/Kernel/SqlBaseTest.php, line 20

Namespace

Drupal\Tests\migrate\Kernel
View source
class SqlBaseTest extends MigrateTestBase {
    
    /**
     * The (probably mocked) migration under test.
     *
     * @var \Drupal\migrate\Plugin\MigrationInterface
     */
    protected $migration;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->migration = $this->createMock(MigrationInterface::class);
        $this->migration
            ->method('id')
            ->willReturn('foo');
    }
    
    /**
     * Tests different connection types.
     */
    public function testConnectionTypes() : void {
        $sql_base = new TestSqlBase([], $this->migration);
        // Verify that falling back to the default 'migrate' connection (defined in
        // the base class) works.
        $this->assertSame('default', $sql_base->getDatabase()
            ->getTarget());
        $this->assertSame('migrate', $sql_base->getDatabase()
            ->getKey());
        // Verify the fallback state key overrides the 'migrate' connection.
        $target = 'test_fallback_target';
        $key = 'test_fallback_key';
        $config = [
            'target' => $target,
            'key' => $key,
        ];
        $database_state_key = 'test_fallback_state';
        \Drupal::state()->set($database_state_key, $config);
        \Drupal::state()->set('migrate.fallback_state_key', $database_state_key);
        // Create a test connection using the default database configuration.
        Database::addConnectionInfo($key, $target, Database::getConnectionInfo('default')['default']);
        $this->assertSame($sql_base->getDatabase()
            ->getTarget(), $target);
        $this->assertSame($sql_base->getDatabase()
            ->getKey(), $key);
        // Verify that setting explicit connection information overrides fallbacks.
        $target = 'test_db_target';
        $key = 'test_migrate_connection';
        $config = [
            'target' => $target,
            'key' => $key,
        ];
        $sql_base->setConfiguration($config);
        Database::addConnectionInfo($key, $target, Database::getConnectionInfo('default')['default']);
        // Validate we have injected our custom key and target.
        $this->assertSame($sql_base->getDatabase()
            ->getTarget(), $target);
        $this->assertSame($sql_base->getDatabase()
            ->getKey(), $key);
        // Now test we can have SqlBase create the connection from an info array.
        $sql_base = new TestSqlBase([], $this->migration);
        $target = 'test_db_target2';
        $key = 'test_migrate_connection2';
        $database = Database::getConnectionInfo('default')['default'];
        $config = [
            'target' => $target,
            'key' => $key,
            'database' => $database,
        ];
        $sql_base->setConfiguration($config);
        // Call getDatabase() to get the connection defined.
        $sql_base->getDatabase();
        // Validate the connection has been created with the right values.
        $this->assertSame(Database::getConnectionInfo($key)[$target], $database);
        // Now, test this all works when using state to store db info.
        $target = 'test_state_db_target';
        $key = 'test_state_migrate_connection';
        $config = [
            'target' => $target,
            'key' => $key,
        ];
        $database_state_key = 'migrate_sql_base_test';
        \Drupal::state()->set($database_state_key, $config);
        $sql_base->setConfiguration([
            'database_state_key' => $database_state_key,
        ]);
        Database::addConnectionInfo($key, $target, Database::getConnectionInfo('default')['default']);
        // Validate we have injected our custom key and target.
        $this->assertSame($sql_base->getDatabase()
            ->getTarget(), $target);
        $this->assertSame($sql_base->getDatabase()
            ->getKey(), $key);
        // Now test we can have SqlBase create the connection from an info array.
        $sql_base = new TestSqlBase([], $this->migration);
        $target = 'test_state_db_target2';
        $key = 'test_state_migrate_connection2';
        $database = Database::getConnectionInfo('default')['default'];
        $config = [
            'target' => $target,
            'key' => $key,
            'database' => $database,
        ];
        $database_state_key = 'migrate_sql_base_test2';
        \Drupal::state()->set($database_state_key, $config);
        $sql_base->setConfiguration([
            'database_state_key' => $database_state_key,
        ]);
        // Call getDatabase() to get the connection defined.
        $sql_base->getDatabase();
        // Validate the connection has been created with the right values.
        $this->assertSame(Database::getConnectionInfo($key)[$target], $database);
        // Verify that falling back to 'migrate' when the connection is not defined
        // throws a RequirementsException.
        \Drupal::state()->delete('migrate.fallback_state_key');
        $sql_base->setConfiguration([]);
        Database::renameConnection('migrate', 'fallback_connection');
        $this->expectException(RequirementsException::class);
        $this->expectExceptionMessage('No database connection configured for source plugin');
        $sql_base->getDatabase();
    }
    
    /**
     * Tests the exception when a connection is defined but not available.
     */
    public function testBrokenConnection() : void {
        if (Database::getConnection()->driver() === 'sqlite') {
            $this->markTestSkipped('Not compatible with sqlite');
        }
        $sql_base = new TestSqlBase([], $this->migration);
        $target = 'test_state_db_target2';
        $key = 'test_state_migrate_connection2';
        $database = Database::getConnectionInfo('default')['default'];
        $database['database'] = 'godot';
        $config = [
            'target' => $target,
            'key' => $key,
            'database' => $database,
        ];
        $database_state_key = 'migrate_sql_base_test2';
        \Drupal::state()->set($database_state_key, $config);
        $sql_base->setConfiguration([
            'database_state_key' => $database_state_key,
        ]);
        // Call checkRequirements(): it will call getDatabase() and convert the
        // exception to a RequirementsException.
        $this->expectException(RequirementsException::class);
        $this->expectExceptionMessage('No database connection available for source plugin sql_base');
        $sql_base->checkRequirements();
    }
    
    /**
     * Tests that SqlBase respects high-water values.
     *
     * @param mixed $high_water
     *   (optional) The high-water value to set.
     * @param array $query_result
     *   (optional) The expected query results.
     *
     * @dataProvider highWaterDataProvider
     */
    public function testHighWater($high_water = NULL, array $query_result = []) : void {
        $configuration = [
            'high_water_property' => [
                'name' => 'order',
            ],
        ];
        $source = new TestSqlBase($configuration, $this->migration);
        if ($high_water) {
            \Drupal::keyValue('migrate:high_water')->set($this->migration
                ->id(), $high_water);
        }
        $statement = $this->createMock(StatementInterface::class);
        $statement->expects($this->atLeastOnce())
            ->method('setFetchMode')
            ->with(\PDO::FETCH_ASSOC);
        $query = $this->createMock(SelectInterface::class);
        $query->method('execute')
            ->willReturn($statement);
        $query->expects($this->atLeastOnce())
            ->method('orderBy')
            ->with('order', 'ASC');
        $condition_group = $this->createMock(ConditionInterface::class);
        $query->method('orConditionGroup')
            ->willReturn($condition_group);
        $source->setQuery($query);
        $source->rewind();
    }
    
    /**
     * Data provider for ::testHighWater().
     *
     * @return array
     *   The scenarios to test.
     */
    public static function highWaterDataProvider() {
        return [
            'no high-water value set' => [],
            'high-water value set' => [
                33,
            ],
        ];
    }

}

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.
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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
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::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.
MigrateTestBase::$collectMessages protected property TRUE to collect messages instead of displaying them.
MigrateTestBase::$logger protected property A logger prophecy object. 2
MigrateTestBase::$migrateMessages protected property A two dimensional array of messages.
MigrateTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules 17
MigrateTestBase::$sourceDatabase protected property The source database connection.
MigrateTestBase::cleanupMigrateConnection private function Cleans up the test migrate connection.
MigrateTestBase::createMigrationConnection private function Changes the database connection to the prefixed one.
MigrateTestBase::display public function Displays a migrate message. Overrides MigrateMessageInterface::display
MigrateTestBase::executeMigration protected function Executes a single migration.
MigrateTestBase::executeMigrations protected function Executes a set of migrations in dependency order.
MigrateTestBase::getMigration protected function Gets the migration plugin.
MigrateTestBase::mockFailure protected function Records a failure in the map table of a specific migration.
MigrateTestBase::prepareMigration protected function Modify a migration's configuration before executing it.
MigrateTestBase::prepareMigrations protected function Prepare any dependent migrations.
MigrateTestBase::setTestLogger protected function Injects the test logger into the container.
MigrateTestBase::startCollectingMessages public function Start collecting messages and erase previous messages.
MigrateTestBase::stopCollectingMessages public function Stop collecting messages.
MigrateTestBase::tearDown protected function Overrides KernelTestBase::tearDown
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.
SqlBaseTest::$migration protected property The (probably mocked) migration under test. Overrides MigrateTestBase::$migration
SqlBaseTest::highWaterDataProvider public static function Data provider for ::testHighWater().
SqlBaseTest::setUp protected function Overrides MigrateTestBase::setUp
SqlBaseTest::testBrokenConnection public function Tests the exception when a connection is defined but not available.
SqlBaseTest::testConnectionTypes public function Tests different connection types.
SqlBaseTest::testHighWater public function Tests that SqlBase respects high-water values.
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.