You are here

class MetatagAdminTest in Metatag 8

Tests the Metatag administration.

@group metatag

Hierarchy

Expanded class hierarchy of MetatagAdminTest

File

tests/src/Functional/MetatagAdminTest.php, line 15

Namespace

Drupal\Tests\metatag\Functional
View source
class MetatagAdminTest extends BrowserTestBase {
  use MetatagHelperTrait;
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    // Core modules.
    // @see testAvailableConfigEntities
    'block',
    'block_content',
    'comment',
    'contact',
    'field_ui',
    'menu_link_content',
    'menu_ui',
    'node',
    'shortcut',
    'taxonomy',
    // Core test modules.
    'entity_test',
    'test_page_test',
    // Contrib modules.
    'token',
    // This module.
    'metatag',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

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

    // Use the test page as the front page.
    $this
      ->config('system.site')
      ->set('page.front', '/test-page')
      ->save();

    // Create Basic page and Article node types.
    if ($this->profile != 'standard') {
      $this
        ->drupalCreateContentType([
        'type' => 'page',
        'name' => 'Basic page',
        'display_submitted' => FALSE,
      ]);
      $this
        ->drupalCreateContentType([
        'type' => 'article',
        'name' => 'Article',
      ]);
    }
  }

  /**
   * Tests the interface to manage metatag defaults.
   */
  public function testDefaults() {

    // Save the default title to test the Revert operation at the end.
    $metatag_defaults = \Drupal::config('metatag.metatag_defaults.global');
    $default_title = $metatag_defaults
      ->get('tags')['title'];

    // Initiate session with a user who can manage metatags.
    $permissions = [
      'administer site configuration',
      'administer meta tags',
    ];
    $account = $this
      ->drupalCreateUser($permissions);
    $this
      ->drupalLogin($account);

    // Check that the user can see the list of metatag defaults.
    $this
      ->drupalGet('admin/config/search/metatag');
    $session = $this
      ->assertSession();
    $session
      ->statusCodeEquals(200);

    // Check that the Global defaults were created.
    $session
      ->linkByHrefExists('admin/config/search/metatag/global');

    // Check that Global and entity defaults can't be deleted.
    $session
      ->linkByHrefNotExists('admin/config/search/metatag/global/delete');
    $session
      ->linkByHrefNotExists('admin/config/search/metatag/node/delete');

    // Check that the module defaults were injected into the Global config
    // entity.
    $this
      ->drupalGet('admin/config/search/metatag/global');
    $session
      ->statusCodeEquals(200);
    $this
      ->assertFieldById('edit-title', $metatag_defaults
      ->get('title'), $this
      ->t('Metatag defaults were injected into the Global configuration entity.'));

    // Update the Global defaults and test them.
    $this
      ->drupalGet('admin/config/search/metatag/global');
    $session
      ->statusCodeEquals(200);
    $values = [
      'title' => 'Test title',
      'description' => 'Test description',
    ];
    $this
      ->drupalPostForm(NULL, $values, 'Save');
    $session
      ->pageTextContains('Saved the Global Metatag defaults.');
    $this
      ->drupalGet('hit-a-404');
    $session
      ->statusCodeEquals(404);
    foreach ($values as $metatag => $value) {
      $session
        ->responseContains($value, $this
        ->t('Updated metatag @tag was found in the HEAD section of the page.', [
        '@tag' => $metatag,
      ]));
    }

    // Check that tokens are processed.
    $this
      ->drupalGet('admin/config/search/metatag/global');
    $session
      ->statusCodeEquals(200);
    $values = [
      'title' => '[site:name] | Test title',
      'description' => '[site:name] | Test description',
    ];
    $this
      ->drupalPostForm(NULL, $values, 'Save');
    $session
      ->pageTextContains('Saved the Global Metatag defaults.');
    drupal_flush_all_caches();
    $this
      ->drupalGet('hit-a-404');
    $session
      ->statusCodeEquals(404);
    foreach ($values as $metatag => $value) {
      $processed_value = \Drupal::token()
        ->replace($value);
      $session
        ->responseContains($processed_value, $this
        ->t('Processed token for metatag @tag was found in the HEAD section of the page.', [
        '@tag' => $metatag,
      ]));
    }

    // Test the Robots plugin.
    $this
      ->drupalGet('admin/config/search/metatag/global');
    $session
      ->statusCodeEquals(200);
    $robots_values = [
      'index',
      'follow',
      'noydir',
    ];
    $values = [];
    foreach ($robots_values as $value) {
      $values['robots[' . $value . ']'] = TRUE;
    }
    $this
      ->drupalPostForm(NULL, $values, 'Save');
    $session
      ->pageTextContains('Saved the Global Metatag defaults.');
    drupal_flush_all_caches();

    // Trigger a 404 request.
    $this
      ->drupalGet('hit-a-404');
    $session
      ->statusCodeEquals(404);
    $robots_value = implode(', ', $robots_values);
    $session
      ->responseContains($robots_value, $this
      ->t('Robots metatag has the expected values.'));

    // Test reverting global configuration to its defaults.
    $this
      ->drupalGet('admin/config/search/metatag/global/revert');
    $session
      ->statusCodeEquals(200);
    $this
      ->drupalPostForm(NULL, [], 'Revert');
    $session
      ->pageTextContains('Reverted Global defaults.');
    $session
      ->pageTextContains($default_title);
    $this
      ->drupalLogout();
  }

  /**
   * Confirm the available entity types show on the add-default page.
   */
  public function testAvailableConfigEntities() {

    // Initiate session with a user who can manage metatags.
    $permissions = [
      'administer site configuration',
      'administer meta tags',
    ];
    $account = $this
      ->drupalCreateUser($permissions);
    $this
      ->drupalLogin($account);

    // Load the default-add page.
    $this
      ->drupalGet('admin/config/search/metatag/add');
    $session = $this
      ->assertSession();
    $session
      ->statusCodeEquals(200);

    // Confirm the 'type' field exists.
    $session
      ->fieldExists('id');

    // Compile a list of entities from the list.
    $options = $this
      ->cssSelect('select[name="id"] option');
    $types = [];
    foreach ($options as $option) {
      $types[$option
        ->getAttribute('value')] = $option
        ->getAttribute('value');
    }

    // Check through the values that are in the 'select' list, make sure that
    // unwanted items are not present.
    $this
      ->assertArrayNotHasKey('block_content', $types, 'Custom block entities are not supported.');
    $this
      ->assertArrayNotHasKey('comment', $types, 'Comment entities are not supported.');
    $this
      ->assertArrayNotHasKey('menu_link_content', $types, 'Menu link entities are not supported.');
    $this
      ->assertArrayNotHasKey('shortcut', $types, 'Shortcut entities are not supported.');
    $this
      ->assertArrayHasKey('node__page', $types, 'Nodes are supported.');
    $this
      ->assertArrayHasKey('user__user', $types, 'Users are supported.');
    $this
      ->assertArrayHasKey('entity_test', $types, 'Test entities are supported.');
  }

  /**
   * Tests special pages.
   */
  public function testSpecialPages() {

    // Initiate session with a user who can manage metatags.
    $permissions = [
      'administer site configuration',
      'administer meta tags',
    ];
    $account = $this
      ->drupalCreateUser($permissions);
    $this
      ->drupalLogin($account);

    // Adjust the front page and test it.
    $this
      ->drupalGet('admin/config/search/metatag/front');
    $session = $this
      ->assertSession();
    $session
      ->statusCodeEquals(200);
    $values = [
      'description' => 'Front page description',
    ];
    $this
      ->drupalPostForm(NULL, $values, 'Save');
    $session
      ->pageTextContains('Saved the Front page Metatag defaults.');
    $this
      ->drupalGet('<front>');
    $session
      ->statusCodeEquals(200);
    $session
      ->responseContains($values['description'], $this
      ->t('Front page defaults are used at the front page.'));

    // Adjust the 403 page and test it.
    $this
      ->drupalGet('admin/config/search/metatag/403');
    $session
      ->statusCodeEquals(200);
    $values = [
      'description' => '403 page description.',
    ];
    $this
      ->drupalPostForm(NULL, $values, 'Save');
    $session
      ->pageTextContains('Saved the 403 access denied Metatag defaults.');
    $this
      ->drupalLogout();
    $this
      ->drupalGet('admin/config/search/metatag');
    $session
      ->statusCodeEquals(403);
    $session
      ->responseContains($values['description'], $this
      ->t('403 page defaults are used at 403 pages.'));

    // Adjust the 404 page and test it.
    $this
      ->drupalLogin($account);
    $this
      ->drupalGet('admin/config/search/metatag/404');
    $session
      ->statusCodeEquals(200);
    $values = [
      'description' => '404 page description.',
    ];
    $this
      ->drupalPostForm(NULL, $values, 'Save');
    $session
      ->pageTextContains('Saved the 404 page not found Metatag defaults.');
    $this
      ->drupalGet('foo');
    $session
      ->statusCodeEquals(404);
    $session
      ->responseContains($values['description'], $this
      ->t('404 page defaults are used at 404 pages.'));
    $this
      ->drupalLogout();
  }

  /**
   * Tests entity and bundle overrides.
   */
  public function testOverrides() {

    // Initiate session with a user who can manage metatags.
    $permissions = [
      'administer site configuration',
      'administer meta tags',
      'access content',
      'create article content',
      'administer nodes',
      'create article content',
      'create page content',
    ];
    $account = $this
      ->drupalCreateUser($permissions);
    $this
      ->drupalLogin($account);

    // Update the Metatag Node defaults.
    $this
      ->drupalGet('admin/config/search/metatag/node');
    $session = $this
      ->assertSession();
    $session
      ->statusCodeEquals(200);
    $values = [
      'title' => 'Test title for a node.',
      'description' => 'Test description for a node.',
    ];
    $this
      ->drupalPostForm(NULL, $values, 'Save');
    $session
      ->pageTextContains('Saved the Content Metatag defaults.');

    // Create a test node.
    $node = $this
      ->drupalCreateNode([
      'title' => $this
        ->t('Hello, world!'),
      'type' => 'article',
    ]);

    // Check that the new values are found in the response.
    $this
      ->drupalGet('node/' . $node
      ->id());
    $session
      ->statusCodeEquals(200);
    foreach ($values as $metatag => $value) {
      $session
        ->responseContains($value, $this
        ->t('Node metatag @tag overrides Global defaults.', [
        '@tag' => $metatag,
      ]));
    }

    // Check that when the node defaults don't define a metatag, the Global one
    // is used.
    // First unset node defaults.
    $this
      ->drupalGet('admin/config/search/metatag/node');
    $session
      ->statusCodeEquals(200);
    $values = [
      'title' => '',
      'description' => '',
    ];
    $this
      ->drupalPostForm(NULL, $values, 'Save');
    $session
      ->pageTextContains('Saved the Content Metatag defaults.');

    // Then, set global ones.
    $this
      ->drupalGet('admin/config/search/metatag/global');
    $session
      ->statusCodeEquals(200);
    $values = [
      'title' => 'Global title',
      'description' => 'Global description',
    ];
    $this
      ->drupalPostForm(NULL, $values, 'Save');
    $session
      ->pageTextContains('Saved the Global Metatag defaults.');

    // Next, test that global defaults are rendered since node ones are empty.
    // We are creating a new node as doing a get on the previous one would
    // return cached results.
    // @todo BookTest.php resets the cache of a single node, which is way more
    // performant than creating a node for every set of assertions.
    // @see BookTest::testDelete()
    $node = $this
      ->drupalCreateNode([
      'title' => $this
        ->t('Hello, world!'),
      'type' => 'article',
    ]);
    $this
      ->drupalGet('node/' . $node
      ->id());
    $session
      ->statusCodeEquals(200);
    foreach ($values as $metatag => $value) {
      $session
        ->responseContains($value, $this
        ->t('Found global @tag tag as Node does not set it.', [
        '@tag' => $metatag,
      ]));
    }

    // Now create article overrides and then test them.
    $this
      ->drupalGet('admin/config/search/metatag/add');
    $session
      ->statusCodeEquals(200);
    $values = [
      'id' => 'node__article',
      'title' => 'Article title override',
      'description' => 'Article description override',
    ];
    $this
      ->drupalPostForm(NULL, $values, 'Save');
    $session
      ->pageTextContains(strip_tags('Created the Content: Article Metatag defaults.'));

    // Confirm the fields load properly on the node/add/article page.
    $node = $this
      ->drupalCreateNode([
      'title' => $this
        ->t('Hello, world!'),
      'type' => 'article',
    ]);
    $this
      ->drupalGet('node/' . $node
      ->id());
    $session
      ->statusCodeEquals(200);
    unset($values['id']);
    foreach ($values as $metatag => $value) {
      $session
        ->responseContains($value, $this
        ->t('Found bundle override for tag @tag.', [
        '@tag' => $metatag,
      ]));
    }

    // Test deleting the article defaults.
    $this
      ->drupalGet('admin/config/search/metatag/node__article/delete');
    $session
      ->statusCodeEquals(200);
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $session
      ->pageTextContains('Deleted Content: Article defaults.');
  }

  /**
   * Test that the entity default values load on the entity form.
   *
   * And that they can then be overridden correctly.
   */
  public function testEntityDefaultInheritence() {

    // Initiate session with a user who can manage meta tags and content type
    // fields.
    $permissions = [
      'administer site configuration',
      'administer meta tags',
      'access content',
      'administer node fields',
      'create article content',
      'administer nodes',
      'create article content',
      'create page content',
    ];
    $account = $this
      ->drupalCreateUser($permissions);
    $this
      ->drupalLogin($account);

    // Add a Metatag field to the Article content type.
    $this
      ->drupalGet('admin/structure/types/manage/article/fields/add-field');
    $session = $this
      ->assertSession();
    $session
      ->statusCodeEquals(200);
    $edit = [
      'new_storage_type' => 'metatag',
      'label' => 'Meta tags',
      'field_name' => 'meta_tags',
    ];
    $this
      ->drupalPostForm(NULL, $edit, $this
      ->t('Save and continue'));
    $this
      ->drupalPostForm(NULL, [], $this
      ->t('Save field settings'));
    $session
      ->pageTextContains(strip_tags('Updated field Meta tags field settings.'));
    $this
      ->drupalPostForm(NULL, [], $this
      ->t('Save settings'));
    $session
      ->pageTextContains(strip_tags('Saved Meta tags configuration.'));

    // Try creating an article, confirm the fields are present. This should be
    // the node default values that are shown.
    $this
      ->drupalGet('node/add/article');
    $session
      ->statusCodeEquals(200);
    $session
      ->fieldValueEquals('field_meta_tags[0][basic][title]', '[node:title] | [site:name]');
    $session
      ->fieldValueEquals('field_meta_tags[0][basic][description]', '[node:summary]');

    // Customize the Article content type defaults.
    $this
      ->drupalGet('admin/config/search/metatag/add');
    $session
      ->statusCodeEquals(200);
    $values = [
      'id' => 'node__article',
      'title' => 'Article title override',
      'description' => 'Article description override',
    ];
    $this
      ->drupalPostForm(NULL, $values, 'Save');
    $session
      ->pageTextContains(strip_tags('Created the Content: Article Metatag defaults.'));

    // Try creating an article, this time with the overridden defaults.
    $this
      ->drupalGet('node/add/article');
    $session
      ->statusCodeEquals(200);
    $session
      ->fieldValueEquals('field_meta_tags[0][basic][title]', 'Article title override');
    $session
      ->fieldValueEquals('field_meta_tags[0][basic][description]', 'Article description override');
  }

  /**
   * Test that protected Metatag defaults cannot be deleted.
   */
  public function testDefaultProtected() {

    // Initiate session with a user who can manage metatags.
    $permissions = [
      'administer site configuration',
      'administer meta tags',
    ];
    $account = $this
      ->drupalCreateUser($permissions);
    $this
      ->drupalLogin($account);
    $session = $this
      ->assertSession();

    // Add default metatag for Articles.
    $edit = [
      'id' => 'node__article',
    ];
    $this
      ->drupalPostForm('/admin/config/search/metatag/add', $edit, 'Save');

    // Check that protected defaults contains "Revert" link instead of "Delete".
    foreach (MetatagManager::protectedDefaults() as $protected) {
      $session
        ->linkByHrefExists('/admin/config/search/metatag/' . $protected);
      $session
        ->linkByHrefExists('/admin/config/search/metatag/' . $protected . '/revert');
      $session
        ->linkByHrefNotExists('/admin/config/search/metatag/' . $protected . '/delete');
    }

    // Confirm that non protected defaults can be deleted.
    $session
      ->linkByHrefExists('/admin/config/search/metatag/node__article');
    $session
      ->linkByHrefNotExists('/admin/config/search/metatag/node__article/revert');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/node__article/delete');

    // Visit each protected default page to confirm "Delete" button is hidden.
    foreach (MetatagManager::protectedDefaults() as $protected) {
      $this
        ->drupalGet('/admin/config/search/metatag/' . $protected);
      $session
        ->linkNotExists('Delete');
    }

    // Confirm that non protected defaults can be deleted.
    $this
      ->drupalGet('/admin/config/search/metatag/node__article');
    $session
      ->linkExists('Delete');
  }

  /**
   * Test that metatag list page pager works as expected.
   */
  public function testListPager() {
    $this
      ->loginUser1();
    $session = $this
      ->assertSession();
    $this
      ->drupalGet('admin/config/search/metatag');
    $session
      ->statusCodeEquals(200);
    $session
      ->linkByHrefExists('/admin/config/search/metatag/global');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/front');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/403');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/404');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/node');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/taxonomy_term');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/user');

    // Create 50 vocabularies and generate metatag defaults for all of them.
    for ($i = 0; $i < 50; $i++) {
      $vocabulary = $this
        ->createVocabulary();
      MetatagDefaults::create([
        'id' => 'taxonomy_term__' . $vocabulary
          ->id(),
        'label' => 'Taxonomy term: ' . $vocabulary
          ->label(),
      ])
        ->save();
    }

    // Reload the page.
    $this
      ->drupalGet('admin/config/search/metatag');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/global');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/front');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/403');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/404');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/node');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/taxonomy_term');

    // User entity not visible because it has been pushed to the next page.
    $session
      ->linkByHrefNotExists('/admin/config/search/metatag/user');
    $this
      ->clickLink('Next');

    // Go to next page and confirm that parents are loaded and user us present.
    $session
      ->linkByHrefExists('/admin/config/search/metatag/global');
    $session
      ->linkByHrefExists('/admin/config/search/metatag/taxonomy_term');

    // Main links not visible in the 2nd page.
    $session
      ->linkByHrefNotExists('/admin/config/search/metatag/front');
    $session
      ->linkByHrefNotExists('/admin/config/search/metatag/403');
    $session
      ->linkByHrefNotExists('/admin/config/search/metatag/404');
    $session
      ->linkByHrefNotExists('/admin/config/search/metatag/node');

    // User is present because was pushed to page 2.
    $session
      ->linkByHrefExists('/admin/config/search/metatag/user');
  }

}

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.
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.
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.
MetatagAdminTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
MetatagAdminTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules 1
MetatagAdminTest::setUp protected function Overrides BrowserTestBase::setUp
MetatagAdminTest::testAvailableConfigEntities public function Confirm the available entity types show on the add-default page.
MetatagAdminTest::testDefaultProtected public function Test that protected Metatag defaults cannot be deleted.
MetatagAdminTest::testDefaults public function Tests the interface to manage metatag defaults.
MetatagAdminTest::testEntityDefaultInheritence public function Test that the entity default values load on the entity form.
MetatagAdminTest::testListPager public function Test that metatag list page pager works as expected.
MetatagAdminTest::testOverrides public function Tests entity and bundle overrides.
MetatagAdminTest::testSpecialPages public function Tests special pages.
MetatagHelperTrait::createContentTypeNode private function Create a content type and a node.
MetatagHelperTrait::createTerm private function Create a taxonomy term.
MetatagHelperTrait::createVocabulary private function Create a vocabulary.
MetatagHelperTrait::loginUser1 protected function Log in as user 1.
MetatagHelperTrait::verbose protected function
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.