DynamicEntityReferenceBaseTest.php in Dynamic Entity Reference 8.2

Namespace

Drupal\Tests\dynamic_entity_reference\Functional

File

tests/src/Functional/DynamicEntityReferenceBaseTest.php

<?php

namespace Drupal\Tests\dynamic_entity_reference\Functional;

use Drupal\Component\Utility\Crypt;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Core\Site\Settings;
use Drupal\Core\Url;
use Drupal\entity_test\Entity\EntityTest;
use Drupal\Tests\BrowserTestBase;

/**
 * Ensures that Dynamic Entity References field works correctly.
 *
 * @group dynamic_entity_reference
 */
class DynamicEntityReferenceBaseTest extends BrowserTestBase {

  /**
   * The admin user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $adminUser;

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'field_ui',
    'dynamic_entity_reference',
    'entity_test',
  ];

  /**
   * Permissions to grant admin user.
   *
   * @var array
   */
  protected $permissions = [
    'access administration pages',
    'view test entity',
    'administer entity_test fields',
    'administer entity_test content',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * Sets the test up.
   */
  protected function setUp() : void {
    parent::setUp();
    $this->adminUser = $this
      ->drupalCreateUser($this->permissions);
  }

  /**
   * Tests adding and editing single values using dynamic entity reference.
   */
  public function testSingleValueDynamicEntityReference() {
    $assert_session = $this
      ->assertSession();
    \Drupal::state()
      ->set('dynamic_entity_reference_entity_test_cardinality', 1);
    \Drupal::service('module_installer')
      ->install([
      'dynamic_entity_reference_entity_test',
    ]);
    $this
      ->drupalLogin($this->adminUser);

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

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

    // Ensure that the autocomplete path is correct.
    $input = $this
      ->xpath('//input[@name=:name]', [
      ':name' => 'dynamic_references[0][target_id]',
    ])[0];
    $settings = \Drupal::service('entity_field.manager')
      ->getBaseFieldDefinitions('entity_test')['dynamic_references']
      ->getSettings();
    $selection_settings = $settings['entity_test']['handler_settings'] ?: [];
    $selection_settings += [
      'match_operator' => 'CONTAINS',
      'match_limit' => 10,
    ];
    $data = serialize($selection_settings) . 'entity_test' . $settings['entity_test']['handler'];
    $selection_settings_key = Crypt::hmacBase64($data, Settings::getHashSalt());
    $expected_autocomplete_path = Url::fromRoute('system.entity_autocomplete', [
      'target_type' => 'entity_test',
      'selection_handler' => $settings['entity_test']['handler'],
      'selection_settings_key' => $selection_settings_key,
    ])
      ->toString();
    $this
      ->assertTrue(strpos($input
      ->getAttribute('data-autocomplete-path'), $expected_autocomplete_path) !== FALSE);
    $edit = [
      // Ensure that an exact match on a unique label is accepted.
      'dynamic_references[0][target_id]' => 'item1',
      'dynamic_references[0][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('item1');
    $this
      ->assertCount(1, $entity->dynamic_references, 'One item in field');
    $this
      ->assertEquals($entity->dynamic_references[0]->entity
      ->label(), 'item1');
    $this
      ->drupalGet('entity_test/manage/' . $entity
      ->id() . '/edit');
    $edit = [
      'name[0][value]' => 'Bazbar',
      // Remove one child.
      'dynamic_references[0][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
      ->assertTrue($entity->dynamic_references
      ->isEmpty(), 'No value 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 = [
      'dynamic_references[0][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 = [
      'dynamic_references[0][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.
      'dynamic_references[0][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->dynamic_references[0]->entity
      ->label(), 'Bazbar');
  }

  /**
   * Tests adding and editing multi values using dynamic entity reference.
   */
  public function testMultiValueDynamicEntityReference() {
    $assert_session = $this
      ->assertSession();
    \Drupal::state()
      ->set('dynamic_entity_reference_entity_test_cardinality', FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
    \Drupal::service('module_installer')
      ->install([
      'dynamic_entity_reference_entity_test',
    ]);
    $this
      ->drupalLogin($this->adminUser);

    // 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('dynamic_references[0][target_id]');
    $assert_session
      ->fieldExists('dynamic_references[0][target_type]');

    // Ensure that the autocomplete path is correct.
    $input = $assert_session
      ->fieldExists('dynamic_references[0][target_id]');
    $settings = \Drupal::service('entity_field.manager')
      ->getBaseFieldDefinitions('entity_test')['dynamic_references']
      ->getSettings();
    $selection_settings = $settings['entity_test']['handler_settings'] ?: [];
    $selection_settings += [
      'match_operator' => 'CONTAINS',
      'match_limit' => 10,
    ];
    $data = serialize($selection_settings) . 'entity_test' . $settings['entity_test']['handler'];
    $selection_settings_key = Crypt::hmacBase64($data, Settings::getHashSalt());
    $expected_autocomplete_path = Url::fromRoute('system.entity_autocomplete', [
      'target_type' => 'entity_test',
      'selection_handler' => $settings['entity_test']['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();
    $edit = [
      // Ensure that an exact match on a unique label is accepted.
      'dynamic_references[0][target_id]' => 'item1',
      'dynamic_references[0][target_type]' => 'entity_test',
      'dynamic_references[1][target_id]' => 'item2 (' . $item2
        ->id() . ')',
      'dynamic_references[1][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('item1');
    $assert_session
      ->pageTextContains('item2');
    $this
      ->assertCount(2, $entity->dynamic_references, 'Two items in field');
    $this
      ->assertEquals($entity->dynamic_references[0]->entity
      ->label(), 'item1');
    $this
      ->assertEquals($entity->dynamic_references[1]->entity
      ->label(), 'item2');
    $this
      ->drupalGet('entity_test/manage/' . $entity
      ->id() . '/edit');
    $edit = [
      'name[0][value]' => 'Bazbar',
      // Remove one child.
      'dynamic_references[1][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(1, $entity->dynamic_references, 'One value 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 = [
      'dynamic_references[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 = [
      'dynamic_references[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.
      'dynamic_references[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->dynamic_references[1]->entity
      ->label(), 'Bazbar');
  }

}

Classes

Name	Description
DynamicEntityReferenceBaseTest	Ensures that Dynamic Entity References field works correctly.