EntityReferenceAdminTest.php 22.1 KB
Newer Older
1 2
<?php

3
namespace Drupal\field\Tests\EntityReference;
4

5 6
use Drupal\Component\Utility\Unicode;
use Drupal\field\Entity\FieldConfig;
7
use Drupal\Core\Field\FieldStorageDefinitionInterface;
8
use Drupal\field_ui\Tests\FieldUiTestTrait;
9
use Drupal\node\Entity\Node;
10
use Drupal\simpletest\WebTestBase;
11
use Drupal\taxonomy\Entity\Vocabulary;
12 13

/**
14 15 16
 * Tests for the administrative UI.
 *
 * @group entity_reference
17 18
 */
class EntityReferenceAdminTest extends WebTestBase {
19

20 21
  use FieldUiTestTrait;

22
  /**
23
   * Modules to install.
24
   *
25 26
   * Enable path module to ensure that the selection handler does not fail for
   * entities with a path field.
27
   * Enable views_ui module to see the no_view_help text.
28
   *
29 30
   * @var array
   */
31
  public static $modules = ['node', 'field_ui', 'path', 'taxonomy', 'block', 'views_ui'];
32 33 34 35 36 37 38 39

  /**
   * The name of the content type created for testing purposes.
   *
   * @var string
   */
  protected $type;

40 41 42
  /**
   * {@inheritdoc}
   */
43
  protected function setUp() {
44
    parent::setUp();
45
    $this->drupalPlaceBlock('system_breadcrumb_block');
46

47
    // Create a content type, with underscores.
48
    $type_name = strtolower($this->randomMachineName(8)) . '_test';
49
    $type = $this->drupalCreateContentType(array('name' => $type_name, 'type' => $type_name));
50
    $this->type = $type->id();
51 52 53 54 55 56 57 58 59 60 61

    // Create test user.
    $admin_user = $this->drupalCreateUser(array(
      'access content',
      'administer node fields',
      'administer node display',
      'administer views',
      'create ' . $type_name . ' content',
      'edit own ' . $type_name . ' content',
    ));
    $this->drupalLogin($admin_user);
62 63 64
  }

  /**
65
   * Tests the Entity Reference Admin UI.
66 67 68 69 70
   */
  public function testFieldAdminHandler() {
    $bundle_path = 'admin/structure/types/manage/' . $this->type;

    // First step: 'Add new field' on the 'Manage fields' page.
71 72 73 74 75 76 77
    $this->drupalGet($bundle_path . '/fields/add-field');

    // Check if the commonly referenced entity types appear in the list.
    $this->assertOption('edit-new-storage-type', 'field_ui:entity_reference:node');
    $this->assertOption('edit-new-storage-type', 'field_ui:entity_reference:user');

    $this->drupalPostForm(NULL, array(
78 79 80 81
      'label' => 'Test label',
      'field_name' => 'test',
      'new_storage_type' => 'entity_reference',
    ), t('Save and continue'));
82 83

    // Node should be selected by default.
84
    $this->assertFieldByName('settings[target_type]', 'node');
85

86
    // Check that all entity types can be referenced.
87
    $this->assertFieldSelectOptions('settings[target_type]', array_keys(\Drupal::entityManager()->getDefinitions()));
88

89
    // Second step: 'Field settings' form.
90
    $this->drupalPostForm(NULL, array(), t('Save field settings'));
91 92

    // The base handler should be selected by default.
93
    $this->assertFieldByName('settings[handler]', 'default:node');
94 95

    // The base handler settings should be displayed.
96
    $entity_type_id = 'node';
97
    $bundles = $this->container->get('entity_type.bundle.info')->getBundleInfo($entity_type_id);
98
    foreach ($bundles as $bundle_name => $bundle_info) {
99
      $this->assertFieldByName('settings[handler_settings][target_bundles][' . $bundle_name . ']');
100 101
    }

102 103
    reset($bundles);

104 105
    // Test the sort settings.
    // Option 0: no sort.
106 107
    $this->assertFieldByName('settings[handler_settings][sort][field]', '_none');
    $this->assertNoFieldByName('settings[handler_settings][sort][direction]');
108
    // Option 1: sort by field.
109 110
    $this->drupalPostAjaxForm(NULL, array('settings[handler_settings][sort][field]' => 'nid'), 'settings[handler_settings][sort][field]');
    $this->assertFieldByName('settings[handler_settings][sort][direction]', 'ASC');
111 112

    // Test that a non-translatable base field is a sort option.
113
    $this->assertFieldByXPath("//select[@name='settings[handler_settings][sort][field]']/option[@value='nid']");
114
    // Test that a translatable base field is a sort option.
115
    $this->assertFieldByXPath("//select[@name='settings[handler_settings][sort][field]']/option[@value='title']");
116
    // Test that a configurable field is a sort option.
117
    $this->assertFieldByXPath("//select[@name='settings[handler_settings][sort][field]']/option[@value='body.value']");
118

119
    // Set back to no sort.
120 121
    $this->drupalPostAjaxForm(NULL, array('settings[handler_settings][sort][field]' => '_none'), 'settings[handler_settings][sort][field]');
    $this->assertNoFieldByName('settings[handler_settings][sort][direction]');
122 123

    // Third step: confirm.
124
    $this->drupalPostForm(NULL, array(
125 126
      'required' => '1',
      'settings[handler_settings][target_bundles][' . key($bundles) . ']' => key($bundles),
127
    ), t('Save settings'));
128 129

    // Check that the field appears in the overview form.
130
    $this->assertFieldByXPath('//table[@id="field-overview"]//tr[@id="field-test"]/td[1]', 'Test label', 'Field was created and appears in the overview page.');
131 132 133 134 135 136

    // 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(t('Edit'), 1);
    $this->drupalPostForm(NULL, array(), t('Save settings'));
137 138 139 140 141

    // 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';
    $edit = array(
142
      'settings[target_type]' => 'taxonomy_term',
143 144 145
    );
    $this->drupalPostForm($bundle_path . '/fields/' . $field_name . '/storage', $edit, t('Save field settings'));
    $this->drupalGet($bundle_path . '/fields/' . $field_name);
146
    $this->assertFieldByName('settings[handler_settings][auto_create]');
147 148 149 150 151

    // 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';
    $edit = array(
152
      'settings[target_type]' => 'user',
153 154 155
    );
    $this->drupalPostForm($bundle_path . '/fields/' . $field_name . '/storage', $edit, t('Save field settings'));
    $this->drupalGet($bundle_path . '/fields/' . $field_name);
156
    $this->assertFieldByName('settings[handler_settings][filter][type]', '_none');
157

158 159 160 161 162 163 164
    // Switch the target type to 'node'.
    $field_name = 'node.' . $this->type . '.field_test';
    $edit = array(
      'settings[target_type]' => 'node',
    );
    $this->drupalPostForm($bundle_path . '/fields/' . $field_name . '/storage', $edit, t('Save field settings'));

165 166
    // Try to select the views handler.
    $edit = array(
167
      'settings[handler]' => 'views',
168
    );
169
    $this->drupalPostAjaxForm($bundle_path . '/fields/' . $field_name, $edit, 'settings[handler]');
170 171 172
    $this->assertRaw(t('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>.', array(
      ':create' => \Drupal::url('views_ui.add'),
      ':existing' => \Drupal::url('entity.view.collection'),
173 174 175 176 177 178 179 180 181 182 183 184 185
    )));
    $this->drupalPostForm(NULL, $edit, t('Save settings'));
    // If no eligible view is available we should see a message.
    $this->assertText('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(array('entity_reference_test'));
    $this->resetAll();
    $this->drupalGet($bundle_path . '/fields/' . $field_name);
    $this->drupalPostAjaxForm($bundle_path . '/fields/' . $field_name, $edit, 'settings[handler]');
    $edit = array(
      'settings[handler_settings][view][view_and_display]' => 'test_entity_reference:entity_reference_1',
    );
186 187
    $this->drupalPostForm(NULL, $edit, t('Save settings'));
    $this->assertResponse(200);
188

189 190 191 192 193 194 195 196 197 198 199
    // Switch the target type to 'entity_test'.
    $edit = array(
      'settings[target_type]' => 'entity_test',
    );
    $this->drupalPostForm($bundle_path . '/fields/' . $field_name . '/storage', $edit, t('Save field settings'));
    $this->drupalGet($bundle_path . '/fields/' . $field_name);
    $edit = array(
      'settings[handler]' => 'views',
    );
    $this->drupalPostAjaxForm($bundle_path . '/fields/' . $field_name, $edit, 'settings[handler]');
    $edit = array(
200
      'required' => FALSE,
201 202 203 204
      'settings[handler_settings][view][view_and_display]' => 'test_entity_reference_entity_test:entity_reference_1',
    );
    $this->drupalPostForm(NULL, $edit, t('Save settings'));
    $this->assertResponse(200);
205 206 207 208 209 210

    // Create a new view and display it as a entity reference.
    $edit = array(
      'id' => 'node_test_view',
      'label' => 'Node Test View',
      'show[wizard_key]' => 'node',
211
      'show[sort]' => 'none',
212 213 214 215 216 217 218 219 220 221 222 223 224
      'page[create]' => 1,
      'page[title]' => 'Test Node View',
      'page[path]' => 'test/node/view',
      'page[style][style_plugin]' => 'default',
      'page[style][row_plugin]' => 'fields',
    );
    $this->drupalPostForm('admin/structure/views/add', $edit, t('Save and edit'));
    $this->drupalPostForm(NULL, array(), t('Duplicate as Entity Reference'));
    $this->clickLink(t('Settings'));
    $edit = array(
      'style_options[search_fields][title]' => 'title',
    );
    $this->drupalPostForm(NULL, $edit, t('Apply'));
225 226 227 228 229 230 231 232

    // Set sort to NID ascending.
    $edit = [
      'name[node_field_data.nid]' => 1,
    ];
    $this->drupalPostForm('admin/structure/views/nojs/add-handler/node_test_view/entity_reference_1/sort', $edit, t('Add and configure sort criteria'));
    $this->drupalPostForm(NULL, NULL, t('Apply'));

233 234 235 236 237 238 239 240 241 242 243
    $this->drupalPostForm('admin/structure/views/view/node_test_view/edit/entity_reference_1', array(), t('Save'));
    $this->clickLink(t('Settings'));

    // Create a test entity reference field.
    $field_name = 'test_entity_ref_field';
    $edit = array(
      'new_storage_type' => 'field_ui:entity_reference:node',
      'label' => 'Test Entity Reference Field',
      'field_name' => $field_name,
    );
    $this->drupalPostForm($bundle_path . '/fields/add-field', $edit, t('Save and continue'));
244 245 246 247 248 249

    // Set to unlimited.
    $edit = array(
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
    );
    $this->drupalPostForm(NULL, $edit, t('Save field settings'));
250 251 252 253 254 255 256 257 258 259 260 261

    // Add the view to the test field.
    $edit = array(
      'settings[handler]' => 'views',
    );
    $this->drupalPostAjaxForm(NULL, $edit, 'settings[handler]');
    $edit = array(
      'required' => FALSE,
      'settings[handler_settings][view][view_and_display]' => 'node_test_view:entity_reference_1',
    );
    $this->drupalPostForm(NULL, $edit, t('Save settings'));

262 263 264 265 266 267 268 269 270 271 272
    // Create nodes.
    $node1 = Node::create([
      'type' => $this->type,
      'title' => 'Foo Node',
    ]);
    $node1->save();
    $node2 = Node::create([
      'type' => $this->type,
      'title' => 'Foo Node',
    ]);
    $node2->save();
273 274 275 276 277 278

    // Try to add a new node and fill the entity reference field.
    $this->drupalGet('node/add/' . $this->type);
    $result = $this->xpath('//input[@name="field_test_entity_ref_field[0][target_id]" and contains(@data-autocomplete-path, "/entity_reference_autocomplete/node/views/")]');
    $target_url = $this->getAbsoluteUrl($result[0]['data-autocomplete-path']);
    $this->drupalGet($target_url, array('query' => array('q' => 'Foo')));
279 280 281
    $this->assertRaw($node1->getTitle() . ' (' . $node1->id() . ')');
    $this->assertRaw($node2->getTitle() . ' (' . $node2->id() . ')');

282 283 284 285 286 287 288 289 290 291 292
    // Try to add a new node, fill the entity reference field and submit the
    // form.
    $this->drupalPostForm('node/add/' . $this->type, [], t('Add another item'));
    $edit = array(
      'title[0][value]' => 'Example',
      'field_test_entity_ref_field[0][target_id]' => 'Foo Node (' . $node1->id() . ')',
      'field_test_entity_ref_field[1][target_id]' => 'Foo Node (' . $node2->id() . ')',
    );
    $this->drupalPostForm(NULL, $edit, t('Save'));
    $this->assertResponse(200);

293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
    $edit = array(
      'title[0][value]' => 'Example',
      'field_test_entity_ref_field[0][target_id]' => 'Test'
    );
    $this->drupalPostForm('node/add/' . $this->type, $edit, t('Save'));

    // Assert that entity reference autocomplete field is validated.
    $this->assertText(t('There are no entities matching "@entity"', ['@entity' => 'Test']));

    $edit = array(
      'title[0][value]' => 'Test',
      'field_test_entity_ref_field[0][target_id]' => $node1->getTitle()
    );
    $this->drupalPostForm('node/add/' . $this->type, $edit, t('Save'));

    // Assert the results multiple times to avoid sorting problem of nodes with
    // the same title.
    $this->assertText(t('Multiple entities match this reference;'));
    $this->assertText(t("@node1", ['@node1' => $node1->getTitle() . ' (' . $node1->id() . ')']));
    $this->assertText(t("@node2", ['@node2' => $node2->getTitle() . ' (' . $node2->id() . ')']));
313
    $this->assertText(t('Specify the one you want by appending the id in parentheses, like "@example".', ['@example' => $node2->getTitle() . ' (' . $node2->id() . ')']));
314 315 316

    $edit = array(
      'title[0][value]' => 'Test',
317
      'field_test_entity_ref_field[0][target_id]' => $node1->getTitle() . ' (' . $node1->id() . ')'
318 319 320
    );
    $this->drupalPostForm('node/add/' . $this->type, $edit, t('Save'));
    $this->assertLink($node1->getTitle());
321 322 323

    // Tests adding default values to autocomplete widgets.
    Vocabulary::create(array('vid' => 'tags', 'name' => 'tags'))->save();
324
    $taxonomy_term_field_name = $this->createEntityReferenceField('taxonomy_term', ['tags']);
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
    $field_path = 'node.' . $this->type . '.field_' . $taxonomy_term_field_name;
    $this->drupalGet($bundle_path . '/fields/' . $field_path . '/storage');
    $edit = [
      'cardinality' => -1,
    ];
    $this->drupalPostForm(NULL, $edit, t('Save field settings'));
    $this->drupalGet($bundle_path . '/fields/' . $field_path);
    $term_name = $this->randomString();
    $edit = [
      // This must be set before new entities will be auto-created.
      'settings[handler_settings][auto_create]' => 1,
    ];
    $this->drupalPostForm(NULL, $edit, t('Save settings'));
    $this->drupalGet($bundle_path . '/fields/' . $field_path);
    $edit = [
      // A term that doesn't yet exist.
      'default_value_input[field_' . $taxonomy_term_field_name . '][0][target_id]' => $term_name,
    ];
    $this->drupalPostForm(NULL, $edit, t('Save settings'));
    // The term should now exist.
    $term = taxonomy_term_load_multiple_by_name($term_name, 'tags')[1];
    $this->assertIdentical(1, count($term), 'Taxonomy term was auto created when set as field default.');
347
  }
348 349

  /**
350
   * Tests the formatters for the Entity References.
351 352 353 354 355 356
   */
  public function testAvailableFormatters() {
    // Create a new vocabulary.
    Vocabulary::create(array('vid' => 'tags', 'name' => 'tags'))->save();

    // Create entity reference field with taxonomy term as a target.
357
    $taxonomy_term_field_name = $this->createEntityReferenceField('taxonomy_term', ['tags']);
358

359 360 361
    // Create entity reference field with user as a target.
    $user_field_name = $this->createEntityReferenceField('user');

362
    // Create entity reference field with node as a target.
363
    $node_field_name = $this->createEntityReferenceField('node', [$this->type]);
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380

    // Create entity reference field with date format as a target.
    $date_format_field_name = $this->createEntityReferenceField('date_format');

    // Display all newly created Entity Reference configuration.
    $this->drupalGet('admin/structure/types/manage/' . $this->type . '/display');

    // Check for Taxonomy Term select box values.
    // Test if Taxonomy Term Entity Reference Field has the correct formatters.
    $this->assertFieldSelectOptions('fields[field_' . $taxonomy_term_field_name . '][type]', array(
      'entity_reference_label',
      'entity_reference_entity_id',
      'entity_reference_rss_category',
      'entity_reference_entity_view',
      'hidden',
    ));

381 382 383 384 385 386 387 388 389 390 391
    // Test if User Reference Field has the correct formatters.
    // Author should be available for this field.
    // RSS Category should not be available for this field.
    $this->assertFieldSelectOptions('fields[field_' . $user_field_name . '][type]', array(
      'author',
      'entity_reference_entity_id',
      'entity_reference_entity_view',
      'entity_reference_label',
      'hidden',
    ));

392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
    // Test if Node Entity Reference Field has the correct formatters.
    // RSS Category should not be available for this field.
    $this->assertFieldSelectOptions('fields[field_' . $node_field_name . '][type]', array(
      'entity_reference_label',
      'entity_reference_entity_id',
      'entity_reference_entity_view',
      'hidden',
    ));

    // Test if Date Format Reference Field has the correct formatters.
    // RSS Category & Entity View should not be available for this field.
    // This could be any field without a ViewBuilder.
    $this->assertFieldSelectOptions('fields[field_' . $date_format_field_name . '][type]', array(
      'entity_reference_label',
      'entity_reference_entity_id',
      'hidden',
    ));
  }

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 465 466 467 468 469 470 471
  /**
   * Tests field settings for an entity reference field when the field has
   * multiple target bundles and is set to auto-create the target entity.
   */
  public function testMultipleTargetBundles() {
    /** @var \Drupal\taxonomy\Entity\Vocabulary[] $vocabularies */
    $vocabularies = [];
    for ($i = 0; $i < 2; $i++) {
      $vid = Unicode::strtolower($this->randomMachineName());
      $vocabularies[$i] = Vocabulary::create([
        'name' => $this->randomString(),
        'vid' => $vid,
      ]);
      $vocabularies[$i]->save();
    }

    // Create a new field pointing to the first vocabulary.
    $field_name = $this->createEntityReferenceField('taxonomy_term', [$vocabularies[0]->id()]);
    $field_name = "field_$field_name";
    $field_id = 'node.' . $this->type . '.' . $field_name;
    $path = 'admin/structure/types/manage/' . $this->type . '/fields/' . $field_id;

    $this->drupalGet($path);

    // Expect that there's no 'auto_create_bundle' selected.
    $this->assertNoFieldByName('settings[handler_settings][auto_create_bundle]');

    $edit = [
      'settings[handler_settings][target_bundles][' . $vocabularies[1]->id() . ']' => TRUE,
    ];
    // Enable the second vocabulary as a target bundle.
    $this->drupalPostAjaxForm($path, $edit, key($edit));
    // Expect a select element with the two vocabularies as options.
    $this->assertFieldByXPath("//select[@name='settings[handler_settings][auto_create_bundle]']/option[@value='" . $vocabularies[0]->id() . "']");
    $this->assertFieldByXPath("//select[@name='settings[handler_settings][auto_create_bundle]']/option[@value='" . $vocabularies[1]->id() . "']");

    $edit = [
      'settings[handler_settings][auto_create]' => TRUE,
      'settings[handler_settings][auto_create_bundle]' => $vocabularies[1]->id(),
    ];
    $this->drupalPostForm(NULL, $edit, t('Save settings'));

    /** @var \Drupal\field\Entity\FieldConfig $field_config */
    $field_config = FieldConfig::load($field_id);
    // Expect that the target bundle has been saved in the backend.
    $this->assertEqual($field_config->getSetting('handler_settings')['auto_create_bundle'], $vocabularies[1]->id());

    // Delete the other bundle. Field config should not be affected.
    $vocabularies[0]->delete();
    $field_config = FieldConfig::load($field_id);
    $this->assertTrue($field_config->getSetting('handler_settings')['auto_create']);
    $this->assertIdentical($field_config->getSetting('handler_settings')['auto_create_bundle'], $vocabularies[1]->id());

    // Delete the bundle set for entity auto-creation. Auto-created settings
    // should be reset (no auto-creation).
    $vocabularies[1]->delete();
    $field_config = FieldConfig::load($field_id);
    $this->assertFalse($field_config->getSetting('handler_settings')['auto_create']);
    $this->assertFalse(isset($field_config->getSetting('handler_settings')['auto_create_bundle']));
  }

472 473 474
  /**
   * Creates a new Entity Reference fields with a given target type.
   *
475
   * @param string $target_type
476
   *   The name of the target type
477 478 479
   * @param string[] $bundles
   *   A list of bundle IDs. Defaults to [].
   *
480 481 482
   * @return string
   *   Returns the generated field name
   */
483
  protected function createEntityReferenceField($target_type, $bundles = []) {
484 485 486 487 488 489
    // Generates a bundle path for the newly created content type.
    $bundle_path = 'admin/structure/types/manage/' . $this->type;

    // Generate a random field name, must be only lowercase characters.
    $field_name = strtolower($this->randomMachineName());

490
    $storage_edit = $field_edit = array();
491
    $storage_edit['settings[target_type]'] = $target_type;
492
    foreach ($bundles as $bundle) {
493
      $field_edit['settings[handler_settings][target_bundles][' . $bundle . ']'] = TRUE;
494 495
    }

496
    $this->fieldUIAddNewField($bundle_path, $field_name, NULL, 'entity_reference', $storage_edit, $field_edit);
497 498 499 500 501

    // Returns the generated field name.
    return $field_name;
  }

502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
  /**
   * Checks if a select element contains the specified options.
   *
   * @param string $name
   *   The field name.
   * @param array $expected_options
   *   An array of expected options.
   *
   * @return bool
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertFieldSelectOptions($name, array $expected_options) {
    $xpath = $this->buildXPathQuery('//select[@name=:name]', array(':name' => $name));
    $fields = $this->xpath($xpath);
    if ($fields) {
      $field = $fields[0];
      $options = $this->getAllOptionsList($field);
519 520 521 522 523

      sort($options);
      sort($expected_options);

      return $this->assertIdentical($options, $expected_options);
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
    }
    else {
      return $this->fail('Unable to find field ' . $name);
    }
  }

  /**
   * Extracts all options from a select element.
   *
   * @param \SimpleXMLElement $element
   *   The select element field information.
   *
   * @return array
   *   An array of option values as strings.
   */
  protected function getAllOptionsList(\SimpleXMLElement $element) {
    $options = array();
    // Add all options items.
    foreach ($element->option as $option) {
      $options[] = (string) $option['value'];
    }

546 547 548
    // Loops trough all the option groups
    foreach ($element->optgroup as $optgroup) {
      $options = array_merge($this->getAllOptionsList($optgroup), $options);
549 550 551 552 553
    }

    return $options;
  }

554
}