class MediaLibraryDisplayModeTest

Same name in other branches
  1. 9 core/modules/media_library/tests/src/Functional/MediaLibraryDisplayModeTest.php \Drupal\Tests\media_library\Functional\MediaLibraryDisplayModeTest
  2. 8.9.x core/modules/media_library/tests/src/Functional/MediaLibraryDisplayModeTest.php \Drupal\Tests\media_library\Functional\MediaLibraryDisplayModeTest
  3. 11.x core/modules/media_library/tests/src/Functional/MediaLibraryDisplayModeTest.php \Drupal\Tests\media_library\Functional\MediaLibraryDisplayModeTest

Tests that the Media Library automatically configures form/view modes.

@group media_library

Hierarchy

Expanded class hierarchy of MediaLibraryDisplayModeTest

File

core/modules/media_library/tests/src/Functional/MediaLibraryDisplayModeTest.php, line 21

Namespace

Drupal\Tests\media_library\Functional
View source
class MediaLibraryDisplayModeTest extends BrowserTestBase {
    use MediaTypeCreationTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'field_ui',
        'media',
        'system',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalLogin($this->drupalCreateUser([
            'access media overview',
            'administer media',
            'administer media fields',
            'administer media form display',
            'administer media display',
            'administer media types',
            'view media',
        ]));
    }
    
    /**
     * Tests that the Media Library can automatically configure display modes.
     */
    public function testDisplayModes() : void {
        $this->createMediaType('file', [
            'id' => 'type_one',
        ]);
        $this->createMediaType('file', [
            'id' => 'type_two',
            'field_map' => [
                'name' => File::METADATA_ATTRIBUTE_NAME,
            ],
        ]);
        $this->createMediaType('image', [
            'id' => 'type_three',
        ]);
        $this->createMediaType('image', [
            'id' => 'type_four',
            'field_map' => [
                'name' => Image::METADATA_ATTRIBUTE_NAME,
            ],
        ]);
        // Display modes are not automatically created when creating a media type
        // programmatically, only when installing the module or when creating a
        // media type via the UI.
        $this->assertNull(EntityFormDisplay::load('media.type_one.media_library'));
        $this->assertNull(EntityViewDisplay::load('media.type_one.media_library'));
        $this->assertNull(EntityFormDisplay::load('media.type_two.media_library'));
        $this->assertNull(EntityViewDisplay::load('media.type_two.media_library'));
        $this->assertNull(EntityFormDisplay::load('media.type_three.media_library'));
        $this->assertNull(EntityViewDisplay::load('media.type_three.media_library'));
        $this->assertNull(EntityFormDisplay::load('media.type_four.media_library'));
        $this->assertNull(EntityViewDisplay::load('media.type_four.media_library'));
        // Display modes are created on install.
        $this->container
            ->get('module_installer')
            ->install([
            'media_library',
        ]);
        // The container was rebuilt during module installation, so ensure we have
        // an up-to-date reference to it.
        $this->container = $this->kernel
            ->getContainer();
        // For a non-image media type without a mapped name field, the media_library
        // form mode should only contain the name field.
        $this->assertFormDisplay('type_one', TRUE, FALSE);
        $this->assertViewDisplay('type_one', 'medium');
        // For a non-image media type with a mapped name field, the media_library
        // form mode should not contain any fields.
        $this->assertFormDisplay('type_two', FALSE, FALSE);
        $this->assertViewDisplay('type_two', 'medium');
        // For an image media type without a mapped name field, the media_library
        // form mode should contain the name field and the source field.
        $this->assertFormDisplay('type_three', TRUE, TRUE);
        $this->assertViewDisplay('type_three', 'medium');
        // For an image media type with a mapped name field, the media_library form
        // mode should only contain the source field.
        $this->assertFormDisplay('type_four', FALSE, TRUE);
        $this->assertViewDisplay('type_four', 'medium');
        // Create a non-image media type without a mapped name field in the UI.
        $type_five_id = 'type_five';
        $edit = [
            'label' => $type_five_id,
            'id' => $type_five_id,
            'source' => 'file',
        ];
        $this->drupalGet('admin/structure/media/add');
        $this->submitForm($edit, 'Save and manage fields');
        $this->submitForm([], 'Save and manage fields');
        $this->assertSession()
            ->pageTextContains("Media Library form and view displays have been created for the {$type_five_id} media type.");
        $this->assertFormDisplay($type_five_id, TRUE, FALSE);
        $this->assertViewDisplay($type_five_id, 'medium');
        // Create a non-image media type with a mapped name field in the UI.
        $type_six_id = 'type_six';
        $edit = [
            'label' => $type_six_id,
            'id' => $type_six_id,
            'source' => 'file',
        ];
        $this->drupalGet('admin/structure/media/add');
        $this->submitForm($edit, 'Save');
        $edit = [
            'field_map[name]' => File::METADATA_ATTRIBUTE_NAME,
        ];
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains("Media Library form and view displays have been created for the {$type_six_id} media type.");
        $this->assertFormDisplay($type_six_id, FALSE, FALSE);
        $this->assertViewDisplay($type_six_id, 'medium');
        // Create an image media type without a mapped name field in the UI.
        $type_seven_id = 'type_seven';
        $edit = [
            'label' => $type_seven_id,
            'id' => $type_seven_id,
            'source' => 'image',
        ];
        $this->drupalGet('admin/structure/media/add');
        $this->submitForm($edit, 'Save');
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->pageTextContains("Media Library form and view displays have been created for the {$type_seven_id} media type.");
        $this->assertFormDisplay($type_seven_id, TRUE, TRUE);
        $this->assertViewDisplay($type_seven_id, 'medium');
        // Create an image media type with a mapped name field in the UI.
        $type_eight_id = 'type_eight';
        $edit = [
            'label' => $type_eight_id,
            'id' => $type_eight_id,
            'source' => 'image',
        ];
        $this->drupalGet('admin/structure/media/add');
        $this->submitForm($edit, 'Save');
        $edit = [
            'field_map[name]' => Image::METADATA_ATTRIBUTE_NAME,
        ];
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains("Media Library form and view displays have been created for the {$type_eight_id} media type.");
        $this->assertFormDisplay($type_eight_id, FALSE, TRUE);
        $this->assertViewDisplay($type_eight_id, 'medium');
        // Create an oEmbed media type with a mapped name field in the UI.
        $type_id = 'pinto_bean';
        $edit = [
            'label' => $type_id,
            'id' => $type_id,
            'source' => 'oembed:video',
        ];
        $this->drupalGet('admin/structure/media/add');
        $this->submitForm($edit, 'Save');
        $edit = [
            'field_map[title]' => 'name',
        ];
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains("Media Library form and view displays have been created for the {$type_id} media type.");
        $this->assertFormDisplay($type_id, FALSE, FALSE);
        $this->assertViewDisplay($type_id, 'medium');
        // Now that all our media types have been created, ensure the bundle info
        // cache is up-to-date.
        $this->container
            ->get('entity_type.bundle.info')
            ->clearCachedBundles();
        // Delete a form and view display.
        EntityFormDisplay::load('media.type_one.media_library')->delete();
        EntityViewDisplay::load('media.type_one.media_library')->delete();
        // Make sure the form and view display are not created when saving existing
        // media types.
        $this->drupalGet('admin/structure/media/manage/type_one');
        $this->submitForm([], 'Save');
        $this->assertNull(EntityFormDisplay::load('media.type_one.media_library'));
        $this->assertNull(EntityViewDisplay::load('media.type_one.media_library'));
        // Delete the medium image style.
        ImageStyle::load('medium')->delete();
        // Create an image media type, assert the displays are created and the
        // fallback 'media_library' image style is used.
        $type_nine_id = 'type_nine';
        $edit = [
            'label' => $type_nine_id,
            'id' => $type_nine_id,
            'source' => 'image',
        ];
        $this->drupalGet('admin/structure/media/add');
        $this->submitForm($edit, 'Save');
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->pageTextContains("Media Library form and view displays have been created for the {$type_nine_id} media type.");
        $this->assertFormDisplay($type_nine_id, TRUE, TRUE);
        $this->assertViewDisplay($type_nine_id, 'media_library');
    }
    
    /**
     * Asserts the media library form display components for a media type.
     *
     * @param string $type_id
     *   The media type ID.
     * @param bool $has_name
     *   Whether the media library form display should contain the name field or
     *   not.
     * @param bool $has_source_field
     *   Whether the media library form display should contain the source field or
     *   not.
     *
     * @internal
     */
    protected function assertFormDisplay(string $type_id, bool $has_name, bool $has_source_field) : void {
        // These components are added by default and invisible.
        $components = [
            'revision_log_message',
            'langcode',
        ];
        // Only assert the name and source field if needed.
        if ($has_name) {
            $components[] = 'name';
        }
        if ($has_source_field) {
            $type = MediaType::load($type_id);
            $components[] = $type->getSource()
                ->getSourceFieldDefinition($type)
                ->getName();
        }
        $form_display = EntityFormDisplay::load('media.' . $type_id . '.media_library');
        $this->assertInstanceOf(EntityFormDisplay::class, $form_display);
        $actual_components = array_keys($form_display->getComponents());
        sort($components);
        sort($actual_components);
        $this->assertSame($components, $actual_components);
    }
    
    /**
     * Asserts the media library view display components for a media type.
     *
     * @param string $type_id
     *   The media type ID.
     * @param string $image_style
     *   The ID of the image style that should be configured for the thumbnail.
     *
     * @internal
     */
    protected function assertViewDisplay(string $type_id, string $image_style) : void {
        $view_display = EntityViewDisplay::load('media.' . $type_id . '.media_library');
        $this->assertInstanceOf(EntityViewDisplay::class, $view_display);
        // Assert the media library view display contains only the thumbnail.
        $this->assertSame([
            'thumbnail',
        ], array_keys($view_display->getComponents()));
        // Assert the thumbnail image style.
        $thumbnail = $view_display->getComponent('thumbnail');
        $this->assertIsArray($thumbnail);
        $this->assertSame($image_style, $thumbnail['settings']['image_style']);
    }

}

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::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
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::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
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::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
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::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
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::tearDown protected function 3
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 '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::$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::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 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
MediaLibraryDisplayModeTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
MediaLibraryDisplayModeTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
MediaLibraryDisplayModeTest::assertFormDisplay protected function Asserts the media library form display components for a media type.
MediaLibraryDisplayModeTest::assertViewDisplay protected function Asserts the media library view display components for a media type.
MediaLibraryDisplayModeTest::setUp protected function Overrides BrowserTestBase::setUp
MediaLibraryDisplayModeTest::testDisplayModes public function Tests that the Media Library can automatically configure display modes.
MediaTypeCreationTrait::createMediaType protected function Create a media type for a source plugin.
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.
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::assertSession public function Returns WebAssert object. 1
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.
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.