You are here

class PathAliasTest in Drupal 8

Same name in this branch
  1. 8 core/modules/path/tests/src/Functional/PathAliasTest.php \Drupal\Tests\path\Functional\PathAliasTest
  2. 8 core/modules/jsonapi/tests/src/Functional/PathAliasTest.php \Drupal\Tests\jsonapi\Functional\PathAliasTest
Same name and namespace in other branches
  1. 9 core/modules/path/tests/src/Functional/PathAliasTest.php \Drupal\Tests\path\Functional\PathAliasTest

Add, edit, delete, and change alias and verify its consistency in the database.

@group path

Hierarchy

Expanded class hierarchy of PathAliasTest

File

core/modules/path/tests/src/Functional/PathAliasTest.php, line 15

Namespace

Drupal\Tests\path\Functional
View source
class PathAliasTest extends PathTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'path',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';
  protected function setUp() {
    parent::setUp();

    // Create test user and log in.
    $web_user = $this
      ->drupalCreateUser([
      'create page content',
      'edit own page content',
      'administer url aliases',
      'create url aliases',
      'access content overview',
    ]);
    $this
      ->drupalLogin($web_user);
  }

  /**
   * Tests the path cache.
   */
  public function testPathCache() {

    // Create test node.
    $node1 = $this
      ->drupalCreateNode();

    // Create alias.
    $edit = [];
    $edit['path[0][value]'] = '/node/' . $node1
      ->id();
    $edit['alias[0][value]'] = '/' . $this
      ->randomMachineName(8);
    $this
      ->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));

    // Check the path alias whitelist cache.
    $whitelist = \Drupal::cache('bootstrap')
      ->get('path_alias_whitelist');
    $this
      ->assertTrue($whitelist->data['node']);
    $this
      ->assertFalse($whitelist->data['admin']);

    // Visit the system path for the node and confirm a cache entry is
    // created.
    \Drupal::cache('data')
      ->deleteAll();

    // Make sure the path is not converted to the alias.
    $this
      ->drupalGet(trim($edit['path[0][value]'], '/'), [
      'alias' => TRUE,
    ]);
    $this
      ->assertNotEmpty(\Drupal::cache('data')
      ->get('preload-paths:' . $edit['path[0][value]']), 'Cache entry was created.');

    // Visit the alias for the node and confirm a cache entry is created.
    \Drupal::cache('data')
      ->deleteAll();

    // @todo Remove this once https://www.drupal.org/node/2480077 lands.
    Cache::invalidateTags([
      'rendered',
    ]);
    $this
      ->drupalGet(trim($edit['alias[0][value]'], '/'));
    $this
      ->assertNotEmpty(\Drupal::cache('data')
      ->get('preload-paths:' . $edit['path[0][value]']), 'Cache entry was created.');
  }

  /**
   * Tests alias functionality through the admin interfaces.
   */
  public function testAdminAlias() {

    // Create test node.
    $node1 = $this
      ->drupalCreateNode();

    // Create alias.
    $edit = [];
    $edit['path[0][value]'] = '/node/' . $node1
      ->id();
    $edit['alias[0][value]'] = '/' . $this
      ->getRandomGenerator()
      ->word(8);
    $this
      ->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));

    // Confirm that the alias works.
    $this
      ->drupalGet($edit['alias[0][value]']);
    $this
      ->assertText($node1
      ->label(), 'Alias works.');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Confirm that the alias works in a case-insensitive way.
    $this
      ->assertTrue(ctype_lower(ltrim($edit['alias[0][value]'], '/')));
    $this
      ->drupalGet($edit['alias[0][value]']);
    $this
      ->assertText($node1
      ->label(), 'Alias works lower case.');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->drupalGet(mb_strtoupper($edit['alias[0][value]']));
    $this
      ->assertText($node1
      ->label(), 'Alias works upper case.');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Change alias to one containing "exotic" characters.
    $pid = $this
      ->getPID($edit['alias[0][value]']);
    $previous = $edit['alias[0][value]'];

    // Lower-case letters.
    $edit['alias[0][value]'] = '/alias' . "- ._~!\$'\"()*@[]?&+%#,;=:" . "%23%25%26%2B%2F%3F" . "中國書۞";
    $connection = Database::getConnection();
    if ($connection
      ->databaseType() != 'sqlite') {

      // When using LIKE for case-insensitivity, the SQLite driver is
      // currently unable to find the upper-case versions of non-ASCII
      // characters.
      // @todo fix this in https://www.drupal.org/node/2607432
      $edit['alias[0][value]'] .= "ïвβéø";
    }
    $this
      ->drupalPostForm('admin/config/search/path/edit/' . $pid, $edit, t('Save'));

    // Confirm that the alias works.
    $this
      ->drupalGet(mb_strtoupper($edit['alias[0][value]']));
    $this
      ->assertText($node1
      ->label(), 'Changed alias works.');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this->container
      ->get('path_alias.manager')
      ->cacheClear();

    // Confirm that previous alias no longer works.
    $this
      ->drupalGet($previous);
    $this
      ->assertNoText($node1
      ->label(), 'Previous alias no longer works.');
    $this
      ->assertSession()
      ->statusCodeEquals(404);

    // Create second test node.
    $node2 = $this
      ->drupalCreateNode();

    // Set alias to second test node.
    $edit['path[0][value]'] = '/node/' . $node2
      ->id();

    // leave $edit['alias'] the same
    $this
      ->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));

    // Confirm no duplicate was created.
    $this
      ->assertRaw(t('The alias %alias is already in use in this language.', [
      '%alias' => $edit['alias[0][value]'],
    ]), 'Attempt to move alias was rejected.');
    $edit_upper = $edit;
    $edit_upper['alias[0][value]'] = mb_strtoupper($edit['alias[0][value]']);
    $this
      ->drupalPostForm('admin/config/search/path/add', $edit_upper, t('Save'));
    $this
      ->assertRaw(t('The alias %alias could not be added because it is already in use in this language with different capitalization: %stored_alias.', [
      '%alias' => $edit_upper['alias[0][value]'],
      '%stored_alias' => $edit['alias[0][value]'],
    ]), 'Attempt to move upper-case alias was rejected.');

    // Delete alias.
    $this
      ->drupalGet('admin/config/search/path/edit/' . $pid);
    $this
      ->clickLink(t('Delete'));
    $this
      ->assertRaw(t('Are you sure you want to delete the URL alias %name?', [
      '%name' => $edit['alias[0][value]'],
    ]));
    $this
      ->drupalPostForm(NULL, [], t('Delete'));

    // Confirm that the alias no longer works.
    $this
      ->drupalGet($edit['alias[0][value]']);
    $this
      ->assertNoText($node1
      ->label(), 'Alias was successfully deleted.');
    $this
      ->assertSession()
      ->statusCodeEquals(404);

    // Create a really long alias.
    $edit = [];
    $edit['path[0][value]'] = '/node/' . $node1
      ->id();
    $alias = '/' . $this
      ->randomMachineName(128);
    $edit['alias[0][value]'] = $alias;

    // The alias is shortened to 50 characters counting the ellipsis.
    $truncated_alias = substr($alias, 0, 47);
    $this
      ->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
    $this
      ->assertNoText($alias, 'The untruncated alias was not found.');

    // The 'truncated' alias will always be found.
    $this
      ->assertText($truncated_alias, 'The truncated alias was found.');

    // Create third test node.
    $node3 = $this
      ->drupalCreateNode();

    // Create absolute path alias.
    $edit = [];
    $edit['path[0][value]'] = '/node/' . $node3
      ->id();
    $node3_alias = '/' . $this
      ->randomMachineName(8);
    $edit['alias[0][value]'] = $node3_alias;
    $this
      ->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));

    // Create fourth test node.
    $node4 = $this
      ->drupalCreateNode();

    // Create alias with trailing slash.
    $edit = [];
    $edit['path[0][value]'] = '/node/' . $node4
      ->id();
    $node4_alias = '/' . $this
      ->randomMachineName(8);
    $edit['alias[0][value]'] = $node4_alias . '/';
    $this
      ->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));

    // Confirm that the alias with trailing slash is not found.
    $this
      ->assertNoText($edit['alias[0][value]'], 'The absolute alias was not found.');

    // The alias without trailing flash is found.
    $this
      ->assertText(trim($edit['alias[0][value]'], '/'), 'The alias without trailing slash was found.');

    // Update an existing alias to point to a different source.
    $pid = $this
      ->getPID($node4_alias);
    $edit = [];
    $edit['alias[0][value]'] = $node4_alias;
    $edit['path[0][value]'] = '/node/' . $node2
      ->id();
    $this
      ->drupalPostForm('admin/config/search/path/edit/' . $pid, $edit, t('Save'));
    $this
      ->assertText('The alias has been saved.');
    $this
      ->drupalGet($edit['alias[0][value]']);
    $this
      ->assertNoText($node4
      ->label(), 'Previous alias no longer works.');
    $this
      ->assertText($node2
      ->label(), 'Alias works.');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Update an existing alias to use a duplicate alias.
    $pid = $this
      ->getPID($node3_alias);
    $edit = [];
    $edit['alias[0][value]'] = $node4_alias;
    $edit['path[0][value]'] = '/node/' . $node3
      ->id();
    $this
      ->drupalPostForm('admin/config/search/path/edit/' . $pid, $edit, t('Save'));
    $this
      ->assertRaw(t('The alias %alias is already in use in this language.', [
      '%alias' => $edit['alias[0][value]'],
    ]));

    // Create an alias without a starting slash.
    $node5 = $this
      ->drupalCreateNode();
    $edit = [];
    $edit['path[0][value]'] = 'node/' . $node5
      ->id();
    $node5_alias = $this
      ->randomMachineName(8);
    $edit['alias[0][value]'] = $node5_alias . '/';
    $this
      ->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
    $this
      ->assertUrl('admin/config/search/path/add');
    $this
      ->assertText('The source path has to start with a slash.');
    $this
      ->assertText('The alias path has to start with a slash.');
  }

  /**
   * Tests alias functionality through the node interfaces.
   */
  public function testNodeAlias() {

    // Create test node.
    $node1 = $this
      ->drupalCreateNode();

    // Create alias.
    $edit = [];
    $edit['path[0][alias]'] = '/' . $this
      ->randomMachineName(8);
    $this
      ->drupalPostForm('node/' . $node1
      ->id() . '/edit', $edit, t('Save'));

    // Confirm that the alias works.
    $this
      ->drupalGet($edit['path[0][alias]']);
    $this
      ->assertText($node1
      ->label(), 'Alias works.');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Confirm the 'canonical' and 'shortlink' URLs.
    $elements = $this
      ->xpath("//link[contains(@rel, 'canonical') and contains(@href, '" . $edit['path[0][alias]'] . "')]");
    $this
      ->assertTrue(!empty($elements), 'Page contains canonical link URL.');
    $elements = $this
      ->xpath("//link[contains(@rel, 'shortlink') and contains(@href, 'node/" . $node1
      ->id() . "')]");
    $this
      ->assertTrue(!empty($elements), 'Page contains shortlink URL.');
    $previous = $edit['path[0][alias]'];

    // Change alias to one containing "exotic" characters.
    // Lower-case letters.
    $edit['path[0][alias]'] = '/alias' . "- ._~!\$'\"()*@[]?&+%#,;=:" . "%23%25%26%2B%2F%3F" . "中國書۞";
    $connection = Database::getConnection();
    if ($connection
      ->databaseType() != 'sqlite') {

      // When using LIKE for case-insensitivity, the SQLite driver is
      // currently unable to find the upper-case versions of non-ASCII
      // characters.
      // @todo fix this in https://www.drupal.org/node/2607432
      $edit['path[0][alias]'] .= "ïвβéø";
    }
    $this
      ->drupalPostForm('node/' . $node1
      ->id() . '/edit', $edit, t('Save'));

    // Confirm that the alias works.
    $this
      ->drupalGet(mb_strtoupper($edit['path[0][alias]']));
    $this
      ->assertText($node1
      ->label(), 'Changed alias works.');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Make sure that previous alias no longer works.
    $this
      ->drupalGet($previous);
    $this
      ->assertNoText($node1
      ->label(), 'Previous alias no longer works.');
    $this
      ->assertSession()
      ->statusCodeEquals(404);

    // Create second test node.
    $node2 = $this
      ->drupalCreateNode();

    // Set alias to second test node.
    // Leave $edit['path[0][alias]'] the same.
    $this
      ->drupalPostForm('node/' . $node2
      ->id() . '/edit', $edit, t('Save'));

    // Confirm that the alias didn't make a duplicate.
    $this
      ->assertSession()
      ->pageTextContains("The alias {$edit['path[0][alias]']} is already in use in this language.");

    // Delete alias.
    $this
      ->drupalPostForm('node/' . $node1
      ->id() . '/edit', [
      'path[0][alias]' => '',
    ], t('Save'));

    // Confirm that the alias no longer works.
    $this
      ->drupalGet($edit['path[0][alias]']);
    $this
      ->assertNoText($node1
      ->label(), 'Alias was successfully deleted.');
    $this
      ->assertSession()
      ->statusCodeEquals(404);

    // Create third test node.
    $node3 = $this
      ->drupalCreateNode();

    // Set its path alias to an absolute path.
    $edit = [
      'path[0][alias]' => '/' . $this
        ->randomMachineName(8),
    ];
    $this
      ->drupalPostForm('node/' . $node3
      ->id() . '/edit', $edit, t('Save'));

    // Confirm that the alias was converted to a relative path.
    $this
      ->drupalGet(trim($edit['path[0][alias]'], '/'));
    $this
      ->assertText($node3
      ->label(), 'Alias became relative.');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Create fourth test node.
    $node4 = $this
      ->drupalCreateNode();

    // Set its path alias to have a trailing slash.
    $edit = [
      'path[0][alias]' => '/' . $this
        ->randomMachineName(8) . '/',
    ];
    $this
      ->drupalPostForm('node/' . $node4
      ->id() . '/edit', $edit, t('Save'));

    // Confirm that the alias was converted to a relative path.
    $this
      ->drupalGet(trim($edit['path[0][alias]'], '/'));
    $this
      ->assertText($node4
      ->label(), 'Alias trimmed trailing slash.');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Create fifth test node.
    $node5 = $this
      ->drupalCreateNode();

    // Set a path alias.
    $edit = [
      'path[0][alias]' => '/' . $this
        ->randomMachineName(8),
    ];
    $this
      ->drupalPostForm('node/' . $node5
      ->id() . '/edit', $edit, t('Save'));

    // Delete the node and check that the path alias is also deleted.
    $node5
      ->delete();
    $path_alias = \Drupal::service('path_alias.repository')
      ->lookUpBySystemPath('/node/' . $node5
      ->id(), $node5
      ->language()
      ->getId());
    $this
      ->assertNull($path_alias, 'Alias was successfully deleted when the referenced node was deleted.');

    // Create sixth test node.
    $node6 = $this
      ->drupalCreateNode();

    // Test the special case where the alias is '0'.
    $edit = [
      'path[0][alias]' => '0',
    ];
    $this
      ->drupalGet($node6
      ->toUrl('edit-form'));
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('The alias path has to start with a slash.');

    // Create an invalid alias with two leading slashes and verify that the
    // extra slash is removed when the link is generated. This ensures that URL
    // aliases cannot be used to inject external URLs.
    // @todo The user interface should either display an error message or
    //   automatically trim these invalid aliases, rather than allowing them to
    //   be silently created, at which point the functional aspects of this
    //   test will need to be moved elsewhere and switch to using a
    //   programmatically-created alias instead.
    $alias = $this
      ->randomMachineName(8);
    $edit = [
      'path[0][alias]' => '//' . $alias,
    ];
    $this
      ->drupalPostForm($node6
      ->toUrl('edit-form'), $edit, t('Save'));
    $this
      ->drupalGet(Url::fromRoute('system.admin_content'));

    // This checks the link href before clicking it, rather than using
    // \Drupal\Tests\BrowserTestBase::assertSession()->addressEquals() after
    // clicking it, because the test browser does not always preserve the
    // correct number of slashes in the URL when it visits internal links;
    // using \Drupal\Tests\BrowserTestBase::assertSession()->addressEquals()
    // would actually make the test pass unconditionally on the testbot (or
    // anywhere else where Drupal is installed in a subdirectory).
    $link_xpath = $this
      ->xpath('//a[normalize-space(text())=:label]', [
      ':label' => $node6
        ->getTitle(),
    ]);
    $link_href = $link_xpath[0]
      ->getAttribute('href');
    $this
      ->assertEquals($link_href, base_path() . $alias);
    $this
      ->clickLink($node6
      ->getTitle());
    $this
      ->assertSession()
      ->statusCodeEquals(404);
  }

  /**
   * Returns the path ID.
   *
   * @param string $alias
   *   A string containing an aliased path.
   *
   * @return int
   *   Integer representing the path ID.
   */
  public function getPID($alias) {
    $result = \Drupal::entityTypeManager()
      ->getStorage('path_alias')
      ->getQuery()
      ->condition('alias', $alias, '=')
      ->accessCheck(FALSE)
      ->execute();
    return reset($result);
  }

  /**
   * Tests that duplicate aliases fail validation.
   */
  public function testDuplicateNodeAlias() {

    // Create one node with a random alias.
    $node_one = $this
      ->drupalCreateNode();
    $edit = [];
    $edit['path[0][alias]'] = '/' . $this
      ->randomMachineName();
    $this
      ->drupalPostForm('node/' . $node_one
      ->id() . '/edit', $edit, t('Save'));

    // Now create another node and try to set the same alias.
    $node_two = $this
      ->drupalCreateNode();
    $this
      ->drupalPostForm('node/' . $node_two
      ->id() . '/edit', $edit, t('Save'));
    $this
      ->assertSession()
      ->pageTextContains("The alias {$edit['path[0][alias]']} is already in use in this language.");
    $this
      ->assertFieldByXPath("//input[@name='path[0][alias]' and contains(@class, 'error')]", $edit['path[0][alias]'], 'Textfield exists and has the error class.');

    // Behavior here differs with the inline_form_errors module enabled.
    // Enable the inline_form_errors module and try this again. This module
    // improves validation with a link in the error message(s) to the fields
    // which have invalid input.
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'inline_form_errors',
    ], TRUE), 'Installed inline_form_errors.');

    // Attempt to edit the second node again, as before.
    $this
      ->drupalPostForm('node/' . $node_two
      ->id() . '/edit', $edit, t('Preview'));

    // This error should still be present next to the field.
    $this
      ->assertSession()
      ->pageTextContains("The alias {$edit['path[0][alias]']} is already in use in this language.");

    // The validation error set for the page should include this text.
    $this
      ->assertSession()
      ->pageTextContains(t('1 error has been found: URL alias'), 'Form error found with expected text.');

    // The text 'URL alias' should be a link.
    $this
      ->assertSession()
      ->linkExists('URL alias');

    // The link should be to the ID of the URL alias field.
    $this
      ->assertSession()
      ->linkByHrefExists('#edit-path-0-alias');
  }

}

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.
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
PathAliasTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
PathAliasTest::$modules public static property Modules to enable. Overrides PathTestBase::$modules
PathAliasTest::getPID public function Returns the path ID.
PathAliasTest::setUp protected function Overrides PathTestBase::setUp
PathAliasTest::testAdminAlias public function Tests alias functionality through the admin interfaces.
PathAliasTest::testDuplicateNodeAlias public function Tests that duplicate aliases fail validation.
PathAliasTest::testNodeAlias public function Tests alias functionality through the node interfaces.
PathAliasTest::testPathCache public function Tests the path cache.
PathAliasTestTrait::assertPathAliasExists protected function Asserts that a path alias exists in the storage.
PathAliasTestTrait::assertPathAliasNotExists protected function Asserts that a path alias does not exist in the storage.
PathAliasTestTrait::createPathAlias protected function Creates a new path alias.
PathAliasTestTrait::loadPathAliasByConditions protected function Gets the first result from a 'load by properties' storage call.
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.