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.

Sign up for GitHub

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

Jump to bottom

Allow wishlist share when all items are out of stock #26185

Merged
merged 6 commits into from
Jan 17, 2020
Merged

Allow wishlist share when all items are out of stock #26185

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6cf13db
Allow wishlist share when all items are out of stock
Dec 26, 2019
860af38
Fix static tests
Dec 26, 2019
21bdc67
Cover changes with Unit test
Nazar65 Dec 30, 2019
3c3018d
Cover changes with unit test
Nazar65 Dec 30, 2019
74a244f
Refactor per review comments, add new test case
Nazar65 Jan 10, 2020
1748633
rename const with prefix "stub" move Object Manager to separate
Nazar65 Jan 10, 2020
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
214 changes: 130 additions & 84 deletions app/code/Magento/Wishlist/Test/Unit/Controller/Index/UpdateTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,15 @@
use Magento\Framework\Exception\NotFoundException;
use Magento\Framework\Message\ManagerInterface;
use Magento\Framework\ObjectManagerInterface;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
use Magento\Wishlist\Controller\Index\Update;
use Magento\Wishlist\Controller\WishlistProviderInterface;
use Magento\Wishlist\Helper\Data;
use Magento\Wishlist\Model\Item;
use Magento\Wishlist\Model\LocaleQuantityProcessor;
use Magento\Wishlist\Model\Wishlist;
use PHPUnit\Framework\TestCase;
use PHPUnit_Framework_MockObject_MockObject as MockObject;

/**
* Test for upate controller wishlist
Expand All @@ -27,124 +30,124 @@
class UpdateTest extends TestCase
{
/**
* @var Validator $formKeyValidator
* Wishlist item id
*
* @var int
*/
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't use Docblocks for consts

private const ITEM_ID = 1;
Copy link
Contributor

Choose a reason for hiding this comment

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

Prefix with STUB_ as it means that is just "stupid replacement" for actual value, that does not matter for tests.


/**
* Product qty for wishlist
*
* @var int
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't use docblocks for const

*/
private $formKeyValidator;
private const WISHLIST_PRODUCT_QTY = 21;
Copy link
Contributor

Choose a reason for hiding this comment

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

Prefix with STUB_


/**
* @var WishlistProviderInterface $wishlistProvider
* @var MockObject|Validator $formKeyValidatorMock
*/
private $wishlistProvider;
private $formKeyValidatorMock;

/**
* @var LocaleQuantityProcessor $quantityProcessor
* @var MockObject|WishlistProviderInterface $wishlistProviderMock
*/
private $quantityProcessor;
private $wishlistProviderMock;

/**
* @var MockObject|LocaleQuantityProcessor $quantityProcessorMock
*/
private $quantityProcessorMock;

/**
* @var Update $updateController
*/
private $updateController;

/**
* @var $context
* @var MockObject|Context$contextMock
*/
private $context;
private $contextMock;

/**
* @var Redirect $resultRedirect
* @var MockObject|Redirect $resultRedirectMock
*/
private $resultRedirect;
private $resultRedirectMock;

/**
* @var ResultFactory $resultFatory
* @var MockObject|ResultFactory $resultFatoryMock
*/
private $resultFactory;
private $resultFactoryMock;

/**
* @var RequestInterface $requestMock
* @var MockObject|RequestInterface $requestMock
*/
private $requestMock;
Copy link
Contributor

Choose a reason for hiding this comment

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

👍


/**
* @var ObjectManagerInterface $objectManagerMock
* @var MockObject|ObjectManagerInterface $objectManagerMock
*/
private $objectManagerMock;

/**
* @var ManagerInterface $messageManager
* @var MockObject|ManagerInterface $messageManagerMock
*/
private $messageManager;
private $messageManagerMock;

/**
* @inheritdoc
*/
protected function setUp()
{
$this->formKeyValidator = $this->createMock(Validator::class);
$this->wishlistProvider = $this->createMock(WishlistProviderInterface::class);
$this->quantityProcessor = $this->createMock(LocaleQuantityProcessor::class);
$this->context = $this->createMock(Context::class);
$this->resultRedirect = $this->createMock(Redirect::class);
$this->resultFactory = $this->createPartialMock(ResultFactory::class, ['create']);
$this->formKeyValidatorMock = $this->createMock(Validator::class);
$this->wishlistProviderMock = $this->createMock(WishlistProviderInterface::class);
$this->quantityProcessorMock = $this->createMock(LocaleQuantityProcessor::class);
$this->contextMock = $this->createMock(Context::class);
$this->resultRedirectMock = $this->createMock(Redirect::class);
$this->resultFactoryMock = $this->createPartialMock(ResultFactory::class, ['create']);
$this->messageManagerMock = $this->createMock(ManagerInterface::class);
$this->objectManagerMock = $this->createMock(ObjectManagerInterface::class);
$this->requestMock = $this->getMockBuilder(RequestInterface::class)
->setMethods(['getPostValue'])
->getMockForAbstractClass();
$this->objectManagerMock = $this->createMock(ObjectManagerInterface::class);

$this->context->expects($this->once())
$this->resultFactoryMock->expects($this->any())
->method('create')
->willReturn($this->resultRedirectMock);
$this->contextMock->expects($this->once())
->method('getResultFactory')
->willReturn($this->resultFactory);
$this->context->expects($this->once())
->willReturn($this->resultFactoryMock);
$this->contextMock->expects($this->once())
->method('getObjectManager')
->willReturn($this->objectManagerMock);

$this->resultFactory->expects($this->any())
->method('create')
->willReturn($this->resultRedirect);
$this->context->expects($this->any())
$this->contextMock->expects($this->any())
->method('getRequest')
->willReturn($this->requestMock);

$this->messageManager = $this->createMock(ManagerInterface::class);
$this->context->expects($this->any())
$this->contextMock->expects($this->any())
->method('getMessageManager')
->willReturn($this->messageManager);
->willReturn($this->messageManagerMock);

$this->updateController = new Update(
$this->context,
$this->formKeyValidator,
$this->wishlistProvider,
$this->quantityProcessor
$this->updateController = (new ObjectManagerHelper($this))->getObject(
Copy link
Contributor

Choose a reason for hiding this comment

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

Extract this to separate variable:
$objectManager = new ObjectManagerHelper($this);

Update::class,
[
'context' => $this->contextMock,
'_formKeyValidator' => $this->formKeyValidatorMock,
'wishlistProvider' => $this->wishlistProviderMock,
'quantityProcessor' => $this->quantityProcessorMock
]
);
}

/**
* Test for update method Wishlist controller.
*
* @dataProvider getWishlistDataProvider
* @param array $wishlistDataProvider
* @param array $postData
* @return void
*/
public function testUpdate(array $wishlistDataProvider): void
public function testUpdate(array $wishlistDataProvider, array $postData): void
{
$this->formKeyValidator->expects($this->once())
->method('validate')
->willReturn(true);

$wishlist = $this->createMock(\Magento\Wishlist\Model\Wishlist::class);

$this->wishlistProvider->expects($this->once())
->method('getWishlist')
->willReturn($wishlist);
$wishlist->expects($this->exactly(2))
->method('getId')
->willReturn($wishlistDataProvider['wishlist_data']['id']);
$this->requestMock->expects($this->once())
->method('getPostValue')
->willReturn($wishlistDataProvider['post_data']);
$this->resultRedirect->expects($this->once())
->method('setPath')
->with('*', ['wishlist_id' => $wishlistDataProvider['wishlist_data']['id']]);
$wishlist = $this->createMock(Wishlist::class);
$itemMock = $this->getMockBuilder(Item::class)
->disableOriginalConstructor()
->setMethods(
Expand All @@ -160,7 +163,27 @@ public function testUpdate(array $wishlistDataProvider): void
'getName'
]
)->getMock();
$dataMock = $this->createMock(Data::class);
$productMock = $this->getMockBuilder(\Magento\Catalog\Model\Product::class)
->disableOriginalConstructor()
->getMock();

$this->formKeyValidatorMock->expects($this->once())
->method('validate')
->with($this->requestMock)
->willReturn(true);
$this->wishlistProviderMock->expects($this->once())
->method('getWishlist')
->willReturn($wishlist);
$wishlist->expects($this->exactly(2))
->method('getId')
->willReturn($wishlistDataProvider['id']);
$this->requestMock->expects($this->once())
->method('getPostValue')
->willReturn($postData);
$this->resultRedirectMock->expects($this->once())
->method('setPath')
->with('*', ['wishlist_id' => $wishlistDataProvider['id']]);
$this->objectManagerMock->expects($this->once())
->method('create')
->with(Item::class)
Expand All @@ -171,7 +194,7 @@ public function testUpdate(array $wishlistDataProvider): void
->willReturnSelf();
$itemMock->expects($this->once())
->method('getWishLIstId')
->willReturn($wishlistDataProvider['wishlist_data']['id']);
->willReturn($wishlistDataProvider['id']);
$itemMock->expects($this->once())
->method('getDescription')
->willReturn('');
Expand All @@ -181,8 +204,6 @@ public function testUpdate(array $wishlistDataProvider): void
$itemMock->expects($this->once())
->method('setQty')
->willReturnSelf();
$dataMock = $this->createMock(Data::class);

$this->objectManagerMock->expects($this->exactly(2))
->method('get')
->with(Data::class)
Expand All @@ -192,33 +213,62 @@ public function testUpdate(array $wishlistDataProvider): void
->willReturn('');
$dataMock->expects($this->once())
->method('calculate');
$this->quantityProcessor->expects($this->once())
$this->quantityProcessorMock->expects($this->once())
->method('process')
->willReturn($wishlistDataProvider['post_data']['qty']);

$productMock = $this->getMockBuilder(\Magento\Catalog\Model\Product::class)
->disableOriginalConstructor()
->getMock();
->willReturn($postData['qty']);
$itemMock->expects($this->once())
->method('getProduct')
->willReturn($productMock);
$productMock->expects($this->once())
->method('getName')
->willReturn('product');
$this->messageManager->expects($this->once())
$this->messageManagerMock->expects($this->once())
->method('addSuccessMessage');
$this->assertEquals($this->resultRedirect, $this->updateController->execute());

$this->assertEquals($this->resultRedirectMock, $this->updateController->execute());
}

/**
* Verify update method if post data not available
*
* @dataProvider getWishlistDataProvider
* @param array $wishlistDataProvider
* @return void
*/
public function testUpdateRedirectWhenNoPostData(array $wishlistDataProvider): void
{
$wishlist = $this->createMock(Wishlist::class);

$this->formKeyValidatorMock->expects($this->once())
->method('validate')
->willReturn(true);
$this->wishlistProviderMock->expects($this->once())
->method('getWishlist')
->willReturn($wishlist);
$wishlist->expects($this->exactly(1))
->method('getId')
->willReturn($wishlistDataProvider['id']);
$this->resultRedirectMock->expects($this->once())
->method('setPath')
->with('*', ['wishlist_id' => $wishlistDataProvider['id']]);
$this->requestMock->expects($this->once())
->method('getPostValue')
->willReturn(null);

$this->assertEquals($this->resultRedirectMock, $this->updateController->execute());
}

/**
* Check if wishlist not availbale, and exception is shown
*
* @return void
*/
public function testUpdateWithNotFoundException()
public function testUpdateThrowsNotFoundExceptionWhenWishlistDoNotExist(): void
{
$this->formKeyValidator->expects($this->once())
$this->formKeyValidatorMock->expects($this->once())
->method('validate')
->willReturn(true);
$this->wishlistProvider->expects($this->once())
$this->wishlistProviderMock->expects($this->once())
->method('getWishlist')
->willReturn(null);
$this->expectException(NotFoundException::class);
Expand All @@ -232,21 +282,17 @@ public function testUpdateWithNotFoundException()
*/
public function getWishlistDataProvider(): array
{
return [
return
[
[
'wishlist_data' => [
'id' => 1,

[
'id' => self::ITEM_ID
],
'post_data' => [
'qty' => [1 => 12],
'description' => [
1 => 'Description for item_id 1'
]
[
'qty' => [self::ITEM_ID => self::WISHLIST_PRODUCT_QTY],
'description' => [self::ITEM_ID => 'Description for item_id 1']
]
]
]
];
];
}
}