class MigrateEntityContentBaseTest in Drupal 10

Tests the EntityContentBase destination.

@group migrate

Hierarchy

• class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, ConfigTestTrait, ExtensionListTestTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
  • class \Drupal\Tests\migrate\Kernel\MigrateEntityContentBaseTest

File

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

Namespace

Drupal\Tests\migrate\Kernel

class MigrateEntityContentBaseTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'migrate',
    'user',
    'language',
    'entity_test',
  ];

  /**
   * The storage for entity_test_mul.
   *
   * @var \Drupal\Core\Entity\ContentEntityStorageInterface
   */
  protected $storage;

  /**
   * A content migrate destination.
   *
   * @var \Drupal\migrate\Plugin\MigrateDestinationInterface
   */
  protected $destination;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Enable two required fields with default values: a single-value field and
    // a multi-value field.
    \Drupal::state()
      ->set('entity_test.required_default_field', TRUE);
    \Drupal::state()
      ->set('entity_test.required_multi_default_field', TRUE);
    $this
      ->installEntitySchema('entity_test_mul');
    ConfigurableLanguage::createFromLangcode('en')
      ->save();
    ConfigurableLanguage::createFromLangcode('fr')
      ->save();
    $this->storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('entity_test_mul');
  }

  /**
   * Check the existing translations of an entity.
   *
   * @param int $id
   *   The entity ID.
   * @param string $default
   *   The expected default translation language code.
   * @param string[] $others
   *   The expected other translation language codes.
   *
   * @internal
   */
  protected function assertTranslations(int $id, string $default, array $others = []) : void {
    $entity = $this->storage
      ->load($id);
    $this
      ->assertNotEmpty($entity, "Entity exists");
    $this
      ->assertEquals($default, $entity
      ->language()
      ->getId(), "Entity default translation");
    $translations = array_keys($entity
      ->getTranslationLanguages(FALSE));
    sort($others);
    sort($translations);
    $this
      ->assertEquals($others, $translations, "Entity translations");
  }

  /**
   * Create the destination plugin to test.
   *
   * @param array $configuration
   *   The plugin configuration.
   */
  protected function createDestination(array $configuration) {
    $this->destination = new EntityContentBase($configuration, 'fake_plugin_id', [], $this
      ->createMock(MigrationInterface::class), $this->storage, [], $this->container
      ->get('entity_field.manager'), $this->container
      ->get('plugin.manager.field.field_type'), $this->container
      ->get('account_switcher'));
  }

  /**
   * Tests importing and rolling back translated entities.
   */
  public function testTranslated() {

    // Create a destination.
    $this
      ->createDestination([
      'translations' => TRUE,
    ]);

    // Create some pre-existing entities.
    $this->storage
      ->create([
      'id' => 1,
      'langcode' => 'en',
    ])
      ->save();
    $this->storage
      ->create([
      'id' => 2,
      'langcode' => 'fr',
    ])
      ->save();
    $translated = $this->storage
      ->create([
      'id' => 3,
      'langcode' => 'en',
    ]);
    $translated
      ->save();
    $translated
      ->addTranslation('fr')
      ->save();

    // Pre-assert that things are as expected.
    $this
      ->assertTranslations(1, 'en');
    $this
      ->assertTranslations(2, 'fr');
    $this
      ->assertTranslations(3, 'en', [
      'fr',
    ]);
    $this
      ->assertNull($this->storage
      ->load(4));
    $destination_rows = [
      // Existing default translation.
      [
        'id' => 1,
        'langcode' => 'en',
        'action' => MigrateIdMapInterface::ROLLBACK_PRESERVE,
      ],
      // New translation.
      [
        'id' => 2,
        'langcode' => 'en',
        'action' => MigrateIdMapInterface::ROLLBACK_DELETE,
      ],
      // Existing non-default translation.
      [
        'id' => 3,
        'langcode' => 'fr',
        'action' => MigrateIdMapInterface::ROLLBACK_PRESERVE,
      ],
      // Brand new row.
      [
        'id' => 4,
        'langcode' => 'fr',
        'action' => MigrateIdMapInterface::ROLLBACK_DELETE,
      ],
    ];
    $rollback_actions = [];

    // Import some rows.
    foreach ($destination_rows as $idx => $destination_row) {
      $row = new Row();
      foreach ($destination_row as $key => $value) {
        $row
          ->setDestinationProperty($key, $value);
      }
      $this->destination
        ->import($row);

      // Check that the rollback action is correct, and save it.
      $this
        ->assertEquals($destination_row['action'], $this->destination
        ->rollbackAction());
      $rollback_actions[$idx] = $this->destination
        ->rollbackAction();
    }
    $this
      ->assertTranslations(1, 'en');
    $this
      ->assertTranslations(2, 'fr', [
      'en',
    ]);
    $this
      ->assertTranslations(3, 'en', [
      'fr',
    ]);
    $this
      ->assertTranslations(4, 'fr');

    // Rollback the rows.
    foreach ($destination_rows as $idx => $destination_row) {
      if ($rollback_actions[$idx] == MigrateIdMapInterface::ROLLBACK_DELETE) {
        $this->destination
          ->rollback($destination_row);
      }
    }

    // No change, update of existing translation.
    $this
      ->assertTranslations(1, 'en');

    // Remove added translation.
    $this
      ->assertTranslations(2, 'fr');

    // No change, update of existing translation.
    $this
      ->assertTranslations(3, 'en', [
      'fr',
    ]);

    // No change, can't remove default translation.
    $this
      ->assertTranslations(4, 'fr');
  }

  /**
   * Tests creation of ID columns table with definitions taken from entity type.
   */
  public function testEntityWithStringId() {
    $this
      ->enableModules([
      'migrate_entity_test',
    ]);
    $this
      ->installEntitySchema('migrate_string_id_entity_test');
    $definition = [
      'source' => [
        'plugin' => 'embedded_data',
        'data_rows' => [
          [
            'id' => 123,
            'version' => 'foo',
          ],
          // This integer needs an 'int' schema with 'big' size. If 'destid1'
          // is not correctly taking the definition from the destination entity
          // type, the import will fail with a SQL exception.
          [
            'id' => 123456789012,
            'version' => 'bar',
          ],
        ],
        'ids' => [
          'id' => [
            'type' => 'integer',
            'size' => 'big',
          ],
          'version' => [
            'type' => 'string',
          ],
        ],
      ],
      'process' => [
        'id' => 'id',
        'version' => 'version',
      ],
      'destination' => [
        'plugin' => 'entity:migrate_string_id_entity_test',
      ],
    ];
    $migration = \Drupal::service('plugin.manager.migration')
      ->createStubMigration($definition);
    $executable = new MigrateExecutable($migration);
    $result = $executable
      ->import();
    $this
      ->assertEquals(MigrationInterface::RESULT_COMPLETED, $result);

    /** @var \Drupal\migrate\Plugin\MigrateIdMapInterface $id_map_plugin */
    $id_map_plugin = $migration
      ->getIdMap();

    // Check that the destination has been stored.
    $map_row = $id_map_plugin
      ->getRowBySource([
      'id' => 123,
      'version' => 'foo',
    ]);
    $this
      ->assertEquals(123, $map_row['destid1']);
    $map_row = $id_map_plugin
      ->getRowBySource([
      'id' => 123456789012,
      'version' => 'bar',
    ]);
    $this
      ->assertEquals(123456789012, $map_row['destid1']);
  }

  /**
   * Tests empty destinations.
   */
  public function testEmptyDestinations() {
    $this
      ->enableModules([
      'migrate_entity_test',
    ]);
    $this
      ->installEntitySchema('migrate_string_id_entity_test');
    $definition = [
      'source' => [
        'plugin' => 'embedded_data',
        'data_rows' => [
          [
            'id' => 123,
            'version' => 'foo',
          ],
          // This integer needs an 'int' schema with 'big' size. If 'destid1'
          // is not correctly taking the definition from the destination entity
          // type, the import will fail with an SQL exception.
          [
            'id' => 123456789012,
            'version' => 'bar',
          ],
        ],
        'ids' => [
          'id' => [
            'type' => 'integer',
            'size' => 'big',
          ],
          'version' => [
            'type' => 'string',
          ],
        ],
        'constants' => [
          'null' => NULL,
        ],
      ],
      'process' => [
        'id' => 'id',
        'version' => 'version',
      ],
      'destination' => [
        'plugin' => 'entity:migrate_string_id_entity_test',
      ],
    ];
    $migration = \Drupal::service('plugin.manager.migration')
      ->createStubMigration($definition);
    $executable = new MigrateExecutable($migration);
    $executable
      ->import();

    /** @var \Drupal\migrate_entity_test\Entity\StringIdEntityTest $entity */
    $entity = StringIdEntityTest::load('123');
    $this
      ->assertSame('foo', $entity->version->value);
    $entity = StringIdEntityTest::load('123456789012');
    $this
      ->assertSame('bar', $entity->version->value);

    // Rerun the migration forcing the version to NULL.
    $definition['process'] = [
      'id' => 'id',
      'version' => 'constants/null',
    ];
    $migration = \Drupal::service('plugin.manager.migration')
      ->createStubMigration($definition);
    $executable = new MigrateExecutable($migration);
    $executable
      ->import();

    /** @var \Drupal\migrate_entity_test\Entity\StringIdEntityTest $entity */
    $entity = StringIdEntityTest::load('123');
    $this
      ->assertNull($entity->version->value);
    $entity = StringIdEntityTest::load('123456789012');
    $this
      ->assertNull($entity->version->value);
  }

  /**
   * Tests stub rows.
   */
  public function testStubRows() {

    // Create a destination.
    $this
      ->createDestination([]);

    // Import a stub row.
    $row = new Row([], [], TRUE);
    $row
      ->setDestinationProperty('type', 'test');
    $ids = $this->destination
      ->import($row);
    $this
      ->assertCount(1, $ids);

    // Make sure the entity was saved.
    $entity = EntityTestMul::load(reset($ids));
    $this
      ->assertInstanceOf(EntityTestMul::class, $entity);

    // Make sure the default value was applied to the required fields.
    $single_field_name = 'required_default_field';
    $single_default_value = $entity
      ->getFieldDefinition($single_field_name)
      ->getDefaultValueLiteral();
    $this
      ->assertSame($single_default_value, $entity
      ->get($single_field_name)
      ->getValue());
    $multi_field_name = 'required_multi_default_field';
    $multi_default_value = $entity
      ->getFieldDefinition($multi_field_name)
      ->getDefaultValueLiteral();
    $count = 3;
    $this
      ->assertCount($count, $multi_default_value);
    for ($i = 0; $i < $count; ++$i) {
      $this
        ->assertSame($multi_default_value[$i], $entity
        ->get($multi_field_name)
        ->get($i)
        ->getValue());
    }
  }

}