You are here

class EntityReferenceWidgetTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/media_library/tests/src/FunctionalJavascript/EntityReferenceWidgetTest.php \Drupal\Tests\media_library\FunctionalJavascript\EntityReferenceWidgetTest
  2. 10 core/modules/media_library/tests/src/FunctionalJavascript/EntityReferenceWidgetTest.php \Drupal\Tests\media_library\FunctionalJavascript\EntityReferenceWidgetTest

Tests the Media library entity reference widget.

@group media_library

Hierarchy

Expanded class hierarchy of EntityReferenceWidgetTest

File

core/modules/media_library/tests/src/FunctionalJavascript/EntityReferenceWidgetTest.php, line 12

Namespace

Drupal\Tests\media_library\FunctionalJavascript
View source
class EntityReferenceWidgetTest extends MediaLibraryTestBase {

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

  /**
   * Test media items.
   *
   * @var \Drupal\media\MediaInterface[]
   */
  protected $mediaItems = [];

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

    // Create a few example media items for use in selection.
    $this->mediaItems = $this
      ->createMediaItems([
      'type_one' => [
        'Horse',
        'Bear',
        'Cat',
        'Dog',
      ],
      'type_two' => [
        'Crocodile',
        'Lizard',
        'Snake',
        'Turtle',
      ],
    ]);

    // Create a user who can use the Media library.
    $user = $this
      ->drupalCreateUser([
      'access content',
      'create basic_page content',
      'edit own basic_page content',
      'view media',
      'create media',
      'administer node form display',
    ]);
    $this
      ->drupalLogin($user);
  }

  /**
   * Tests that disabled media items don't capture focus on page load.
   */
  public function testFocusNotAppliedWithoutSelectionChange() {

    // Create a node with the maximum number of values for the field_twin_media
    // field.
    $node = $this
      ->drupalCreateNode([
      'type' => 'basic_page',
      'field_twin_media' => [
        $this->mediaItems['Horse'],
        $this->mediaItems['Bear'],
      ],
    ]);
    $this
      ->drupalGet($node
      ->toUrl('edit-form'));
    $open_button = $this
      ->assertElementExistsAfterWait('css', '.js-media-library-open-button[name^="field_twin_media"]');

    // The open button should be disabled, but not have the
    // 'data-disabled-focus' attribute.
    $this
      ->assertFalse($open_button
      ->hasAttribute('data-disabled-focus'));
    $this
      ->assertTrue($open_button
      ->hasAttribute('disabled'));

    // The button should be disabled.
    $this
      ->assertJsCondition('jQuery("#field_twin_media-media-library-wrapper .js-media-library-open-button").is(":disabled")');

    // The button should not have focus.
    $this
      ->assertJsCondition('jQuery("#field_twin_media-media-library-wrapper .js-media-library-open-button").not(":focus")');
  }

  /**
   * Tests that the Media library's widget works as expected.
   */
  public function testWidget() {
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();

    // Visit a node create page.
    $this
      ->drupalGet('node/add/basic_page');

    // Assert that media widget instances are present.
    $assert_session
      ->pageTextContains('Unlimited media');
    $assert_session
      ->pageTextContains('Twin media');
    $assert_session
      ->pageTextContains('Single media type');
    $assert_session
      ->pageTextContains('Empty types media');

    // Assert generic media library elements.
    $this
      ->openMediaLibraryForField('field_unlimited_media');
    $assert_session
      ->elementExists('css', '.ui-dialog-titlebar-close')
      ->click();

    // Assert that the media type menu is available when more than 1 type is
    // configured for the field.
    $menu = $this
      ->openMediaLibraryForField('field_unlimited_media');
    $this
      ->assertTrue($menu
      ->hasLink('Show Type One media (selected)'));
    $this
      ->assertFalse($menu
      ->hasLink('Type Two'));
    $this
      ->assertTrue($menu
      ->hasLink('Type Three'));
    $this
      ->assertFalse($menu
      ->hasLink('Type Four'));
    $this
      ->switchToMediaType('Three');

    // Assert the active tab is set correctly.
    $this
      ->assertFalse($menu
      ->hasLink('Show Type One media (selected)'));
    $this
      ->assertTrue($menu
      ->hasLink('Show Type Three media (selected)'));

    // Assert the focus is set to the first tabbable element when a vertical tab
    // is clicked.
    $this
      ->assertJsCondition('jQuery(tabbable.tabbable(document.getElementById("media-library-content"))[0]).is(":focus")');
    $assert_session
      ->elementExists('css', '.ui-dialog-titlebar-close')
      ->click();

    // Assert that there are no links in the media library view.
    $this
      ->openMediaLibraryForField('field_unlimited_media');
    $assert_session
      ->elementNotExists('css', '.media-library-item__name a');
    $assert_session
      ->elementNotExists('css', '.view-media-library .media-library-item__edit');
    $assert_session
      ->elementNotExists('css', '.view-media-library .media-library-item__remove');
    $assert_session
      ->elementExists('css', '.ui-dialog-titlebar-close')
      ->click();

    // Assert that the media type menu is available when the target_bundles
    // setting for the entity reference field is null. All types should be
    // allowed in this case.
    $menu = $this
      ->openMediaLibraryForField('field_null_types_media');

    // Assert that the button to open the media library does not submit the
    // parent form. We can do this by checking if the validation of the parent
    // form is not triggered.
    $assert_session
      ->pageTextNotContains('Title field is required.');
    $this
      ->assertTrue($menu
      ->hasLink('Type One'));
    $this
      ->assertTrue($menu
      ->hasLink('Type Two'));
    $this
      ->assertTrue($menu
      ->hasLink('Type Three'));
    $this
      ->assertTrue($menu
      ->hasLink('Type Four'));
    $this
      ->assertTrue($menu
      ->hasLink('Type Five'));
    $assert_session
      ->elementExists('css', '.ui-dialog-titlebar-close')
      ->click();

    // Assert that the media type menu is not available when only 1 type is
    // configured for the field.
    $this
      ->openMediaLibraryForField('field_single_media_type', '#media-library-wrapper');
    $this
      ->waitForElementTextContains('.media-library-selected-count', '0 of 1 item selected');

    // Select a media item, assert the hidden selection field contains the ID of
    // the selected item.
    $this
      ->selectMediaItem(0);
    $assert_session
      ->hiddenFieldValueEquals('media-library-modal-selection', '4');
    $this
      ->assertSelectedMediaCount('1 of 1 item selected');
    $assert_session
      ->elementNotExists('css', '.js-media-library-menu');
    $assert_session
      ->elementExists('css', '.ui-dialog-titlebar-close')
      ->click();

    // Assert the menu links can be sorted through the widget configuration.
    $this
      ->openMediaLibraryForField('field_twin_media');
    $links = $this
      ->getTypesMenu()
      ->findAll('css', 'a');
    $link_titles = [];
    foreach ($links as $link) {
      $link_titles[] = $link
        ->getText();
    }
    $expected_link_titles = [
      'Show Type Three media (selected)',
      'Show Type One media',
      'Show Type Two media',
      'Show Type Four media',
    ];
    $this
      ->assertSame($link_titles, $expected_link_titles);
    $this
      ->drupalGet('admin/structure/types/manage/basic_page/form-display');

    // Ensure that the widget settings form is not displayed when only
    // one media type is allowed.
    $assert_session
      ->pageTextContains('Single media type');
    $assert_session
      ->buttonNotExists('field_single_media_type_settings_edit');
    $assert_session
      ->buttonExists('field_twin_media_settings_edit')
      ->press();
    $this
      ->assertElementExistsAfterWait('css', '#field-twin-media .tabledrag-toggle-weight')
      ->press();
    $assert_session
      ->fieldExists('fields[field_twin_media][settings_edit_form][settings][media_types][type_one][weight]')
      ->selectOption(0);
    $assert_session
      ->fieldExists('fields[field_twin_media][settings_edit_form][settings][media_types][type_three][weight]')
      ->selectOption(1);
    $assert_session
      ->fieldExists('fields[field_twin_media][settings_edit_form][settings][media_types][type_four][weight]')
      ->selectOption(2);
    $assert_session
      ->fieldExists('fields[field_twin_media][settings_edit_form][settings][media_types][type_two][weight]')
      ->selectOption(3);
    $assert_session
      ->buttonExists('Save')
      ->press();
    $this
      ->drupalGet('node/add/basic_page');
    $this
      ->openMediaLibraryForField('field_twin_media');
    $link_titles = array_map(function ($link) {
      return $link
        ->getText();
    }, $links);
    $this
      ->assertSame($link_titles, [
      'Show Type One media (selected)',
      'Show Type Three media',
      'Show Type Four media',
      'Show Type Two media',
    ]);
    $assert_session
      ->elementExists('css', '.ui-dialog-titlebar-close')
      ->click();

    // Assert the announcements for media type navigation in the media library.
    $this
      ->openMediaLibraryForField('field_unlimited_media');
    $this
      ->switchToMediaType('Three');
    $this
      ->assertNotEmpty($assert_session
      ->waitForText('Showing Type Three media.'));
    $this
      ->switchToMediaType('One');
    $this
      ->assertNotEmpty($assert_session
      ->waitForText('Showing Type One media.'));

    // Assert the links can be triggered by via the spacebar.
    $assert_session
      ->elementExists('named', [
      'link',
      'Type Three',
    ])
      ->keyPress(32);
    $this
      ->waitForText('Showing Type Three media.');
    $assert_session
      ->elementExists('css', '.ui-dialog-titlebar-close')
      ->click();

    // Assert media is only visible on the tab for the related media type.
    $this
      ->openMediaLibraryForField('field_unlimited_media');
    $assert_session
      ->pageTextContains('Dog');
    $assert_session
      ->pageTextContains('Bear');
    $assert_session
      ->pageTextNotContains('Turtle');
    $this
      ->switchToMediaType('Three');
    $this
      ->assertNotEmpty($assert_session
      ->waitForText('Showing Type Three media.'));
    $assert_session
      ->elementExists('named', [
      'link',
      'Show Type Three media (selected)',
    ]);
    $assert_session
      ->pageTextNotContains('Dog');
    $assert_session
      ->pageTextNotContains('Bear');
    $assert_session
      ->pageTextNotContains('Turtle');
    $assert_session
      ->elementExists('css', '.ui-dialog-titlebar-close')
      ->click();

    // Assert the exposed name filter of the view.
    $this
      ->openMediaLibraryForField('field_unlimited_media');
    $session = $this
      ->getSession();
    $session
      ->getPage()
      ->fillField('Name', 'Dog');
    $session
      ->getPage()
      ->pressButton('Apply filters');
    $this
      ->waitForText('Dog');
    $this
      ->waitForNoText('Bear');
    $session
      ->getPage()
      ->fillField('Name', '');
    $session
      ->getPage()
      ->pressButton('Apply filters');
    $this
      ->waitForText('Dog');
    $this
      ->waitForText('Bear');
    $assert_session
      ->elementExists('css', '.ui-dialog-titlebar-close')
      ->click();

    // Assert adding a single media item and removing it.
    $this
      ->openMediaLibraryForField('field_twin_media');
    $this
      ->selectMediaItem(0);
    $this
      ->pressInsertSelected('Added one media item.');

    // Assert the focus is set back on the open button of the media field.
    $this
      ->assertJsCondition('jQuery("#field_twin_media-media-library-wrapper .js-media-library-open-button").is(":focus")');

    // The toggle for weight inputs' visibility should not be available when the
    // field contains a single item.
    $wrapper = $assert_session
      ->elementExists('css', '.field--name-field-twin-media');
    $assert_session
      ->elementNotExists('named', [
      'button',
      'Show media item weights',
    ], $wrapper);

    // Remove the selected item.
    $button = $assert_session
      ->buttonExists('Remove', $wrapper);
    $this
      ->assertSame('Remove Dog', $button
      ->getAttribute('aria-label'));
    $button
      ->press();
    $this
      ->waitForText('Dog has been removed.');

    // Assert the focus is set back on the open button of the media field.
    $this
      ->assertJsCondition('jQuery("#field_twin_media-media-library-wrapper .js-media-library-open-button").is(":focus")');

    // Assert we can select the same media item twice.
    $this
      ->openMediaLibraryForField('field_twin_media');
    $page
      ->checkField('Select Dog');
    $this
      ->pressInsertSelected('Added one media item.');
    $this
      ->openMediaLibraryForField('field_twin_media');
    $page
      ->checkField('Select Dog');
    $this
      ->pressInsertSelected('Added one media item.');

    // Assert that we can toggle the visibility of the weight inputs when the
    // field contains more than one item.
    $wrapper = $assert_session
      ->elementExists('css', '.field--name-field-twin-media');
    $wrapper
      ->pressButton('Show media item weights');

    // Ensure that the styling doesn't accidentally render the weight field
    // unusable.
    $assert_session
      ->fieldExists('Weight', $wrapper)
      ->click();
    $wrapper
      ->pressButton('Hide media item weights');

    // Assert the same has been added twice and remove the items again.
    $this
      ->waitForElementsCount('css', '.field--name-field-twin-media [data-media-library-item-delta]', 2);
    $assert_session
      ->hiddenFieldValueEquals('field_twin_media[selection][0][target_id]', 4);
    $assert_session
      ->hiddenFieldValueEquals('field_twin_media[selection][1][target_id]', 4);
    $wrapper
      ->pressButton('Remove');
    $this
      ->waitForText('Dog has been removed.');
    $wrapper
      ->pressButton('Remove');
    $this
      ->waitForText('Dog has been removed.');
    $result = $wrapper
      ->waitFor(10, function ($wrapper) {

      /** @var \Behat\Mink\Element\NodeElement $wrapper */
      return $wrapper
        ->findButton('Remove') == NULL;
    });
    $this
      ->assertTrue($result);

    // Assert the selection is persistent in the media library modal, and
    // the number of selected items is displayed correctly.
    $this
      ->openMediaLibraryForField('field_twin_media');

    // Assert the number of selected items is displayed correctly.
    $this
      ->assertSelectedMediaCount('0 of 2 items selected');

    // Select a media item, assert the hidden selection field contains the ID of
    // the selected item.
    $checkboxes = $this
      ->getCheckboxes();
    $this
      ->assertCount(4, $checkboxes);
    $this
      ->selectMediaItem(0, '1 of 2 items selected');
    $assert_session
      ->hiddenFieldValueEquals('media-library-modal-selection', '4');

    // Select another item and assert the number of selected items is updated.
    $this
      ->selectMediaItem(1, '2 of 2 items selected');
    $assert_session
      ->hiddenFieldValueEquals('media-library-modal-selection', '4,3');

    // Assert unselected items are disabled when the maximum allowed items are
    // selected (cardinality for this field is 2).
    $this
      ->assertTrue($checkboxes[2]
      ->hasAttribute('disabled'));
    $this
      ->assertTrue($checkboxes[3]
      ->hasAttribute('disabled'));

    // Assert the selected items are updated when deselecting an item.
    $checkboxes[0]
      ->click();
    $this
      ->assertSelectedMediaCount('1 of 2 items selected');
    $assert_session
      ->hiddenFieldValueEquals('media-library-modal-selection', '3');

    // Assert deselected items are available again.
    $this
      ->assertFalse($checkboxes[2]
      ->hasAttribute('disabled'));
    $this
      ->assertFalse($checkboxes[3]
      ->hasAttribute('disabled'));

    // The selection should be persisted when navigating to other media types in
    // the modal.
    $this
      ->switchToMediaType('Three');
    $this
      ->switchToMediaType('One');
    $selected_checkboxes = [];
    foreach ($this
      ->getCheckboxes() as $checkbox) {
      if ($checkbox
        ->isChecked()) {
        $selected_checkboxes[] = $checkbox
          ->getValue();
      }
    }
    $this
      ->assertCount(1, $selected_checkboxes);
    $assert_session
      ->hiddenFieldValueEquals('media-library-modal-selection', implode(',', $selected_checkboxes));
    $this
      ->assertSelectedMediaCount('1 of 2 items selected');

    // Add to selection from another type.
    $this
      ->switchToMediaType('Two');
    $checkboxes = $this
      ->getCheckboxes();
    $this
      ->assertCount(4, $checkboxes);
    $this
      ->selectMediaItem(0, '2 of 2 items selected');
    $assert_session
      ->hiddenFieldValueEquals('media-library-modal-selection', '3,8');

    // Assert unselected items are disabled when the maximum allowed items are
    // selected (cardinality for this field is 2).
    $this
      ->assertFalse($checkboxes[0]
      ->hasAttribute('disabled'));
    $this
      ->assertTrue($checkboxes[1]
      ->hasAttribute('disabled'));
    $this
      ->assertTrue($checkboxes[2]
      ->hasAttribute('disabled'));
    $this
      ->assertTrue($checkboxes[3]
      ->hasAttribute('disabled'));

    // Assert the checkboxes are also disabled on other pages.
    $this
      ->switchToMediaType('One');
    $this
      ->assertTrue($checkboxes[0]
      ->hasAttribute('disabled'));
    $this
      ->assertFalse($checkboxes[1]
      ->hasAttribute('disabled'));
    $this
      ->assertTrue($checkboxes[2]
      ->hasAttribute('disabled'));
    $this
      ->assertTrue($checkboxes[3]
      ->hasAttribute('disabled'));

    // Select the items.
    $this
      ->pressInsertSelected('Added 2 media items.');

    // Assert the open button is disabled.
    $open_button = $this
      ->assertElementExistsAfterWait('css', '.js-media-library-open-button[name^="field_twin_media"]');
    $this
      ->assertTrue($open_button
      ->hasAttribute('data-disabled-focus'));
    $this
      ->assertTrue($open_button
      ->hasAttribute('disabled'));
    $this
      ->assertJsCondition('jQuery("#field_twin_media-media-library-wrapper .js-media-library-open-button").is(":disabled")');

    // Ensure that the selection completed successfully.
    $assert_session
      ->pageTextNotContains('Add or select media');
    $assert_session
      ->elementTextNotContains('css', '#field_twin_media-media-library-wrapper', 'Dog');
    $assert_session
      ->elementTextContains('css', '#field_twin_media-media-library-wrapper', 'Cat');
    $assert_session
      ->elementTextContains('css', '#field_twin_media-media-library-wrapper', 'Turtle');
    $assert_session
      ->elementTextNotContains('css', '#field_twin_media-media-library-wrapper', 'Snake');

    // Remove "Cat" (happens to be the first remove button on the page).
    $button = $assert_session
      ->buttonExists('Remove', $wrapper);
    $this
      ->assertSame('Remove Cat', $button
      ->getAttribute('aria-label'));
    $button
      ->press();
    $this
      ->waitForText('Cat has been removed.');

    // Assert the focus is set to the wrapper of the other selected item.
    $this
      ->assertJsCondition('jQuery("#field_twin_media-media-library-wrapper [data-media-library-item-delta]").is(":focus")');
    $assert_session
      ->elementTextNotContains('css', '#field_twin_media-media-library-wrapper', 'Cat');
    $assert_session
      ->elementTextContains('css', '#field_twin_media-media-library-wrapper', 'Turtle');

    // Assert the open button is no longer disabled.
    $open_button = $assert_session
      ->elementExists('css', '.js-media-library-open-button[name^="field_twin_media"]');
    $this
      ->assertFalse($open_button
      ->hasAttribute('data-disabled-focus'));
    $this
      ->assertFalse($open_button
      ->hasAttribute('disabled'));
    $this
      ->assertJsCondition('jQuery("#field_twin_media-media-library-wrapper .js-media-library-open-button").is(":not(:disabled)")');

    // Open the media library again and select another item.
    $this
      ->openMediaLibraryForField('field_twin_media');
    $this
      ->selectMediaItem(0);
    $this
      ->pressInsertSelected('Added one media item.');
    $this
      ->waitForElementTextContains('#field_twin_media-media-library-wrapper', 'Dog');
    $assert_session
      ->elementTextNotContains('css', '#field_twin_media-media-library-wrapper', 'Cat');
    $assert_session
      ->elementTextContains('css', '#field_twin_media-media-library-wrapper', 'Turtle');
    $assert_session
      ->elementTextNotContains('css', '#field_twin_media-media-library-wrapper', 'Snake');

    // Assert the open button is disabled.
    $this
      ->assertTrue($assert_session
      ->elementExists('css', '.js-media-library-open-button[name^="field_twin_media"]')
      ->hasAttribute('data-disabled-focus'));
    $this
      ->assertTrue($assert_session
      ->elementExists('css', '.js-media-library-open-button[name^="field_twin_media"]')
      ->hasAttribute('disabled'));
    $this
      ->assertJsCondition('jQuery("#field_twin_media-media-library-wrapper .js-media-library-open-button").is(":disabled")');

    // Assert the selection is cleared when the modal is closed.
    $this
      ->openMediaLibraryForField('field_unlimited_media');
    $checkboxes = $this
      ->getCheckboxes();
    $this
      ->assertGreaterThanOrEqual(4, count($checkboxes));

    // Nothing is selected yet.
    $this
      ->assertFalse($checkboxes[0]
      ->isChecked());
    $this
      ->assertFalse($checkboxes[1]
      ->isChecked());
    $this
      ->assertFalse($checkboxes[2]
      ->isChecked());
    $this
      ->assertFalse($checkboxes[3]
      ->isChecked());
    $this
      ->assertSelectedMediaCount('0 items selected');

    // Select the first 2 items.
    $checkboxes[0]
      ->click();
    $this
      ->assertSelectedMediaCount('1 item selected');
    $checkboxes[1]
      ->click();
    $this
      ->assertSelectedMediaCount('2 items selected');
    $this
      ->assertTrue($checkboxes[0]
      ->isChecked());
    $this
      ->assertTrue($checkboxes[1]
      ->isChecked());
    $this
      ->assertFalse($checkboxes[2]
      ->isChecked());
    $this
      ->assertFalse($checkboxes[3]
      ->isChecked());

    // Close the dialog, reopen it and assert not is selected again.
    $assert_session
      ->elementExists('css', '.ui-dialog-titlebar-close')
      ->click();
    $this
      ->openMediaLibraryForField('field_unlimited_media');
    $checkboxes = $this
      ->getCheckboxes();
    $this
      ->assertGreaterThanOrEqual(4, count($checkboxes));
    $this
      ->assertFalse($checkboxes[0]
      ->isChecked());
    $this
      ->assertFalse($checkboxes[1]
      ->isChecked());
    $this
      ->assertFalse($checkboxes[2]
      ->isChecked());
    $this
      ->assertFalse($checkboxes[3]
      ->isChecked());
    $assert_session
      ->elementExists('css', '.ui-dialog-titlebar-close')
      ->click();

    // Finally, save the form.
    $assert_session
      ->elementExists('css', '.js-media-library-widget-toggle-weight')
      ->click();
    $this
      ->submitForm([
      'title[0][value]' => 'My page',
      'field_twin_media[selection][0][weight]' => '3',
    ], 'Save');
    $assert_session
      ->pageTextContains('Basic Page My page has been created');

    // We removed this item earlier.
    $assert_session
      ->pageTextNotContains('Cat');

    // This item was never selected.
    $assert_session
      ->pageTextNotContains('Snake');

    // "Turtle" should come after "Dog", since we changed the weight.
    $assert_session
      ->elementExists('css', '.field--name-field-twin-media > .field__items > .field__item:last-child:contains("Turtle")');

    // Make sure everything that was selected shows up.
    $assert_session
      ->pageTextContains('Dog');
    $assert_session
      ->pageTextContains('Turtle');

    // Re-edit the content and make a new selection.
    $this
      ->drupalGet('node/1/edit');
    $assert_session
      ->pageTextContains('Dog');
    $assert_session
      ->pageTextNotContains('Cat');
    $assert_session
      ->pageTextNotContains('Bear');
    $assert_session
      ->pageTextNotContains('Horse');
    $assert_session
      ->pageTextContains('Turtle');
    $assert_session
      ->pageTextNotContains('Snake');
    $this
      ->openMediaLibraryForField('field_unlimited_media');

    // Select all media items of type one (should also contain Dog, again).
    $this
      ->selectMediaItem(0);
    $this
      ->selectMediaItem(1);
    $this
      ->selectMediaItem(2);
    $this
      ->selectMediaItem(3);
    $this
      ->pressInsertSelected('Added 4 media items.');
    $this
      ->waitForText('Dog');
    $assert_session
      ->pageTextContains('Cat');
    $assert_session
      ->pageTextContains('Bear');
    $assert_session
      ->pageTextContains('Horse');
    $assert_session
      ->pageTextContains('Turtle');
    $assert_session
      ->pageTextNotContains('Snake');
    $this
      ->submitForm([], 'Save');
    $assert_session
      ->pageTextContains('Dog');
    $assert_session
      ->pageTextContains('Cat');
    $assert_session
      ->pageTextContains('Bear');
    $assert_session
      ->pageTextContains('Horse');
    $assert_session
      ->pageTextContains('Turtle');
    $assert_session
      ->pageTextNotContains('Snake');
  }

  /**
   * Tests saving a required media library field.
   */
  public function testRequiredMediaField() {
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();

    // Make field_unlimited_media required.
    $field_config = FieldConfig::loadByName('node', 'basic_page', 'field_unlimited_media');
    $field_config
      ->setRequired(TRUE)
      ->save();
    $this
      ->drupalGet('node/add/basic_page');
    $page
      ->fillField('Title', 'My page');
    $page
      ->pressButton('Save');

    // Check that a clear error message is shown.
    $assert_session
      ->pageTextNotContains('This value should not be null.');
    $assert_session
      ->pageTextContains(sprintf('%s field is required.', $field_config
      ->label()));

    // Open the media library, select an item and save the node.
    $this
      ->openMediaLibraryForField('field_unlimited_media');
    $this
      ->selectMediaItem(0);
    $this
      ->pressInsertSelected('Added one media item.');
    $page
      ->pressButton('Save');

    // Confirm that the node was created.
    $this
      ->assertSession()
      ->pageTextContains('Basic page My page has been created.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated 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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
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 Mink default driver params.
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::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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::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::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
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
EntityReferenceWidgetTest::$mediaItems protected property Test media items.
EntityReferenceWidgetTest::$modules protected static property Modules to enable. Overrides MediaLibraryTestBase::$modules
EntityReferenceWidgetTest::setUp protected function Overrides BrowserTestBase::setUp
EntityReferenceWidgetTest::testFocusNotAppliedWithoutSelectionChange public function Tests that disabled media items don't capture focus on page load.
EntityReferenceWidgetTest::testRequiredMediaField public function Tests saving a required media library field.
EntityReferenceWidgetTest::testWidget public function Tests that the Media library's widget works as expected.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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::$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. 1
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. 20
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. 1
MediaLibraryTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
MediaLibraryTestBase::addMediaFileToField public function Waits for a file field to exist before uploading.
MediaLibraryTestBase::assertElementExistsAfterWait protected function Waits for the specified selector and returns it if not empty.
MediaLibraryTestBase::assertMediaAdded protected function Asserts a media item was added, but not yet saved.
MediaLibraryTestBase::assertMediaLibraryGrid protected function Asserts that the grid display of the widget view is visible.
MediaLibraryTestBase::assertMediaLibraryTable protected function Asserts that the table display of the widget view is visible.
MediaLibraryTestBase::assertNoMediaAdded protected function Asserts that media was not added, i.e. due to a validation error.
MediaLibraryTestBase::assertSelectedMediaCount protected function Asserts the current text of the selected item counter.
MediaLibraryTestBase::createMediaItems protected function Create media items.
MediaLibraryTestBase::getCheckboxes protected function Gets all available media item checkboxes.
MediaLibraryTestBase::getSelectionArea protected function Gets the "Additional selected media" area after adding new media.
MediaLibraryTestBase::getTypesMenu protected function Gets the menu of available media types.
MediaLibraryTestBase::openMediaLibraryForField protected function Clicks a button that opens a media widget and confirms it is open.
MediaLibraryTestBase::pressInsertSelected protected function Presses the modal's "Insert selected" button.
MediaLibraryTestBase::pressSaveButton protected function Clicks "Save" button and waits for AJAX completion.
MediaLibraryTestBase::saveAnd protected function Clicks "Save and select||insert" button and waits for AJAX completion.
MediaLibraryTestBase::selectMediaItem protected function Selects an item in the media library modal.
MediaLibraryTestBase::switchToMediaLibraryGrid protected function Switches to the grid display of the widget view.
MediaLibraryTestBase::switchToMediaLibraryTable protected function Switches to the table display of the widget view.
MediaLibraryTestBase::switchToMediaType protected function Clicks a media type tab and waits for it to appear.
MediaLibraryTestBase::waitForElementsCount protected function Checks for a specified number of specific elements on page after wait.
MediaLibraryTestBase::waitForElementTextContains protected function Asserts that text appears in an element after a wait.
MediaLibraryTestBase::waitForFieldExists protected function Checks for the existence of a field on page after wait.
MediaLibraryTestBase::waitForNoText protected function Asserts that text does not appear on page after a wait.
MediaLibraryTestBase::waitForText protected function Asserts that text appears on page after a wait.
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
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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. 1
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.
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. 1
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. 1
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 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 2
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 Deprecated 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::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
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::$failOnJavascriptConsoleErrors protected property Determines if a test should fail on JavaScript console errors. 3
WebDriverTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. Overrides BrowserTestBase::$minkDefaultDriverClass 1
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
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
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.