You are here

Home » API reference » Zircon Profile 8 » CommentPagerTest.php

class CommentPagerTest in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/comment/src/Tests/CommentPagerTest.php \Drupal\comment\Tests\CommentPagerTest

Tests paging of comments and their settings.

@group comment

Hierarchy

Expanded class hierarchy of CommentPagerTest

File

core/modules/comment/src/Tests/CommentPagerTest.php, line 19
Contains \Drupal\comment\Tests\CommentPagerTest.

Namespace

Drupal\comment\Tests
View source 
class CommentPagerTest extends CommentTestBase {

  /**
   * Confirms comment paging works correctly with flat and threaded comments.
   */
  function testCommentPaging() {
    $this
      ->drupalLogin($this->adminUser);

    // Set comment variables.
    $this
      ->setCommentForm(TRUE);
    $this
      ->setCommentSubject(TRUE);
    $this
      ->setCommentPreview(DRUPAL_DISABLED);

    // Create a node and three comments.
    $node = $this
      ->drupalCreateNode(array(
      'type' => 'article',
      'promote' => 1,
    ));
    $comments = array();
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');

    // Set comments to one per page so that we are able to test paging without
    // needing to insert large numbers of comments.
    $this
      ->setCommentsPerPage(1);

    // Check the first page of the node, and confirm the correct comments are
    // shown.
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertRaw(t('next'), 'Paging links found.');
    $this
      ->assertTrue($this
      ->commentExists($comments[0]), 'Comment 1 appears on page 1.');
    $this
      ->assertFalse($this
      ->commentExists($comments[1]), 'Comment 2 does not appear on page 1.');
    $this
      ->assertFalse($this
      ->commentExists($comments[2]), 'Comment 3 does not appear on page 1.');

    // Check the second page.
    $this
      ->drupalGet('node/' . $node
      ->id(), array(
      'query' => array(
        'page' => 1,
      ),
    ));
    $this
      ->assertTrue($this
      ->commentExists($comments[1]), 'Comment 2 appears on page 2.');
    $this
      ->assertFalse($this
      ->commentExists($comments[0]), 'Comment 1 does not appear on page 2.');
    $this
      ->assertFalse($this
      ->commentExists($comments[2]), 'Comment 3 does not appear on page 2.');

    // Check the third page.
    $this
      ->drupalGet('node/' . $node
      ->id(), array(
      'query' => array(
        'page' => 2,
      ),
    ));
    $this
      ->assertTrue($this
      ->commentExists($comments[2]), 'Comment 3 appears on page 3.');
    $this
      ->assertFalse($this
      ->commentExists($comments[0]), 'Comment 1 does not appear on page 3.');
    $this
      ->assertFalse($this
      ->commentExists($comments[1]), 'Comment 2 does not appear on page 3.');

    // Post a reply to the oldest comment and test again.
    $oldest_comment = reset($comments);
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $oldest_comment
      ->id());
    $reply = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $this
      ->setCommentsPerPage(2);

    // We are still in flat view - the replies should not be on the first page,
    // even though they are replies to the oldest comment.
    $this
      ->drupalGet('node/' . $node
      ->id(), array(
      'query' => array(
        'page' => 0,
      ),
    ));
    $this
      ->assertFalse($this
      ->commentExists($reply, TRUE), 'In flat mode, reply does not appear on page 1.');

    // If we switch to threaded mode, the replies on the oldest comment
    // should be bumped to the first page and comment 6 should be bumped
    // to the second page.
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Switched to threaded mode.');
    $this
      ->drupalGet('node/' . $node
      ->id(), array(
      'query' => array(
        'page' => 0,
      ),
    ));
    $this
      ->assertTrue($this
      ->commentExists($reply, TRUE), 'In threaded mode, reply appears on page 1.');
    $this
      ->assertFalse($this
      ->commentExists($comments[1]), 'In threaded mode, comment 2 has been bumped off of page 1.');

    // If (# replies > # comments per page) in threaded expanded view,
    // the overage should be bumped.
    $reply2 = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $this
      ->drupalGet('node/' . $node
      ->id(), array(
      'query' => array(
        'page' => 0,
      ),
    ));
    $this
      ->assertFalse($this
      ->commentExists($reply2, TRUE), 'In threaded mode where # replies > # comments per page, the newest reply does not appear on page 1.');

    // Test that the page build process does not somehow generate errors when
    // # comments per page is set to 0.
    $this
      ->setCommentsPerPage(0);
    $this
      ->drupalGet('node/' . $node
      ->id(), array(
      'query' => array(
        'page' => 0,
      ),
    ));
    $this
      ->assertFalse($this
      ->commentExists($reply2, TRUE), 'Threaded mode works correctly when comments per page is 0.');
    $this
      ->drupalLogout();
  }

  /**
   * Tests comment ordering and threading.
   */
  function testCommentOrderingThreading() {
    $this
      ->drupalLogin($this->adminUser);

    // Set comment variables.
    $this
      ->setCommentForm(TRUE);
    $this
      ->setCommentSubject(TRUE);
    $this
      ->setCommentPreview(DRUPAL_DISABLED);

    // Display all the comments on the same page.
    $this
      ->setCommentsPerPage(1000);

    // Create a node and three comments.
    $node = $this
      ->drupalCreateNode(array(
      'type' => 'article',
      'promote' => 1,
    ));
    $comments = array();
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the second comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[1]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the first comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[0]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the last comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[2]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the second comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[3]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // At this point, the comment tree is:
    // - 0
    //   - 4
    // - 1
    //   - 3
    //     - 6
    // - 2
    //   - 5
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');
    $expected_order = array(
      0,
      1,
      2,
      3,
      4,
      5,
      6,
    );
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertCommentOrder($comments, $expected_order);
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Switched to threaded mode.');
    $expected_order = array(
      0,
      4,
      1,
      3,
      6,
      2,
      5,
    );
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertCommentOrder($comments, $expected_order);
  }

  /**
   * Asserts that the comments are displayed in the correct order.
   *
   * @param $comments
   *   And array of comments.
   * @param $expected_order
   *   An array of keys from $comments describing the expected order.
   */
  function assertCommentOrder(array $comments, array $expected_order) {
    $expected_cids = array();

    // First, rekey the expected order by cid.
    foreach ($expected_order as $key) {
      $expected_cids[] = $comments[$key]
        ->id();
    }
    $comment_anchors = $this
      ->xpath('//a[starts-with(@id,"comment-")]');
    $result_order = array();
    foreach ($comment_anchors as $anchor) {
      $result_order[] = substr($anchor['id'], 8);
    }
    return $this
      ->assertEqual($expected_cids, $result_order, format_string('Comment order: expected @expected, returned @returned.', array(
      '@expected' => implode(',', $expected_cids),
      '@returned' => implode(',', $result_order),
    )));
  }

  /**
   * Tests calculation of first page with new comment.
   */
  function testCommentNewPageIndicator() {
    $this
      ->drupalLogin($this->adminUser);

    // Set comment variables.
    $this
      ->setCommentForm(TRUE);
    $this
      ->setCommentSubject(TRUE);
    $this
      ->setCommentPreview(DRUPAL_DISABLED);

    // Set comments to one per page so that we are able to test paging without
    // needing to insert large numbers of comments.
    $this
      ->setCommentsPerPage(1);

    // Create a node and three comments.
    $node = $this
      ->drupalCreateNode(array(
      'type' => 'article',
      'promote' => 1,
    ));
    $comments = array();
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the second comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[1]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the first comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[0]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the last comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[2]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // At this point, the comment tree is:
    // - 0
    //   - 4
    // - 1
    //   - 3
    // - 2
    //   - 5
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');
    $expected_pages = array(
      1 => 5,
      // Page of comment 5
      2 => 4,
      // Page of comment 4
      3 => 3,
      // Page of comment 3
      4 => 2,
      // Page of comment 2
      5 => 1,
      // Page of comment 1
      6 => 0,
    );
    $node = Node::load($node
      ->id());
    foreach ($expected_pages as $new_replies => $expected_page) {
      $returned_page = \Drupal::entityManager()
        ->getStorage('comment')
        ->getNewCommentPageNumber($node
        ->get('comment')->comment_count, $new_replies, $node, 'comment');
      $this
        ->assertIdentical($expected_page, $returned_page, format_string('Flat mode, @new replies: expected page @expected, returned page @returned.', array(
        '@new' => $new_replies,
        '@expected' => $expected_page,
        '@returned' => $returned_page,
      )));
    }
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Switched to threaded mode.');
    $expected_pages = array(
      1 => 5,
      // Page of comment 5
      2 => 1,
      // Page of comment 4
      3 => 1,
      // Page of comment 4
      4 => 1,
      // Page of comment 4
      5 => 1,
      // Page of comment 4
      6 => 0,
    );
    \Drupal::entityManager()
      ->getStorage('node')
      ->resetCache(array(
      $node
        ->id(),
    ));
    $node = Node::load($node
      ->id());
    foreach ($expected_pages as $new_replies => $expected_page) {
      $returned_page = \Drupal::entityManager()
        ->getStorage('comment')
        ->getNewCommentPageNumber($node
        ->get('comment')->comment_count, $new_replies, $node, 'comment');
      $this
        ->assertEqual($expected_page, $returned_page, format_string('Threaded mode, @new replies: expected page @expected, returned page @returned.', array(
        '@new' => $new_replies,
        '@expected' => $expected_page,
        '@returned' => $returned_page,
      )));
    }
  }

  /**
   * Confirms comment paging works correctly with two pagers.
   */
  function testTwoPagers() {

    // Add another field to article content-type.
    $this
      ->addDefaultCommentField('node', 'article', 'comment_2');

    // Set default to display comment list with unique pager id.
    entity_get_display('node', 'article', 'default')
      ->setComponent('comment_2', array(
      'label' => 'hidden',
      'type' => 'comment_default',
      'weight' => 30,
      'settings' => array(
        'pager_id' => 1,
      ),
    ))
      ->save();

    // Make sure pager appears in formatter summary and settings form.
    $account = $this
      ->drupalCreateUser(array(
      'administer node display',
    ));
    $this
      ->drupalLogin($account);
    $this
      ->drupalGet('admin/structure/types/manage/article/display');
    $this
      ->assertNoText(t('Pager ID: @id', array(
      '@id' => 0,
    )), 'No summary for standard pager');
    $this
      ->assertText(t('Pager ID: @id', array(
      '@id' => 1,
    )));
    $this
      ->drupalPostAjaxForm(NULL, array(), 'comment_settings_edit');

    // Change default pager to 2.
    $this
      ->drupalPostForm(NULL, array(
      'fields[comment][settings_edit_form][settings][pager_id]' => 2,
    ), t('Save'));
    $this
      ->assertText(t('Pager ID: @id', array(
      '@id' => 2,
    )));

    // Revert the changes.
    $this
      ->drupalPostAjaxForm(NULL, array(), 'comment_settings_edit');
    $this
      ->drupalPostForm(NULL, array(
      'fields[comment][settings_edit_form][settings][pager_id]' => 0,
    ), t('Save'));
    $this
      ->assertNoText(t('Pager ID: @id', array(
      '@id' => 0,
    )), 'No summary for standard pager');
    $this
      ->drupalLogin($this->adminUser);

    // Add a new node with both comment fields open.
    $node = $this
      ->drupalCreateNode(array(
      'type' => 'article',
      'promote' => 1,
      'uid' => $this->webUser
        ->id(),
    ));

    // Set comment options.
    $comments = array();
    foreach (array(
      'comment',
      'comment_2',
    ) as $field_name) {
      $this
        ->setCommentForm(TRUE, $field_name);
      $this
        ->setCommentPreview(DRUPAL_OPTIONAL, $field_name);
      $this
        ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.', $field_name);

      // Set comments to one per page so that we are able to test paging without
      // needing to insert large numbers of comments.
      $this
        ->setCommentsPerPage(1, $field_name);
      for ($i = 0; $i < 3; $i++) {
        $comment = t('Comment @count on field @field', array(
          '@count' => $i + 1,
          '@field' => $field_name,
        ));
        $comments[] = $this
          ->postComment($node, $comment, $comment, TRUE, $field_name);
      }
    }

    // Check the first page of the node, and confirm the correct comments are
    // shown.
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertRaw(t('next'), 'Paging links found.');
    $this
      ->assertRaw('Comment 1 on field comment');
    $this
      ->assertRaw('Comment 1 on field comment_2');

    // Navigate to next page of field 1.
    $this
      ->clickLinkWithXPath('//h3/a[normalize-space(text())=:label]/ancestor::section[1]//a[@rel="next"]', array(
      ':label' => 'Comment 1 on field comment',
    ));

    // Check only one pager updated.
    $this
      ->assertRaw('Comment 2 on field comment');
    $this
      ->assertRaw('Comment 1 on field comment_2');

    // Return to page 1.
    $this
      ->drupalGet('node/' . $node
      ->id());

    // Navigate to next page of field 2.
    $this
      ->clickLinkWithXPath('//h3/a[normalize-space(text())=:label]/ancestor::section[1]//a[@rel="next"]', array(
      ':label' => 'Comment 1 on field comment_2',
    ));

    // Check only one pager updated.
    $this
      ->assertRaw('Comment 1 on field comment');
    $this
      ->assertRaw('Comment 2 on field comment_2');

    // Navigate to next page of field 1.
    $this
      ->clickLinkWithXPath('//h3/a[normalize-space(text())=:label]/ancestor::section[1]//a[@rel="next"]', array(
      ':label' => 'Comment 1 on field comment',
    ));

    // Check only one pager updated.
    $this
      ->assertRaw('Comment 2 on field comment');
    $this
      ->assertRaw('Comment 2 on field comment_2');
  }

  /**
   * Follows a link found at a give xpath query.
   *
   * Will click the first link found with the given xpath query by default,
   * or a later one if an index is given.
   *
   * If the link is discovered and clicked, the test passes. Fail otherwise.
   *
   * @param string $xpath
   *   Xpath query that targets an anchor tag, or set of anchor tags.
   * @param array $arguments
   *   An array of arguments with keys in the form ':name' matching the
   *   placeholders in the query. The values may be either strings or numeric
   *   values.
   * @param int $index
   *   Link position counting from zero.
   *
   * @return string|false
   *   Page contents on success, or FALSE on failure.
   *
   * @see WebTestBase::clickLink()
   */
  protected function clickLinkWithXPath($xpath, $arguments = array(), $index = 0) {
    $url_before = $this
      ->getUrl();
    $urls = $this
      ->xpath($xpath, $arguments);
    if (isset($urls[$index])) {
      $url_target = $this
        ->getAbsoluteUrl($urls[$index]['href']);
      $this
        ->pass(SafeMarkup::format('Clicked link %label (@url_target) from @url_before', array(
        '%label' => $xpath,
        '@url_target' => $url_target,
        '@url_before' => $url_before,
      )), 'Browser');
      return $this
        ->drupalGet($url_target);
    }
    $this
      ->fail(SafeMarkup::format('Link %label does not exist on @url_before', array(
      '%label' => $xpath,
      '@url_before' => $url_before,
    )), 'Browser');
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 2
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected function Casts MarkupInterface objects into strings.
CommentPagerTest::assertCommentOrder function Asserts that the comments are displayed in the correct order.
CommentPagerTest::clickLinkWithXPath protected function Follows a link found at a give xpath query.
CommentPagerTest::testCommentNewPageIndicator function Tests calculation of first page with new comment.
CommentPagerTest::testCommentOrderingThreading function Tests comment ordering and threading.
CommentPagerTest::testCommentPaging function Confirms comment paging works correctly with flat and threaded comments.
CommentPagerTest::testTwoPagers function Confirms comment paging works correctly with two pagers.
CommentTestBase::$adminUser protected property An administrative user with permission to configure comment settings. 1
CommentTestBase::$modules public static property Modules to install. 12
CommentTestBase::$node protected property A test node to which comments will be posted.
CommentTestBase::$webUser protected property A normal user with permission to post comments.
CommentTestBase::commentContactInfoAvailable function Checks whether the commenter's contact information is displayed.
CommentTestBase::commentExists function Checks current page for specified comment.
CommentTestBase::createCommentType protected function Creates a comment comment type (bundle).
CommentTestBase::deleteComment function Deletes a comment.
CommentTestBase::getUnapprovedComment function Gets the comment ID for an unapproved comment.
CommentTestBase::performCommentOperation function Performs the specified operation on the specified comment.
CommentTestBase::postComment public function Posts a comment.
CommentTestBase::setCommentAnonymous function Sets the value governing restrictions on anonymous comments.
CommentTestBase::setCommentForm public function Sets the value governing whether the comment form is on its own page.
CommentTestBase::setCommentPreview public function Sets the value governing the previewing mode for the comment form.
CommentTestBase::setCommentSettings public function Sets a comment settings variable for the article content type.
CommentTestBase::setCommentsPerPage public function Sets the value specifying the default number of comments per page.
CommentTestBase::setCommentSubject public function Sets the value governing whether the subject field should be enabled.
CommentTestBase::setUp protected function Sets up a Drupal site for running functional and integration tests. Overrides WebTestBase::setUp 15
CommentTestTrait::addDefaultCommentField public function Adds the default comment field to an entity.
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.
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.
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.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 5
TestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestBase::$container protected property The dependency injection container used in the test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalProfile protected property The original installation profile.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$privateFilesDirectory protected property The private file directory for the test environment.
TestBase::$publicFilesDirectory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$siteDirectory protected property The site directory of this test run.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestBase::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. 1
TestBase::changeDatabasePrefix private function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 2
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 5
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 3
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests.
TestBase::prepareEnvironment private function Prepares the current environment for running the test.
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 1
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database.
TestBase::verbose protected function Logs a verbose message in a text file.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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.
WebTestBase::$additionalCurlOptions protected property Additional cURL options.
WebTestBase::$assertAjaxHeader protected property Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$classLoader protected property The class loader to use for installation and initialization of setup.
WebTestBase::$configDirectories protected property The config directories used in this test.
WebTestBase::$cookieFile protected property The current cookie file used by cURL.
WebTestBase::$cookies protected property The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies protected property Cookies to set on curl requests.
WebTestBase::$curlHandle protected property The handle of the current cURL connection.
WebTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
WebTestBase::$dumpHeaders protected property Indicates that headers should be dumped if verbose output is enabled. 12
WebTestBase::$generatedTestFiles protected property Whether the files were copied to the test files directory.
WebTestBase::$headers protected property The headers of the page currently loaded in the internal browser.
WebTestBase::$kernel protected property The kernel used in this test. Overrides TestBase::$kernel
WebTestBase::$loggedInUser protected property The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects protected property The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch protected property The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile protected property The profile to install as a basis for testing. 30
WebTestBase::$redirectCount protected property The number of redirects followed during the handling of a request.
WebTestBase::$rootUser protected property The "#1" admin user.
WebTestBase::$sessionId protected property The current session ID, if available.
WebTestBase::$url protected property The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations protected function Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears protected function Checks to see whether a block appears on the page.
WebTestBase::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
WebTestBase::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader protected function Check if a HTTP response header exists and has the expected value.
WebTestBase::assertMail protected function Asserts that the most recently sent email message has the given value.
WebTestBase::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
WebTestBase::assertMailString protected function Asserts that the most recently sent email message has the string in it.
WebTestBase::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
WebTestBase::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse protected function Asserts the page did not return the specified response code.
WebTestBase::assertResponse protected function Asserts the page responds with the specified response code.
WebTestBase::assertUrl protected function Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink protected function Follows a link by complete name.
WebTestBase::clickLinkHelper protected function Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName protected function Follows a link by partial name.
WebTestBase::cronRun protected function Runs cron in the Drupal installed by Simpletest.
WebTestBase::curlClose protected function Close the cURL handler and unset the handler.
WebTestBase::curlExec protected function Initializes and executes a cURL request. 2
WebTestBase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize protected function Initializes the cURL connection.
WebTestBase::doInstall protected function Execute the non-interactive installer.
WebTestBase::drupalBuildEntityView protected function Builds the renderable view of an entity.
WebTestBase::drupalCompareFiles protected function Compare two files based on size and file name.
WebTestBase::drupalCreateContentType protected function Creates a custom content type based on default settings.
WebTestBase::drupalCreateNode protected function Creates a node based on default settings.
WebTestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. 1
WebTestBase::drupalGetAjax protected function Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
WebTestBase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page.
WebTestBase::drupalGetJSON protected function Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetMails protected function Gets an array containing all emails sent during this test case.
WebTestBase::drupalGetNodeByTitle function Get a node from the database based on its title.
WebTestBase::drupalGetTestFiles protected function Gets a list of files that can be used in tests.
WebTestBase::drupalGetWithFormat protected function Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR protected function Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
WebTestBase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin protected function Log in a user with the internal browser.
WebTestBase::drupalLogout protected function Logs a user out of the internal browser and confirms.
WebTestBase::drupalPlaceBlock protected function Creates a block instance based on default settings.
WebTestBase::drupalPost protected function Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm protected function Executes an Ajax form submission.
WebTestBase::drupalPostForm protected function Executes a form submission.
WebTestBase::drupalPostWithFormat protected function Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse protected function Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
WebTestBase::findBlockInstance protected function Find a block instance on the page.
WebTestBase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData protected function Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::getDatabaseTypes protected function Returns all supported database driver installer objects.
WebTestBase::handleForm protected function Handles form input related to drupalPostForm().
WebTestBase::initConfig protected function Initialize various configurations post-installation.
WebTestBase::initKernel protected function Initializes the kernel after installation.
WebTestBase::initSettings protected function Initialize settings created during install.
WebTestBase::initUserSession protected function Initializes user 1 for the site to be installed.
WebTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`.
WebTestBase::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 2
WebTestBase::isInChildSite protected function Returns whether the test is being executed from within a test site.
WebTestBase::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
WebTestBase::prepareSettings protected function Prepares site settings and services before installation. 1
WebTestBase::rebuildAll protected function Reset and rebuild the environment after setup.
WebTestBase::rebuildContainer protected function Rebuilds \Drupal::getContainer().
WebTestBase::refreshVariables protected function Refreshes in-memory configuration and state information. 1
WebTestBase::resetAll protected function Resets all data structures after having enabled new modules.
WebTestBase::restoreBatch protected function Restore the original batch.
WebTestBase::serializePostValues protected function Serialize POST HTTP request values.
WebTestBase::setBatch protected function Preserve the original batch, and instantiate the test batch.
WebTestBase::setContainerParameter protected function Changes parameters in the services.yml file.
WebTestBase::setHttpResponseDebugCacheabilityHeaders protected function Enables/disables the cacheability headers.
WebTestBase::tearDown protected function Cleans up after testing. Overrides TestBase::tearDown 2
WebTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
WebTestBase::writeCustomTranslations protected function Writes custom translations to the test site's settings.php.
WebTestBase::writeSettings protected function Rewrites the settings.php file of the test site.
WebTestBase::__construct function Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct 1