class OEmbedSourceTest in Drupal 9

Same name and namespace in other branches

8 core/modules/media/tests/src/Kernel/OEmbedSourceTest.php \Drupal\Tests\media\Kernel\OEmbedSourceTest

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

@group media

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\Tests\media\Kernel\MediaKernelTestBase uses MediaTypeCreationTrait
  - class \Drupal\Tests\media\Kernel\OEmbedSourceTest

Expanded class hierarchy of OEmbedSourceTest

File

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

Namespace

Drupal\Tests\media\Kernel

View source

class OEmbedSourceTest extends MediaKernelTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'media',
  ];

  /**
   * @covers ::getMetadata
   */
  public function testGetMetadata() {
    $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 function providerThumbnailUri() : array {
    return [
      'no query string, file extension is known' => [
        'internal:/core/misc/druplicon.png',
      ],
      'with query string and file extension' => [
        'internal:/core/misc/druplicon.png?foo=bar',
      ],
      'no query string, unknown file extension' => [
        'internal:/core/misc/druplicon',
        [
          'Content-Type' => [
            'image/png',
          ],
        ],
      ],
      'query string, unknown file extension' => [
        'internal:/core/misc/druplicon?pasta=ravioli',
        [
          'Content-Type' => [
            'image/png',
          ],
        ],
      ],
      'no query string, unknown file extension, exception' => [
        'internal:/core/misc/druplicon',
        '\\GuzzleHttp\\Exception\\TransferException',
      ],
    ];
  }

  /**
   * 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[]|string $thumbnail_headers
   *   (optional) If the thumbnail's file extension cannot be determined from
   *   its URL, a HEAD request will be made in an attempt to derive its
   *   extension from its Content-Type header. If this is an array, it contains
   *   headers that should be returned by the HEAD request, where the keys are
   *   header names and the values are arrays of strings. If it's the name of a
   *   throwable class, it is the exception class that should be thrown by the
   *   HTTP client.
   *
   * @covers ::getLocalThumbnailUri
   *
   * @dataProvider providerThumbnailUri
   */
  public function testThumbnailUri(string $remote_thumbnail_url, $thumbnail_headers = NULL) : 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, [], Utils::streamFor($data));
    $http_client = $this
      ->prophesize(Client::class);

    // The thumbnail should only be downloaded once.
    $http_client
      ->request('GET', $thumbnail_url)
      ->willReturn($response)
      ->shouldBeCalledOnce();

    // The extension we expect the downloaded thumbnail to have.
    $expected_extension = 'png';

    // If the file extension cannot be derived from the URL, a single HEAD
    // request should be made to try and determine its type from the
    // Content-Type HTTP header.
    if (is_array($thumbnail_headers)) {
      $response = new Response(200, $thumbnail_headers);
      $http_client
        ->request('HEAD', $thumbnail_url)
        ->willReturn($response)
        ->shouldBeCalledOnce();
    }
    elseif (is_a($thumbnail_headers, 'Throwable', TRUE)) {
      $e = new $thumbnail_headers('Nope!');
      $http_client
        ->request('HEAD', $thumbnail_url)
        ->willThrow($e)
        ->shouldBeCalledOnce();

      // Ensure that the exception is logged.
      $logger = $this
        ->prophesize('\\Psr\\Log\\LoggerInterface');
      $logger
        ->log(RfcLogLevel::WARNING, $e
        ->getMessage(), Argument::cetera())
        ->shouldBeCalled();
      $this->container
        ->get('logger.factory')
        ->addLogger($logger
        ->reveal());

      // If the request fails, we won't be able to determine the thumbnail's
      // extension.
      $expected_extension = '';
    }
    else {
      $http_client
        ->request('HEAD', $thumbnail_url)
        ->shouldNotBeCalled();
    }
    $this->container
      ->set('http_client', $http_client
      ->reveal());
    $media_type = $this
      ->createMediaType('oembed:video');
    $source = $media_type
      ->getSource();
    $media = Media::create([
      'bundle' => $media_type
        ->id(),
      $source
        ->getSourceFieldDefinition($media_type)
        ->getName() => $this
        ->randomString(),
    ]);
    $media
      ->save();

    // The thumbnail should have a file extension, even if it wasn't in the URL.
    $expected_uri = 'public://oembed_thumbnails/' . 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 (this is verified by the shouldBeCalledOnce() checks
    // in the mocked HTTP client).
    $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());
  }

}

Members

Name	Modifiers	Type	Description	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	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	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	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	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	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	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	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	protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	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	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	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	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::getUrl	protected	function	Get the current URL from the cURL handler.	1
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.
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
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.
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
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.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
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	private	function	Bootstraps a kernel for a test.
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.
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.	3
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable 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::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	24
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.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		4
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
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	1
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	function	Data provider for ::testThumbnailUri().
OEmbedSourceTest::testGetMetadata	public	function	@covers ::getMetadata
OEmbedSourceTest::testThumbnailUri	public	function	Tests that remote thumbnails are downloaded correctly.
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::$randomGenerator	protected	property	The random generator.
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.	1
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	public	function	Callback for random string validation.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.

You are here

class OEmbedSourceTest in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation