CommentNonNodeTest.php 16.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
<?php

/**
 * @file
 * Contains \Drupal\comment\Tests\CommentNonNodeTest.
 */

namespace Drupal\comment\Tests;

use Drupal\comment\CommentInterface;
11
use Drupal\comment\Entity\CommentType;
12
use Drupal\comment\Plugin\Field\FieldType\CommentItemInterface;
13
use Drupal\field\Entity\FieldConfig;
14
use Drupal\field_ui\Tests\FieldUiTestTrait;
15 16 17 18
use Drupal\simpletest\WebTestBase;
use Drupal\Core\Entity\EntityInterface;

/**
19 20 21
 * Tests commenting on a test entity.
 *
 * @group comment
22 23 24
 */
class CommentNonNodeTest extends WebTestBase {

25 26
  use FieldUiTestTrait;

27 28 29 30 31 32 33
  public static $modules = array('comment', 'user', 'field_ui', 'entity_test');

  /**
   * An administrative user with permission to configure comment settings.
   *
   * @var \Drupal\user\UserInterface
   */
34
  protected $adminUser;
35

36
  protected function setUp() {
37 38
    parent::setUp();

39 40
    // Create a bundle for entity_test.
    entity_test_create_bundle('entity_test', 'Entity Test', 'entity_test');
41 42 43 44 45 46
    entity_create('comment_type', array(
      'id' => 'comment',
      'label' => 'Comment settings',
      'description' => 'Comment settings',
      'target_entity_type_id' => 'entity_test',
    ))->save();
47 48
    // Create comment field on entity_test bundle.
    $this->container->get('comment.manager')->addDefaultField('entity_test', 'entity_test');
49

50 51
    // Verify that bundles are defined correctly.
    $bundles = \Drupal::entityManager()->getBundleInfo('comment');
52
    $this->assertEqual($bundles['comment']['label'], 'Comment settings');
53

54
    // Create test user.
55
    $this->adminUser = $this->drupalCreateUser(array(
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
      'administer comments',
      'skip comment approval',
      'post comments',
      'access comments',
      'view test entity',
      'administer entity_test content',
    ));

    // Enable anonymous and authenticated user comments.
    user_role_grant_permissions(DRUPAL_ANONYMOUS_RID, array(
      'access comments',
      'post comments',
      'skip comment approval',
    ));
    user_role_grant_permissions(DRUPAL_AUTHENTICATED_RID, array(
      'access comments',
      'post comments',
      'skip comment approval',
    ));

    // Create a test entity.
77
    $random_label = $this->randomMachineName();
78 79
    $data = array('type' => 'entity_test', 'name' => $random_label);
    $this->entity = entity_create('entity_test', $data);
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
    $this->entity->save();
  }

  /**
   * Posts a comment.
   *
   * @param \Drupal\Core\Entity\EntityInterface|null $entity
   *   Entity to post comment on or NULL to post to the previously loaded page.
   * @param $comment
   *   Comment body.
   * @param $subject
   *   Comment subject.
   * @param $contact
   *   Set to NULL for no contact info, TRUE to ignore success checking, and
   *   array of values to set contact info.
   */
  function postComment(EntityInterface $entity, $comment, $subject = '', $contact = NULL) {
    $edit = array();
    $edit['comment_body[0][value]'] = $comment;

100 101
    $field = FieldConfig::loadByName('entity_test', 'entity_test', 'comment');
    $preview_mode = $field->getSetting('preview');
102 103 104

    // Must get the page before we test for fields.
    if ($entity !== NULL) {
105
      $this->drupalGet('comment/reply/entity_test/' . $entity->id() . '/comment');
106 107
    }

108 109 110 111
    // Determine the visibility of subject form field.
    if (entity_get_form_display('comment', 'comment', 'default')->getComponent('subject')) {
      // Subject input allowed.
      $edit['subject[0][value]'] = $subject;
112 113
    }
    else {
114
      $this->assertNoFieldByName('subject[0][value]', '', 'Subject field not found.');
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
    }

    if ($contact !== NULL && is_array($contact)) {
      $edit += $contact;
    }
    switch ($preview_mode) {
      case DRUPAL_REQUIRED:
        // Preview required so no save button should be found.
        $this->assertNoFieldByName('op', t('Save'), 'Save button not found.');
        $this->drupalPostForm(NULL, $edit, t('Preview'));
        // Don't break here so that we can test post-preview field presence and
        // function below.
      case DRUPAL_OPTIONAL:
        $this->assertFieldByName('op', t('Preview'), 'Preview button found.');
        $this->assertFieldByName('op', t('Save'), 'Save button found.');
        $this->drupalPostForm(NULL, $edit, t('Save'));
        break;

      case DRUPAL_DISABLED:
        $this->assertNoFieldByName('op', t('Preview'), 'Preview button not found.');
        $this->assertFieldByName('op', t('Save'), 'Save button found.');
        $this->drupalPostForm(NULL, $edit, t('Save'));
        break;
    }
    $match = array();
    // Get comment ID
    preg_match('/#comment-([0-9]+)/', $this->getURL(), $match);

    // Get comment.
    if ($contact !== TRUE) { // If true then attempting to find error message.
      if ($subject) {
        $this->assertText($subject, 'Comment subject posted.');
      }
      $this->assertText($comment, 'Comment body posted.');
      $this->assertTrue((!empty($match) && !empty($match[1])), 'Comment ID found.');
    }

    if (isset($match[1])) {
      return entity_load('comment', $match[1]);
    }
  }

  /**
   * Checks current page for specified comment.
   *
   * @param \Drupal\comment\CommentInterface $comment
   *   The comment object.
   * @param boolean $reply
   *   Boolean indicating whether the comment is a reply to another comment.
   *
   * @return boolean
   *   Boolean indicating whether the comment was found.
   */
  function commentExists(CommentInterface $comment = NULL, $reply = FALSE) {
    if ($comment) {
      $regex = '/' . ($reply ? '<div class="indented">(.*?)' : '');
171 172 173
      $regex .= '<a id="comment-' . $comment->id() . '"(.*?)';
      $regex .= $comment->getSubject() . '(.*?)';
      $regex .= $comment->comment_body->value . '(.*?)';
174 175
      $regex .= '/s';

176
      return (boolean) preg_match($regex, $this->drupalGetContent());
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
    }
    else {
      return FALSE;
    }
  }

  /**
   * Checks whether the commenter's contact information is displayed.
   *
   * @return boolean
   *   Contact info is available.
   */
  function commentContactInfoAvailable() {
    return preg_match('/(input).*?(name="name").*?(input).*?(name="mail").*?(input).*?(name="homepage")/s', $this->drupalGetContent());
  }

  /**
   * Performs the specified operation on the specified comment.
   *
   * @param object $comment
   *   Comment to perform operation on.
   * @param string $operation
   *   Operation to perform.
   * @param boolean $aproval
   *   Operation is found on approval page.
   */
  function performCommentOperation($comment, $operation, $approval = FALSE) {
    $edit = array();
    $edit['operation'] = $operation;
    $edit['comments[' . $comment->id() . ']'] = TRUE;
    $this->drupalPostForm('admin/content/comment' . ($approval ? '/approval' : ''), $edit, t('Update'));

    if ($operation == 'delete') {
      $this->drupalPostForm(NULL, array(), t('Delete comments'));
211
      $this->assertRaw(\Drupal::translation()->formatPlural(1, 'Deleted 1 comment.', 'Deleted @count comments.'), format_string('Operation "@operation" was performed on comment.', array('@operation' => $operation)));
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
    }
    else {
      $this->assertText(t('The update has been performed.'), format_string('Operation "@operation" was performed on comment.', array('@operation' => $operation)));
    }
  }

  /**
   * Gets the comment ID for an unapproved comment.
   *
   * @param string $subject
   *   Comment subject to find.
   *
   * @return integer
   *   Comment ID.
   */
  function getUnapprovedComment($subject) {
    $this->drupalGet('admin/content/comment/approval');
    preg_match('/href="(.*?)#comment-([^"]+)"(.*?)>(' . $subject . ')/', $this->drupalGetContent(), $match);

    return $match[2];
  }

  /**
   * Tests anonymous comment functionality.
   */
  function testCommentFunctionality() {
    $limited_user = $this->drupalCreateUser(array(
239
      'administer entity_test fields'
240 241 242
    ));
    $this->drupalLogin($limited_user);
    // Test that default field exists.
243
    $this->drupalGet('entity_test/structure/entity_test/fields');
244
    $this->assertText(t('Comments'));
245
    $this->assertLinkByHref('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
246
    // Test widget hidden option is not visible when there's no comments.
247
    $this->drupalGet('entity_test/structure/entity_test/entity-test/fields/entity_test.entity_test.comment');
248 249
    $this->assertNoField('edit-default-value-input-comment-und-0-status-0');

250
    $this->drupalLogin($this->adminUser);
251 252

    // Post a comment.
253
    $comment1 = $this->postComment($this->entity, $this->randomMachineName(), $this->randomMachineName());
254 255 256
    $this->assertTrue($this->commentExists($comment1), 'Comment on test entity exists.');

    // Assert the breadcrumb is valid.
257
    $this->drupalGet('comment/reply/entity_test/' . $this->entity->id() . '/comment');
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
    $this->assertLink($this->entity->label());

    // Unpublish the comment.
    $this->performCommentOperation($comment1, 'unpublish');
    $this->drupalGet('admin/content/comment/approval');
    $this->assertRaw('comments[' . $comment1->id() . ']', 'Comment was unpublished.');

    // Publish the comment.
    $this->performCommentOperation($comment1, 'publish', TRUE);
    $this->drupalGet('admin/content/comment');
    $this->assertRaw('comments[' . $comment1->id() . ']', 'Comment was published.');

    // Delete the comment.
    $this->performCommentOperation($comment1, 'delete');
    $this->drupalGet('admin/content/comment');
    $this->assertNoRaw('comments[' . $comment1->id() . ']', 'Comment was deleted.');

    // Post another comment.
276
    $comment1 = $this->postComment($this->entity, $this->randomMachineName(), $this->randomMachineName());
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
    $this->assertTrue($this->commentExists($comment1), 'Comment on test entity exists.');

    // Check that the comment was found.
    $this->drupalGet('admin/content/comment');
    $this->assertRaw('comments[' . $comment1->id() . ']', 'Comment was published.');

    // Check that entity access applies to administrative page.
    $this->assertText($this->entity->label(), 'Name of commented account found.');
    $limited_user = $this->drupalCreateUser(array(
      'administer comments',
    ));
    $this->drupalLogin($limited_user);
    $this->drupalGet('admin/content/comment');
    $this->assertNoText($this->entity->label(), 'No commented account name found.');

    $this->drupalLogout();

    // Deny anonymous users access to comments.
    user_role_change_permissions(DRUPAL_ANONYMOUS_RID, array(
      'access comments' => FALSE,
      'post comments' => FALSE,
      'skip comment approval' => FALSE,
      'view test entity' => TRUE,
    ));

    // Attempt to view comments while disallowed.
303
    $this->drupalGet('entity-test/' . $this->entity->id());
304 305 306 307
    $this->assertNoPattern('@<h2[^>]*>Comments</h2>@', 'Comments were not displayed.');
    $this->assertNoLink('Add new comment', 'Link to add comment was found.');

    // Attempt to view test entity comment form while disallowed.
308
    $this->drupalGet('comment/reply/entity_test/' . $this->entity->id() . '/comment');
309
    $this->assertText('You are not authorized to post comments', 'Error attempting to post comment.');
310
    $this->assertNoFieldByName('subject[0][value]', '', 'Subject field not found.');
311 312 313 314 315 316 317 318
    $this->assertNoFieldByName('comment_body[0][value]', '', 'Comment field not found.');

    user_role_change_permissions(DRUPAL_ANONYMOUS_RID, array(
      'access comments' => TRUE,
      'post comments' => FALSE,
      'view test entity' => TRUE,
      'skip comment approval' => FALSE,
    ));
319
    $this->drupalGet('entity_test/' . $this->entity->id());
320 321 322
    $this->assertPattern('@<h2[^>]*>Comments</h2>@', 'Comments were displayed.');
    $this->assertLink('Log in', 0, 'Link to log in was found.');
    $this->assertLink('register', 0, 'Link to register was found.');
323
    $this->assertNoFieldByName('subject[0][value]', '', 'Subject field not found.');
324 325 326 327 328 329 330 331 332 333 334
    $this->assertNoFieldByName('comment_body[0][value]', '', 'Comment field not found.');

    // 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(DRUPAL_ANONYMOUS_RID, array(
      'access comments' => FALSE,
      'post comments' => TRUE,
      'skip comment approval' => TRUE,
      'view test entity' => TRUE,
    ));
335
    $this->drupalGet('entity_test/' . $this->entity->id());
336
    $this->assertNoPattern('@<h2[^>]*>Comments</h2>@', 'Comments were not displayed.');
337
    $this->assertFieldByName('subject[0][value]', '', 'Subject field found.');
338 339
    $this->assertFieldByName('comment_body[0][value]', '', 'Comment field found.');

340
    $this->drupalGet('comment/reply/entity_test/' . $this->entity->id() . '/comment/' . $comment1->id());
341
    $this->assertText('You are not authorized to view comments');
342
    $this->assertNoText($comment1->getSubject(), 'Comment not displayed.');
343 344 345

    // Test comment field widget changes.
    $limited_user = $this->drupalCreateUser(array(
346
      'administer entity_test fields',
347 348 349 350
      'view test entity',
      'administer entity_test content',
    ));
    $this->drupalLogin($limited_user);
351
    $this->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
352 353 354 355
    $this->assertNoFieldChecked('edit-default-value-input-comment-0-status-0');
    $this->assertNoFieldChecked('edit-default-value-input-comment-0-status-1');
    $this->assertFieldChecked('edit-default-value-input-comment-0-status-2');
    // Test comment option change in field settings.
356
    $edit = array('default_value_input[comment][0][status]' => CommentItemInterface::CLOSED);
357
    $this->drupalPostForm(NULL, $edit, t('Save settings'));
358
    $this->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
359 360 361 362
    $this->assertNoFieldChecked('edit-default-value-input-comment-0-status-0');
    $this->assertFieldChecked('edit-default-value-input-comment-0-status-1');
    $this->assertNoFieldChecked('edit-default-value-input-comment-0-status-2');

363 364 365 366 367 368 369 370 371
    // Add a new comment-type.
    $bundle = CommentType::create(array(
      'id' => 'foobar',
      'label' => 'Foobar',
      'description' => '',
      'target_entity_type_id' => 'entity_test',
    ));
    $bundle->save();

372
    // Add a new comment field.
373
    $storage_edit = array(
374
      'field_storage[settings][comment_type]' => 'foobar',
375 376
    );
    $this->fieldUIAddNewField('entity_test/structure/entity_test', 'foobar', 'Foobar', 'comment', $storage_edit);
377

378
    // Add a third comment field.
379
    $this->fieldUIAddNewField('entity_test/structure/entity_test', 'barfoo', 'BarFoo', 'comment', $storage_edit);
380 381

    // Check the field contains the correct comment type.
382 383 384
    $field_storage = entity_load('field_storage_config', 'entity_test.field_barfoo');
    $this->assertTrue($field_storage);
    $this->assertEqual($field_storage->getSetting('comment_type'), 'foobar');
385

386
    // Test the new entity commenting inherits default.
387
    $random_label = $this->randomMachineName();
388 389
    $data = array('bundle' => 'entity_test', 'name' => $random_label);
    $new_entity = entity_create('entity_test', $data);
390
    $new_entity->save();
391
    $this->drupalGet('entity_test/manage/' . $new_entity->id());
392 393 394 395
    $this->assertNoFieldChecked('edit-field-foobar-0-status-1');
    $this->assertFieldChecked('edit-field-foobar-0-status-2');
    $this->assertNoField('edit-field-foobar-0-status-0');

396
    $this->drupalGet('comment/reply/entity_test/comment/' . $new_entity->id());
397
    $this->assertNoFieldByName('subject[0][value]', '', 'Subject field found.');
398 399 400
    $this->assertNoFieldByName('comment_body[0][value]', '', 'Comment field found.');
  }

401
  /**
402
   * Tests comment fields cannot be added to entity types without integer IDs.
403
   */
404 405
  public function testsNonIntegerIdEntities() {
    // Create a bundle for entity_test_string_id.
406 407 408 409 410
    entity_test_create_bundle('entity_test', 'Entity Test', 'entity_test_string_id');
    $limited_user = $this->drupalCreateUser(array(
      'administer entity_test_string_id fields',
    ));
    $this->drupalLogin($limited_user);
411 412
    // Visit the Field UI field add page.
    $this->drupalGet('entity_test_string_id/structure/entity_test/fields/add-field');
413
    // Ensure field isn't shown for string IDs.
414
    $this->assertNoOption('edit-new-storage-type', 'comment');
415
    // Ensure a core field type shown.
416
    $this->assertOption('edit-new-storage-type', 'boolean');
417

418
    // Create a bundle for entity_test_no_id.
419 420 421 422
    entity_test_create_bundle('entity_test', 'Entity Test', 'entity_test_no_id');
    $this->drupalLogin($this->drupalCreateUser(array(
      'administer entity_test_no_id fields',
    )));
423 424
    // Visit the Field UI field add page.
    $this->drupalGet('entity_test_no_id/structure/entity_test/fields/add-field');
425
    // Ensure field isn't shown for empty IDs.
426
    $this->assertNoOption('edit-new-storage-type', 'comment');
427
    // Ensure a core field type shown.
428
    $this->assertOption('edit-new-storage-type', 'boolean');
429 430
  }

431
}