You are here

Home » API reference » Zircon Profile 8 » ImageStyleTest.php

class ImageStyleTest in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/image/tests/src/Unit/ImageStyleTest.php \Drupal\Tests\image\Unit\ImageStyleTest

@coversDefaultClass \Drupal\image\Entity\ImageStyle

@group Image

Hierarchy

Expanded class hierarchy of ImageStyleTest

File

core/modules/image/tests/src/Unit/ImageStyleTest.php, line 18
Contains \Drupal\Tests\image\Unit\ImageStyleTest.

Namespace

Drupal\Tests\image\Unit
View source 
class ImageStyleTest extends UnitTestCase {

  /**
   * The entity type used for testing.
   *
   * @var \Drupal\Core\Entity\EntityTypeInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $entityType;

  /**
   * The entity manager used for testing.
   *
   * @var \Drupal\Core\Entity\EntityManagerInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $entityManager;

  /**
   * The ID of the type of the entity under test.
   *
   * @var string
   */
  protected $entityTypeId;

  /**
   * Gets a mocked image style for testing.
   *
   * @param string $image_effect_id
   *   The image effect ID.
   * @param \Drupal\image\ImageEffectInterface|\PHPUnit_Framework_MockObject_MockObject $image_effect
   *   The image effect used for testing.
   *
   * @return \Drupal\image\ImageStyleInterface|\Drupal\image\ImageStyleInterface
   *   The mocked image style.
   */
  protected function getImageStyleMock($image_effect_id, $image_effect, $stubs = array()) {
    $effectManager = $this
      ->getMockBuilder('\\Drupal\\image\\ImageEffectManager')
      ->disableOriginalConstructor()
      ->getMock();
    $effectManager
      ->expects($this
      ->any())
      ->method('createInstance')
      ->with($image_effect_id)
      ->will($this
      ->returnValue($image_effect));
    $default_stubs = array(
      'getImageEffectPluginManager',
      'fileUriScheme',
      'fileUriTarget',
      'fileDefaultScheme',
    );
    $image_style = $this
      ->getMockBuilder('\\Drupal\\image\\Entity\\ImageStyle')
      ->setConstructorArgs(array(
      array(
        'effects' => array(
          $image_effect_id => array(
            'id' => $image_effect_id,
          ),
        ),
      ),
      $this->entityTypeId,
    ))
      ->setMethods(array_merge($default_stubs, $stubs))
      ->getMock();
    $image_style
      ->expects($this
      ->any())
      ->method('getImageEffectPluginManager')
      ->will($this
      ->returnValue($effectManager));
    $image_style
      ->expects($this
      ->any())
      ->method('fileUriScheme')
      ->will($this
      ->returnCallback(array(
      $this,
      'fileUriScheme',
    )));
    $image_style
      ->expects($this
      ->any())
      ->method('fileUriTarget')
      ->will($this
      ->returnCallback(array(
      $this,
      'fileUriTarget',
    )));
    $image_style
      ->expects($this
      ->any())
      ->method('fileDefaultScheme')
      ->will($this
      ->returnCallback(array(
      $this,
      'fileDefaultScheme',
    )));
    return $image_style;
  }

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    $this->entityTypeId = $this
      ->randomMachineName();
    $this->provider = $this
      ->randomMachineName();
    $this->entityType = $this
      ->getMock('\\Drupal\\Core\\Entity\\EntityTypeInterface');
    $this->entityType
      ->expects($this
      ->any())
      ->method('getProvider')
      ->will($this
      ->returnValue($this->provider));
    $this->entityManager = $this
      ->getMock('\\Drupal\\Core\\Entity\\EntityManagerInterface');
    $this->entityManager
      ->expects($this
      ->any())
      ->method('getDefinition')
      ->with($this->entityTypeId)
      ->will($this
      ->returnValue($this->entityType));
  }

  /**
   * @covers ::getDerivativeExtension
   */
  public function testGetDerivativeExtension() {
    $image_effect_id = $this
      ->randomMachineName();
    $logger = $this
      ->getMockBuilder('\\Psr\\Log\\LoggerInterface')
      ->getMock();
    $image_effect = $this
      ->getMockBuilder('\\Drupal\\image\\ImageEffectBase')
      ->setConstructorArgs(array(
      array(),
      $image_effect_id,
      array(),
      $logger,
    ))
      ->getMock();
    $image_effect
      ->expects($this
      ->any())
      ->method('getDerivativeExtension')
      ->will($this
      ->returnValue('png'));
    $image_style = $this
      ->getImageStyleMock($image_effect_id, $image_effect);
    $extensions = array(
      'jpeg',
      'gif',
      'png',
    );
    foreach ($extensions as $extension) {
      $extensionReturned = $image_style
        ->getDerivativeExtension($extension);
      $this
        ->assertEquals($extensionReturned, 'png');
    }
  }

  /**
   * @covers ::buildUri
   */
  public function testBuildUri() {

    // Image style that changes the extension.
    $image_effect_id = $this
      ->randomMachineName();
    $logger = $this
      ->getMockBuilder('\\Psr\\Log\\LoggerInterface')
      ->getMock();
    $image_effect = $this
      ->getMockBuilder('\\Drupal\\image\\ImageEffectBase')
      ->setConstructorArgs(array(
      array(),
      $image_effect_id,
      array(),
      $logger,
    ))
      ->getMock();
    $image_effect
      ->expects($this
      ->any())
      ->method('getDerivativeExtension')
      ->will($this
      ->returnValue('png'));
    $image_style = $this
      ->getImageStyleMock($image_effect_id, $image_effect);
    $this
      ->assertEquals($image_style
      ->buildUri('public://test.jpeg'), 'public://styles/' . $image_style
      ->id() . '/public/test.jpeg.png');

    // Image style that doesn't change the extension.
    $image_effect_id = $this
      ->randomMachineName();
    $image_effect = $this
      ->getMockBuilder('\\Drupal\\image\\ImageEffectBase')
      ->setConstructorArgs(array(
      array(),
      $image_effect_id,
      array(),
      $logger,
    ))
      ->getMock();
    $image_effect
      ->expects($this
      ->any())
      ->method('getDerivativeExtension')
      ->will($this
      ->returnArgument(0));
    $image_style = $this
      ->getImageStyleMock($image_effect_id, $image_effect);
    $this
      ->assertEquals($image_style
      ->buildUri('public://test.jpeg'), 'public://styles/' . $image_style
      ->id() . '/public/test.jpeg');
  }

  /**
   * @covers ::getPathToken
   */
  public function testGetPathToken() {
    $logger = $this
      ->getMockBuilder('\\Psr\\Log\\LoggerInterface')
      ->getMock();
    $private_key = $this
      ->randomMachineName();
    $hash_salt = $this
      ->randomMachineName();

    // Image style that changes the extension.
    $image_effect_id = $this
      ->randomMachineName();
    $image_effect = $this
      ->getMockBuilder('\\Drupal\\image\\ImageEffectBase')
      ->setConstructorArgs(array(
      array(),
      $image_effect_id,
      array(),
      $logger,
    ))
      ->getMock();
    $image_effect
      ->expects($this
      ->any())
      ->method('getDerivativeExtension')
      ->will($this
      ->returnValue('png'));
    $image_style = $this
      ->getImageStyleMock($image_effect_id, $image_effect, array(
      'getPrivateKey',
      'getHashSalt',
    ));
    $image_style
      ->expects($this
      ->any())
      ->method('getPrivateKey')
      ->will($this
      ->returnValue($private_key));
    $image_style
      ->expects($this
      ->any())
      ->method('getHashSalt')
      ->will($this
      ->returnValue($hash_salt));

    // Assert the extension has been added to the URI before creating the token.
    $this
      ->assertEquals($image_style
      ->getPathToken('public://test.jpeg.png'), $image_style
      ->getPathToken('public://test.jpeg'));
    $this
      ->assertEquals(substr(Crypt::hmacBase64($image_style
      ->id() . ':' . 'public://test.jpeg.png', $private_key . $hash_salt), 0, 8), $image_style
      ->getPathToken('public://test.jpeg'));
    $this
      ->assertNotEquals(substr(Crypt::hmacBase64($image_style
      ->id() . ':' . 'public://test.jpeg', $private_key . $hash_salt), 0, 8), $image_style
      ->getPathToken('public://test.jpeg'));

    // Image style that doesn't change the extension.
    $image_effect_id = $this
      ->randomMachineName();
    $image_effect = $this
      ->getMockBuilder('\\Drupal\\image\\ImageEffectBase')
      ->setConstructorArgs(array(
      array(),
      $image_effect_id,
      array(),
      $logger,
    ))
      ->getMock();
    $image_effect
      ->expects($this
      ->any())
      ->method('getDerivativeExtension')
      ->will($this
      ->returnArgument(0));
    $image_style = $this
      ->getImageStyleMock($image_effect_id, $image_effect, array(
      'getPrivateKey',
      'getHashSalt',
    ));
    $image_style
      ->expects($this
      ->any())
      ->method('getPrivateKey')
      ->will($this
      ->returnValue($private_key));
    $image_style
      ->expects($this
      ->any())
      ->method('getHashSalt')
      ->will($this
      ->returnValue($hash_salt));

    // Assert no extension has been added to the uri before creating the token.
    $this
      ->assertNotEquals($image_style
      ->getPathToken('public://test.jpeg.png'), $image_style
      ->getPathToken('public://test.jpeg'));
    $this
      ->assertNotEquals(substr(Crypt::hmacBase64($image_style
      ->id() . ':' . 'public://test.jpeg.png', $private_key . $hash_salt), 0, 8), $image_style
      ->getPathToken('public://test.jpeg'));
    $this
      ->assertEquals(substr(Crypt::hmacBase64($image_style
      ->id() . ':' . 'public://test.jpeg', $private_key . $hash_salt), 0, 8), $image_style
      ->getPathToken('public://test.jpeg'));
  }

  /**
   * Mock function for ImageStyle::fileUriScheme().
   */
  public function fileUriScheme($uri) {
    if (preg_match('/^([\\w\\-]+):\\/\\/|^(data):/', $uri, $matches)) {

      // The scheme will always be the last element in the matches array.
      return array_pop($matches);
    }
    return FALSE;
  }

  /**
   * Mock function for ImageStyle::fileUriTarget().
   */
  public function fileUriTarget($uri) {

    // Remove the scheme from the URI and remove erroneous leading or trailing,
    // forward-slashes and backslashes.
    $target = trim(preg_replace('/^[\\w\\-]+:\\/\\/|^data:/', '', $uri), '\\/');

    // If nothing was replaced, the URI doesn't have a valid scheme.
    return $target !== $uri ? $target : FALSE;
  }

  /**
   * Mock function for ImageStyle::fileDefaultScheme().
   */
  public function fileDefaultScheme() {
    return 'public';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ImageStyleTest::$entityManager protected property The entity manager used for testing.
ImageStyleTest::$entityType protected property The entity type used for testing.
ImageStyleTest::$entityTypeId protected property The ID of the type of the entity under test.
ImageStyleTest::fileDefaultScheme public function Mock function for ImageStyle::fileDefaultScheme().
ImageStyleTest::fileUriScheme public function Mock function for ImageStyle::fileUriScheme().
ImageStyleTest::fileUriTarget public function Mock function for ImageStyle::fileUriTarget().
ImageStyleTest::getImageStyleMock protected function Gets a mocked image style for testing.
ImageStyleTest::setUp public function Overrides UnitTestCase::setUp
ImageStyleTest::testBuildUri public function @covers ::buildUri
ImageStyleTest::testGetDerivativeExtension public function @covers ::getDerivativeExtension
ImageStyleTest::testGetPathToken public function @covers ::getPathToken
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root.
UnitTestCase::assertArrayEquals protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName protected function Mocks a block with a block plugin.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed in array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator protected function Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName public function Generates a unique random string containing letters and numbers.