public function ImageDimensionsTest::testImageDimensions in Drupal 8

Same name and namespace in other branches

1. 9 core/modules/image/tests/src/Functional/ImageDimensionsTest.php \Drupal\Tests\image\Functional\ImageDimensionsTest::testImageDimensions()

Test styled image dimensions cumulatively.

File

core/modules/image/tests/src/Functional/ImageDimensionsTest.php, line 39

Class

ImageDimensionsTest

Tests that images have correct dimensions when styled.

Namespace

Drupal\Tests\image\Functional

Code

public function testImageDimensions() {
  $image_factory = $this->container
    ->get('image.factory');

  // Create a working copy of the file.
  $files = $this
    ->drupalGetTestFiles('image');
  $file = reset($files);

  /** @var \Drupal\Core\File\FileSystemInterface $file_system */
  $file_system = \Drupal::service('file_system');
  $original_uri = $file_system
    ->copy($file->uri, 'public://', FileSystemInterface::EXISTS_RENAME);

  // Create a style.

  /** @var $style \Drupal\image\ImageStyleInterface */
  $style = ImageStyle::create([
    'name' => 'test',
    'label' => 'Test',
  ]);
  $style
    ->save();
  $generated_uri = 'public://styles/test/public/' . $file_system
    ->basename($original_uri);
  $url = file_url_transform_relative($style
    ->buildUrl($original_uri));
  $variables = [
    '#theme' => 'image_style',
    '#style_name' => 'test',
    '#uri' => $original_uri,
    '#width' => 40,
    '#height' => 20,
  ];

  // Verify that the original image matches the hard-coded values.
  $image_file = $image_factory
    ->get($original_uri);
  $this
    ->assertEqual($image_file
    ->getWidth(), $variables['#width']);
  $this
    ->assertEqual($image_file
    ->getHeight(), $variables['#height']);

  // Scale an image that is wider than it is high.
  $effect = [
    'id' => 'image_scale',
    'data' => [
      'width' => 120,
      'height' => 90,
      'upscale' => TRUE,
    ],
    'weight' => 0,
  ];
  $style
    ->addImageEffect($effect);
  $style
    ->save();
  $this
    ->assertEqual($this
    ->getImageTag($variables), '<img src="' . $url . '" width="120" height="60" alt="" class="image-style-test" />');
  $this
    ->assertFileNotExists($generated_uri);
  $this
    ->drupalGet($this
    ->getAbsoluteUrl($url));
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertFileExists($generated_uri);
  $image_file = $image_factory
    ->get($generated_uri);
  $this
    ->assertEqual($image_file
    ->getWidth(), 120);
  $this
    ->assertEqual($image_file
    ->getHeight(), 60);

  // Rotate 90 degrees anticlockwise.
  $effect = [
    'id' => 'image_rotate',
    'data' => [
      'degrees' => -90,
      'random' => FALSE,
    ],
    'weight' => 1,
  ];
  $style
    ->addImageEffect($effect);
  $style
    ->save();
  $this
    ->assertEqual($this
    ->getImageTag($variables), '<img src="' . $url . '" width="60" height="120" alt="" class="image-style-test" />');
  $this
    ->assertFileNotExists($generated_uri);
  $this
    ->drupalGet($this
    ->getAbsoluteUrl($url));
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertFileExists($generated_uri);
  $image_file = $image_factory
    ->get($generated_uri);
  $this
    ->assertEqual($image_file
    ->getWidth(), 60);
  $this
    ->assertEqual($image_file
    ->getHeight(), 120);

  // Scale an image that is higher than it is wide (rotated by previous effect).
  $effect = [
    'id' => 'image_scale',
    'data' => [
      'width' => 120,
      'height' => 90,
      'upscale' => TRUE,
    ],
    'weight' => 2,
  ];
  $style
    ->addImageEffect($effect);
  $style
    ->save();
  $this
    ->assertEqual($this
    ->getImageTag($variables), '<img src="' . $url . '" width="45" height="90" alt="" class="image-style-test" />');
  $this
    ->assertFileNotExists($generated_uri);
  $this
    ->drupalGet($this
    ->getAbsoluteUrl($url));
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertFileExists($generated_uri);
  $image_file = $image_factory
    ->get($generated_uri);
  $this
    ->assertEqual($image_file
    ->getWidth(), 45);
  $this
    ->assertEqual($image_file
    ->getHeight(), 90);

  // Test upscale disabled.
  $effect = [
    'id' => 'image_scale',
    'data' => [
      'width' => 400,
      'height' => 200,
      'upscale' => FALSE,
    ],
    'weight' => 3,
  ];
  $style
    ->addImageEffect($effect);
  $style
    ->save();
  $this
    ->assertEqual($this
    ->getImageTag($variables), '<img src="' . $url . '" width="45" height="90" alt="" class="image-style-test" />');
  $this
    ->assertFileNotExists($generated_uri);
  $this
    ->drupalGet($this
    ->getAbsoluteUrl($url));
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertFileExists($generated_uri);
  $image_file = $image_factory
    ->get($generated_uri);
  $this
    ->assertEqual($image_file
    ->getWidth(), 45);
  $this
    ->assertEqual($image_file
    ->getHeight(), 90);

  // Add a desaturate effect.
  $effect = [
    'id' => 'image_desaturate',
    'data' => [],
    'weight' => 4,
  ];
  $style
    ->addImageEffect($effect);
  $style
    ->save();
  $this
    ->assertEqual($this
    ->getImageTag($variables), '<img src="' . $url . '" width="45" height="90" alt="" class="image-style-test" />');
  $this
    ->assertFileNotExists($generated_uri);
  $this
    ->drupalGet($this
    ->getAbsoluteUrl($url));
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertFileExists($generated_uri);
  $image_file = $image_factory
    ->get($generated_uri);
  $this
    ->assertEqual($image_file
    ->getWidth(), 45);
  $this
    ->assertEqual($image_file
    ->getHeight(), 90);

  // Add a random rotate effect.
  $effect = [
    'id' => 'image_rotate',
    'data' => [
      'degrees' => 180,
      'random' => TRUE,
    ],
    'weight' => 5,
  ];
  $style
    ->addImageEffect($effect);
  $style
    ->save();
  $this
    ->assertEqual($this
    ->getImageTag($variables), '<img src="' . $url . '" alt="" class="image-style-test" />');
  $this
    ->assertFileNotExists($generated_uri);
  $this
    ->drupalGet($this
    ->getAbsoluteUrl($url));
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertFileExists($generated_uri);

  // Add a crop effect.
  $effect = [
    'id' => 'image_crop',
    'data' => [
      'width' => 30,
      'height' => 30,
      'anchor' => 'center-center',
    ],
    'weight' => 6,
  ];
  $style
    ->addImageEffect($effect);
  $style
    ->save();
  $this
    ->assertEqual($this
    ->getImageTag($variables), '<img src="' . $url . '" width="30" height="30" alt="" class="image-style-test" />');
  $this
    ->assertFileNotExists($generated_uri);
  $this
    ->drupalGet($this
    ->getAbsoluteUrl($url));
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertFileExists($generated_uri);
  $image_file = $image_factory
    ->get($generated_uri);
  $this
    ->assertEqual($image_file
    ->getWidth(), 30);
  $this
    ->assertEqual($image_file
    ->getHeight(), 30);

  // Rotate to a non-multiple of 90 degrees.
  $effect = [
    'id' => 'image_rotate',
    'data' => [
      'degrees' => 57,
      'random' => FALSE,
    ],
    'weight' => 7,
  ];
  $effect_id = $style
    ->addImageEffect($effect);
  $style
    ->save();

  // @todo Uncomment this once
  //   https://www.drupal.org/project/drupal/issues/2670966 is resolved.
  // $this->assertEqual($this->getImageTag($variables), '<img src="' . $url . '" width="41" height="41" alt="" class="image-style-test" />');
  $this
    ->assertFileNotExists($generated_uri);
  $this
    ->drupalGet($this
    ->getAbsoluteUrl($url));
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertFileExists($generated_uri);
  $image_file = $image_factory
    ->get($generated_uri);

  // @todo Uncomment this once
  //   https://www.drupal.org/project/drupal/issues/2670966 is resolved.
  // $this->assertEqual($image_file->getWidth(), 41);
  // $this->assertEqual($image_file->getHeight(), 41);
  $effect_plugin = $style
    ->getEffect($effect_id);
  $style
    ->deleteImageEffect($effect_plugin);

  // Ensure that an effect can unset dimensions.
  $effect = [
    'id' => 'image_module_test_null',
    'data' => [],
    'weight' => 8,
  ];
  $style
    ->addImageEffect($effect);
  $style
    ->save();
  $this
    ->assertEqual($this
    ->getImageTag($variables), '<img src="' . $url . '" alt="" class="image-style-test" />');

  // Test URI dependent image effect.
  $style = ImageStyle::create([
    'name' => 'test_uri',
    'label' => 'Test URI',
  ]);
  $effect = [
    'id' => 'image_module_test_uri_dependent',
    'data' => [],
    'weight' => 0,
  ];
  $style
    ->addImageEffect($effect);
  $style
    ->save();
  $variables = [
    '#theme' => 'image_style',
    '#style_name' => 'test_uri',
    '#uri' => $original_uri,
    '#width' => 40,
    '#height' => 20,
  ];

  // PNG original image. Should be resized to 100x100.
  $generated_uri = 'public://styles/test_uri/public/' . $file_system
    ->basename($original_uri);
  $url = file_url_transform_relative($style
    ->buildUrl($original_uri));
  $this
    ->assertEqual($this
    ->getImageTag($variables), '<img src="' . $url . '" width="100" height="100" alt="" class="image-style-test-uri" />');
  $this
    ->assertFileNotExists($generated_uri);
  $this
    ->drupalGet($this
    ->getAbsoluteUrl($url));
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertFileExists($generated_uri);
  $image_file = $image_factory
    ->get($generated_uri);
  $this
    ->assertEqual($image_file
    ->getWidth(), 100);
  $this
    ->assertEqual($image_file
    ->getHeight(), 100);

  // GIF original image. Should be resized to 50x50.
  $file = $files[1];
  $original_uri = $file_system
    ->copy($file->uri, 'public://', FileSystemInterface::EXISTS_RENAME);
  $generated_uri = 'public://styles/test_uri/public/' . $file_system
    ->basename($original_uri);
  $url = file_url_transform_relative($style
    ->buildUrl($original_uri));
  $variables['#uri'] = $original_uri;
  $this
    ->assertEqual($this
    ->getImageTag($variables), '<img src="' . $url . '" width="50" height="50" alt="" class="image-style-test-uri" />');
  $this
    ->assertFileNotExists($generated_uri);
  $this
    ->drupalGet($this
    ->getAbsoluteUrl($url));
  $this
    ->assertSession()
    ->statusCodeEquals(200);
  $this
    ->assertFileExists($generated_uri);
  $image_file = $image_factory
    ->get($generated_uri);
  $this
    ->assertEqual($image_file
    ->getWidth(), 50);
  $this
    ->assertEqual($image_file
    ->getHeight(), 50);
}