You are here

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

abstract class MigrateMediaTestBase in Media Migration 8

Provides a base class for testing media migration via the UI.

Hierarchy

Expanded class hierarchy of MigrateMediaTestBase

File

tests/src/Functional/MigrateMediaTestBase.php, line 21

Namespace

Drupal\Tests\media_migration\Functional
View source 
abstract class MigrateMediaTestBase extends MigrateUpgradeTestBase {
  use StringTranslationTrait;
  use MediaMigrationTestTrait;
  use MediaMigrationAssertionsForMediaSourceTrait;

  /**
   * The method how embed code should reference media entities.
   *
   * This might be 'id', or 'uuid'.
   *
   * @var string|null
   */
  protected $embedMediaReferenceMethod;

  /**
   * The destination filter plugin ID to target on entity embed token transform.
   *
   * If this is not null, then the corresponding "$settings" key is written into
   * the settings.php file.
   *
   * @var string|null
   */
  protected $embedTokenDestinationFilterPlugin;

  /**
   * The destination site major version.
   *
   * @var string
   */
  protected $destinationSiteVersion;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'image',
    'media',
    'media_migration',
    'media_migration_test_oembed',
    'migrate_drupal_ui',
    'node',
  ];

  /**
   * {@inheritdoc}
   */
  protected function getSourceBasePath() {
    return drupal_get_path('module', 'media_migration') . '/tests/fixtures';
  }

  /**
   * {@inheritdoc}
   */
  protected function getSourcePrivateFilesPath() {
    return $this
      ->getSourceBasePath();
  }

  /**
   * Returns IDs or labels of those entities that shouldn't be checked.
   *
   * @return string[][]
   *   An array of expected entity labels keyed by IDs, grouped by entity type
   *   ID. For some of the entities, label can be NULL.
   */
  protected function getIgnoredEntities() {
    return [
      'file' => [
        'audio.png',
        'generic.png',
        'video.png',
      ],
    ];
  }

  /**
   * Gets the expected entity IDs and labels per entity type after migration.
   *
   * @return string|null[][]
   *   An array of expected entity labels keyed by IDs, grouped by entity type
   *   ID. For some of the entities, label can be NULL.
   */
  protected function getExpectedEntities() {
    $expected_entities = [
      'editor' => [
        'basic_html' => 'Basic HTML',
        'full_html' => 'Full HTML',
      ],
      'entity_form_display' => [
        'block_content.basic.default' => NULL,
        'comment.comment.default' => NULL,
        'comment.comment_node_article.default' => NULL,
        'comment.comment_node_page.default' => NULL,
        'media.audio.default' => NULL,
        'media.document.default' => NULL,
        'media.image.default' => NULL,
        'media.remote_video.default' => NULL,
        'media.video.default' => NULL,
        'node.article.default' => NULL,
        'node.page.default' => NULL,
        'user.user.default' => NULL,
      ],
      'entity_form_mode' => [
        'user.register' => 'Register',
      ],
      'entity_view_display' => [
        'block_content.basic.default' => NULL,
        'comment.comment.default' => NULL,
        'comment.comment_node_article.default' => NULL,
        'comment.comment_node_page.default' => NULL,
        'media.audio.default' => NULL,
        'media.document.default' => NULL,
        'media.image.default' => NULL,
        'media.remote_video.default' => NULL,
        'media.video.default' => NULL,
        'node.article.default' => NULL,
        'node.article.teaser' => NULL,
        'node.page.default' => NULL,
        'node.page.teaser' => NULL,
        'user.user.compact' => NULL,
        'user.user.default' => NULL,
      ],
      'entity_view_mode' => [
        'block_content.full' => 'Full',
        'comment.full' => 'Full',
        'media.full' => 'Full',
        'media.preview' => 'preview',
        'media.rss' => 'RSS',
        'media.search_index' => 'Search index',
        'media.search_result' => 'Search result',
        'media.teaser' => 'Teaser',
        'media.wysiwyg' => 'WYSIWYG',
        'node.full' => 'Full',
        'node.rss' => 'RSS',
        'node.search_index' => 'Search index',
        'node.search_result' => 'Search result highlighting input',
        'node.teaser' => 'Teaser',
        'taxonomy_term.full' => 'Taxonomy term page',
        'user.compact' => 'Compact',
        'user.full' => 'User account',
      ],
      'field_config' => [
        'block_content.basic.body' => 'Body',
        'comment.comment.comment_body' => 'Comment',
        'comment.comment_node_article.comment_body' => 'Comment',
        'comment.comment_node_page.comment_body' => 'Comment',
        'media.audio.field_media_audio_file' => 'Audio file',
        'media.document.field_media_document' => 'Document',
        'media.image.field_media_image' => 'Image',
        'media.image.field_media_integer' => 'Integer',
        'media.remote_video.field_media_oembed_video' => 'Video URL',
        'media.video.field_media_video_file' => 'Video file',
        'node.article.body' => 'Body',
        'node.article.comment_node_article' => 'Comments',
        'node.article.field_image' => 'Image',
        'node.article.field_media' => 'Media',
        'node.page.body' => 'Body',
        'node.page.comment_node_page' => 'Comments',
        'user.user.user_picture' => 'Picture',
      ],
      'field_storage_config' => [
        'block_content.body' => 'block_content.body',
        'comment.comment_body' => 'comment.comment_body',
        'media.field_media_audio_file' => 'media.field_media_audio_file',
        'media.field_media_document' => 'media.field_media_document',
        'media.field_media_image' => 'media.field_media_image',
        'media.field_media_integer' => 'media.field_media_integer',
        'media.field_media_oembed_video' => 'media.field_media_oembed_video',
        'media.field_media_video_file' => 'media.field_media_video_file',
        'node.body' => 'node.body',
        'node.comment_node_article' => 'node.comment_node_article',
        'node.comment_node_page' => 'node.comment_node_page',
        'node.field_image' => 'node.field_image',
        'node.field_media' => 'node.field_media',
        'user.user_picture' => 'user.user_picture',
      ],
      'filter_format' => [
        'basic_html' => 'Basic HTML',
        'full_html' => 'Full HTML',
        'plain_text' => 'Plain text',
        'restricted_html' => 'Restricted HTML',
        'filtered_html' => 'Filtered HTML',
      ],
      'image_style' => [
        'large' => 'Large (480×480)',
        'medium' => 'Medium (220×220)',
        'thumbnail' => 'Thumbnail (100×100)',
      ],
      'media_type' => [
        'audio' => 'Audio',
        'document' => 'Document',
        'image' => 'Image',
        'remote_video' => 'Remote video',
        'video' => 'Video',
      ],
      'media' => [
        1 => 'Blue PNG',
        2 => 'green.jpg',
        3 => 'red.jpeg',
        4 => 'DrupalCon Amsterdam 2019: Keynote - Driesnote',
        5 => 'Responsive Images in Drupal 8',
        6 => 'LICENSE.txt',
        7 => 'yellow.jpg',
        8 => 'video.webm',
        9 => 'video.mp4',
        10 => 'yellow.webp',
        11 => 'audio.m4a',
        12 => 'document.odt',
      ],
      'file' => [
        1 => 'Blue PNG',
        2 => 'green.jpg',
        3 => 'red.jpeg',
        6 => 'LICENSE.txt',
        7 => 'yellow.jpg',
        8 => 'video.webm',
        9 => 'video.mp4',
        10 => 'yellow.webp',
        11 => 'audio.m4a',
        12 => 'document.odt',
      ],
      'node' => [
        1 => 'Article with embed image media',
        2 => 'Article with only a single image',
      ],
      'node_type' => [
        'article' => 'Article',
        'page' => 'Basic page',
      ],
    ];

    // Drupal core 8.9.x prior 8.9.3 and Drupal core 9.0.x prior 9.0.3 were
    // unable to migrate "filtered_html" filter format due to a but in the
    // "subprocess" migrate process plugin.
    // @todo We can remove this after 8.9.3 and 9.0.3 are released.
    // @see https://drupal.org/i/3126063
    if (version_compare(\Drupal::VERSION, '8.9.0', '>=') && version_compare(\Drupal::VERSION, '8.9.2', '<=') || version_compare(\Drupal::VERSION, '9.0.0', '>=') && version_compare(\Drupal::VERSION, '9.0.2', '<=')) {
      unset($expected_entities['filter_format']['filtered_html']);
    }

    // Drupal 9.1.x ships a new default image style "wide".
    if (version_compare(\Drupal::VERSION, '9.1', '>=')) {
      $expected_entities['image_style']['wide'] = 'Wide (1090)';
    }
    return $expected_entities;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntityCounts() {

    // This is not used.
    $entity_counts = [];
    foreach ($this
      ->getExpectedEntities() as $entity_type_id => $expected_entities) {
      $entity_counts[$entity_type_id] = count($expected_entities);
    }
    return $entity_counts;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntityCountsIncremental() {

    // This is not used.
    return $this
      ->getEntityCounts();
  }

  /**
   * {@inheritdoc}
   */
  protected function getAvailablePaths() {
    $available_paths = [
      'block',
      'color',
      'comment',
      'ctools',
      'dashboard',
      'dblog',
      'field',
      'field_sql_storage',
      'file',
      'filter',
      'image',
      'list',
      'menu',
      'node',
      'number',
      'options',
      'path',
      'rdf',
      'search',
      'shortcut',
      'system',
      'taxonomy',
      'text',
      'user',
      // Include modules that do not have an upgrade path and are enabled in the
      // source database.
      'contextual',
      'field_ui',
      'help',
      'toolbar',
    ];

    // No idea why, but Drupal 9 threats available/missing migration paths
    // different than prior versions.
    if (version_compare(\Drupal::VERSION, '9.0', '<')) {
      $available_paths[] = 'file_entity';
    }

    // Drupal 9.1+ checks the human name of the modules.
    if (version_compare(\Drupal::VERSION, '9.1', '>=')) {
      $available_paths = [
        'Block',
        'Chaos tools',
        'Color',
        'Comment',
        'Contextual links',
        'Dashboard',
        'Database logging',
        'Field',
        'Field SQL storage',
        'Field UI',
        'File',
        'Filter',
        'Help',
        'Image',
        'List',
        'Menu',
        'Node',
        'Number',
        'Options',
        'Path',
        'RDF',
        'Search',
        'Shortcut',
        'System',
        'Taxonomy',
        'Text',
        'Toolbar',
        'User',
      ];
    }
    return $available_paths;
  }

  /**
   * {@inheritdoc}
   */
  protected function getMissingPaths() {
    $missing_paths = [
      'media',
      'media_internet',
      'media_vimeo',
      'media_wysiwyg',
      'media_youtube',
      'views',
      'wysiwyg',
    ];

    // No idea why, but Drupal 9 threats available/missing migration paths
    // different than prior versions.
    if (version_compare(\Drupal::VERSION, '9.0', '>=')) {
      $missing_paths[] = 'file_entity';
    }

    // Drupal 9.1+ checks the human name of the modules.
    if (version_compare(\Drupal::VERSION, '9.1', '>=')) {
      $missing_paths = [
        'File Entity',
        'Media',
        'Media Internet Sources',
        'Media WYSIWYG',
        'Media: Vimeo',
        'Media: YouTube',
        'Views',
        'Wysiwyg',
      ];
    }
    return $missing_paths;
  }

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->destinationSiteVersion = explode('.', \Drupal::VERSION, 2)[0];

    // Delete 'article' content type. The destination Drupal 8|9 instance's
    // article content type will contain an image type field with the same name
    // that we have in the source Drupal 7 database. Media Migration tries to
    // change the field type of file and image fields to media reference, but
    // since the type of an existing field cannot be changed, this is the only
    // way to test the migration of media until we solve this issue.
    if ($node_type_storage = $this
      ->getEntityStorage('node_type')) {
      if ($article_node_type = $node_type_storage
        ->load('article')) {
        $article_node_type
          ->delete();
      }
    }
    $this
      ->loadFixture($this
      ->getFixtureFilePath());
    $this
      ->setEmbedTokenDestinationFilterPlugin($this->embedTokenDestinationFilterPlugin);
    $this
      ->setEmbedMediaReferenceMethod($this->embedMediaReferenceMethod);
  }

  /**
   * Submits the Migrate Upgrade source connection and files form.
   */
  protected function submitMigrateUpgradeSourceConnectionForm() {
    $connection_options = $this->sourceDatabase
      ->getConnectionOptions();
    $this
      ->drupalGet('/upgrade');
    $session = $this
      ->assertSession();
    $session
      ->responseContains("Upgrade a site by importing its files and the data from its database into a clean and empty new install of Drupal {$this->destinationSiteVersion}.");
    $this
      ->drupalPostForm(NULL, [], $this
      ->t('Continue'));
    $session
      ->pageTextContains('Provide credentials for the database of the Drupal site you want to upgrade.');
    $driver = $connection_options['driver'];
    $connection_options['prefix'] = $connection_options['prefix']['default'];

    // Use the driver connection form to get the correct options out of the
    // database settings. This supports all of the databases we test against.
    $drivers = drupal_get_database_types();
    $form = $drivers[$driver]
      ->getFormOptions($connection_options);
    $connection_options = array_intersect_key($connection_options, $form + $form['advanced_options']);
    $version = $this
      ->getLegacyDrupalVersion($this->sourceDatabase);
    $edit = [
      $driver => $connection_options,
      'source_private_file_path' => $this
        ->getSourcePrivateFilesPath(),
      'version' => $version,
      'source_base_path' => $this
        ->getSourceBasePath(),
    ];
    if (count($drivers) !== 1) {
      $edit['driver'] = $driver;
    }
    $edits = $this
      ->translatePostValues($edit);
    $this
      ->drupalPostForm(NULL, $edits, $this
      ->t('Review upgrade'));
  }

  /**
   * Executes the upgrade process by the UI and asserts basic expectations.
   *
   * @param bool $assert_review_page
   *   Whether the review page should be tested or not. Defaults to TRUE.
   */
  protected function assertMigrateUpgradeViaUi(bool $assert_review_page = TRUE) {
    $this
      ->submitMigrateUpgradeSourceConnectionForm();
    $session = $this
      ->assertSession();
    $session
      ->pageTextNotContains('Resolve all issues below to continue the upgrade.');

    // When complete node migration is executed, Drupal 8.9 and above (even 9.x)
    // will complain about content id conflicts. Drupal 8.8 and below won't.
    // @see https://www.drupal.org/node/2928118
    // @see https://www.drupal.org/node/3105503
    if (version_compare(\Drupal::VERSION, '8.9', '>=') && !Settings::get('migrate_node_migrate_type_classic', FALSE)) {
      $session
        ->buttonExists($this
        ->t('I acknowledge I may lose data. Continue anyway.'));
      $this
        ->drupalPostForm(NULL, [], $this
        ->t('I acknowledge I may lose data. Continue anyway.'));
      $session
        ->statusCodeEquals(200);
    }
    if ($assert_review_page) {

      // Test the review page.
      $available_paths = $this
        ->getAvailablePaths();
      $missing_paths = $this
        ->getMissingPaths();
      $this
        ->assertReviewPage($session, $available_paths, $missing_paths);
    }

    // Perform the upgrade.
    $this
      ->drupalPostForm(NULL, [], $this
      ->t('Perform upgrade'));
    $this
      ->assertText($this
      ->t('Congratulations, you upgraded Drupal!'));

    // Have to reset all the statics after migration to ensure entities are
    // loadable.
    $this
      ->resetAll();
  }

  /**
   * Checks that migrations have been performed successfully.
   */
  protected function assertMediaMigrationResults() {
    $version = $this
      ->getLegacyDrupalVersion($this->sourceDatabase);
    $this
      ->assertEntities();
    $plugin_manager = $this->container
      ->get('plugin.manager.migration');

    /** @var \Drupal\migrate\Plugin\Migration[] $all_migrations */
    $all_migrations = $plugin_manager
      ->createInstancesByTag('Drupal ' . $version);
    foreach ($all_migrations as $migration) {
      $id_map = $migration
        ->getIdMap();
      foreach ($id_map as $source_id => $map) {

        // Convert $source_id into a keyless array so that
        // \Drupal\migrate\Plugin\migrate\id_map\Sql::getSourceHash() works as
        // expected.
        $source_id_values = array_values(unserialize($source_id));
        $row = $id_map
          ->getRowBySource($source_id_values);
        $destination = serialize($id_map
          ->currentDestination());
        $message = "Migration of {$source_id} to {$destination} as part of the {$migration->id()} migration. The source row status is " . $row['source_row_status'];

        // A completed migration should have maps with
        // MigrateIdMapInterface::STATUS_IGNORED or
        // MigrateIdMapInterface::STATUS_IMPORTED.
        $this
          ->assertNotSame(MigrateIdMapInterface::STATUS_FAILED, $row['source_row_status'], $message);
        $this
          ->assertNotSame(MigrateIdMapInterface::STATUS_NEEDS_UPDATE, $row['source_row_status'], $message);
      }
    }
  }

  /**
   * Pass if the page HTML title is the given string.
   *
   * @param string $expected_title
   *   The string the page title should be.
   *
   * @throws \Behat\Mink\Exception\ExpectationException
   *   Thrown when element doesn't exist, or the title is a different one.
   */
  protected function assertPageTitle($expected_title) {
    $page_title_element = $this
      ->getSession()
      ->getPage()
      ->find('css', 'h1.page-title');
    if (!$page_title_element) {
      throw new ExpectationException('No page title element found on the page', $this
        ->getSession()
        ->getDriver());
    }
    $actual_title = $page_title_element
      ->getText();
    $this
      ->assertSame($expected_title, $actual_title, 'The page title is not the same as expected.');
  }

  /**
   * Asserts that the expected entities exist.
   */
  protected function assertEntities() {
    foreach ($this
      ->getExpectedEntities() as $entity_type_id => $expected_entity_labels) {
      if ($storage = $this
        ->getEntityStorage($entity_type_id)) {
        $ignored_entities = $this
          ->getIgnoredEntities()[$entity_type_id] ?? [];
        $entities = $storage
          ->loadMultiple();
        $actual_labels = array_reduce($entities, function ($carry, EntityInterface $entity) use ($ignored_entities) {
          $label = $entity
            ->label();
          $id = $entity
            ->id();
          if (empty($ignored_entities) || array_search($label, $ignored_entities) === FALSE && array_search($id, $ignored_entities) === FALSE) {
            $carry[$id] = $label;
          }
          return $carry;
        });
        $this
          ->assertEquals($expected_entity_labels, $actual_labels, sprintf('The expected %s entities are not matching the actual ones.', $entity_type_id));
      }
      else {
        $this
          ->fail(sprintf('The expected %s entity type is missing.', $entity_type_id));
      }
    }
  }

  /**
   * Helper method to assert the text on the 'Upgrade analysis report' page.
   *
   * This method is removed from Drupal core 9.1.x, but we need it for BC.
   *
   * @param \Drupal\Tests\WebAssert $session
   *   The web-assert session.
   * @param array $available_paths
   *   An array of modules that will be upgraded.
   * @param array $missing_paths
   *   An array of modules that will not be upgraded.
   */
  protected function assertReviewPage(WebAssert $session, array $available_paths = NULL, array $missing_paths = NULL) {
    if (is_callable('parent::assertReviewPage')) {
      parent::assertReviewPage($session, $available_paths, $missing_paths);
      return;
    }
    parent::assertReviewForm($available_paths, $missing_paths);
  }

  /**
   * Sets the method of the embed media reference.
   *
   * @param string|null $new_reference_method
   *   The reference method to set. This can be 'id', or 'uuid'.
   */
  protected function setEmbedMediaReferenceMethod($new_reference_method) {
    $current_method = Settings::get(MediaMigration::MEDIA_REFERENCE_METHOD_SETTINGS);
    if ($current_method !== $new_reference_method) {
      $settings['settings'][MediaMigration::MEDIA_REFERENCE_METHOD_SETTINGS] = (object) [
        'value' => $new_reference_method,
        'required' => TRUE,
      ];
      $this
        ->writeSettings($settings);
    }
  }

  /**
   * Changes the entity embed token transform destination filter plugin.
   *
   * @param string|null $new_filter_plugin_id
   *   The new token transform destination plugin ID.
   */
  protected function setEmbedTokenDestinationFilterPlugin($new_filter_plugin_id) {
    $current_filter_plugin_id = Settings::get('media_migration_embed_token_transform_destination_filter_plugin');
    if ($new_filter_plugin_id !== $current_filter_plugin_id) {
      $settings['settings']['media_migration_embed_token_transform_destination_filter_plugin'] = (object) [
        'value' => $new_filter_plugin_id,
        'required' => TRUE,
      ];
      $this
        ->writeSettings($settings);
    }
  }

  /**
   * Returns the specified entity's storage when the entity definition exists.
   *
   * @param string $entity_type_id
   *   The entity type ID.
   *
   * @return \Drupal\Core\Entity\EntityStorageInterface|null
   *   The embed button's entity storage, or NULL if it does not exist.
   */
  protected function getEntityStorage(string $entity_type_id) {
    $entity_type_manager = $this->container
      ->get('entity_type.manager');
    assert($entity_type_manager instanceof EntityTypeManagerInterface);
    try {
      $storage = $entity_type_manager
        ->getStorage($entity_type_id);
    } catch (PluginNotFoundException $e) {

      // The entity type does not exist.
      return NULL;
    }
    return $storage;
  }

  /**
   * Sets the type of the node migration.
   *
   * @param bool $classic_node_migration
   *   Whether nodes should be migrated with the 'classic' way. If this is
   *   FALSE, and the current Drupal instance has the 'complete' migration, then
   *   the complete node migration will be used.
   */
  protected function setClassicNodeMigration(bool $classic_node_migration) {
    $current_method = Settings::get('migrate_node_migrate_type_classic', FALSE);
    if ($current_method !== $classic_node_migration) {
      $settings['settings']['migrate_node_migrate_type_classic'] = (object) [
        'value' => $classic_node_migration,
        'required' => TRUE,
      ];
      $this
        ->writeSettings($settings);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
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::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$defaultTheme protected property The theme to install as the default for testing. 1,597
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
CreateTestContentEntitiesTrait::createContent protected function Create several pieces of generic content.
CreateTestContentEntitiesTrait::createContentPostUpgrade protected function Create several pieces of generic content.
CreateTestContentEntitiesTrait::getRequiredModules protected function Gets required modules.
CreateTestContentEntitiesTrait::installEntitySchemas protected function Install required entity schemas.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
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.
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.
MigrateMediaTestBase::$destinationSiteVersion protected property The destination site major version.
MigrateMediaTestBase::$embedMediaReferenceMethod protected property The method how embed code should reference media entities.
MigrateMediaTestBase::$embedTokenDestinationFilterPlugin protected property The destination filter plugin ID to target on entity embed token transform. 1
MigrateMediaTestBase::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules 2
MigrateMediaTestBase::assertEntities protected function Asserts that the expected entities exist.
MigrateMediaTestBase::assertMediaMigrationResults protected function Checks that migrations have been performed successfully.
MigrateMediaTestBase::assertMigrateUpgradeViaUi protected function Executes the upgrade process by the UI and asserts basic expectations.
MigrateMediaTestBase::assertPageTitle protected function Pass if the page HTML title is the given string.
MigrateMediaTestBase::assertReviewPage protected function Helper method to assert the text on the 'Upgrade analysis report' page. Overrides MigrateUpgradeTestBase::assertReviewPage
MigrateMediaTestBase::getAvailablePaths protected function Gets the available upgrade paths. Overrides MigrateUpgradeTestBase::getAvailablePaths
MigrateMediaTestBase::getEntityCounts protected function Gets the expected number of entities per entity type after migration. Overrides MigrateUpgradeTestBase::getEntityCounts
MigrateMediaTestBase::getEntityCountsIncremental protected function Gets expected number of entities per entity after incremental migration. Overrides MigrateUpgradeTestBase::getEntityCountsIncremental
MigrateMediaTestBase::getEntityStorage protected function Returns the specified entity's storage when the entity definition exists.
MigrateMediaTestBase::getExpectedEntities protected function Gets the expected entity IDs and labels per entity type after migration. 3
MigrateMediaTestBase::getIgnoredEntities protected function Returns IDs or labels of those entities that shouldn't be checked.
MigrateMediaTestBase::getMissingPaths protected function Gets the missing upgrade paths. Overrides MigrateUpgradeTestBase::getMissingPaths
MigrateMediaTestBase::getSourceBasePath protected function Gets the source base path for the concrete test. Overrides MigrateUpgradeTestBase::getSourceBasePath
MigrateMediaTestBase::getSourcePrivateFilesPath protected function
MigrateMediaTestBase::setClassicNodeMigration protected function Sets the type of the node migration.
MigrateMediaTestBase::setEmbedMediaReferenceMethod protected function Sets the method of the embed media reference.
MigrateMediaTestBase::setEmbedTokenDestinationFilterPlugin protected function Changes the entity embed token transform destination filter plugin.
MigrateMediaTestBase::setUp protected function Overrides MigrateUpgradeTestBase::setUp
MigrateMediaTestBase::submitMigrateUpgradeSourceConnectionForm protected function Submits the Migrate Upgrade source connection and files form.
MigrateUpgradeTestBase::$profile protected property Use the Standard profile to test help implementations of many core modules. Overrides BrowserTestBase::$profile
MigrateUpgradeTestBase::$sourceDatabase protected property The source database connection.
MigrateUpgradeTestBase::assertIdConflict protected function Helper method that asserts text on the ID conflict form.
MigrateUpgradeTestBase::assertMigrationResults protected function Checks that migrations have been performed successfully.
MigrateUpgradeTestBase::assertUpgradePaths protected function Tests the displayed upgrade paths.
MigrateUpgradeTestBase::createMigrationConnection protected function Changes the database connection to the prefixed one.
MigrateUpgradeTestBase::loadFixture protected function Loads a database fixture into the source database connection.
MigrateUpgradeTestBase::tearDown protected function Overrides BrowserTestBase::tearDown
MigrationConfigurationTrait::$configFactory protected property The config factory service.
MigrationConfigurationTrait::$followUpMigrationTags protected property The follow-up migration tags.
MigrationConfigurationTrait::$migrationPluginManager protected property The migration plugin manager service.
MigrationConfigurationTrait::$state protected property The state service.
MigrationConfigurationTrait::createDatabaseStateSettings protected function Creates the necessary state entries for SqlBase::getDatabase() to work.
MigrationConfigurationTrait::getConfigFactory protected function Gets the config factory service.
MigrationConfigurationTrait::getConnection protected function Gets the database connection for the source Drupal database.
MigrationConfigurationTrait::getFollowUpMigrationTags protected function Returns the follow-up migration tags.
MigrationConfigurationTrait::getLegacyDrupalVersion public static function Determines what version of Drupal the source database contains.
MigrationConfigurationTrait::getMigrationPluginManager protected function Gets the migration plugin manager service.
MigrationConfigurationTrait::getMigrations protected function Gets the migrations for import.
MigrationConfigurationTrait::getState protected function Gets the state service.
MigrationConfigurationTrait::getSystemData protected function Gets the system data from the system table of the source Drupal database.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
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.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.