class OEmbedSourceTest

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

@coversDefaultClass \Drupal\media\Plugin\media\Source\OEmbed

@group media

Hierarchy

Expanded class hierarchy of OEmbedSourceTest

File

core/modules/media/tests/src/Kernel/OEmbedSourceTest.php, line 27

Namespace

Drupal\Tests\media\Kernel
View source 
class OEmbedSourceTest extends MediaKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'media',
    ];
    
    /**
     * @covers ::getMetadata
     */
    public function testGetMetadata() : void {
        $configuration = [
            'source_field' => 'field_test_oembed',
        ];
        $plugin = OEmbed::create($this->container, $configuration, 'oembed', []);
        // Test that NULL is returned for a media item with no source value.
        $media = $this->prophesize('\\Drupal\\media\\MediaInterface');
        $field_items = $this->prophesize('\\Drupal\\Core\\Field\\FieldItemListInterface');
        $field_items->isEmpty()
            ->willReturn(TRUE);
        $media->get($configuration['source_field'])
            ->willReturn($field_items->reveal());
        $this->assertNull($plugin->getMetadata($media->reveal(), 'type'));
    }
    
    /**
     * Data provider for ::testThumbnailUri().
     *
     * @return array
     *   Sets of arguments to pass to the test method.
     */
    public static function providerThumbnailUri() : array {
        return [
            'no query string, extension in URL' => [
                'internal:/core/misc/druplicon.png',
                [],
                'png',
            ],
            'with query string, extension in URL' => [
                'internal:/core/misc/druplicon.png?foo=bar',
                [],
                'png',
            ],
            'no query string or extension in URL, has MIME type' => [
                'internal:/core/misc/druplicon',
                [
                    'Content-Type' => [
                        'image/png',
                    ],
                ],
                'png',
            ],
            'query string but no extension in URL, has MIME type' => [
                'internal:/core/misc/druplicon?pasta=ravioli',
                [
                    'Content-Type' => [
                        'image/png',
                    ],
                ],
                'png',
            ],
            'no query string, MIME type, or extension in URL' => [
                'internal:/core/misc/druplicon',
                [],
                '',
            ],
        ];
    }
    
    /**
     * Tests that remote thumbnails are downloaded correctly.
     *
     * @param string $remote_thumbnail_url
     *   The URL of the remote thumbnail. This will be wired up to a mocked
     *   response containing the data from core/misc/druplicon.png.
     * @param array[] $thumbnail_headers
     *   If the thumbnail's file extension cannot be determined from its URL, an
     *   attempt will be made to derive the extension from the response's
     *   Content-Type header. This array contains the headers that should be
     *   returned with the thumbnail response, where the keys are header names and
     *   the values are arrays of strings.
     * @param string $expected_extension
     *   The extension that the downloaded thumbnail should have.
     *
     * @covers ::getLocalThumbnailUri
     *
     * @dataProvider providerThumbnailUri
     */
    public function testThumbnailUri(string $remote_thumbnail_url, array $thumbnail_headers, string $expected_extension) : void {
        // Create a fake resource with the given thumbnail URL.
        $resource = Resource::rich('<html></html>', 16, 16, NULL, 'Test resource', NULL, NULL, NULL, $remote_thumbnail_url, 16, 16);
        $thumbnail_url = $resource->getThumbnailUrl()
            ->toString();
        // There's no need to resolve the resource URL in this test; we just need
        // to fetch the resource.
        $this->container
            ->set('media.oembed.url_resolver', $this->prophesize(UrlResolverInterface::class)
            ->reveal());
        // Mock the resource fetcher so that it will return our fake resource.
        $resource_fetcher = $this->prophesize(ResourceFetcherInterface::class);
        $resource_fetcher->fetchResource(Argument::any())
            ->willReturn($resource);
        $this->container
            ->set('media.oembed.resource_fetcher', $resource_fetcher->reveal());
        // The source plugin will try to fetch the remote thumbnail, so mock the
        // HTTP client to ensure that request returns a response with some valid
        // image data.
        $data = Utils::tryFopen($this->getDrupalRoot() . '/core/misc/druplicon.png', 'r');
        $response = new Response(200, $thumbnail_headers, Utils::streamFor($data));
        $handler = new MockHandler([
            $response,
        ]);
        $client = new Client([
            'handler' => new HandlerStack($handler),
        ]);
        $this->container
            ->set('http_client', $client);
        $media_type = $this->createMediaType('oembed:video');
        $source = $media_type->getSource();
        // Add some HTML to the global site slogan, and use the site:slogan token in
        // the thumbnail path, in order to prove that the final thumbnail path is
        // stripped of HTML tags, and XML entities are decoded.
        $this->config('system.site')
            ->set('slogan', '<h1>this&amp;that</h1>')
            ->save();
        $configuration = $source->getConfiguration();
        $configuration['thumbnails_directory'] .= '/[site:slogan]';
        $source->setConfiguration($configuration);
        $media_type->save();
        $media = Media::create([
            'bundle' => $media_type->id(),
            $source->getSourceFieldDefinition($media_type)
                ->getName() => $this->randomString(),
        ]);
        $media->save();
        // The thumbnail directory should include the current date, as per the
        // default configuration of the oEmbed source plugin.
        $date = date('Y-m', $this->container
            ->get('datetime.time')
            ->getRequestTime());
        // The thumbnail should have a file extension, even if it wasn't in the URL.
        $expected_uri = "public://oembed_thumbnails/{$date}/this&that/" . Crypt::hashBase64($thumbnail_url) . ".{$expected_extension}";
        $this->assertSame($expected_uri, $source->getMetadata($media, 'thumbnail_uri'));
        // Even if we get the thumbnail_uri more than once, it should only be
        // downloaded once. The HTTP client will throw an exception if we try to
        // do another request without setting up another response.
        $source->getMetadata($media, 'thumbnail_uri');
        // The downloaded thumbnail should be usable by the image toolkit.
        $this->assertFileExists($expected_uri);
        
        /** @var \Drupal\Core\Image\Image $image */
        $image = $this->container
            ->get('image.factory')
            ->get($expected_uri);
        $this->assertTrue($image->isValid());
        // Check that the current date token as per the default configuration of the
        // oEmbed source plugin doesn't make a render context uncacheable.
        $context = new RenderContext();
        \Drupal::service('renderer')->executeInRenderContext($context, function () use ($source, $media) {
            return $source->getMetadata($media, 'thumbnail_uri');
        });
        
        /** @var \Drupal\Core\Render\BubbleableMetadata $bubbleable_metadata */
        $bubbleable_metadata = $context->pop();
        $this->assertSame(Cache::PERMANENT, $bubbleable_metadata->getCacheMaxAge());
    }

}

Members

Title Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds Deprecated protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern Deprecated protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
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.
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.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 3
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 2
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 28
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::tearDown protected function 7
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
MediaKernelTestBase::$testConstraintsMediaType protected property The test media type with constraints.
MediaKernelTestBase::$testMediaType protected property The test media type.
MediaKernelTestBase::$user protected property A user.
MediaKernelTestBase::generateMedia protected function Helper to generate a media item.
MediaKernelTestBase::setUp protected function Overrides KernelTestBase::setUp 2
MediaTypeCreationTrait::createMediaType protected function Create a media type for a source plugin.
OEmbedSourceTest::$modules protected static property Modules to install. Overrides MediaKernelTestBase::$modules
OEmbedSourceTest::providerThumbnailUri public static function Data provider for ::testThumbnailUri().
OEmbedSourceTest::testGetMetadata public function @covers ::getMetadata
OEmbedSourceTest::testThumbnailUri public function Tests that remote thumbnails are downloaded correctly.
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.
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.

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