class ImageFormatterTest

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

Tests the image field rendering using entity fields of the image field type.

@group image

Hierarchy

Expanded class hierarchy of ImageFormatterTest

File

core/modules/image/tests/src/Kernel/ImageFormatterTest.php, line 21

Namespace

Drupal\Tests\image\Kernel
View source
class ImageFormatterTest extends FieldKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'file',
        'image',
    ];
    
    /**
     * @var string
     */
    protected $entityType;
    
    /**
     * @var string
     */
    protected $bundle;
    
    /**
     * @var string
     */
    protected $fieldName;
    
    /**
     * @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface
     */
    protected $display;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installConfig([
            'field',
        ]);
        $this->installEntitySchema('entity_test');
        $this->installEntitySchema('file');
        $this->installSchema('file', [
            'file_usage',
        ]);
        $this->entityType = 'entity_test';
        $this->bundle = $this->entityType;
        $this->fieldName = $this->randomMachineName();
        FieldStorageConfig::create([
            'entity_type' => $this->entityType,
            'field_name' => $this->fieldName,
            'type' => 'image',
            'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
        ])
            ->save();
        FieldConfig::create([
            'entity_type' => $this->entityType,
            'field_name' => $this->fieldName,
            'bundle' => $this->bundle,
            'settings' => [
                'file_extensions' => 'jpg',
            ],
        ])
            ->save();
        $this->display = \Drupal::service('entity_display.repository')->getViewDisplay($this->entityType, $this->bundle)
            ->setComponent($this->fieldName, [
            'type' => 'image',
            'label' => 'hidden',
        ]);
        $this->display
            ->save();
    }
    
    /**
     * Tests the cache tags from image formatters.
     */
    public function testImageFormatterCacheTags() : void {
        // Create a test entity with the image field set.
        $entity = EntityTest::create([
            'name' => $this->randomMachineName(),
        ]);
        $entity->{$this->fieldName}
            ->generateSampleItems(2);
        $entity->save();
        // Generate the render array to verify if the cache tags are as expected.
        $build = $this->display
            ->build($entity);
        $this->assertEquals($entity->{$this->fieldName}[0]->entity
            ->getCacheTags(), $build[$this->fieldName][0]['#cache']['tags'], 'First image cache tags is as expected');
        $this->assertEquals($entity->{$this->fieldName}[1]->entity
            ->getCacheTags(), $build[$this->fieldName][1]['#cache']['tags'], 'Second image cache tags is as expected');
    }
    
    /**
     * Tests ImageFormatter's handling of SVG images.
     *
     * @requires extension gd
     */
    public function testImageFormatterSvg() : void {
        // Install the default image styles.
        $this->installConfig([
            'image',
        ]);
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        $png = File::create([
            'uri' => 'public://test-image.png',
        ]);
        $png->save();
        // We need to create an actual empty PNG, or the GD toolkit will not
        // consider the image valid.
        $png_resource = imagecreate(300, 300);
        imagefill($png_resource, 0, 0, imagecolorallocate($png_resource, 0, 0, 0));
        imagepng($png_resource, $png->getFileUri());
        $svg = File::create([
            'uri' => 'public://test-image.svg',
        ]);
        $svg->save();
        // We don't have to put any real SVG data in here, because the GD toolkit
        // won't be able to load it anyway.
        touch($svg->getFileUri());
        $entity = EntityTest::create([
            'name' => $this->randomMachineName(),
            $this->fieldName => [
                $png,
                $svg,
            ],
        ]);
        $entity->save();
        // Ensure that the display is using the medium image style.
        $component = $this->display
            ->getComponent($this->fieldName);
        $component['settings']['image_style'] = 'medium';
        $this->display
            ->setComponent($this->fieldName, $component)
            ->save();
        $build = $this->display
            ->build($entity);
        // The first image is a PNG, so it is supported by the GD image toolkit.
        // The image style should be applied with its cache tags, image derivative
        // computed with its URI and dimensions.
        $this->assertCacheTags($build[$this->fieldName][0], ImageStyle::load('medium')->getCacheTags());
        $renderer->renderRoot($build[$this->fieldName][0]);
        $this->assertEquals('medium', $build[$this->fieldName][0]['#image_style']);
        // We check that the image URL contains the expected style directory
        // structure.
        $this->assertStringContainsString('styles/medium/public/test-image.png', (string) $build[$this->fieldName][0]['#markup']);
        $this->assertStringContainsString('width="220"', (string) $build[$this->fieldName][0]['#markup']);
        $this->assertStringContainsString('height="220"', (string) $build[$this->fieldName][0]['#markup']);
        // The second image is an SVG, which is not supported by the GD toolkit.
        // The image style should still be applied with its cache tags, but image
        // derivative will not be available so <img> tag will point to the original
        // image.
        $this->assertCacheTags($build[$this->fieldName][1], ImageStyle::load('medium')->getCacheTags());
        $renderer->renderRoot($build[$this->fieldName][1]);
        $this->assertEquals('medium', $build[$this->fieldName][1]['#image_style']);
        // We check that the image URL does not contain the style directory
        // structure.
        $this->assertStringNotContainsString('styles/medium/public/test-image.svg', (string) $build[$this->fieldName][1]['#markup']);
        // Since we did not store original image dimensions, width and height
        // HTML attributes will not be present.
        $this->assertStringNotContainsString('width', (string) $build[$this->fieldName][1]['#markup']);
        $this->assertStringNotContainsString('height', (string) $build[$this->fieldName][1]['#markup']);
    }
    
    /**
     * Tests Image Formatter URL options handling.
     */
    public function testImageFormatterUrlOptions() : void {
        $this->display
            ->setComponent($this->fieldName, [
            'settings' => [
                'image_link' => 'content',
            ],
        ]);
        // Create a test entity with the image field set.
        $entity = EntityTest::create([
            'name' => $this->randomMachineName(),
        ]);
        $entity->{$this->fieldName}
            ->generateSampleItems(2);
        $entity->save();
        // Generate the render array to verify URL options are as expected.
        $build = $this->display
            ->build($entity);
        $this->assertInstanceOf(Url::class, $build[$this->fieldName][0]['#url']);
        $build[$this->fieldName][0]['#url']
            ->setOption('attributes', [
            'data-attributes-test' => 'test123',
        ]);
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        $output = $renderer->renderRoot($build[$this->fieldName][0]);
        $this->assertStringContainsString('<a href="' . $entity->toUrl()
            ->toString() . '" data-attributes-test="test123"', (string) $output);
    }
    
    /**
     * Asserts that a renderable array has a set of cache tags.
     *
     * @param array $renderable
     *   The renderable array. Must have a #cache[tags] element.
     * @param array $cache_tags
     *   The expected cache tags.
     *
     * @internal
     */
    protected function assertCacheTags(array $renderable, array $cache_tags) : void {
        $diff = array_diff($cache_tags, $renderable['#cache']['tags']);
        $this->assertEmpty($diff);
    }

}

Members

Title Sort descending 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.
FieldKernelTestBase::$entityId protected property
FieldKernelTestBase::$fieldTestData protected property Bag of created field storages and fields.
FieldKernelTestBase::assertFieldValues protected function Assert that a field has the expected values in an entity.
FieldKernelTestBase::createFieldWithStorage protected function Create a field and an associated field storage.
FieldKernelTestBase::entitySaveReload protected function Saves and reloads an entity.
FieldKernelTestBase::entityValidateAndSave protected function Validate and save entity. Fail if violations are found.
FieldKernelTestBase::_generateTestFieldValues protected function Generate random values for a field_test field.
ImageFormatterTest::$bundle protected property
ImageFormatterTest::$display protected property
ImageFormatterTest::$entityType protected property
ImageFormatterTest::$fieldName protected property
ImageFormatterTest::$modules protected static property Modules to install. Overrides FieldKernelTestBase::$modules
ImageFormatterTest::assertCacheTags protected function Asserts that a renderable array has a set of cache tags.
ImageFormatterTest::setUp protected function Set the default field storage backend for fields created during tests. Overrides FieldKernelTestBase::setUp
ImageFormatterTest::testImageFormatterCacheTags public function Tests the cache tags from image formatters.
ImageFormatterTest::testImageFormatterSvg public function Tests ImageFormatter&#039;s handling of SVG images.
ImageFormatterTest::testImageFormatterUrlOptions public function Tests Image Formatter URL options handling.
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. 2
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
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.
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.