class WidgetOverflowTest

Same name in other branches
  1. 11.x core/modules/media_library/tests/src/FunctionalJavascript/WidgetOverflowTest.php \Drupal\Tests\media_library\FunctionalJavascript\WidgetOverflowTest

Tests that uploads in the 'media_library_widget' works as expected.

@group media_library

@todo This test will occasionally fail with SQLite until https://www.drupal.org/node/3066447 is addressed.

Hierarchy

Expanded class hierarchy of WidgetOverflowTest

File

core/modules/media_library/tests/src/FunctionalJavascript/WidgetOverflowTest.php, line 17

Namespace

Drupal\Tests\media_library\FunctionalJavascript
View source
class WidgetOverflowTest extends MediaLibraryTestBase {
    use TestFileCreationTrait;
    
    /**
     * The test image file.
     *
     * @var \Drupal\file\Entity\File
     */
    protected $image;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        foreach ($this->getTestFiles('image') as $image) {
            $extension = pathinfo($image->filename, PATHINFO_EXTENSION);
            if ($extension === 'png') {
                $this->image = $image;
            }
        }
        if (!isset($this->image)) {
            $this->fail('Expected test files not present.');
        }
        // Create a user that can only add media of type four.
        $user = $this->drupalCreateUser([
            'access administration pages',
            'access content',
            'create basic_page content',
            'create type_one media',
            'create type_three media',
            'view media',
        ]);
        $this->drupalLogin($user);
    }
    
    /**
     * Uploads multiple test images into the media library.
     *
     * @param int $number
     *   The number of images to upload.
     */
    private function uploadFiles(int $number) : void {
        
        /** @var \Drupal\Core\File\FileSystemInterface $file_system */
        $file_system = $this->container
            ->get('file_system');
        // Create a list of new files to upload.
        $filenames = $remote_paths = [];
        for ($i = 0; $i < $number; $i++) {
            $path = $file_system->copy($this->image->uri, 'public://');
            $path = $file_system->realpath($path);
            $this->assertNotEmpty($path);
            $this->assertFileExists($path);
            $filenames[] = $file_system->basename($path);
            $remote_paths[] = $this->getSession()
                ->getDriver()
                ->uploadFileAndGetRemoteFilePath($path);
        }
        $page = $this->getSession()
            ->getPage();
        $page->fillField('Add files', implode("\n", $remote_paths));
        $this->assertMediaAdded();
        $assert_session = $this->assertSession();
        foreach ($filenames as $i => $filename) {
            $assert_session->fieldValueEquals("media[{$i}][fields][name][0][value]", $filename);
            $page->fillField("media[{$i}][fields][field_media_test_image][0][alt]", $filename);
        }
    }
    
    /**
     * Tests that the Media Library constrains the number of selected items.
     *
     * @param string|null $selected_operation
     *   The operation of the button to click. For example, if this is "insert",
     *   the "Save and insert" button will be pressed. If NULL, the "Save" button
     *   will be pressed.
     *
     * @dataProvider providerWidgetOverflow
     */
    public function testWidgetOverflow(?string $selected_operation) : void {
        // If we want to press the "Save and insert" or "Save and select" buttons,
        // we need to enable the advanced UI.
        if ($selected_operation) {
            $this->config('media_library.settings')
                ->set('advanced_ui', TRUE)
                ->save();
        }
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $this->drupalGet('node/add/basic_page');
        // Upload 5 files into a media field that only allows 2.
        $this->openMediaLibraryForField('field_twin_media');
        $this->uploadFiles(5);
        // Save the media items and ensure that the user is warned that they have
        // selected too many items.
        if ($selected_operation) {
            $this->saveAnd($selected_operation);
        }
        else {
            $this->pressSaveButton();
        }
        $this->waitForElementTextContains('.messages--warning', 'There are currently 5 items selected. The maximum number of items for the field is 2. Remove 3 items from the selection.');
        // If the user tries to insert the selected items anyway, they should get
        // an error.
        $this->pressInsertSelected(NULL, FALSE);
        $this->waitForElementTextContains('.messages--error', 'There are currently 5 items selected. The maximum number of items for the field is 2. Remove 3 items from the selection.');
        $assert_session->elementNotExists('css', '.messages--warning');
        // Once the extra items are deselected, all should be well.
        $this->deselectMediaItem(2);
        $this->deselectMediaItem(3);
        $this->deselectMediaItem(4);
        $this->pressInsertSelected('Added 2 media items.');
    }
    
    /**
     * Tests that unlimited fields' selection count is not constrained.
     *
     * @param string|null $selected_operation
     *   The operation of the button to click. For example, if this is "insert",
     *   the "Save and insert" button will be pressed. If NULL, the "Save" button
     *   will be pressed.
     *
     * @dataProvider providerWidgetOverflow
     */
    public function testUnlimitedCardinality(?string $selected_operation) : void {
        if ($selected_operation) {
            $this->config('media_library.settings')
                ->set('advanced_ui', TRUE)
                ->save();
        }
        $assert_session = $this->assertSession();
        // Visit a node create page and open the media library.
        $this->drupalGet('node/add/basic_page');
        $this->openMediaLibraryForField('field_unlimited_media');
        $this->switchToMediaType('Three');
        $this->uploadFiles(5);
        if ($selected_operation) {
            $this->saveAnd($selected_operation);
        }
        else {
            $this->pressSaveButton();
        }
        if ($selected_operation !== 'insert') {
            $this->pressInsertSelected();
        }
        // There should not be any warnings or errors.
        $assert_session->elementNotExists('css', '.messages--error');
        $assert_session->elementNotExists('css', '.messages--warning');
        $this->waitForText('Added 5 media items.');
    }
    
    /**
     * Data provider for ::testWidgetOverflow() and ::testUnlimitedCardinality().
     *
     * @return array[]
     *   Sets of arguments to pass to the test method.
     */
    public static function providerWidgetOverflow() : array {
        return [
            'Save' => [
                NULL,
            ],
            'Save and insert' => [
                'insert',
            ],
            'Save and select' => [
                'select',
            ],
        ];
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
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 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 SettingsEditor::rewrite().
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. 40
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 test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
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 test site. 2
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::__get public function
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
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 &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
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. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
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. 4
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 11
MediaLibraryTestBase::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules 6
MediaLibraryTestBase::addMediaFileToField public function Waits for a file field to exist before uploading.
MediaLibraryTestBase::assertAnnounceContains protected function Checks for inclusion of text in #drupal-live-announce. 1
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::deselectMediaItem protected function De-selects an item in the media library modal.
MediaLibraryTestBase::getCheckboxes protected function Gets all available media item checkboxes.
MediaLibraryTestBase::getSelectionArea protected function Gets the &quot;Additional selected media&quot; 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&#039;s &quot;Insert selected&quot; button.
MediaLibraryTestBase::pressSaveButton protected function Clicks &quot;Save&quot; button and waits for AJAX completion.
MediaLibraryTestBase::saveAnd protected function Clicks &quot;Save and select||insert&quot; 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::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
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 Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
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.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name.
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
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. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
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::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
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 Deprecated public static function Returns the database connection to the site under test.
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::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
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. 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::drupalResetSession protected function Resets the current active session back to Anonymous session.
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. 2
WebDriverTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. Overrides BrowserTestBase::$minkDefaultDriverClass
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::failOnJavaScriptErrors protected function Triggers a test failure if a JavaScript error was encountered.
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 Gets the Mink driver args from an environment variable. Overrides BrowserTestBase::getMinkDriverArgs 1
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 1
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
WidgetOverflowTest::$image protected property The test image file.
WidgetOverflowTest::providerWidgetOverflow public static function Data provider for ::testWidgetOverflow() and ::testUnlimitedCardinality().
WidgetOverflowTest::setUp protected function Overrides BrowserTestBase::setUp
WidgetOverflowTest::testUnlimitedCardinality public function Tests that unlimited fields&#039; selection count is not constrained.
WidgetOverflowTest::testWidgetOverflow public function Tests that the Media Library constrains the number of selected items.
WidgetOverflowTest::uploadFiles private function Uploads multiple test images into the media library.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.