public function ToolkitImagemagickTest::testManipulations in ImageMagick 8.2

Same name and namespace in other branches

1. 8.3 tests/src/Functional/ToolkitImagemagickTest.php \Drupal\Tests\imagemagick\Functional\ToolkitImagemagickTest::testManipulations()
2. 8 tests/src/Functional/ToolkitImagemagickTest.php \Drupal\Tests\imagemagick\Functional\ToolkitImagemagickTest::testManipulations()

Test image toolkit operations.

Since PHP can't visually check that our images have been manipulated properly, build a list of expected color values for each of the corners and the expected height and widths for the final images.

@dataProvider providerToolkitConfiguration

Parameters

string $toolkit_id: The id of the toolkit to set up.

string $toolkit_config: The config object of the toolkit to set up.

array $toolkit_settings: The settings of the toolkit to set up.

File

tests/src/Functional/ToolkitImagemagickTest.php, line 118

Class

ToolkitImagemagickTest

Tests that core image manipulations work properly through Imagemagick.

Namespace

Drupal\Tests\imagemagick\Functional

Code

public function testManipulations($toolkit_id, $toolkit_config, array $toolkit_settings) {
  $this
    ->setUpToolkit($toolkit_id, $toolkit_config, $toolkit_settings);
  $this
    ->prepareImageFileHandling();

  // Typically the corner colors will be unchanged. These colors are in the
  // order of top-left, top-right, bottom-right, bottom-left.
  $default_corners = [
    $this->red,
    $this->green,
    $this->blue,
    $this->transparent,
  ];

  // A list of files that will be tested.
  $files = [
    'image-test.png',
    'image-test.gif',
    'image-test-no-transparency.gif',
    'image-test.jpg',
  ];

  // Setup a list of tests to perform on each type.
  $operations = [
    'resize' => [
      'function' => 'resize',
      'arguments' => [
        'width' => 20,
        'height' => 10,
      ],
      'width' => 20,
      'height' => 10,
      'corners' => $default_corners,
      'tolerance' => 0,
    ],
    'scale_x' => [
      'function' => 'scale',
      'arguments' => [
        'width' => 20,
      ],
      'width' => 20,
      'height' => 10,
      'corners' => $default_corners,
      'tolerance' => 0,
    ],
    'scale_y' => [
      'function' => 'scale',
      'arguments' => [
        'height' => 10,
      ],
      'width' => 20,
      'height' => 10,
      'corners' => $default_corners,
      'tolerance' => 0,
    ],
    'upscale_x' => [
      'function' => 'scale',
      'arguments' => [
        'width' => 80,
        'upscale' => TRUE,
      ],
      'width' => 80,
      'height' => 40,
      'corners' => $default_corners,
      'tolerance' => 0,
    ],
    'upscale_y' => [
      'function' => 'scale',
      'arguments' => [
        'height' => 40,
        'upscale' => TRUE,
      ],
      'width' => 80,
      'height' => 40,
      'corners' => $default_corners,
      'tolerance' => 0,
    ],
    'crop' => [
      'function' => 'crop',
      'arguments' => [
        'x' => 12,
        'y' => 4,
        'width' => 16,
        'height' => 12,
      ],
      'width' => 16,
      'height' => 12,
      'corners' => array_fill(0, 4, $this->white),
      'tolerance' => 0,
    ],
    'scale_and_crop' => [
      'function' => 'scale_and_crop',
      'arguments' => [
        'width' => 10,
        'height' => 8,
      ],
      'width' => 10,
      'height' => 8,
      'corners' => array_fill(0, 4, $this->black),
      'tolerance' => 100,
    ],
    'convert_jpg' => [
      'function' => 'convert',
      'width' => 40,
      'height' => 20,
      'arguments' => [
        'extension' => 'jpeg',
      ],
      'mimetype' => 'image/jpeg',
      'corners' => $default_corners,
      'tolerance' => 0,
    ],
    'convert_gif' => [
      'function' => 'convert',
      'width' => 40,
      'height' => 20,
      'arguments' => [
        'extension' => 'gif',
      ],
      'mimetype' => 'image/gif',
      'corners' => $default_corners,
      'tolerance' => 15,
    ],
    'convert_png' => [
      'function' => 'convert',
      'width' => 40,
      'height' => 20,
      'arguments' => [
        'extension' => 'png',
      ],
      'mimetype' => 'image/png',
      'corners' => $default_corners,
      'tolerance' => 5,
    ],
    'rotate_5' => [
      'function' => 'rotate',
      'arguments' => [
        'degrees' => 5,
        'background' => '#FF00FF',
        'resize_filter' => 'Box',
      ],
      'width' => 41,
      'height' => 23,
      'corners' => array_fill(0, 4, $this->fuchsia),
      'tolerance' => 5,
    ],
    'rotate_minus_10' => [
      'function' => 'rotate',
      'arguments' => [
        'degrees' => -10,
        'background' => '#FF00FF',
        'resize_filter' => 'Box',
      ],
      'width' => 41,
      'height' => 26,
      'corners' => array_fill(0, 4, $this->fuchsia),
      'tolerance' => 15,
    ],
    'rotate_90' => [
      'function' => 'rotate',
      'arguments' => [
        'degrees' => 90,
        'background' => '#FF00FF',
      ],
      'width' => 20,
      'height' => 40,
      'corners' => [
        $this->transparent,
        $this->red,
        $this->green,
        $this->blue,
      ],
      'tolerance' => 0,
    ],
    'rotate_transparent_5' => [
      'function' => 'rotate',
      'arguments' => [
        'degrees' => 5,
        'resize_filter' => 'Box',
      ],
      'width' => 41,
      'height' => 23,
      'corners' => array_fill(0, 4, $this->transparent),
      'tolerance' => 0,
    ],
    'rotate_transparent_90' => [
      'function' => 'rotate',
      'arguments' => [
        'degrees' => 90,
      ],
      'width' => 20,
      'height' => 40,
      'corners' => [
        $this->transparent,
        $this->red,
        $this->green,
        $this->blue,
      ],
      'tolerance' => 0,
    ],
    'desaturate' => [
      'function' => 'desaturate',
      'arguments' => [],
      'height' => 20,
      'width' => 40,
      // Grayscale corners are a bit funky. Each of the corners are a shade of
      // gray. The values of these were determined simply by looking at the
      // final image to see what desaturated colors end up being.
      'corners' => [
        array_fill(0, 3, 76) + [
          3 => 0,
        ],
        array_fill(0, 3, 149) + [
          3 => 0,
        ],
        array_fill(0, 3, 29) + [
          3 => 0,
        ],
        array_fill(0, 3, 225) + [
          3 => 127,
        ],
      ],
      // @todo tolerance here is too high. Check reasons.
      'tolerance' => 17000,
    ],
  ];
  foreach ($files as $file) {
    $image_uri = 'public://' . $file;
    foreach ($operations as $op => $values) {

      // Load up a fresh image.
      $image = $this->imageFactory
        ->get($image_uri);
      if (!$image
        ->isValid()) {
        $this
          ->fail("Could not load image {$file}.");
        continue 2;
      }

      // Check that no multi-frame information is set.
      $this
        ->assertSame(1, $image
        ->getToolkit()
        ->getFrames());

      // Perform our operation.
      $image
        ->apply($values['function'], $values['arguments']);

      // Save and reload image.
      $file_path = $this->testDirectory . '/' . $op . substr($file, -4);
      $this
        ->assertTrue($image
        ->save($file_path));
      $image = $this->imageFactory
        ->get($file_path);
      $this
        ->assertTrue($image
        ->isValid());

      // @todo Suite specifics, temporarily adjust tests.
      $package = $image
        ->getToolkit()
        ->getExecManager()
        ->getPackage();
      if ($package === 'graphicsmagick') {

        // @todo Issues with crop and convert on GIF files, investigate.
        if (in_array($file, [
          'image-test.gif',
          'image-test-no-transparency.gif',
        ]) && in_array($op, [
          'crop',
          'scale_and_crop',
          'convert_png',
        ])) {
          continue;
        }
      }
      if ($package === 'imagemagick') {

        // @todo Issues with crop and convert on GIF files, investigate.
        if (in_array($file, [
          'image-test.gif',
          'image-test-no-transparency.gif',
        ]) && in_array($op, [
          'crop',
          'scale_and_crop',
        ])) {
          continue;
        }
      }

      // Reload with GD to be able to check results at pixel level.
      $image = $this->imageFactory
        ->get($file_path, 'gd');
      $toolkit = $image
        ->getToolkit();
      $toolkit
        ->getResource();
      $this
        ->assertTrue($image
        ->isValid());

      // Check MIME type if needed.
      if (isset($values['mimetype'])) {
        $this
          ->assertEquals($values['mimetype'], $toolkit
          ->getMimeType(), "Image '{$file}' after '{$op}' action has proper MIME type ({$values['mimetype']}).");
      }

      // To keep from flooding the test with assert values, make a general
      // value for whether each group of values fail.
      $correct_dimensions_real = TRUE;
      $correct_dimensions_object = TRUE;

      // Check the real dimensions of the image first.
      $actual_toolkit_width = imagesx($toolkit
        ->getResource());
      $actual_toolkit_height = imagesy($toolkit
        ->getResource());
      if ($actual_toolkit_height != $values['height'] || $actual_toolkit_width != $values['width']) {
        $correct_dimensions_real = FALSE;
      }

      // Check that the image object has an accurate record of the dimensions.
      $actual_image_width = $image
        ->getWidth();
      $actual_image_height = $image
        ->getHeight();
      if ($actual_image_width != $values['width'] || $actual_image_height != $values['height']) {
        $correct_dimensions_object = FALSE;
      }
      $this
        ->assertTrue($correct_dimensions_real, "Image '{$file}' after '{$op}' action has proper dimensions. Expected {$values['width']}x{$values['height']}, actual {$actual_toolkit_width}x{$actual_toolkit_height}.");
      $this
        ->assertTrue($correct_dimensions_object, "Image '{$file}' object after '{$op}' action is reporting the proper height and width values.  Expected {$values['width']}x{$values['height']}, actual {$actual_image_width}x{$actual_image_height}.");

      // JPEG colors will always be messed up due to compression.
      if ($image
        ->getToolkit()
        ->getType() != IMAGETYPE_JPEG) {

        // Now check each of the corners to ensure color correctness.
        foreach ($values['corners'] as $key => $corner) {

          // The test gif that does not have transparency has yellow where the
          // others have transparent.
          if ($file === 'image-test-no-transparency.gif' && $corner === $this->transparent && $op != 'rotate_transparent_5') {
            $corner = $this->yellow;
          }

          // The test jpg when converted to other formats has yellow where the
          // others have transparent.
          if ($file === 'image-test.jpg' && $corner === $this->transparent && in_array($op, [
            'convert_gif',
            'convert_png',
          ])) {
            $corner = $this->yellow;
          }

          // Get the location of the corner.
          switch ($key) {
            case 0:
              $x = 0;
              $y = 0;
              break;
            case 1:
              $x = $image
                ->getWidth() - 1;
              $y = 0;
              break;
            case 2:
              $x = $image
                ->getWidth() - 1;
              $y = $image
                ->getHeight() - 1;
              break;
            case 3:
              $x = 0;
              $y = $image
                ->getHeight() - 1;
              break;
          }
          $color = $this
            ->getPixelColor($image, $x, $y);
          $this
            ->colorsAreClose($color, $corner, $values['tolerance'], $file, $op);
        }
      }
    }
  }

  // Test loading non-existing image files.
  $this
    ->assertFalse($this->imageFactory
    ->get('/generic.png')
    ->isValid());
  $this
    ->assertFalse($this->imageFactory
    ->get('public://generic.png')
    ->isValid());

  // Test creation of image from scratch, and saving to storage.
  foreach ([
    IMAGETYPE_PNG,
    IMAGETYPE_GIF,
    IMAGETYPE_JPEG,
  ] as $type) {
    $image = $this->imageFactory
      ->get();
    $image
      ->createNew(50, 20, image_type_to_extension($type, FALSE), '#ffff00');
    $file = 'from_null' . image_type_to_extension($type);
    $file_path = $this->testDirectory . '/' . $file;
    $this
      ->assertEquals(50, $image
      ->getWidth(), "Image file '{$file}' has the correct width.");
    $this
      ->assertEquals(20, $image
      ->getHeight(), "Image file '{$file}' has the correct height.");
    $this
      ->assertEquals(image_type_to_mime_type($type), $image
      ->getMimeType(), "Image file '{$file}' has the correct MIME type.");
    $this
      ->assertTrue($image
      ->save($file_path), "Image '{$file}' created anew from a null image was saved.");

    // Reload saved image.
    $image_reloaded = $this->imageFactory
      ->get($file_path, 'gd');
    if (!$image_reloaded
      ->isValid()) {
      $this
        ->fail("Could not load image '{$file}'.");
      continue;
    }
    $this
      ->assertEquals(50, $image_reloaded
      ->getWidth(), "Image file '{$file}' has the correct width.");
    $this
      ->assertEquals(20, $image_reloaded
      ->getHeight(), "Image file '{$file}' has the correct height.");
    $this
      ->assertEquals(image_type_to_mime_type($type), $image_reloaded
      ->getMimeType(), "Image file '{$file}' has the correct MIME type.");
    if ($image_reloaded
      ->getToolkit()
      ->getType() == IMAGETYPE_GIF) {
      $this
        ->assertEquals('#ffff00', $image_reloaded
        ->getToolkit()
        ->getTransparentColor(), "Image file '{$file}' has the correct transparent color channel set.");
    }
    else {
      $this
        ->assertEquals(NULL, $image_reloaded
        ->getToolkit()
        ->getTransparentColor(), "Image file '{$file}' has no color channel set.");
    }
  }

  // Test saving image files with filenames having non-ascii characters.
  $file_names = [
    'greek εικόνα δοκιμής.png',
    'russian Тестовое изображение.png',
    'simplified chinese 测试图片.png',
    'japanese 試験画像.png',
    'arabic صورة الاختبار.png',
    'armenian փորձարկման պատկերը.png',
    'bengali পরীক্ষা ইমেজ.png',
    'hebraic תמונת בדיקה.png',
    'hindi परीक्षण छवि.png',
    'viet hình ảnh thử nghiệm.png',
    'viet \'with quotes\' hình ảnh thử nghiệm.png',
    'viet "with double quotes" hình ảnh thử nghiệm.png',
  ];
  foreach ($file_names as $file) {

    // @todo on Windows, GraphicsMagick fails.
    if (substr(PHP_OS, 0, 3) === 'WIN' && $toolkit_settings['binaries'] === 'graphicsmagick') {
      continue;
    }

    // On Windows, skip filenames with non-allowed characters.
    if (substr(PHP_OS, 0, 3) === 'WIN' && preg_match('/[:*?"<>|]/', $file)) {
      continue;
    }
    $image = $this->imageFactory
      ->get();
    $this
      ->assertTrue($image
      ->createNew(50, 20, 'png'));
    $file_path = $this->testDirectory . '/' . $file;
    $this
      ->assertTrue($image
      ->save($file_path), $file);
    $image_reloaded = $this->imageFactory
      ->get($file_path, 'gd');
    $this
      ->assertTrue($image_reloaded
      ->isValid(), "Image file '{$file}' loaded successfully.");
  }

  // Test handling a file stored through a remote stream wrapper.
  $image = $this->imageFactory
    ->get('dummy-remote://image-test.png');

  // Source file should be equal to the copied local temp source file.
  $this
    ->assertEquals(filesize('dummy-remote://image-test.png'), filesize($image
    ->getToolkit()
    ->arguments()
    ->getSourceLocalPath()));
  $image
    ->desaturate();
  $this
    ->assertTrue($image
    ->save('dummy-remote://remote-image-test.png'));

  // Destination file should exists, and destination local temp file should
  // have been reset.
  $this
    ->assertTrue(file_exists($image
    ->getToolkit()
    ->arguments()
    ->getDestination()));
  $this
    ->assertEquals('dummy-remote://remote-image-test.png', $image
    ->getToolkit()
    ->arguments()
    ->getDestination());
  $this
    ->assertSame('', $image
    ->getToolkit()
    ->arguments()
    ->getDestinationLocalPath());

  // Test retrieval of EXIF information.
  file_unmanaged_copy(drupal_get_path('module', 'imagemagick') . '/misc/test-exif.jpeg', 'public://', FILE_EXISTS_REPLACE);

  // The image files that will be tested.
  $image_files = [
    [
      'path' => drupal_get_path('module', 'imagemagick') . '/misc/test-exif.jpeg',
      'orientation' => 8,
    ],
    [
      'path' => 'public://test-exif.jpeg',
      'orientation' => 8,
    ],
    [
      'path' => 'dummy-remote://test-exif.jpeg',
      'orientation' => 8,
    ],
    [
      'path' => 'public://image-test.jpg',
      'orientation' => NULL,
    ],
    [
      'path' => 'public://image-test.png',
      'orientation' => NULL,
    ],
    [
      'path' => 'public://image-test.gif',
      'orientation' => NULL,
    ],
    [
      'path' => NULL,
      'orientation' => NULL,
    ],
  ];
  foreach ($image_files as $image_file) {

    // Get image using 'identify'.
    \Drupal::configFactory()
      ->getEditable('imagemagick.settings')
      ->set('use_identify', TRUE)
      ->save();
    $image = $this->imageFactory
      ->get($image_file['path']);
    $this
      ->assertSame($image_file['orientation'], $image
      ->getToolkit()
      ->getExifOrientation());
  }

  // Test multi-frame GIF image.
  $image_files = [
    [
      'source' => drupal_get_path('module', 'imagemagick') . '/misc/test-multi-frame.gif',
      'destination' => $this->testDirectory . '/test-multi-frame.gif',
      'width' => 60,
      'height' => 29,
      'frames' => 13,
      'scaled_width' => 30,
      'scaled_height' => 15,
      'rotated_width' => 33,
      'rotated_height' => 26,
    ],
  ];

  // Get images using 'identify'.
  \Drupal::configFactory()
    ->getEditable('imagemagick.settings')
    ->set('use_identify', TRUE)
    ->save();
  foreach ($image_files as $image_file) {
    $image = $this->imageFactory
      ->get($image_file['source']);
    $this
      ->assertSame($image_file['width'], $image
      ->getWidth());
    $this
      ->assertSame($image_file['height'], $image
      ->getHeight());
    $this
      ->assertSame($image_file['frames'], $image
      ->getToolkit()
      ->getFrames());

    // Scaling should preserve frames.
    $image
      ->scale(30);
    $this
      ->assertTrue($image
      ->save($image_file['destination']));
    $image = $this->imageFactory
      ->get($image_file['destination']);
    $this
      ->assertSame($image_file['scaled_width'], $image
      ->getWidth());
    $this
      ->assertSame($image_file['scaled_height'], $image
      ->getHeight());
    $this
      ->assertSame($image_file['frames'], $image
      ->getToolkit()
      ->getFrames());

    // Rotating should preserve frames.
    $image
      ->rotate(24);
    $this
      ->assertTrue($image
      ->save($image_file['destination']));
    $image = $this->imageFactory
      ->get($image_file['destination']);
    $this
      ->assertSame($image_file['rotated_width'], $image
      ->getWidth());
    $this
      ->assertSame($image_file['rotated_height'], $image
      ->getHeight());
    $this
      ->assertSame($image_file['frames'], $image
      ->getToolkit()
      ->getFrames());

    // Converting to PNG should drop frames.
    $image
      ->convert('png');
    $this
      ->assertTrue($image
      ->save($image_file['destination']));
    $image = $this->imageFactory
      ->get($image_file['destination']);
    $this
      ->assertSame(1, $image
      ->getToolkit()
      ->getFrames());
    $this
      ->assertSame($image_file['rotated_width'], $image
      ->getWidth());
    $this
      ->assertSame($image_file['rotated_height'], $image
      ->getHeight());
    $this
      ->assertSame(1, $image
      ->getToolkit()
      ->getFrames());
  }
}