EntityReferenceItemTest.php 21.2 KB
Newer Older
1 2
<?php

3
namespace Drupal\Tests\field\Kernel\EntityReference;
4

5 6
use Drupal\comment\Entity\Comment;
use Drupal\Component\Render\FormattableMarkup;
7
use Drupal\Component\Utility\Unicode;
8 9
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\FieldItemInterface;
10
use Drupal\Core\Field\FieldStorageDefinitionInterface;
11
use Drupal\Core\StringTranslation\TranslatableMarkup;
12
use Drupal\Core\Language\LanguageInterface;
13 14
use Drupal\entity_test\Entity\EntityTest;
use Drupal\entity_test\Entity\EntityTestStringId;
15 16
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
17
use Drupal\field\Tests\EntityReference\EntityReferenceTestTrait;
18
use Drupal\node\NodeInterface;
19
use Drupal\Tests\field\Kernel\FieldKernelTestBase;
20 21
use Drupal\file\Entity\File;
use Drupal\node\Entity\Node;
22
use Drupal\taxonomy\Entity\Term;
23
use Drupal\taxonomy\Entity\Vocabulary;
24
use Drupal\user\Entity\User;
25

26

27 28
/**
 * Tests the new entity API for the entity reference field type.
29 30
 *
 * @group entity_reference
31
 */
32
class EntityReferenceItemTest extends FieldKernelTestBase {
33

34 35
  use EntityReferenceTestTrait;

36
  /**
37
   * Modules to install.
38 39 40
   *
   * @var array
   */
41
  public static $modules = ['node', 'comment', 'file', 'taxonomy', 'text', 'filter', 'views', 'field'];
42

43 44 45 46 47 48 49 50 51 52 53 54 55 56
  /**
   * The taxonomy vocabulary to test with.
   *
   * @var \Drupal\taxonomy\VocabularyInterface
   */
  protected $vocabulary;

  /**
   * The taxonomy term to test with.
   *
   * @var \Drupal\taxonomy\TermInterface
   */
  protected $term;

57 58 59 60 61 62 63
  /**
   * The test entity with a string ID.
   *
   * @var \Drupal\entity_test\Entity\EntityTestStringId
   */
  protected $entityStringId;

64 65 66
  /**
   * Sets up the test.
   */
67
  protected function setUp() {
68 69
    parent::setUp();

70
    $this->installEntitySchema('entity_test_string_id');
71
    $this->installEntitySchema('taxonomy_term');
72 73 74 75 76
    $this->installEntitySchema('node');
    $this->installEntitySchema('comment');
    $this->installEntitySchema('file');

    $this->installSchema('comment', ['comment_entity_statistics']);
77
    $this->installSchema('node', ['node_access']);
78

79
    $this->vocabulary = Vocabulary::create([
80
      'name' => $this->randomMachineName(),
81
      'vid' => Unicode::strtolower($this->randomMachineName()),
82
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
83
    ]);
84
    $this->vocabulary->save();
85

86
    $this->term = Term::create([
87
      'name' => $this->randomMachineName(),
88
      'vid' => $this->vocabulary->id(),
89
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
90
    ]);
91 92
    $this->term->save();

93 94 95 96 97
    $this->entityStringId = EntityTestStringId::create([
      'id' => $this->randomMachineName(),
    ]);
    $this->entityStringId->save();

98
    // Use the util to create an instance.
99
    $this->createEntityReferenceField('entity_test', 'entity_test', 'field_test_taxonomy_term', 'Test content entity reference', 'taxonomy_term');
100
    $this->createEntityReferenceField('entity_test', 'entity_test', 'field_test_entity_test_string_id', 'Test content entity reference with string ID', 'entity_test_string_id');
101
    $this->createEntityReferenceField('entity_test', 'entity_test', 'field_test_taxonomy_vocabulary', 'Test config entity reference', 'taxonomy_vocabulary');
102
    $this->createEntityReferenceField('entity_test', 'entity_test', 'field_test_node', 'Test node entity reference', 'node', 'default', [], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
103 104 105
    $this->createEntityReferenceField('entity_test', 'entity_test', 'field_test_user', 'Test user entity reference', 'user');
    $this->createEntityReferenceField('entity_test', 'entity_test', 'field_test_comment', 'Test comment entity reference', 'comment');
    $this->createEntityReferenceField('entity_test', 'entity_test', 'field_test_file', 'Test file entity reference', 'file');
106 107 108
  }

  /**
109
   * Tests the entity reference field type for referencing content entities.
110
   */
111
  public function testContentEntityReferenceItem() {
112
    $tid = $this->term->id();
113 114

    // Just being able to create the entity like this verifies a lot of code.
115
    $entity = EntityTest::create();
116
    $entity->field_test_taxonomy_term->target_id = $tid;
117
    $entity->name->value = $this->randomMachineName();
118 119
    $entity->save();

120
    $entity = EntityTest::load($entity->id());
121 122 123
    $this->assertTrue($entity->field_test_taxonomy_term instanceof FieldItemListInterface, 'Field implements interface.');
    $this->assertTrue($entity->field_test_taxonomy_term[0] instanceof FieldItemInterface, 'Field item implements interface.');
    $this->assertEqual($entity->field_test_taxonomy_term->target_id, $tid);
124
    $this->assertEqual($entity->field_test_taxonomy_term->entity->getName(), $this->term->getName());
125 126
    $this->assertEqual($entity->field_test_taxonomy_term->entity->id(), $tid);
    $this->assertEqual($entity->field_test_taxonomy_term->entity->uuid(), $this->term->uuid());
127 128
    // Verify that the label for the target ID property definition is correct.
    $label = $entity->field_test_taxonomy_term->getFieldDefinition()->getFieldStorageDefinition()->getPropertyDefinition('target_id')->getLabel();
129
    $this->assertTrue($label instanceof TranslatableMarkup);
130
    $this->assertEqual($label->render(), 'Taxonomy term ID');
131 132

    // Change the name of the term via the reference.
133
    $new_name = $this->randomMachineName();
134
    $entity->field_test_taxonomy_term->entity->setName($new_name);
135
    $entity->field_test_taxonomy_term->entity->save();
136
    // Verify it is the correct name.
137
    $term = Term::load($tid);
138
    $this->assertEqual($term->getName(), $new_name);
139

140
    // Make sure the computed term reflects updates to the term id.
141
    $term2 = Term::create([
142
      'name' => $this->randomMachineName(),
143
      'vid' => $this->term->bundle(),
144
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
145
    ]);
146
    $term2->save();
147

148 149 150 151 152 153
    // Test all the possible ways of assigning a value.
    $entity->field_test_taxonomy_term->target_id = $term->id();
    $this->assertEqual($entity->field_test_taxonomy_term->entity->id(), $term->id());
    $this->assertEqual($entity->field_test_taxonomy_term->entity->getName(), $term->getName());

    $entity->field_test_taxonomy_term = [['target_id' => $term2->id()]];
154
    $this->assertEqual($entity->field_test_taxonomy_term->entity->id(), $term2->id());
155
    $this->assertEqual($entity->field_test_taxonomy_term->entity->getName(), $term2->getName());
156

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
    // Test value assignment via the computed 'entity' property.
    $entity->field_test_taxonomy_term->entity = $term;
    $this->assertEqual($entity->field_test_taxonomy_term->target_id, $term->id());
    $this->assertEqual($entity->field_test_taxonomy_term->entity->getName(), $term->getName());

    $entity->field_test_taxonomy_term = [['entity' => $term2]];
    $this->assertEqual($entity->field_test_taxonomy_term->target_id, $term2->id());
    $this->assertEqual($entity->field_test_taxonomy_term->entity->getName(), $term2->getName());

    // Test assigning an invalid item throws an exception.
    try {
      $entity->field_test_taxonomy_term = ['target_id' => 'invalid', 'entity' => $term2];
      $this->fail('Assigning an invalid item throws an exception.');
    }
    catch (\InvalidArgumentException $e) {
      $this->pass('Assigning an invalid item throws an exception.');
    }

175 176 177
    // Delete terms so we have nothing to reference and try again
    $term->delete();
    $term2->delete();
178
    $entity = EntityTest::create(array('name' => $this->randomMachineName()));
179
    $entity->save();
180 181

    // Test the generateSampleValue() method.
182
    $entity = EntityTest::create();
183 184 185
    $entity->field_test_taxonomy_term->generateSampleItems();
    $entity->field_test_taxonomy_vocabulary->generateSampleItems();
    $this->entityValidateAndSave($entity);
186
  }
187

188 189 190 191 192 193 194 195 196 197
  /**
   * Tests referencing content entities with string IDs.
   */
  public function testContentEntityReferenceItemWithStringId() {
    $entity = EntityTest::create();
    $entity->field_test_entity_test_string_id->target_id = $this->entityStringId->id();
    $entity->save();
    $storage = \Drupal::entityManager()->getStorage('entity_test');
    $storage->resetCache();
    $this->assertEqual($this->entityStringId->id(), $storage->load($entity->id())->field_test_entity_test_string_id->target_id);
198 199
    // Verify that the label for the target ID property definition is correct.
    $label = $entity->field_test_taxonomy_term->getFieldDefinition()->getFieldStorageDefinition()->getPropertyDefinition('target_id')->getLabel();
200
    $this->assertTrue($label instanceof TranslatableMarkup);
201
    $this->assertEqual($label->render(), 'Taxonomy term ID');
202 203
  }

204
  /**
205
   * Tests the entity reference field type for referencing config entities.
206
   */
207 208 209 210
  public function testConfigEntityReferenceItem() {
    $referenced_entity_id = $this->vocabulary->id();

    // Just being able to create the entity like this verifies a lot of code.
211
    $entity = EntityTest::create();
212
    $entity->field_test_taxonomy_vocabulary->target_id = $referenced_entity_id;
213
    $entity->name->value = $this->randomMachineName();
214 215
    $entity->save();

216
    $entity = EntityTest::load($entity->id());
217 218 219
    $this->assertTrue($entity->field_test_taxonomy_vocabulary instanceof FieldItemListInterface, 'Field implements interface.');
    $this->assertTrue($entity->field_test_taxonomy_vocabulary[0] instanceof FieldItemInterface, 'Field item implements interface.');
    $this->assertEqual($entity->field_test_taxonomy_vocabulary->target_id, $referenced_entity_id);
220
    $this->assertEqual($entity->field_test_taxonomy_vocabulary->entity->label(), $this->vocabulary->label());
221 222 223 224
    $this->assertEqual($entity->field_test_taxonomy_vocabulary->entity->id(), $referenced_entity_id);
    $this->assertEqual($entity->field_test_taxonomy_vocabulary->entity->uuid(), $this->vocabulary->uuid());

    // Change the name of the term via the reference.
225
    $new_name = $this->randomMachineName();
226
    $entity->field_test_taxonomy_vocabulary->entity->set('name', $new_name);
227 228
    $entity->field_test_taxonomy_vocabulary->entity->save();
    // Verify it is the correct name.
229
    $vocabulary = Vocabulary::load($referenced_entity_id);
230
    $this->assertEqual($vocabulary->label(), $new_name);
231 232

    // Make sure the computed term reflects updates to the term id.
233
    $vocabulary2 = $vocabulary = Vocabulary::create([
234
      'name' => $this->randomMachineName(),
235
      'vid' => Unicode::strtolower($this->randomMachineName()),
236
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
237
    ]);
238 239 240 241
    $vocabulary2->save();

    $entity->field_test_taxonomy_vocabulary->target_id = $vocabulary2->id();
    $this->assertEqual($entity->field_test_taxonomy_vocabulary->entity->id(), $vocabulary2->id());
242
    $this->assertEqual($entity->field_test_taxonomy_vocabulary->entity->label(), $vocabulary2->label());
243 244 245 246

    // Delete terms so we have nothing to reference and try again
    $this->vocabulary->delete();
    $vocabulary2->delete();
247
    $entity = EntityTest::create(array('name' => $this->randomMachineName()));
248
    $entity->save();
249
  }
250

251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
  /**
   * Tests entity auto create.
   */
  public function testEntityAutoCreate() {
    // The term entity is unsaved here.
    $term = Term::create(array(
      'name' => $this->randomMachineName(),
      'vid' => $this->term->bundle(),
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ));
    $entity = EntityTest::create();
    // Now assign the unsaved term to the field.
    $entity->field_test_taxonomy_term->entity = $term;
    $entity->name->value = $this->randomMachineName();
    // This is equal to storing an entity to tempstore or cache and retrieving
    // it back. An example for this is node preview.
    $entity = serialize($entity);
    $entity = unserialize($entity);
    // And then the entity.
    $entity->save();
    $term = \Drupal::entityManager()->loadEntityByUuid($term->getEntityTypeId(), $term->uuid());
    $this->assertEqual($entity->field_test_taxonomy_term->entity->id(), $term->id());
  }

275 276 277 278 279
  /**
   * Test saving order sequence doesn't matter.
   */
  public function testEntitySaveOrder() {
    // The term entity is unsaved here.
280
    $term = Term::create([
281 282 283
      'name' => $this->randomMachineName(),
      'vid' => $this->term->bundle(),
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
284
    ]);
285
    $entity = EntityTest::create();
286 287 288
    // Now assign the unsaved term to the field.
    $entity->field_test_taxonomy_term->entity = $term;
    $entity->name->value = $this->randomMachineName();
289 290 291 292 293 294
    // Now get the field value.
    $value = $entity->get('field_test_taxonomy_term');
    $this->assertTrue(empty($value['target_id']));
    $this->assertNull($entity->field_test_taxonomy_term->target_id);
    // And then set it.
    $entity->field_test_taxonomy_term = $value;
295 296 297 298 299 300 301
    // Now save the term.
    $term->save();
    // And then the entity.
    $entity->save();
    $this->assertEqual($entity->field_test_taxonomy_term->entity->id(), $term->id());
  }

302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
  /**
   * Tests that the 'handler' field setting stores the proper plugin ID.
   */
  public function testSelectionHandlerSettings() {
    $field_name = Unicode::strtolower($this->randomMachineName());
    $field_storage = FieldStorageConfig::create(array(
      'field_name' => $field_name,
      'entity_type' => 'entity_test',
      'type' => 'entity_reference',
      'settings' => array(
        'target_type' => 'entity_test'
      ),
    ));
    $field_storage->save();

    // Do not specify any value for the 'handler' setting in order to verify
318
    // that the default handler with the correct derivative is used.
319 320 321 322 323
    $field = FieldConfig::create(array(
      'field_storage' => $field_storage,
      'bundle' => 'entity_test',
    ));
    $field->save();
324 325
    $field = FieldConfig::load($field->id());
    $this->assertEqual($field->getSetting('handler'), 'default:entity_test');
326

327 328 329 330
    // Change the target_type in the field storage, and check that the handler
    // was correctly reassigned in the field.
    $field_storage->setSetting('target_type', 'entity_test_rev');
    $field_storage->save();
331
    $field = FieldConfig::load($field->id());
332
    $this->assertEqual($field->getSetting('handler'), 'default:entity_test_rev');
333

334
    // Change the handler to another, non-derivative plugin.
335
    $field->setSetting('handler', 'views');
336 337
    $field->save();
    $field = FieldConfig::load($field->id());
338 339 340 341 342 343 344 345
    $this->assertEqual($field->getSetting('handler'), 'views');

    // Change the target_type in the field storage again, and check that the
    // non-derivative handler was unchanged.
    $field_storage->setSetting('target_type', 'entity_test_rev');
    $field_storage->save();
    $field = FieldConfig::load($field->id());
    $this->assertEqual($field->getSetting('handler'), 'views');
346 347
  }

348
  /**
349
   * Tests ValidReferenceConstraint with newly created and unsaved entities.
350
   */
351
  public function testAutocreateValidation() {
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
    // The term entity is unsaved here.
    $term = Term::create(array(
      'name' => $this->randomMachineName(),
      'vid' => $this->term->bundle(),
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ));
    $entity = EntityTest::create([
      'field_test_taxonomy_term' => [
        'entity' => $term,
        'target_id' => NULL,
      ],
    ]);
    $errors = $entity->validate();
    // Using target_id of NULL is valid with an unsaved entity.
    $this->assertEqual(0, count($errors));
    // Using target_id of NULL is not valid with a saved entity.
    $term->save();
    $entity = EntityTest::create([
      'field_test_taxonomy_term' => [
        'entity' => $term,
        'target_id' => NULL,
      ],
    ]);
    $errors = $entity->validate();
    $this->assertEqual(1, count($errors));
    $this->assertEqual($errors[0]->getMessage(), 'This value should not be null.');
    $this->assertEqual($errors[0]->getPropertyPath(), 'field_test_taxonomy_term.0');
    // This should rectify the issue, favoring the entity over the target_id.
    $entity->save();
    $errors = $entity->validate();
    $this->assertEqual(0, count($errors));
383 384 385 386 387 388

    // Test with an unpublished and unsaved node.
    $title = $this->randomString();
    $node = Node::create([
      'title' => $title,
      'type' => 'node',
389
      'status' => NodeInterface::NOT_PUBLISHED,
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
    ]);

    $entity = EntityTest::create([
      'field_test_node' => [
        'entity' => $node,
      ],
    ]);

    $errors = $entity->validate();
    $this->assertEqual(1, count($errors));
    $this->assertEqual($errors[0]->getMessage(), new FormattableMarkup('This entity (%type: %label) cannot be referenced.', ['%type' => 'node', '%label' => $title]));
    $this->assertEqual($errors[0]->getPropertyPath(), 'field_test_node.0.entity');

    // Publish the node and try again.
    $node->setPublished(TRUE);
    $errors = $entity->validate();
    $this->assertEqual(0, count($errors));

408 409 410 411 412
    // Test with a mix of valid and invalid nodes.
    $unsaved_unpublished_node_title = $this->randomString();
    $unsaved_unpublished_node = Node::create([
      'title' => $unsaved_unpublished_node_title,
      'type' => 'node',
413
      'status' => NodeInterface::NOT_PUBLISHED,
414 415 416 417 418 419
    ]);

    $saved_unpublished_node_title = $this->randomString();
    $saved_unpublished_node = Node::create([
      'title' => $saved_unpublished_node_title,
      'type' => 'node',
420
      'status' => NodeInterface::NOT_PUBLISHED,
421 422 423 424 425 426 427
    ]);
    $saved_unpublished_node->save();

    $saved_published_node_title = $this->randomString();
    $saved_published_node = Node::create([
      'title' => $saved_published_node_title,
      'type' => 'node',
428
      'status' => NodeInterface::PUBLISHED,
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
    ]);
    $saved_published_node->save();

    $entity = EntityTest::create([
      'field_test_node' => [
        [
          'entity' => $unsaved_unpublished_node,
        ],
        [
          'target_id' => $saved_unpublished_node->id(),
        ],
        [
          'target_id' => $saved_published_node->id(),
        ],
      ],
    ]);

    $errors = $entity->validate();
    $this->assertEqual(2, count($errors));
    $this->assertEqual($errors[0]->getMessage(), new FormattableMarkup('This entity (%type: %label) cannot be referenced.', ['%type' => 'node', '%label' => $unsaved_unpublished_node_title]));
    $this->assertEqual($errors[0]->getPropertyPath(), 'field_test_node.0.entity');
    $this->assertEqual($errors[1]->getMessage(), new FormattableMarkup('This entity (%type: %label) cannot be referenced.', ['%type' => 'node', '%label' => $saved_unpublished_node->id()]));
    $this->assertEqual($errors[1]->getPropertyPath(), 'field_test_node.1.target_id');

    // Publish one of the nodes and try again.
    $saved_unpublished_node->setPublished(TRUE);
    $saved_unpublished_node->save();
    $errors = $entity->validate();
    $this->assertEqual(1, count($errors));
    $this->assertEqual($errors[0]->getMessage(), new FormattableMarkup('This entity (%type: %label) cannot be referenced.', ['%type' => 'node', '%label' => $unsaved_unpublished_node_title]));
    $this->assertEqual($errors[0]->getPropertyPath(), 'field_test_node.0.entity');

    // Publish the last invalid node and try again.
    $unsaved_unpublished_node->setPublished(TRUE);
    $errors = $entity->validate();
    $this->assertEqual(0, count($errors));

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
    // Test with an unpublished and unsaved comment.
    $title = $this->randomString();
    $comment = Comment::create([
      'subject' => $title,
      'comment_type' => 'comment',
      'status' => 0,
    ]);

    $entity = EntityTest::create([
      'field_test_comment' => [
        'entity' => $comment,
      ],
    ]);

    $errors = $entity->validate();
    $this->assertEqual(1, count($errors));
    $this->assertEqual($errors[0]->getMessage(), new FormattableMarkup('This entity (%type: %label) cannot be referenced.', ['%type' => 'comment', '%label' => $title]));
    $this->assertEqual($errors[0]->getPropertyPath(), 'field_test_comment.0.entity');

    // Publish the comment and try again.
    $comment->setPublished(TRUE);
    $errors = $entity->validate();
    $this->assertEqual(0, count($errors));

    // Test with an inactive and unsaved user.
    $name = $this->randomString();
    $user = User::create([
      'name' => $name,
      'status' => 0,
    ]);

    $entity = EntityTest::create([
      'field_test_user' => [
        'entity' => $user,
      ],
    ]);

    $errors = $entity->validate();
    $this->assertEqual(1, count($errors));
    $this->assertEqual($errors[0]->getMessage(), new FormattableMarkup('This entity (%type: %label) cannot be referenced.', ['%type' => 'user', '%label' => $name]));
    $this->assertEqual($errors[0]->getPropertyPath(), 'field_test_user.0.entity');

    // Activate the user and try again.
    $user->activate();
    $errors = $entity->validate();
    $this->assertEqual(0, count($errors));

    // Test with a temporary and unsaved file.
    $filename = $this->randomMachineName() . '.txt';
    $file = File::create([
      'filename' => $filename,
      'status' => 0,
    ]);

    $entity = EntityTest::create([
      'field_test_file' => [
        'entity' => $file,
      ],
    ]);

    $errors = $entity->validate();
    $this->assertEqual(1, count($errors));
    $this->assertEqual($errors[0]->getMessage(), new FormattableMarkup('This entity (%type: %label) cannot be referenced.', ['%type' => 'file', '%label' => $filename]));
    $this->assertEqual($errors[0]->getPropertyPath(), 'field_test_file.0.entity');

    // Set the file as permanent and try again.
    $file->setPermanent();
    $errors = $entity->validate();
    $this->assertEqual(0, count($errors));
535 536
  }

537
}