You are here

Home » API reference » Drupal 8 » CommentInterfaceTest.php

class CommentInterfaceTest in Drupal 8

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

Tests comment user interfaces.

@group comment

Hierarchy

Expanded class hierarchy of CommentInterfaceTest

File

core/modules/comment/tests/src/Functional/CommentInterfaceTest.php, line 19

Namespace

Drupal\Tests\comment\Functional
View source 
class CommentInterfaceTest extends CommentTestBase {

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

  /**
   * Set up comments to have subject and preview disabled.
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalLogin($this->adminUser);

    // Make sure that comment field title is not displayed when there's no
    // comments posted.
    $this
      ->drupalGet($this->node
      ->toUrl());
    $this
      ->assertSession()
      ->responseNotMatches('@<h2[^>]*>Comments</h2>@', 'Comments title is not displayed.');

    // Set comments to have subject and preview disabled.
    $this
      ->setCommentPreview(DRUPAL_DISABLED);
    $this
      ->setCommentForm(TRUE);
    $this
      ->setCommentSubject(FALSE);
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Comment paging changed.');
    $this
      ->drupalLogout();
  }

  /**
   * Tests the comment interface.
   */
  public function testCommentInterface() {

    // Post comment #1 without subject or preview.
    $this
      ->drupalLogin($this->webUser);
    $comment_text = $this
      ->randomMachineName();
    $comment = $this
      ->postComment($this->node, $comment_text);
    $this
      ->assertTrue($this
      ->commentExists($comment), 'Comment found.');

    // Test the comment field title is displayed when there's comments.
    $this
      ->drupalGet($this->node
      ->toUrl());
    $this
      ->assertPattern('@<h2[^>]*>Comments</h2>@');

    // Set comments to have subject and preview to required.
    $this
      ->drupalLogout();
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->setCommentSubject(TRUE);
    $this
      ->setCommentPreview(DRUPAL_REQUIRED);
    $this
      ->drupalLogout();

    // Create comment #2 that allows subject and requires preview.
    $this
      ->drupalLogin($this->webUser);
    $subject_text = $this
      ->randomMachineName();
    $comment_text = $this
      ->randomMachineName();
    $comment = $this
      ->postComment($this->node, $comment_text, $subject_text, TRUE);
    $this
      ->assertTrue($this
      ->commentExists($comment), 'Comment found.');

    // Comment as anonymous with preview required.
    $this
      ->drupalLogout();
    user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, [
      'access content',
      'access comments',
      'post comments',
      'skip comment approval',
    ]);
    $anonymous_comment = $this
      ->postComment($this->node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $this
      ->assertTrue($this
      ->commentExists($anonymous_comment), 'Comment found.');
    $anonymous_comment
      ->delete();

    // Check comment display.
    $this
      ->drupalLogin($this->webUser);
    $this
      ->drupalGet('node/' . $this->node
      ->id());
    $this
      ->assertText($subject_text, 'Individual comment subject found.');
    $this
      ->assertText($comment_text, 'Individual comment body found.');
    $arguments = [
      ':link' => base_path() . 'comment/' . $comment
        ->id() . '#comment-' . $comment
        ->id(),
    ];
    $pattern_permalink = '//footer[contains(@class,"comment__meta")]/a[contains(@href,:link) and text()="Permalink"]';
    $permalink = $this
      ->xpath($pattern_permalink, $arguments);
    $this
      ->assertTrue(!empty($permalink), 'Permalink link found.');

    // Set comments to have subject and preview to optional.
    $this
      ->drupalLogout();
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->setCommentSubject(TRUE);
    $this
      ->setCommentPreview(DRUPAL_OPTIONAL);
    $this
      ->drupalGet('comment/' . $comment
      ->id() . '/edit');
    $this
      ->assertTitle('Edit comment ' . $comment
      ->getSubject() . ' | Drupal');

    // Test changing the comment author to "Anonymous".
    $comment = $this
      ->postComment(NULL, $comment->comment_body->value, $comment
      ->getSubject(), [
      'uid' => '',
    ]);
    $this
      ->assertTrue($comment
      ->getAuthorName() == t('Anonymous') && $comment
      ->getOwnerId() == 0, 'Comment author successfully changed to anonymous.');

    // Test changing the comment author to an unverified user.
    $random_name = $this
      ->randomMachineName();
    $this
      ->drupalGet('comment/' . $comment
      ->id() . '/edit');
    $comment = $this
      ->postComment(NULL, $comment->comment_body->value, $comment
      ->getSubject(), [
      'name' => $random_name,
    ]);
    $this
      ->drupalGet('node/' . $this->node
      ->id());
    $this
      ->assertText($random_name . ' (' . t('not verified') . ')', 'Comment author successfully changed to an unverified user.');

    // Test changing the comment author to a verified user.
    $this
      ->drupalGet('comment/' . $comment
      ->id() . '/edit');
    $comment = $this
      ->postComment(NULL, $comment->comment_body->value, $comment
      ->getSubject(), [
      'uid' => $this->webUser
        ->getAccountName() . ' (' . $this->webUser
        ->id() . ')',
    ]);
    $this
      ->assertTrue($comment
      ->getAuthorName() == $this->webUser
      ->getAccountName() && $comment
      ->getOwnerId() == $this->webUser
      ->id(), 'Comment author successfully changed to a registered user.');
    $this
      ->drupalLogout();

    // Reply to comment #2 creating comment #3 with optional preview and no
    // subject though field enabled.
    $this
      ->drupalLogin($this->webUser);

    // Deliberately use the wrong url to test
    // \Drupal\comment\Controller\CommentController::redirectNode().
    $this
      ->drupalGet('comment/' . $this->node
      ->id() . '/reply');

    // Verify we were correctly redirected.
    $this
      ->assertUrl(Url::fromRoute('comment.reply', [
      'entity_type' => 'node',
      'entity' => $this->node
        ->id(),
      'field_name' => 'comment',
    ], [
      'absolute' => TRUE,
    ])
      ->toString());
    $this
      ->drupalGet('comment/reply/node/' . $this->node
      ->id() . '/comment/' . $comment
      ->id());
    $this
      ->assertText($subject_text, 'Individual comment-reply subject found.');
    $this
      ->assertText($comment_text, 'Individual comment-reply body found.');
    $reply = $this
      ->postComment(NULL, $this
      ->randomMachineName(), '', TRUE);
    $reply_loaded = Comment::load($reply
      ->id());
    $this
      ->assertTrue($this
      ->commentExists($reply, TRUE), 'Reply found.');
    $this
      ->assertEqual($comment
      ->id(), $reply_loaded
      ->getParentComment()
      ->id(), 'Pid of a reply to a comment is set correctly.');

    // Check the thread of reply grows correctly.
    $this
      ->assertEqual(rtrim($comment
      ->getThread(), '/') . '.00/', $reply_loaded
      ->getThread());

    // Second reply to comment #2 creating comment #4.
    $this
      ->drupalGet('comment/reply/node/' . $this->node
      ->id() . '/comment/' . $comment
      ->id());
    $this
      ->assertText($comment
      ->getSubject(), 'Individual comment-reply subject found.');
    $this
      ->assertText($comment->comment_body->value, 'Individual comment-reply body found.');
    $reply = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $reply_loaded = Comment::load($reply
      ->id());
    $this
      ->assertTrue($this
      ->commentExists($reply, TRUE), 'Second reply found.');

    // Check the thread of second reply grows correctly.
    $this
      ->assertEqual(rtrim($comment
      ->getThread(), '/') . '.01/', $reply_loaded
      ->getThread());

    // Reply to comment #4 creating comment #5.
    $this
      ->drupalGet('comment/reply/node/' . $this->node
      ->id() . '/comment/' . $reply_loaded
      ->id());
    $this
      ->assertText($reply_loaded
      ->getSubject(), 'Individual comment-reply subject found.');
    $this
      ->assertText($reply_loaded->comment_body->value, 'Individual comment-reply body found.');
    $reply = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $reply_loaded = Comment::load($reply
      ->id());
    $this
      ->assertTrue($this
      ->commentExists($reply, TRUE), 'Second reply found.');

    // Check the thread of reply to second reply grows correctly.
    $this
      ->assertEqual(rtrim($comment
      ->getThread(), '/') . '.01.00/', $reply_loaded
      ->getThread());

    // Edit reply.
    $this
      ->drupalGet('comment/' . $reply
      ->id() . '/edit');
    $reply = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $this
      ->assertTrue($this
      ->commentExists($reply, TRUE), 'Modified reply found.');

    // Confirm a new comment is posted to the correct page.
    $this
      ->setCommentsPerPage(2);
    $comment_new_page = $this
      ->postComment($this->node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $this
      ->assertTrue($this
      ->commentExists($comment_new_page), 'Page one exists. %s');
    $this
      ->drupalGet('node/' . $this->node
      ->id(), [
      'query' => [
        'page' => 2,
      ],
    ]);
    $this
      ->assertTrue($this
      ->commentExists($reply, TRUE), 'Page two exists. %s');
    $this
      ->setCommentsPerPage(50);

    // Attempt to reply to an unpublished comment.
    $reply_loaded
      ->setUnpublished();
    $reply_loaded
      ->save();
    $this
      ->drupalGet('comment/reply/node/' . $this->node
      ->id() . '/comment/' . $reply_loaded
      ->id());
    $this
      ->assertSession()
      ->statusCodeEquals(403);

    // Attempt to post to node with comments disabled.
    $this->node = $this
      ->drupalCreateNode([
      'type' => 'article',
      'promote' => 1,
      'comment' => [
        [
          'status' => CommentItemInterface::HIDDEN,
        ],
      ],
    ]);
    $this
      ->assertNotNull($this->node, 'Article node created.');
    $this
      ->drupalGet('comment/reply/node/' . $this->node
      ->id() . '/comment');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
    $this
      ->assertNoField('edit-comment', 'Comment body field found.');

    // Attempt to post to node with read-only comments.
    $this->node = $this
      ->drupalCreateNode([
      'type' => 'article',
      'promote' => 1,
      'comment' => [
        [
          'status' => CommentItemInterface::CLOSED,
        ],
      ],
    ]);
    $this
      ->assertNotNull($this->node, 'Article node created.');
    $this
      ->drupalGet('comment/reply/node/' . $this->node
      ->id() . '/comment');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
    $this
      ->assertNoField('edit-comment', 'Comment body field found.');

    // Attempt to post to node with comments enabled (check field names etc).
    $this->node = $this
      ->drupalCreateNode([
      'type' => 'article',
      'promote' => 1,
      'comment' => [
        [
          'status' => CommentItemInterface::OPEN,
        ],
      ],
    ]);
    $this
      ->assertNotNull($this->node, 'Article node created.');
    $this
      ->drupalGet('comment/reply/node/' . $this->node
      ->id() . '/comment');
    $this
      ->assertNoText('This discussion is closed', 'Posting to node with comments enabled');
    $this
      ->assertField('edit-comment-body-0-value', 'Comment body field found.');

    // Delete comment and make sure that reply is also removed.
    $this
      ->drupalLogout();
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->deleteComment($comment);
    $this
      ->deleteComment($comment_new_page);
    $this
      ->drupalGet('node/' . $this->node
      ->id());
    $this
      ->assertFalse($this
      ->commentExists($comment), 'Comment not found.');
    $this
      ->assertFalse($this
      ->commentExists($reply, TRUE), 'Reply not found.');

    // Enabled comment form on node page.
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->setCommentForm(TRUE);
    $this
      ->drupalLogout();

    // Submit comment through node form.
    $this
      ->drupalLogin($this->webUser);
    $this
      ->drupalGet('node/' . $this->node
      ->id());
    $form_comment = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $this
      ->assertTrue($this
      ->commentExists($form_comment), 'Form comment found.');

    // Disable comment form on node page.
    $this
      ->drupalLogout();
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->setCommentForm(FALSE);
  }

  /**
   * Test that the subject is automatically filled if disabled or left blank.
   *
   * When the subject field is blank or disabled, the first 29 characters of the
   * comment body are used for the subject. If this would break within a word,
   * then the break is put at the previous word boundary instead.
   */
  public function testAutoFilledSubject() {
    $this
      ->drupalLogin($this->webUser);
    $this
      ->drupalGet('node/' . $this->node
      ->id());

    // Break when there is a word boundary before 29 characters.
    $body_text = 'Lorem ipsum Lorem ipsum Loreming ipsum Lorem ipsum';
    $comment1 = $this
      ->postComment(NULL, $body_text, '', TRUE);
    $this
      ->assertTrue($this
      ->commentExists($comment1), 'Form comment found.');
    $this
      ->assertEqual('Lorem ipsum Lorem ipsum…', $comment1
      ->getSubject());

    // Break at 29 characters where there's no boundary before that.
    $body_text2 = 'LoremipsumloremipsumLoremingipsumLoremipsum';
    $comment2 = $this
      ->postComment(NULL, $body_text2, '', TRUE);
    $this
      ->assertEqual('LoremipsumloremipsumLoreming…', $comment2
      ->getSubject());
  }

  /**
   * Test that automatic subject is correctly created from HTML comment text.
   *
   * This is the same test as in CommentInterfaceTest::testAutoFilledSubject()
   * with the additional check that HTML is stripped appropriately prior to
   * character-counting.
   */
  public function testAutoFilledHtmlSubject() {

    // Set up two default (i.e. filtered HTML) input formats, because then we
    // can select one of them. Then create a user that can use these formats,
    // log the user in, and then GET the node page on which to test the
    // comments.
    $filtered_html_format = FilterFormat::create([
      'format' => 'filtered_html',
      'name' => 'Filtered HTML',
    ]);
    $filtered_html_format
      ->save();
    $full_html_format = FilterFormat::create([
      'format' => 'full_html',
      'name' => 'Full HTML',
    ]);
    $full_html_format
      ->save();
    $html_user = $this
      ->drupalCreateUser([
      'access comments',
      'post comments',
      'edit own comments',
      'skip comment approval',
      'access content',
      $filtered_html_format
        ->getPermissionName(),
      $full_html_format
        ->getPermissionName(),
    ]);
    $this
      ->drupalLogin($html_user);
    $this
      ->drupalGet('node/' . $this->node
      ->id());

    // HTML should not be included in the character count.
    $body_text1 = '<span></span><strong> </strong><span> </span><strong></strong>Hello World<br />';
    $edit1 = [
      'comment_body[0][value]' => $body_text1,
      'comment_body[0][format]' => 'filtered_html',
    ];
    $this
      ->drupalPostForm(NULL, $edit1, t('Save'));
    $this
      ->assertEqual('Hello World', Comment::load(1)
      ->getSubject());

    // If there's nothing other than HTML, the subject should be '(No subject)'.
    $body_text2 = '<span></span><strong> </strong><span> </span><strong></strong> <br />';
    $edit2 = [
      'comment_body[0][value]' => $body_text2,
      'comment_body[0][format]' => 'filtered_html',
    ];
    $this
      ->drupalPostForm(NULL, $edit2, t('Save'));
    $this
      ->assertEqual('(No subject)', Comment::load(2)
      ->getSubject());
  }

  /**
   * Tests the comment formatter configured with a custom comment view mode.
   */
  public function testViewMode() {
    $this
      ->drupalLogin($this->webUser);
    $this
      ->drupalGet($this->node
      ->toUrl());
    $comment_text = $this
      ->randomMachineName();

    // Post a comment.
    $this
      ->postComment($this->node, $comment_text);

    // Comment displayed in 'default' display mode found and has body text.
    $comment_element = $this
      ->cssSelect('.comment-wrapper');
    $this
      ->assertTrue(!empty($comment_element));
    $this
      ->assertRaw('<p>' . $comment_text . '</p>');

    // Create a new comment entity view mode.
    $mode = mb_strtolower($this
      ->randomMachineName());
    EntityViewMode::create([
      'targetEntityType' => 'comment',
      'id' => "comment.{$mode}",
    ])
      ->save();

    // Create the corresponding entity view display for article node-type. Note
    // that this new view display mode doesn't contain the comment body.
    EntityViewDisplay::create([
      'targetEntityType' => 'comment',
      'bundle' => 'comment',
      'mode' => $mode,
    ])
      ->setStatus(TRUE)
      ->save();

    /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $node_display */
    $node_display = EntityViewDisplay::load('node.article.default');
    $formatter = $node_display
      ->getComponent('comment');

    // Change the node comment field formatter to use $mode mode instead of
    // 'default' mode.
    $formatter['settings']['view_mode'] = $mode;
    $node_display
      ->setComponent('comment', $formatter)
      ->save();

    // Reloading the node page to show the same node with its same comment but
    // with a different display mode.
    $this
      ->drupalGet($this->node
      ->toUrl());

    // The comment should exist but without the body text because we used $mode
    // mode this time.
    $comment_element = $this
      ->cssSelect('.comment-wrapper');
    $this
      ->assertTrue(!empty($comment_element));
    $this
      ->assertNoRaw('<p>' . $comment_text . '</p>');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommentInterfaceTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CommentInterfaceTest::setUp protected function Set up comments to have subject and preview disabled. Overrides CommentTestBase::setUp
CommentInterfaceTest::testAutoFilledHtmlSubject public function Test that automatic subject is correctly created from HTML comment text.
CommentInterfaceTest::testAutoFilledSubject public function Test that the subject is automatically filled if disabled or left blank.
CommentInterfaceTest::testCommentInterface public function Tests the comment interface.
CommentInterfaceTest::testViewMode public function Tests the comment formatter configured with a custom comment view mode.
CommentTestBase::$adminUser protected property An administrative user with permission to configure comment settings. 1
CommentTestBase::$modules public static property Modules to install. Overrides BrowserTestBase::$modules 14
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 public function Checks whether the commenter's contact information is displayed.
CommentTestBase::commentExists public function Checks current page for specified comment.
CommentTestBase::createCommentType protected function Creates a comment comment type (bundle).
CommentTestBase::deleteComment public function Deletes a comment.
CommentTestBase::getUnapprovedComment public function Gets the comment ID for an unapproved comment.
CommentTestBase::performCommentOperation public function Performs the specified operation on the specified comment.
CommentTestBase::postComment public function Posts a comment.
CommentTestBase::setCommentAnonymous public 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.
CommentTestTrait::addDefaultCommentField public function Adds the default comment field to an entity.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.