ImageTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\Core\Image;

use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\Image\Image;
use Drupal\Core\ImageToolkit\ImageToolkitInterface;
use Drupal\Tests\UnitTestCase;

/**
 * Tests the image class.
 *
 * @requires extension gd
 * @group Image
 */
class ImageTest extends UnitTestCase {
    
    /**
     * Image source path.
     *
     * @var string
     */
    protected $source;
    
    /**
     * Image object.
     *
     * @var \Drupal\Core\Image\Image
     */
    protected $image;
    
    /**
     * Mocked image toolkit.
     *
     * @var \Drupal\Core\ImageToolkit\ImageToolkitInterface
     */
    protected $toolkit;
    
    /**
     * Mocked image toolkit operation.
     *
     * @var \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface
     */
    protected $toolkitOperation;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Use the Druplicon image.
        $this->source = __DIR__ . '/../../../../../misc/druplicon.png';
    }
    
    /**
     * Mocks a toolkit.
     *
     * @param array $stubs
     *   (optional) Array containing methods to be replaced with stubs.
     *
     * @return \PHPUnit\Framework\MockObject\MockObject
     */
    protected function getToolkitMock(array $stubs = []) {
        $mock_builder = $this->getMockBuilder('Drupal\\system\\Plugin\\ImageToolkit\\GDToolkit');
        $stubs = array_merge([
            'getPluginId',
            'save',
        ], $stubs);
        return $mock_builder->disableOriginalConstructor()
            ->onlyMethods($stubs)
            ->getMock();
    }
    
    /**
     * Mocks a toolkit operation.
     *
     * @param string $class_name
     *   The name of the GD toolkit operation class to be mocked.
     * @param \Drupal\Core\ImageToolkit\ImageToolkitInterface $toolkit
     *   The image toolkit object.
     *
     * @return \PHPUnit\Framework\MockObject\MockObject
     */
    protected function getToolkitOperationMock($class_name, ImageToolkitInterface $toolkit) {
        $mock_builder = $this->getMockBuilder('Drupal\\system\\Plugin\\ImageToolkit\\Operation\\gd\\' . $class_name);
        $logger = $this->createMock('Psr\\Log\\LoggerInterface');
        return $mock_builder->onlyMethods([
            'execute',
        ])
            ->setConstructorArgs([
            [],
            '',
            [],
            $toolkit,
            $logger,
        ])
            ->getMock();
    }
    
    /**
     * Get an image with a mocked toolkit, for testing.
     *
     * @param bool $load_expected
     *   (optional) Whether the load() method is expected to be called. Defaults
     *   to TRUE.
     * @param array $stubs
     *   (optional) Array containing toolkit methods to be replaced with stubs.
     *
     * @return \Drupal\Core\Image\Image
     *   An image object.
     */
    protected function getTestImage($load_expected = TRUE, array $stubs = []) {
        if (!$load_expected && !in_array('load', $stubs)) {
            $stubs = array_merge([
                'load',
            ], $stubs);
        }
        $this->toolkit = $this->getToolkitMock($stubs);
        $this->toolkit
            ->expects($this->any())
            ->method('getPluginId')
            ->willReturn('gd');
        if (!$load_expected) {
            $this->toolkit
                ->expects($this->never())
                ->method('load');
        }
        $this->image = new Image($this->toolkit, $this->source);
        return $this->image;
    }
    
    /**
     * Get an image with mocked toolkit and operation, for operation testing.
     *
     * @param string $class_name
     *   The name of the GD toolkit operation class to be mocked.
     *
     * @return \Drupal\Core\Image\Image
     *   An image object.
     */
    protected function getTestImageForOperation($class_name) {
        $this->toolkit = $this->getToolkitMock([
            'getToolkitOperation',
        ]);
        $this->toolkitOperation = $this->getToolkitOperationMock($class_name, $this->toolkit);
        $this->toolkit
            ->expects($this->any())
            ->method('getPluginId')
            ->willReturn('gd');
        $this->toolkit
            ->expects($this->any())
            ->method('getToolkitOperation')
            ->willReturn($this->toolkitOperation);
        $this->image = new Image($this->toolkit, $this->source);
        return $this->image;
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::getHeight().
     */
    public function testGetHeight() : void {
        $this->getTestImage(FALSE);
        $this->assertEquals(100, $this->image
            ->getHeight());
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::getWidth().
     */
    public function testGetWidth() : void {
        $this->getTestImage(FALSE);
        $this->assertEquals(88, $this->image
            ->getWidth());
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::getFileSize.
     */
    public function testGetFileSize() : void {
        $this->getTestImage(FALSE);
        $this->assertEquals(3905, $this->image
            ->getFileSize());
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::getToolkit()->getType().
     */
    public function testGetType() : void {
        $this->getTestImage(FALSE);
        $this->assertEquals(IMAGETYPE_PNG, $this->image
            ->getToolkit()
            ->getType());
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::getMimeType().
     */
    public function testGetMimeType() : void {
        $this->getTestImage(FALSE);
        $this->assertEquals('image/png', $this->image
            ->getMimeType());
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::isValid().
     */
    public function testIsValid() : void {
        $this->getTestImage(FALSE);
        $this->assertTrue($this->image
            ->isValid());
        $this->assertFileIsReadable($this->image
            ->getSource());
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::getToolkitId().
     */
    public function testGetToolkitId() : void {
        $this->getTestImage(FALSE);
        $this->assertEquals('gd', $this->image
            ->getToolkitId());
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::save().
     */
    public function testSave() : void {
        $this->getTestImage();
        // This will fail if save() method isn't called on the toolkit.
        $toolkit = $this->getToolkitMock();
        $toolkit->expects($this->once())
            ->method('save')
            ->willReturn(TRUE);
        $image = new Image($toolkit, $this->image
            ->getSource());
        $file_system = $this->prophesize(FileSystemInterface::class);
        $file_system->chmod($this->image
            ->getSource())
            ->willReturn(TRUE);
        $container = $this->getMockBuilder('Symfony\\Component\\DependencyInjection\\ContainerBuilder')
            ->onlyMethods([
            'get',
        ])
            ->getMock();
        $container->expects($this->once())
            ->method('get')
            ->with('file_system')
            ->willReturn($file_system->reveal());
        \Drupal::setContainer($container);
        $image->save();
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::save().
     */
    public function testSaveFails() : void {
        $this->getTestImage();
        // This will fail if save() method isn't called on the toolkit.
        $this->toolkit
            ->expects($this->once())
            ->method('save')
            ->willReturn(FALSE);
        $this->assertFalse($this->image
            ->save());
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::save().
     */
    public function testChmodFails() : void {
        $this->getTestImage();
        // This will fail if save() method isn't called on the toolkit.
        $toolkit = $this->getToolkitMock();
        $toolkit->expects($this->once())
            ->method('save')
            ->willReturn(TRUE);
        $image = new Image($toolkit, $this->image
            ->getSource());
        $file_system = $this->prophesize(FileSystemInterface::class);
        $file_system->chmod($this->image
            ->getSource())
            ->willReturn(FALSE);
        $container = $this->getMockBuilder('Symfony\\Component\\DependencyInjection\\ContainerBuilder')
            ->onlyMethods([
            'get',
        ])
            ->getMock();
        $container->expects($this->once())
            ->method('get')
            ->with('file_system')
            ->willReturn($file_system->reveal());
        \Drupal::setContainer($container);
        $this->assertFalse($image->save());
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::parseFile().
     */
    public function testParseFileFails() : void {
        $toolkit = $this->getToolkitMock();
        $image = new Image($toolkit, 'magic-foobar.png');
        $this->assertFalse($image->isValid());
        $this->assertFalse($image->save());
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::scale().
     */
    public function testScaleWidth() : void {
        $this->getTestImageForOperation('Scale');
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        $ret = $this->image
            ->scale(44, NULL, FALSE);
        $this->assertEquals(50, $ret['height']);
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::scale().
     */
    public function testScaleHeight() : void {
        $this->getTestImageForOperation('Scale');
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        $ret = $this->image
            ->scale(NULL, 50, FALSE);
        $this->assertEquals(44, $ret['width']);
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::scale().
     */
    public function testScaleSame() : void {
        $this->getTestImageForOperation('Scale');
        // Dimensions are the same, resize should not be called.
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        $ret = $this->image
            ->scale(88, 100, FALSE);
        $this->assertEquals(88, $ret['width']);
        $this->assertEquals(100, $ret['height']);
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::scaleAndCrop().
     */
    public function testScaleAndCropWidth() : void {
        $this->getTestImageForOperation('ScaleAndCrop');
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        $ret = $this->image
            ->scaleAndCrop(34, 50);
        $this->assertEquals(5, $ret['x']);
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::scaleAndCrop().
     */
    public function testScaleAndCropHeight() : void {
        $this->getTestImageForOperation('ScaleAndCrop');
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        $ret = $this->image
            ->scaleAndCrop(44, 40);
        $this->assertEquals(5, $ret['y']);
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::scaleAndCrop().
     */
    public function testScaleAndCropFails() : void {
        $this->getTestImageForOperation('ScaleAndCrop');
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        $ret = $this->image
            ->scaleAndCrop(44, 40);
        $this->assertEquals(0, $ret['x']);
        $this->assertEquals(5, $ret['y']);
        $this->assertEquals(44, $ret['resize']['width']);
        $this->assertEquals(50, $ret['resize']['height']);
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::crop().
     */
    public function testCropWidth() : void {
        $this->getTestImageForOperation('Crop');
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        // Cropping with width only should preserve the aspect ratio.
        $ret = $this->image
            ->crop(0, 0, 44);
        $this->assertEquals(50, $ret['height']);
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::crop().
     */
    public function testCropHeight() : void {
        $this->getTestImageForOperation('Crop');
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        // Cropping with height only should preserve the aspect ratio.
        $ret = $this->image
            ->crop(0, 0, NULL, 50);
        $this->assertEquals(44, $ret['width']);
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::crop().
     */
    public function testCrop() : void {
        $this->getTestImageForOperation('Crop');
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        $ret = $this->image
            ->crop(0, 0, 44, 50);
        $this->assertEquals(44, $ret['width']);
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::convert().
     */
    public function testConvert() : void {
        $this->getTestImageForOperation('Convert');
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        $ret = $this->image
            ->convert('png');
        $this->assertEquals('png', $ret['extension']);
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::resize().
     */
    public function testResize() : void {
        $this->getTestImageForOperation('Resize');
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        // Resize with integer for width and height.
        $ret = $this->image
            ->resize(30, 40);
        $this->assertEquals(30, $ret['width']);
        $this->assertEquals(40, $ret['height']);
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::resize().
     */
    public function testFloatResize() : void {
        $this->getTestImageForOperation('Resize');
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        // Pass a float for width.
        $ret = $this->image
            ->resize(30.4, 40);
        // Ensure that the float was rounded to an integer first.
        $this->assertEquals(30, $ret['width']);
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::desaturate().
     */
    public function testDesaturate() : void {
        $this->getTestImageForOperation('Desaturate');
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        $this->image
            ->desaturate();
    }
    
    /**
     * Tests \Drupal\Core\Image\Image::rotate().
     */
    public function testRotate() : void {
        $this->getTestImageForOperation('Rotate');
        $this->toolkitOperation
            ->expects($this->once())
            ->method('execute')
            ->willReturnArgument(0);
        $ret = $this->image
            ->rotate(90);
        $this->assertEquals(90, $ret['degrees']);
    }

}