You are here

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

class CommentNonNodeTest in Zircon Profile 8

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

Tests commenting on a test entity.

@group comment

Hierarchy

Expanded class hierarchy of CommentNonNodeTest

File

core/modules/comment/src/Tests/CommentNonNodeTest.php, line 26
Contains \Drupal\comment\Tests\CommentNonNodeTest.

Namespace

Drupal\comment\Tests
View source 
class CommentNonNodeTest extends WebTestBase {
  use FieldUiTestTrait;
  use CommentTestTrait;
  public static $modules = array(
    'comment',
    'user',
    'field_ui',
    'entity_test',
    'block',
  );

  /**
   * An administrative user with permission to configure comment settings.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;

  /**
   * The entity to use within tests.
   *
   * @var \Drupal\entity_test\Entity\EntityTest
   */
  protected $entity;

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

    // Create a bundle for entity_test.
    entity_test_create_bundle('entity_test', 'Entity Test', 'entity_test');
    entity_create('comment_type', array(
      'id' => 'comment',
      'label' => 'Comment settings',
      'description' => 'Comment settings',
      'target_entity_type_id' => 'entity_test',
    ))
      ->save();

    // Create comment field on entity_test bundle.
    $this
      ->addDefaultCommentField('entity_test', 'entity_test');

    // Verify that bundles are defined correctly.
    $bundles = \Drupal::entityManager()
      ->getBundleInfo('comment');
    $this
      ->assertEqual($bundles['comment']['label'], 'Comment settings');

    // Create test user.
    $this->adminUser = $this
      ->drupalCreateUser(array(
      'administer comments',
      'skip comment approval',
      'post comments',
      'access comments',
      'view test entity',
      'administer entity_test content',
    ));

    // Enable anonymous and authenticated user comments.
    user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, array(
      'access comments',
      'post comments',
      'skip comment approval',
    ));
    user_role_grant_permissions(RoleInterface::AUTHENTICATED_ID, array(
      'access comments',
      'post comments',
      'skip comment approval',
    ));

    // Create a test entity.
    $random_label = $this
      ->randomMachineName();
    $data = array(
      'type' => 'entity_test',
      'name' => $random_label,
    );
    $this->entity = entity_create('entity_test', $data);
    $this->entity
      ->save();
  }

  /**
   * Posts a comment.
   *
   * @param \Drupal\Core\Entity\EntityInterface|null $entity
   *   Entity to post comment on or NULL to post to the previously loaded page.
   * @param string $comment
   *   Comment body.
   * @param string $subject
   *   Comment subject.
   * @param mixed $contact
   *   Set to NULL for no contact info, TRUE to ignore success checking, and
   *   array of values to set contact info.
   *
   * @return \Drupal\comment\CommentInterface
   *   The new comment entity.
   */
  function postComment(EntityInterface $entity, $comment, $subject = '', $contact = NULL) {
    $edit = array();
    $edit['comment_body[0][value]'] = $comment;
    $field = FieldConfig::loadByName('entity_test', 'entity_test', 'comment');
    $preview_mode = $field
      ->getSetting('preview');

    // Must get the page before we test for fields.
    if ($entity !== NULL) {
      $this
        ->drupalGet('comment/reply/entity_test/' . $entity
        ->id() . '/comment');
    }

    // Determine the visibility of subject form field.
    if (entity_get_form_display('comment', 'comment', 'default')
      ->getComponent('subject')) {

      // Subject input allowed.
      $edit['subject[0][value]'] = $subject;
    }
    else {
      $this
        ->assertNoFieldByName('subject[0][value]', '', 'Subject field not found.');
    }
    if ($contact !== NULL && is_array($contact)) {
      $edit += $contact;
    }
    switch ($preview_mode) {
      case DRUPAL_REQUIRED:

        // Preview required so no save button should be found.
        $this
          ->assertNoFieldByName('op', t('Save'), 'Save button not found.');
        $this
          ->drupalPostForm(NULL, $edit, t('Preview'));

      // Don't break here so that we can test post-preview field presence and
      // function below.
      case DRUPAL_OPTIONAL:
        $this
          ->assertFieldByName('op', t('Preview'), 'Preview button found.');
        $this
          ->assertFieldByName('op', t('Save'), 'Save button found.');
        $this
          ->drupalPostForm(NULL, $edit, t('Save'));
        break;
      case DRUPAL_DISABLED:
        $this
          ->assertNoFieldByName('op', t('Preview'), 'Preview button not found.');
        $this
          ->assertFieldByName('op', t('Save'), 'Save button found.');
        $this
          ->drupalPostForm(NULL, $edit, t('Save'));
        break;
    }
    $match = array();

    // Get comment ID
    preg_match('/#comment-([0-9]+)/', $this
      ->getURL(), $match);

    // Get comment.
    if ($contact !== TRUE) {

      // If true then attempting to find error message.
      if ($subject) {
        $this
          ->assertText($subject, 'Comment subject posted.');
      }
      $this
        ->assertText($comment, 'Comment body posted.');
      $this
        ->assertTrue(!empty($match) && !empty($match[1]), 'Comment ID found.');
    }
    if (isset($match[1])) {
      return Comment::load($match[1]);
    }
  }

  /**
   * Checks current page for specified comment.
   *
   * @param \Drupal\comment\CommentInterface $comment
   *   The comment object.
   * @param bool $reply
   *   Boolean indicating whether the comment is a reply to another comment.
   *
   * @return bool
   *   Boolean indicating whether the comment was found.
   */
  function commentExists(CommentInterface $comment = NULL, $reply = FALSE) {
    if ($comment) {
      $regex = '/' . ($reply ? '<div class="indented">(.*?)' : '');
      $regex .= '<a id="comment-' . $comment
        ->id() . '"(.*?)';
      $regex .= $comment
        ->getSubject() . '(.*?)';
      $regex .= $comment->comment_body->value . '(.*?)';
      $regex .= '/s';
      return (bool) preg_match($regex, $this
        ->getRawContent());
    }
    else {
      return FALSE;
    }
  }

  /**
   * Checks whether the commenter's contact information is displayed.
   *
   * @return bool
   *   Contact info is available.
   */
  function commentContactInfoAvailable() {
    return preg_match('/(input).*?(name="name").*?(input).*?(name="mail").*?(input).*?(name="homepage")/s', $this
      ->getRawContent());
  }

  /**
   * Performs the specified operation on the specified comment.
   *
   * @param object $comment
   *   Comment to perform operation on.
   * @param string $operation
   *   Operation to perform.
   * @param bool $approval
   *   Operation is found on approval page.
   */
  function performCommentOperation($comment, $operation, $approval = FALSE) {
    $edit = array();
    $edit['operation'] = $operation;
    $edit['comments[' . $comment
      ->id() . ']'] = TRUE;
    $this
      ->drupalPostForm('admin/content/comment' . ($approval ? '/approval' : ''), $edit, t('Update'));
    if ($operation == 'delete') {
      $this
        ->drupalPostForm(NULL, array(), t('Delete comments'));
      $this
        ->assertRaw(\Drupal::translation()
        ->formatPlural(1, 'Deleted 1 comment.', 'Deleted @count comments.'), format_string('Operation "@operation" was performed on comment.', array(
        '@operation' => $operation,
      )));
    }
    else {
      $this
        ->assertText(t('The update has been performed.'), format_string('Operation "@operation" was performed on comment.', array(
        '@operation' => $operation,
      )));
    }
  }

  /**
   * Gets the comment ID for an unapproved comment.
   *
   * @param string $subject
   *   Comment subject to find.
   *
   * @return integer
   *   Comment ID.
   */
  function getUnapprovedComment($subject) {
    $this
      ->drupalGet('admin/content/comment/approval');
    preg_match('/href="(.*?)#comment-([^"]+)"(.*?)>(' . $subject . ')/', $this
      ->getRawContent(), $match);
    return $match[2];
  }

  /**
   * Tests anonymous comment functionality.
   */
  function testCommentFunctionality() {
    $limited_user = $this
      ->drupalCreateUser(array(
      'administer entity_test fields',
    ));
    $this
      ->drupalLogin($limited_user);

    // Test that default field exists.
    $this
      ->drupalGet('entity_test/structure/entity_test/fields');
    $this
      ->assertText(t('Comments'));
    $this
      ->assertLinkByHref('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');

    // Test widget hidden option is not visible when there's no comments.
    $this
      ->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
    $this
      ->assertResponse(200);
    $this
      ->assertNoField('edit-default-value-input-comment-und-0-status-0');

    // Test that field to change cardinality is not available.
    $this
      ->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment/storage');
    $this
      ->assertResponse(200);
    $this
      ->assertNoField('cardinality_number');
    $this
      ->assertNoField('cardinality');
    $this
      ->drupalLogin($this->adminUser);

    // Test breadcrumb on comment add page.
    $this
      ->drupalGet('comment/reply/entity_test/' . $this->entity
      ->id() . '/comment');
    $xpath = '//nav[@class="breadcrumb"]/ol/li[last()]/a';
    $this
      ->assertEqual(current($this
      ->xpath($xpath)), $this->entity
      ->label(), 'Last breadcrumb item is equal to node title on comment reply page.');

    // Post a comment.

    /** @var \Drupal\comment\CommentInterface $comment1 */
    $comment1 = $this
      ->postComment($this->entity, $this
      ->randomMachineName(), $this
      ->randomMachineName());
    $this
      ->assertTrue($this
      ->commentExists($comment1), 'Comment on test entity exists.');

    // Test breadcrumb on comment reply page.
    $this
      ->drupalGet('comment/reply/entity_test/' . $this->entity
      ->id() . '/comment/' . $comment1
      ->id());
    $xpath = '//nav[@class="breadcrumb"]/ol/li[last()]/a';
    $this
      ->assertEqual(current($this
      ->xpath($xpath)), $comment1
      ->getSubject(), 'Last breadcrumb item is equal to comment title on comment reply page.');

    // Test breadcrumb on comment edit page.
    $this
      ->drupalGet('comment/' . $comment1
      ->id() . '/edit');
    $xpath = '//nav[@class="breadcrumb"]/ol/li[last()]/a';
    $this
      ->assertEqual(current($this
      ->xpath($xpath)), $comment1
      ->getSubject(), 'Last breadcrumb item is equal to comment subject on edit page.');

    // Test breadcrumb on comment delete page.
    $this
      ->drupalGet('comment/' . $comment1
      ->id() . '/delete');
    $xpath = '//nav[@class="breadcrumb"]/ol/li[last()]/a';
    $this
      ->assertEqual(current($this
      ->xpath($xpath)), $comment1
      ->getSubject(), 'Last breadcrumb item is equal to comment subject on delete confirm page.');

    // Unpublish the comment.
    $this
      ->performCommentOperation($comment1, 'unpublish');
    $this
      ->drupalGet('admin/content/comment/approval');
    $this
      ->assertRaw('comments[' . $comment1
      ->id() . ']', 'Comment was unpublished.');

    // Publish the comment.
    $this
      ->performCommentOperation($comment1, 'publish', TRUE);
    $this
      ->drupalGet('admin/content/comment');
    $this
      ->assertRaw('comments[' . $comment1
      ->id() . ']', 'Comment was published.');

    // Delete the comment.
    $this
      ->performCommentOperation($comment1, 'delete');
    $this
      ->drupalGet('admin/content/comment');
    $this
      ->assertNoRaw('comments[' . $comment1
      ->id() . ']', 'Comment was deleted.');

    // Post another comment.
    $comment1 = $this
      ->postComment($this->entity, $this
      ->randomMachineName(), $this
      ->randomMachineName());
    $this
      ->assertTrue($this
      ->commentExists($comment1), 'Comment on test entity exists.');

    // Check that the comment was found.
    $this
      ->drupalGet('admin/content/comment');
    $this
      ->assertRaw('comments[' . $comment1
      ->id() . ']', 'Comment was published.');

    // Check that entity access applies to administrative page.
    $this
      ->assertText($this->entity
      ->label(), 'Name of commented account found.');
    $limited_user = $this
      ->drupalCreateUser(array(
      'administer comments',
    ));
    $this
      ->drupalLogin($limited_user);
    $this
      ->drupalGet('admin/content/comment');
    $this
      ->assertNoText($this->entity
      ->label(), 'No commented account name found.');
    $this
      ->drupalLogout();

    // Deny anonymous users access to comments.
    user_role_change_permissions(RoleInterface::ANONYMOUS_ID, array(
      'access comments' => FALSE,
      'post comments' => FALSE,
      'skip comment approval' => FALSE,
      'view test entity' => TRUE,
    ));

    // Attempt to view comments while disallowed.
    $this
      ->drupalGet('entity-test/' . $this->entity
      ->id());
    $this
      ->assertNoPattern('@<h2[^>]*>Comments</h2>@', 'Comments were not displayed.');
    $this
      ->assertNoLink('Add new comment', 'Link to add comment was found.');

    // Attempt to view test entity comment form while disallowed.
    $this
      ->drupalGet('comment/reply/entity_test/' . $this->entity
      ->id() . '/comment');
    $this
      ->assertResponse(403);
    $this
      ->assertNoFieldByName('subject[0][value]', '', 'Subject field not found.');
    $this
      ->assertNoFieldByName('comment_body[0][value]', '', 'Comment field not found.');
    user_role_change_permissions(RoleInterface::ANONYMOUS_ID, array(
      'access comments' => TRUE,
      'post comments' => FALSE,
      'view test entity' => TRUE,
      'skip comment approval' => FALSE,
    ));
    $this
      ->drupalGet('entity_test/' . $this->entity
      ->id());
    $this
      ->assertPattern('@<h2[^>]*>Comments</h2>@', 'Comments were displayed.');
    $this
      ->assertLink('Log in', 0, 'Link to log in was found.');
    $this
      ->assertLink('register', 0, 'Link to register was found.');
    $this
      ->assertNoFieldByName('subject[0][value]', '', 'Subject field not found.');
    $this
      ->assertNoFieldByName('comment_body[0][value]', '', 'Comment field not found.');

    // Test the combination of anonymous users being able to post, but not view
    // comments, to ensure that access to post comments doesn't grant access to
    // view them.
    user_role_change_permissions(RoleInterface::ANONYMOUS_ID, array(
      'access comments' => FALSE,
      'post comments' => TRUE,
      'skip comment approval' => TRUE,
      'view test entity' => TRUE,
    ));
    $this
      ->drupalGet('entity_test/' . $this->entity
      ->id());
    $this
      ->assertNoPattern('@<h2[^>]*>Comments</h2>@', 'Comments were not displayed.');
    $this
      ->assertFieldByName('subject[0][value]', '', 'Subject field found.');
    $this
      ->assertFieldByName('comment_body[0][value]', '', 'Comment field found.');
    $this
      ->drupalGet('comment/reply/entity_test/' . $this->entity
      ->id() . '/comment/' . $comment1
      ->id());
    $this
      ->assertResponse(403);
    $this
      ->assertNoText($comment1
      ->getSubject(), 'Comment not displayed.');

    // Test comment field widget changes.
    $limited_user = $this
      ->drupalCreateUser(array(
      'administer entity_test fields',
      'view test entity',
      'administer entity_test content',
    ));
    $this
      ->drupalLogin($limited_user);
    $this
      ->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
    $this
      ->assertNoFieldChecked('edit-default-value-input-comment-0-status-0');
    $this
      ->assertNoFieldChecked('edit-default-value-input-comment-0-status-1');
    $this
      ->assertFieldChecked('edit-default-value-input-comment-0-status-2');

    // Test comment option change in field settings.
    $edit = array(
      'default_value_input[comment][0][status]' => CommentItemInterface::CLOSED,
      'settings[anonymous]' => COMMENT_ANONYMOUS_MAY_CONTACT,
    );
    $this
      ->drupalPostForm(NULL, $edit, t('Save settings'));
    $this
      ->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
    $this
      ->assertNoFieldChecked('edit-default-value-input-comment-0-status-0');
    $this
      ->assertFieldChecked('edit-default-value-input-comment-0-status-1');
    $this
      ->assertNoFieldChecked('edit-default-value-input-comment-0-status-2');
    $this
      ->assertFieldByName('settings[anonymous]', COMMENT_ANONYMOUS_MAY_CONTACT);

    // Add a new comment-type.
    $bundle = CommentType::create(array(
      'id' => 'foobar',
      'label' => 'Foobar',
      'description' => '',
      'target_entity_type_id' => 'entity_test',
    ));
    $bundle
      ->save();

    // Add a new comment field.
    $storage_edit = array(
      'settings[comment_type]' => 'foobar',
    );
    $this
      ->fieldUIAddNewField('entity_test/structure/entity_test', 'foobar', 'Foobar', 'comment', $storage_edit);

    // Add a third comment field.
    $this
      ->fieldUIAddNewField('entity_test/structure/entity_test', 'barfoo', 'BarFoo', 'comment', $storage_edit);

    // Check the field contains the correct comment type.
    $field_storage = FieldStorageConfig::load('entity_test.field_barfoo');
    $this
      ->assertTrue($field_storage);
    $this
      ->assertEqual($field_storage
      ->getSetting('comment_type'), 'foobar');
    $this
      ->assertEqual($field_storage
      ->getCardinality(), 1);

    // Test the new entity commenting inherits default.
    $random_label = $this
      ->randomMachineName();
    $data = array(
      'bundle' => 'entity_test',
      'name' => $random_label,
    );
    $new_entity = entity_create('entity_test', $data);
    $new_entity
      ->save();
    $this
      ->drupalGet('entity_test/manage/' . $new_entity
      ->id() . '/edit');
    $this
      ->assertNoFieldChecked('edit-field-foobar-0-status-1');
    $this
      ->assertFieldChecked('edit-field-foobar-0-status-2');
    $this
      ->assertNoField('edit-field-foobar-0-status-0');

    // @todo Check proper url and form https://www.drupal.org/node/2458323
    $this
      ->drupalGet('comment/reply/entity_test/comment/' . $new_entity
      ->id());
    $this
      ->assertNoFieldByName('subject[0][value]', '', 'Subject field found.');
    $this
      ->assertNoFieldByName('comment_body[0][value]', '', 'Comment field found.');

    // Test removal of comment_body field.
    $limited_user = $this
      ->drupalCreateUser(array(
      'administer entity_test fields',
      'post comments',
      'administer comment fields',
      'administer comment types',
    ));
    $this
      ->drupalLogin($limited_user);
    $this
      ->drupalGet('comment/reply/entity_test/' . $this->entity
      ->id() . '/comment');
    $this
      ->assertFieldByName('comment_body[0][value]', '', 'Comment body field found.');
    $this
      ->fieldUIDeleteField('admin/structure/comment/manage/comment', 'comment.comment.comment_body', 'Comment', 'Comment settings');
    $this
      ->drupalGet('comment/reply/entity_test/' . $this->entity
      ->id() . '/comment');
    $this
      ->assertNoFieldByName('comment_body[0][value]', '', 'Comment body field not found.');

    // Set subject field to autogenerate it.
    $edit = [
      'subject[0][value]' => '',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
  }

  /**
   * Tests comment fields cannot be added to entity types without integer IDs.
   */
  public function testsNonIntegerIdEntities() {

    // Create a bundle for entity_test_string_id.
    entity_test_create_bundle('entity_test', 'Entity Test', 'entity_test_string_id');
    $limited_user = $this
      ->drupalCreateUser(array(
      'administer entity_test_string_id fields',
    ));
    $this
      ->drupalLogin($limited_user);

    // Visit the Field UI field add page.
    $this
      ->drupalGet('entity_test_string_id/structure/entity_test/fields/add-field');

    // Ensure field isn't shown for string IDs.
    $this
      ->assertNoOption('edit-new-storage-type', 'comment');

    // Ensure a core field type shown.
    $this
      ->assertOption('edit-new-storage-type', 'boolean');

    // Create a bundle for entity_test_no_id.
    entity_test_create_bundle('entity_test', 'Entity Test', 'entity_test_no_id');
    $this
      ->drupalLogin($this
      ->drupalCreateUser(array(
      'administer entity_test_no_id fields',
    )));

    // Visit the Field UI field add page.
    $this
      ->drupalGet('entity_test_no_id/structure/entity_test/fields/add-field');

    // Ensure field isn't shown for empty IDs.
    $this
      ->assertNoOption('edit-new-storage-type', 'comment');

    // Ensure a core field type shown.
    $this
      ->assertOption('edit-new-storage-type', 'boolean');
  }

}

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.
CommentNonNodeTest::$adminUser protected property An administrative user with permission to configure comment settings.
CommentNonNodeTest::$entity protected property The entity to use within tests.
CommentNonNodeTest::$modules public static property
CommentNonNodeTest::commentContactInfoAvailable function Checks whether the commenter's contact information is displayed.
CommentNonNodeTest::commentExists function Checks current page for specified comment.
CommentNonNodeTest::getUnapprovedComment function Gets the comment ID for an unapproved comment.
CommentNonNodeTest::performCommentOperation function Performs the specified operation on the specified comment.
CommentNonNodeTest::postComment function Posts a comment.
CommentNonNodeTest::setUp protected function Sets up a Drupal site for running functional and integration tests. Overrides WebTestBase::setUp
CommentNonNodeTest::testCommentFunctionality function Tests anonymous comment functionality.
CommentNonNodeTest::testsNonIntegerIdEntities public function Tests comment fields cannot be added to entity types without integer IDs.
CommentTestTrait::addDefaultCommentField public function Adds the default comment field to an entity.
FieldUiTestTrait::fieldUIAddExistingField public function Adds an existing field through the Field UI.
FieldUiTestTrait::fieldUIAddNewField public function Creates a new field through the Field UI.
FieldUiTestTrait::fieldUIDeleteField public function Deletes a field through the Field UI.
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