diff --git a/core/modules/migrate_drupal/src/Plugin/migrate/source/ContentEntity.php b/core/modules/migrate_drupal/src/Plugin/migrate/source/ContentEntity.php index a2f38d180c8..5ce5f1b4c9e 100644 --- a/core/modules/migrate_drupal/src/Plugin/migrate/source/ContentEntity.php +++ b/core/modules/migrate_drupal/src/Plugin/migrate/source/ContentEntity.php @@ -30,16 +30,26 @@ use Symfony\Component\DependencyInjection\ContainerInterface; * of this bundle. * - include_translations: (optional) Indicates if the entity translations * should be included, defaults to TRUE. + * - add_revision_id: (optional) Indicates if the revision key is added to the + * source IDs, defaults to TRUE. * * Examples: * - * This will return all nodes, from every bundle and every translation. It does - * not return all revisions, just the default one. + * This will return the default revision for all nodes, from every bundle and + * every translation. The revision key is added to the source IDs. * @code * source: * plugin: content_entity:node * @endcode * + * This will return the default revision for all nodes, from every bundle and + * every translation. The revision key is not added to the source IDs. + * @code + * source: + * plugin: content_entity:node + * add_revision_id: false + * @endcode + * * This will only return nodes of type 'article' in their default language. * @code * source: @@ -93,6 +103,7 @@ class ContentEntity extends SourcePluginBase implements ContainerFactoryPluginIn protected $defaultConfiguration = [ 'bundle' => NULL, 'include_translations' => TRUE, + 'add_revision_id' => TRUE, ]; /** @@ -265,7 +276,7 @@ class ContentEntity extends SourcePluginBase implements ContainerFactoryPluginIn public function getIds() { $id_key = $this->entityType->getKey('id'); $ids[$id_key] = $this->getDefinitionFromEntity($id_key); - if ($this->entityType->isRevisionable()) { + if ($this->configuration['add_revision_id'] && $this->entityType->isRevisionable()) { $revision_key = $this->entityType->getKey('revision'); $ids[$revision_key] = $this->getDefinitionFromEntity($revision_key); } diff --git a/core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/source/ContentEntityTest.php b/core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/source/ContentEntityTest.php index 4a0645528e4..c79db8f20d0 100644 --- a/core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/source/ContentEntityTest.php +++ b/core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/source/ContentEntityTest.php @@ -3,12 +3,14 @@ namespace Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source; use Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException; +use Drupal\Component\Plugin\PluginBase; use Drupal\Core\Field\FieldStorageDefinitionInterface; use Drupal\Core\Language\LanguageInterface; use Drupal\file\Entity\File; use Drupal\KernelTests\KernelTestBase; use Drupal\language\Entity\ConfigurableLanguage; use Drupal\media\Entity\Media; +use Drupal\migrate\Plugin\MigrateSourceInterface; use Drupal\migrate\Plugin\MigrationInterface; use Drupal\migrate_drupal\Plugin\migrate\source\ContentEntity; use Drupal\node\Entity\Node; @@ -85,13 +87,6 @@ class ContentEntityTest extends KernelTestBase { */ protected $migrationPluginManager; - /** - * The source plugin manager. - * - * @var \Drupal\migrate\Plugin\MigrateSourcePluginManager - */ - protected $sourcePluginManager; - /** * {@inheritdoc} */ @@ -175,7 +170,6 @@ class ContentEntityTest extends KernelTestBase { $this->fieldName => $term->id(), ])->save(); - $this->sourcePluginManager = $this->container->get('plugin.manager.migrate.source'); $this->migrationPluginManager = $this->container->get('plugin.manager.migration'); } @@ -240,19 +234,48 @@ class ContentEntityTest extends KernelTestBase { } /** - * Tests user source plugin. + * Helper to assert IDs structure. + * + * @param \Drupal\migrate\Plugin\MigrateSourceInterface $source + * The source plugin. + * @param array $configuration + * The source plugin configuration (Nope, no getter available). */ - public function testUserSource() { - $configuration = [ - 'include_translations' => FALSE, - ]; - $migration = $this->migrationPluginManager->createStubMigration($this->migrationDefinition('content_entity:user')); - $user_source = $this->sourcePluginManager->createInstance('content_entity:user', $configuration, $migration); + protected function assertIds(MigrateSourceInterface $source, array $configuration) { + $ids = $source->getIds(); + [, $entity_type_id] = explode(PluginBase::DERIVATIVE_SEPARATOR, $source->getPluginId()); + $entity_type = \Drupal::entityTypeManager()->getDefinition($entity_type_id); + + $this->assertArrayHasKey($entity_type->getKey('id'), $ids); + $ids_count_expected = 1; + + if ($entity_type->isTranslatable()) { + $ids_count_expected++; + $this->assertArrayHasKey($entity_type->getKey('langcode'), $ids); + } + + if ($entity_type->isRevisionable() && $configuration['add_revision_id']) { + $ids_count_expected++; + $this->assertArrayHasKey($entity_type->getKey('revision'), $ids); + } + + $this->assertCount($ids_count_expected, $ids); + } + + /** + * Tests user source plugin. + * + * @dataProvider migrationConfigurationProvider + */ + public function testUserSource(array $configuration) { + $migration = $this->migrationPluginManager + ->createStubMigration($this->migrationDefinition('content_entity:user', $configuration)); + $user_source = $migration->getSourcePlugin(); $this->assertSame('users', $user_source->__toString()); - $this->assertEquals(1, $user_source->count()); - $ids = $user_source->getIds(); - $this->assertArrayHasKey('langcode', $ids); - $this->assertArrayHasKey('uid', $ids); + if (!$configuration['include_translations']) { + $this->assertEquals(1, $user_source->count()); + } + $this->assertIds($user_source, $configuration); $fields = $user_source->fields(); $this->assertArrayHasKey('name', $fields); $this->assertArrayHasKey('pass', $fields); @@ -269,8 +292,10 @@ class ContentEntityTest extends KernelTestBase { /** * Tests file source plugin. + * + * @dataProvider migrationConfigurationProvider */ - public function testFileSource() { + public function testFileSource(array $configuration) { $file = File::create([ 'filename' => 'foo.txt', 'uid' => $this->user->id(), @@ -278,15 +303,14 @@ class ContentEntityTest extends KernelTestBase { ]); $file->save(); - $configuration = [ - 'include_translations' => FALSE, - ]; - $migration = $this->migrationPluginManager->createStubMigration($this->migrationDefinition('content_entity:file')); - $file_source = $this->sourcePluginManager->createInstance('content_entity:file', $configuration, $migration); + $migration = $this->migrationPluginManager + ->createStubMigration($this->migrationDefinition('content_entity:file', $configuration)); + $file_source = $migration->getSourcePlugin(); $this->assertSame('files', $file_source->__toString()); - $this->assertEquals(1, $file_source->count()); - $ids = $file_source->getIds(); - $this->assertArrayHasKey('fid', $ids); + if (!$configuration['include_translations']) { + $this->assertEquals(1, $file_source->count()); + } + $this->assertIds($file_source, $configuration); $fields = $file_source->fields(); $this->assertArrayHasKey('fid', $fields); $this->assertArrayHasKey('filemime', $fields); @@ -303,14 +327,16 @@ class ContentEntityTest extends KernelTestBase { /** * Tests node source plugin. + * + * @dataProvider migrationConfigurationProvider */ - public function testNodeSource() { - $migration = $this->migrationPluginManager->createStubMigration($this->migrationDefinition('content_entity:node')); - $node_source = $this->sourcePluginManager->createInstance('content_entity:node', ['bundle' => $this->bundle], $migration); + public function testNodeSource(array $configuration) { + $configuration += ['bundle' => $this->bundle]; + $migration = $this->migrationPluginManager + ->createStubMigration($this->migrationDefinition('content_entity:node', $configuration)); + $node_source = $migration->getSourcePlugin(); $this->assertSame('content items', $node_source->__toString()); - $ids = $node_source->getIds(); - $this->assertArrayHasKey('langcode', $ids); - $this->assertArrayHasKey('nid', $ids); + $this->assertIds($node_source, $configuration); $fields = $node_source->fields(); $this->assertArrayHasKey('nid', $fields); $this->assertArrayHasKey('vid', $fields); @@ -321,28 +347,42 @@ class ContentEntityTest extends KernelTestBase { $values = $node_source->current()->getSource(); $this->assertEquals($this->bundle, $values['type'][0]['target_id']); $this->assertEquals(1, $values['nid']); - $this->assertEquals(1, $values['vid']); + if ($configuration['add_revision_id']) { + $this->assertEquals(1, $values['vid']); + } + else { + $this->assertEquals([['value' => '1']], $values['vid']); + } $this->assertEquals('en', $values['langcode']); $this->assertEquals(1, $values['status'][0]['value']); $this->assertEquals('Apples', $values['title'][0]['value']); $this->assertEquals(1, $values['default_langcode'][0]['value']); $this->assertEquals(1, $values['field_entity_reference'][0]['target_id']); - $node_source->next(); - $values = $node_source->current()->getSource(); - $this->assertEquals($this->bundle, $values['type'][0]['target_id']); - $this->assertEquals(1, $values['nid']); - $this->assertEquals(1, $values['vid']); - $this->assertEquals('fr', $values['langcode']); - $this->assertEquals(1, $values['status'][0]['value']); - $this->assertEquals('Pommes', $values['title'][0]['value']); - $this->assertEquals(0, $values['default_langcode'][0]['value']); - $this->assertEquals(1, $values['field_entity_reference'][0]['target_id']); + if ($configuration['include_translations']) { + $node_source->next(); + $values = $node_source->current()->getSource(); + $this->assertEquals($this->bundle, $values['type'][0]['target_id']); + $this->assertEquals(1, $values['nid']); + if ($configuration['add_revision_id']) { + $this->assertEquals(1, $values['vid']); + } + else { + $this->assertEquals([0 => ['value' => 1]], $values['vid']); + } + $this->assertEquals('fr', $values['langcode']); + $this->assertEquals(1, $values['status'][0]['value']); + $this->assertEquals('Pommes', $values['title'][0]['value']); + $this->assertEquals(0, $values['default_langcode'][0]['value']); + $this->assertEquals(1, $values['field_entity_reference'][0]['target_id']); + } } /** * Tests media source plugin. + * + * @dataProvider migrationConfigurationProvider */ - public function testMediaSource() { + public function testMediaSource(array $configuration) { $values = [ 'id' => 'image', 'label' => 'Image', @@ -357,17 +397,17 @@ class ContentEntityTest extends KernelTestBase { ]); $media->save(); - $configuration = [ - 'include_translations' => FALSE, + $configuration += [ 'bundle' => 'image', ]; - $migration = $this->migrationPluginManager->createStubMigration($this->migrationDefinition('content_entity:media')); - $media_source = $this->sourcePluginManager->createInstance('content_entity:media', $configuration, $migration); + $migration = $this->migrationPluginManager + ->createStubMigration($this->migrationDefinition('content_entity:media', $configuration)); + $media_source = $migration->getSourcePlugin(); $this->assertSame('media items', $media_source->__toString()); - $this->assertEquals(1, $media_source->count()); - $ids = $media_source->getIds(); - $this->assertArrayHasKey('langcode', $ids); - $this->assertArrayHasKey('mid', $ids); + if (!$configuration['include_translations']) { + $this->assertEquals(1, $media_source->count()); + } + $this->assertIds($media_source, $configuration); $fields = $media_source->fields(); $this->assertArrayHasKey('bundle', $fields); $this->assertArrayHasKey('mid', $fields); @@ -377,7 +417,12 @@ class ContentEntityTest extends KernelTestBase { $media_source->rewind(); $values = $media_source->current()->getSource(); $this->assertEquals(1, $values['mid']); - $this->assertEquals(1, $values['vid']); + if ($configuration['add_revision_id']) { + $this->assertEquals(1, $values['vid']); + } + else { + $this->assertEquals([['value' => 1]], $values['vid']); + } $this->assertEquals('Foo media', $values['name'][0]['value']); $this->assertNull($values['thumbnail'][0]['title']); $this->assertEquals(1, $values['uid'][0]['target_id']); @@ -386,8 +431,10 @@ class ContentEntityTest extends KernelTestBase { /** * Tests term source plugin. + * + * @dataProvider migrationConfigurationProvider */ - public function testTermSource() { + public function testTermSource(array $configuration) { $term2 = Term::create([ 'vid' => $this->vocabulary, 'name' => 'Granny Smith', @@ -396,18 +443,17 @@ class ContentEntityTest extends KernelTestBase { ]); $term2->save(); - $configuration = [ - 'include_translations' => FALSE, + $configuration += [ 'bundle' => $this->vocabulary, ]; - $migration = $this->migrationPluginManager->createStubMigration($this->migrationDefinition('content_entity:taxonomy_term')); - $term_source = $this->sourcePluginManager->createInstance('content_entity:taxonomy_term', $configuration, $migration); + $migration = $this->migrationPluginManager + ->createStubMigration($this->migrationDefinition('content_entity:taxonomy_term', $configuration)); + $term_source = $migration->getSourcePlugin(); $this->assertSame('taxonomy terms', $term_source->__toString()); - $this->assertEquals(2, $term_source->count()); - $ids = $term_source->getIds(); - $this->assertArrayHasKey('langcode', $ids); - $this->assertArrayHasKey('revision_id', $ids); - $this->assertArrayHasKey('tid', $ids); + if (!$configuration['include_translations']) { + $this->assertEquals(2, $term_source->count()); + } + $this->assertIds($term_source, $configuration); $fields = $term_source->fields(); $this->assertArrayHasKey('vid', $fields); $this->assertArrayHasKey('revision_id', $fields); @@ -429,20 +475,46 @@ class ContentEntityTest extends KernelTestBase { $this->assertEquals('Granny Smith', $values['name'][0]['value']); } + /** + * Data provider for several test methods. + * + * @see \Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source\ContentEntityTest::testUserSource + * @see \Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source\ContentEntityTest::testFileSource + * @see \Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source\ContentEntityTest::testNodeSource + * @see \Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source\ContentEntityTest::testMediaSource + * @see \Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source\ContentEntityTest::testTermSource + */ + public function migrationConfigurationProvider() { + $data = []; + foreach ([FALSE, TRUE] as $include_translations) { + foreach ([FALSE, TRUE] as $add_revision_id) { + $configuration = [ + 'include_translations' => $include_translations, + 'add_revision_id' => $add_revision_id, + ]; + // Add an array key for this data set. + $data[http_build_query($configuration)] = [$configuration]; + } + } + return $data; + } + /** * Get a migration definition. * * @param string $plugin_id * The plugin id. + * @param array $configuration + * The plugin configuration. * * @return array * The definition. */ - protected function migrationDefinition($plugin_id) { + protected function migrationDefinition($plugin_id, array $configuration = []) { return [ 'source' => [ 'plugin' => $plugin_id, - ], + ] + $configuration, 'process' => [], 'destination' => [ 'plugin' => 'null',