Your IP : 216.73.216.220
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Ui\Test\Unit\Model\Export;
use Magento\Framework\Api\Search\DocumentInterface;
use Magento\Framework\Api\Search\SearchResultInterface;
use Magento\Framework\Api\SearchCriteriaInterface;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\Filesystem;
use Magento\Framework\Filesystem\Directory\WriteInterface as DirectoryWriteInterface;
use Magento\Framework\Filesystem\File\WriteInterface as FileWriteInterface;
use Magento\Framework\View\Element\UiComponent\ContextInterface;
use Magento\Framework\View\Element\UiComponent\DataProvider\DataProviderInterface;
use Magento\Framework\View\Element\UiComponentInterface;
use Magento\Ui\Component\MassAction\Filter;
use Magento\Ui\Model\Export\ConvertToCsv;
use Magento\Ui\Model\Export\MetadataProvider;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
/**
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class ConvertToCsvTest extends TestCase
{
/**
* @var ConvertToCsv
*/
protected $model;
/**
* @var DirectoryWriteInterface|MockObject
*/
protected $directory;
/**
* @var Filesystem|MockObject
*/
protected $filesystem;
/**
* @var Filter|MockObject
*/
protected $filter;
/**
* @var MetadataProvider|MockObject
*/
protected $metadataProvider;
/**
* @var FileWriteInterface|MockObject
*/
protected $stream;
/**
* @var UiComponentInterface|MockObject
*/
protected $component;
protected function setUp(): void
{
$this->directory = $this->getMockBuilder(\Magento\Framework\Filesystem\Directory\WriteInterface::class)
->getMockForAbstractClass();
$this->filesystem = $this->getMockBuilder(Filesystem::class)
->disableOriginalConstructor()
->getMock();
$this->filesystem->expects($this->any())
->method('getDirectoryWrite')
->with(DirectoryList::VAR_DIR)
->willReturn($this->directory);
$this->filter = $this->getMockBuilder(Filter::class)
->disableOriginalConstructor()
->getMock();
$this->metadataProvider = $this->getMockBuilder(MetadataProvider::class)
->disableOriginalConstructor()
->getMock();
$this->component = $this->getMockBuilder(UiComponentInterface::class)
->getMockForAbstractClass();
$this->stream = $this->getMockBuilder(\Magento\Framework\Filesystem\File\WriteInterface::class)
->setMethods([
'lock',
'unlock',
'close',
])
->getMockForAbstractClass();
$this->model = new ConvertToCsv(
$this->filesystem,
$this->filter,
$this->metadataProvider
);
}
public function testGetCsvFile()
{
$componentName = 'component_name';
$data = ['data_value'];
$document = $this->getMockBuilder(DocumentInterface::class)
->getMockForAbstractClass();
$this->mockComponent($componentName, [$document]);
$this->mockFilter();
$this->mockDirectory();
$this->stream->expects($this->once())
->method('lock')
->willReturnSelf();
$this->stream->expects($this->once())
->method('unlock')
->willReturnSelf();
$this->stream->expects($this->once())
->method('close')
->willReturnSelf();
$this->stream->expects($this->any())
->method('writeCsv')
->with($data)
->willReturnSelf();
$this->metadataProvider->expects($this->once())
->method('getOptions')
->willReturn([]);
$this->metadataProvider->expects($this->once())
->method('getHeaders')
->with($this->component)
->willReturn($data);
$this->metadataProvider->expects($this->once())
->method('getFields')
->with($this->component)
->willReturn([]);
$this->metadataProvider->expects($this->once())
->method('getRowData')
->with($document, [], [])
->willReturn($data);
$this->metadataProvider->expects($this->once())
->method('convertDate')
->with($document, $componentName);
$result = $this->model->getCsvFile();
$this->assertIsArray($result);
$this->assertArrayHasKey('type', $result);
$this->assertArrayHasKey('value', $result);
$this->assertArrayHasKey('rm', $result);
$this->assertStringContainsString($componentName, $result['value']);
$this->assertStringContainsString('.csv', $result['value']);
}
/**
* @param array $expected
*/
protected function mockStream($expected)
{
$this->stream = $this->getMockBuilder(\Magento\Framework\Filesystem\File\WriteInterface::class)
->setMethods([
'lock',
'unlock',
'close',
])
->getMockForAbstractClass();
$this->stream->expects($this->once())
->method('lock')
->willReturnSelf();
$this->stream->expects($this->once())
->method('unlock')
->willReturnSelf();
$this->stream->expects($this->once())
->method('close')
->willReturnSelf();
$this->stream->expects($this->once())
->method('writeCsv')
->with($expected)
->willReturnSelf();
}
/**
* @param string $componentName
* @param array $items
*/
protected function mockComponent($componentName, $items)
{
$context = $this->getMockBuilder(ContextInterface::class)
->setMethods(['getDataProvider'])
->getMockForAbstractClass();
$dataProvider = $this->getMockBuilder(
DataProviderInterface::class
)
->setMethods(['getSearchResult'])
->getMockForAbstractClass();
$searchResult = $this->getMockBuilder(SearchResultInterface::class)
->setMethods(['getItems'])
->getMockForAbstractClass();
$searchCriteria = $this->getMockBuilder(SearchCriteriaInterface::class)
->setMethods(['setPageSize', 'setCurrentPage'])
->getMockForAbstractClass();
$this->component->expects($this->any())
->method('getName')
->willReturn($componentName);
$this->component->expects($this->once())
->method('getContext')
->willReturn($context);
$context->expects($this->once())
->method('getDataProvider')
->willReturn($dataProvider);
$dataProvider->expects($this->exactly(2))
->method('getSearchResult')
->willReturn($searchResult);
$dataProvider->expects($this->once())
->method('getSearchCriteria')
->willReturn($searchCriteria);
$searchResult->expects($this->once())
->method('getItems')
->willReturn($items);
$searchResult->expects($this->once())
->method('getTotalCount')
->willReturn(1);
$searchCriteria->expects($this->any())
->method('setCurrentPage')
->willReturnSelf();
$searchCriteria->expects($this->once())
->method('setPageSize')
->with(200)
->willReturnSelf();
}
protected function mockFilter()
{
$this->filter->expects($this->once())
->method('getComponent')
->willReturn($this->component);
$this->filter->expects($this->once())
->method('prepareComponent')
->with($this->component)
->willReturnSelf();
$this->filter->expects($this->once())
->method('applySelectionOnTargetProvider')
->willReturnSelf();
}
protected function mockDirectory()
{
$this->directory->expects($this->once())
->method('create')
->with('export')
->willReturnSelf();
$this->directory->expects($this->once())
->method('openFile')
->willReturn($this->stream);
}
}