class OEmbedFormatterTest

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

@covers \Drupal\media\Plugin\Field\FieldFormatter\OEmbedFormatter

@group media @group #slow

Hierarchy

Expanded class hierarchy of OEmbedFormatterTest

File

core/modules/media/tests/src/Functional/FieldFormatter/OEmbedFormatterTest.php, line 22

Namespace

Drupal\Tests\media\Functional\FieldFormatter
View source
class OEmbedFormatterTest extends MediaFunctionalTestBase {
    use OEmbedTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'field_ui',
        'link',
        'media_test_oembed',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->lockHttpClientToFixtures();
        \Drupal::configFactory()->getEditable('media.settings')
            ->set('standalone_url', TRUE)
            ->save(TRUE);
        $this->container
            ->get('router.builder')
            ->rebuild();
    }
    
    /**
     * Data provider for testRender().
     *
     * @see ::testRender()
     *
     * @return array
     */
    public static function providerRender() {
        return [
            'Vimeo video' => [
                'https://vimeo.com/7073899',
                'video_vimeo.json',
                [],
                [
                    'iframe' => [
                        'src' => '/media/oembed?url=https%3A//vimeo.com/7073899',
                        'width' => '480',
                        'height' => '360',
                        'title' => 'Drupal Rap Video - Schipulcon09',
                        'loading' => 'lazy',
                        // cSpell:disable-next-line
'allowtransparency' => NULL,
                        'frameborder' => NULL,
                    ],
                ],
                'self_closing' => TRUE,
            ],
            'Vimeo video, resized' => [
                'https://vimeo.com/7073899',
                'video_vimeo-resized.json',
                [
                    'max_width' => '100',
                    'max_height' => '100',
                ],
                [
                    'iframe' => [
                        'src' => '/media/oembed?url=https%3A//vimeo.com/7073899&max_width=100&max_height=100',
                        'width' => '100',
                        'height' => '67',
                        'title' => 'Drupal Rap Video - Schipulcon09',
                        'loading' => 'lazy',
                    ],
                ],
                'self_closing' => TRUE,
            ],
            'Vimeo video, no title' => [
                'https://vimeo.com/7073899',
                'video_vimeo-no-title.json',
                [],
                [
                    'iframe' => [
                        'src' => '/media/oembed?url=https%3A//vimeo.com/7073899',
                        'width' => '480',
                        'height' => '360',
                        'title' => NULL,
                        'loading' => 'lazy',
                    ],
                ],
                'self_closing' => TRUE,
            ],
            'tweet' => [
                'https://twitter.com/drupaldevdays/status/935643039741202432',
                'rich_twitter.json',
                [
                    // The tweet resource does not specify a height, so the formatter
                    // should default to the configured maximum height.
'max_height' => 360,
                    'loading' => [
                        'attribute' => 'eager',
                    ],
                ],
                [
                    'iframe' => [
                        'src' => '/media/oembed?url=https%3A//twitter.com/drupaldevdays/status/935643039741202432',
                        'width' => '550',
                        'height' => '360',
                        'loading' => 'eager',
                    ],
                ],
                'self_closing' => TRUE,
            ],
            'Flickr photo' => [
                'https://www.flickr.com/photos/amazeelabs/26497866357',
                'photo_flickr.json',
                [],
                [
                    'img' => [
                        'src' => '/core/misc/druplicon.png',
                        'width' => '88',
                        'height' => '100',
                        'loading' => 'lazy',
                    ],
                ],
                'self_closing' => FALSE,
            ],
            'Flickr photo (no dimensions)' => [
                'https://www.flickr.com/photos/amazeelabs/26497866357',
                'photo_flickr_no_dimensions.json',
                [],
                [
                    'img' => [
                        'src' => '/core/misc/druplicon.png',
                        'loading' => 'lazy',
                    ],
                ],
                'self_closing' => FALSE,
            ],
        ];
    }
    
    /**
     * Tests that oEmbed media types' display can be configured correctly.
     */
    public function testDisplayConfiguration() : void {
        $account = $this->drupalCreateUser([
            'administer media display',
        ]);
        $this->drupalLogin($account);
        $media_type = $this->createMediaType('oembed:video');
        $this->drupalGet('/admin/structure/media/manage/' . $media_type->id() . '/display');
        $assert = $this->assertSession();
        $assert->statusCodeEquals(200);
        // Test that the formatter doesn't try to check applicability for fields
        // which do not have a specific target bundle.
        // @see https://www.drupal.org/project/drupal/issues/2976795.
        $assert->pageTextNotContains('Can only flip STRING and INTEGER values!');
    }
    
    /**
     * Tests the oEmbed field formatter.
     *
     * @param string $url
     *   The canonical URL of the media asset to test.
     * @param string $resource_url
     *   The oEmbed resource URL of the media asset to test.
     * @param array $formatter_settings
     *   Settings for the oEmbed field formatter.
     * @param array $selectors
     *   An array of arrays. Each key is a CSS selector targeting an element in
     *   the rendered output, and each value is an array of attributes, keyed by
     *   name, that the element is expected to have.
     * @param bool $self_closing
     *   Indicator if the HTML element is self closing i.e. <p/> vs <p></p>.
     *
     * @dataProvider providerRender
     */
    public function testRender($url, $resource_url, array $formatter_settings, array $selectors, bool $self_closing) : void {
        $account = $this->drupalCreateUser([
            'view media',
        ]);
        $this->drupalLogin($account);
        $media_type = $this->createMediaType('oembed:video');
        $source = $media_type->getSource();
        $source_field = $source->getSourceFieldDefinition($media_type);
        EntityViewDisplay::create([
            'targetEntityType' => 'media',
            'bundle' => $media_type->id(),
            'mode' => 'full',
            'status' => TRUE,
        ])
            ->removeComponent('thumbnail')
            ->setComponent($source_field->getName(), [
            'type' => 'oembed',
            'settings' => $formatter_settings,
        ])
            ->save();
        $this->hijackProviderEndpoints();
        ResourceController::setResourceUrl($url, $this->getFixturesDirectory() . '/' . $resource_url);
        UrlResolver::setEndpointUrl($url, $resource_url);
        $entity = Media::create([
            'bundle' => $media_type->id(),
            $source_field->getName() => $url,
        ]);
        $entity->save();
        $this->drupalGet($entity->toUrl());
        $assert = $this->assertSession();
        $assert->statusCodeEquals(200);
        foreach ($selectors as $selector => $attributes) {
            $element = $assert->elementExists('css', $selector);
            if ($self_closing) {
                self::assertStringContainsString("</{$selector}", $element->getParent()
                    ->getHtml());
            }
            foreach ($attributes as $attribute => $value) {
                if (isset($value)) {
                    $this->assertStringContainsString($value, $element->getAttribute($attribute));
                }
                else {
                    $this->assertFalse($element->hasAttribute($attribute));
                }
            }
        }
    }

}

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::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::$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::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::__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 &#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. 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::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. 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
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.
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
OEmbedFormatterTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
OEmbedFormatterTest::$modules protected static property Modules to install. Overrides MediaFunctionalTestBase::$modules
OEmbedFormatterTest::providerRender public static function Data provider for testRender().
OEmbedFormatterTest::setUp protected function Overrides MediaFunctionalTestTrait::setUp
OEmbedFormatterTest::testDisplayConfiguration public function Tests that oEmbed media types&#039; display can be configured correctly.
OEmbedFormatterTest::testRender public function Tests the oEmbed field formatter.
OEmbedTestTrait::getFixturesDirectory protected function Returns the relative path to the oEmbed fixtures directory.
OEmbedTestTrait::getFixturesUrl protected function Returns the absolute URL of the oEmbed fixtures directory.
OEmbedTestTrait::hijackProviderEndpoints protected function Ensures that oEmbed provider endpoints use the test resource route.
OEmbedTestTrait::lockHttpClientToFixtures protected function Configures the HTTP client to always use the fixtures directory.
OEmbedTestTrait::useFixtureProviders protected function Forces Media to use the provider database in the fixtures directory.
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::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.