function EntityReferenceAdminTest::testFieldAdminHandler

Tests the Entity Reference Admin UI.

File

core/modules/field/tests/src/FunctionalJavascript/EntityReference/EntityReferenceAdminTest.php, line 116

Class

EntityReferenceAdminTest

Tests for the administrative UI.

Namespace

Code

public function testFieldAdminHandler() : void {
  $bundle_path = 'admin/structure/types/manage/' . $this->type;
  $page = $this->getSession()
    ->getPage();
  /** @var \Drupal\FunctionalJavascriptTests\JSWebAssert $assert_session */
  $assert_session = $this->assertSession();
  // First step: 'Add new field' on the 'Manage fields' page.
  $this->drupalGet($bundle_path . '/fields/add-field');
  // Check if the commonly referenced entity types appear in the list.
  $page->find('css', "[name='new_storage_type'][value='reference']")
    ->getParent()
    ->click();
  $page->pressButton('Continue');
  $assert_session->pageTextContains('Choose an option below');
  $this->assertSession()
    ->elementExists('css', "[name='group_field_options_wrapper'][value='field_ui:entity_reference:node']");
  $this->assertSession()
    ->elementExists('css', "[name='group_field_options_wrapper'][value='field_ui:entity_reference:user']");
  $page->pressButton('Back');
  $this->fieldUIAddNewFieldJS(NULL, 'test', 'Test', 'entity_reference', FALSE);
  // Node should be selected by default.
  $this->assertSession()
    ->fieldValueEquals('field_storage[subform][settings][target_type]', 'node');
  // Check that all entity types can be referenced.
  $this->assertFieldSelectOptions('field_storage[subform][settings][target_type]', array_keys(\Drupal::entityTypeManager()->getDefinitions()));
  // The base handler should be selected by default.
  $this->assertSession()
    ->fieldValueEquals('settings[handler]', 'default:node');
  // The base handler settings should be displayed.
  $entity_type_id = 'node';
  // Check that the type label is correctly displayed.
  $assert_session->pageTextContains('Content type');
  // Check that sort options are not yet visible.
  $sort_by = $page->findField('settings[handler_settings][sort][field]');
  $this->assertNotEmpty($sort_by);
  $this->assertFalse($sort_by->isVisible(), 'The "sort by" options are hidden.');
  $bundles = $this->container
    ->get('entity_type.bundle.info')
    ->getBundleInfo($entity_type_id);
  foreach ($bundles as $bundle_name => $bundle_info) {
    $this->assertSession()
      ->fieldExists('settings[handler_settings][target_bundles][' . $bundle_name . ']');
  }
  reset($bundles);
  // Initially, no bundles are selected so no sort options are available.
  $this->assertFieldSelectOptions('settings[handler_settings][sort][field]', [
    '_none',
  ]);
  // Select this bundle so that standard sort options are available.
  $page->findField('settings[handler_settings][target_bundles][' . $this->type . ']')
    ->setValue($this->type);
  $assert_session->assertWaitOnAjaxRequest();
  // Test that a non-translatable base field is a sort option.
  $assert_session->optionExists('settings[handler_settings][sort][field]', 'nid');
  // Test that a translatable base field is a sort option.
  $assert_session->optionExists('settings[handler_settings][sort][field]', 'title');
  // Test that a configurable field is a sort option.
  $assert_session->optionExists('settings[handler_settings][sort][field]', 'body.value');
  // Test that a field not on this bundle is not a sort option.
  $assert_session->optionNotExists('settings[handler_settings][sort][field]', 'field_text.value');
  // Test that the title option appears once, with the default label.
  $title_options = $sort_by->findAll('xpath', 'option[@value="title"]');
  $this->assertEquals(1, count($title_options));
  $this->assertEquals('Title', $title_options[0]->getText());
  // Also select the target bundle so that field_text is also available.
  $page->findField('settings[handler_settings][target_bundles][' . $this->targetType . ']')
    ->setValue($this->targetType);
  $assert_session->assertWaitOnAjaxRequest();
  $assert_session->optionExists('settings[handler_settings][sort][field]', 'nid');
  $assert_session->optionExists('settings[handler_settings][sort][field]', 'title');
  $assert_session->optionExists('settings[handler_settings][sort][field]', 'body.value');
  $assert_session->optionExists('settings[handler_settings][sort][field]', 'field_text.value');
  // Select only the target bundle. The options should be the same.
  $page->findField('settings[handler_settings][target_bundles][' . $this->type . ']')
    ->uncheck();
  $assert_session->assertWaitOnAjaxRequest();
  $assert_session->optionExists('settings[handler_settings][sort][field]', 'nid');
  $assert_session->optionExists('settings[handler_settings][sort][field]', 'title');
  $assert_session->optionExists('settings[handler_settings][sort][field]', 'body.value');
  $assert_session->optionExists('settings[handler_settings][sort][field]', 'field_text.value');
  // Exception: the title option has a different label.
  $title_options = $sort_by->findAll('xpath', 'option[@value="title"]');
  $this->assertEquals(1, count($title_options));
  $this->assertEquals($this->targetType . ' title', $title_options[0]->getText());
  // Test the sort settings.
  // Option 0: no sort.
  $this->assertSession()
    ->fieldValueEquals('settings[handler_settings][sort][field]', '_none');
  $sort_direction = $page->findField('settings[handler_settings][sort][direction]');
  $this->assertFalse($sort_direction->isVisible());
  // Option 1: sort by field.
  $sort_by->setValue('nid');
  $assert_session->assertWaitOnAjaxRequest();
  $this->assertTrue($sort_direction->isVisible());
  $this->assertSession()
    ->fieldValueEquals('settings[handler_settings][sort][direction]', 'ASC');
  // Test that the sort-by options are sorted.
  $labels = array_map(function (NodeElement $element) {
    return $element->getText();
  }, $sort_by->findAll('xpath', 'option'));
  for ($i = count($labels) - 1, $sorted = TRUE; $i > 0; --$i) {
    if ($labels[$i - 1] > $labels[$i]) {
      $sorted = FALSE;
      break;

    }
  }
  $this->assertTrue($sorted, 'The "sort by" options are sorted.');
  // Set back to no sort.
  $sort_by->setValue('_none');
  $assert_session->assertWaitOnAjaxRequest();
  $this->assertFalse($sort_direction->isVisible());
  // Sort by nid, then select no bundles. The sort fields and sort direction
  // should not display.
  $sort_by->setValue('nid');
  $assert_session->assertWaitOnAjaxRequest();
  foreach ($bundles as $bundle_name => $bundle_info) {
    $this->assertSession()
      ->fieldExists('settings[handler_settings][target_bundles][' . $bundle_name . ']');
    $checkbox = $page->findField('settings[handler_settings][target_bundles][' . $bundle_name . ']');
    if ($checkbox->isChecked()) {
      $checkbox->uncheck();
      $assert_session->assertWaitOnAjaxRequest();
    }
  }
  $this->assertFalse($sort_by->isVisible(), 'The "sort by" options are hidden.');
  $this->assertFalse($sort_direction->isVisible());
  // Select a bundle and check the same two fields.
  $page->findField('settings[handler_settings][target_bundles][' . $this->targetType . ']')
    ->setValue($this->targetType);
  $assert_session->assertWaitOnAjaxRequest();
  $this->assertTrue($sort_by->isVisible(), 'The "sort by" options are visible.');
  $assert_session->optionExists('settings[handler_settings][sort][field]', 'field_text.value');
  // Un-select the bundle and check the same two fields.
  $page->findField('settings[handler_settings][target_bundles][' . $this->targetType . ']')
    ->uncheck();
  $assert_session->assertWaitOnAjaxRequest();
  $this->assertFalse($sort_by->isVisible(), 'The "sort by" options are hidden yet again.');
  $this->assertFieldSelectOptions('settings[handler_settings][sort][field]', [
    '_none',
  ]);
  // Third step: confirm.
  $page->findField('settings[handler_settings][target_bundles][' . $this->targetType . ']')
    ->setValue($this->targetType);
  $assert_session->assertWaitOnAjaxRequest();
  $this->submitForm([
    'required' => '1',
  ], 'Save settings');
  // Check that the field appears in the overview form.
  $this->assertSession()
    ->elementTextContains('xpath', '//table[@id="field-overview"]//tr[@id="field-test"]/td[1]', "Test");
  // Check that the field settings form can be submitted again, even when the
  // field is required.
  // The first 'Edit' link is for the Body field.
  $this->clickLink('Edit', 1);
  $this->submitForm([], 'Save settings');
  // Switch the target type to 'taxonomy_term' and check that the settings
  // specific to its selection handler are displayed.
  $field_name = 'node.' . $this->type . '.field_test';
  $this->drupalGet($bundle_path . '/fields/' . $field_name);
  $page->findField('field_storage[subform][settings][target_type]')
    ->setValue('taxonomy_term');
  $this->assertSession()
    ->assertWaitOnAjaxRequest();
  $this->assertSession()
    ->fieldExists('settings[handler_settings][auto_create]');
  $this->assertSession()
    ->fieldValueEquals('settings[handler]', 'default:taxonomy_term');
  // Switch the target type to 'user' and check that the settings specific to
  // its selection handler are displayed.
  $field_name = 'node.' . $this->type . '.field_test';
  $this->drupalGet($bundle_path . '/fields/' . $field_name);
  $target_type_input = $assert_session->fieldExists('field_storage[subform][settings][target_type]');
  $target_type_input->setValue('user');
  $assert_session->assertWaitOnAjaxRequest();
  $this->assertSession()
    ->fieldValueEquals('settings[handler_settings][filter][type]', '_none');
  $this->assertSession()
    ->fieldValueEquals('settings[handler_settings][sort][field]', '_none');
  $assert_session->optionNotExists('settings[handler_settings][sort][field]', 'nid');
  $assert_session->optionExists('settings[handler_settings][sort][field]', 'uid');
  // Check that sort direction is visible only when a sort field is selected.
  $sort_direction = $page->findField('settings[handler_settings][sort][direction]');
  $this->assertFalse($sort_direction->isVisible());
  $sort_by->setValue('name');
  $assert_session->assertWaitOnAjaxRequest();
  $this->assertTrue($sort_direction->isVisible());
  // Switch the target type to 'node'.
  $field_name = 'node.' . $this->type . '.field_test';
  $this->drupalGet($bundle_path . '/fields/' . $field_name);
  $page->findField('field_storage[subform][settings][target_type]')
    ->setValue('node');
  // Try to select the views handler.
  $this->drupalGet($bundle_path . '/fields/' . $field_name);
  $page->findField('settings[handler]')
    ->setValue('views');
  $views_text = (string) new FormattableMarkup('No eligible views were found. <a href=":create">Create a view</a> with an <em>Entity Reference</em> display, or add such a display to an <a href=":existing">existing view</a>.', [
    ':create' => Url::fromRoute('views_ui.add')->toString(),
    ':existing' => Url::fromRoute('entity.view.collection')->toString(),
  ]);
  $assert_session->waitForElement('xpath', '//a[contains(text(), "Create a view")]');
  $assert_session->responseContains($views_text);
  $this->submitForm([], 'Save settings');
  // If no eligible view is available we should see a message.
  $assert_session->pageTextContains('The views entity selection mode requires a view.');
  // Enable the entity_reference_test module which creates an eligible view.
  $this->container
    ->get('module_installer')
    ->install([
    'entity_reference_test',
  ]);
  $this->resetAll();
  $this->drupalGet($bundle_path . '/fields/' . $field_name);
  $page->findField('settings[handler]')
    ->setValue('views');
  $assert_session->waitForField('settings[handler_settings][view][view_and_display]')
    ->setValue('test_entity_reference:entity_reference_1');
  $this->submitForm([], 'Save settings');
  $assert_session->pageTextContains('Saved Test configuration.');
  // Switch the target type to 'entity_test'.
  $this->drupalGet($bundle_path . '/fields/' . $field_name);
  $page->findField('field_storage[subform][settings][target_type]')
    ->setValue('entity_test');
  $assert_session->assertWaitOnAjaxRequest();
  $page->findField('settings[handler]')
    ->setValue('views');
  $page->findField('settings[handler_settings][view][view_and_display]')
    ->selectOption('test_entity_reference_entity_test:entity_reference_1');
  $edit = [
    'required' => FALSE,
  ];
  $this->submitForm($edit, 'Save settings');
  $assert_session->pageTextContains('Saved Test configuration.');
}