You are here

Home » API reference » Entity Browser 8.2 » EntityReferenceWidgetTest.php

class EntityReferenceWidgetTest in Entity Browser 8.2

Same name and namespace in other branches
  1. 8 tests/src/FunctionalJavascript/EntityReferenceWidgetTest.php \Drupal\Tests\entity_browser\FunctionalJavascript\EntityReferenceWidgetTest

Tests the Entity Reference Widget.

@group entity_browser

Hierarchy

Expanded class hierarchy of EntityReferenceWidgetTest

File

tests/src/FunctionalJavascript/EntityReferenceWidgetTest.php, line 18

Namespace

Drupal\Tests\entity_browser\FunctionalJavascript
View source 
class EntityReferenceWidgetTest extends EntityBrowserWebDriverTestBase {
  use SortableTestTrait;

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

    /** @var \Drupal\user\RoleInterface $role */
    $role = Role::load('authenticated');
    $this
      ->grantPermissions($role, [
      'access test_entity_browser_iframe_node_view entity browser pages',
      'bypass node access',
      'administer node form display',
      'access contextual links',
    ]);
  }

  /**
   * Tests Entity Reference widget.
   */
  public function testEntityReferenceWidget() {

    // Create an entity_reference field to test the widget.
    $field_storage = FieldStorageConfig::create([
      'field_name' => 'field_entity_reference1',
      'type' => 'entity_reference',
      'entity_type' => 'node',
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
      'settings' => [
        'target_type' => 'node',
      ],
    ]);
    $field_storage
      ->save();
    $field = FieldConfig::create([
      'field_name' => 'field_entity_reference1',
      'entity_type' => 'node',
      'bundle' => 'article',
      'label' => 'Referenced articles',
      'settings' => [],
    ]);
    $field
      ->save();

    /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $form_display */
    $form_display = $this->container
      ->get('entity_type.manager')
      ->getStorage('entity_form_display')
      ->load('node.article.default');
    $form_display
      ->setComponent('field_entity_reference1', [
      'type' => 'entity_browser_entity_reference',
      'settings' => [
        'entity_browser' => 'test_entity_browser_iframe_node_view',
        'open' => TRUE,
        'field_widget_edit' => TRUE,
        'field_widget_remove' => TRUE,
        'field_widget_replace' => FALSE,
        'selection_mode' => EntityBrowserElement::SELECTION_MODE_APPEND,
        'field_widget_display' => 'rendered_entity',
        'field_widget_display_settings' => [
          'view_mode' => 'teaser',
        ],
      ],
    ])
      ->save();

    // Create a dummy node that will be used as target.
    $target_node = Node::create([
      'title' => 'Walrus',
      'type' => 'article',
    ]);
    $target_node
      ->save();
    $target_node_translation = $target_node
      ->addTranslation('fr', $target_node
      ->toArray());
    $target_node_translation
      ->setTitle('le Morse');
    $target_node_translation
      ->save();
    $this
      ->drupalGet('/node/add/article');
    $this
      ->assertSession()
      ->fieldExists('title[0][value]')
      ->setValue('Referencing node 1');
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_test_entity_browser_iframe_node_view');
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:1]')
      ->check();
    $this
      ->assertSession()
      ->buttonExists('Select entities')
      ->press();
    $this
      ->getSession()
      ->switchToIFrame();
    $this
      ->assertTrue($this
      ->assertSession()
      ->waitForText('Walrus'));
    $this
      ->assertSession()
      ->buttonExists('Save')
      ->press();
    $this
      ->assertSession()
      ->pageTextContains('Article Referencing node 1 has been created.');
    $nid = \Drupal::entityQuery('node')
      ->condition('title', 'Referencing node 1')
      ->execute();
    $nid = reset($nid);

    // Assert correct translation appears.
    // @see Drupal\entity_browser\Plugin\EntityBrowser\FieldWidgetDisplay\EntityLabel
    $this
      ->drupalGet('fr/node/' . $nid . '/edit');
    $this
      ->assertSession()
      ->pageTextContains('le Morse');
    $this
      ->drupalGet('node/' . $nid . '/edit');
    $this
      ->assertSession()
      ->pageTextContains('Walrus');

    // Make sure both "Edit" and "Remove" buttons are visible.
    $this
      ->assertSession()
      ->buttonExists('edit-field-entity-reference1-current-items-0-remove-button');
    $this
      ->assertSession()
      ->buttonExists('edit-field-entity-reference1-current-items-0-edit-button')
      ->press();

    // Make sure the contextual links are not present.
    $this
      ->assertSession()
      ->elementNotExists('css', '.contextual-links');

    // Test edit dialog by changing title of referenced entity.
    $edit_dialog = $this
      ->assertSession()
      ->waitForElement('xpath', '//div[contains(@id, "node-' . $target_node
      ->id() . '-edit-dialog")]');
    $title_field = $edit_dialog
      ->findField('title[0][value]');
    $title = $title_field
      ->getValue();
    $this
      ->assertEquals('Walrus', $title);
    $title_field
      ->setValue('Alpaca');
    $this
      ->assertSession()
      ->elementExists('css', '.ui-dialog-buttonset.form-actions .form-submit')
      ->press();
    $this
      ->waitForAjaxToFinish();

    // Check that new title is displayed.
    $this
      ->assertSession()
      ->pageTextNotContains('Walrus');
    $this
      ->assertSession()
      ->pageTextContains('Alpaca');

    // Test whether changing these definitions on the browser config effectively
    // change the visibility of the buttons.
    $form_display
      ->setComponent('field_entity_reference1', [
      'type' => 'entity_browser_entity_reference',
      'settings' => [
        'entity_browser' => 'test_entity_browser_iframe_node_view',
        'open' => TRUE,
        'field_widget_edit' => FALSE,
        'field_widget_remove' => FALSE,
        'field_widget_replace' => FALSE,
        'selection_mode' => EntityBrowserElement::SELECTION_MODE_APPEND,
        'field_widget_display' => 'label',
        'field_widget_display_settings' => [],
      ],
    ])
      ->save();
    $this
      ->drupalGet('node/' . $nid . '/edit');
    $this
      ->assertSession()
      ->buttonNotExists('edit-field-entity-reference1-current-items-0-remove-button');
    $this
      ->assertSession()
      ->buttonNotExists('edit-field-entity-reference1-current-items-0-edit-button');

    // Set them to visible again.
    $form_display
      ->setComponent('field_entity_reference1', [
      'type' => 'entity_browser_entity_reference',
      'settings' => [
        'entity_browser' => 'test_entity_browser_iframe_node_view',
        'open' => TRUE,
        'field_widget_edit' => TRUE,
        'field_widget_remove' => TRUE,
        'field_widget_replace' => FALSE,
        'selection_mode' => EntityBrowserElement::SELECTION_MODE_APPEND,
        'field_widget_display' => 'label',
        'field_widget_display_settings' => [],
      ],
    ])
      ->save();
    $this
      ->drupalGet('node/' . $nid . '/edit');
    $remove_button = $this
      ->assertSession()
      ->buttonExists('edit-field-entity-reference1-current-items-0-remove-button');
    $this
      ->assertEquals('Remove', $remove_button
      ->getValue());
    $this
      ->assertTrue($remove_button
      ->hasClass('remove-button'));
    $edit_button = $this
      ->assertSession()
      ->buttonExists('edit-field-entity-reference1-current-items-0-edit-button');
    $this
      ->assertEquals('Edit', $edit_button
      ->getValue());
    $this
      ->assertTrue($edit_button
      ->hasClass('edit-button'));

    // Make sure the "Replace" button is not there.
    $this
      ->assertSession()
      ->buttonNotExists('edit-field-entity-reference1-current-items-0-replace-button');

    // Test the "Remove" button on the widget works.
    $this
      ->assertSession()
      ->buttonExists('Remove')
      ->press();
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->pageTextNotContains('Alpaca');

    // Test the "Replace" button functionality.
    $form_display
      ->setComponent('field_entity_reference1', [
      'type' => 'entity_browser_entity_reference',
      'settings' => [
        'entity_browser' => 'test_entity_browser_iframe_node_view',
        'open' => TRUE,
        'field_widget_edit' => TRUE,
        'field_widget_remove' => TRUE,
        'field_widget_replace' => TRUE,
        'selection_mode' => EntityBrowserElement::SELECTION_MODE_APPEND,
        'field_widget_display' => 'label',
        'field_widget_display_settings' => [],
      ],
    ])
      ->save();

    // In order to ensure the replace button opens the browser, it needs to be
    // closed.

    /** @var \Drupal\entity_browser\EntityBrowserInterface $browser */
    $browser = $this->container
      ->get('entity_type.manager')
      ->getStorage('entity_browser')
      ->load('test_entity_browser_iframe_node_view');
    $browser
      ->getDisplay()
      ->setConfiguration([
      'width' => 650,
      'height' => 500,
      'link_text' => 'Select entities',
      'auto_open' => FALSE,
    ]);
    $browser
      ->save();

    // We'll need a third node to be able to make a new selection.
    $target_node2 = Node::create([
      'title' => 'Target example node 2',
      'type' => 'article',
    ]);
    $target_node2
      ->save();
    $this
      ->drupalGet('node/' . $nid . '/edit');

    // If there is only one entity in the current selection the button should
    // show up.
    $replace_button = $this
      ->assertSession()
      ->buttonExists('edit-field-entity-reference1-current-items-0-replace-button');
    $this
      ->assertEquals('Replace', $replace_button
      ->getValue());
    $this
      ->assertTrue($replace_button
      ->hasClass('replace-button'));

    // Clicking on the button should empty the selection and automatically
    // open the browser again.
    $replace_button
      ->click();
    $this
      ->waitForAjaxToFinish();
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_test_entity_browser_iframe_node_view');
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:3]')
      ->check();
    $this
      ->assertSession()
      ->buttonExists('Select entities')
      ->press();
    $this
      ->getSession()
      ->wait(1000);
    $this
      ->getSession()
      ->switchToIFrame();
    $this
      ->waitForAjaxToFinish();

    // Even in the AJAX-built markup for the newly selected element, the replace
    // button should be there.
    $this
      ->assertSession()
      ->elementExists('css', 'input[data-drupal-selector="edit-field-entity-reference1-current-items-0-replace-button"]');

    // Adding a new node to the selection, however, should make it disappear.
    $open_iframe_link = $this
      ->assertSession()
      ->elementExists('css', 'a[data-drupal-selector="edit-field-entity-reference1-entity-browser-entity-browser-link"]');
    $open_iframe_link
      ->click();
    $this
      ->waitForAjaxToFinish();
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_test_entity_browser_iframe_node_view');
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:1]')
      ->check();
    $this
      ->assertSession()
      ->buttonExists('Select entities')
      ->press();
    $this
      ->getSession()
      ->wait(1000);
    $this
      ->getSession()
      ->switchToIFrame();
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->elementNotExists('css', 'input[data-drupal-selector="edit-field-entity-reference1-current-items-0-replace-button"]');
    $this
      ->assertSession()
      ->buttonExists('Save')
      ->press();
    $this
      ->assertSession()
      ->pageTextContains('Article Referencing node 1 has been updated.');

    // Test the replace button again with different field cardinalities.
    FieldStorageConfig::load('node.field_entity_reference1')
      ->setCardinality(1)
      ->save();
    $this
      ->drupalGet('/node/add/article');
    $this
      ->assertSession()
      ->fieldExists('title[0][value]')
      ->setValue('Referencing node 2');
    $open_iframe_link = $this
      ->assertSession()
      ->elementExists('css', 'a[data-drupal-selector="edit-field-entity-reference1-entity-browser-entity-browser-link"]');
    $open_iframe_link
      ->click();
    $this
      ->waitForAjaxToFinish();
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_test_entity_browser_iframe_node_view');
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:1]')
      ->check();
    $this
      ->assertSession()
      ->buttonExists('Select entities')
      ->press();
    $this
      ->getSession()
      ->wait(1000);
    $this
      ->getSession()
      ->switchToIFrame();
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->elementContains('css', '#edit-field-entity-reference1-wrapper', 'Alpaca');

    // All three buttons should be visible.
    $this
      ->assertSession()
      ->elementExists('css', 'input[data-drupal-selector="edit-field-entity-reference1-current-items-0-remove-button"]');
    $this
      ->assertSession()
      ->elementExists('css', 'input[data-drupal-selector="edit-field-entity-reference1-current-items-0-edit-button"]');
    $replace_button = $this
      ->assertSession()
      ->elementExists('css', 'input[data-drupal-selector="edit-field-entity-reference1-current-items-0-replace-button"]');

    // Clicking on the button should empty the selection and automatically
    // open the browser again.
    $replace_button
      ->click();
    $this
      ->waitForAjaxToFinish();
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_test_entity_browser_iframe_node_view');
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:2]')
      ->check();
    $this
      ->assertSession()
      ->buttonExists('Select entities')
      ->press();
    $this
      ->getSession()
      ->wait(1000);
    $this
      ->getSession()
      ->switchToIFrame();
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->elementContains('css', '#edit-field-entity-reference1-wrapper', 'Referencing node 1');

    // Do the same as above but now with cardinality 2.
    FieldStorageConfig::load('node.field_entity_reference1')
      ->setCardinality(2)
      ->save();
    $this
      ->drupalGet('/node/add/article');
    $this
      ->assertSession()
      ->fieldExists('title[0][value]')
      ->setValue('Referencing node 3');
    $open_iframe_link = $this
      ->assertSession()
      ->elementExists('css', 'a[data-drupal-selector="edit-field-entity-reference1-entity-browser-entity-browser-link"]');
    $open_iframe_link
      ->click();
    $this
      ->waitForAjaxToFinish();
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_test_entity_browser_iframe_node_view');
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:1]')
      ->check();
    $this
      ->assertSession()
      ->buttonExists('Select entities')
      ->press();
    $this
      ->getSession()
      ->wait(1000);
    $this
      ->getSession()
      ->switchToIFrame();
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->elementContains('css', '#edit-field-entity-reference1-wrapper', 'Alpaca');

    // All three buttons should be visible.
    $this
      ->assertSession()
      ->elementExists('css', 'input[data-drupal-selector="edit-field-entity-reference1-current-items-0-remove-button"]');
    $this
      ->assertSession()
      ->elementExists('css', 'input[data-drupal-selector="edit-field-entity-reference1-current-items-0-edit-button"]');
    $replace_button = $this
      ->assertSession()
      ->elementExists('css', 'input[data-drupal-selector="edit-field-entity-reference1-current-items-0-replace-button"]');

    // Clicking on the button should empty the selection and automatically
    // open the browser again.
    $replace_button
      ->click();
    $this
      ->waitForAjaxToFinish();
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_test_entity_browser_iframe_node_view');
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:2]')
      ->check();
    $this
      ->assertSession()
      ->buttonExists('Select entities')
      ->press();
    $this
      ->getSession()
      ->wait(1000);
    $this
      ->getSession()
      ->switchToIFrame();
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->elementContains('css', '#edit-field-entity-reference1-wrapper', 'Referencing node 1');

    // Verify that if the user cannot edit the entity, the "Edit" button does
    // not show up, even if configured to.

    /** @var \Drupal\user\RoleInterface $role */
    $role = Role::load('authenticated');
    $role
      ->revokePermission('bypass node access')
      ->trustData()
      ->save();
    $this
      ->drupalGet('node/add/article');
    $open_iframe_link = $this
      ->assertSession()
      ->elementExists('css', 'a[data-drupal-selector="edit-field-entity-reference1-entity-browser-entity-browser-link"]');
    $open_iframe_link
      ->click();
    $this
      ->waitForAjaxToFinish();
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_test_entity_browser_iframe_node_view');
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:1]')
      ->check();
    $this
      ->assertSession()
      ->buttonExists('Select entities')
      ->press();
    $this
      ->getSession()
      ->switchToIFrame();
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->buttonNotExists('edit-field-entity-reference1-current-items-0-edit-button');
  }

  /**
   * Tests that drag and drop functions properly.
   */
  public function testDragAndDrop() {
    $assert_session = $this
      ->assertSession();
    $time = time();
    $gatsby = $this
      ->createNode([
      'type' => 'shark',
      'title' => 'Gatsby',
      'created' => $time--,
    ]);
    $daisy = $this
      ->createNode([
      'type' => 'jet',
      'title' => 'Daisy',
      'created' => $time--,
    ]);
    $nick = $this
      ->createNode([
      'type' => 'article',
      'title' => 'Nick',
      'created' => $time--,
    ]);
    $santa = $this
      ->createNode([
      'type' => 'shark',
      'title' => 'Santa Claus',
      'created' => $time--,
    ]);
    $easter_bunny = $this
      ->createNode([
      'type' => 'jet',
      'title' => 'Easter Bunny',
      'created' => $time--,
    ]);
    $pumpkin_king = $this
      ->createNode([
      'type' => 'article',
      'title' => 'Pumpkin King',
      'created' => $time--,
    ]);
    $field1_storage_config = [
      'field_name' => 'field_east_egg',
      'type' => 'entity_reference',
      'entity_type' => 'node',
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
      'settings' => [
        'target_type' => 'node',
      ],
    ];
    $field2_storage_config = [
      'field_name' => 'field_east_egg2',
    ] + $field1_storage_config;
    $field_storage = FieldStorageConfig::create($field1_storage_config);
    $field_storage
      ->save();
    $field_storage2 = FieldStorageConfig::create($field2_storage_config);
    $field_storage2
      ->save();
    $field1_config = [
      'field_name' => 'field_east_egg',
      'entity_type' => 'node',
      'bundle' => 'article',
      'label' => 'East Eggers',
      'settings' => [
        'handler_settings' => [
          'target_bundles' => [
            'shark' => 'shark',
            'jet' => 'jet',
            'article' => 'article',
          ],
        ],
      ],
    ];
    $field2_config = [
      'field_name' => 'field_east_egg2',
      'label' => 'Easter Eggs',
    ] + $field1_config;
    $field = FieldConfig::create($field1_config);
    $field
      ->save();
    $field2 = FieldConfig::create($field2_config);
    $field2
      ->save();

    /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $form_display */
    $form_display = $this->container
      ->get('entity_type.manager')
      ->getStorage('entity_form_display')
      ->load('node.article.default');
    $form_display
      ->removeComponent('field_reference');
    $field_widget_config = [
      'type' => 'entity_browser_entity_reference',
      'settings' => [
        'entity_browser' => 'widget_context_default_value',
        'table_settings' => [
          'status_column' => TRUE,
          'bundle_column' => TRUE,
          'label_column' => FALSE,
        ],
        'open' => FALSE,
        'field_widget_edit' => TRUE,
        'field_widget_remove' => TRUE,
        'field_widget_replace' => FALSE,
        'selection_mode' => EntityBrowserElement::SELECTION_MODE_APPEND,
        'field_widget_display' => 'label',
        'field_widget_display_settings' => [],
      ],
    ];
    $form_display
      ->setComponent('field_east_egg', $field_widget_config)
      ->save();
    $form_display
      ->setComponent('field_east_egg2', $field_widget_config)
      ->save();

    // Set auto open to false on the entity browser.
    $entity_browser = $this->container
      ->get('entity_type.manager')
      ->getStorage('entity_browser')
      ->load('widget_context_default_value');
    $display_configuration = $entity_browser
      ->get('display_configuration');
    $display_configuration['auto_open'] = FALSE;
    $entity_browser
      ->set('display_configuration', $display_configuration);
    $entity_browser
      ->save();
    $account = $this
      ->drupalCreateUser([
      'access widget_context_default_value entity browser pages',
      'create article content',
      'access content',
    ]);
    $this
      ->drupalLogin($account);
    $this
      ->drupalGet('node/add/article');
    $this
      ->assertSession()
      ->elementExists('xpath', '(//summary)[1]')
      ->click();

    // Open the entity browser widget form.
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Select entities');
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_widget_context_default_value');
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:' . $gatsby
      ->id() . ']')
      ->check();
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:' . $daisy
      ->id() . ']')
      ->check();
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:' . $nick
      ->id() . ']')
      ->check();
    $this
      ->assertSession()
      ->buttonExists('Select entities')
      ->press();
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->buttonExists('Use selected')
      ->press();
    $this
      ->waitForAjaxToFinish();
    $this
      ->getSession()
      ->switchToIFrame();
    $this
      ->waitForAjaxToFinish();
    $correct_order = [
      1 => 'Gatsby',
      2 => 'Daisy',
      3 => 'Nick',
    ];
    foreach ($correct_order as $key => $value) {
      $this
        ->assertSession()
        ->elementContains('xpath', "(//div[contains(@class, 'item-container')])[" . $key . "]", $value);
    }

    // Close details 1.
    $this
      ->assertSession()
      ->elementExists('xpath', '(//summary)[1]')
      ->click();

    // Open details 2.
    $this
      ->assertSession()
      ->elementExists('xpath', '(//summary)[2]')
      ->click();

    // Open the entity browser widget form.
    $this
      ->assertSession()
      ->elementExists('xpath', "(//a[contains(text(), 'Select entities')])[2]")
      ->click();
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_widget_context_default_value');
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:' . $santa
      ->id() . ']')
      ->check();
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:' . $easter_bunny
      ->id() . ']')
      ->check();
    $this
      ->assertSession()
      ->fieldExists('entity_browser_select[node:' . $pumpkin_king
      ->id() . ']')
      ->check();
    $this
      ->assertSession()
      ->buttonExists('Select entities')
      ->press();
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->buttonExists('Use selected')
      ->press();
    $this
      ->waitForAjaxToFinish();
    $this
      ->getSession()
      ->switchToIFrame();
    $this
      ->waitForAjaxToFinish();

    // Close details 2.
    $this
      ->assertSession()
      ->elementExists('xpath', '(//summary)[2]')
      ->click();

    // Open details 1.
    $this
      ->assertSession()
      ->elementExists('xpath', '(//summary)[1]')
      ->click();

    // In the first set of selections, drag the first item into the second
    // position.
    $list_selector = '[data-drupal-selector="edit-field-east-egg-current"]';
    $item_selector = "{$list_selector} .item-container";
    $assert_session
      ->elementsCount('css', $item_selector, 3);
    $this
      ->sortableAfter("{$item_selector}:first-child", "{$item_selector}:nth-child(2)", $list_selector);
    $this
      ->waitForAjaxToFinish();
    $this
      ->assertSession()
      ->fieldExists('title[0][value]')
      ->setValue('Hello World');
    $this
      ->assertSession()
      ->buttonExists('Save')
      ->press();
    $this
      ->drupalGet('node/7/edit');
    $correct_order = [
      1 => 'Daisy',
      2 => 'Gatsby',
      3 => 'Nick',
      4 => 'Santa Claus',
      5 => 'Easter Bunny',
      6 => 'Pumpkin King',
    ];
    foreach ($correct_order as $key => $value) {
      $this
        ->assertSession()
        ->elementContains('xpath', "(//div[contains(@class, 'item-container')])[" . $key . "]", $value);
    }

    // In the second set of selections, drag the first item into the second
    // position.
    $list_selector = '[data-drupal-selector="edit-field-east-egg2-current"]';
    $item_selector = "{$list_selector} .item-container";
    $assert_session
      ->elementsCount('css', $item_selector, 3);
    $this
      ->sortableAfter("{$item_selector}:first-child", "{$item_selector}:nth-child(2)", $list_selector);
    $correct_order = [
      4 => 'Easter Bunny',
      5 => 'Santa Claus',
      6 => 'Pumpkin King',
    ];
    foreach ($correct_order as $key => $value) {
      $this
        ->assertSession()
        ->elementContains('xpath', "(//div[contains(@class, 'item-container')])[" . $key . "]", $value);
    }

    // Test that order is preserved after removing item.
    $this
      ->assertSession()
      ->elementExists('xpath', '(//input[contains(@class, "remove-button")])[5]')
      ->press();
    $this
      ->waitForAjaxToFinish();
    $correct_order = [
      4 => 'Easter Bunny',
      5 => 'Pumpkin King',
    ];
    foreach ($correct_order as $key => $value) {
      $this
        ->assertSession()
        ->elementContains('xpath', "(//div[contains(@class, 'item-container')])[" . $key . "]", $value);
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function sortableUpdate($item, $from, $to = NULL) {
    list($container) = explode(' ', $item, 2);
    $js = <<<END
Drupal.entityBrowserEntityReference.entitiesReordered(document.querySelector("{<span class="php-variable">$container</span>}"));
END;
    $this
      ->getSession()
      ->executeScript($js);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
EntityBrowserWebDriverTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme 2
EntityBrowserWebDriverTestBase::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules 5
EntityBrowserWebDriverTestBase::$userPermissions protected static property Permissions for user that will be logged-in for test. 2
EntityBrowserWebDriverTestBase::assertCheckboxExistsByValue protected function Checks that a specific checkbox input element exists on the current page.
EntityBrowserWebDriverTestBase::assertCheckboxNotExistsByValue protected function Checks that a specific checkbox input element does not exist on the current page.
EntityBrowserWebDriverTestBase::assertRadioExistsByValue protected function Checks that a specific radio input element exists on the current page.
EntityBrowserWebDriverTestBase::assertRadioNotExistsByValue protected function Checks that a specific radio input element does not exist on the current page.
EntityBrowserWebDriverTestBase::createFile protected function Creates an image.
EntityBrowserWebDriverTestBase::dragDropElement protected function Drag element in document with defined offset position.
EntityBrowserWebDriverTestBase::getEntityBrowser protected function Return an entity browser if it exists or creates a new one.
EntityBrowserWebDriverTestBase::waitForAjaxToFinish protected function Waits for jQuery to become ready and animations to complete.
EntityReferenceWidgetTest::setUp public function Overrides EntityBrowserWebDriverTestBase::setUp
EntityReferenceWidgetTest::sortableUpdate protected function Define to provide any necessary callback following layout change. Overrides SortableTestTrait::sortableUpdate
EntityReferenceWidgetTest::testDragAndDrop public function Tests that drag and drop functions properly.
EntityReferenceWidgetTest::testEntityReferenceWidget public function Tests Entity Reference widget.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
SortableTestTrait::sortableAfter protected function Simulates a drag moving an element after its sibling in the same container.
SortableTestTrait::sortableTo protected function Simulates a drag on an element from one container to another.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$minkDefaultDriverClass protected property To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase::$minkDefaultDriverClass 2
WebDriverTestBase::assertElementNotVisible Deprecated protected function Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated protected function Asserts that the element with the given CSS selector is visible.
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession 1
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink 1
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.