You are here

class ConfigUpdateTest in Configuration Update Manager 8

Verify the config revert report and its links.

@group config_update

Hierarchy

Expanded class hierarchy of ConfigUpdateTest

File

config_update_ui/tests/src/Functional/ConfigUpdateTest.php, line 12

Namespace

Drupal\Tests\config_update_ui\Functional
View source
class ConfigUpdateTest extends BrowserTestBase {

  /**
   * Default theme.
   *
   * @var string
   */
  protected $defaultTheme = 'classy';

  /**
   * Modules to enable.
   *
   * Use the Search module because it has two included config items in its
   * config/install, assuming node and user are also enabled.
   *
   * @var array
   */
  public static $modules = [
    'config',
    'config_update',
    'config_update_ui',
    'search',
    'node',
    'user',
    'block',
    'text',
    'field',
    'filter',
  ];

  /**
   * The admin user that will be created.
   *
   * @var object
   */
  protected $adminUser;

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

    // Create user and log in.
    $this->adminUser = $this
      ->createUser([
      'access administration pages',
      'administer search',
      'view config updates report',
      'synchronize configuration',
      'export configuration',
      'import configuration',
      'revert configuration',
      'delete configuration',
      'administer filters',
    ]);
    $this
      ->drupalLogin($this->adminUser);

    // Make sure local tasks and page title are showing.
    $this
      ->placeBlock('local_tasks_block');
    $this
      ->placeBlock('page_title_block');

    // Load the Drush include file so that its functions can be tested, plus
    // the Drush testing include file.
    module_load_include('inc', 'config_update_ui', 'config_update_ui.drush_testing');
    module_load_include('inc', 'config_update_ui', 'config_update_ui.drush');
  }

  /**
   * Tests the config report and its linked pages.
   */
  public function testConfigReport() {

    // Test links to report page.
    $this
      ->drupalGet('admin/config/development/configuration');
    $this
      ->clickLink('Updates report');
    $this
      ->assertNoReport();

    // Verify the Drush list types command.
    $output = implode("\n", drush_config_update_ui_config_list_types());
    $this
      ->assertTrue(strpos($output, 'search_page') !== FALSE);
    $this
      ->assertTrue(strpos($output, 'node_type') !== FALSE);
    $this
      ->assertTrue(strpos($output, 'user_role') !== FALSE);
    $this
      ->assertTrue(strpos($output, 'block') !== FALSE);

    // Verify some empty reports.
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->assertReport('Search page', [], [], [], []);
    $this
      ->assertDrushReports('type', 'search_page', [], [], [], []);

    // Module, theme, and profile reports have no 'added' section.
    $this
      ->drupalGet('admin/config/development/configuration/report/module/search');
    $this
      ->assertReport('Search module', [], [], [], [], [
      'added',
    ]);
    $this
      ->assertDrushReports('module', 'search', [], [], [], []);
    $this
      ->drupalGet('admin/config/development/configuration/report/theme/classy');
    $this
      ->assertReport('Classy theme', [], [], [], [], [
      'added',
    ]);
    $this
      ->assertDrushReports('theme', 'classy', [], [], [], []);
    $inactive = [
      'locale.settings' => 'Simple configuration',
    ];
    $this
      ->drupalGet('admin/config/development/configuration/report/profile');
    $this
      ->assertReport('Testing profile', [], [], [], $inactive, [
      'added',
    ]);

    // The locale.settings line should show that the Testing profile is the
    // provider.
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('Testing profile');
    $this
      ->assertDrushReports('profile', '', [], [], [], array_keys($inactive));

    // Verify that the user search page cannot be imported (because it already
    // exists).
    $this
      ->drupalGet('admin/config/development/configuration/report/import/search_page/user_search');
    $session = $this
      ->assertSession();
    $session
      ->statusCodeEquals(404);

    // Delete the user search page from the search UI and verify report for
    // both the search page config type and user module.
    $this
      ->drupalGet('admin/config/search/pages');
    $this
      ->clickLink('Delete');
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $inactive = [
      'search.page.user_search' => 'Users',
    ];
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->assertReport('Search page', [], [], [], $inactive);

    // The search.page.user_search line should show that the User module is the
    // provider.
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('User module');
    $this
      ->assertDrushReports('type', 'search_page', [], [], [], array_keys($inactive));
    $this
      ->drupalGet('admin/config/development/configuration/report/module/user');
    $this
      ->assertReport('User module', [], [], [], $inactive, [
      'added',
      'changed',
    ]);
    $this
      ->assertDrushReports('module', 'user', [], [], [], [
      'rdf.mapping.user.user',
      'search.page.user_search',
      'views.view.user_admin_people',
      'views.view.who_s_new',
      'views.view.who_s_online',
    ], [
      'changed',
    ]);

    // Verify that the user search page cannot be reverted (because it does
    // not already exist).
    $this
      ->drupalGet('admin/config/development/configuration/report/revert/search_page/user_search');
    $session = $this
      ->assertSession();
    $session
      ->statusCodeEquals(404);

    // Verify that the delete URL doesn't work either.
    $this
      ->drupalGet('admin/config/development/configuration/report/delete/search_page/user_search');
    $session = $this
      ->assertSession();
    $session
      ->statusCodeEquals(404);

    // Use the import link to get it back. Do this from the search page
    // report to make sure we are importing the right config.
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->clickLink('Import from source');
    $this
      ->drupalPostForm(NULL, [], 'Import');
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('has been imported');
    $this
      ->assertNoReport();
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->assertReport('Search page', [], [], [], []);
    $this
      ->assertDrushReports('type', 'search_page', [], [], [], []);

    // Verify that after import, there is no config hash generated.
    $this
      ->drupalGet('admin/config/development/configuration/single/export/search_page/user_search');
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('id: user_search');
    $session
      ->pageTextNotContains('default_config_hash:');

    // Test importing again, this time using the Drush import command.
    $this
      ->drupalGet('admin/config/search/pages');
    $this
      ->clickLink('Delete');
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $inactive = [
      'search.page.user_search' => 'Users',
    ];
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->assertReport('Search page', [], [], [], $inactive);
    drush_config_update_ui_config_import_missing('search.page.user_search');
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->assertReport('Search page', [], [], [], []);

    // Edit the node search page from the search UI and verify report.
    $this
      ->drupalGet('admin/config/search/pages');
    $this
      ->clickLink('Edit');
    $this
      ->drupalPostForm(NULL, [
      'label' => 'New label',
      'path' => 'new_path',
    ], 'Save search page');
    $changed = [
      'search.page.node_search' => 'New label',
    ];
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->assertReport('Search page', [], [], $changed, []);
    $this
      ->assertDrushReports('type', 'search_page', [], [], array_keys($changed), []);

    // Test the show differences link.
    $this
      ->clickLink('Show differences');
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('Content');
    $session
      ->pageTextContains('New label');
    $session
      ->pageTextContains('node');
    $session
      ->pageTextContains('new_path');

    // Test the show differences Drush command.
    $output = drush_config_update_ui_config_diff('search.page.node_search');
    $this
      ->assertTrue(strpos($output, 'Content') !== FALSE);
    $this
      ->assertTrue(strpos($output, 'New label') !== FALSE);
    $this
      ->assertTrue(strpos($output, 'node') !== FALSE);
    $this
      ->assertTrue(strpos($output, 'new_path') !== FALSE);

    // Test the Back link.
    $this
      ->clickLink("Back to 'Updates report' page.");
    $this
      ->assertNoReport();

    // Test the export link.
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->clickLink('Export');
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('Here is your configuration:');
    $session
      ->pageTextContains('id: node_search');
    $session
      ->pageTextContains('New label');
    $session
      ->pageTextContains('path: new_path');
    $session
      ->pageTextContains('search.page.node_search.yml');

    // Grab the uuid and hash lines from the exported config for the next test.
    $text = strip_tags($this
      ->getSession()
      ->getPage()
      ->find('css', 'textarea')
      ->getHtml());
    $matches = [];
    preg_match('|^.*uuid:.*$|m', $text, $matches);
    $uuid_line = trim($matches[0]);
    preg_match('|^.*default_config_hash:.*$|m', $text, $matches);
    $hash_line = trim($matches[0]);

    // Test reverting.
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->clickLink('Revert to source');
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('Are you sure you want to revert');
    $session
      ->pageTextContains('Search page');
    $session
      ->pageTextContains('node_search');
    $session
      ->pageTextContains('Customizations will be lost. This action cannot be undone');
    $this
      ->drupalPostForm(NULL, [], 'Revert');
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->assertReport('Search page', [], [], [], []);

    // Verify that the uuid and hash keys were retained in the revert.
    $this
      ->drupalGet('admin/config/development/configuration/single/export/search_page/node_search');
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('id: node_search');
    $session
      ->pageTextContains($uuid_line);
    $session
      ->pageTextContains($hash_line);

    // Test reverting again, this time using Drush single revert command.
    $this
      ->drupalGet('admin/config/search/pages');
    $this
      ->clickLink('Edit');
    $this
      ->drupalPostForm(NULL, [
      'label' => 'New label',
      'path' => 'new_path',
    ], 'Save search page');
    $changed = [
      'search.page.node_search' => 'New label',
    ];
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->assertReport('Search page', [], [], $changed, []);
    drush_config_update_ui_config_revert('search.page.node_search');
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->assertReport('Search page', [], [], [], []);

    // Test reverting again, this time using Drush multiple revert command.
    $this
      ->drupalGet('admin/config/search/pages');
    $this
      ->clickLink('Edit');
    $this
      ->drupalPostForm(NULL, [
      'label' => 'New label',
      'path' => 'new_path',
    ], 'Save search page');
    $changed = [
      'search.page.node_search' => 'New label',
    ];
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->assertReport('Search page', [], [], $changed, []);
    drush_config_update_ui_config_revert_multiple('type', 'search_page');
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->assertReport('Search page', [], [], [], []);

    // Add a new search page from the search UI and verify report.
    $this
      ->drupalPostForm('admin/config/search/pages', [
      'search_type' => 'node_search',
    ], 'Add search page');
    $this
      ->drupalPostForm(NULL, [
      'label' => 'test',
      'id' => 'test',
      'path' => 'test',
    ], 'Save');
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $added = [
      'search.page.test' => 'test',
    ];
    $this
      ->assertReport('Search page', [], $added, [], []);
    $this
      ->assertDrushReports('type', 'search_page', [], array_keys($added), [], []);

    // Test the export link.
    $this
      ->clickLink('Export');
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('Here is your configuration:');
    $session
      ->pageTextContains('id: test');
    $session
      ->pageTextContains('label: test');
    $session
      ->pageTextContains('path: test');
    $session
      ->pageTextContains('search.page.test.yml');

    // Test the delete link.
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->clickLink('Delete');
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('Are you sure');
    $session
      ->pageTextContains('cannot be undone');
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('has been deleted');

    // And verify the report again.
    $this
      ->drupalGet('admin/config/development/configuration/report/type/search_page');
    $this
      ->assertReport('Search page', [], [], [], []);

    // Change the search module config and verify the actions work for
    // simple config.
    $this
      ->drupalPostForm('admin/config/search/pages', [
      'minimum_word_size' => 4,
    ], 'Save configuration');
    $changed = [
      'search.settings' => 'search.settings',
    ];
    $this
      ->drupalGet('admin/config/development/configuration/report/module/search');
    $this
      ->assertReport('Search module', [], [], $changed, [], [
      'added',
    ]);
    $this
      ->clickLink('Show differences');
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('Config difference for Simple configuration search.settings');
    $session
      ->pageTextContains('index::minimum_word_size');
    $session
      ->pageTextContains('4');
    $this
      ->drupalGet('admin/config/development/configuration/report/module/search');
    $this
      ->clickLink('Export');
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('minimum_word_size: 4');

    // Grab the hash line for the next test.
    $text = strip_tags($this
      ->getSession()
      ->getPage()
      ->find('css', 'textarea')
      ->getHtml());
    $matches = [];
    preg_match('|^.*default_config_hash:.*$|m', $text, $matches);
    $hash_line = trim($matches[0]);
    $this
      ->drupalGet('admin/config/development/configuration/report/module/search');
    $this
      ->clickLink('Revert to source');
    $this
      ->drupalPostForm(NULL, [], 'Revert');

    // Verify that the hash was retained in the revert.
    $this
      ->drupalGet('admin/config/development/configuration/single/export/system.simple/search.settings');
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains($hash_line);
    $this
      ->drupalGet('admin/config/development/configuration/report/module/search');
    $this
      ->assertReport('Search module', [], [], [], [], [
      'added',
    ]);

    // Edit the plain_text filter from the filter UI and verify report.
    // The filter_format config type uses a label key other than 'label'.
    $this
      ->drupalPostForm('admin/config/content/formats/manage/plain_text', [
      'name' => 'New label',
    ], 'Save configuration');
    $changed = [
      'filter.format.plain_text' => 'New label',
    ];
    $this
      ->drupalGet('admin/config/development/configuration/report/type/filter_format');
    $this
      ->assertReport('Text format', [], [], $changed, []);

    // Verify that we can revert non-entity configuration in Drush. Issue:
    // https://www.drupal.org/project/config_update/issues/2935395
    drush_config_update_ui_config_revert('system.date');
  }

  /**
   * Asserts that the report page has the correct content.
   *
   * Assumes you are already on the report page.
   *
   * @param string $title
   *   Report title to check for.
   * @param string[] $missing
   *   Array of items that should be listed as missing, name => label.
   * @param string[] $added
   *   Array of items that should be listed as added, name => label.
   * @param string[] $changed
   *   Array of items that should be listed as changed, name => label.
   * @param string[] $inactive
   *   Array of items that should be listed as inactive, name => label.
   * @param string[] $skip
   *   Array of report sections to skip checking.
   */
  protected function assertReport($title, array $missing, array $added, array $changed, array $inactive, array $skip = []) {
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('Configuration updates report for ' . $title);
    $session
      ->pageTextContains('Generate new report');
    if (!in_array('missing', $skip)) {
      $session
        ->pageTextContains('Missing configuration items');
      if (count($missing)) {
        foreach ($missing as $name => $label) {
          $session
            ->pageTextContains($name);
          $session
            ->pageTextContains($label);
        }
        $session
          ->pageTextNotContains('None: all provided configuration items are in your active configuration.');
      }
      else {
        $session
          ->pageTextContains('None: all provided configuration items are in your active configuration.');
      }
    }
    if (!in_array('inactive', $skip)) {
      $session
        ->pageTextContains('Inactive optional items');
      if (count($inactive)) {
        foreach ($inactive as $name => $label) {
          $session
            ->pageTextContains($name);
          $session
            ->pageTextContains($label);
        }
        $session
          ->pageTextNotContains('None: all optional configuration items are in your active configuration.');
      }
      else {
        $session
          ->pageTextContains('None: all optional configuration items are in your active configuration.');
      }
    }
    if (!in_array('added', $skip)) {
      $session
        ->pageTextContains('Added configuration items');
      if (count($added)) {
        foreach ($added as $name => $label) {
          $session
            ->pageTextContains($name);
          $session
            ->pageTextContains($label);
        }
        $session
          ->pageTextNotContains('None: all active configuration items of this type were provided by modules, themes, or install profile.');
      }
      else {
        $session
          ->pageTextContains('None: all active configuration items of this type were provided by modules, themes, or install profile.');
      }
    }
    if (!in_array('changed', $skip)) {
      $session
        ->pageTextContains('Changed configuration items');
      if (count($changed)) {
        foreach ($changed as $name => $label) {
          $session
            ->pageTextContains($name);
          $session
            ->pageTextContains($label);
        }
        $session
          ->pageTextNotContains('None: no active configuration items differ from their current provided versions.');
      }
      else {
        $session
          ->pageTextContains('None: no active configuration items differ from their current provided versions.');
      }
    }
  }

  /**
   * Asserts that the Drush reports have the correct content.
   *
   * @param string $type
   *   Type of report to run (type, module, theme, etc.).
   * @param string $name
   *   Name of that type to run (e.g., module machine name).
   * @param string[] $missing
   *   Array of config items that should be listed as missing.
   * @param string[] $added
   *   Array of config items that should be listed as added.
   * @param string[] $changed
   *   Array of config items that should be listed as changed.
   * @param string[] $inactive
   *   Array of config items that should be listed as inactive.
   * @param string[] $skip
   *   Array of report sections to skip checking.
   */
  protected function assertDrushReports($type, $name, array $missing, array $added, array $changed, array $inactive, array $skip = []) {
    if (!in_array('missing', $skip)) {
      $output = drush_config_update_ui_config_missing_report($type, $name);
      $this
        ->assertEquals(count($output), count($missing), 'Drush missing report has correct number of items');
      if (count($missing)) {
        foreach ($missing as $item) {
          $this
            ->assertTrue(in_array($item, $output), "Item {$item} is in the Drush missing report");
        }
      }
    }
    if (!in_array('added', $skip) && $type == 'type') {
      $output = drush_config_update_ui_config_added_report($name);
      $this
        ->assertEquals(count($output), count($added), 'Drush added report has correct number of items');
      if (count($added)) {
        foreach ($added as $item) {
          $this
            ->assertTrue(in_array($item, $output), "Item {$item} is in the Drush added report");
        }
      }
    }
    if (!in_array('changed', $skip)) {
      $output = drush_config_update_ui_config_different_report($type, $name);
      $this
        ->assertEquals(count($output), count($changed), 'Drush changed report has correct number of items');
      if (count($changed)) {
        foreach ($changed as $item) {
          $this
            ->assertTrue(in_array($item, $output), "Item {$item} is in the Drush changed report");
        }
      }
    }
    if (!in_array('inactive', $skip)) {
      $output = drush_config_update_ui_config_inactive_report($type, $name);
      $this
        ->assertEquals(count($output), count($inactive), 'Drush inactive report has correct number of items');
      if (count($inactive)) {
        foreach ($inactive as $item) {
          $this
            ->assertTrue(in_array($item, $output), "Item {$item} is in the Drush inactive report");
        }
      }
    }
  }

  /**
   * Asserts that the report is not shown.
   *
   * Assumes you are already on the report form page.
   */
  protected function assertNoReport() {
    $session = $this
      ->assertSession();
    $session
      ->pageTextContains('Report type');
    $session
      ->pageTextContains('Full report');
    $session
      ->pageTextContains('Single configuration type');
    $session
      ->pageTextContains('Single module');
    $session
      ->pageTextContains('Single theme');
    $session
      ->pageTextContains('Installation profile');
    $session
      ->pageTextContains('Updates report');
    $session
      ->pageTextNotContains('Missing configuration items');
    $session
      ->pageTextNotContains('Added configuration items');
    $session
      ->pageTextNotContains('Changed configuration items');
    $session
      ->pageTextNotContains('Unchanged configuration items');

    // Verify that certain report links are shown or not shown. For extensions,
    // only extensions that have configuration should be shown.
    // Modules.
    $session
      ->linkExists('Search');
    $session
      ->linkExists('Field');
    $session
      ->linkNotExists('Configuration Update Base');
    $session
      ->linkNotExists('Configuration Update Reports');

    // Themes.
    $session
      ->linkNotExists('Stark');
    $session
      ->linkNotExists('Classy');

    // Profiles.
    $session
      ->linkExists('Testing');

    // Configuration types.
    $session
      ->linkExists('Everything');
    $session
      ->linkExists('Simple configuration');
    $session
      ->linkExists('Search page');
  }

}

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::$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::$profile protected property The profile to install as a basis for testing. 39
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::tearDown protected function 3
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.
ConfigUpdateTest::$adminUser protected property The admin user that will be created.
ConfigUpdateTest::$defaultTheme protected property Default theme. Overrides BrowserTestBase::$defaultTheme
ConfigUpdateTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
ConfigUpdateTest::assertDrushReports protected function Asserts that the Drush reports have the correct content.
ConfigUpdateTest::assertNoReport protected function Asserts that the report is not shown.
ConfigUpdateTest::assertReport protected function Asserts that the report page has the correct content.
ConfigUpdateTest::setUp protected function Overrides BrowserTestBase::setUp
ConfigUpdateTest::testConfigReport public function Tests the config report and its linked pages.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
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.
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.
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.