function CommentInterfaceTest::testCommentInterface

Same name and namespace in other branches
  1. 7.x modules/comment/comment.test \CommentInterfaceTest::testCommentInterface()
  2. 9 core/modules/comment/tests/src/Functional/CommentInterfaceTest.php \Drupal\Tests\comment\Functional\CommentInterfaceTest::testCommentInterface()
  3. 8.9.x core/modules/comment/tests/src/Functional/CommentInterfaceTest.php \Drupal\Tests\comment\Functional\CommentInterfaceTest::testCommentInterface()
  4. 11.x core/modules/comment/tests/src/Functional/CommentInterfaceTest.php \Drupal\Tests\comment\Functional\CommentInterfaceTest::testCommentInterface()

Tests the comment interface.

File

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

Class

CommentInterfaceTest
Tests comment user interfaces.

Namespace

Drupal\Tests\comment\Functional

Code

public function testCommentInterface() : void {
  // 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 that using an invalid entity-type does not raise an error.
  $this->drupalGet('comment/reply/yeah-this-is-not-an-entity-type/' . $this->node
    ->id() . '/comment/' . $comment->id());
  $this->assertSession()
    ->statusCodeEquals(404);
  // Test the comment field title is displayed when there's comments.
  $this->drupalGet($this->node
    ->toUrl());
  $this->assertSession()
    ->responseMatches('@<h2[^>]*>Comments</h2>@');
  // Set comments to have subject and preview to required.
  $this->drupalLogout();
  $this->setCommentSubject(TRUE);
  $this->setCommentPreview(DRUPAL_REQUIRED);
  // 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->assertSession()
    ->pageTextContains($subject_text);
  $this->assertSession()
    ->pageTextContains($comment_text);
  $this->assertSession()
    ->elementExists('xpath', '//footer/a[contains(@href,"' . base_path() . 'comment/' . $comment->id() . '#comment-' . $comment->id() . '") and text()="Permalink"]');
  // 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->assertSession()
    ->titleEquals('Edit comment ' . $comment->getSubject() . ' | Drupal');
  // Test changing the comment author to "Anonymous".
  $comment = $this->postComment(NULL, $comment->comment_body->value, $comment->getSubject(), [
    'uid' => '',
  ]);
  $this->assertSame('Anonymous', $comment->getAuthorName());
  $this->assertEquals(0, $comment->getOwnerId());
  // 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->assertSession()
    ->pageTextContains($random_name . ' (not verified)');
  // 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->assertSame($this->webUser
    ->getAccountName(), $comment->getAuthorName());
  $this->assertSame($this->webUser
    ->id(), $comment->getOwnerId());
  $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->assertSession()
    ->addressEquals(Url::fromRoute('comment.reply', [
    'entity_type' => 'node',
    'entity' => $this->node
      ->id(),
    'field_name' => 'comment',
  ]));
  $this->drupalGet('comment/reply/node/' . $this->node
    ->id() . '/comment/' . $comment->id());
  $this->assertSession()
    ->pageTextContains($subject_text);
  $this->assertSession()
    ->pageTextContains($comment_text);
  $reply = $this->postComment(NULL, $this->randomMachineName(), '', TRUE);
  $reply_loaded = Comment::load($reply->id());
  $this->assertTrue($this->commentExists($reply, TRUE), 'Reply found.');
  $this->assertEquals($comment->id(), $reply_loaded->getParentComment()
    ->id(), 'Pid of a reply to a comment is set correctly.');
  // Check the thread of reply grows correctly.
  $this->assertEquals(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->assertSession()
    ->pageTextContains($comment->getSubject());
  $this->assertSession()
    ->pageTextContains($comment->comment_body->value);
  $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->assertEquals(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->assertSession()
    ->pageTextContains($reply_loaded->getSubject());
  $this->assertSession()
    ->pageTextContains($reply_loaded->comment_body->value);
  $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->assertEquals(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->assertSession()
    ->fieldNotExists('edit-comment');
  // 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->assertSession()
    ->fieldNotExists('edit-comment');
  // 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->assertSession()
    ->pageTextNotContains('This discussion is closed');
  // Ensure that the comment body field exists.
  $this->assertSession()
    ->fieldExists('edit-comment-body-0-value');
  // 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->setCommentForm(TRUE);
  // 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->setCommentForm(FALSE);
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.