You are here

class ShortcutLinksTest in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/shortcut/tests/src/Functional/ShortcutLinksTest.php \Drupal\Tests\shortcut\Functional\ShortcutLinksTest
  2. 10 core/modules/shortcut/tests/src/Functional/ShortcutLinksTest.php \Drupal\Tests\shortcut\Functional\ShortcutLinksTest

Create, view, edit, delete, and change shortcut links.

@group shortcut

Hierarchy

Expanded class hierarchy of ShortcutLinksTest

File

core/modules/shortcut/tests/src/Functional/ShortcutLinksTest.php, line 19

Namespace

Drupal\Tests\shortcut\Functional
View source
class ShortcutLinksTest extends ShortcutTestBase {
  use AssertBlockAppearsTrait;
  use PathAliasTestTrait;

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

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalPlaceBlock('page_title_block');
  }

  /**
   * Tests that creating a shortcut works properly.
   */
  public function testShortcutLinkAdd() {
    $set = $this->set;

    // Create an alias for the node so we can test aliases.
    $path_alias = $this
      ->createPathAlias('/node/' . $this->node
      ->id(), '/' . $this
      ->randomMachineName(8));

    // Create some paths to test.
    $test_cases = [
      '/',
      '/admin',
      '/admin/config/system/site-information',
      '/node/' . $this->node
        ->id() . '/edit',
      $path_alias
        ->getAlias(),
      '/router_test/test2',
      '/router_test/test3/value',
    ];
    $test_cases_non_access = [
      '/admin',
      '/admin/config/system/site-information',
    ];

    // Test the add shortcut form UI. Test that the base field description is
    // there.
    $this
      ->drupalGet('admin/config/user-interface/shortcut/manage/' . $set
      ->id() . '/add-link');
    $this
      ->assertRaw('The location this shortcut points to.');

    // Check that each new shortcut links where it should.
    foreach ($test_cases as $test_path) {
      $title = $this
        ->randomMachineName();
      $form_data = [
        'title[0][value]' => $title,
        'link[0][uri]' => $test_path,
      ];
      $this
        ->drupalPostForm('admin/config/user-interface/shortcut/manage/' . $set
        ->id() . '/add-link', $form_data, t('Save'));
      $this
        ->assertSession()
        ->statusCodeEquals(200);
      $this
        ->assertText(t('Added a shortcut for @title.', [
        '@title' => $title,
      ]));
      $saved_set = ShortcutSet::load($set
        ->id());
      $paths = $this
        ->getShortcutInformation($saved_set, 'link');
      $this
        ->assertContains('internal:' . $test_path, $paths, 'Shortcut created: ' . $test_path);
      if (in_array($test_path, $test_cases_non_access)) {
        $this
          ->assertSession()
          ->linkNotExists($title, new FormattableMarkup('Shortcut link %url not accessible on the page.', [
          '%url' => $test_path,
        ]));
      }
      else {
        $this
          ->assertSession()
          ->linkExists($title, 0, new FormattableMarkup('Shortcut link %url found on the page.', [
          '%url' => $test_path,
        ]));
      }
    }
    $saved_set = ShortcutSet::load($set
      ->id());

    // Test that saving and re-loading a shortcut preserves its values.
    $shortcuts = $saved_set
      ->getShortcuts();
    foreach ($shortcuts as $entity) {

      // Test the node routes with parameters.
      $entity
        ->save();
      $loaded = Shortcut::load($entity
        ->id());
      $this
        ->assertEqual($entity->link->uri, $loaded->link->uri);
      $this
        ->assertEqual($entity->link->options, $loaded->link->options);
    }

    // Log in as non admin user, to check that access is checked when creating
    // shortcuts.
    $this
      ->drupalLogin($this->shortcutUser);
    $title = $this
      ->randomMachineName();
    $form_data = [
      'title[0][value]' => $title,
      'link[0][uri]' => '/admin',
    ];
    $this
      ->drupalPostForm('admin/config/user-interface/shortcut/manage/' . $set
      ->id() . '/add-link', $form_data, t('Save'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertRaw(t("The path '@link_path' is inaccessible.", [
      '@link_path' => '/admin',
    ]));
    $form_data = [
      'title[0][value]' => $title,
      'link[0][uri]' => '/node',
    ];
    $this
      ->drupalPostForm('admin/config/user-interface/shortcut/manage/' . $set
      ->id() . '/add-link', $form_data, t('Save'));
    $this
      ->assertSession()
      ->linkExists($title, 0, 'Shortcut link found on the page.');

    // Create a new shortcut set and add a link to it.
    $this
      ->drupalLogin($this->adminUser);
    $edit = [
      'label' => $this
        ->randomMachineName(),
      'id' => strtolower($this
        ->randomMachineName()),
    ];
    $this
      ->drupalPostForm('admin/config/user-interface/shortcut/add-set', $edit, t('Save'));
    $title = $this
      ->randomMachineName();
    $form_data = [
      'title[0][value]' => $title,
      'link[0][uri]' => '/admin',
    ];
    $this
      ->drupalPostForm('admin/config/user-interface/shortcut/manage/' . $edit['id'] . '/add-link', $form_data, t('Save'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
  }

  /**
   * Tests that the "add to shortcut" and "remove from shortcut" links work.
   */
  public function testShortcutQuickLink() {
    \Drupal::service('theme_installer')
      ->install([
      'seven',
    ]);
    $this
      ->config('system.theme')
      ->set('admin', 'seven')
      ->save();
    $this
      ->config('node.settings')
      ->set('use_admin_theme', '1')
      ->save();
    $this->container
      ->get('router.builder')
      ->rebuild();
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->drupalGet('admin/config/system/cron');

    // Test the "Add to shortcuts" link.
    $this
      ->clickLink('Add to Default shortcuts');
    $this
      ->assertText('Added a shortcut for Cron.');
    $this
      ->assertSession()
      ->linkExists('Cron', 0, 'Shortcut link found on page');
    $this
      ->drupalGet('admin/structure');
    $this
      ->assertSession()
      ->linkExists('Cron', 0, 'Shortcut link found on different page');

    // Test the "Remove from shortcuts" link.
    $this
      ->clickLink('Cron');
    $this
      ->clickLink('Remove from Default shortcuts');
    $this
      ->assertText('The shortcut Cron has been deleted.');
    $this
      ->assertSession()
      ->linkNotExists('Cron', 'Shortcut link removed from page');
    $this
      ->drupalGet('admin/structure');
    $this
      ->assertSession()
      ->linkNotExists('Cron', 'Shortcut link removed from different page');
    $this
      ->drupalGet('admin/people');

    // Test the "Add to shortcuts" link for a page generated by views.
    $this
      ->clickLink('Add to Default shortcuts');
    $this
      ->assertText('Added a shortcut for People.');
    $this
      ->assertShortcutQuickLink('Remove from Default shortcuts');

    // Test the "Remove from  shortcuts" link for a page generated by views.
    $this
      ->clickLink('Remove from Default shortcuts');
    $this
      ->assertText('The shortcut People has been deleted.');
    $this
      ->assertShortcutQuickLink('Add to Default shortcuts');

    // Test two pages which use same route name but different route parameters.
    $this
      ->drupalGet('node/add/page');

    // Add Shortcut for Basic Page.
    $this
      ->clickLink('Add to Default shortcuts');
    $this
      ->assertText('Added a shortcut for Create Basic page.');

    // Assure that Article does not have its shortcut indicated as set.
    $this
      ->drupalGet('node/add/article');
    $link = $this
      ->xpath('//a[normalize-space()=:label]', [
      ':label' => 'Remove from Default shortcuts',
    ]);
    $this
      ->assertTrue(empty($link), 'Link Remove to Default shortcuts not found for Create Article page.');

    // Add Shortcut for Article.
    $this
      ->clickLink('Add to Default shortcuts');
    $this
      ->assertText('Added a shortcut for Create Article.');
    $this
      ->config('system.theme')
      ->set('default', 'seven')
      ->save();
    $this
      ->drupalGet('node/' . $this->node
      ->id());
    $title = $this->node
      ->getTitle();

    // Test the "Add to shortcuts" link for node view route.
    $this
      ->clickLink('Add to Default shortcuts');
    $this
      ->assertText(new FormattableMarkup('Added a shortcut for @title.', [
      '@title' => $title,
    ]));
    $this
      ->assertShortcutQuickLink('Remove from Default shortcuts');

    // Test the "Remove from shortcuts" link for node view route.
    $this
      ->clickLink('Remove from Default shortcuts');
    $this
      ->assertText(new FormattableMarkup('The shortcut @title has been deleted.', [
      '@title' => $title,
    ]));
    $this
      ->assertShortcutQuickLink('Add to Default shortcuts');
    \Drupal::service('module_installer')
      ->install([
      'block_content',
    ]);
    BlockContentType::create([
      'id' => 'basic',
      'label' => 'Basic block',
      'revision' => FALSE,
    ])
      ->save();

    // Test page with HTML tags in title.
    $this
      ->drupalGet('admin/structure/block/block-content/manage/basic');
    $page_title = new FormattableMarkup('Edit %label custom block type', [
      '%label' => 'Basic block',
    ]);
    $this
      ->assertRaw($page_title);

    // Add shortcut to this page.
    $this
      ->clickLink('Add to Default shortcuts');
    $this
      ->assertRaw(new FormattableMarkup('Added a shortcut for %title.', [
      '%title' => trim(strip_tags($page_title)),
    ]));
  }

  /**
   * Tests that shortcut links can be renamed.
   */
  public function testShortcutLinkRename() {
    $set = $this->set;

    // Attempt to rename shortcut link.
    $new_link_name = $this
      ->randomMachineName();
    $shortcuts = $set
      ->getShortcuts();
    $shortcut = reset($shortcuts);
    $this
      ->drupalPostForm('admin/config/user-interface/shortcut/link/' . $shortcut
      ->id(), [
      'title[0][value]' => $new_link_name,
    ], t('Save'));
    $saved_set = ShortcutSet::load($set
      ->id());
    $titles = $this
      ->getShortcutInformation($saved_set, 'title');
    $this
      ->assertContains($new_link_name, $titles, 'Shortcut renamed: ' . $new_link_name);
    $this
      ->assertSession()
      ->linkExists($new_link_name, 0, 'Renamed shortcut link appears on the page.');
    $this
      ->assertText(t('The shortcut @link has been updated.', [
      '@link' => $new_link_name,
    ]));
  }

  /**
   * Tests that changing the path of a shortcut link works.
   */
  public function testShortcutLinkChangePath() {
    $set = $this->set;

    // Tests changing a shortcut path.
    $new_link_path = '/admin/config';
    $shortcuts = $set
      ->getShortcuts();
    $shortcut = reset($shortcuts);
    $this
      ->drupalPostForm('admin/config/user-interface/shortcut/link/' . $shortcut
      ->id(), [
      'title[0][value]' => $shortcut
        ->getTitle(),
      'link[0][uri]' => $new_link_path,
    ], t('Save'));
    $saved_set = ShortcutSet::load($set
      ->id());
    $paths = $this
      ->getShortcutInformation($saved_set, 'link');
    $this
      ->assertContains('internal:' . $new_link_path, $paths, 'Shortcut path changed: ' . $new_link_path);
    $this
      ->assertLinkByHref($new_link_path, 0, 'Shortcut with new path appears on the page.');
    $this
      ->assertText(t('The shortcut @link has been updated.', [
      '@link' => $shortcut
        ->getTitle(),
    ]));
  }

  /**
   * Tests that changing the route of a shortcut link works.
   */
  public function testShortcutLinkChangeRoute() {
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->drupalGet('admin/content');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Disable the view.
    View::load('content')
      ->disable()
      ->save();

    /** @var \Drupal\Core\Routing\RouteBuilderInterface $router_builder */
    $router_builder = \Drupal::service('router.builder');
    $router_builder
      ->rebuildIfNeeded();
    $this
      ->drupalGet('admin/content');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
  }

  /**
   * Tests deleting a shortcut link.
   */
  public function testShortcutLinkDelete() {
    $set = $this->set;
    $shortcuts = $set
      ->getShortcuts();
    $shortcut = reset($shortcuts);
    $this
      ->drupalPostForm('admin/config/user-interface/shortcut/link/' . $shortcut
      ->id() . '/delete', [], 'Delete');
    $saved_set = ShortcutSet::load($set
      ->id());
    $ids = $this
      ->getShortcutInformation($saved_set, 'id');
    $this
      ->assertNotContains($shortcut
      ->id(), $ids, 'Successfully deleted a shortcut.');

    // Delete all the remaining shortcut links.
    $storage = \Drupal::entityTypeManager()
      ->getStorage('shortcut');
    $storage
      ->delete($storage
      ->loadMultiple(array_filter($ids)));

    // Get the front page to check that no exceptions occur.
    $this
      ->drupalGet('');
  }

  /**
   * Tests that the add shortcut link is not displayed for 404/403 errors.
   *
   * Tests that the "Add to shortcuts" link is not displayed on a page not
   * found or a page the user does not have access to.
   */
  public function testNoShortcutLink() {

    // Change to a theme that displays shortcuts.
    \Drupal::service('theme_installer')
      ->install([
      'seven',
    ]);
    $this
      ->config('system.theme')
      ->set('default', 'seven')
      ->save();
    $this
      ->drupalGet('page-that-does-not-exist');
    $result = $this
      ->xpath('//a[contains(@class, "shortcut-action--add")]');
    $this
      ->assertTrue(empty($result), 'Add to shortcuts link was not shown on a page not found.');

    // The user does not have access to this path.
    $this
      ->drupalGet('admin/modules');
    $result = $this
      ->xpath('//a[contains(@class, "shortcut-action--add")]');
    $this
      ->assertTrue(empty($result), 'Add to shortcuts link was not shown on a page the user does not have access to.');

    // Verify that the testing mechanism works by verifying the shortcut link
    // appears on admin/content.
    $this
      ->drupalGet('admin/content');
    $result = $this
      ->xpath('//a[contains(@class, "shortcut-action--remove")]');
    $this
      ->assertTrue(!empty($result), 'Remove from shortcuts link was shown on a page the user does have access to.');

    // Verify that the shortcut link appears on routing only pages.
    $this
      ->drupalGet('router_test/test2');
    $result = $this
      ->xpath('//a[contains(@class, "shortcut-action--add")]');
    $this
      ->assertTrue(!empty($result), 'Add to shortcuts link was shown on a page the user does have access to.');
  }

  /**
   * Tests that the 'access shortcuts' permissions works properly.
   */
  public function testAccessShortcutsPermission() {

    // Change to a theme that displays shortcuts.
    \Drupal::service('theme_installer')
      ->install([
      'seven',
    ]);
    $this
      ->config('system.theme')
      ->set('default', 'seven')
      ->save();

    // Add cron to the default shortcut set.
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->drupalGet('admin/config/system/cron');
    $this
      ->clickLink('Add to Default shortcuts');

    // Verify that users without the 'access shortcuts' permission can't see the
    // shortcuts.
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access toolbar',
    ]));
    $this
      ->assertSession()
      ->linkNotExists('Shortcuts', 'Shortcut link not found on page.');

    // Verify that users without the 'administer site configuration' permission
    // can't see the cron shortcuts but can see shortcuts.
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access toolbar',
      'access shortcuts',
    ]));
    $this
      ->assertSession()
      ->linkExists('Shortcuts');
    $this
      ->assertSession()
      ->linkNotExists('Cron', 'Cron shortcut link not found on page.');

    // Verify that users with the 'access shortcuts' permission can see the
    // shortcuts.
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access toolbar',
      'access shortcuts',
      'administer site configuration',
    ]));
    $this
      ->clickLink('Shortcuts', 0, 'Shortcut link found on page.');
    $this
      ->assertSession()
      ->linkExists('Cron', 0, 'Cron shortcut link found on page.');
    $this
      ->verifyAccessShortcutsPermissionForEditPages();
  }

  /**
   * Tests the shortcuts are correctly ordered by weight in the toolbar.
   */
  public function testShortcutLinkOrder() {

    // Ensure to give permissions to access the shortcuts.
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access toolbar',
      'access shortcuts',
      'access content overview',
      'administer content types',
    ]));
    $this
      ->drupalGet(Url::fromRoute('<front>'));
    $shortcuts = $this
      ->cssSelect('#toolbar-item-shortcuts-tray .toolbar-menu a');
    $this
      ->assertEqual($shortcuts[0]
      ->getText(), 'Add content');
    $this
      ->assertEqual($shortcuts[1]
      ->getText(), 'All content');
    foreach ($this->set
      ->getShortcuts() as $shortcut) {
      $shortcut
        ->setWeight($shortcut
        ->getWeight() * -1)
        ->save();
    }
    $this
      ->drupalGet(Url::fromRoute('<front>'));
    $shortcuts = $this
      ->cssSelect('#toolbar-item-shortcuts-tray .toolbar-menu a');
    $this
      ->assertEqual($shortcuts[0]
      ->getText(), 'All content');
    $this
      ->assertEqual($shortcuts[1]
      ->getText(), 'Add content');
  }

  /**
   * Tests that the 'access shortcuts' permission is required for shortcut set
   * administration page access.
   */
  private function verifyAccessShortcutsPermissionForEditPages() {

    // Create a user with customize links and switch sets permissions  but
    // without the 'access shortcuts' permission.
    $test_permissions = [
      'customize shortcut links',
      'switch shortcut sets',
    ];
    $noaccess_user = $this
      ->drupalCreateUser($test_permissions);
    $this
      ->drupalLogin($noaccess_user);

    // Verify that set administration pages are inaccessible without the
    // 'access shortcuts' permission.
    $this
      ->drupalGet('admin/config/user-interface/shortcut/manage/default/customize');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
    $this
      ->drupalGet('admin/config/user-interface/shortcut/manage/default');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
    $this
      ->drupalGet('user/' . $noaccess_user
      ->id() . '/shortcuts');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
  }

  /**
   * Tests that the 'access shortcuts' permission is required to access the
   * shortcut block.
   */
  public function testShortcutBlockAccess() {

    // Creates a block instance and place in a region through api.
    $block = $this
      ->drupalPlaceBlock('shortcuts');

    // Verify that users with the 'access shortcuts' permission can see the
    // shortcut block.
    $this
      ->drupalLogin($this->shortcutUser);
    $this
      ->drupalGet('');
    $this
      ->assertBlockAppears($block);
    $this
      ->drupalLogout();

    // Verify that users without the 'access shortcuts' permission can see the
    // shortcut block.
    $this
      ->drupalLogin($this
      ->drupalCreateUser([]));
    $this
      ->drupalGet('');
    $this
      ->assertNoBlockAppears($block);
  }

  /**
   * Passes if a shortcut quick link with the specified label is found.
   *
   * An optional link index may be passed.
   *
   * @param string $label
   *   Text between the anchor tags.
   * @param int $index
   *   Link position counting from zero.
   * @param string $message
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use new FormattableMarkup() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
   * @param string $group
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
   *
   * @return bool
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertShortcutQuickLink($label, $index = 0, $message = '', $group = 'Other') {
    $links = $this
      ->xpath('//a[normalize-space()=:label]', [
      ':label' => $label,
    ]);
    $message = $message ? $message : new FormattableMarkup('Shortcut quick link with label %label found.', [
      '%label' => $label,
    ]);
    return $this
      ->assert(isset($links[$index]), $message, $group);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertBlockAppearsTrait::assertBlockAppears protected function Checks to see whether a block appears on the page.
AssertBlockAppearsTrait::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
AssertBlockAppearsTrait::findBlockInstance protected function Find a block instance on the page.
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
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.
ShortcutLinksTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ShortcutLinksTest::$modules public static property Modules to enable. Overrides ShortcutTestBase::$modules
ShortcutLinksTest::assertShortcutQuickLink protected function Passes if a shortcut quick link with the specified label is found.
ShortcutLinksTest::setUp protected function Overrides ShortcutTestBase::setUp
ShortcutLinksTest::testAccessShortcutsPermission public function Tests that the 'access shortcuts' permissions works properly.
ShortcutLinksTest::testNoShortcutLink public function Tests that the add shortcut link is not displayed for 404/403 errors.
ShortcutLinksTest::testShortcutBlockAccess public function Tests that the 'access shortcuts' permission is required to access the shortcut block.
ShortcutLinksTest::testShortcutLinkAdd public function Tests that creating a shortcut works properly.
ShortcutLinksTest::testShortcutLinkChangePath public function Tests that changing the path of a shortcut link works.
ShortcutLinksTest::testShortcutLinkChangeRoute public function Tests that changing the route of a shortcut link works.
ShortcutLinksTest::testShortcutLinkDelete public function Tests deleting a shortcut link.
ShortcutLinksTest::testShortcutLinkOrder public function Tests the shortcuts are correctly ordered by weight in the toolbar.
ShortcutLinksTest::testShortcutLinkRename public function Tests that shortcut links can be renamed.
ShortcutLinksTest::testShortcutQuickLink public function Tests that the "add to shortcut" and "remove from shortcut" links work.
ShortcutLinksTest::verifyAccessShortcutsPermissionForEditPages private function Tests that the 'access shortcuts' permission is required for shortcut set administration page access.
ShortcutTestBase::$adminUser protected property User with permission to administer shortcuts.
ShortcutTestBase::$node protected property Generic node used for testing.
ShortcutTestBase::$set protected property Site-wide default shortcut set.
ShortcutTestBase::$shortcutUser protected property User with permission to use shortcuts, but not administer them.
ShortcutTestBase::generateShortcutSet public function Creates a generic shortcut set.
ShortcutTestBase::getShortcutInformation public function Extracts information from shortcut set links.
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.