class MigrateLookupTest

Same name in this branch
  1. 11.x core/modules/migrate/tests/src/Kernel/MigrateLookupTest.php \Drupal\Tests\migrate\Kernel\MigrateLookupTest
Same name and namespace 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. 8.9.x core/modules/migrate/tests/src/Unit/MigrateLookupTest.php \Drupal\Tests\migrate\Unit\MigrateLookupTest
  4. 8.9.x core/modules/migrate/tests/src/Kernel/MigrateLookupTest.php \Drupal\Tests\migrate\Kernel\MigrateLookupTest
  5. 10 core/modules/migrate/tests/src/Unit/MigrateLookupTest.php \Drupal\Tests\migrate\Unit\MigrateLookupTest
  6. 10 core/modules/migrate/tests/src/Kernel/MigrateLookupTest.php \Drupal\Tests\migrate\Kernel\MigrateLookupTest

Provides unit testing for the migration lookup service.

@group migrate

@coversDefaultClass \Drupal\migrate\MigrateLookup

Hierarchy

Expanded class hierarchy of MigrateLookupTest

File

core/modules/migrate/tests/src/Unit/MigrateLookupTest.php, line 22

Namespace

Drupal\Tests\migrate\Unit
View source
class MigrateLookupTest extends MigrateTestCase {
    
    /**
     * Tests the lookup function.
     *
     * @covers ::lookup
     */
    public function testLookup() : void {
        $source_ids = [
            'id' => '1',
        ];
        $destination_ids = [
            [
                2,
            ],
        ];
        $id_map = $this->prophesize(MigrateIdMapInterface::class);
        $id_map->lookupDestinationIds($source_ids)
            ->willReturn($destination_ids);
        $destination = $this->prophesize(MigrateDestinationInterface::class);
        $destination->getIds()
            ->willReturn([
            'id' => [
                'type' => 'integer',
            ],
        ]);
        $migration = $this->prophesize(MigrationInterface::class);
        $migration->getIdMap()
            ->willReturn($id_map->reveal());
        $migration->getDestinationPlugin()
            ->willReturn($destination->reveal());
        $plugin_manager = $this->prophesize(MigrationPluginManagerInterface::class);
        $plugin_manager->createInstances('test_migration')
            ->willReturn([
            $migration->reveal(),
        ]);
        $lookup = new MigrateLookup($plugin_manager->reveal());
        $this->assertSame([
            [
                'id' => 2,
            ],
        ], $lookup->lookup('test_migration', $source_ids));
    }
    
    /**
     * Tests message logged when a single migration is not found.
     *
     * @dataProvider providerExceptionOnMigrationNotFound
     */
    public function testExceptionOnMigrationNotFound($migrations, $message) : void {
        $migration_plugin_manager = $this->prophesize(MigrationPluginManagerInterface::class);
        $migration_plugin_manager->createInstances($migrations)
            ->willReturn([]);
        $this->expectException(PluginNotFoundException::class);
        $this->expectExceptionMessage($message);
        $lookup = new MigrateLookup($migration_plugin_manager->reveal());
        $lookup->lookup($migrations, [
            1,
        ]);
    }
    
    /**
     * Provides data for testExceptionOnMigrationNotFound.
     */
    public static function providerExceptionOnMigrationNotFound() {
        return [
            'string' => [
                'bad_plugin',
                "Plugin ID 'bad_plugin' was not found.",
            ],
            'array one item' => [
                [
                    'bad_plugin',
                ],
                "Plugin ID 'bad_plugin' was not found.",
            ],
        ];
    }
    
    /**
     * Tests message logged when multiple migrations are not found.
     *
     * @dataProvider providerExceptionOnMultipleMigrationsNotFound
     */
    public function testExceptionOnMultipleMigrationsNotFound($migrations, $message) : void {
        $migration_plugin_manager = $this->prophesize(MigrationPluginManagerInterface::class);
        $migration_plugin_manager->createInstances($migrations)
            ->willReturn([]);
        $this->expectException(PluginException::class);
        $this->expectExceptionMessage($message);
        $lookup = new MigrateLookup($migration_plugin_manager->reveal());
        $lookup->lookup($migrations, [
            1,
        ]);
    }
    
    /**
     * Provides data for testExceptionOnMultipleMigrationsNotFound.
     */
    public static function providerExceptionOnMultipleMigrationsNotFound() {
        return [
            'array two items' => [
                [
                    'foo',
                    'bar',
                ],
                "Plugin IDs 'foo', 'bar' were not found.",
            ],
            'empty array' => [
                [],
                "Plugin IDs '' were not found.",
            ],
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
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.
MigrateLookupTest::providerExceptionOnMigrationNotFound public static function Provides data for testExceptionOnMigrationNotFound.
MigrateLookupTest::providerExceptionOnMultipleMigrationsNotFound public static function Provides data for testExceptionOnMultipleMigrationsNotFound.
MigrateLookupTest::testExceptionOnMigrationNotFound public function Tests message logged when a single migration is not found.
MigrateLookupTest::testExceptionOnMultipleMigrationsNotFound public function Tests message logged when multiple migrations are not found.
MigrateLookupTest::testLookup public function Tests the lookup function.
MigrateTestCase::$idMap protected property The migration ID map.
MigrateTestCase::$migrationConfiguration protected property An array of migration configuration values. 10
MigrateTestCase::$migrationStatus protected property Local store for mocking setStatus()/getStatus().
MigrateTestCase::createSchemaFromRow protected function Generates a table schema from a row.
MigrateTestCase::getDatabase protected function Gets an SQLite database connection object for use in tests.
MigrateTestCase::getMigration protected function Retrieves a mocked migration.
MigrateTestCase::getValue protected function Gets the value on a row for a given key.
MigrateTestCase::queryResultTest public function Tests a query.
MigrateTestCase::retrievalAssertHelper protected function Asserts tested values during test retrieval.
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.
UnitTestCase::$root protected property The app root.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setUp protected function 354
UnitTestCase::setUpBeforeClass public static function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.