class ToolkitImagemagickFileMetadataTest in ImageMagick 8.2
Same name and namespace in other branches
- 8.3 tests/src/Functional/ToolkitImagemagickFileMetadataTest.php \Drupal\Tests\imagemagick\Functional\ToolkitImagemagickFileMetadataTest
Tests that Imagemagick integrates properly with File Metadata Manager.
@group Imagemagick
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\imagemagick\Functional\ToolkitImagemagickFileMetadataTest uses ToolkitSetupTrait
Expanded class hierarchy of ToolkitImagemagickFileMetadataTest
File
- tests/
src/ Functional/ ToolkitImagemagickFileMetadataTest.php, line 16
Namespace
Drupal\Tests\imagemagick\FunctionalView source
class ToolkitImagemagickFileMetadataTest extends BrowserTestBase {
use ToolkitSetupTrait;
/**
* Modules to enable.
*
* Enable 'file_test' to be able to work with dummy_remote:// stream wrapper.
*
* @var array
*/
public static $modules = [
'system',
'imagemagick',
'file_mdm',
'file_test',
];
/**
* {@inheritdoc}
*/
public function setUp() {
parent::setUp();
// Set the image factory.
$this->imageFactory = $this->container
->get('image.factory');
// Set the file system.
$this->fileSystem = $this->container
->get('file_system');
// Prepare a directory for test file results.
$this->testDirectory = 'public://imagetest';
// Set the toolkit on the image factory.
$this->imageFactory
->setToolkitId('imagemagick');
}
/**
* Test image toolkit integration with file metadata manager.
*
* @param string $toolkit_id
* The id of the toolkit to set up.
* @param string $toolkit_config
* The config object of the toolkit to set up.
* @param array $toolkit_settings
* The settings of the toolkit to set up.
*
* @dataProvider providerToolkitConfiguration
*/
public function testFileMetadata($toolkit_id, $toolkit_config, array $toolkit_settings) {
$this
->setUpToolkit($toolkit_id, $toolkit_config, $toolkit_settings);
$this
->prepareImageFileHandling();
$config = \Drupal::configFactory()
->getEditable('imagemagick.settings');
$config_mdm = \Drupal::configFactory()
->getEditable('file_mdm.settings');
// Reset file_mdm settings.
$config_mdm
->set('metadata_cache.enabled', TRUE)
->set('metadata_cache.disallowed_paths', [])
->save();
// A list of files that will be tested.
$files = [
'public://image-test.png' => [
'width' => 40,
'height' => 20,
'frames' => 1,
'mimetype' => 'image/png',
'colorspace' => 'SRGB',
'profiles' => [],
],
'public://image-test.gif' => [
'width' => 40,
'height' => 20,
'frames' => 1,
'mimetype' => 'image/gif',
'colorspace' => 'SRGB',
'profiles' => [],
],
'dummy-remote://image-test.jpg' => [
'width' => 40,
'height' => 20,
'frames' => 1,
'mimetype' => 'image/jpeg',
'colorspace' => 'SRGB',
'profiles' => [],
],
'public://test-multi-frame.gif' => [
'skip_dimensions_check' => TRUE,
'frames' => 13,
'mimetype' => 'image/gif',
'colorspace' => 'SRGB',
'profiles' => [],
],
'public://test-exif.jpeg' => [
'skip_dimensions_check' => TRUE,
'frames' => 1,
'mimetype' => 'image/jpeg',
'colorspace' => 'SRGB',
'profiles' => [
'exif',
],
],
'public://test-exif-icc.jpeg' => [
'skip_dimensions_check' => TRUE,
'frames' => 1,
'mimetype' => 'image/jpeg',
'colorspace' => 'SRGB',
'profiles' => [
'exif',
'icc',
],
],
];
// Setup a list of tests to perform on each type.
$operations = [
'resize' => [
'function' => 'resize',
'arguments' => [
'width' => 20,
'height' => 10,
],
'width' => 20,
'height' => 10,
],
'scale_x' => [
'function' => 'scale',
'arguments' => [
'width' => 20,
],
'width' => 20,
'height' => 10,
],
// Fuchsia background.
'rotate_5' => [
'function' => 'rotate',
'arguments' => [
'degrees' => 5,
'background' => '#FF00FF',
],
'width' => 41,
'height' => 23,
],
'convert_jpg' => [
'function' => 'convert',
'width' => 40,
'height' => 20,
'arguments' => [
'extension' => 'jpeg',
],
'mimetype' => 'image/jpeg',
],
];
// The file metadata manager service.
$fmdm = $this->container
->get('file_metadata_manager');
// Prepare a copy of test files.
file_unmanaged_copy(drupal_get_path('module', 'imagemagick') . '/misc/test-multi-frame.gif', 'public://', FILE_EXISTS_REPLACE);
file_unmanaged_copy(drupal_get_path('module', 'imagemagick') . '/misc/test-exif.jpeg', 'public://', FILE_EXISTS_REPLACE);
file_unmanaged_copy(drupal_get_path('module', 'imagemagick') . '/misc/test-exif-icc.jpeg', 'public://', FILE_EXISTS_REPLACE);
// Perform tests without caching.
$config_mdm
->set('metadata_cache.enabled', FALSE)
->save();
foreach ($files as $source_uri => $source_image_data) {
$this
->assertFalse($fmdm
->has($source_uri));
$source_image_md = $fmdm
->uri($source_uri);
$this
->assertTrue($fmdm
->has($source_uri), $source_uri);
$first = TRUE;
file_unmanaged_delete_recursive($this->testDirectory);
file_prepare_directory($this->testDirectory, FILE_CREATE_DIRECTORY);
foreach ($operations as $op => $values) {
// Load up a fresh image.
if ($first) {
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
}
else {
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
}
$source_image = $this->imageFactory
->get($source_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
$this
->assertSame($source_image_data['mimetype'], $source_image
->getMimeType());
if ($toolkit_settings['binaries'] === 'imagemagick') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
$this
->assertEquals($source_image_data['profiles'], $source_image
->getToolkit()
->getProfiles());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertSame($source_image_data['height'], $source_image
->getHeight());
$this
->assertSame($source_image_data['width'], $source_image
->getWidth());
}
// Perform our operation.
$source_image
->apply($values['function'], $values['arguments']);
// Save image.
$saved_uri = $this->testDirectory . '/' . $op . substr($source_uri, -4);
$this
->assertFalse($fmdm
->has($saved_uri));
$this
->assertTrue($source_image
->save($saved_uri));
$this
->assertFalse($fmdm
->has($saved_uri));
// Reload saved image and check data.
$saved_image_md = $fmdm
->uri($saved_uri);
$saved_image = $this->imageFactory
->get($saved_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $saved_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
$this
->assertSame($values['function'] === 'convert' ? $values['mimetype'] : $source_image_data['mimetype'], $saved_image
->getMimeType());
if ($toolkit_settings['binaries'] === 'imagemagick') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
$this
->assertEquals($source_image_data['profiles'], $source_image
->getToolkit()
->getProfiles());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image
->getHeight());
$this
->assertEquals($values['width'], $saved_image
->getWidth());
}
$fmdm
->release($saved_uri);
// Get metadata via the file_mdm service.
$saved_image_md = $fmdm
->uri($saved_uri);
// Should not be available at this stage.
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $saved_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
// Get metadata from file.
$saved_image_md
->getMetadata(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $saved_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image_md
->getMetadata(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID, 'height'));
$this
->assertEquals($values['width'], $saved_image_md
->getMetadata(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID, 'width'));
}
$fmdm
->release($saved_uri);
$first = FALSE;
}
$fmdm
->release($source_uri);
$this
->assertFalse($fmdm
->has($source_uri));
}
// Perform tests with caching.
$config_mdm
->set('metadata_cache.enabled', TRUE)
->save();
foreach ($files as $source_uri => $source_image_data) {
$first = TRUE;
file_unmanaged_delete_recursive($this->testDirectory);
file_prepare_directory($this->testDirectory, FILE_CREATE_DIRECTORY);
foreach ($operations as $op => $values) {
// Load up a fresh image.
$this
->assertFalse($fmdm
->has($source_uri));
$source_image_md = $fmdm
->uri($source_uri);
$this
->assertTrue($fmdm
->has($source_uri));
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
$source_image = $this->imageFactory
->get($source_uri);
if ($first) {
// First time load, metadata loaded from file.
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
}
else {
// Further loads, metadata loaded from cache.
$this
->assertSame(FileMetadataInterface::LOADED_FROM_CACHE, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
}
$this
->assertSame($source_image_data['mimetype'], $source_image
->getMimeType());
if ($toolkit_settings['binaries'] === 'imagemagick') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
$this
->assertEquals($source_image_data['profiles'], $source_image
->getToolkit()
->getProfiles());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertSame($source_image_data['height'], $source_image
->getHeight());
$this
->assertSame($source_image_data['width'], $source_image
->getWidth());
}
// Perform our operation.
$source_image
->apply($values['function'], $values['arguments']);
// Save image.
$saved_uri = $this->testDirectory . '/' . $op . substr($source_uri, -4);
$this
->assertFalse($fmdm
->has($saved_uri));
$this
->assertTrue($source_image
->save($saved_uri));
$this
->assertFalse($fmdm
->has($saved_uri));
// Reload saved image and check data.
$saved_image_md = $fmdm
->uri($saved_uri);
$saved_image = $this->imageFactory
->get($saved_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $saved_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
$this
->assertSame($values['function'] === 'convert' ? $values['mimetype'] : $source_image_data['mimetype'], $saved_image
->getMimeType());
if ($toolkit_settings['binaries'] === 'imagemagick') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
$this
->assertEquals($source_image_data['profiles'], $source_image
->getToolkit()
->getProfiles());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image
->getHeight());
$this
->assertEquals($values['width'], $saved_image
->getWidth());
}
$fmdm
->release($saved_uri);
// Get metadata via the file_mdm service. Should be cached.
$saved_image_md = $fmdm
->uri($saved_uri);
// Should not be available at this stage.
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $saved_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
// Get metadata from cache.
$saved_image_md
->getMetadata(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_CACHE, $saved_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image_md
->getMetadata(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID, 'height'));
$this
->assertEquals($values['width'], $saved_image_md
->getMetadata(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID, 'width'));
}
$fmdm
->release($saved_uri);
// We release the source image FileMetadata at each cycle to ensure
// that metadata is read from cache.
$fmdm
->release($source_uri);
$this
->assertFalse($fmdm
->has($source_uri));
$first = FALSE;
}
}
// Open source images again after deleting the temp folder files.
// Source image data should now be cached, but temp files non existing.
// Therefore we test that the toolkit can create a new temp file copy.
// Note: on Windows, temp imagemagick file names have a
// imaNNN.tmp.[image_extension] pattern so we cannot scan for
// 'imagemagick'.
$directory_scan = file_scan_directory('temporary://', '/ima.*/');
$this
->assertGreaterThan(0, count($directory_scan));
foreach ($directory_scan as $file) {
file_unmanaged_delete($file->uri);
}
$directory_scan = file_scan_directory('temporary://', '/ima.*/');
$this
->assertEquals(0, count($directory_scan));
foreach ($files as $source_uri => $source_image_data) {
file_unmanaged_delete_recursive($this->testDirectory);
file_prepare_directory($this->testDirectory, FILE_CREATE_DIRECTORY);
foreach ($operations as $op => $values) {
// Load up the source image. Parsing should be fully cached now.
$fmdm
->release($source_uri);
$source_image_md = $fmdm
->uri($source_uri);
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
$source_image = $this->imageFactory
->get($source_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_CACHE, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
$this
->assertSame($source_image_data['mimetype'], $source_image
->getMimeType());
if ($toolkit_settings['binaries'] === 'imagemagick') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
$this
->assertEquals($source_image_data['profiles'], $source_image
->getToolkit()
->getProfiles());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertSame($source_image_data['height'], $source_image
->getHeight());
$this
->assertSame($source_image_data['width'], $source_image
->getWidth());
}
// Perform our operation.
$source_image
->apply($values['function'], $values['arguments']);
// Save image.
$saved_uri = $this->testDirectory . '/' . $op . substr($source_uri, -4);
$this
->assertFalse($fmdm
->has($saved_uri));
$this
->assertTrue($source_image
->save($saved_uri));
$this
->assertFalse($fmdm
->has($saved_uri));
// Reload saved image and check data.
$saved_image_md = $fmdm
->uri($saved_uri);
$saved_image = $this->imageFactory
->get($saved_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $saved_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
$this
->assertSame($values['function'] === 'convert' ? $values['mimetype'] : $source_image_data['mimetype'], $saved_image
->getMimeType());
if ($toolkit_settings['binaries'] === 'imagemagick') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
$this
->assertEquals($source_image_data['profiles'], $source_image
->getToolkit()
->getProfiles());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image
->getHeight());
$this
->assertEquals($values['width'], $saved_image
->getWidth());
}
$fmdm
->release($saved_uri);
// Get metadata via the file_mdm service. Should be cached.
$saved_image_md = $fmdm
->uri($saved_uri);
// Should not be available at this stage.
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $saved_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
// Get metadata from cache.
$saved_image_md
->getMetadata(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_CACHE, $saved_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image_md
->getMetadata(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID, 'height'));
$this
->assertEquals($values['width'], $saved_image_md
->getMetadata(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID, 'width'));
}
$fmdm
->release($saved_uri);
}
$fmdm
->release($source_uri);
$this
->assertFalse($fmdm
->has($source_uri));
}
// Files in temporary:// must not be cached.
file_unmanaged_copy(drupal_get_path('module', 'imagemagick') . '/misc/test-multi-frame.gif', 'temporary://', FILE_EXISTS_REPLACE);
$source_uri = 'temporary://test-multi-frame.gif';
$fmdm
->release($source_uri);
$source_image_md = $fmdm
->uri($source_uri);
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
$source_image = $this->imageFactory
->get($source_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
$fmdm
->release($source_uri);
$source_image_md = $fmdm
->uri($source_uri);
$source_image = $this->imageFactory
->get($source_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
// Invalidate cache, and open source images again. Now, all files should be
// parsed again.
Cache::InvalidateTags([
'config:imagemagick.file_metadata_plugin.imagemagick_identify',
'config:file_mdm.file_metadata_plugin.getimagesize',
]);
// Disallow caching on the test results directory.
$config_mdm
->set('metadata_cache.disallowed_paths', [
'public://imagetest/*',
])
->save();
foreach ($files as $source_uri => $source_image_data) {
$fmdm
->release($source_uri);
}
foreach ($files as $source_uri => $source_image_data) {
$this
->assertFalse($fmdm
->has($source_uri));
$source_image_md = $fmdm
->uri($source_uri);
$this
->assertTrue($fmdm
->has($source_uri));
$first = TRUE;
file_unmanaged_delete_recursive($this->testDirectory);
file_prepare_directory($this->testDirectory, FILE_CREATE_DIRECTORY);
foreach ($operations as $op => $values) {
// Load up a fresh image.
if ($first) {
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
}
else {
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
}
$source_image = $this->imageFactory
->get($source_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
$this
->assertSame($source_image_data['mimetype'], $source_image
->getMimeType());
if ($toolkit_settings['binaries'] === 'imagemagick') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
$this
->assertEquals($source_image_data['profiles'], $source_image
->getToolkit()
->getProfiles());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertSame($source_image_data['height'], $source_image
->getHeight());
$this
->assertSame($source_image_data['width'], $source_image
->getWidth());
}
// Perform our operation.
$source_image
->apply($values['function'], $values['arguments']);
// Save image.
$saved_uri = $this->testDirectory . '/' . $op . substr($source_uri, -4);
$this
->assertFalse($fmdm
->has($saved_uri));
$this
->assertTrue($source_image
->save($saved_uri));
$this
->assertFalse($fmdm
->has($saved_uri));
// Reload saved image and check data.
$saved_image_md = $fmdm
->uri($saved_uri);
$saved_image = $this->imageFactory
->get($saved_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $saved_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
$this
->assertSame($values['function'] === 'convert' ? $values['mimetype'] : $source_image_data['mimetype'], $saved_image
->getMimeType());
if ($toolkit_settings['binaries'] === 'imagemagick') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
$this
->assertEquals($source_image_data['profiles'], $source_image
->getToolkit()
->getProfiles());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image
->getHeight());
$this
->assertEquals($values['width'], $saved_image
->getWidth());
}
$fmdm
->release($saved_uri);
// Get metadata via the file_mdm service.
$saved_image_md = $fmdm
->uri($saved_uri);
// Should not be available at this stage.
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $saved_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
// Get metadata from file.
$saved_image_md
->getMetadata(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $saved_image_md
->isMetadataLoaded(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID));
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image_md
->getMetadata(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID, 'height'));
$this
->assertEquals($values['width'], $saved_image_md
->getMetadata(ImagemagickToolkit::FILE_METADATA_PLUGIN_ID, 'width'));
}
$fmdm
->release($saved_uri);
$first = FALSE;
}
$fmdm
->release($source_uri);
$this
->assertFalse($fmdm
->has($source_uri));
}
}
/**
* Provides data for testFileMetadataLegacy.
*
* @return array[]
* A simple array of simple arrays, each having the following elements:
* - binaries to use for testing.
* - parsing method to use for testing.
*/
public function providerFileMetadataTestLegacy() {
return [
[
'imagemagick',
'getimagesize',
],
[
'graphicsmagick',
'getimagesize',
],
];
}
/**
* Test legacy image toolkit integration with file metadata manager.
*
* @param string $binaries
* The graphics package binaries to use for testing.
* @param string $parsing_method
* The parsing method to use for testing.
*
* @dataProvider providerFileMetadataTestLegacy
*
* @group legacy
*/
public function testFileMetadataLegacy($binaries, $parsing_method) {
$config = \Drupal::configFactory()
->getEditable('imagemagick.settings');
$config_mdm = \Drupal::configFactory()
->getEditable('file_mdm.settings');
// Reset file_mdm settings.
$config_mdm
->set('metadata_cache.enabled', TRUE)
->set('metadata_cache.disallowed_paths', [])
->save();
// Execute tests with selected binaries.
// The test can only be executed if binaries are available on the shell
// path.
$config
->set('binaries', $binaries)
->set('use_identify', $parsing_method === 'imagemagick_identify')
->save();
$status = \Drupal::service('image.toolkit.manager')
->createInstance('imagemagick')
->getExecManager()
->checkPath('');
if (!empty($status['errors'])) {
// Bots running automated test on d.o. do not have binaries installed,
// so the test will be skipped; it can be run locally where binaries are
// installed.
$this
->markTestSkipped("Tests for '{$binaries}' cannot run because the binaries are not available on the shell path.");
}
// A list of files that will be tested.
$files = [
'public://image-test.png' => [
'width' => 40,
'height' => 20,
'frames' => 1,
'mimetype' => 'image/png',
'colorspace' => 'SRGB',
],
'public://image-test.gif' => [
'width' => 40,
'height' => 20,
'frames' => 1,
'mimetype' => 'image/gif',
'colorspace' => 'SRGB',
],
'dummy-remote://image-test.jpg' => [
'width' => 40,
'height' => 20,
'frames' => 1,
'mimetype' => 'image/jpeg',
'colorspace' => 'SRGB',
],
'public://test-multi-frame.gif' => [
'skip_dimensions_check' => TRUE,
'frames' => 13,
'mimetype' => 'image/gif',
'colorspace' => 'SRGB',
],
];
// Setup a list of tests to perform on each type.
$operations = [
'resize' => [
'function' => 'resize',
'arguments' => [
'width' => 20,
'height' => 10,
],
'width' => 20,
'height' => 10,
],
'scale_x' => [
'function' => 'scale',
'arguments' => [
'width' => 20,
],
'width' => 20,
'height' => 10,
],
// Fuchsia background.
'rotate_5' => [
'function' => 'rotate',
'arguments' => [
'degrees' => 5,
'background' => '#FF00FF',
],
'width' => 41,
'height' => 23,
],
'convert_jpg' => [
'function' => 'convert',
'width' => 40,
'height' => 20,
'arguments' => [
'extension' => 'jpeg',
],
'mimetype' => 'image/jpeg',
],
];
// The file metadata manager service.
$fmdm = $this->container
->get('file_metadata_manager');
// Prepare a copy of test files.
$this
->getTestFiles('image');
file_unmanaged_copy(drupal_get_path('module', 'imagemagick') . '/misc/test-multi-frame.gif', 'public://', FILE_EXISTS_REPLACE);
// Perform tests without caching.
$config_mdm
->set('metadata_cache.enabled', FALSE)
->save();
foreach ($files as $source_uri => $source_image_data) {
$this
->assertFalse($fmdm
->has($source_uri));
$source_image_md = $fmdm
->uri($source_uri);
$this
->assertTrue($fmdm
->has($source_uri));
$first = TRUE;
file_unmanaged_delete_recursive($this->testDirectory);
file_prepare_directory($this->testDirectory, FILE_CREATE_DIRECTORY);
foreach ($operations as $op => $values) {
// Load up a fresh image.
if ($first) {
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $source_image_md
->isMetadataLoaded($parsing_method));
}
else {
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded($parsing_method));
}
$source_image = $this->imageFactory
->get($source_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded($parsing_method));
$this
->assertSame($source_image_data['mimetype'], $source_image
->getMimeType());
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertSame($source_image_data['height'], $source_image
->getHeight());
$this
->assertSame($source_image_data['width'], $source_image
->getWidth());
}
// Perform our operation.
$source_image
->apply($values['function'], $values['arguments']);
// Save image.
$saved_uri = $this->testDirectory . '/' . $op . substr($source_uri, -4);
$this
->assertFalse($fmdm
->has($saved_uri));
$this
->assertTrue($source_image
->save($saved_uri));
// In some cases the metadata can be generated on save without need to
// re-read it back from the image.
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify' && $source_image
->getToolkit()
->getFrames() === 1) {
$this
->assertTrue($fmdm
->has($saved_uri));
}
else {
$this
->assertFalse($fmdm
->has($saved_uri));
}
// Reload saved image and check data.
$saved_image_md = $fmdm
->uri($saved_uri);
$saved_image = $this->imageFactory
->get($saved_uri);
// In some cases the metadata can be generated on save without need to
// re-read it back from the image.
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify' && $saved_image
->getToolkit()
->getFrames() === 1 && !($values['function'] === 'convert' && $source_image_data['frames'] > 1)) {
$this
->assertSame(FileMetadataInterface::LOADED_BY_CODE, $saved_image_md
->isMetadataLoaded($parsing_method));
}
else {
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $saved_image_md
->isMetadataLoaded($parsing_method));
}
$this
->assertSame($values['function'] === 'convert' ? $values['mimetype'] : $source_image_data['mimetype'], $saved_image
->getMimeType());
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image
->getHeight());
$this
->assertEquals($values['width'], $saved_image
->getWidth());
}
$fmdm
->release($saved_uri);
// Get metadata via the file_mdm service.
$saved_image_md = $fmdm
->uri($saved_uri);
// Should not be available at this stage.
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $saved_image_md
->isMetadataLoaded($parsing_method));
// Get metadata from file.
$saved_image_md
->getMetadata($parsing_method);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $saved_image_md
->isMetadataLoaded($parsing_method));
switch ($parsing_method) {
case 'imagemagick_identify':
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image_md
->getMetadata($parsing_method, 'height'));
$this
->assertEquals($values['width'], $saved_image_md
->getMetadata($parsing_method, 'width'));
}
break;
case 'getimagesize':
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image_md
->getMetadata($parsing_method, 1));
$this
->assertEquals($values['width'], $saved_image_md
->getMetadata($parsing_method, 0));
}
break;
}
$fmdm
->release($saved_uri);
$first = FALSE;
}
$fmdm
->release($source_uri);
$this
->assertFalse($fmdm
->has($source_uri));
}
// Perform tests with caching.
$config_mdm
->set('metadata_cache.enabled', TRUE)
->save();
foreach ($files as $source_uri => $source_image_data) {
$first = TRUE;
file_unmanaged_delete_recursive($this->testDirectory);
file_prepare_directory($this->testDirectory, FILE_CREATE_DIRECTORY);
foreach ($operations as $op => $values) {
// Load up a fresh image.
$this
->assertFalse($fmdm
->has($source_uri));
$source_image_md = $fmdm
->uri($source_uri);
$this
->assertTrue($fmdm
->has($source_uri));
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $source_image_md
->isMetadataLoaded($parsing_method));
$source_image = $this->imageFactory
->get($source_uri);
if ($first) {
// First time load, metadata loaded from file.
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded($parsing_method));
}
else {
// Further loads, metadata loaded from cache.
$this
->assertSame(FileMetadataInterface::LOADED_FROM_CACHE, $source_image_md
->isMetadataLoaded($parsing_method));
}
$this
->assertSame($source_image_data['mimetype'], $source_image
->getMimeType());
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertSame($source_image_data['height'], $source_image
->getHeight());
$this
->assertSame($source_image_data['width'], $source_image
->getWidth());
}
// Perform our operation.
$source_image
->apply($values['function'], $values['arguments']);
// Save image.
$saved_uri = $this->testDirectory . '/' . $op . substr($source_uri, -4);
$this
->assertFalse($fmdm
->has($saved_uri));
$this
->assertTrue($source_image
->save($saved_uri));
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify' && $source_image
->getToolkit()
->getFrames() === 1) {
$this
->assertTrue($fmdm
->has($saved_uri));
}
else {
$this
->assertFalse($fmdm
->has($saved_uri));
}
// Reload saved image and check data.
$saved_image_md = $fmdm
->uri($saved_uri);
$saved_image = $this->imageFactory
->get($saved_uri);
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify' && $saved_image
->getToolkit()
->getFrames() === 1 && !($values['function'] === 'convert' && $source_image_data['frames'] > 1)) {
$this
->assertSame(FileMetadataInterface::LOADED_BY_CODE, $saved_image_md
->isMetadataLoaded($parsing_method));
}
else {
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $saved_image_md
->isMetadataLoaded($parsing_method));
}
$this
->assertSame($values['function'] === 'convert' ? $values['mimetype'] : $source_image_data['mimetype'], $saved_image
->getMimeType());
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image
->getHeight());
$this
->assertEquals($values['width'], $saved_image
->getWidth());
}
$fmdm
->release($saved_uri);
// Get metadata via the file_mdm service. Should be cached.
$saved_image_md = $fmdm
->uri($saved_uri);
// Should not be available at this stage.
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $saved_image_md
->isMetadataLoaded($parsing_method));
// Get metadata from cache.
$saved_image_md
->getMetadata($parsing_method);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_CACHE, $saved_image_md
->isMetadataLoaded($parsing_method));
switch ($parsing_method) {
case 'imagemagick_identify':
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image_md
->getMetadata($parsing_method, 'height'));
$this
->assertEquals($values['width'], $saved_image_md
->getMetadata($parsing_method, 'width'));
}
break;
case 'getimagesize':
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image_md
->getMetadata($parsing_method, 1));
$this
->assertEquals($values['width'], $saved_image_md
->getMetadata($parsing_method, 0));
}
break;
}
$fmdm
->release($saved_uri);
// We release the source image FileMetadata at each cycle to ensure
// that metadata is read from cache.
$fmdm
->release($source_uri);
$this
->assertFalse($fmdm
->has($source_uri));
$first = FALSE;
}
}
// Open source images again after deleting the temp folder files.
// Source image data should now be cached, but temp files non existing.
// Therefore we test that the toolkit can create a new temp file copy.
// Note: on Windows, temp imagemagick file names have a
// imaNNN.tmp.[image_extension] pattern so we cannot scan for
// 'imagemagick'.
$directory_scan = file_scan_directory('temporary://', '/ima.*/');
$this
->assertGreaterThan(0, count($directory_scan));
foreach ($directory_scan as $file) {
file_unmanaged_delete($file->uri);
}
$directory_scan = file_scan_directory('temporary://', '/ima.*/');
$this
->assertEquals(0, count($directory_scan));
foreach ($files as $source_uri => $source_image_data) {
file_unmanaged_delete_recursive($this->testDirectory);
file_prepare_directory($this->testDirectory, FILE_CREATE_DIRECTORY);
foreach ($operations as $op => $values) {
// Load up the source image. Parsing should be fully cached now.
$fmdm
->release($source_uri);
$source_image_md = $fmdm
->uri($source_uri);
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $source_image_md
->isMetadataLoaded($parsing_method));
$source_image = $this->imageFactory
->get($source_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_CACHE, $source_image_md
->isMetadataLoaded($parsing_method));
$this
->assertSame($source_image_data['mimetype'], $source_image
->getMimeType());
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertSame($source_image_data['height'], $source_image
->getHeight());
$this
->assertSame($source_image_data['width'], $source_image
->getWidth());
}
// Perform our operation.
$source_image
->apply($values['function'], $values['arguments']);
// Save image.
$saved_uri = $this->testDirectory . '/' . $op . substr($source_uri, -4);
$this
->assertFalse($fmdm
->has($saved_uri));
$this
->assertTrue($source_image
->save($saved_uri));
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify' && $source_image
->getToolkit()
->getFrames() === 1) {
$this
->assertTrue($fmdm
->has($saved_uri));
}
else {
$this
->assertFalse($fmdm
->has($saved_uri));
}
// Reload saved image and check data.
$saved_image_md = $fmdm
->uri($saved_uri);
$saved_image = $this->imageFactory
->get($saved_uri);
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify' && $saved_image
->getToolkit()
->getFrames() === 1 && !($values['function'] === 'convert' && $source_image_data['frames'] > 1)) {
$this
->assertSame(FileMetadataInterface::LOADED_BY_CODE, $saved_image_md
->isMetadataLoaded($parsing_method));
}
else {
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $saved_image_md
->isMetadataLoaded($parsing_method));
}
$this
->assertSame($values['function'] === 'convert' ? $values['mimetype'] : $source_image_data['mimetype'], $saved_image
->getMimeType());
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image
->getHeight());
$this
->assertEquals($values['width'], $saved_image
->getWidth());
}
$fmdm
->release($saved_uri);
// Get metadata via the file_mdm service. Should be cached.
$saved_image_md = $fmdm
->uri($saved_uri);
// Should not be available at this stage.
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $saved_image_md
->isMetadataLoaded($parsing_method));
// Get metadata from cache.
$saved_image_md
->getMetadata($parsing_method);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_CACHE, $saved_image_md
->isMetadataLoaded($parsing_method));
switch ($parsing_method) {
case 'imagemagick_identify':
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image_md
->getMetadata($parsing_method, 'height'));
$this
->assertEquals($values['width'], $saved_image_md
->getMetadata($parsing_method, 'width'));
}
break;
case 'getimagesize':
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image_md
->getMetadata($parsing_method, 1));
$this
->assertEquals($values['width'], $saved_image_md
->getMetadata($parsing_method, 0));
}
break;
}
$fmdm
->release($saved_uri);
}
$fmdm
->release($source_uri);
$this
->assertFalse($fmdm
->has($source_uri));
}
// Files in temporary:// must not be cached.
if ($parsing_method === 'imagemagick_identify') {
file_unmanaged_copy(drupal_get_path('module', 'imagemagick') . '/misc/test-multi-frame.gif', 'temporary://', FILE_EXISTS_REPLACE);
$source_uri = 'temporary://test-multi-frame.gif';
$fmdm
->release($source_uri);
$source_image_md = $fmdm
->uri($source_uri);
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $source_image_md
->isMetadataLoaded('imagemagick_identify'));
$source_image = $this->imageFactory
->get($source_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded('imagemagick_identify'));
$fmdm
->release($source_uri);
$source_image_md = $fmdm
->uri($source_uri);
$source_image = $this->imageFactory
->get($source_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded('imagemagick_identify'));
}
// Invalidate cache, and open source images again. Now, all files should be
// parsed again.
Cache::InvalidateTags([
'config:imagemagick.file_metadata_plugin.imagemagick_identify',
'config:file_mdm.file_metadata_plugin.getimagesize',
]);
// Disallow caching on the test results directory.
$config_mdm
->set('metadata_cache.disallowed_paths', [
'public://imagetest/*',
])
->save();
foreach ($files as $source_uri => $source_image_data) {
$fmdm
->release($source_uri);
}
foreach ($files as $source_uri => $source_image_data) {
$this
->assertFalse($fmdm
->has($source_uri));
$source_image_md = $fmdm
->uri($source_uri);
$this
->assertTrue($fmdm
->has($source_uri));
$first = TRUE;
file_unmanaged_delete_recursive($this->testDirectory);
file_prepare_directory($this->testDirectory, FILE_CREATE_DIRECTORY);
foreach ($operations as $op => $values) {
// Load up a fresh image.
if ($first) {
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $source_image_md
->isMetadataLoaded($parsing_method));
}
else {
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded($parsing_method));
}
$source_image = $this->imageFactory
->get($source_uri);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $source_image_md
->isMetadataLoaded($parsing_method));
$this
->assertSame($source_image_data['mimetype'], $source_image
->getMimeType());
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertSame($source_image_data['height'], $source_image
->getHeight());
$this
->assertSame($source_image_data['width'], $source_image
->getWidth());
}
// Perform our operation.
$source_image
->apply($values['function'], $values['arguments']);
// Save image.
$saved_uri = $this->testDirectory . '/' . $op . substr($source_uri, -4);
$this
->assertFalse($fmdm
->has($saved_uri));
$this
->assertTrue($source_image
->save($saved_uri));
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify' && $source_image
->getToolkit()
->getFrames() === 1) {
$this
->assertTrue($fmdm
->has($saved_uri));
}
else {
$this
->assertFalse($fmdm
->has($saved_uri));
}
// Reload saved image and check data.
$saved_image_md = $fmdm
->uri($saved_uri);
$saved_image = $this->imageFactory
->get($saved_uri);
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify' && $saved_image
->getToolkit()
->getFrames() === 1 && !($values['function'] === 'convert' && $source_image_data['frames'] > 1)) {
$this
->assertSame(FileMetadataInterface::LOADED_BY_CODE, $saved_image_md
->isMetadataLoaded($parsing_method));
}
else {
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $saved_image_md
->isMetadataLoaded($parsing_method));
}
$this
->assertSame($values['function'] === 'convert' ? $values['mimetype'] : $source_image_data['mimetype'], $saved_image
->getMimeType());
if ($binaries === 'imagemagick' && $parsing_method === 'imagemagick_identify') {
$this
->assertSame($source_image_data['colorspace'], $source_image
->getToolkit()
->getColorspace());
}
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image
->getHeight());
$this
->assertEquals($values['width'], $saved_image
->getWidth());
}
$fmdm
->release($saved_uri);
// Get metadata via the file_mdm service.
$saved_image_md = $fmdm
->uri($saved_uri);
// Should not be available at this stage.
$this
->assertSame(FileMetadataInterface::NOT_LOADED, $saved_image_md
->isMetadataLoaded($parsing_method));
// Get metadata from file.
$saved_image_md
->getMetadata($parsing_method);
$this
->assertSame(FileMetadataInterface::LOADED_FROM_FILE, $saved_image_md
->isMetadataLoaded($parsing_method));
switch ($parsing_method) {
case 'imagemagick_identify':
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image_md
->getMetadata($parsing_method, 'height'));
$this
->assertEquals($values['width'], $saved_image_md
->getMetadata($parsing_method, 'width'));
}
break;
case 'getimagesize':
if (!isset($source_image_data['skip_dimensions_check'])) {
$this
->assertEquals($values['height'], $saved_image_md
->getMetadata($parsing_method, 1));
$this
->assertEquals($values['width'], $saved_image_md
->getMetadata($parsing_method, 0));
}
break;
}
$fmdm
->release($saved_uri);
$first = FALSE;
}
$fmdm
->release($source_uri);
$this
->assertFalse($fmdm
->has($source_uri));
}
}
/**
* Tests getSourceLocalPath() for re-creating local path.
*
* @param string $toolkit_id
* The id of the toolkit to set up.
* @param string $toolkit_config
* The config object of the toolkit to set up.
* @param array $toolkit_settings
* The settings of the toolkit to set up.
*
* @dataProvider providerToolkitConfiguration
*/
public function testSourceLocalPath($toolkit_id, $toolkit_config, array $toolkit_settings) {
$this
->setUpToolkit($toolkit_id, $toolkit_config, $toolkit_settings);
$this
->prepareImageFileHandling();
$config = \Drupal::configFactory()
->getEditable('imagemagick.settings');
$config_mdm = \Drupal::configFactory()
->getEditable('file_mdm.settings');
// The file metadata manager service.
$fmdm = $this->container
->get('file_metadata_manager');
// The file that will be tested.
$source_uri = 'public://image-test.png';
// Enable metadata caching.
$config_mdm
->set('metadata_cache.enabled', TRUE)
->save();
// Parse with identify.
$config
->set('use_identify', TRUE)
->save();
// Load up the image.
$image = $this->imageFactory
->get($source_uri);
$this
->assertEquals($source_uri, $image
->getToolkit()
->getSource());
$this
->assertEquals($this->fileSystem
->realpath($source_uri), $image
->getToolkit()
->arguments()
->getSourceLocalPath());
// Free up the URI from the file metadata manager to force reload from
// cache. Simulates that next imageFactory->get is from another request.
$fmdm
->release($source_uri);
// Re-load the image, ensureLocalSourcePath should return the local path.
$image1 = $this->imageFactory
->get($source_uri);
$this
->assertEquals($source_uri, $image1
->getToolkit()
->getSource());
$this
->assertEquals($this->fileSystem
->realpath($source_uri), $image1
->getToolkit()
->ensureSourceLocalPath());
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Asserts whether an expected cache tag was present in the last response. | |
AssertLegacyTrait:: |
protected | function | Asserts that the element with the given CSS selector is not present. | |
AssertLegacyTrait:: |
protected | function | Asserts that the element with the given CSS selector is present. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertLegacyTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertLegacyTrait:: |
protected | function | Checks that current response header equals value. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertLegacyTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertLegacyTrait:: |
protected | function | Asserts whether an expected cache tag was absent in the last response. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text is not found escaped on the loaded page. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does NOT exist with the given name or ID. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertLegacyTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertLegacyTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertLegacyTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option does NOT exist in the current page. | |
AssertLegacyTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is not found in the raw content. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS not found on the loaded page, fail otherwise. | 1 |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | 1 |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertLegacyTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | 1 |
AssertLegacyTrait:: |
protected | function | Asserts the page responds with the specified response code. | 1 |
AssertLegacyTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | 1 |
AssertLegacyTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertLegacyTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertLegacyTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertLegacyTrait:: |
protected | function | Passes if the internal browser's URL matches the given path. | |
AssertLegacyTrait:: |
protected | function | Builds an XPath query. | |
AssertLegacyTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertLegacyTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertLegacyTrait:: |
protected | function | Gets the current raw content. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
BlockCreationTrait:: |
protected | function | Creates a block instance based on default settings. Aliased as: drupalPlaceBlock | |
BrowserHtmlDebugTrait:: |
protected | property | The Base URI to use for links to the output files. | |
BrowserHtmlDebugTrait:: |
protected | property | Class name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter storage for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Directory name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output output enabled. | |
BrowserHtmlDebugTrait:: |
protected | property | The file name to write the list of URLs to. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output test ID. | |
BrowserHtmlDebugTrait:: |
protected | function | Formats HTTP headers as string for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | function | Returns headers in HTML output format. | 1 |
BrowserHtmlDebugTrait:: |
protected | function | Logs a HTML output message in a text file. | |
BrowserHtmlDebugTrait:: |
protected | function | Creates the directory to store browser output. | |
BrowserTestBase:: |
protected | property | The base URL. | |
BrowserTestBase:: |
protected | property | The config importer that can be used in a test. | |
BrowserTestBase:: |
protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | |
BrowserTestBase:: |
protected | property | The database prefix of this test run. | |
BrowserTestBase:: |
protected | property | The theme to install as the default for testing. | 1,597 |
BrowserTestBase:: |
protected | property | Mink session manager. | |
BrowserTestBase:: |
protected | property | ||
BrowserTestBase:: |
protected | property | 1 | |
BrowserTestBase:: |
protected | property | The original container. | |
BrowserTestBase:: |
protected | property | The original array of shutdown function callbacks. | |
BrowserTestBase:: |
protected | property | ||
BrowserTestBase:: |
protected | property | The profile to install as a basis for testing. | 39 |
BrowserTestBase:: |
protected | property | The app root. | |
BrowserTestBase:: |
protected | property | Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests. | |
BrowserTestBase:: |
protected | property | Time limit in seconds for the test. | |
BrowserTestBase:: |
protected | property | The translation file directory for the test environment. | |
BrowserTestBase:: |
protected | function | Clean up the Simpletest environment. | |
BrowserTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
BrowserTestBase:: |
protected | function | Translates a CSS expression to its XPath equivalent. | |
BrowserTestBase:: |
protected | function | Gets the value of an HTTP response header. | |
BrowserTestBase:: |
protected | function | Returns all response headers. | |
BrowserTestBase:: |
public static | function | Ensures test files are deletable. | |
BrowserTestBase:: |
protected | function | Gets an instance of the default Mink driver. | |
BrowserTestBase:: |
protected | function | Gets the JavaScript drupalSettings variable for the currently-loaded page. | 1 |
BrowserTestBase:: |
protected | function | Obtain the HTTP client for the system under test. | |
BrowserTestBase:: |
protected | function | Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. | 1 |
BrowserTestBase:: |
protected | function | Helper function to get the options of select field. | |
BrowserTestBase:: |
protected | function |
Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait:: |
|
BrowserTestBase:: |
public | function | Returns Mink session. | |
BrowserTestBase:: |
protected | function | Get session cookies from current session. | |
BrowserTestBase:: |
protected | function |
Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait:: |
|
BrowserTestBase:: |
protected | function | Visits the front page when initializing Mink. | 3 |
BrowserTestBase:: |
protected | function | Initializes Mink sessions. | 1 |
BrowserTestBase:: |
public | function | Installs Drupal into the Simpletest site. | 1 |
BrowserTestBase:: |
protected | function | Registers additional Mink sessions. | |
BrowserTestBase:: |
protected | function | 3 | |
BrowserTestBase:: |
protected | function | Transforms a nested array into a flat array suitable for drupalPostForm(). | |
BrowserTestBase:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
BrowserTestBase:: |
public | function | 1 | |
BrowserTestBase:: |
public | function | Prevents serializing any properties. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ContentTypeCreationTrait:: |
protected | function | Creates a custom content type based on default settings. Aliased as: drupalCreateContentType | 1 |
FunctionalTestSetupTrait:: |
protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 |
FunctionalTestSetupTrait:: |
protected | property | The class loader to use for installation and initialization of setup. | |
FunctionalTestSetupTrait:: |
protected | property | The config directories used in this test. | |
FunctionalTestSetupTrait:: |
protected | property | The "#1" admin user. | |
FunctionalTestSetupTrait:: |
protected | function | Execute the non-interactive installer. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns all supported database driver installer objects. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize various configurations post-installation. | 2 |
FunctionalTestSetupTrait:: |
protected | function | Initializes the kernel after installation. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize settings created during install. | |
FunctionalTestSetupTrait:: |
protected | function | Initializes user 1 for the site to be installed. | |
FunctionalTestSetupTrait:: |
protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | |
FunctionalTestSetupTrait:: |
protected | function | Install modules defined by `static::$modules`. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns the parameters that will be used when Simpletest installs Drupal. | 9 |
FunctionalTestSetupTrait:: |
protected | function | Prepares the current environment for running the test. | 23 |
FunctionalTestSetupTrait:: |
protected | function | Creates a mock request and sets it on the generator. | |
FunctionalTestSetupTrait:: |
protected | function | Prepares site settings and services before installation. | 2 |
FunctionalTestSetupTrait:: |
protected | function | Resets and rebuilds the environment after setup. | |
FunctionalTestSetupTrait:: |
protected | function | Rebuilds \Drupal::getContainer(). | |
FunctionalTestSetupTrait:: |
protected | function | Resets all data structures after having enabled new modules. | |
FunctionalTestSetupTrait:: |
protected | function | Changes parameters in the services.yml file. | |
FunctionalTestSetupTrait:: |
protected | function | Sets up the base URL based upon the environment variable. | |
FunctionalTestSetupTrait:: |
protected | function | Rewrites the settings.php file of the test site. | |
NodeCreationTrait:: |
protected | function | Creates a node based on default settings. Aliased as: drupalCreateNode | |
NodeCreationTrait:: |
public | function | Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
RefreshVariablesTrait:: |
protected | function | Refreshes in-memory configuration and state information. | 3 |
SessionTestTrait:: |
protected | property | The name of the session cookie. | |
SessionTestTrait:: |
protected | function | Generates a session cookie name. | |
SessionTestTrait:: |
protected | function | Returns the session name in use on the child site. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestFileCreationTrait:: |
protected | property | Whether the files were copied to the test files directory. | |
TestFileCreationTrait:: |
protected | function | Compares two files based on size and file name. | |
TestFileCreationTrait:: |
public static | function | Generates a test file. | |
TestFileCreationTrait:: |
protected | function | Gets a list of files that can be used in tests. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
TestSetupTrait:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
TestSetupTrait:: |
protected | property | The dependency injection container used in the test. | |
TestSetupTrait:: |
protected | property | The DrupalKernel instance used in the test. | |
TestSetupTrait:: |
protected | property | The site directory of the original parent site. | |
TestSetupTrait:: |
protected | property | The private file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The public file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The site directory of this test run. | |
TestSetupTrait:: |
protected | property | Set to TRUE to strict check all configuration saved. | 2 |
TestSetupTrait:: |
protected | property | The temporary file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The test run ID. | |
TestSetupTrait:: |
protected | function | Changes the database connection to the prefixed one. | |
TestSetupTrait:: |
protected | function | Gets the config schema exclusions for this test. | |
TestSetupTrait:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestSetupTrait:: |
protected | function | Generates a database prefix for running tests. | 2 |
ToolkitImagemagickFileMetadataTest:: |
public static | property |
Modules to enable. Overrides BrowserTestBase:: |
|
ToolkitImagemagickFileMetadataTest:: |
public | function | Provides data for testFileMetadataLegacy. | |
ToolkitImagemagickFileMetadataTest:: |
public | function |
Overrides BrowserTestBase:: |
|
ToolkitImagemagickFileMetadataTest:: |
public | function | Test image toolkit integration with file metadata manager. | |
ToolkitImagemagickFileMetadataTest:: |
public | function | Test legacy image toolkit integration with file metadata manager. | |
ToolkitImagemagickFileMetadataTest:: |
public | function | Tests getSourceLocalPath() for re-creating local path. | |
ToolkitSetupTrait:: |
protected | property | The file system service. | |
ToolkitSetupTrait:: |
protected | property | The image factory service. | |
ToolkitSetupTrait:: |
protected | property | A directory for image test file results. | |
ToolkitSetupTrait:: |
protected | function | Prepares image files for test handling. | |
ToolkitSetupTrait:: |
public | function | Provides toolkit configuration data for tests. | |
ToolkitSetupTrait:: |
protected | function | Sets up the image toolkit. | |
UiHelperTrait:: |
protected | property | The current user logged in using the Mink controlled browser. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects followed during ::drupalGet(). | |
UiHelperTrait:: |
public | function | Returns WebAssert object. | 1 |
UiHelperTrait:: |
protected | function | Builds an a absolute URL from a system path or a URL object. | |
UiHelperTrait:: |
protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | |
UiHelperTrait:: |
protected | function | Clicks the element with the given CSS selector. | |
UiHelperTrait:: |
protected | function | Follows a link by complete name. | |
UiHelperTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
UiHelperTrait:: |
protected | function | Retrieves a Drupal path or an absolute path. | 3 |
UiHelperTrait:: |
protected | function | Logs in a user using the Mink controlled browser. | |
UiHelperTrait:: |
protected | function | Logs a user out of the Mink controlled browser and confirms. | |
UiHelperTrait:: |
protected | function | Executes a form submission. | |
UiHelperTrait:: |
protected | function | Returns whether a given user account is logged in. | |
UiHelperTrait:: |
protected | function | Takes a path and returns an absolute path. | |
UiHelperTrait:: |
protected | function | Retrieves the plain-text content from the current page. | |
UiHelperTrait:: |
protected | function | Get the current URL from the browser. | |
UiHelperTrait:: |
protected | function | Prepare for a request to testing site. | 1 |
UiHelperTrait:: |
protected | function | Fills and submits a form. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. | |
UserCreationTrait:: |
protected | function | Creates an administrative role. | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. | |
XdebugRequestTrait:: |
protected | function | Adds xdebug cookies, from request setup. |