class MigrationPluginListTest

Same name in other branches
  1. 9 core/modules/migrate/tests/src/Kernel/Plugin/MigrationPluginListTest.php \Drupal\Tests\migrate\Kernel\Plugin\MigrationPluginListTest
  2. 8.9.x core/modules/migrate/tests/src/Kernel/Plugin/MigrationPluginListTest.php \Drupal\Tests\migrate\Kernel\Plugin\MigrationPluginListTest
  3. 11.x core/modules/migrate/tests/src/Kernel/Plugin/MigrationPluginListTest.php \Drupal\Tests\migrate\Kernel\Plugin\MigrationPluginListTest

Tests the migration plugin manager.

@coversDefaultClass \Drupal\migrate\Plugin\MigratePluginManager @group migrate

Hierarchy

Expanded class hierarchy of MigrationPluginListTest

File

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

Namespace

Drupal\Tests\migrate\Kernel\Plugin
View source
class MigrationPluginListTest extends KernelTestBase {
    use EntityReferenceFieldCreationTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'migrate',
        // Test with all modules containing Drupal migrations.
'ban',
        'block',
        'block_content',
        // @todo Remove book in https://www.drupal.org/project/drupal/issues/3376101
'book',
        'comment',
        'contact',
        'content_translation',
        'dblog',
        'field',
        'file',
        'filter',
        // @todo Remove forum in https://www.drupal.org/project/drupal/issues/3261653
'forum',
        'image',
        'language',
        'locale',
        'menu_link_content',
        'menu_ui',
        'node',
        'options',
        'path',
        'search',
        'shortcut',
        // @todo Remove statistics in https://www.drupal.org/project/drupal/issues/3341092
'statistics',
        'syslog',
        'system',
        'taxonomy',
        'text',
        // @todo Remove tracker in https://www.drupal.org/project/drupal/issues/3261452
'tracker',
        'update',
        'user',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('user');
    }
    
    /**
     * @covers ::getDefinitions
     */
    public function testGetDefinitions() : void {
        // Create an entity reference field to make sure that migrations derived by
        // EntityReferenceTranslationDeriver do not get discovered without
        // migrate_drupal enabled.
        $this->createEntityReferenceField('user', 'user', 'field_entity_reference', 'Entity Reference', 'node');
        // Make sure retrieving all the core migration plugins does not throw any
        // errors.
        $migration_plugins = $this->container
            ->get('plugin.manager.migration')
            ->getDefinitions();
        // All the plugins provided by core depend on migrate_drupal.
        $this->assertEmpty($migration_plugins);
        // Enable a module that provides migrations that do not depend on
        // migrate_drupal.
        $this->enableModules([
            'migrate_external_translated_test',
        ]);
        $migration_plugins = $this->container
            ->get('plugin.manager.migration')
            ->getDefinitions();
        // All the plugins provided by migrate_external_translated_test do not
        // depend on migrate_drupal.
        $this::assertArrayHasKey('external_translated_test_node', $migration_plugins);
        $this::assertArrayHasKey('external_translated_test_node_translation', $migration_plugins);
        // Disable the test module and the list should be empty again.
        $this->disableModules([
            'migrate_external_translated_test',
        ]);
        $migration_plugins = $this->container
            ->get('plugin.manager.migration')
            ->getDefinitions();
        // All the plugins provided by core depend on migrate_drupal.
        $this->assertEmpty($migration_plugins);
        // Enable migrate_drupal to test that the plugins can now be discovered.
        $this->enableModules([
            'migrate_drupal',
        ]);
        // Make sure retrieving these migration plugins in the absence of a database
        // connection does not throw any errors.
        $migration_plugins = $this->container
            ->get('plugin.manager.migration')
            ->createInstances([]);
        // Any database-based source plugins should fail a requirements test in the
        // absence of a source database connection (e.g., a connection with the
        // 'migrate' key).
        $source_plugins = array_map(function ($migration_plugin) {
            return $migration_plugin->getSourcePlugin();
        }, $migration_plugins);
        foreach ($source_plugins as $id => $source_plugin) {
            if ($source_plugin instanceof RequirementsInterface) {
                try {
                    $source_plugin->checkRequirements();
                } catch (RequirementsException $e) {
                    unset($source_plugins[$id]);
                }
            }
        }
        // Without a connection defined, no database-based plugins should be
        // returned.
        foreach ($source_plugins as $id => $source_plugin) {
            $this->assertNotInstanceOf(SqlBase::class, $source_plugin);
        }
        // Set up a migrate database connection so that plugin discovery works.
        // Clone the current connection and replace the current prefix.
        $connection_info = Database::getConnectionInfo('migrate');
        if ($connection_info) {
            Database::renameConnection('migrate', 'simpletest_original_migrate');
        }
        $connection_info = Database::getConnectionInfo('default');
        foreach ($connection_info as $target => $value) {
            $prefix = $value['prefix'];
            // Tests use 7 character prefixes at most so this can't cause collisions.
            $connection_info[$target]['prefix'] = $prefix . '0';
        }
        Database::addConnectionInfo('migrate', 'default', $connection_info['default']);
        // Make sure source plugins can be serialized.
        foreach ($migration_plugins as $migration_plugin) {
            $source_plugin = $migration_plugin->getSourcePlugin();
            if ($source_plugin instanceof SqlBase) {
                $source_plugin->getDatabase();
            }
            $this->assertNotEmpty(serialize($source_plugin));
        }
        $migration_plugins = $this->container
            ->get('plugin.manager.migration')
            ->getDefinitions();
        // All the plugins provided by core depend on migrate_drupal.
        $this->assertNotEmpty($migration_plugins);
        // Test that migrations derived by EntityReferenceTranslationDeriver are
        // discovered now that migrate_drupal is enabled.
        $this->assertArrayHasKey('d6_entity_reference_translation:user__user', $migration_plugins);
        $this->assertArrayHasKey('d7_entity_reference_translation:user__user', $migration_plugins);
    }

}

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.
EntityReferenceFieldCreationTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
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::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.
MigrationPluginListTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
MigrationPluginListTest::setUp protected function Overrides KernelTestBase::setUp
MigrationPluginListTest::testGetDefinitions public function @covers ::getDefinitions
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.