You are here

Home » API reference » Entity Construction Kit (ECK) 8 » MigrateEckTestBase.php

abstract class MigrateEckTestBase in Entity Construction Kit (ECK) 8

Base class for ECK migration tests.

Hierarchy

Expanded class hierarchy of MigrateEckTestBase

1 file declares its use of MigrateEckTestBase
EckEntityExceptionTest.php in tests/src/Kernel/Plugin/migrate/source/d7/EckEntityExceptionTest.php

File

tests/src/Kernel/Migrate/d7/MigrateEckTestBase.php, line 17

Namespace

Drupal\Tests\eck\Kernel\Migrate\d7
View source 
abstract class MigrateEckTestBase extends MigrateDrupal7TestBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->entityTypeManager = \Drupal::entityTypeManager();
  }

  /**
   * Gets the path to the fixture file.
   */
  protected function getFixtureFilePath() {
    return __DIR__ . '/../../../../fixtures/drupal7.php';
  }

  /**
   * Executes all field migrations.
   */
  protected function migrateFields() {
    $this
      ->executeMigration('d7_field');
    $this
      ->migrateContentTypes();
    $this
      ->executeMigrations([
      'd7_field_instance',
    ]);
  }

  /**
   * Asserts an Eck config entity type.
   *
   * @param array $type
   *   An array of eck type information.
   *   - id: The entity type id.
   *   - label: The entity label.
   *   - langcode: The entity language code.
   */
  public function assertEckEntityType(array $type) {
    $entity = eckEntityType::load($type['id']);
    $this
      ->assertInstanceOf(eckEntityType::class, $entity);
    $this
      ->assertSame($type['label'], $entity
      ->label());
    $this
      ->assertSame($type['langcode'], $entity
      ->language()
      ->getId());
  }

  /**
   * Asserts an Eck bundle config entity.
   *
   * @param array $bundle
   *   An array of eck bundle information.
   *   - id: The entity type id.
   *   - label: The entity label.
   *   - description: The entity description.
   *   - langcode: The entity language code.
   */
  public function assertEckBundle(array $bundle) {
    $entity = eckEntityBundle::load($bundle['type']);
    $this
      ->assertInstanceOf(eckEntityBundle::class, $entity);
    $this
      ->assertSame($bundle['name'], $entity->name);
    $this
      ->assertSame($bundle['description'], $entity->description);
    $this
      ->assertSame($bundle['langcode'], $entity
      ->language()
      ->getId());
  }

  /**
   * Asserts an Eck entity.
   *
   * @param array $eck
   *   An array of eck information.
   *   - id: The entity id.
   *   - label: The entity label.
   *   - langcode: The entity language code.
   *   - fields: An array of field names and field values.
   */
  public function assertEck(array $eck) {
    $message = "Failure for eck entity type '" . $eck['type'] . "' with id of '" . $eck['id'] . "'";

    /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
    $entity = $this->entityTypeManager
      ->getStorage($eck['type'])
      ->load($eck['id']);
    $this
      ->assertInstanceOf(EckEntity::class, $entity, $message);
    $this
      ->assertSame($eck['label'], $entity
      ->label(), $message);
    $this
      ->assertSame($eck['bundle'], $entity
      ->bundle(), $message);
    $this
      ->assertSame($eck['langcode'], $entity
      ->language()
      ->getId(), $message);
    foreach ($eck['fields'] as $name => $value) {
      $this
        ->assertSame($value, $entity
        ->get($name)
        ->getValue(), $message);
    }

    // Verify translations.
    if (!empty($eck['translations'])) {
      foreach ($eck['translations'] as $language => $translation_data) {
        $this
          ->assertTrue($entity
          ->hasTranslation($language));
        $translation = $entity
          ->getTranslation($language);
        foreach ($translation_data['fields'] as $name => $value) {
          $this
            ->assertSame($value, $translation
            ->get($name)
            ->getValue(), $message);
        }
      }
    }
  }

  /**
   * Asserts various aspects of a field_storage_config entity.
   *
   * @param string $id
   *   The entity ID in the form ENTITY_TYPE.FIELD_NAME.
   * @param string $expected_type
   *   The expected field type.
   * @param bool $expected_translatable
   *   Whether or not the field is expected to be translatable.
   * @param int $expected_cardinality
   *   The expected cardinality of the field.
   */
  protected function assertFieldStorage($id, $expected_type, $expected_translatable, $expected_cardinality) {
    list($expected_entity_type, $expected_name) = explode('.', $id);

    /** @var \Drupal\field\FieldStorageConfigInterface $field */
    $field = FieldStorageConfig::load($id);
    $this
      ->assertInstanceOf(FieldStorageConfigInterface::class, $field);
    $this
      ->assertEquals($expected_name, $field
      ->getName());
    $this
      ->assertEquals($expected_type, $field
      ->getType());
    $this
      ->assertEquals($expected_translatable, $field
      ->isTranslatable());
    $this
      ->assertEquals($expected_entity_type, $field
      ->getTargetEntityTypeId());
    if ($expected_cardinality === 1) {
      $this
        ->assertFalse($field
        ->isMultiple());
    }
    else {
      $this
        ->assertTrue($field
        ->isMultiple());
    }
    $this
      ->assertEquals($expected_cardinality, $field
      ->getCardinality());
  }

  /**
   * Asserts various aspects of a field config entity.
   *
   * @param string $id
   *   The entity ID in the form ENTITY_TYPE.BUNDLE.FIELD_NAME.
   * @param string $expected_label
   *   The expected field label.
   * @param string $expected_field_type
   *   The expected field type.
   * @param bool $is_required
   *   Whether or not the field is required.
   * @param bool $expected_translatable
   *   Whether or not the field is expected to be translatable.
   */
  protected function assertFieldInstance($id, $expected_label, $expected_field_type, $is_required, $expected_translatable) {
    list($expected_entity_type, $expected_bundle, $expected_name) = explode('.', $id);

    /** @var \Drupal\field\FieldConfigInterface $field */
    $field = FieldConfig::load($id);
    $this
      ->assertInstanceOf(FieldConfigInterface::class, $field);
    $this
      ->assertEquals($expected_label, $field
      ->label());
    $this
      ->assertEquals($expected_field_type, $field
      ->getType());
    $this
      ->assertEquals($expected_entity_type, $field
      ->getTargetEntityTypeId());
    $this
      ->assertEquals($expected_bundle, $field
      ->getTargetBundle());
    $this
      ->assertEquals($expected_name, $field
      ->getName());
    $this
      ->assertEquals($is_required, $field
      ->isRequired());
    $this
      ->assertEquals($expected_entity_type . '.' . $expected_name, $field
      ->getFieldStorageDefinition()
      ->id());
    $this
      ->assertEquals($expected_translatable, $field
      ->isTranslatable());
  }

}

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::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.
MigrateDrupal7TestBase::migrateCommentTypes protected function Migrates comment types.
MigrateDrupal7TestBase::migrateContent protected function Executes all content migrations.
MigrateDrupal7TestBase::migrateContentTypes protected function Migrates node types.
MigrateDrupal7TestBase::migrateTaxonomyTerms protected function Executes all taxonomy term migrations.
MigrateDrupal7TestBase::migrateUsers protected function Executes all user migrations.
MigrateDrupalTestBase::$modules public static property Modules to enable. Overrides MigrateTestBase::$modules 105
MigrateDrupalTestBase::loadFixture protected function Loads a database fixture into the source database connection.
MigrateEckTestBase::$entityTypeManager protected property The entity type manager.
MigrateEckTestBase::assertEck public function Asserts an Eck entity.
MigrateEckTestBase::assertEckBundle public function Asserts an Eck bundle config entity.
MigrateEckTestBase::assertEckEntityType public function Asserts an Eck config entity type.
MigrateEckTestBase::assertFieldInstance protected function Asserts various aspects of a field config entity.
MigrateEckTestBase::assertFieldStorage protected function Asserts various aspects of a field_storage_config entity.
MigrateEckTestBase::getFixtureFilePath protected function Gets the path to the fixture file. Overrides MigrateDrupal7TestBase::getFixtureFilePath
MigrateEckTestBase::migrateFields protected function Executes all field migrations. Overrides MigrateDrupal7TestBase::migrateFields
MigrateEckTestBase::setUp protected function Overrides MigrateDrupal7TestBase::setUp 6
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
NodeMigrateTypeTestTrait::$tableName public property The migrate_map table name.
NodeMigrateTypeTestTrait::getTableName protected function Gets the migrate_map table name.
NodeMigrateTypeTestTrait::makeNodeMigrateMapTable protected function Create a node migrate_map table.
NodeMigrateTypeTestTrait::nodeMigrateMapTableCount protected function Gets the numbers of complete and classic node migrate_map tables.
NodeMigrateTypeTestTrait::removeNodeMigrateMapTable protected function Remove the node migrate map table.
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.