public function DynamicEntityReferenceTest::testDynamicEntityReference in Dynamic Entity Reference 8

Same name and namespace in other branches

1. 8.2 tests/src/Functional/DynamicEntityReferenceTest.php \Drupal\Tests\dynamic_entity_reference\Functional\DynamicEntityReferenceTest::testDynamicEntityReference()

Tests adding and editing values using dynamic entity reference.

File

tests/src/Functional/DynamicEntityReferenceTest.php, line 197

Class

DynamicEntityReferenceTest

Ensures that Dynamic Entity References field works correctly.

Namespace

Drupal\Tests\dynamic_entity_reference\Functional

Code

public function testDynamicEntityReference() {
  $assert_session = $this
    ->assertSession();

  // Add EntityTestBundle for EntityTestWithBundle.
  EntityTestBundle::create([
    'id' => 'test',
    'label' => 'Test label',
    'description' => 'My test description',
  ])
    ->save();
  $this
    ->drupalLogin($this->adminUser);

  // Add a new dynamic entity reference field.
  $this
    ->drupalGet('entity_test/structure/entity_test/fields/add-field');
  $edit = [
    'label' => 'Foobar',
    'field_name' => 'foobar',
    'new_storage_type' => 'dynamic_entity_reference',
  ];
  $this
    ->submitForm($edit, t('Save and continue'));
  $assert_session
    ->optionNotExists('settings[entity_type_ids][]', 'settings[entity_test_no_id][handler_settings][target_bundles][entity_test_no_id]');
  $assert_session
    ->optionNotExists('settings[entity_type_ids][]', 'settings[entity_test_no_id][handler_settings][target_bundles][entity_test_string_id]');
  $this
    ->submitForm([
    'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
  ], t('Save field settings'));
  $assert_session
    ->fieldNotExists('settings[entity_test_no_id][handler_settings][target_bundles][entity_test_no_id]');
  $assert_session
    ->fieldNotExists('settings[entity_test_string_id][handler_settings][target_bundles][entity_test_string_id]');
  $labels = $this->container
    ->get('entity_type.repository')
    ->getEntityTypeLabels(TRUE);
  $edit = [];
  $excluded_entity_type_ids = [
    'user',
    'file',
    'path_alias',
    'entity_test_no_id',
    'entity_test_no_bundle',
    'entity_test_string_id',
    'entity_test_computed_field',
    'entity_test_map_field',
    'entity_test_no_bundle_with_label',
  ];
  foreach ($labels[(string) t('Content', [], [
    'context' => 'Entity type group',
  ])] as $entity_type_id => $entity_type_label) {
    if (!in_array($entity_type_id, $excluded_entity_type_ids)) {
      if ($entity_type_id !== 'entity_test_with_bundle') {
        $edit["settings[{$entity_type_id}][handler_settings][target_bundles][{$entity_type_id}]"] = TRUE;
      }
      else {
        $edit['settings[entity_test_with_bundle][handler_settings][target_bundles][test]'] = TRUE;
      }
    }
  }
  $this
    ->submitForm($edit, t('Save settings'));
  $assert_session
    ->responseContains(t('Saved %name configuration', [
    '%name' => 'Foobar',
  ]));
  \Drupal::service('entity_field.manager')
    ->clearCachedFieldDefinitions();

  // Create some items to reference.
  $item1 = EntityTest::create([
    'name' => 'item1',
  ]);
  $item1
    ->save();
  $item2 = EntityTest::create([
    'name' => 'item2',
  ]);
  $item2
    ->save();

  // Test the new entity commenting inherits default.
  $this
    ->drupalGet('entity_test/add');
  $assert_session
    ->fieldExists('field_foobar[0][target_id]');
  $assert_session
    ->fieldExists('field_foobar[0][target_type]');

  // Ensure that the autocomplete path is correct.
  $input = $assert_session
    ->fieldExists('field_foobar[0][target_id]');
  $settings = FieldConfig::loadByName('entity_test', 'entity_test', 'field_foobar')
    ->getSettings();
  $selection_settings = $settings['entity_test_computed_field']['handler_settings'] ?: [];
  $selection_settings += [
    'match_operator' => 'CONTAINS',
    'match_limit' => 10,
  ];
  $data = serialize($selection_settings) . 'entity_test_computed_field' . $settings['entity_test_computed_field']['handler'];
  $selection_settings_key = Crypt::hmacBase64($data, Settings::getHashSalt());
  $expected_autocomplete_path = Url::fromRoute('system.entity_autocomplete', [
    'target_type' => 'entity_test_computed_field',
    'selection_handler' => $settings['entity_test_computed_field']['handler'],
    'selection_settings_key' => $selection_settings_key,
  ])
    ->toString();
  $this
    ->assertStringContainsString($input
    ->getAttribute('data-autocomplete-path'), $expected_autocomplete_path);

  // Add some extra dynamic entity reference fields.
  $this
    ->getSession()
    ->getPage()
    ->findButton('Add another item')
    ->click();
  $this
    ->getSession()
    ->getPage()
    ->findButton('Add another item')
    ->click();
  $edit = [
    'field_foobar[0][target_id]' => $this->anotherUser
      ->label() . ' (' . $this->anotherUser
      ->id() . ')',
    'field_foobar[0][target_type]' => 'user',
    // Ensure that an exact match on a unique label is accepted.
    'field_foobar[1][target_id]' => 'item1',
    'field_foobar[1][target_type]' => 'entity_test',
    'field_foobar[2][target_id]' => 'item2 (' . $item2
      ->id() . ')',
    'field_foobar[2][target_type]' => 'entity_test',
    'name[0][value]' => 'Barfoo',
    'user_id[0][target_id]' => $this->adminUser
      ->label() . ' (' . $this->adminUser
      ->id() . ')',
  ];
  $this
    ->submitForm($edit, t('Save'));
  $entities = \Drupal::entityTypeManager()
    ->getStorage('entity_test')
    ->loadByProperties([
    'name' => 'Barfoo',
  ]);
  $this
    ->assertCount(1, $entities, 'Entity was saved');
  $entity = reset($entities);
  $this
    ->drupalGet('entity_test/' . $entity
    ->id());
  $assert_session
    ->pageTextContains('Barfoo');
  $assert_session
    ->pageTextContains($this->anotherUser
    ->label());
  $assert_session
    ->pageTextContains('item1');
  $assert_session
    ->pageTextContains('item2');
  $this
    ->assertCount(3, $entity->field_foobar, 'Three items in field');
  $this
    ->assertEquals($entity->field_foobar[0]->entity
    ->label(), $this->anotherUser
    ->label());
  $this
    ->assertEquals($entity->field_foobar[1]->entity
    ->label(), 'item1');
  $this
    ->assertEquals($entity->field_foobar[2]->entity
    ->label(), 'item2');
  $this
    ->drupalGet('entity_test/manage/' . $entity
    ->id() . '/edit');

  // Ensure that the autocomplete path is correct.
  $expected_entity_types = [
    '0' => 'user',
    '1' => 'entity_test',
    '2' => 'entity_test',
  ];
  foreach ($expected_entity_types as $index => $expected_entity_type) {
    $selection_settings = $settings[$expected_entity_type]['handler_settings'] ?: [];
    $selection_settings += [
      'match_operator' => 'CONTAINS',
      'match_limit' => 10,
    ];
    $data = serialize($selection_settings) . $expected_entity_type . $settings[$expected_entity_type]['handler'];
    $selection_settings_key = Crypt::hmacBase64($data, Settings::getHashSalt());
    $input = $assert_session
      ->fieldExists('field_foobar[' . $index . '][target_id]');
    $expected_autocomplete_path = Url::fromRoute('system.entity_autocomplete', [
      'target_type' => $expected_entity_type,
      'selection_handler' => $settings[$expected_entity_type]['handler'],
      'selection_settings_key' => $selection_settings_key,
    ])
      ->toString();
    $this
      ->assertStringContainsString($input
      ->getAttribute('data-autocomplete-path'), $expected_autocomplete_path);
  }
  $edit = [
    'name[0][value]' => 'Bazbar',
    // Remove one child.
    'field_foobar[2][target_id]' => '',
  ];
  $this
    ->submitForm($edit, t('Save'));
  $this
    ->drupalGet('entity_test/' . $entity
    ->id());
  $assert_session
    ->pageTextContains('Bazbar');

  // Reload entity.
  \Drupal::entityTypeManager()
    ->getStorage('entity_test')
    ->resetCache([
    $entity
      ->id(),
  ]);
  $entity = EntityTest::load($entity
    ->id());
  $this
    ->assertCount(2, $entity->field_foobar, 'Two values in field');

  // Create two entities with the same label.
  $labels = [];
  $duplicates = [];
  for ($i = 0; $i < 2; $i++) {
    $duplicates[$i] = EntityTest::create([
      'name' => 'duplicate label',
    ]);
    $duplicates[$i]
      ->save();
    $labels[$i] = $duplicates[$i]
      ->label() . ' (' . $duplicates[$i]
      ->id() . ')';
  }

  // Now try to submit and just specify the label.
  $this
    ->drupalGet('entity_test/manage/' . $entity
    ->id() . '/edit');
  $edit = [
    'field_foobar[1][target_id]' => 'duplicate label',
  ];
  $this
    ->submitForm($edit, t('Save'));

  // We don't know the order in which the entities will be listed, so just
  // assert parts and make sure both are shown.
  // @todo remove this once 9.1 and 9.0 are not supported anymore.
  if (version_compare(\Drupal::VERSION, '9.2', '>=')) {
    $error_message = t('Multiple test entity entities match this reference;');
  }
  else {
    $error_message = t('Multiple entities match this reference;');
  }
  $assert_session
    ->responseContains($error_message);
  $assert_session
    ->responseContains($labels[0]);
  $assert_session
    ->responseContains($labels[1]);

  // Create a few more to trigger the case where there are more than 5
  // matching results.
  for ($i = 2; $i < 7; $i++) {
    $duplicates[$i] = EntityTest::create([
      'name' => 'duplicate label',
    ]);
    $duplicates[$i]
      ->save();
    $labels[$i] = $duplicates[$i]
      ->label() . ' (' . $duplicates[$i]
      ->id() . ')';
  }

  // Submit again with the same values.
  $this
    ->submitForm($edit, t('Save'));
  $params = [
    '%value' => 'duplicate label',
  ];

  // We don't know which id it will display, so just assert a part of the
  // error.
  // @todo remove this once 9.1 and 9.0 are not supported anymore.
  if (version_compare(\Drupal::VERSION, '9.2', '>=')) {
    $error_message = t('Many test entity entities are called %value. Specify the one you want by appending the id in parentheses', $params);
  }
  else {
    $error_message = t('Many entities are called %value. Specify the one you want by appending the id in parentheses', $params);
  }
  $assert_session
    ->responseContains($error_message);

  // Submit with a label that does not match anything.
  // Now try to submit and just specify the label.
  $this
    ->drupalGet('entity_test/manage/' . $entity
    ->id() . '/edit');
  $edit = [
    'field_foobar[1][target_id]' => 'does not exist',
  ];
  $this
    ->submitForm($edit, t('Save'));

  // @todo remove this once 9.1 and 9.0 are not supported anymore.
  if (version_compare(\Drupal::VERSION, '9.2', '>=')) {
    $assert_session
      ->responseContains(t('There are no test entity entities matching "%value".', [
      '%value' => 'does not exist',
    ]));
  }
  else {
    $assert_session
      ->responseContains(t('There are no entities matching "%value".', [
      '%value' => 'does not exist',
    ]));
  }
  $this
    ->drupalGet('entity_test/manage/' . $entity
    ->id() . '/edit');
  $edit = [
    'name[0][value]' => 'Bazbar',
    // Reference itself.
    'field_foobar[1][target_id]' => 'Bazbar (' . $entity
      ->id() . ')',
  ];
  $this
    ->submitForm($edit, t('Save'));
  $this
    ->drupalGet('entity_test/' . $entity
    ->id());
  $assert_session
    ->pageTextContains('Bazbar');

  // Reload entity.
  \Drupal::entityTypeManager()
    ->getStorage('entity_test')
    ->resetCache([
    $entity
      ->id(),
  ]);
  $entity = EntityTest::load($entity
    ->id());
  $this
    ->assertEquals($entity->field_foobar[1]->entity
    ->label(), 'Bazbar');
}