EntityReferenceItemTest.php 21.1 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 18
use Drupal\field\Tests\EntityReference\EntityReferenceTestTrait;
use Drupal\Tests\field\Kernel\FieldKernelTestBase;
19 20
use Drupal\file\Entity\File;
use Drupal\node\Entity\Node;
21
use Drupal\taxonomy\Entity\Term;
22
use Drupal\taxonomy\Entity\Vocabulary;
23
use Drupal\user\Entity\User;
24

25

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

33 34
  use EntityReferenceTestTrait;

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

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

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

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

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

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

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

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

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

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

97
    // Use the util to create an instance.
98
    $this->createEntityReferenceField('entity_test', 'entity_test', 'field_test_taxonomy_term', 'Test content entity reference', 'taxonomy_term');
99
    $this->createEntityReferenceField('entity_test', 'entity_test', 'field_test_entity_test_string_id', 'Test content entity reference with string ID', 'entity_test_string_id');
100
    $this->createEntityReferenceField('entity_test', 'entity_test', 'field_test_taxonomy_vocabulary', 'Test config entity reference', 'taxonomy_vocabulary');
101
    $this->createEntityReferenceField('entity_test', 'entity_test', 'field_test_node', 'Test node entity reference', 'node', 'default', [], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
102 103 104
    $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');
105 106 107
  }

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

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

119
    $entity = entity_load('entity_test', $entity->id());
120 121 122
    $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);
123
    $this->assertEqual($entity->field_test_taxonomy_term->entity->getName(), $this->term->getName());
124 125
    $this->assertEqual($entity->field_test_taxonomy_term->entity->id(), $tid);
    $this->assertEqual($entity->field_test_taxonomy_term->entity->uuid(), $this->term->uuid());
126 127
    // Verify that the label for the target ID property definition is correct.
    $label = $entity->field_test_taxonomy_term->getFieldDefinition()->getFieldStorageDefinition()->getPropertyDefinition('target_id')->getLabel();
128
    $this->assertTrue($label instanceof TranslatableMarkup);
129
    $this->assertEqual($label->render(), 'Taxonomy term ID');
130 131

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

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

147 148 149 150 151 152
    // 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()]];
153
    $this->assertEqual($entity->field_test_taxonomy_term->entity->id(), $term2->id());
154
    $this->assertEqual($entity->field_test_taxonomy_term->entity->getName(), $term2->getName());
155

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
    // 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.');
    }

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

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

187 188 189 190 191 192 193 194 195 196
  /**
   * 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);
197 198
    // Verify that the label for the target ID property definition is correct.
    $label = $entity->field_test_taxonomy_term->getFieldDefinition()->getFieldStorageDefinition()->getPropertyDefinition('target_id')->getLabel();
199
    $this->assertTrue($label instanceof TranslatableMarkup);
200
    $this->assertEqual($label->render(), 'Taxonomy term ID');
201 202
  }

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

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

    $entity = entity_load('entity_test', $entity->id());
    $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);
219
    $this->assertEqual($entity->field_test_taxonomy_vocabulary->entity->label(), $this->vocabulary->label());
220 221 222 223
    $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.
224
    $new_name = $this->randomMachineName();
225
    $entity->field_test_taxonomy_vocabulary->entity->set('name', $new_name);
226 227
    $entity->field_test_taxonomy_vocabulary->entity->save();
    // Verify it is the correct name.
228
    $vocabulary = Vocabulary::load($referenced_entity_id);
229
    $this->assertEqual($vocabulary->label(), $new_name);
230 231

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

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

    // Delete terms so we have nothing to reference and try again
    $this->vocabulary->delete();
    $vocabulary2->delete();
246
    $entity = EntityTest::create(array('name' => $this->randomMachineName()));
247
    $entity->save();
248
  }
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
  /**
   * 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());
  }

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

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
  /**
   * 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
317
    // that the default handler with the correct derivative is used.
318 319 320 321 322
    $field = FieldConfig::create(array(
      'field_storage' => $field_storage,
      'bundle' => 'entity_test',
    ));
    $field->save();
323 324
    $field = FieldConfig::load($field->id());
    $this->assertEqual($field->getSetting('handler'), 'default:entity_test');
325

326 327 328 329
    // 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();
330
    $field = FieldConfig::load($field->id());
331
    $this->assertEqual($field->getSetting('handler'), 'default:entity_test_rev');
332

333
    // Change the handler to another, non-derivative plugin.
334
    $field->setSetting('handler', 'views');
335 336
    $field->save();
    $field = FieldConfig::load($field->id());
337 338 339 340 341 342 343 344
    $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');
345 346
  }

347
  /**
348
   * Tests ValidReferenceConstraint with newly created and unsaved entities.
349
   */
350
  public function testAutocreateValidation() {
351 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
    // 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));
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406

    // Test with an unpublished and unsaved node.
    $title = $this->randomString();
    $node = Node::create([
      'title' => $title,
      'type' => 'node',
      'status' => NODE_NOT_PUBLISHED,
    ]);

    $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));

407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 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
    // 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',
      'status' => NODE_NOT_PUBLISHED,
    ]);

    $saved_unpublished_node_title = $this->randomString();
    $saved_unpublished_node = Node::create([
      'title' => $saved_unpublished_node_title,
      'type' => 'node',
      'status' => NODE_NOT_PUBLISHED,
    ]);
    $saved_unpublished_node->save();

    $saved_published_node_title = $this->randomString();
    $saved_published_node = Node::create([
      'title' => $saved_published_node_title,
      'type' => 'node',
      'status' => NODE_PUBLISHED,
    ]);
    $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));

465 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
    // 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));
534 535
  }

536
}