Your IP : 216.73.216.43
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Catalog\Test\Unit\Helper;
use Magento\Catalog\Helper\Image;
use Magento\Catalog\Model\Config\CatalogMediaConfig;
use Magento\Catalog\Model\Product;
use Magento\Catalog\Model\Product\ImageFactory as ProductImageFactory;
use Magento\Catalog\Model\View\Asset\PlaceholderFactory;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\App\Helper\Context;
use Magento\Framework\Config\View;
use Magento\Framework\View\Asset\Repository;
use Magento\Framework\View\ConfigInterface;
use Magento\Store\Model\ScopeInterface;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
/**
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class ImageTest extends TestCase
{
/**
* @var Image
*/
protected $helper;
/**
* @var Context|MockObject
*/
protected $context;
/**
* @var \Magento\Catalog\Block\Product\ImageFactory|MockObject
*/
protected $imageFactory;
/**
* @var Repository|MockObject
*/
protected $assetRepository;
/**
* @var View|MockObject
*/
protected $configView;
/**
* @var ConfigInterface|MockObject
*/
protected $viewConfig;
/**
* @var \Magento\Catalog\Model\Product\Image|MockObject
*/
protected $image;
/**
* @var ScopeConfigInterface|MockObject
*/
protected $scopeConfig;
/**
* @var PlaceholderFactory|MockObject
*/
protected $placeholderFactory;
/**
* @var CatalogMediaConfig|MockObject
*/
private $catalogMediaConfigMock;
protected function setUp(): void
{
$this->mockContext();
$this->mockImage();
$this->assetRepository = $this->getMockBuilder(Repository::class)
->disableOriginalConstructor()
->getMock();
$this->configView = $this->getMockBuilder(View::class)
->disableOriginalConstructor()
->getMock();
$this->viewConfig = $this->getMockBuilder(ConfigInterface::class)
->getMockForAbstractClass();
$this->placeholderFactory = $this->getMockBuilder(PlaceholderFactory::class)
->disableOriginalConstructor()
->getMock();
$this->catalogMediaConfigMock = $this->createPartialMock(CatalogMediaConfig::class, ['getMediaUrlFormat']);
$this->catalogMediaConfigMock->method('getMediaUrlFormat')->willReturn(CatalogMediaConfig::HASH);
$this->helper = new Image(
$this->context,
$this->imageFactory,
$this->assetRepository,
$this->viewConfig,
$this->placeholderFactory,
$this->catalogMediaConfigMock
);
}
protected function mockContext()
{
$this->context = $this->getMockBuilder(Context::class)
->disableOriginalConstructor()
->getMock();
$this->scopeConfig = $this->getMockBuilder(ScopeConfigInterface::class)
->getMockForAbstractClass();
$this->context->expects($this->any())
->method('getScopeConfig')
->willReturn($this->scopeConfig);
}
protected function mockImage()
{
$this->imageFactory = $this->getMockBuilder(ProductImageFactory::class)
->disableOriginalConstructor()
->setMethods(['create'])
->getMock();
$this->image = $this->getMockBuilder(\Magento\Catalog\Model\Product\Image::class)
->disableOriginalConstructor()
->getMock();
$this->imageFactory->expects($this->any())
->method('create')
->willReturn($this->image);
}
/**
* @param array $data
* @dataProvider initDataProvider
*/
public function testInit($data)
{
$imageId = 'test_image_id';
$attributes = [];
$productMock = $this->getMockBuilder(Product::class)
->disableOriginalConstructor()
->getMock();
$this->prepareAttributes($data, $imageId);
$this->prepareImageProperties($data);
$this->prepareWatermarkProperties($data);
$this->assertInstanceOf(
Image::class,
$this->helper->init($productMock, $imageId, $attributes)
);
}
/**
* @return array
*/
public function initDataProvider()
{
return [
[
'data' => [
'type' => 'image',
'width' => 100,
'height' => 100,
'frame' => 1,
'constrain' => 1,
'aspect_ratio' => 1,
'transparency' => 0,
'background' => [255, 255, 255],
'watermark' => 'watermark_file',
'watermark_opacity' => 100,
'watermark_position' => 1,
'watermark_size' => '100x100',
'watermark_size_array' => ['width' => 100, 'height' => 100],
],
],
];
}
/**
* @param array $data - optional 'frame' key
* @param bool $whiteBorders view config
* @param bool $expectedKeepFrame
* @dataProvider initKeepFrameDataProvider
*/
public function testInitKeepFrame($data, $whiteBorders, $expectedKeepFrame)
{
$imageId = 'test_image_id';
$attributes = [];
$productMock = $this->getMockBuilder(Product::class)
->disableOriginalConstructor()
->getMock();
$this->prepareAttributes($data, $imageId);
$this->configView->expects(isset($data['frame']) ? $this->never() : $this->once())
->method('getVarValue')
->with('Magento_Catalog', 'product_image_white_borders')
->willReturn($whiteBorders);
$this->viewConfig->expects($this->once())
->method('getViewConfig')
->willReturn($this->configView);
$this->image->expects($this->once())
->method('setKeepFrame')
->with($expectedKeepFrame)
->willReturnSelf();
$this->helper->init($productMock, $imageId, $attributes);
}
/**
* @return array
*/
public function initKeepFrameDataProvider()
{
return [
// when frame defined explicitly, it wins
[
'mediaImage' => [
'frame' => 1,
],
'whiteBorders' => true,
'expected' => true,
],
[
'mediaImage' => [
'frame' => 0,
],
'whiteBorders' => true,
'expected' => false,
],
// when frame is not defined, var is used
[
'mediaImage' => [],
'whiteBorders' => true,
'expected' => true,
],
[
'mediaImage' => [],
'whiteBorders' => false,
'expected' => false,
],
];
}
/**
* @param $data
* @param $imageId
*/
protected function prepareAttributes($data, $imageId)
{
$this->configView->expects($this->once())
->method('getMediaAttributes')
->with('Magento_Catalog', Image::MEDIA_TYPE_CONFIG_NODE, $imageId)
->willReturn($data);
$this->viewConfig->expects($this->once())
->method('getViewConfig')
->willReturn($this->configView);
}
/**
* @param $data
*/
protected function prepareImageProperties($data)
{
$this->image->expects($this->once())
->method('setDestinationSubdir')
->with($data['type'])
->willReturnSelf();
$this->image->expects($this->any())
->method('getDestinationSubdir')
->willReturn($data['type']);
$this->image->expects($this->once())
->method('setWidth')
->with($data['width'])
->willReturnSelf();
$this->image->expects($this->once())
->method('setHeight')
->with($data['height'])
->willReturnSelf();
$this->image->expects($this->any())
->method('setKeepFrame')
->with($data['frame'])
->willReturnSelf();
$this->image->expects($this->any())
->method('setConstrainOnly')
->with($data['constrain'])
->willReturnSelf();
$this->image->expects($this->any())
->method('setKeepAspectRatio')
->with($data['aspect_ratio'])
->willReturnSelf();
$this->image->expects($this->any())
->method('setKeepTransparency')
->with($data['transparency'])
->willReturnSelf();
$this->image->expects($this->any())
->method('setBackgroundColor')
->with($data['background'])
->willReturnSelf();
}
/**
* @param $data
*/
protected function prepareWatermarkProperties($data)
{
$this->scopeConfig->expects($this->any())
->method('getValue')
->willReturnMap(
[
[
'design/watermark/' . $data['type'] . '_image',
ScopeInterface::SCOPE_STORE,
null,
$data['watermark']
],
[
'design/watermark/' . $data['type'] . '_imageOpacity',
ScopeInterface::SCOPE_STORE,
null,
$data['watermark_opacity']
],
[
'design/watermark/' . $data['type'] . '_position',
ScopeInterface::SCOPE_STORE,
null,
$data['watermark_position']
],
[
'design/watermark/' . $data['type'] . '_size',
ScopeInterface::SCOPE_STORE,
null,
$data['watermark_size']
],
]
);
$this->image->expects($this->any())
->method('setWatermarkFile')
->with($data['watermark'])
->willReturnSelf();
$this->image->expects($this->any())
->method('setWatermarkImageOpacity')
->with($data['watermark_opacity'])
->willReturnSelf();
$this->image->expects($this->any())
->method('setWatermarkPosition')
->with($data['watermark_position'])
->willReturnSelf();
$this->image->expects($this->any())
->method('setWatermarkSize')
->with($data['watermark_size_array'])
->willReturnSelf();
}
public function testGetType()
{
$imageId = 'test_image_id';
$attributes = [];
$data = [
'type' => 'image',
];
$productMock = $this->getMockBuilder(Product::class)
->disableOriginalConstructor()
->getMock();
$this->prepareAttributes($data, $imageId);
$this->helper->init($productMock, $imageId, $attributes);
$this->assertEquals($data['type'], $this->helper->getType());
}
public function testGetWidth()
{
$imageId = 'test_image_id';
$attributes = [];
$data = [
'width' => 100,
];
$productMock = $this->getMockBuilder(Product::class)
->disableOriginalConstructor()
->getMock();
$this->prepareAttributes($data, $imageId);
$this->helper->init($productMock, $imageId, $attributes);
$this->assertEquals($data['width'], $this->helper->getWidth());
}
/**
* Check initBaseFile without properties - product
*/
public function testGetUrlWithOutProduct()
{
$this->assertNull($this->helper->getUrl());
}
/**
* @param array $data
* @dataProvider getHeightDataProvider
*/
public function testGetHeight($data)
{
$imageId = 'test_image_id';
$attributes = [];
$productMock = $this->getMockBuilder(Product::class)
->disableOriginalConstructor()
->getMock();
$this->prepareAttributes($data, $imageId);
$height = isset($data['height']) ? $data['height'] : $data['width'];
$this->helper->init($productMock, $imageId, $attributes);
$this->assertEquals($height, $this->helper->getHeight());
}
/**
* @return array
*/
public function getHeightDataProvider()
{
return [
'data' => [
[
'height' => 100,
],
[
'width' => 100,
'height' => 100,
],
[
'width' => 100,
],
],
];
}
/**
* @param array $data
* @dataProvider getFrameDataProvider
*/
public function testGetFrame($data)
{
$imageId = 'test_image_id';
$attributes = [];
$productMock = $this->getMockBuilder(Product::class)
->disableOriginalConstructor()
->getMock();
$this->prepareAttributes($data, $imageId);
$this->helper->init($productMock, $imageId, $attributes);
$this->assertEquals($data['frame'], $this->helper->getFrame());
}
/**
* @return array
*/
public function getFrameDataProvider()
{
return [
'data' => [
[
'frame' => 0,
],
[
'frame' => 1,
],
],
];
}
/**
* @param array $data
* @param string $expected
* @dataProvider getLabelDataProvider
*/
public function testGetLabel($data, $expected)
{
$imageId = 'test_image_id';
$attributes = [];
$productMock = $this->getMockBuilder(Product::class)
->disableOriginalConstructor()
->getMock();
$productMock->expects($this->once())
->method('getData')
->with($data['type'] . '_' . 'label')
->willReturn($data['label']);
$productMock->expects($this->any())
->method('getName')
->willReturn($expected);
$this->prepareAttributes($data, $imageId);
$this->helper->init($productMock, $imageId, $attributes);
$this->assertEquals($expected, $this->helper->getLabel());
}
/**
* @return array
*/
public function getLabelDataProvider()
{
return [
[
'data' => [
'type' => 'image',
'label' => 'test_label',
],
'test_label',
],
[
'data' => [
'type' => 'image',
'label' => null,
],
'test_label',
],
];
}
/**
* @param string $imageId
* @param string $imageFile
* @param string $baseFile
* @param string $destination
* @param boolean $setImageFile
* @param boolean $isCached
* @param boolean $isBaseFilePlaceholder
* @param array $resizedImageInfo
* @dataProvider getResizedImageInfoDataProvider
*/
public function testGetResizedImageInfo(
$imageId,
$imageFile,
$baseFile,
$destination,
$setImageFile,
$isCached,
$isBaseFilePlaceholder,
$resizedImageInfo
) {
$productMock = $this->getMockBuilder(Product::class)
->disableOriginalConstructor()
->getMock();
$productMock->expects($this->any())
->method('getData')
->with($destination)
->willReturn($imageFile);
$this->image->expects($this->any())
->method('setBaseFile')
->with($imageFile)
->willReturnSelf();
$this->image->expects($this->once())
->method('getBaseFile')
->willReturn($baseFile);
$this->image->expects($this->any())
->method('getDestinationSubdir')
->willReturn($destination);
$this->image->expects($this->any())
->method('isCached')
->willReturn($isCached);
$this->image->expects($this->any())
->method('resize')
->willReturnSelf();
$this->image->expects($this->any())
->method('saveFile')
->willReturnSelf();
$this->image->expects($this->once())
->method('getResizedImageInfo')
->willReturn($resizedImageInfo);
$this->image->expects($this->any())
->method('isBaseFilePlaceholder')
->willReturn($isBaseFilePlaceholder);
$this->prepareAttributes([], $imageId);
$this->helper->init($productMock, $imageId);
if ($setImageFile) {
$this->helper->setImageFile($imageFile);
}
$result = $this->helper->getResizedImageInfo();
$this->assertEquals($resizedImageInfo, $result);
}
/**
* @return array
*/
public function getResizedImageInfoDataProvider()
{
return [
[
'image_id' => 'test_image_id',
'image_file' => '/path/to/test_image_id.png',
'base_file' => '/path/to/base_image.png',
'destination' => 'small_image',
'set_image_file' => true,
'is_cached' => false,
'is_base_file_placeholder' => false,
'resized_image_info' => [
'x' => 100,
'y' => 100,
],
],
[
'image_id' => 'test_image_id',
'image_file' => '/path/to/test_image_id.png',
'base_file' => null,
'destination' => 'small_image',
'set_image_file' => false,
'is_cached' => false,
'is_base_file_placeholder' => false,
'resized_image_info' => [
'x' => 100,
'y' => 100,
],
],
[
'image_id' => 'test_image_id',
'image_file' => '/path/to/test_image_id.png',
'base_file' => null,
'destination' => 'small_image',
'set_image_file' => true,
'is_cached' => false,
'is_base_file_placeholder' => false,
'resized_image_info' => [
'x' => 100,
'y' => 100,
],
],
[
'image_id' => 'test_image_id',
'image_file' => '/path/to/test_image_id.png',
'base_file' => null,
'destination' => 'small_image',
'set_image_file' => true,
'is_cached' => false,
'is_base_file_placeholder' => true,
'resized_image_info' => [
'x' => 100,
'y' => 100,
],
],
[
'image_id' => 'test_image_id',
'image_file' => '/path/to/test_image_id.png',
'base_file' => null,
'destination' => 'small_image',
'set_image_file' => true,
'is_cached' => false,
'is_base_file_placeholder' => false,
'resized_image_info' => [
'x' => 100,
'y' => 100,
],
],
];
}
}