Issue #1588284 by Tor Arne Thune, aspilicious, Rob Loach: Convert comment tests to PSR-0.

core/modules/comment/comment.info

@@ -6,6 +6,5 @@ core = 8.x
 dependencies[] = node
 dependencies[] = text
 dependencies[] = entity
-files[] = comment.test
 configure = admin/content/comment
 stylesheets[all][] = comment.theme.css

core/modules/comment/lib/Drupal/comment/Tests/CommentActionsTest.php

+<?php
+
+/**
+ * @file
+ * Definition of Drupal\comment\Tests\CommentActionsTest.
+ */
+
+namespace Drupal\comment\Tests;
+
+/**
+ * Tests actions provided by the Comment module.
+ */
+class CommentActionsTest extends CommentTestBase {
+  public static function getInfo() {
+    return array(
+      'name' => 'Comment actions',
+      'description' => 'Test actions provided by the comment module.',
+      'group' => 'Comment',
+    );
+  }
+
+  /**
+   * Tests comment publish and unpublish actions.
+   */
+  function testCommentPublishUnpublishActions() {
+    $this->drupalLogin($this->web_user);
+    $comment_text = $this->randomName();
+    $subject = $this->randomName();
+    $comment = $this->postComment($this->node, $comment_text, $subject);
+    $comment = comment_load($comment->id);
+
+    // Unpublish a comment (direct form: doesn't actually save the comment).
+    comment_unpublish_action($comment);
+    $this->assertEqual($comment->status, COMMENT_NOT_PUBLISHED, t('Comment was unpublished'));
+    $this->assertWatchdogMessage('Unpublished comment %subject.', array('%subject' => $subject), t('Found watchdog message'));
+    $this->clearWatchdog();
+
+    // Unpublish a comment (indirect form: modify the comment in the database).
+    comment_unpublish_action(NULL, array('cid' => $comment->cid));
+    $this->assertEqual(comment_load($comment->cid)->status, COMMENT_NOT_PUBLISHED, t('Comment was unpublished'));
+    $this->assertWatchdogMessage('Unpublished comment %subject.', array('%subject' => $subject), t('Found watchdog message'));
+
+    // Publish a comment (direct form: doesn't actually save the comment).
+    comment_publish_action($comment);
+    $this->assertEqual($comment->status, COMMENT_PUBLISHED, t('Comment was published'));
+    $this->assertWatchdogMessage('Published comment %subject.', array('%subject' => $subject), t('Found watchdog message'));
+    $this->clearWatchdog();
+
+    // Publish a comment (indirect form: modify the comment in the database).
+    comment_publish_action(NULL, array('cid' => $comment->cid));
+    $this->assertEqual(comment_load($comment->cid)->status, COMMENT_PUBLISHED, t('Comment was published'));
+    $this->assertWatchdogMessage('Published comment %subject.', array('%subject' => $subject), t('Found watchdog message'));
+    $this->clearWatchdog();
+  }
+
+  /**
+   * Verifies that a watchdog message has been entered.
+   *
+   * @param $watchdog_message
+   *   The watchdog message.
+   * @param $variables
+   *   The array of variables passed to watchdog().
+   * @param $message
+   *   The assertion message.
+   */
+  function assertWatchdogMessage($watchdog_message, $variables, $message) {
+    $status = (bool) db_query_range("SELECT 1 FROM {watchdog} WHERE message = :message AND variables = :variables", 0, 1, array(':message' => $watchdog_message, ':variables' => serialize($variables)))->fetchField();
+    return $this->assert($status, $message);
+  }
+
+  /**
+   * Clears watchdog.
+   */
+  function clearWatchdog() {
+    db_truncate('watchdog')->execute();
+  }
+}

core/modules/comment/lib/Drupal/comment/Tests/CommentAnonymousTest.php

+<?php
+
+/**
+ * @file
+ * Definition of Drupal\comment\Tests\CommentAnonymousTest.
+ */
+
+namespace Drupal\comment\Tests;
+
+/**
+ * Tests anonymous commenting.
+ */
+class CommentAnonymousTest extends CommentTestBase {
+  public static function getInfo() {
+    return array(
+      'name' => 'Anonymous comments',
+      'description' => 'Test anonymous comments.',
+      'group' => 'Comment',
+    );
+  }
+
+  function setUp() {
+    parent::setUp();
+    variable_set('user_register', USER_REGISTER_VISITORS);
+  }
+
+  /**
+   * Tests anonymous comment functionality.
+   */
+  function testAnonymous() {
+    $this->drupalLogin($this->admin_user);
+    // Enabled anonymous user comments.
+    user_role_change_permissions(DRUPAL_ANONYMOUS_RID, array(
+      'access comments' => TRUE,
+      'post comments' => TRUE,
+      'skip comment approval' => TRUE,
+    ));
+    $this->setCommentAnonymous('0'); // Ensure that doesn't require contact info.
+    $this->drupalLogout();
+
+    // Post anonymous comment without contact info.
+    $anonymous_comment1 = $this->postComment($this->node, $this->randomName(), $this->randomName());
+    $this->assertTrue($this->commentExists($anonymous_comment1), t('Anonymous comment without contact info found.'));
+
+    // Allow contact info.
+    $this->drupalLogin($this->admin_user);
+    $this->setCommentAnonymous('1');
+
+    // Attempt to edit anonymous comment.
+    $this->drupalGet('comment/' . $anonymous_comment1->id . '/edit');
+    $edited_comment = $this->postComment(NULL, $this->randomName(), $this->randomName());
+    $this->assertTrue($this->commentExists($edited_comment, FALSE), t('Modified reply found.'));
+    $this->drupalLogout();
+
+    // Post anonymous comment with contact info (optional).
+    $this->drupalGet('comment/reply/' . $this->node->nid);
+    $this->assertTrue($this->commentContactInfoAvailable(), t('Contact information available.'));
+
+    $anonymous_comment2 = $this->postComment($this->node, $this->randomName(), $this->randomName());
+    $this->assertTrue($this->commentExists($anonymous_comment2), t('Anonymous comment with contact info (optional) found.'));
+
+    // Ensure anonymous users cannot post in the name of registered users.
+    $langcode = LANGUAGE_NOT_SPECIFIED;
+    $edit = array(
+      'name' => $this->admin_user->name,
+      'mail' => $this->randomName() . '@example.com',
+      'subject' => $this->randomName(),
+      "comment_body[$langcode][0][value]" => $this->randomName(),
+    );
+    $this->drupalPost('comment/reply/' . $this->node->nid, $edit, t('Save'));
+    $this->assertText(t('The name you used belongs to a registered user.'));
+
+    // Require contact info.
+    $this->drupalLogin($this->admin_user);
+    $this->setCommentAnonymous('2');
+    $this->drupalLogout();
+
+    // Try to post comment with contact info (required).
+    $this->drupalGet('comment/reply/' . $this->node->nid);
+    $this->assertTrue($this->commentContactInfoAvailable(), t('Contact information available.'));
+
+    $anonymous_comment3 = $this->postComment($this->node, $this->randomName(), $this->randomName(), TRUE);
+    $this->assertText(t('E-mail field is required.'), t('E-mail required.')); // Name should have 'Anonymous' for value by default.
+    $this->assertFalse($this->commentExists($anonymous_comment3), t('Anonymous comment with contact info (required) not found.'));
+
+    // Post comment with contact info (required).
+    $author_name = $this->randomName();
+    $author_mail = $this->randomName() . '@example.com';
+    $anonymous_comment3 = $this->postComment($this->node, $this->randomName(), $this->randomName(), array('name' => $author_name, 'mail' => $author_mail));
+    $this->assertTrue($this->commentExists($anonymous_comment3), t('Anonymous comment with contact info (required) found.'));
+
+    // Make sure the user data appears correctly when editing the comment.
+    $this->drupalLogin($this->admin_user);
+    $this->drupalGet('comment/' . $anonymous_comment3->id . '/edit');
+    $this->assertRaw($author_name, t("The anonymous user's name is correct when editing the comment."));
+    $this->assertRaw($author_mail, t("The anonymous user's e-mail address is correct when editing the comment."));
+
+    // Unpublish comment.
+    $this->performCommentOperation($anonymous_comment3, 'unpublish');
+
+    $this->drupalGet('admin/content/comment/approval');
+    $this->assertRaw('comments[' . $anonymous_comment3->id . ']', t('Comment was unpublished.'));
+
+    // Publish comment.
+    $this->performCommentOperation($anonymous_comment3, 'publish', TRUE);
+
+    $this->drupalGet('admin/content/comment');
+    $this->assertRaw('comments[' . $anonymous_comment3->id . ']', t('Comment was published.'));
+
+    // Delete comment.
+    $this->performCommentOperation($anonymous_comment3, 'delete');
+
+    $this->drupalGet('admin/content/comment');
+    $this->assertNoRaw('comments[' . $anonymous_comment3->id . ']', t('Comment was deleted.'));
+    $this->drupalLogout();
+
+    // Reset.
+    user_role_change_permissions(DRUPAL_ANONYMOUS_RID, array(
+      'access comments' => FALSE,
+      'post comments' => FALSE,
+      'skip comment approval' => FALSE,
+    ));
+
+    // Attempt to view comments while disallowed.
+    // NOTE: if authenticated user has permission to post comments, then a
+    // "Login or register to post comments" type link may be shown.
+    $this->drupalGet('node/' . $this->node->nid);
+    $this->assertNoPattern('@<h2[^>]*>Comments</h2>@', t('Comments were not displayed.'));
+    $this->assertNoLink('Add new comment', t('Link to add comment was found.'));
+
+    // Attempt to view node-comment form while disallowed.
+    $this->drupalGet('comment/reply/' . $this->node->nid);
+    $this->assertText('You are not authorized to post comments', t('Error attempting to post comment.'));
+    $this->assertNoFieldByName('subject', '', t('Subject field not found.'));
+    $this->assertNoFieldByName("comment_body[$langcode][0][value]", '', t('Comment field not found.'));
+
+    user_role_change_permissions(DRUPAL_ANONYMOUS_RID, array(
+      'access comments' => TRUE,
+      'post comments' => FALSE,
+      'skip comment approval' => FALSE,
+    ));
+    $this->drupalGet('node/' . $this->node->nid);
+    $this->assertPattern('@<h2[^>]*>Comments</h2>@', t('Comments were displayed.'));
+    $this->assertLink('Log in', 1, t('Link to log in was found.'));
+    $this->assertLink('register', 1, t('Link to register was found.'));
+
+    user_role_change_permissions(DRUPAL_ANONYMOUS_RID, array(
+      'access comments' => FALSE,
+      'post comments' => TRUE,
+      'skip comment approval' => TRUE,
+    ));
+    $this->drupalGet('node/' . $this->node->nid);
+    $this->assertNoPattern('@<h2[^>]*>Comments</h2>@', t('Comments were not displayed.'));
+    $this->assertFieldByName('subject', '', t('Subject field found.'));
+    $this->assertFieldByName("comment_body[$langcode][0][value]", '', t('Comment field found.'));
+
+    $this->drupalGet('comment/reply/' . $this->node->nid . '/' . $anonymous_comment3->id);
+    $this->assertText('You are not authorized to view comments', t('Error attempting to post reply.'));
+    $this->assertNoText($author_name, t('Comment not displayed.'));
+  }
+}

core/modules/comment/lib/Drupal/comment/Tests/CommentApprovalTest.php

+<?php
+
+/**
+ * @file
+ * Definition of Drupal\comment\Tests\CommentApprovalTest.
+ */
+
+namespace Drupal\comment\Tests;
+
+/**
+ * Tests comment approval functionality.
+ */
+class CommentApprovalTest extends CommentTestBase {
+  public static function getInfo() {
+    return array(
+      'name' => 'Comment approval',
+      'description' => 'Test comment approval functionality.',
+      'group' => 'Comment',
+    );
+  }
+
+  /**
+   * Test comment approval functionality through admin/content/comment.
+   */
+  function testApprovalAdminInterface() {
+    // Set anonymous comments to require approval.
+    user_role_change_permissions(DRUPAL_ANONYMOUS_RID, array(
+      'access comments' => TRUE,
+      'post comments' => TRUE,
+      'skip comment approval' => FALSE,
+    ));
+    $this->drupalLogin($this->admin_user);
+    $this->setCommentAnonymous('0'); // Ensure that doesn't require contact info.
+
+    // Test that the comments page loads correctly when there are no comments
+    $this->drupalGet('admin/content/comment');
+    $this->assertText(t('No comments available.'));
+
+    $this->drupalLogout();
+
+    // Post anonymous comment without contact info.
+    $subject = $this->randomName();
+    $body = $this->randomName();
+    $this->postComment($this->node, $body, $subject, TRUE); // Set $contact to true so that it won't check for id and message.
+    $this->assertText(t('Your comment has been queued for review by site administrators and will be published after approval.'), t('Comment requires approval.'));
+
+    // Get unapproved comment id.
+    $this->drupalLogin($this->admin_user);
+    $anonymous_comment4 = $this->getUnapprovedComment($subject);
+    $anonymous_comment4 = entity_create('comment', array('id' => $anonymous_comment4, 'subject' => $subject, 'comment' => $body));
+    $this->drupalLogout();
+
+    $this->assertFalse($this->commentExists($anonymous_comment4), t('Anonymous comment was not published.'));
+
+    // Approve comment.
+    $this->drupalLogin($this->admin_user);
+    $this->performCommentOperation($anonymous_comment4, 'publish', TRUE);
+    $this->drupalLogout();
+
+    $this->drupalGet('node/' . $this->node->nid);
+    $this->assertTrue($this->commentExists($anonymous_comment4), t('Anonymous comment visible.'));
+
+    // Post 2 anonymous comments without contact info.
+    $comments[] = $this->postComment($this->node, $this->randomName(), $this->randomName(), TRUE);
+    $comments[] = $this->postComment($this->node, $this->randomName(), $this->randomName(), TRUE);
+
+    // Publish multiple comments in one operation.
+    $this->drupalLogin($this->admin_user);
+    $this->drupalGet('admin/content/comment/approval');
+    $this->assertText(t('Unapproved comments (@count)', array('@count' => 2)), t('Two unapproved comments waiting for approval.'));
+    $edit = array(
+      "comments[{$comments[0]->id}]" => 1,
+      "comments[{$comments[1]->id}]" => 1,
+    );
+    $this->drupalPost(NULL, $edit, t('Update'));
+    $this->assertText(t('Unapproved comments (@count)', array('@count' => 0)), t('All comments were approved.'));
+
+    // Delete multiple comments in one operation.
+    $edit = array(
+      'operation' => 'delete',
+      "comments[{$comments[0]->id}]" => 1,
+      "comments[{$comments[1]->id}]" => 1,
+      "comments[{$anonymous_comment4->id}]" => 1,
+    );
+    $this->drupalPost(NULL, $edit, t('Update'));
+    $this->assertText(t('Are you sure you want to delete these comments and all their children?'), t('Confirmation required.'));
+    $this->drupalPost(NULL, $edit, t('Delete comments'));
+    $this->assertText(t('No comments available.'), t('All comments were deleted.'));
+  }
+
+  /**
+   * Tests comment approval functionality through the node interface.
+   */
+  function testApprovalNodeInterface() {
+    // Set anonymous comments to require approval.
+    user_role_change_permissions(DRUPAL_ANONYMOUS_RID, array(
+      'access comments' => TRUE,
+      'post comments' => TRUE,
+      'skip comment approval' => FALSE,
+    ));
+    $this->drupalLogin($this->admin_user);
+    $this->setCommentAnonymous('0'); // Ensure that doesn't require contact info.
+    $this->drupalLogout();
+
+    // Post anonymous comment without contact info.
+    $subject = $this->randomName();
+    $body = $this->randomName();
+    $this->postComment($this->node, $body, $subject, TRUE); // Set $contact to true so that it won't check for id and message.
+    $this->assertText(t('Your comment has been queued for review by site administrators and will be published after approval.'), t('Comment requires approval.'));
+
+    // Get unapproved comment id.
+    $this->drupalLogin($this->admin_user);
+    $anonymous_comment4 = $this->getUnapprovedComment($subject);
+    $anonymous_comment4 = entity_create('comment', array('id' => $anonymous_comment4, 'subject' => $subject, 'comment' => $body));
+    $this->drupalLogout();
+
+    $this->assertFalse($this->commentExists($anonymous_comment4), t('Anonymous comment was not published.'));
+
+    // Approve comment.
+    $this->drupalLogin($this->admin_user);
+    $this->drupalGet('comment/1/approve');
+    $this->assertResponse(403, t('Forged comment approval was denied.'));
+    $this->drupalGet('comment/1/approve', array('query' => array('token' => 'forged')));
+    $this->assertResponse(403, t('Forged comment approval was denied.'));
+    $this->drupalGet('node/' . $this->node->nid);
+    $this->clickLink(t('approve'));
+    $this->drupalLogout();
+
+    $this->drupalGet('node/' . $this->node->nid);
+    $this->assertTrue($this->commentExists($anonymous_comment4), t('Anonymous comment visible.'));
+  }
+}

core/modules/comment/lib/Drupal/comment/Tests/CommentBlockTest.php

+<?php
+
+/**
+ * @file
+ * Definition of Drupal\comment\Tests\CommentBlockTest.
+ */
+
+namespace Drupal\comment\Tests;
+
+/**
+ * Tests the Comment module blocks.
+ */
+class CommentBlockTest extends CommentTestBase {
+  public static function getInfo() {
+    return array(
+      'name' => 'Comment blocks',
+      'description' => 'Test comment block functionality.',
+      'group' => 'Comment',
+    );
+  }
+
+  /**
+   * Tests the recent comments block.
+   */
+  function testRecentCommentBlock() {
+    $this->drupalLogin($this->admin_user);
+
+    // Set the block to a region to confirm block is available.
+    $edit = array(
+      'blocks[comment_recent][region]' => 'sidebar_first',
+    );
+    $this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
+    $this->assertText(t('The block settings have been updated.'), t('Block saved to first sidebar region.'));
+
+    // Set block title and variables.
+    $block = array(
+      'title' => $this->randomName(),
+      'comment_block_count' => 2,
+    );
+    $this->drupalPost('admin/structure/block/manage/comment/recent/configure', $block, t('Save block'));
+    $this->assertText(t('The block configuration has been saved.'), t('Block saved.'));
+
+    // Add some test comments, one without a subject.
+    $comment1 = $this->postComment($this->node, $this->randomName(), $this->randomName());
+    $comment2 = $this->postComment($this->node, $this->randomName(), $this->randomName());
+    $comment3 = $this->postComment($this->node, $this->randomName());
+
+    // Test that a user without the 'access comments' permission cannot see the
+    // block.
+    $this->drupalLogout();
+    user_role_revoke_permissions(DRUPAL_ANONYMOUS_RID, array('access comments'));
+    // drupalCreateNode() does not automatically flush content caches unlike
+    // posting a node from a node form.
+    cache_clear_all();
+    $this->drupalGet('');
+    $this->assertNoText($block['title'], t('Block was not found.'));
+    user_role_grant_permissions(DRUPAL_ANONYMOUS_RID, array('access comments'));
+
+    // Test that a user with the 'access comments' permission can see the
+    // block.
+    $this->drupalLogin($this->web_user);
+    $this->drupalGet('');
+    $this->assertText($block['title'], t('Block was found.'));
+
+    // Test the only the 2 latest comments are shown and in the proper order.
+    $this->assertNoText($comment1->subject, t('Comment not found in block.'));
+    $this->assertText($comment2->subject, t('Comment found in block.'));
+    $this->assertText($comment3->comment, t('Comment found in block.'));
+    $this->assertTrue(strpos($this->drupalGetContent(), $comment3->comment) < strpos($this->drupalGetContent(), $comment2->subject), t('Comments were ordered correctly in block.'));
+
+    // Set the number of recent comments to show to 10.
+    $this->drupalLogout();
+    $this->drupalLogin($this->admin_user);
+    $block = array(
+      'comment_block_count' => 10,
+    );
+    $this->drupalPost('admin/structure/block/manage/comment/recent/configure', $block, t('Save block'));
+    $this->assertText(t('The block configuration has been saved.'), t('Block saved.'));
+
+    // Post an additional comment.
+    $comment4 = $this->postComment($this->node, $this->randomName(), $this->randomName());
+
+    // Test that all four comments are shown.
+    $this->assertText($comment1->subject, t('Comment found in block.'));
+    $this->assertText($comment2->subject, t('Comment found in block.'));
+    $this->assertText($comment3->comment, t('Comment found in block.'));
+    $this->assertText($comment4->subject, t('Comment found in block.'));
+
+    // Test that links to comments work when comments are across pages.
+    $this->setCommentsPerPage(1);
+    $this->drupalGet('');
+    $this->clickLink($comment1->subject);
+    $this->assertText($comment1->subject, t('Comment link goes to correct page.'));
+    $this->drupalGet('');
+    $this->clickLink($comment2->subject);
+    $this->assertText($comment2->subject, t('Comment link goes to correct page.'));
+    $this->clickLink($comment4->subject);
+    $this->assertText($comment4->subject, t('Comment link goes to correct page.'));
+    // Check that when viewing a comment page from a link to the comment, that
+    // rel="canonical" is added to the head of the document.
+    $this->assertRaw('<link rel="canonical"', t('Canonical URL was found in the HTML head'));
+  }
+}

core/modules/comment/lib/Drupal/comment/Tests/CommentContentRebuildTest.php

+<?php
+
+/**
+ * @file
+ * Definition of Drupal\comment\Tests\CommentContentRebuildTest.
+ */
+
+namespace Drupal\comment\Tests;
+
+/**
+ * Tests comment content rebuilding.
+ */
+class CommentContentRebuildTest extends CommentTestBase {
+  public static function getInfo() {
+    return array(
+      'name' => 'Comment Rebuild',
+      'description' => 'Test to make sure the comment content is rebuilt.',
+      'group' => 'Comment',
+    );
+  }
+
+  /**
+   * Tests the rebuilding of comment's content arrays on calling comment_view().
+   */
+  function testCommentRebuild() {
+    // Update the comment settings so preview isn't required.
+    $this->drupalLogin($this->admin_user);
+    $this->setCommentSubject(TRUE);
+    $this->setCommentPreview(DRUPAL_OPTIONAL);
+    $this->drupalLogout();
+
+    // Log in as the web user and add the comment.
+    $this->drupalLogin($this->web_user);
+    $subject_text = $this->randomName();
+    $comment_text = $this->randomName();
+    $comment = $this->postComment($this->node, $comment_text, $subject_text, TRUE);
+    $comment_loaded = comment_load($comment->id);
+    $this->assertTrue($this->commentExists($comment), t('Comment found.'));
+
+    // Add the property to the content array and then see if it still exists on build.
+    $comment_loaded->content['test_property'] = array('#value' => $this->randomString());
+    $built_content = comment_view($comment_loaded, $this->node);
+
+    // This means that the content was rebuilt as the added test property no longer exists.
+    $this->assertFalse(isset($built_content['test_property']), t('Comment content was emptied before being built.'));
+  }
+}

core/modules/comment/lib/Drupal/comment/Tests/CommentFieldsTest.php

+<?php
+
+/**
+ * @file
+ * Definition of Drupal\comment\Tests\CommentFieldsTest.
+ */
+
+namespace Drupal\comment\Tests;
+
+/**
+ * Tests fields on comments.
+ */
+class CommentFieldsTest extends CommentTestBase {
+  public static function getInfo() {
+    return array(
+      'name' => 'Comment fields',
+      'description' => 'Tests fields on comments.',
+      'group' => 'Comment',
+    );
+  }
+
+  /**
+   * Tests that the default 'comment_body' field is correctly added.
+   */
+  function testCommentDefaultFields() {
+    // Do not make assumptions on default node types created by the test
+    // install profile, and create our own.
+    $this->drupalCreateContentType(array('type' => 'test_node_type'));
+
+    // Check that the 'comment_body' field is present on all comment bundles.
+    $instances = field_info_instances('comment');
+    foreach (node_type_get_types() as $type_name => $info) {
+      $this->assertTrue(isset($instances['comment_node_' . $type_name]['comment_body']), t('The comment_body field is present for comments on type @type', array('@type' => $type_name)));
+
+      // Delete the instance along the way.
+      field_delete_instance($instances['comment_node_' . $type_name]['comment_body']);
+    }
+