You are here

Home » API reference » ImageMagick 8 » ToolkitImagemagickTest.php

class ToolkitImagemagickTest in ImageMagick 8

Same name and namespace in other branches
  1. 8.3 tests/src/Functional/ToolkitImagemagickTest.php \Drupal\Tests\imagemagick\Functional\ToolkitImagemagickTest
  2. 8.2 tests/src/Functional/ToolkitImagemagickTest.php \Drupal\Tests\imagemagick\Functional\ToolkitImagemagickTest

Tests that core image manipulations work properly through Imagemagick.

@group Imagemagick

Hierarchy

Expanded class hierarchy of ToolkitImagemagickTest

File

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

Namespace

Drupal\Tests\imagemagick\Functional
View source 
class ToolkitImagemagickTest extends BrowserTestBase {
  use TestFileCreationTrait;

  /**
   * The image factory service.
   *
   * @var \Drupal\Core\Image\ImageFactory
   */
  protected $imageFactory;

  /**
   * A directory for image test file results.
   *
   * @var string
   */
  protected $testDirectory;

  // Colors that are used in testing.
  // @codingStandardsIgnoreStart
  protected $black = [
    0,
    0,
    0,
    0,
  ];
  protected $red = [
    255,
    0,
    0,
    0,
  ];
  protected $green = [
    0,
    255,
    0,
    0,
  ];
  protected $blue = [
    0,
    0,
    255,
    0,
  ];
  protected $yellow = [
    255,
    255,
    0,
    0,
  ];
  protected $fuchsia = [
    255,
    0,
    255,
    0,
  ];
  protected $cyan = [
    0,
    255,
    255,
    0,
  ];
  protected $white = [
    255,
    255,
    255,
    0,
  ];
  protected $grey = [
    128,
    128,
    128,
    0,
  ];
  protected $transparent = [
    0,
    0,
    0,
    127,
  ];
  protected $rotateTransparent = [
    255,
    255,
    255,
    127,
  ];
  protected $width = 40;
  protected $height = 20;

  // @codingStandardsIgnoreEnd

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'system',
    'simpletest',
    'file_test',
    'imagemagick',
  ];

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();

    // Create an admin user.
    $admin_user = $this
      ->drupalCreateUser([
      'administer site configuration',
    ]);
    $this
      ->drupalLogin($admin_user);

    // Set the image factory.
    $this->imageFactory = $this->container
      ->get('image.factory');

    // Prepare a directory for test file results.
    $this->testDirectory = 'public://imagetest';
  }

  /**
   * Provides data for testManipulations.
   *
   * @return array[]
   *   A simple array of simple arrays, each having the following elements:
   *   - binaries to use for testing.
   */
  public function providerManipulationTest() {
    return [
      [
        'imagemagick',
      ],
      [
        'graphicsmagick',
      ],
    ];
  }

  /**
   * 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.
   *
   * @param string $binaries
   *   The graphics package binaries to use for testing.
   *
   * @dataProvider providerManipulationTest
   */
  public function testManipulations($binaries) {

    // Change the toolkit.
    \Drupal::configFactory()
      ->getEditable('system.image')
      ->set('toolkit', 'imagemagick')
      ->save();

    // Execute tests with selected binaries.
    // The test can only be executed if binaries are available on the shell
    // path.
    \Drupal::configFactory()
      ->getEditable('imagemagick.settings')
      ->set('debug', TRUE)
      ->set('binaries', $binaries)
      ->set('quality', 100)
      ->save();
    $status = \Drupal::service('image.toolkit.manager')
      ->createInstance('imagemagick')
      ->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.");
    }

    // Set the toolkit on the image factory.
    $this->imageFactory
      ->setToolkitId('imagemagick');

    // Test that the image factory is set to use the Imagemagick toolkit.
    $this
      ->assertEqual($this->imageFactory
      ->getToolkitId(), 'imagemagick', 'The image factory is set to use the \'imagemagick\' image toolkit.');

    // Prepare directory.
    file_unmanaged_delete_recursive($this->testDirectory);
    file_prepare_directory($this->testDirectory, FILE_CREATE_DIRECTORY);

    // 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,
      ],
    ];

    // Prepare a copy of test files.
    $this
      ->getTestFiles('image');
    foreach ($files as $file) {
      foreach ($operations as $op => $values) {

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

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

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

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

        // @todo Suite specifics, temporarily adjust tests.
        $package = $image
          ->getToolkit()
          ->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;
          }
        }

        // 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
            ->assertEqual($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 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
        ->assertEqual(50, $image
        ->getWidth(), "Image file '{$file}' has the correct width.");
      $this
        ->assertEqual(20, $image
        ->getHeight(), "Image file '{$file}' has the correct height.");
      $this
        ->assertEqual(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
        ->assertEqual(50, $image_reloaded
        ->getWidth(), "Image file '{$file}' has the correct width.");
      $this
        ->assertEqual(20, $image_reloaded
        ->getHeight(), "Image file '{$file}' has the correct height.");
      $this
        ->assertEqual(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
          ->assertEqual('#ffff00', $image_reloaded
          ->getToolkit()
          ->getTransparentColor(), "Image file '{$file}' has the correct transparent color channel set.");
      }
      else {
        $this
          ->assertEqual(NULL, $image_reloaded
          ->getToolkit()
          ->getTransparentColor(), "Image file '{$file}' has no color channel set.");
      }
    }

    // Test failures of CreateNew.
    $image = $this->imageFactory
      ->get();
    $image
      ->createNew(-50, 20);
    $this
      ->assertFalse($image
      ->isValid(), 'CreateNew with negative width fails.');
    $image
      ->createNew(50, 20, 'foo');
    $this
      ->assertFalse($image
      ->isValid(), 'CreateNew with invalid extension fails.');
    $image
      ->createNew(50, 20, 'gif', '#foo');
    $this
      ->assertFalse($image
      ->isValid(), 'CreateNew with invalid color hex string fails.');
    $image
      ->createNew(50, 20, 'gif', '#ff0000');
    $this
      ->assertTrue($image
      ->isValid(), 'CreateNew with valid arguments validates the Image.');

    // 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) {
      $image = $this->imageFactory
        ->get();
      $image
        ->createNew(50, 20, 'png');
      $file_path = $this->testDirectory . '/' . $file;
      $image
        ->save($file_path);
      $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
      ->assertEqual(filesize('dummy-remote://image-test.png'), filesize($image
      ->getToolkit()
      ->getSourceLocalPath()));
    $image
      ->desaturate();
    $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()
      ->getDestination()));
    $this
      ->assertEqual('dummy-remote://remote-image-test.png', $image
      ->getToolkit()
      ->getDestination());
    $this
      ->assertIdentical('', $image
      ->getToolkit()
      ->getDestinationLocalPath());

    // Test retrieval of EXIF information.
    $image_files = [
      [
        'path' => drupal_get_path('module', 'imagemagick') . '/misc/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
        ->assertIdentical($image_file['orientation'], $image
        ->getToolkit()
        ->getExifOrientation());

      // Get image using 'getimagesize'.
      \Drupal::configFactory()
        ->getEditable('imagemagick.settings')
        ->set('use_identify', FALSE)
        ->save();
      $image = $this->imageFactory
        ->get($image_file['path']);
      $this
        ->assertIdentical($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
        ->assertIdentical($image_file['width'], $image
        ->getWidth());
      $this
        ->assertIdentical($image_file['height'], $image
        ->getHeight());
      $this
        ->assertIdentical($image_file['frames'], $image
        ->getToolkit()
        ->getFrames());

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

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

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

  /**
   * Test ImageMagick subform and settings.
   */
  public function testFormAndSettings() {

    // Change the toolkit.
    \Drupal::configFactory()
      ->getEditable('system.image')
      ->set('toolkit', 'imagemagick')
      ->save();

    // Test form is accepting wrong binaries path while setting toolkit to GD.
    $this
      ->drupalGet('admin/config/media/image-toolkit');
    $this
      ->assertFieldByName('image_toolkit', 'imagemagick');
    $edit = [
      'image_toolkit' => 'gd',
      'imagemagick[suite][path_to_binaries]' => '/foo/bar',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save configuration');
    $this
      ->assertFieldByName('image_toolkit', 'gd');

    // Change the toolkit.
    \Drupal::configFactory()
      ->getEditable('system.image')
      ->set('toolkit', 'imagemagick')
      ->save();
    $this->imageFactory
      ->setToolkitId('imagemagick');
    $this
      ->assertEqual('imagemagick', $this->imageFactory
      ->getToolkitId());

    // Test default supported image extensions.
    $this
      ->assertEqual('gif jpe jpeg jpg png', implode(' ', $this->imageFactory
      ->getSupportedExtensions()));
    $config = \Drupal::configFactory()
      ->getEditable('imagemagick.settings');

    // Enable TIFF.
    $image_formats = $config
      ->get('image_formats');
    $image_formats['TIFF']['enabled'] = TRUE;
    $config
      ->set('image_formats', $image_formats)
      ->save();
    $this
      ->assertEqual('gif jpe jpeg jpg png tif tiff', implode(' ', $this->imageFactory
      ->getSupportedExtensions()));

    // Disable PNG.
    $image_formats['PNG']['enabled'] = FALSE;
    $config
      ->set('image_formats', $image_formats)
      ->save();
    $this
      ->assertEqual('gif jpe jpeg jpg tif tiff', implode(' ', $this->imageFactory
      ->getSupportedExtensions()));

    // Disable some extensions.
    $image_formats['TIFF']['exclude_extensions'] = 'tif, gif';
    $config
      ->set('image_formats', $image_formats)
      ->save();
    $this
      ->assertEqual('gif jpe jpeg jpg tiff', implode(' ', $this->imageFactory
      ->getSupportedExtensions()));
    $image_formats['JPEG']['exclude_extensions'] = 'jpe, jpg';
    $config
      ->set('image_formats', $image_formats)
      ->save();
    $this
      ->assertEqual('gif jpeg tiff', implode(' ', $this->imageFactory
      ->getSupportedExtensions()));
  }

  /**
   * Function for finding a pixel's RGBa values.
   */
  protected function getPixelColor(ImageInterface $image, $x, $y) {
    $toolkit = $image
      ->getToolkit();
    $color_index = imagecolorat($toolkit
      ->getResource(), $x, $y);
    $transparent_index = imagecolortransparent($toolkit
      ->getResource());
    if ($color_index == $transparent_index) {
      return array(
        0,
        0,
        0,
        127,
      );
    }
    return array_values(imagecolorsforindex($toolkit
      ->getResource(), $color_index));
  }

  /**
   * Function to compare two colors by RGBa, within a tolerance.
   *
   * Very basic, just compares the sum of the squared differences for each of
   * the R, G, B, A components of two colors against a 'tolerance' value.
   *
   * @param int[] $actual
   *   The actual RGBA array.
   * @param int[] $expected
   *   The expected RGBA array.
   * @param int $tolerance
   *   The acceptable difference between the colors.
   * @param string $file
   *   The image file being tested.
   * @param string $op
   *   The image operation being tested.
   *
   * @return bool
   *   TRUE if the colors differences are within tolerance, FALSE otherwise.
   */
  protected function colorsAreClose(array $actual, array $expected, $tolerance, $file, $op) {

    // Fully transparent colors are equal, regardless of RGB.
    if ($actual[3] == 127 && $expected[3] == 127) {
      return TRUE;
    }
    $distance = pow($actual[0] - $expected[0], 2) + pow($actual[1] - $expected[1], 2) + pow($actual[2] - $expected[2], 2) + pow($actual[3] - $expected[3], 2);
    $this
      ->assertLessThanOrEqual($tolerance, $distance, "Actual: {" . implode(',', $actual) . "}, Expected: {" . implode(',', $expected) . "}, Distance: " . $distance . ", Tolerance: " . $tolerance . ", File: " . $file . ", Operation: " . $op);
    return TRUE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$defaultTheme protected property The theme to install as the default for testing. 1,597
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs 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::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name.
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
ToolkitImagemagickTest::$black protected property
ToolkitImagemagickTest::$blue protected property
ToolkitImagemagickTest::$cyan protected property
ToolkitImagemagickTest::$fuchsia protected property
ToolkitImagemagickTest::$green protected property
ToolkitImagemagickTest::$grey protected property
ToolkitImagemagickTest::$height protected property
ToolkitImagemagickTest::$imageFactory protected property The image factory service.
ToolkitImagemagickTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
ToolkitImagemagickTest::$red protected property
ToolkitImagemagickTest::$rotateTransparent protected property
ToolkitImagemagickTest::$testDirectory protected property A directory for image test file results.
ToolkitImagemagickTest::$transparent protected property
ToolkitImagemagickTest::$white protected property
ToolkitImagemagickTest::$width protected property
ToolkitImagemagickTest::$yellow protected property
ToolkitImagemagickTest::colorsAreClose protected function Function to compare two colors by RGBa, within a tolerance.
ToolkitImagemagickTest::getPixelColor protected function Function for finding a pixel's RGBa values.
ToolkitImagemagickTest::providerManipulationTest public function Provides data for testManipulations.
ToolkitImagemagickTest::setUp public function Overrides BrowserTestBase::setUp
ToolkitImagemagickTest::testFormAndSettings public function Test ImageMagick subform and settings.
ToolkitImagemagickTest::testManipulations public function Test image toolkit operations.
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.