CommentInterfaceTest.php in Zircon Profile 8

Contains \Drupal\comment\Tests\CommentInterfaceTest.

Namespace

Drupal\comment\Tests

File

core/modules/comment/src/Tests/CommentInterfaceTest.php

<?php

/**
 * @file
 * Contains \Drupal\comment\Tests\CommentInterfaceTest.
 */
namespace Drupal\comment\Tests;

use Drupal\comment\CommentManagerInterface;
use Drupal\comment\Plugin\Field\FieldType\CommentItemInterface;
use Drupal\comment\Entity\Comment;
use Drupal\user\RoleInterface;
use Drupal\filter\Entity\FilterFormat;

/**
 * Tests comment user interfaces.
 *
 * @group comment
 */
class CommentInterfaceTest extends CommentTestBase {

  /**
   * Set up comments to have subject and preview disabled.
   */
  public 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
      ->urlInfo());
    $this
      ->assertNoPattern('@<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
      ->urlInfo());
    $this
      ->assertPattern('@<h2[^>]*>Comments</h2>@', 'Comments title is displayed.');

    // 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, array(
      '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.');

    // 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(t('Edit comment @title | Drupal', array(
      '@title' => $comment
        ->getSubject(),
    )));

    // Test changing the comment author to "Anonymous".
    $comment = $this
      ->postComment(NULL, $comment->comment_body->value, $comment
      ->getSubject(), array(
      '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(), array(
      '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(), array(
      'uid' => $this->webUser
        ->getUsername() . ' (' . $this->webUser
        ->id() . ')',
    ));
    $this
      ->assertTrue($comment
      ->getAuthorName() == $this->webUser
      ->getUsername() && $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(\Drupal::url('comment.reply', array(
      'entity_type' => 'node',
      'entity' => $this->node
        ->id(),
      'field_name' => 'comment',
    ), array(
      'absolute' => TRUE,
    )));
    $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(), array(
      'query' => array(
        'page' => 2,
      ),
    ));
    $this
      ->assertTrue($this
      ->commentExists($reply, TRUE), 'Page two exists. %s');
    $this
      ->setCommentsPerPage(50);

    // Attempt to reply to an unpublished comment.
    $reply_loaded
      ->setPublished(FALSE);
    $reply_loaded
      ->save();
    $this
      ->drupalGet('comment/reply/node/' . $this->node
      ->id() . '/comment/' . $reply_loaded
      ->id());
    $this
      ->assertResponse(403);

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

    // Attempt to post to node with read-only comments.
    $this->node = $this
      ->drupalCreateNode(array(
      'type' => 'article',
      'promote' => 1,
      'comment' => array(
        array(
          'status' => CommentItemInterface::CLOSED,
        ),
      ),
    ));
    $this
      ->assertTrue($this->node, 'Article node created.');
    $this
      ->drupalGet('comment/reply/node/' . $this->node
      ->id() . '/comment');
    $this
      ->assertResponse(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(array(
      'type' => 'article',
      'promote' => 1,
      'comment' => array(
        array(
          'status' => CommentItemInterface::OPEN,
        ),
      ),
    ));
    $this
      ->assertTrue($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(array(
      'format' => 'filtered_html',
      'name' => 'Filtered HTML',
    ));
    $filtered_html_format
      ->save();
    $full_html_format = FilterFormat::create(array(
      'format' => 'full_html',
      'name' => 'Full HTML',
    ));
    $full_html_format
      ->save();
    $html_user = $this
      ->drupalCreateUser(array(
      '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 = array(
      '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 = array(
      '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());
  }

}

Classes

Name	Description
CommentInterfaceTest	Tests comment user interfaces.