CommentNonNodeTest.php 17.2 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\FieldInstanceConfig;
14
15
16
17
use Drupal\simpletest\WebTestBase;
use Drupal\Core\Entity\EntityInterface;

/**
18
 * Tests basic comment functionality against the entity_test entity type.
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 */
class CommentNonNodeTest extends WebTestBase {

  public static $modules = array('comment', 'user', 'field_ui', 'entity_test');

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

  public static function getInfo() {
    return array(
      'name' => 'Comment non-node tests',
      'description' => 'Test commenting on a test entity.',
      'group' => 'Comment',
    );
  }

  function setUp() {
    parent::setUp();

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

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

57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
    // Create test user.
    $this->admin_user = $this->drupalCreateUser(array(
      '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.
    $random_label = $this->randomName();
81
82
    $data = array('type' => 'entity_test', 'name' => $random_label);
    $this->entity = entity_create('entity_test', $data);
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
    $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;

103
    $instance = FieldInstanceConfig::loadByName('entity_test', 'entity_test', 'comment');
104
105
    $preview_mode = $instance->getSetting('preview');
    $subject_mode = $instance->getSetting('subject');
106
107
108

    // Must get the page before we test for fields.
    if ($entity !== NULL) {
109
      $this->drupalGet('comment/reply/entity_test/' . $entity->id() . '/comment');
110
111
112
113
114
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
171
172
    }

    if ($subject_mode == TRUE) {
      $edit['subject'] = $subject;
    }
    else {
      $this->assertNoFieldByName('subject', '', 'Subject field not found.');
    }

    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">(.*?)' : '');
173
174
175
      $regex .= '<a id="comment-' . $comment->id() . '"(.*?)';
      $regex .= $comment->getSubject() . '(.*?)';
      $regex .= $comment->comment_body->value . '(.*?)';
176
177
      $regex .= '/s';

178
      return (boolean) preg_match($regex, $this->drupalGetContent());
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
211
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
239
240
    }
    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'));
      $this->assertRaw(format_plural(1, 'Deleted 1 comment.', 'Deleted @count comments.'), format_string('Operation "@operation" was performed on comment.', array('@operation' => $operation)));
    }
    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(
241
      'administer entity_test fields'
242
243
244
    ));
    $this->drupalLogin($limited_user);
    // Test that default field exists.
245
    $this->drupalGet('entity_test/structure/entity_test/fields');
246
    $this->assertText(t('Comment settings'));
247
    $this->assertLinkByHref('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
248
    // Test widget hidden option is not visible when there's no comments.
249
    $this->drupalGet('entity_test/structure/entity_test/entity-test/fields/entity_test.entity_test.comment');
250
251
252
253
254
255
256
257
258
    $this->assertNoField('edit-default-value-input-comment-und-0-status-0');

    $this->drupalLogin($this->admin_user);

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

    // Assert the breadcrumb is valid.
259
    $this->drupalGet('comment/reply/entity_test/' . $this->entity->id() . '/comment');
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
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
303
304
    $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.
    $comment1 = $this->postComment($this->entity, $this->randomName(), $this->randomName());
    $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.
305
    $this->drupalGet('entity-test/' . $this->entity->id());
306
307
308
309
    $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.
310
    $this->drupalGet('comment/reply/entity_test/' . $this->entity->id() . '/comment');
311
312
313
314
315
316
317
318
319
320
    $this->assertText('You are not authorized to post comments', 'Error attempting to post comment.');
    $this->assertNoFieldByName('subject', '', 'Subject field not found.');
    $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,
    ));
321
    $this->drupalGet('entity_test/' . $this->entity->id());
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
    $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.');
    $this->assertNoFieldByName('subject', '', 'Subject field not found.');
    $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,
    ));
337
    $this->drupalGet('entity_test/' . $this->entity->id());
338
339
340
341
    $this->assertNoPattern('@<h2[^>]*>Comments</h2>@', 'Comments were not displayed.');
    $this->assertFieldByName('subject', '', 'Subject field found.');
    $this->assertFieldByName('comment_body[0][value]', '', 'Comment field found.');

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

    // Test comment field widget changes.
    $limited_user = $this->drupalCreateUser(array(
348
      'administer entity_test fields',
349
350
351
352
      'view test entity',
      'administer entity_test content',
    ));
    $this->drupalLogin($limited_user);
353
    $this->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
354
355
356
357
    $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.
358
    $edit = array('default_value_input[comment][0][status]' => CommentItemInterface::CLOSED);
359
    $this->drupalPostForm(NULL, $edit, t('Save settings'));
360
    $this->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.comment');
361
362
363
364
    $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');

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

374
    // Add a new comment field.
375
    $this->drupalGet('entity_test/structure/entity_test/fields');
376
377
378
379
380
381
    $edit = array(
      'fields[_add_new_field][label]' => 'Foobar',
      'fields[_add_new_field][field_name]' => 'foobar',
      'fields[_add_new_field][type]' => 'comment',
    );
    $this->drupalPostForm(NULL, $edit, t('Save'));
382
383
384
385
    $this->drupalPostForm(NULL, array(
      'field[settings][comment_type]' => 'foobar',
    ), t('Save field settings'));

386
387
388
    $this->drupalPostForm(NULL, array(), t('Save settings'));
    $this->assertRaw(t('Saved %name configuration', array('%name' => 'Foobar')));

389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
    // Add a third comment field.
    $this->drupalGet('entity_test/structure/entity_test/fields');
    $edit = array(
      'fields[_add_new_field][label]' => 'Barfoo',
      'fields[_add_new_field][field_name]' => 'barfoo',
      'fields[_add_new_field][type]' => 'comment',
    );
    $this->drupalPostForm(NULL, $edit, t('Save'));
    // Re-use another comment type.
    $this->drupalPostForm(NULL, array(
      'field[settings][comment_type]' => 'foobar',
    ), t('Save field settings'));
    $this->drupalPostForm(NULL, array(), t('Save settings'));
    $this->assertRaw(t('Saved %name configuration', array('%name' => 'Barfoo')));

    // Check the field contains the correct comment type.
    $field = entity_load('field_config', 'entity_test.field_barfoo');
    $this->assertTrue($field);
    $this->assertEqual($field->getSetting('comment_type'), 'foobar');

409
410
    // Test the new entity commenting inherits default.
    $random_label = $this->randomName();
411
412
    $data = array('bundle' => 'entity_test', 'name' => $random_label);
    $new_entity = entity_create('entity_test', $data);
413
    $new_entity->save();
414
    $this->drupalGet('entity_test/manage/' . $new_entity->id());
415
416
417
418
    $this->assertNoFieldChecked('edit-field-foobar-0-status-1');
    $this->assertFieldChecked('edit-field-foobar-0-status-2');
    $this->assertNoField('edit-field-foobar-0-status-0');

419
    $this->drupalGet('comment/reply/entity_test/comment/' . $new_entity->id());
420
421
422
423
    $this->assertNoFieldByName('subject', '', 'Subject field found.');
    $this->assertNoFieldByName('comment_body[0][value]', '', 'Comment field found.');
  }

424
  /**
425
   * Tests comment fields cannot be added to entity types without integer IDs.
426
   */
427
428
  public function testsNonIntegerIdEntities() {
    // Create a bundle for entity_test_string_id.
429
430
431
432
433
434
435
    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);
    // Visit the Field UI overview.
    $this->drupalGet('entity_test_string_id/structure/entity_test/fields');
436
    // Ensure field isn't shown for string IDs.
437
438
    $this->assertNoOption('edit-fields-add-new-field-type', 'comment');

439
    // Create a bundle for entity_test_no_id.
440
441
442
443
444
445
    entity_test_create_bundle('entity_test', 'Entity Test', 'entity_test_no_id');
    $this->drupalLogin($this->drupalCreateUser(array(
      'administer entity_test_no_id fields',
    )));
    // Visit the Field UI overview.
    $this->drupalGet('entity_test_no_id/structure/entity_test/fields');
446
    // Ensure field isn't shown for empty IDs.
447
448
449
    $this->assertNoOption('edit-fields-add-new-field-type', 'comment');
  }

450
}