class MigrationProvidersExistTest

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

Tests that modules exist for all source and destination plugins.

@group migrate_drupal_ui

Hierarchy

Expanded class hierarchy of MigrationProvidersExistTest

File

core/modules/migrate/tests/src/Kernel/Plugin/MigrationProvidersExistTest.php, line 16

Namespace

Drupal\Tests\migrate\Kernel\Plugin
View source
class MigrationProvidersExistTest extends MigrateDrupalTestBase {
    use DeprecatedModulesTestTrait;
    use FileSystemModuleDiscoveryDataProviderTrait;
    
    /**
     * Tests that a missing source_module property raises an exception.
     */
    public function testSourceProvider() {
        $this->enableModules([
            'migration_provider_test',
        ]);
        $this->expectException(BadPluginDefinitionException::class);
        $this->expectExceptionMessage('The no_source_module plugin must define the source_module property.');
        $this->container
            ->get('plugin.manager.migration')
            ->getDefinition('migration_provider_no_annotation');
    }
    
    /**
     * Tests that modules exist for all source plugins.
     */
    public function testProvidersExist() {
        $this->enableAllModules();
        
        /** @var \Drupal\migrate\Plugin\MigrateSourcePluginManager $plugin_manager */
        $plugin_manager = $this->container
            ->get('plugin.manager.migrate.source');
        foreach ($plugin_manager->getDefinitions() as $definition) {
            $id = $definition['id'];
            $this->assertArrayHasKey('source_module', $definition, "No source_module property in '{$id}'");
        }
    }
    
    /**
     * Enable all available modules.
     */
    protected function enableAllModules() {
        // Install all available modules.
        $module_handler = $this->container
            ->get('module_handler');
        $modules = $this->coreModuleListDataProvider();
        $modules_enabled = $module_handler->getModuleList();
        $modules_to_enable = array_keys(array_diff_key($modules, $modules_enabled));
        $this->enableModules($modules_to_enable);
    }
    
    /**
     * Tests that modules exist for all field plugins.
     */
    public function testFieldProvidersExist() {
        $expected_mappings = [
            'userreference' => [
                'source_module' => 'userreference',
                'destination_module' => 'core',
            ],
            'nodereference' => [
                'source_module' => 'nodereference',
                'destination_module' => 'core',
            ],
            'optionwidgets' => [
                'source_module' => 'optionwidgets',
                'destination_module' => 'options',
            ],
            'list' => [
                'source_module' => 'list',
                'destination_module' => 'options',
            ],
            'options' => [
                'source_module' => 'options',
                'destination_module' => 'options',
            ],
            'filefield' => [
                'source_module' => 'filefield',
                'destination_module' => 'file',
            ],
            'imagefield' => [
                'source_module' => 'imagefield',
                'destination_module' => 'image',
            ],
            'file' => [
                'source_module' => 'file',
                'destination_module' => 'file',
            ],
            'image' => [
                'source_module' => 'image',
                'destination_module' => 'image',
            ],
            'phone' => [
                'source_module' => 'phone',
                'destination_module' => 'telephone',
            ],
            'link' => [
                'source_module' => 'link',
                'destination_module' => 'link',
            ],
            'link_field' => [
                'source_module' => 'link',
                'destination_module' => 'link',
            ],
            'd6_text' => [
                'source_module' => 'text',
                'destination_module' => 'text',
            ],
            'd7_text' => [
                'source_module' => 'text',
                'destination_module' => 'text',
            ],
            'taxonomy_term_reference' => [
                'source_module' => 'taxonomy',
                'destination_module' => 'core',
            ],
            'date' => [
                'source_module' => 'date',
                'destination_module' => 'datetime',
            ],
            'datetime' => [
                'source_module' => 'date',
                'destination_module' => 'datetime',
            ],
            'email' => [
                'source_module' => 'email',
                'destination_module' => 'core',
            ],
            'number_default' => [
                'source_module' => 'number',
                'destination_module' => 'core',
            ],
            'entityreference' => [
                'source_module' => 'entityreference',
                'destination_module' => 'core',
            ],
        ];
        $this->enableAllModules();
        $definitions = $this->container
            ->get('plugin.manager.migrate.field')
            ->getDefinitions();
        foreach ($definitions as $key => $definition) {
            $this->assertArrayHasKey($key, $expected_mappings);
            $this->assertEquals($expected_mappings[$key]['source_module'], $definition['source_module']);
            $this->assertEquals($expected_mappings[$key]['destination_module'], $definition['destination_module']);
        }
    }
    
    /**
     * Test a missing required definition.
     *
     * @param array $definitions
     *   A field plugin definition.
     * @param string $missing_property
     *   The name of the property missing from the definition.
     *
     * @dataProvider fieldPluginDefinitionsProvider
     */
    public function testFieldProviderMissingRequiredProperty(array $definitions, $missing_property) {
        $discovery = $this->getMockBuilder(MigrateFieldPluginManager::class)
            ->disableOriginalConstructor()
            ->setMethods([
            'getDefinitions',
        ])
            ->getMock();
        $discovery->method('getDefinitions')
            ->willReturn($definitions);
        $plugin_manager = $this->getMockBuilder(MigrateFieldPluginManager::class)
            ->disableOriginalConstructor()
            ->setMethods([
            'getDiscovery',
        ])
            ->getMock();
        $plugin_manager->method('getDiscovery')
            ->willReturn($discovery);
        $this->expectException(BadPluginDefinitionException::class);
        $this->expectExceptionMessage("The missing_{$missing_property} plugin must define the {$missing_property} property.");
        $plugin_manager->getDefinitions();
    }
    
    /**
     * Data provider for field plugin definitions.
     *
     * @return array
     *   Array of plugin definitions.
     */
    public function fieldPluginDefinitionsProvider() {
        return [
            'missing_core_scenario' => [
                'definitions' => [
                    'missing_core' => [
                        'source_module' => 'migrate',
                        'destination_module' => 'migrate',
                        'id' => 'missing_core',
                        'class' => 'foo',
                        'provider' => 'foo',
                    ],
                ],
                'missing_property' => 'core',
            ],
            'missing_source_scenario' => [
                'definitions' => [
                    'missing_source_module' => [
                        'core' => [
                            6,
                            7,
                        ],
                        'destination_module' => 'migrate',
                        'id' => 'missing_source_module',
                        'class' => 'foo',
                        'provider' => 'foo',
                    ],
                ],
                'missing_property' => 'source_module',
            ],
            'missing_destination_scenario' => [
                'definitions' => [
                    'missing_destination_module' => [
                        'core' => [
                            6,
                            7,
                        ],
                        'source_module' => 'migrate',
                        'id' => 'missing_destination_module',
                        'class' => 'foo',
                        'provider' => 'foo',
                    ],
                ],
                'missing_property' => 'destination_module',
            ],
        ];
    }

}

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.
DeprecatedModulesTestTrait::$deprecatedModules protected property List of deprecated modules names to not be enabled for tests.
DeprecatedModulesTestTrait::$excludeDeprecated protected property Flag to exclude deprecated modules from the tests. 12
DeprecatedModulesTestTrait::enableModules protected function Overrides \Drupal\KernelTests\KernelTestBase::enableModules().
DeprecatedModulesTestTrait::removeDeprecatedModules protected function Removes deprecated modules from the provided modules.list.
FileSystemModuleDiscoveryDataProviderTrait::coreModuleListDataProvider public function A data provider that lists every module in core.
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::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::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.
MigrateDrupalTestBase::$modules public static property Modules to enable. Overrides MigrateTestBase::$modules 105
MigrateDrupalTestBase::loadFixture protected function Loads a database fixture into the source database connection.
MigrateDrupalTestBase::setUp protected function Overrides MigrateTestBase::setUp 13
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::$migration protected property The primary migration being tested. 1
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
MigrationProvidersExistTest::enableAllModules protected function Enable all available modules.
MigrationProvidersExistTest::fieldPluginDefinitionsProvider public function Data provider for field plugin definitions.
MigrationProvidersExistTest::testFieldProviderMissingRequiredProperty public function Test a missing required definition.
MigrationProvidersExistTest::testFieldProvidersExist public function Tests that modules exist for all field plugins.
MigrationProvidersExistTest::testProvidersExist public function Tests that modules exist for all source plugins.
MigrationProvidersExistTest::testSourceProvider public function Tests that a missing source_module property raises an exception.
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.