You are here

Home » API reference » Media Migration 8 » MediaMigrationFormatterWidgetTest.php

class MediaMigrationFormatterWidgetTest in Media Migration 8

Tests widgets and formatters.

@group media_migration

Hierarchy

Expanded class hierarchy of MediaMigrationFormatterWidgetTest

File

tests/src/Kernel/Migrate/MediaMigrationFormatterWidgetTest.php, line 14

Namespace

Drupal\Tests\media_migration\Kernel\Migrate
View source 
class MediaMigrationFormatterWidgetTest extends MediaMigrationTestBase {
  use MediaMigrationAssertionsForMediaSourceTrait;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'comment',
    'datetime',
    'datetime_range',
    'editor',
    'embed',
    'entity_embed',
    'field',
    'file',
    'filter',
    'image',
    'link',
    'media',
    'media_migration',
    'media_migration_test_oembed',
    'menu_ui',
    'migrate',
    'migrate_drupal',
    'migrate_plus',
    'node',
    'options',
    'smart_sql_idmap',
    'system',
    'taxonomy',
    'telephone',
    'text',
    'user',
  ];

  /**
   * Tests media widgets' and formatters' migration without Media Library.
   *
   * @dataProvider providerTestCases
   */
  public function testWidgetsAndFormattersWithoutMediaLibrary(bool $classic_node_migration) {
    $this
      ->createStandardMediaTypes();
    $this
      ->setClassicNodeMigration($classic_node_migration);

    // Execute the media migrations.
    $this
      ->executeMediaMigrations($classic_node_migration);
    $media_fields = [
      'field_image' => [
        'form' => 'image_image',
        'view' => 'entity_reference_entity_view',
      ],
      'field_media' => [
        'form' => 'file_generic',
        'view' => 'entity_reference_entity_view',
      ],
    ];
    $entity_type_manager = $this->container
      ->get('entity_type.manager');
    assert($entity_type_manager instanceof EntityTypeManagerInterface);

    // Check default widget configurations. Every field widget should use.
    foreach ($media_fields as $field_name => $expected_config) {
      $entity_form_display = $entity_type_manager
        ->getStorage('entity_form_display')
        ->load(implode('.', [
        'node',
        'article',
        'default',
      ]));
      $entity_form_display_array = $entity_form_display
        ->toArray();
      $content = $entity_form_display_array['content'];
      $this
        ->assertTrue(array_key_exists($field_name, $content));
      $this
        ->assertEquals($expected_config['form'], $content[$field_name]['type']);
    }

    // Check default formatter configurations.
    foreach ($media_fields as $field_name => $expected_config) {
      $entity_form_display = $entity_type_manager
        ->getStorage('entity_view_display')
        ->load(implode('.', [
        'node',
        'article',
        'default',
      ]));
      $entity_form_display_array = $entity_form_display
        ->toArray();
      $content = $entity_form_display_array['content'];
      $this
        ->assertTrue(array_key_exists($field_name, $content));
      $this
        ->assertEquals($expected_config['view'], $content[$field_name]['type']);
    }
    $this
      ->assertMediaTypeDisplayModes();
  }

  /**
   * Tests media widgets' and formatters' migration with Media Library.
   *
   * @dataProvider providerTestCases
   */
  public function testWidgetsAndFormattersWithMediaLibrary(bool $classic_node_migration) {
    $this
      ->createStandardMediaTypes();
    $this
      ->setClassicNodeMigration($classic_node_migration);
    $installer = $this->container
      ->get('module_installer');
    assert($installer instanceof ModuleInstallerInterface);
    $installer
      ->install([
      'media_library',
    ]);

    // Execute the media migrations.
    $this
      ->executeMediaMigrations($classic_node_migration);
    $media_fields = [
      'field_image' => [
        'form' => 'media_library_widget',
        'view' => 'entity_reference_entity_view',
      ],
      'field_media' => [
        'form' => 'media_library_widget',
        'view' => 'entity_reference_entity_view',
      ],
    ];
    $entity_type_manager = $this->container
      ->get('entity_type.manager');
    assert($entity_type_manager instanceof EntityTypeManagerInterface);

    // Check default widget configurations. Every field widget should use.
    foreach ($media_fields as $field_name => $expected_config) {
      $entity_form_display = $entity_type_manager
        ->getStorage('entity_form_display')
        ->load(implode('.', [
        'node',
        'article',
        'default',
      ]));
      $entity_form_display_array = $entity_form_display
        ->toArray();
      $content = $entity_form_display_array['content'];
      $this
        ->assertTrue(array_key_exists($field_name, $content));
      $this
        ->assertEquals($expected_config['form'], $content[$field_name]['type']);
    }

    // Check default formatter configurations.
    foreach ($media_fields as $field_name => $expected_config) {
      $entity_form_display = $entity_type_manager
        ->getStorage('entity_view_display')
        ->load(implode('.', [
        'node',
        'article',
        'default',
      ]));
      $entity_form_display_array = $entity_form_display
        ->toArray();
      $content = $entity_form_display_array['content'];
      $this
        ->assertTrue(array_key_exists($field_name, $content));
      $this
        ->assertEquals($expected_config['view'], $content[$field_name]['type']);
    }
    $this
      ->assertMediaTypeDisplayModes();
  }

  /**
   * Tests display configuration of the migrated media types.
   */
  public function assertMediaTypeDisplayModes() {
    $this
      ->assertMediaAudioDisplayModes();
    $this
      ->assertMediaDocumentDisplayModes();
    $this
      ->assertMediaImageDisplayModes(TRUE);
    $this
      ->assertMediaRemoteVideoDisplayModes();
    $this
      ->assertMediaVideoDisplayModes();
  }

  /**
   * Data provider for ::testMediaTokenToMediaEmbedTransform().
   *
   * @return array
   *   The test cases.
   */
  public function providerTestCases() {
    $test_cases = [
      'Classic node migration' => [
        'Classic node migration' => TRUE,
      ],
      'Complete node migration' => [
        'Classic node migration' => FALSE,
      ],
    ];

    // Drupal 8.8.x only has 'classic' node migrations.
    // @see https://www.drupal.org/node/3105503
    if (version_compare(\Drupal::VERSION, '8.9', '<')) {
      $test_cases = array_filter($test_cases, function ($test_case) {
        return $test_case['Classic node migration'];
      });
    }
    return $test_cases;
  }

}

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.
MediaMigrationAssertionsBaseTrait::$mediaUnconcernedProperties protected property List of media properties whose value shouldn't have to be checked.
MediaMigrationAssertionsBaseTrait::$migrationUnconcernedProperties protected property List of migration conf properties whose value shouldn't have to be checked.
MediaMigrationAssertionsBaseTrait::$nodeUnconcernedProperties protected property List of node properties whose value shouldn't have to be checked.
MediaMigrationAssertionsBaseTrait::assertArticleBodyFieldMigrationProcesses protected function Tests the processes of the body field of the given article migration.
MediaMigrationAssertionsBaseTrait::assertEmbedTokenHtmlTags protected function Assert that embed HTML tags exist in the given text.
MediaMigrationAssertionsBaseTrait::assertMediaAudioDisplayModes protected function Tests media audio's default form and view mode configuration.
MediaMigrationAssertionsBaseTrait::assertMediaDocumentDisplayModes protected function Tests media documents's default form and view mode configuration.
MediaMigrationAssertionsBaseTrait::assertMediaFieldsAllowedTypes protected function Tests the allowed media types of a media reference field.
MediaMigrationAssertionsBaseTrait::assertMediaImageDisplayModes protected function Tests media image's default form and view mode configuration.
MediaMigrationAssertionsBaseTrait::assertMediaRemoteVideoDisplayModes protected function Tests media remote_video's default form and view mode configuration.
MediaMigrationAssertionsBaseTrait::assertMediaVideoDisplayModes protected function Tests media video's default form and view mode configuration.
MediaMigrationAssertionsBaseTrait::getImportantEntityProperties protected function Filters out unconcerned properties from an entity.
MediaMigrationAssertionsBaseTrait::getReferencedEntities protected function Get the referred entities.
MediaMigrationAssertionsForMediaSourceTrait::assertArticleImageFieldsAllowedTypes protected function Tests article's "field_image" media reference field's allowed media types.
MediaMigrationAssertionsForMediaSourceTrait::assertArticleMediaFieldsAllowedTypes protected function Tests article's "field_media" media reference field's allowed media types.
MediaMigrationAssertionsForMediaSourceTrait::assertFilterFormats protected function Tests the migrated filter formats.
MediaMigrationAssertionsForMediaSourceTrait::assertMedia10FieldValues protected function Assertions of media 10 ("yellow.webp").
MediaMigrationAssertionsForMediaSourceTrait::assertMedia11FieldValues protected function Assertions of media 11 ("audio.m4a").
MediaMigrationAssertionsForMediaSourceTrait::assertMedia12FieldValues protected function Assertions of media 12 ("document.odt").
MediaMigrationAssertionsForMediaSourceTrait::assertMedia1FieldValues protected function Assertions of media 1.
MediaMigrationAssertionsForMediaSourceTrait::assertMedia2FieldValues protected function Assertions of media 2.
MediaMigrationAssertionsForMediaSourceTrait::assertMedia3FieldValues protected function Assertions of media 3.
MediaMigrationAssertionsForMediaSourceTrait::assertMedia4FieldValues protected function Assertions of media 4 (Youtube Apqd4ff0NRI – 2019 Amsterdam Driesnote).
MediaMigrationAssertionsForMediaSourceTrait::assertMedia5FieldValues protected function Assertions of media 5 (Vimeo 204517230 – Responsive Images).
MediaMigrationAssertionsForMediaSourceTrait::assertMedia6FieldValues protected function Assertions of media 6 (LICENSE.txt).
MediaMigrationAssertionsForMediaSourceTrait::assertMedia7FieldValues protected function Assertions of media 7.
MediaMigrationAssertionsForMediaSourceTrait::assertMedia8FieldValues protected function Assertions of media 8 ("video.webm").
MediaMigrationAssertionsForMediaSourceTrait::assertMedia9FieldValues protected function Assertions of media 9 ("video.mp4").
MediaMigrationAssertionsForMediaSourceTrait::assertNode1FieldValues protected function Assertions of node 1.
MediaMigrationFormatterWidgetTest::$modules public static property Modules to enable. Overrides MigrateDrupalTestBase::$modules
MediaMigrationFormatterWidgetTest::assertMediaTypeDisplayModes public function Tests display configuration of the migrated media types.
MediaMigrationFormatterWidgetTest::providerTestCases public function Data provider for ::testMediaTokenToMediaEmbedTransform().
MediaMigrationFormatterWidgetTest::testWidgetsAndFormattersWithMediaLibrary public function Tests media widgets' and formatters' migration with Media Library.
MediaMigrationFormatterWidgetTest::testWidgetsAndFormattersWithoutMediaLibrary public function Tests media widgets' and formatters' migration without Media Library.
MediaMigrationTestBase::$profile protected property
MediaMigrationTestBase::executeMediaConfigurationMigrations protected function Executes the media configuration migrations (types, fields etc).
MediaMigrationTestBase::executeMediaMigrations protected function Executes migrations of the media source database. 1
MediaMigrationTestBase::loadFixture protected function Loads a database fixture into the source database connection. Overrides MigrateDrupalTestBase::loadFixture
MediaMigrationTestBase::setClassicNodeMigration protected function Sets the type of the node migration.
MediaMigrationTestBase::setEmbedMediaReferenceMethod protected function Sets the method of the embed media reference.
MediaMigrationTestBase::setEmbedTokenDestinationFilterPlugin protected function Changes the entity embed token transform destination filter plugin.
MediaMigrationTestBase::setUp public function Overrides MigrateDrupalTestBase::setUp
MediaMigrationTestTrait::createStandardMediaTypes protected function Creates the media types which are shipped with the core standard profile.
MediaMigrationTestTrait::getFixtureFilePath protected function Returns the path to the Drupal 7 migration database fixture. 3
MediaTypeCreationTrait::createMediaType protected function Create a media type for a source plugin.
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
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.