Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unit test for Magento\Downloadable\Model\Sample\DeleteHandler #26835

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

declare(strict_types=1);

namespace Magento\Downloadable\Test\Unit\Model\Sample;

use Magento\Catalog\Api\Data\ProductInterface;
use Magento\Catalog\Model\Product;
use Magento\Downloadable\Api\Data\SampleInterface;
use Magento\Downloadable\Api\SampleRepositoryInterface as SampleRepository;
use Magento\Downloadable\Model\Product\Type;
use Magento\Downloadable\Model\Sample\DeleteHandler;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;

/**
* Unit Test for \Magento\Downloadable\Model\Sample\DeleteHandler
*/
class DeleteHandlerTest extends TestCase
{
const STUB_PRODUCT_TYPE = 'simple';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a recommendation for the future to declare constant scope as private. It will reduce the chance of "temptation" to make another dependency on the current test in another test.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the note, will keep it in mind!

const STUB_PRODUCT_SKU = 'sku';
const STUB_SAMPLE_ID = 1;

/**
* @var ProductInterface|MockObject
*/
private $entityMock;

/**
* @var SampleRepository|MockObject
*/
private $sampleRepositoryMock;

/**
* @var DeleteHandler
*/
private $deleteHandler;

/**
* @inheritDoc
*/
protected function setUp()
{
$this->entityMock = $this->createMock(Product::class);
$this->sampleRepositoryMock = $this->getMockBuilder(SampleRepository::class)
->disableOriginalConstructor()
->setMethods(['getList', 'delete'])
->getMockForAbstractClass();

$this->deleteHandler = (new ObjectManagerHelper($this))->getObject(
DeleteHandler::class,
['sampleRepository' => $this->sampleRepositoryMock]
);
}

/**
* Test case when provided Product has type Downloadable.
*/
public function testExecuteWithDownloadableProduct()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another advice is to use return type hinting if we declare strict types in the future. So we have

Suggested change
public function testExecuteWithDownloadableProduct()
public function testExecuteWithDownloadableProduct(): void

{
$this->entityMock->expects($this->once())
->method('getTypeId')
->willReturn(Type::TYPE_DOWNLOADABLE);
$this->entityMock->expects($this->once())
->method('getSku')
->willReturn(self::STUB_PRODUCT_SKU);

$sampleMock = $this->createMock(SampleInterface::class);
$sampleMock->expects($this->once())
->method('getId')
->willReturn(self::STUB_SAMPLE_ID);

$this->sampleRepositoryMock->expects($this->once())->method('delete');
$this->sampleRepositoryMock->expects($this->once())
->method('getList')
->willReturn([$sampleMock]);

$this->assertSame($this->entityMock, $this->deleteHandler->execute($this->entityMock));
}

/**
* Test case when provided Product is not Downloadable.
*/
public function testExecuteWithOtherProduct()
{
$this->entityMock->expects($this->once())
->method('getTypeId')
->willReturn(self::STUB_PRODUCT_TYPE);

$this->sampleRepositoryMock->expects($this->never())->method('getList');
$this->sampleRepositoryMock->expects($this->never())->method('delete');
$this->assertSame($this->entityMock, $this->deleteHandler->execute($this->entityMock));
}
}