class MigrateSqlSourceTestBase
Same name in other branches
- 9 core/modules/migrate/tests/src/Kernel/MigrateSqlSourceTestBase.php \Drupal\Tests\migrate\Kernel\MigrateSqlSourceTestBase
- 8.9.x core/modules/migrate/tests/src/Kernel/MigrateSqlSourceTestBase.php \Drupal\Tests\migrate\Kernel\MigrateSqlSourceTestBase
- 10 core/modules/migrate/tests/src/Kernel/MigrateSqlSourceTestBase.php \Drupal\Tests\migrate\Kernel\MigrateSqlSourceTestBase
Base class for tests of Migrate source plugins that use a database.
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\ExtensionListTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait
- class \Drupal\Tests\migrate\Kernel\MigrateSourceTestBase extends \Drupal\KernelTests\KernelTestBase
- class \Drupal\Tests\migrate\Kernel\MigrateSqlSourceTestBase extends \Drupal\Tests\migrate\Kernel\MigrateSourceTestBase
- class \Drupal\Tests\migrate\Kernel\MigrateSourceTestBase extends \Drupal\KernelTests\KernelTestBase
Expanded class hierarchy of MigrateSqlSourceTestBase
98 files declare their use of MigrateSqlSourceTestBase
- ActionTest.php in core/
modules/ system/ tests/ src/ Kernel/ Plugin/ migrate/ source/ ActionTest.php - BlockCustomTest.php in core/
modules/ block_content/ tests/ src/ Kernel/ Plugin/ migrate/ source/ d7/ BlockCustomTest.php - BlockCustomTranslationTest.php in core/
modules/ block_content/ tests/ src/ Kernel/ Plugin/ migrate/ source/ d7/ BlockCustomTranslationTest.php - BlockedIpsTest.php in core/
modules/ ban/ tests/ src/ Kernel/ Plugin/ migrate/ source/ d7/ BlockedIpsTest.php - BlockTest.php in core/
modules/ block/ tests/ src/ Kernel/ Plugin/ migrate/ source/ BlockTest.php
File
-
core/
modules/ migrate/ tests/ src/ Kernel/ MigrateSqlSourceTestBase.php, line 15
Namespace
Drupal\Tests\migrate\KernelView source
abstract class MigrateSqlSourceTestBase extends MigrateSourceTestBase {
/**
* {@inheritdoc}
*/
public function register(ContainerBuilder $container) {
parent::register($container);
$container->register('cache_factory', MemoryCounterBackendFactory::class)
->addArgument(new Reference('datetime.time'));
}
/**
* Builds an in-memory SQLite database from a set of source data.
*
* @param array $source_data
* The source data, keyed by table name. Each table is an array containing
* the rows in that table.
*
* @return \Drupal\sqlite\Driver\Database\sqlite\Connection
* The SQLite database connection.
*/
protected function getDatabase(array $source_data) {
// Create an in-memory SQLite database. Plugins can interact with it like
// any other database, and it will cease to exist when the connection is
// closed.
$connection_options = [
'database' => ':memory:',
];
$pdo = Connection::open($connection_options);
$connection = new Connection($pdo, $connection_options);
// Create the tables and fill them with data.
foreach ($source_data as $table => $rows) {
// Use the biggest row to build the table schema.
$counts = array_map('count', $rows);
asort($counts);
$pilot = $rows[array_key_last($counts)];
$connection->schema()
->createTable($table, [
// SQLite uses loose affinity typing, so it's OK for every field to
// be a text field.
'fields' => array_map(function () {
return [
'type' => 'text',
];
}, $pilot),
]);
$fields = array_keys($pilot);
$insert = $connection->insert($table)
->fields($fields);
array_walk($rows, [
$insert,
'values',
]);
$insert->execute();
}
return $connection;
}
/**
* Tests the source plugin against a particular data set.
*
* @param array $source_data
* The source data that the plugin will read. See getDatabase() for the
* expected format.
* @param array $expected_data
* The result rows the plugin is expected to return.
* @param int $expected_count
* (optional) How many rows the source plugin is expected to return.
* @param array $configuration
* (optional) Configuration for the source plugin.
* @param mixed $high_water
* (optional) The value of the high water field.
* @param string|null $expected_cache_key
* (optional) The expected cache key.
*
* @dataProvider providerSource
*
* @requires extension pdo_sqlite
*/
public function testSource(array $source_data, array $expected_data, $expected_count = NULL, array $configuration = [], $high_water = NULL, $expected_cache_key = NULL) : void {
$plugin = $this->getPlugin($configuration);
// Since we don't yet inject the database connection, we need to use a
// reflection hack to set it in the plugin instance.
$reflector = new \ReflectionObject($plugin);
$property = $reflector->getProperty('database');
$property->setValue($plugin, $this->getDatabase($source_data));
/** @var MemoryCounterBackend $cache **/
$cache = \Drupal::cache('migrate');
if ($expected_cache_key) {
// Verify the computed cache key.
$property = $reflector->getProperty('cacheKey');
$this->assertSame($expected_cache_key, $property->getValue($plugin));
// Cache miss prior to calling ::count().
$this->assertFalse($cache->get($expected_cache_key, 'cache'));
$this->assertSame([], $cache->getCounter('set'));
$count = $plugin->count();
$this->assertSame($expected_count, $count);
$this->assertSame([
$expected_cache_key => 1,
], $cache->getCounter('set'));
// Cache hit afterwards.
$cache_item = $cache->get($expected_cache_key, 'cache');
$this->assertNotSame(FALSE, $cache_item, 'This is not a cache hit.');
$this->assertSame($expected_count, $cache_item->data);
}
else {
$this->assertSame([], $cache->getCounter('set'));
$plugin->count();
$this->assertSame([], $cache->getCounter('set'));
}
parent::testSource($source_data, $expected_data, $expected_count, $configuration, $high_water);
}
}
Members
Title Sort descending | 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. | ||
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | ||
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | ||
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | ||
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | ||
ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | ||
ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | ||
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. | 4 | |
KernelTestBase::$container | protected | property | |||
KernelTestBase::$databasePrefix | protected | property | |||
KernelTestBase::$keyValue | protected | property | The key_value service that must persist between container rebuilds. | ||
KernelTestBase::$root | protected | property | The app root. | ||
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. | 3 | |
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::tearDown | protected | function | 7 | ||
KernelTestBase::tearDownCloseDatabaseConnection | public | function | Additional tear down method to close the connection at the end. | ||
KernelTestBase::vfsDump | protected | function | Dumps the current state of the virtual filesystem to STDOUT. | ||
KernelTestBase::__construct | public | function | |||
KernelTestBase::__sleep | public | function | Prevents serializing any properties. | ||
MigrateSourceTestBase::$migration | protected | property | The mocked migration. | ||
MigrateSourceTestBase::$modules | protected static | property | Modules to install. | Overrides KernelTestBase::$modules | 99 |
MigrateSourceTestBase::$plugin | protected | property | The source plugin under test. | ||
MigrateSourceTestBase::getPlugin | protected | function | Instantiates the source plugin under test. | ||
MigrateSourceTestBase::getPluginClass | protected | function | Determines the plugin to be tested by reading the class @covers annotation. | ||
MigrateSourceTestBase::setUp | protected | function | Overrides KernelTestBase::setUp | ||
MigrateSqlSourceTestBase::getDatabase | protected | function | Builds an in-memory SQLite database from a set of source data. | ||
MigrateSqlSourceTestBase::register | public | function | Registers test-specific services. | Overrides KernelTestBase::register | |
MigrateSqlSourceTestBase::testSource | public | function | Tests the source plugin against a particular data set. | Overrides MigrateSourceTestBase::testSource | |
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. | ||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | ||
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.