You are here

Home » API reference » Drupal 8 » MigrateEntityContentBaseTest.php

class MigrateEntityContentBaseTest in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/migrate/tests/src/Kernel/MigrateEntityContentBaseTest.php \Drupal\Tests\migrate\Kernel\MigrateEntityContentBaseTest

Tests the EntityContentBase destination.

@group migrate

Hierarchy

Expanded class hierarchy of MigrateEntityContentBaseTest

File

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

Namespace

Drupal\Tests\migrate\Kernel
View source 
class MigrateEntityContentBaseTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public 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() {
    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.
   */
  protected function assertTranslations($id, $default, $others = []) {
    $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'));
  }

  /**
   * Test 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());
    }
  }

}

Members

Namesort descending Modifiers Type Description 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 Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
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.
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::tearDown protected function 6
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.
MigrateEntityContentBaseTest::$destination protected property A content migrate destination.
MigrateEntityContentBaseTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
MigrateEntityContentBaseTest::$storage protected property The storage for entity_test_mul.
MigrateEntityContentBaseTest::assertTranslations protected function Check the existing translations of an entity.
MigrateEntityContentBaseTest::createDestination protected function Create the destination plugin to test.
MigrateEntityContentBaseTest::setUp protected function Overrides KernelTestBase::setUp
MigrateEntityContentBaseTest::testEmptyDestinations public function Tests empty destinations.
MigrateEntityContentBaseTest::testEntityWithStringId public function Tests creation of ID columns table with definitions taken from entity type.
MigrateEntityContentBaseTest::testStubRows public function Tests stub rows.
MigrateEntityContentBaseTest::testTranslated public function Test importing and rolling back translated entities.
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.