EntityReferenceAutocompleteWidgetTest.php in Drupal 9

Namespace

Drupal\FunctionalJavascriptTests\EntityReference

File

core/tests/Drupal/FunctionalJavascriptTests/EntityReference/EntityReferenceAutocompleteWidgetTest.php

<?php

namespace Drupal\FunctionalJavascriptTests\EntityReference;

use Drupal\FunctionalJavascriptTests\WebDriverTestBase;
use Drupal\Tests\field\Traits\EntityReferenceTestTrait;
use Drupal\Tests\node\Traits\ContentTypeCreationTrait;
use Drupal\Tests\node\Traits\NodeCreationTrait;

/**
 * Tests the output of entity reference autocomplete widgets.
 *
 * @group entity_reference
 */
class EntityReferenceAutocompleteWidgetTest extends WebDriverTestBase {
  use ContentTypeCreationTrait;
  use EntityReferenceTestTrait;
  use NodeCreationTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'node',
    'field_ui',
  ];

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Create a Content type and two test nodes.
    $this
      ->createContentType([
      'type' => 'page',
    ]);
    $this
      ->createNode([
      'title' => 'Test page',
    ]);
    $this
      ->createNode([
      'title' => 'Page test',
    ]);
    $user = $this
      ->drupalCreateUser([
      'access content',
      'create page content',
    ]);
    $this
      ->drupalLogin($user);
  }

  /**
   * Tests that the default autocomplete widget return the correct results.
   */
  public function testEntityReferenceAutocompleteWidget() {

    /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
    $display_repository = \Drupal::service('entity_display.repository');

    // Create an entity reference field and use the default 'CONTAINS' match
    // operator.
    $field_name = 'field_test';
    $this
      ->createEntityReferenceField('node', 'page', $field_name, $field_name, 'node', 'default', [
      'target_bundles' => [
        'page',
      ],
      'sort' => [
        'field' => 'title',
        'direction' => 'DESC',
      ],
    ]);
    $form_display = $display_repository
      ->getFormDisplay('node', 'page');
    $form_display
      ->setComponent($field_name, [
      'type' => 'entity_reference_autocomplete',
      'settings' => [
        'match_operator' => 'CONTAINS',
      ],
    ]);

    // To satisfy config schema, the size setting must be an integer, not just
    // a numeric value. See https://www.drupal.org/node/2885441.
    $this
      ->assertIsInt($form_display
      ->getComponent($field_name)['settings']['size']);
    $form_display
      ->save();
    $this
      ->assertIsInt($form_display
      ->getComponent($field_name)['settings']['size']);

    // Visit the node add page.
    $this
      ->drupalGet('node/add/page');
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();
    $autocomplete_field = $assert_session
      ->waitForElement('css', '[name="' . $field_name . '[0][target_id]"].ui-autocomplete-input');
    $autocomplete_field
      ->setValue('Test');
    $this
      ->getSession()
      ->getDriver()
      ->keyDown($autocomplete_field
      ->getXpath(), ' ');
    $assert_session
      ->waitOnAutocomplete();
    $results = $page
      ->findAll('css', '.ui-autocomplete li');
    $this
      ->assertCount(2, $results);
    $assert_session
      ->pageTextContains('Test page');
    $assert_session
      ->pageTextContains('Page test');

    // Now switch the autocomplete widget to the 'STARTS_WITH' match operator.
    $display_repository
      ->getFormDisplay('node', 'page')
      ->setComponent($field_name, [
      'type' => 'entity_reference_autocomplete',
      'settings' => [
        'match_operator' => 'STARTS_WITH',
      ],
    ])
      ->save();
    $this
      ->drupalGet('node/add/page');
    $this
      ->doAutocomplete($field_name);
    $results = $page
      ->findAll('css', '.ui-autocomplete li');
    $this
      ->assertCount(1, $results);
    $assert_session
      ->pageTextContains('Test page');
    $assert_session
      ->pageTextNotContains('Page test');

    // Change the size of the result set.
    $display_repository
      ->getFormDisplay('node', 'page')
      ->setComponent($field_name, [
      'type' => 'entity_reference_autocomplete',
      'settings' => [
        'match_limit' => 1,
      ],
    ])
      ->save();
    $this
      ->drupalGet('node/add/page');
    $this
      ->doAutocomplete($field_name);
    $results = $page
      ->findAll('css', '.ui-autocomplete li');
    $this
      ->assertCount(1, $results);
    $assert_session
      ->pageTextContains('Test page');
    $assert_session
      ->pageTextNotContains('Page test');

    // Change the size of the result set via the UI.
    $this
      ->drupalLogin($this
      ->createUser([
      'access content',
      'administer content types',
      'administer node fields',
      'administer node form display',
      'create page content',
    ]));
    $this
      ->drupalGet('/admin/structure/types/manage/page/form-display');
    $assert_session
      ->pageTextContains('Autocomplete suggestion list size: 1');

    // Click on the widget settings button to open the widget settings form.
    $this
      ->submitForm([], $field_name . "_settings_edit");
    $this
      ->assertSession()
      ->waitForElement('css', sprintf('[name="fields[%s][settings_edit_form][settings][match_limit]"]', $field_name));
    $page
      ->fillField('Number of results', 2);
    $page
      ->pressButton('Save');
    $assert_session
      ->pageTextContains('Your settings have been saved.');
    $assert_session
      ->pageTextContains('Autocomplete suggestion list size: 2');
    $this
      ->drupalGet('node/add/page');
    $this
      ->doAutocomplete($field_name);
    $this
      ->assertCount(2, $page
      ->findAll('css', '.ui-autocomplete li'));
  }

  /**
   * Executes an autocomplete on a given field and waits for it to finish.
   *
   * @param string $field_name
   *   The field name.
   */
  protected function doAutocomplete($field_name) {
    $autocomplete_field = $this
      ->getSession()
      ->getPage()
      ->findField($field_name . '[0][target_id]');
    $autocomplete_field
      ->setValue('Test');
    $this
      ->getSession()
      ->getDriver()
      ->keyDown($autocomplete_field
      ->getXpath(), ' ');
    $this
      ->assertSession()
      ->waitOnAutocomplete();
  }

}

Classes

Name	Description
EntityReferenceAutocompleteWidgetTest	Tests the output of entity reference autocomplete widgets.