class MediaDisplayTest

Same name in other branches
  1. 9 core/modules/media/tests/src/FunctionalJavascript/MediaDisplayTest.php \Drupal\Tests\media\FunctionalJavascript\MediaDisplayTest
  2. 8.9.x core/modules/media/tests/src/FunctionalJavascript/MediaDisplayTest.php \Drupal\Tests\media\FunctionalJavascript\MediaDisplayTest
  3. 10 core/modules/media/tests/src/FunctionalJavascript/MediaDisplayTest.php \Drupal\Tests\media\FunctionalJavascript\MediaDisplayTest

Basic display tests for Media.

@group media

Hierarchy

Expanded class hierarchy of MediaDisplayTest

File

core/modules/media/tests/src/FunctionalJavascript/MediaDisplayTest.php, line 20

Namespace

Drupal\Tests\media\FunctionalJavascript
View source
class MediaDisplayTest extends MediaJavascriptTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Install the optional configs from the standard profile.
        $extension_path = $this->container
            ->get('extension.list.profile')
            ->getPath('standard');
        $optional_install_path = $extension_path . '/' . InstallStorage::CONFIG_OPTIONAL_DIRECTORY;
        $storage = new FileStorage($optional_install_path);
        $this->container
            ->get('config.installer')
            ->installOptionalConfig($storage, '');
        // Reset all the static caches and list caches.
        $this->container
            ->get('config.factory')
            ->reset();
        // This test is going to test the display, so we need the standalone URL.
        \Drupal::configFactory()->getEditable('media.settings')
            ->set('standalone_url', TRUE)
            ->save(TRUE);
        $this->container
            ->get('router.builder')
            ->rebuild();
    }
    
    /**
     * Tests basic media display.
     */
    public function testMediaDisplay() : void {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $media_type = $this->createMediaType('test');
        // Create a media item.
        $media = Media::create([
            'bundle' => $media_type->id(),
            'name' => 'Fantastic!',
        ]);
        $media->save();
        $this->drupalGet('media/' . $media->id());
        // Verify the "name" field is really not present. The name should be in the
        // h1 with no additional markup in the h1.
        $assert_session->elementTextContains('css', 'h1', $media->getName());
        $assert_session->elementNotExists('css', 'h1 div');
        // Enable the field on the display and verify it becomes visible on the UI.
        $this->drupalGet("/admin/structure/media/manage/{$media_type->id()}/display");
        $assert_session->buttonExists('Show row weights')
            ->press();
        $this->assertSession()
            ->waitForElementVisible('css', '[name="fields[name][region]"]');
        $page->selectFieldOption('fields[name][region]', 'content');
        $assert_session->waitForElementVisible('css', '#edit-fields-name-settings-edit');
        $page->pressButton('Save');
        $this->drupalGet('media/' . $media->id());
        // Verify the name is present, and its text matches what is expected. Now
        // there should be markup in the h1.
        $assert_session->elementTextContains('xpath', '//h1/div/div[1]', 'Name');
        $assert_session->elementTextContains('xpath', '//h1/div/div[2]', $media->getName());
        // In the standard profile, there are some pre-cooked types. Make sure the
        // elements configured on their displays are the expected ones.
        $this->drupalGet('media/add/image');
        $image_media_name = 'example_1.jpeg';
        $page->attachFileToField('files[field_media_image_0]', $this->root . '/core/modules/media/tests/fixtures/' . $image_media_name);
        $result = $assert_session->waitForButton('Remove');
        $this->assertNotEmpty($result);
        $page->fillField('field_media_image[0][alt]', 'Image Alt Text 1');
        $page->pressButton('Save');
        $image_media_id = $this->container
            ->get('entity_type.manager')
            ->getStorage('media')
            ->getQuery()
            ->accessCheck(FALSE)
            ->sort('mid', 'DESC')
            ->execute();
        $image_media_id = reset($image_media_id);
        // Go to the media entity view.
        $this->drupalGet('/media/' . $image_media_id);
        // Check if the default media name is generated as expected.
        $assert_session->elementTextContains('xpath', '//h1', $image_media_name);
        // Here we expect to see only the image, nothing else.
        // Assert only one element in the content region.
        $media_item = $assert_session->elementExists('xpath', '//div[@class="layout-content"]/div/div[2]');
        $assert_session->elementsCount('xpath', '/div', 1, $media_item);
        // Assert the image is present inside the media element.
        $media_image = $assert_session->elementExists('xpath', '//img', $media_item);
        // Assert that the image src uses the large image style, the label is
        // visually hidden, and there is no link to the image file.
        
        /** @var \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator */
        $file_url_generator = \Drupal::service('file_url_generator');
        $expected_image_src = $file_url_generator->generate(\Drupal::token()->replace('public://styles/large/public/[date:custom:Y]-[date:custom:m]/example_1.jpeg'))
            ->toString();
        $this->assertStringContainsString($expected_image_src, $media_image->getAttribute('src'));
        $field = $assert_session->elementExists('xpath', '/div[1]', $media_item);
        $assert_session->elementExists('xpath', '/div[@class="visually-hidden"]', $field);
        $assert_session->elementNotExists('xpath', '//a', $field);
        $test_filename = $this->randomMachineName() . '.txt';
        $test_filepath = 'public://' . $test_filename;
        file_put_contents($test_filepath, $this->randomMachineName());
        $this->drupalGet("media/add/document");
        $page->attachFileToField("files[field_media_document_0]", \Drupal::service('file_system')->realpath($test_filepath));
        $result = $assert_session->waitForButton('Remove');
        $this->assertNotEmpty($result);
        $page->pressButton('Save');
        // Go to the media entity view.
        $this->drupalGet($this->assertLinkToCreatedMedia());
        // Check if the default media name is generated as expected.
        $assert_session->elementTextContains('css', 'h1', $test_filename);
        // Here we expect to see only the linked filename.
        // Assert only one element in the content region.
        $media_item = $assert_session->elementExists('xpath', '//div[@class="layout-content"]/div/div[2]');
        $assert_session->elementsCount('xpath', '/div', 1, $media_item);
        // Assert the file link is present, and its text matches the filename.
        $link = $assert_session->elementExists('xpath', '//a', $media_item);
        $this->assertSame($test_filename, $link->getText());
        // Create a node type "page" to use as host entity.
        $node_type = NodeType::create([
            'type' => 'page',
            'name' => 'Page',
        ]);
        $node_type->save();
        // Reference the created media using an entity_reference field and make sure
        // the output is what we expect.
        $storage = FieldStorageConfig::create([
            'entity_type' => 'node',
            'field_name' => 'field_related_media',
            'type' => 'entity_reference',
            'settings' => [
                'target_type' => 'media',
            ],
        ]);
        $storage->save();
        FieldConfig::create([
            'field_storage' => $storage,
            'entity_type' => 'node',
            'bundle' => $node_type->id(),
            'label' => 'Related media',
            'settings' => [
                'handler_settings' => [
                    'target_bundles' => [
                        'image' => 'image',
                    ],
                ],
            ],
        ])
            ->save();
        \Drupal::service('entity_display.repository')->getViewDisplay('node', $node_type->id())
            ->setComponent('field_related_media', [
            'type' => 'entity_reference_entity_view',
            'label' => 'above',
            'settings' => [
                'view_mode' => 'full',
            ],
        ])
            ->save();
        $node = Node::create([
            'title' => 'Host node',
            'type' => $node_type->id(),
            'field_related_media' => [
                'target_id' => $image_media_id,
            ],
        ]);
        $node->save();
        $this->drupalGet('/node/' . $node->id());
        // Media field (field_related_media) is there.
        $assert_session->pageTextContains('Related media');
        // Media name element is not there.
        $assert_session->pageTextNotContains($image_media_name);
        // Only one image is present.
        $assert_session->elementsCount('xpath', '//img', 1);
        // The image has the correct image style.
        $assert_session->elementAttributeContains('xpath', '//img', 'src', '/styles/large/');
    }

}

Members

Title Sort descending 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::$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::$profile protected property The profile to install as a basis for testing. 41
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::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
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. 8
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. 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. 29
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
MediaDisplayTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
MediaDisplayTest::setUp protected function Overrides MediaFunctionalTestTrait::setUp
MediaDisplayTest::testMediaDisplay public function Tests basic media display.
MediaFunctionalTestTrait::$adminUser protected property An admin test user account.
MediaFunctionalTestTrait::$adminUserPermissions protected static property Permissions for the admin user that will be logged-in for test.
MediaFunctionalTestTrait::$nonAdminUser protected property A non-admin test user account.
MediaFunctionalTestTrait::$storage protected property The storage service.
MediaJavascriptTestBase::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules 4
MediaJavascriptTestBase::assertLinkToCreatedMedia protected function Asserts that a link to a new media item is displayed in the messages area.
MediaJavascriptTestBase::waitUntilVisible protected function Waits and asserts that a given element is visible.
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
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.
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::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. 3
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::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
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.