You are here

class TrackerTest in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/tracker/tests/src/Functional/TrackerTest.php \Drupal\Tests\tracker\Functional\TrackerTest

Create and delete nodes and check for their display in the tracker listings.

@group tracker

Hierarchy

Expanded class hierarchy of TrackerTest

File

core/modules/tracker/tests/src/Functional/TrackerTest.php, line 22

Namespace

Drupal\Tests\tracker\Functional
View source
class TrackerTest extends BrowserTestBase {
  use CommentTestTrait;
  use AssertPageCacheContextsAndTagsTrait;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'block',
    'comment',
    'tracker',
    'history',
    'node_test',
  ];

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

  /**
   * The main user for testing.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $user;

  /**
   * A second user that will 'create' comments and nodes.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $otherUser;
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalCreateContentType([
      'type' => 'page',
      'name' => 'Basic page',
    ]);
    $permissions = [
      'access comments',
      'create page content',
      'post comments',
      'skip comment approval',
    ];
    $this->user = $this
      ->drupalCreateUser($permissions);
    $this->otherUser = $this
      ->drupalCreateUser($permissions);
    $this
      ->addDefaultCommentField('node', 'page');
    user_role_grant_permissions(AccountInterface::ANONYMOUS_ROLE, [
      'access content',
      'access user profiles',
    ]);
    $this
      ->drupalPlaceBlock('local_tasks_block', [
      'id' => 'page_tabs_block',
    ]);
    $this
      ->drupalPlaceBlock('local_actions_block', [
      'id' => 'page_actions_block',
    ]);
  }

  /**
   * Tests for the presence of nodes on the global tracker listing.
   */
  public function testTrackerAll() {
    $this
      ->drupalLogin($this->user);
    $unpublished = $this
      ->drupalCreateNode([
      'title' => $this
        ->randomMachineName(8),
      'status' => 0,
    ]);
    $published = $this
      ->drupalCreateNode([
      'title' => $this
        ->randomMachineName(8),
      'status' => 1,
    ]);
    $this
      ->drupalGet('activity');
    $this
      ->assertNoText($unpublished
      ->label(), 'Unpublished node does not show up in the tracker listing.');
    $this
      ->assertText($published
      ->label(), 'Published node shows up in the tracker listing.');
    $this
      ->assertSession()
      ->linkExists(t('My recent content'), 0, 'User tab shows up on the global tracker page.');

    // Assert cache contexts, specifically the pager and node access contexts.
    $this
      ->assertCacheContexts([
      'languages:language_interface',
      'route',
      'theme',
      'url.query_args:' . MainContentViewSubscriber::WRAPPER_FORMAT,
      'url.query_args.pagers:0',
      'user.node_grants:view',
      'user',
    ]);

    // Assert cache tags for the action/tabs blocks, visible node, and node list
    // cache tag.
    $expected_tags = Cache::mergeTags($published
      ->getCacheTags(), $published
      ->getOwner()
      ->getCacheTags());

    // Because the 'user.permissions' cache context is being optimized away.
    $role_tags = [];
    foreach ($this->user
      ->getRoles() as $rid) {
      $role_tags[] = "config:user.role.{$rid}";
    }
    $expected_tags = Cache::mergeTags($expected_tags, $role_tags);
    $block_tags = [
      'block_view',
      'local_task',
      'config:block.block.page_actions_block',
      'config:block.block.page_tabs_block',
      'config:block_list',
    ];
    $expected_tags = Cache::mergeTags($expected_tags, $block_tags);
    $additional_tags = [
      'node_list',
      'rendered',
    ];
    $expected_tags = Cache::mergeTags($expected_tags, $additional_tags);
    $this
      ->assertCacheTags($expected_tags);

    // Delete a node and ensure it no longer appears on the tracker.
    $published
      ->delete();
    $this
      ->drupalGet('activity');
    $this
      ->assertNoText($published
      ->label(), 'Deleted node does not show up in the tracker listing.');

    // Test proper display of time on activity page when comments are disabled.
    // Disable comments.
    FieldStorageConfig::loadByName('node', 'comment')
      ->delete();
    $node = $this
      ->drupalCreateNode([
      // This title is required to trigger the custom changed time set in the
      // node_test module. This is needed in order to ensure a sufficiently
      // large 'time ago' interval that isn't numbered in seconds.
      'title' => 'testing_node_presave',
      'status' => 1,
    ]);
    $this
      ->drupalGet('activity');
    $this
      ->assertText($node
      ->label(), 'Published node shows up in the tracker listing.');
    $this
      ->assertText(\Drupal::service('date.formatter')
      ->formatTimeDiffSince($node
      ->getChangedTime()), 'The changed time was displayed on the tracker listing.');
  }

  /**
   * Tests for the presence of nodes on a user's tracker listing.
   */
  public function testTrackerUser() {
    $this
      ->drupalLogin($this->user);
    $unpublished = $this
      ->drupalCreateNode([
      'title' => $this
        ->randomMachineName(8),
      'uid' => $this->user
        ->id(),
      'status' => 0,
    ]);
    $my_published = $this
      ->drupalCreateNode([
      'title' => $this
        ->randomMachineName(8),
      'uid' => $this->user
        ->id(),
      'status' => 1,
    ]);
    $other_published_no_comment = $this
      ->drupalCreateNode([
      'title' => $this
        ->randomMachineName(8),
      'uid' => $this->otherUser
        ->id(),
      'status' => 1,
    ]);
    $other_published_my_comment = $this
      ->drupalCreateNode([
      'title' => $this
        ->randomMachineName(8),
      'uid' => $this->otherUser
        ->id(),
      'status' => 1,
    ]);
    $comment = [
      'subject[0][value]' => $this
        ->randomMachineName(),
      'comment_body[0][value]' => $this
        ->randomMachineName(20),
    ];
    $this
      ->drupalPostForm('comment/reply/node/' . $other_published_my_comment
      ->id() . '/comment', $comment, t('Save'));
    $this
      ->drupalGet('user/' . $this->user
      ->id() . '/activity');
    $this
      ->assertNoText($unpublished
      ->label(), "Unpublished nodes do not show up in the user's tracker listing.");
    $this
      ->assertText($my_published
      ->label(), "Published nodes show up in the user's tracker listing.");
    $this
      ->assertNoText($other_published_no_comment
      ->label(), "Another user's nodes do not show up in the user's tracker listing.");
    $this
      ->assertText($other_published_my_comment
      ->label(), "Nodes that the user has commented on appear in the user's tracker listing.");

    // Assert cache contexts.
    $this
      ->assertCacheContexts([
      'languages:language_interface',
      'route',
      'theme',
      'url.query_args:' . MainContentViewSubscriber::WRAPPER_FORMAT,
      'url.query_args.pagers:0',
      'user',
      'user.node_grants:view',
    ]);

    // Assert cache tags for the visible nodes (including owners) and node list
    // cache tag.
    $expected_tags = Cache::mergeTags($my_published
      ->getCacheTags(), $my_published
      ->getOwner()
      ->getCacheTags());
    $expected_tags = Cache::mergeTags($expected_tags, $other_published_my_comment
      ->getCacheTags());
    $expected_tags = Cache::mergeTags($expected_tags, $other_published_my_comment
      ->getOwner()
      ->getCacheTags());

    // Because the 'user.permissions' cache context is being optimized away.
    $role_tags = [];
    foreach ($this->user
      ->getRoles() as $rid) {
      $role_tags[] = "config:user.role.{$rid}";
    }
    $expected_tags = Cache::mergeTags($expected_tags, $role_tags);
    $block_tags = [
      'block_view',
      'local_task',
      'config:block.block.page_actions_block',
      'config:block.block.page_tabs_block',
      'config:block_list',
    ];
    $expected_tags = Cache::mergeTags($expected_tags, $block_tags);
    $additional_tags = [
      'node_list',
      'rendered',
    ];
    $expected_tags = Cache::mergeTags($expected_tags, $additional_tags);
    $this
      ->assertCacheTags($expected_tags);
    $this
      ->assertCacheContexts([
      'languages:language_interface',
      'route',
      'theme',
      'url.query_args:' . MainContentViewSubscriber::WRAPPER_FORMAT,
      'url.query_args.pagers:0',
      'user',
      'user.node_grants:view',
    ]);
    $this
      ->assertSession()
      ->linkExists($my_published
      ->label());
    $this
      ->assertSession()
      ->linkNotExists($unpublished
      ->label());

    // Verify that title and tab title have been set correctly.
    $this
      ->assertText('Activity', 'The user activity tab has the name "Activity".');
    $this
      ->assertTitle($this->user
      ->getAccountName() . ' | Drupal');

    // Verify that unpublished comments are removed from the tracker.
    $admin_user = $this
      ->drupalCreateUser([
      'post comments',
      'administer comments',
      'access user profiles',
    ]);
    $this
      ->drupalLogin($admin_user);
    $this
      ->drupalPostForm('comment/1/edit', [
      'status' => CommentInterface::NOT_PUBLISHED,
    ], t('Save'));
    $this
      ->drupalGet('user/' . $this->user
      ->id() . '/activity');
    $this
      ->assertNoText($other_published_my_comment
      ->label(), 'Unpublished comments are not counted on the tracker listing.');

    // Test escaping of title on user's tracker tab.
    \Drupal::service('module_installer')
      ->install([
      'user_hooks_test',
    ]);
    Cache::invalidateTags([
      'rendered',
    ]);
    \Drupal::state()
      ->set('user_hooks_test_user_format_name_alter', TRUE);
    $this
      ->drupalGet('user/' . $this->user
      ->id() . '/activity');
    $this
      ->assertEscaped('<em>' . $this->user
      ->id() . '</em>');
    \Drupal::state()
      ->set('user_hooks_test_user_format_name_alter_safe', TRUE);
    Cache::invalidateTags([
      'rendered',
    ]);
    $this
      ->drupalGet('user/' . $this->user
      ->id() . '/activity');
    $this
      ->assertNoEscaped('<em>' . $this->user
      ->id() . '</em>');
    $this
      ->assertRaw('<em>' . $this->user
      ->id() . '</em>');
  }

  /**
   * Tests the metadata for the "new"/"updated" indicators.
   */
  public function testTrackerHistoryMetadata() {
    $this
      ->drupalLogin($this->user);

    // Create a page node.
    $edit = [
      'title' => $this
        ->randomMachineName(8),
    ];
    $node = $this
      ->drupalCreateNode($edit);

    // Verify that the history metadata is present.
    $this
      ->drupalGet('activity');
    $this
      ->assertHistoryMetadata($node
      ->id(), $node
      ->getChangedTime(), $node
      ->getChangedTime());
    $this
      ->drupalGet('activity/' . $this->user
      ->id());
    $this
      ->assertHistoryMetadata($node
      ->id(), $node
      ->getChangedTime(), $node
      ->getChangedTime());
    $this
      ->drupalGet('user/' . $this->user
      ->id() . '/activity');
    $this
      ->assertHistoryMetadata($node
      ->id(), $node
      ->getChangedTime(), $node
      ->getChangedTime());

    // Add a comment to the page, make sure it is created after the node by
    // sleeping for one second, to ensure the last comment timestamp is
    // different from before.
    $comment = [
      'subject[0][value]' => $this
        ->randomMachineName(),
      'comment_body[0][value]' => $this
        ->randomMachineName(20),
    ];
    sleep(1);
    $this
      ->drupalPostForm('comment/reply/node/' . $node
      ->id() . '/comment', $comment, t('Save'));

    // Reload the node so that comment.module's hook_node_load()
    // implementation can set $node->last_comment_timestamp for the freshly
    // posted comment.
    $node = Node::load($node
      ->id());

    // Verify that the history metadata is updated.
    $this
      ->drupalGet('activity');
    $this
      ->assertHistoryMetadata($node
      ->id(), $node
      ->getChangedTime(), $node
      ->get('comment')->last_comment_timestamp);
    $this
      ->drupalGet('activity/' . $this->user
      ->id());
    $this
      ->assertHistoryMetadata($node
      ->id(), $node
      ->getChangedTime(), $node
      ->get('comment')->last_comment_timestamp);
    $this
      ->drupalGet('user/' . $this->user
      ->id() . '/activity');
    $this
      ->assertHistoryMetadata($node
      ->id(), $node
      ->getChangedTime(), $node
      ->get('comment')->last_comment_timestamp);

    // Log out, now verify that the metadata is still there, but the library is
    // not.
    $this
      ->drupalLogout();
    $this
      ->drupalGet('activity');
    $this
      ->assertHistoryMetadata($node
      ->id(), $node
      ->getChangedTime(), $node
      ->get('comment')->last_comment_timestamp, FALSE);
    $this
      ->drupalGet('user/' . $this->user
      ->id() . '/activity');
    $this
      ->assertHistoryMetadata($node
      ->id(), $node
      ->getChangedTime(), $node
      ->get('comment')->last_comment_timestamp, FALSE);
  }

  /**
   * Tests for ordering on a users tracker listing when comments are posted.
   */
  public function testTrackerOrderingNewComments() {
    $this
      ->drupalLogin($this->user);
    $node_one = $this
      ->drupalCreateNode([
      'title' => $this
        ->randomMachineName(8),
    ]);
    $node_two = $this
      ->drupalCreateNode([
      'title' => $this
        ->randomMachineName(8),
    ]);

    // Now get otherUser to track these pieces of content.
    $this
      ->drupalLogin($this->otherUser);

    // Add a comment to the first page.
    $comment = [
      'subject[0][value]' => $this
        ->randomMachineName(),
      'comment_body[0][value]' => $this
        ->randomMachineName(20),
    ];
    $this
      ->drupalPostForm('comment/reply/node/' . $node_one
      ->id() . '/comment', $comment, t('Save'));

    // If the comment is posted in the same second as the last one then Drupal
    // can't tell the difference, so we wait one second here.
    sleep(1);

    // Add a comment to the second page.
    $comment = [
      'subject[0][value]' => $this
        ->randomMachineName(),
      'comment_body[0][value]' => $this
        ->randomMachineName(20),
    ];
    $this
      ->drupalPostForm('comment/reply/node/' . $node_two
      ->id() . '/comment', $comment, t('Save'));

    // We should at this point have in our tracker for otherUser:
    // 1. node_two
    // 2. node_one
    // Because that's the reverse order of the posted comments.
    // Now we're going to post a comment to node_one which should jump it to the
    // top of the list.
    $this
      ->drupalLogin($this->user);

    // If the comment is posted in the same second as the last one then Drupal
    // can't tell the difference, so we wait one second here.
    sleep(1);

    // Add a comment to the second page.
    $comment = [
      'subject[0][value]' => $this
        ->randomMachineName(),
      'comment_body[0][value]' => $this
        ->randomMachineName(20),
    ];
    $this
      ->drupalPostForm('comment/reply/node/' . $node_one
      ->id() . '/comment', $comment, t('Save'));

    // Switch back to the otherUser and assert that the order has swapped.
    $this
      ->drupalLogin($this->otherUser);
    $this
      ->drupalGet('user/' . $this->otherUser
      ->id() . '/activity');

    // This is a cheeky way of asserting that the nodes are in the right order
    // on the tracker page.
    // It's almost certainly too brittle.
    $pattern = '/' . preg_quote($node_one
      ->getTitle()) . '.+' . preg_quote($node_two
      ->getTitle()) . '/s';
    $this
      ->verbose($pattern);

    // Verify that the most recent comment on node appears at the top of
    // tracker.
    $this
      ->assertPattern($pattern);
  }

  /**
   * Tests that existing nodes are indexed by cron.
   */
  public function testTrackerCronIndexing() {
    $this
      ->drupalLogin($this->user);

    // Create 3 nodes.
    $edits = [];
    $nodes = [];
    for ($i = 1; $i <= 3; $i++) {
      $edits[$i] = [
        'title' => $this
          ->randomMachineName(),
      ];
      $nodes[$i] = $this
        ->drupalCreateNode($edits[$i]);
    }

    // Add a comment to the last node as other user.
    $this
      ->drupalLogin($this->otherUser);
    $comment = [
      'subject[0][value]' => $this
        ->randomMachineName(),
      'comment_body[0][value]' => $this
        ->randomMachineName(20),
    ];
    $this
      ->drupalPostForm('comment/reply/node/' . $nodes[3]
      ->id() . '/comment', $comment, t('Save'));

    // Create an unpublished node.
    $unpublished = $this
      ->drupalCreateNode([
      'title' => $this
        ->randomMachineName(8),
      'status' => 0,
    ]);

    // Start indexing backwards from node 4.
    \Drupal::state()
      ->set('tracker.index_nid', 4);

    // Clear the current tracker tables and rebuild them.
    $connection = Database::getConnection();
    $connection
      ->delete('tracker_node')
      ->execute();
    $connection
      ->delete('tracker_user')
      ->execute();
    tracker_cron();
    $this
      ->drupalLogin($this->user);

    // Fetch the user's tracker.
    $this
      ->drupalGet('activity/' . $this->user
      ->id());

    // Assert that all node titles are displayed.
    foreach ($nodes as $i => $node) {
      $this
        ->assertText($node
        ->label(), new FormattableMarkup('Node @i is displayed on the tracker listing pages.', [
        '@i' => $i,
      ]));
    }

    // Fetch the site-wide tracker.
    $this
      ->drupalGet('activity');

    // Assert that all node titles are displayed.
    foreach ($nodes as $i => $node) {
      $this
        ->assertText($node
        ->label(), new FormattableMarkup('Node @i is displayed on the tracker listing pages.', [
        '@i' => $i,
      ]));
    }
  }

  /**
   * Tests that publish/unpublish works at admin/content/node.
   */
  public function testTrackerAdminUnpublish() {
    \Drupal::service('module_installer')
      ->install([
      'views',
    ]);
    \Drupal::service('router.builder')
      ->rebuild();
    $admin_user = $this
      ->drupalCreateUser([
      'access content overview',
      'administer nodes',
      'bypass node access',
    ]);
    $this
      ->drupalLogin($admin_user);
    $node = $this
      ->drupalCreateNode([
      'title' => $this
        ->randomMachineName(),
    ]);

    // Assert that the node is displayed.
    $this
      ->drupalGet('activity');
    $this
      ->assertText($node
      ->label(), 'A node is displayed on the tracker listing pages.');

    // Unpublish the node and ensure that it's no longer displayed.
    $edit = [
      'action' => 'node_unpublish_action',
      'node_bulk_form[0]' => $node
        ->id(),
    ];
    $this
      ->drupalPostForm('admin/content', $edit, t('Apply to selected items'));
    $this
      ->drupalGet('activity');
    $this
      ->assertText(t('No content available.'), 'A node is displayed on the tracker listing pages.');
  }

  /**
   * Passes if the appropriate history metadata exists.
   *
   * Verify the data-history-node-id, data-history-node-timestamp and
   * data-history-node-last-comment-timestamp attributes, which are used by the
   * drupal.tracker-history library to add the appropriate "new" and "updated"
   * indicators, as well as the "x new" replies link to the tracker.
   * We do this in JavaScript to prevent breaking the render cache.
   *
   * @param int $node_id
   *   A node ID, that must exist as a data-history-node-id attribute
   * @param int $node_timestamp
   *   A node timestamp, that must exist as a data-history-node-timestamp
   *   attribute.
   * @param int $node_last_comment_timestamp
   *   A node's last comment timestamp, that must exist as a
   *   data-history-node-last-comment-timestamp attribute.
   * @param bool $library_is_present
   *   Whether the drupal.tracker-history library should be present or not.
   */
  public function assertHistoryMetadata($node_id, $node_timestamp, $node_last_comment_timestamp, $library_is_present = TRUE) {
    $settings = $this
      ->getDrupalSettings();
    $this
      ->assertIdentical($library_is_present, isset($settings['ajaxPageState']) && in_array('tracker/history', explode(',', $settings['ajaxPageState']['libraries'])), 'drupal.tracker-history library is present.');
    $this
      ->assertCount(1, $this
      ->xpath('//table/tbody/tr/td[@data-history-node-id="' . $node_id . '" and @data-history-node-timestamp="' . $node_timestamp . '"]'), 'Tracker table cell contains the data-history-node-id and data-history-node-timestamp attributes for the node.');
    $this
      ->assertCount(1, $this
      ->xpath('//table/tbody/tr/td[@data-history-node-last-comment-timestamp="' . $node_last_comment_timestamp . '"]'), 'Tracker table cell contains the data-history-node-last-comment-timestamp attribute for the node.');
  }

}

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
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
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.
CommentTestTrait::addDefaultCommentField public function Adds the default comment field to an entity.
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
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
TrackerTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
TrackerTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
TrackerTest::$otherUser protected property A second user that will 'create' comments and nodes.
TrackerTest::$user protected property The main user for testing.
TrackerTest::assertHistoryMetadata public function Passes if the appropriate history metadata exists.
TrackerTest::setUp protected function Overrides BrowserTestBase::setUp
TrackerTest::testTrackerAdminUnpublish public function Tests that publish/unpublish works at admin/content/node.
TrackerTest::testTrackerAll public function Tests for the presence of nodes on the global tracker listing.
TrackerTest::testTrackerCronIndexing public function Tests that existing nodes are indexed by cron.
TrackerTest::testTrackerHistoryMetadata public function Tests the metadata for the "new"/"updated" indicators.
TrackerTest::testTrackerOrderingNewComments public function Tests for ordering on a users tracker listing when comments are posted.
TrackerTest::testTrackerUser public function Tests for the presence of nodes on a user's tracker listing.
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.