function CommentNonNodeTest::testCommentFunctionality

Tests anonymous comment functionality.

File

core/modules/comment/tests/src/Functional/CommentNonNodeTest.php, line 271

Class

CommentNonNodeTest

Tests commenting on a test entity.

Namespace

Code

public function testCommentFunctionality() : void {
  $limited_user = $this->drupalCreateUser([
    'administer entity_test fields',
  ]);
  $this->drupalLogin($limited_user);
  // Test that default field exists.
  $this->drupalGet('entity_test/structure/entity_test/fields');
  $this->assertSession()
    ->pageTextContains('Comments');
  $this->assertSession()
    ->linkByHrefExists('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
  // Test widget hidden option is not visible when there's no comments.
  $this->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
  $this->assertSession()
    ->statusCodeEquals(200);
  $this->assertSession()
    ->fieldNotExists('edit-default-value-input-comment-und-0-status-0');
  // Test that field to change cardinality is not available.
  $this->assertSession()
    ->fieldNotExists('cardinality_number');
  $this->assertSession()
    ->fieldNotExists('cardinality');
  $this->drupalLogin($this->adminUser);
  // Test breadcrumb on comment add page.
  $this->drupalGet('comment/reply/entity_test/' . $this->entity
    ->id() . '/comment');
  $this->assertSession()
    ->elementTextEquals('xpath', '//nav[@aria-labelledby="system-breadcrumb"]/ol/li[last()]/a', $this->entity
    ->label());
  // Post a comment.
  /** @var \Drupal\comment\CommentInterface $comment1 */
  $comment1 = $this->postComment($this->entity, $this->randomMachineName(), $this->randomMachineName());
  $this->assertTrue($this->commentExists($comment1), 'Comment on test entity exists.');
  // Test breadcrumb on comment reply page.
  $this->drupalGet('comment/reply/entity_test/' . $this->entity
    ->id() . '/comment/' . $comment1->id());
  $this->assertSession()
    ->elementTextEquals('xpath', '//nav[@aria-labelledby="system-breadcrumb"]/ol/li[last()]/a', $comment1->getSubject());
  // Test breadcrumb on comment edit page.
  $this->drupalGet('comment/' . $comment1->id() . '/edit');
  $this->assertSession()
    ->elementTextEquals('xpath', '//nav[@aria-labelledby="system-breadcrumb"]/ol/li[last()]/a', $comment1->getSubject());
  // Test breadcrumb on comment delete page.
  $this->drupalGet('comment/' . $comment1->id() . '/delete');
  $this->assertSession()
    ->elementTextEquals('xpath', '//nav[@aria-labelledby="system-breadcrumb"]/ol/li[last()]/a', $comment1->getSubject());
  // Test threading replying to comment #1 creating comment #1_2.
  $this->drupalGet('comment/reply/entity_test/' . $this->entity
    ->id() . '/comment/' . $comment1->id());
  $comment1_2 = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName());
  $this->assertTrue($this->commentExists($comment1_2, TRUE), 'Comment #1_2. Reply found.');
  $this->assertEquals('01.00/', $comment1_2->getThread());
  // Test nested threading replying to comment #1_2 creating comment #1_2_3.
  $this->drupalGet('comment/reply/entity_test/' . $this->entity
    ->id() . '/comment/' . $comment1_2->id());
  $comment1_2_3 = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName());
  $this->assertTrue($this->commentExists($comment1_2_3, TRUE), 'Comment #1_2_3. Reply found.');
  $this->assertEquals('01.00.00/', $comment1_2_3->getThread());
  // Unpublish the comment.
  $this->performCommentOperation($comment1, 'unpublish');
  $this->drupalGet('admin/content/comment/approval');
  $this->assertSession()
    ->responseContains('comments[' . $comment1->id() . ']');
  // Publish the comment.
  $this->performCommentOperation($comment1, 'publish', TRUE);
  $this->drupalGet('admin/content/comment');
  $this->assertSession()
    ->responseContains('comments[' . $comment1->id() . ']');
  // Delete the comment.
  $this->performCommentOperation($comment1, 'delete');
  $this->drupalGet('admin/content/comment');
  $this->assertSession()
    ->responseNotContains('comments[' . $comment1->id() . ']');
  // Post another comment.
  $comment1 = $this->postComment($this->entity, $this->randomMachineName(), $this->randomMachineName());
  $this->assertTrue($this->commentExists($comment1), 'Comment on test entity exists.');
  // Check that the comment was found.
  $this->drupalGet('admin/content/comment');
  $this->assertSession()
    ->responseContains('comments[' . $comment1->id() . ']');
  // Check that entity access applies to administrative page.
  $this->assertSession()
    ->pageTextContains($this->entity
    ->label());
  $limited_user = $this->drupalCreateUser([
    'administer comments',
  ]);
  $this->drupalLogin($limited_user);
  $this->drupalGet('admin/content/comment');
  $this->assertSession()
    ->pageTextNotContains($this->entity
    ->label());
  $this->drupalLogout();
  // Deny anonymous users access to comments.
  user_role_change_permissions(RoleInterface::ANONYMOUS_ID, [
    'access comments' => FALSE,
    'post comments' => FALSE,
    'skip comment approval' => FALSE,
    'view test entity' => TRUE,
  ]);
  // Attempt to view comments while disallowed.
  $this->drupalGet('entity-test/' . $this->entity
    ->id());
  // Verify that comments were not displayed.
  $this->assertSession()
    ->responseNotMatches('@<h2[^>]*>Comments</h2>@');
  $this->assertSession()
    ->linkNotExists('Add new comment', 'Link to add comment was found.');
  // Attempt to view test entity comment form while disallowed.
  $this->drupalGet('comment/reply/entity_test/' . $this->entity
    ->id() . '/comment');
  $this->assertSession()
    ->statusCodeEquals(403);
  $this->assertSession()
    ->fieldNotExists('subject[0][value]');
  $this->assertSession()
    ->fieldNotExists('comment_body[0][value]');
  user_role_change_permissions(RoleInterface::ANONYMOUS_ID, [
    'access comments' => TRUE,
    'post comments' => FALSE,
    'view test entity' => TRUE,
    'skip comment approval' => FALSE,
  ]);
  $this->drupalGet('entity_test/' . $this->entity
    ->id());
  // Verify that the comment field title is displayed.
  $this->assertSession()
    ->responseMatches('@<h2[^>]*>Comments</h2>@');
  $this->assertSession()
    ->linkExists('Log in', 0, 'Link to login was found.');
  $this->assertSession()
    ->linkExists('register', 0, 'Link to register was found.');
  $this->assertSession()
    ->fieldNotExists('subject[0][value]');
  $this->assertSession()
    ->fieldNotExists('comment_body[0][value]');
  // Test the combination of anonymous users being able to post, but not view
  // comments, to ensure that access to post comments doesn't grant access to
  // view them.
  user_role_change_permissions(RoleInterface::ANONYMOUS_ID, [
    'access comments' => FALSE,
    'post comments' => TRUE,
    'skip comment approval' => TRUE,
    'view test entity' => TRUE,
  ]);
  $this->drupalGet('entity_test/' . $this->entity
    ->id());
  // Verify that comments were not displayed.
  $this->assertSession()
    ->responseNotMatches('@<h2[^>]*>Comments</h2>@');
  $this->assertSession()
    ->fieldValueEquals('subject[0][value]', '');
  $this->assertSession()
    ->fieldValueEquals('comment_body[0][value]', '');
  $this->drupalGet('comment/reply/entity_test/' . $this->entity
    ->id() . '/comment/' . $comment1->id());
  $this->assertSession()
    ->statusCodeEquals(403);
  $this->assertSession()
    ->pageTextNotContains($comment1->getSubject());
  // Test comment field widget changes.
  $limited_user = $this->drupalCreateUser([
    'administer entity_test fields',
    'view test entity',
    'administer entity_test content',
    'administer comments',
  ]);
  $this->drupalLogin($limited_user);
  $this->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
  $this->assertSession()
    ->checkboxNotChecked('edit-default-value-input-comment-0-status-0');
  $this->assertSession()
    ->checkboxNotChecked('edit-default-value-input-comment-0-status-1');
  $this->assertSession()
    ->checkboxChecked('edit-default-value-input-comment-0-status-2');
  // Test comment option change in field settings.
  $edit = [
    'default_value_input[comment][0][status]' => CommentItemInterface::CLOSED,
    'settings[anonymous]' => CommentInterface::ANONYMOUS_MAY_CONTACT,
  ];
  $this->submitForm($edit, 'Save settings');
  $this->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
  $this->assertSession()
    ->checkboxNotChecked('edit-default-value-input-comment-0-status-0');
  $this->assertSession()
    ->checkboxChecked('edit-default-value-input-comment-0-status-1');
  $this->assertSession()
    ->checkboxNotChecked('edit-default-value-input-comment-0-status-2');
  $this->assertSession()
    ->fieldValueEquals('settings[anonymous]', CommentInterface::ANONYMOUS_MAY_CONTACT);
  // Add a new comment-type.
  $bundle = CommentType::create([
    'id' => 'foobar',
    'label' => 'Foobar',
    'description' => '',
    'target_entity_type_id' => 'entity_test',
  ]);
  $bundle->save();
  // Add a new comment field.
  $storage_edit = [
    'settings[comment_type]' => 'foobar',
  ];
  $this->fieldUIAddNewField('entity_test/structure/entity_test', 'foobar', 'Foobar', 'comment', $storage_edit);
  // Add a third comment field.
  $this->fieldUIAddNewField('entity_test/structure/entity_test', 'bar_foo', 'Bar_Foo', 'comment', $storage_edit);
  // Check the field contains the correct comment type.
  $field_storage = FieldStorageConfig::load('entity_test.field_bar_foo');
  $this->assertInstanceOf(FieldStorageConfig::class, $field_storage);
  $this->assertEquals('foobar', $field_storage->getSetting('comment_type'));
  $this->assertEquals(1, $field_storage->getCardinality());
  // Test the new entity commenting inherits default.
  $random_label = $this->randomMachineName();
  $data = [
    'bundle' => 'entity_test',
    'name' => $random_label,
  ];
  $new_entity = EntityTest::create($data);
  $new_entity->save();
  $this->drupalGet('entity_test/manage/' . $new_entity->id() . '/edit');
  $this->assertSession()
    ->checkboxChecked('edit-field-foobar-0-status-2');
  $this->assertSession()
    ->checkboxNotChecked('edit-field-foobar-0-status-0');
  $this->assertSession()
    ->fieldNotExists('edit-field-foobar-0-status-1');
  // @todo Check proper URL and form https://www.drupal.org/node/2458323
  $this->drupalGet('comment/reply/entity_test/comment/' . $new_entity->id());
  $this->assertSession()
    ->fieldNotExists('subject[0][value]');
  $this->assertSession()
    ->fieldNotExists('comment_body[0][value]');
  // Test removal of comment_body field.
  $limited_user = $this->drupalCreateUser([
    'administer entity_test fields',
    'post comments',
    'administer comment fields',
    'administer comment types',
    'view test entity',
  ]);
  $this->drupalLogin($limited_user);
  $this->drupalGet('comment/reply/entity_test/' . $this->entity
    ->id() . '/comment');
  $this->assertSession()
    ->fieldValueEquals('comment_body[0][value]', '');
  $this->fieldUIDeleteField('admin/structure/comment/manage/comment', 'comment.comment.comment_body', 'Comment', 'Comment settings', 'comment type');
  $this->drupalGet('comment/reply/entity_test/' . $this->entity
    ->id() . '/comment');
  $this->assertSession()
    ->fieldNotExists('comment_body[0][value]');
  // Set subject field to autogenerate it.
  $edit = [
    'subject[0][value]' => '',
  ];
  $this->submitForm($edit, 'Save');
}