class MigrateLookupTest

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

Tests the Migrate Lookup service.

@group migrate

Hierarchy

Expanded class hierarchy of MigrateLookupTest

File

core/modules/migrate/tests/src/Kernel/MigrateLookupTest.php, line 14

Namespace

Drupal\Tests\migrate\Kernel
View source
class MigrateLookupTest extends MigrateTestBase {
    use ContentTypeCreationTrait;
    
    /**
     * {@inheritdoc}
     */
    public static $modules = [
        'system',
        'node',
        'field',
        'user',
        'text',
        'migrate_lookup_test',
    ];
    
    /**
     * The migration lookup service.
     *
     * @var \Drupal\migrate\MigrateLookupInterface
     */
    protected $migrateLookup;
    
    /**
     * {@inheritdoc}
     */
    public function setUp() {
        parent::setUp();
        $this->setTestLogger();
        $this->migrateLookup = $this->container
            ->get('migrate.lookup');
        $this->installEntitySchema('node');
        $this->installEntitySchema('user');
        $this->installConfig([
            'node',
            'user',
        ]);
        $this->createContentType([
            'type' => 'node_lookup',
        ]);
    }
    
    /**
     * Tests scenarios around single id lookups.
     */
    public function testSingleLookup() {
        $this->executeMigration('sample_lookup_migration');
        // Test numerically indexed source id.
        $result = $this->migrateLookup
            ->lookup('sample_lookup_migration', [
            17,
        ]);
        $this->assertSame('1', $result[0]['nid']);
        // Test associatively indexed source id.
        $result = $this->migrateLookup
            ->lookup('sample_lookup_migration', [
            'id' => 25,
        ]);
        $this->assertSame('2', $result[0]['nid']);
        // Test lookup not found.
        $result = $this->migrateLookup
            ->lookup('sample_lookup_migration', [
            1337,
        ]);
        $this->assertSame([], $result);
    }
    
    /**
     * Tests an invalid lookup.
     */
    public function testInvalidIdLookup() {
        $this->executeMigration('sample_lookup_migration');
        $this->expectException(MigrateException::class);
        $this->expectExceptionMessage("Extra unknown items for map migrate_map_sample_lookup_migration in source IDs: array (\n  'invalid_id' => 25,\n)");
        // Test invalidly indexed source id.
        $this->migrateLookup
            ->lookup('sample_lookup_migration', [
            'invalid_id' => 25,
        ]);
    }
    
    /**
     * Tests an invalid lookup.
     */
    public function testInvalidMigrationLookup() {
        $this->expectException(PluginNotFoundException::class);
        $this->expectExceptionMessage("Plugin ID 'invalid_migration' was not found.");
        // Test invalid migration_id.
        $this->migrateLookup
            ->lookup('invalid_migration', [
            'id' => 1337,
        ]);
    }
    
    /**
     * Tests lookups with multiple source ids.
     */
    public function testMultipleSourceIds() {
        $this->executeMigration('sample_lookup_migration_multiple_source_ids');
        // Test with full set of numerically indexed source ids.
        $result = $this->migrateLookup
            ->lookup('sample_lookup_migration_multiple_source_ids', [
            25,
            26,
        ]);
        $this->assertCount(1, $result);
        $this->assertSame('3', $result[0]['nid']);
        // Test with full set of associatively indexed source ids.
        $result = $this->migrateLookup
            ->lookup('sample_lookup_migration_multiple_source_ids', [
            'id' => 17,
            'version_id' => 17,
        ]);
        $this->assertCount(1, $result);
        $this->assertSame('1', $result[0]['nid']);
        // Test with full set of associatively indexed source ids in the wrong
        // order.
        $result = $this->migrateLookup
            ->lookup('sample_lookup_migration_multiple_source_ids', [
            'version_id' => 26,
            'id' => 25,
        ]);
        $this->assertCount(1, $result);
        $this->assertSame('3', $result[0]['nid']);
        // Test with a partial set of numerically indexed ids.
        $result = $this->migrateLookup
            ->lookup('sample_lookup_migration_multiple_source_ids', [
            25,
        ]);
        $this->assertCount(2, $result);
        $this->assertSame('2', $result[0]['nid']);
        $this->assertSame('3', $result[1]['nid']);
        // Test with a partial set of associatively indexed ids.
        $result = $this->migrateLookup
            ->lookup('sample_lookup_migration_multiple_source_ids', [
            'version_id' => 25,
        ]);
        $this->assertCount(1, $result);
        $this->assertSame('2', $result[0]['nid']);
    }
    
    /**
     * Tests looking up against multiple migrations at once.
     *
     * @throws \Drupal\Component\Plugin\Exception\PluginException
     * @throws \Drupal\migrate\MigrateException
     */
    public function testMultipleMigrationLookup() {
        $migrations = [
            'sample_lookup_migration',
            'sample_lookup_migration_2',
        ];
        foreach ($migrations as $migration) {
            $this->executeMigration($migration);
        }
        // Test numerically indexed source id.
        $result = $this->migrateLookup
            ->lookup($migrations, [
            17,
        ]);
        $this->assertSame('1', $result[0]['nid']);
        // Test associatively indexed source id.
        $result = $this->migrateLookup
            ->lookup($migrations, [
            'id' => 35,
        ]);
        $this->assertSame('4', $result[0]['nid']);
        // Test lookup not found.
        $result = $this->migrateLookup
            ->lookup($migrations, [
            1337,
        ]);
        $this->assertSame([], $result);
    }
    
    /**
     * Tests a lookup with string source ids.
     */
    public function testLookupWithStringIds() {
        $this->executeMigration('sample_lookup_migration_string_ids');
        // Test numerically indexed source id.
        $result = $this->migrateLookup
            ->lookup('sample_lookup_migration_string_ids', [
            'node1',
        ]);
        $this->assertSame('10', $result[0]['nid']);
        // Test associatively indexed source id.
        $result = $this->migrateLookup
            ->lookup('sample_lookup_migration_string_ids', [
            'id' => 'node2',
        ]);
        $this->assertSame('11', $result[0]['nid']);
        // Test lookup not found.
        $result = $this->migrateLookup
            ->lookup('sample_lookup_migration_string_ids', [
            'node1337',
        ]);
        $this->assertSame([], $result);
    }

}

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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. 1
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::enableModules protected function Enables 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.
MigrateLookupTest::$migrateLookup protected property The migration lookup service.
MigrateLookupTest::$modules public static property Modules to enable. Overrides MigrateTestBase::$modules
MigrateLookupTest::setUp public function Overrides MigrateTestBase::setUp
MigrateLookupTest::testInvalidIdLookup public function Tests an invalid lookup.
MigrateLookupTest::testInvalidMigrationLookup public function Tests an invalid lookup.
MigrateLookupTest::testLookupWithStringIds public function Tests a lookup with string source ids.
MigrateLookupTest::testMultipleMigrationLookup public function Tests looking up against multiple migrations at once.
MigrateLookupTest::testMultipleSourceIds public function Tests lookups with multiple source ids.
MigrateLookupTest::testSingleLookup public function Tests scenarios around single id lookups.
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
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.