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\Sales\Test\Unit\Model\Service;
use Magento\Directory\Model\Currency;
use Magento\Framework\Api\Filter;
use Magento\Framework\Api\FilterBuilder;
use Magento\Framework\Api\SearchCriteria;
use Magento\Framework\Api\SearchCriteriaBuilder;
use Magento\Framework\App\ResourceConnection;
use Magento\Framework\DB\Adapter\AdapterInterface;
use Magento\Framework\Pricing\PriceCurrencyInterface;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
use Magento\Sales\Api\CreditmemoCommentRepositoryInterface;
use Magento\Sales\Api\CreditmemoRepositoryInterface;
use Magento\Sales\Api\Data\CreditmemoInterface;
use Magento\Sales\Api\OrderRepositoryInterface;
use Magento\Sales\Model\AbstractModel;
use Magento\Sales\Model\Order;
use Magento\Sales\Model\Order\Creditmemo;
use Magento\Sales\Model\Order\CreditmemoNotifier;
use Magento\Sales\Model\Order\RefundAdapterInterface;
use Magento\Sales\Model\Service\CreditmemoService;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
/**
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class CreditmemoServiceTest extends TestCase
{
/**
* @var CreditmemoRepositoryInterface|MockObject
*/
protected $creditmemoRepositoryMock;
/**
* @var CreditmemoCommentRepositoryInterface|MockObject
*/
protected $creditmemoCommentRepositoryMock;
/**
* @var SearchCriteriaBuilder|MockObject
*/
protected $searchCriteriaBuilderMock;
/**
* @var FilterBuilder|MockObject
*/
protected $filterBuilderMock;
/**
* @var CreditmemoNotifier|MockObject
*/
protected $creditmemoNotifierMock;
/**
* @var PriceCurrencyInterface|MockObject
*/
private $priceCurrency;
/**
* @var CreditmemoService
*/
protected $creditmemoService;
/**
* @var ObjectManager
*/
private $objectManagerHelper;
/**
* SetUp
*/
protected function setUp(): void
{
$this->creditmemoRepositoryMock = $this->getMockForAbstractClass(
CreditmemoRepositoryInterface::class,
['get'],
'',
false
);
$this->creditmemoCommentRepositoryMock = $this->getMockForAbstractClass(
CreditmemoCommentRepositoryInterface::class,
[],
'',
false
);
$this->searchCriteriaBuilderMock = $this->createPartialMock(
SearchCriteriaBuilder::class,
['create', 'addFilters']
);
$this->filterBuilderMock = $this->createPartialMock(
FilterBuilder::class,
['setField', 'setValue', 'setConditionType', 'create']
);
$this->creditmemoNotifierMock = $this->createMock(CreditmemoNotifier::class);
$this->priceCurrency = $this->getMockBuilder(PriceCurrencyInterface::class)
->getMockForAbstractClass();
$this->objectManagerHelper = new ObjectManager($this);
$this->creditmemoService = $this->objectManagerHelper->getObject(
CreditmemoService::class,
[
'creditmemoRepository' => $this->creditmemoRepositoryMock,
'creditmemoCommentRepository' => $this->creditmemoCommentRepositoryMock,
'searchCriteriaBuilder' => $this->searchCriteriaBuilderMock,
'filterBuilder' => $this->filterBuilderMock,
'creditmemoNotifier' => $this->creditmemoNotifierMock,
'priceCurrency' => $this->priceCurrency,
]
);
}
/**
* Run test cancel method
*/
public function testCancel()
{
$this->expectException('Magento\Framework\Exception\LocalizedException');
$this->expectExceptionMessage('You can not cancel Credit Memo');
$this->assertTrue($this->creditmemoService->cancel(1));
}
/**
* Run test getCommentsList method
*/
public function testGetCommentsList()
{
$id = 25;
$returnValue = 'return-value';
$filterMock = $this->createMock(Filter::class);
$searchCriteriaMock = $this->createMock(SearchCriteria::class);
$this->filterBuilderMock->expects($this->once())
->method('setField')
->with('parent_id')->willReturnSelf();
$this->filterBuilderMock->expects($this->once())
->method('setValue')
->with($id)->willReturnSelf();
$this->filterBuilderMock->expects($this->once())
->method('setConditionType')
->with('eq')->willReturnSelf();
$this->filterBuilderMock->expects($this->once())
->method('create')
->willReturn($filterMock);
$this->searchCriteriaBuilderMock->expects($this->once())
->method('addFilters')
->with([$filterMock]);
$this->searchCriteriaBuilderMock->expects($this->once())
->method('create')
->willReturn($searchCriteriaMock);
$this->creditmemoCommentRepositoryMock->expects($this->once())
->method('getList')
->with($searchCriteriaMock)
->willReturn($returnValue);
$this->assertEquals($returnValue, $this->creditmemoService->getCommentsList($id));
}
/**
* Run test notify method
*/
public function testNotify()
{
$id = 123;
$returnValue = 'return-value';
$modelMock = $this->getMockForAbstractClass(
AbstractModel::class,
[],
'',
false
);
$this->creditmemoRepositoryMock->expects($this->once())
->method('get')
->with($id)
->willReturn($modelMock);
$this->creditmemoNotifierMock->expects($this->once())
->method('notify')
->with($modelMock)
->willReturn($returnValue);
$this->assertEquals($returnValue, $this->creditmemoService->notify($id));
}
/**
* Run test notify method
*/
public function testRefund()
{
$creditMemoMock = $this->getMockBuilder(CreditmemoInterface::class)
->setMethods(['getId', 'getOrder', 'getInvoice', 'getOrderId'])
->disableOriginalConstructor()
->getMockForAbstractClass();
$creditMemoMock->expects($this->once())->method('getId')->willReturn(null);
$orderMock = $this->getMockBuilder(Order::class)
->disableOriginalConstructor()
->getMock();
$creditMemoMock->expects($this->atLeastOnce())->method('getOrder')->willReturn($orderMock);
$creditMemoMock->expects($this->atLeastOnce())->method('getOrderId')->willReturn(1);
$orderMock->expects($this->once())->method('getBaseTotalRefunded')->willReturn(0);
$orderMock->expects($this->once())->method('getBaseTotalPaid')->willReturn(10);
$creditMemoMock->expects($this->once())->method('getBaseGrandTotal')->willReturn(10);
$this->priceCurrency->expects($this->any())
->method('round')
->willReturnArgument(0);
// Set payment adapter dependency
$refundAdapterMock = $this->getMockBuilder(RefundAdapterInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->objectManagerHelper->setBackwardCompatibleProperty(
$this->creditmemoService,
'refundAdapter',
$refundAdapterMock
);
// Set resource dependency
$resourceMock = $this->getMockBuilder(ResourceConnection::class)
->disableOriginalConstructor()
->getMock();
$this->objectManagerHelper->setBackwardCompatibleProperty(
$this->creditmemoService,
'resource',
$resourceMock
);
// Set order repository dependency
$orderRepositoryMock = $this->getMockBuilder(OrderRepositoryInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->objectManagerHelper->setBackwardCompatibleProperty(
$this->creditmemoService,
'orderRepository',
$orderRepositoryMock
);
$adapterMock = $this->getMockBuilder(AdapterInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$resourceMock->expects($this->once())->method('getConnection')->with('sales')->willReturn($adapterMock);
$adapterMock->expects($this->once())->method('beginTransaction');
$refundAdapterMock->expects($this->once())
->method('refund')
->with($creditMemoMock, $orderMock, false)
->willReturn($orderMock);
$orderRepositoryMock->expects($this->once())
->method('save')
->with($orderMock);
$creditMemoMock->expects($this->once())
->method('getInvoice')
->willReturn(null);
$adapterMock->expects($this->once())->method('commit');
$this->creditmemoRepositoryMock->expects($this->once())
->method('save');
$this->assertSame($creditMemoMock, $this->creditmemoService->refund($creditMemoMock, true));
}
public function testRefundPendingCreditMemo()
{
$creditMemoMock = $this->getMockBuilder(CreditmemoInterface::class)
->setMethods(['getId', 'getOrder', 'getState', 'getInvoice', 'getOrderId'])
->disableOriginalConstructor()
->getMockForAbstractClass();
$creditMemoMock->expects($this->once())->method('getId')->willReturn(444);
$creditMemoMock->expects($this->once())->method('getState')
->willReturn(Creditmemo::STATE_OPEN);
$creditMemoMock->expects($this->once())->method('getOrderId')
->willReturn(1);
$orderMock = $this->getMockBuilder(Order::class)
->disableOriginalConstructor()
->getMock();
$creditMemoMock->expects($this->atLeastOnce())->method('getOrder')->willReturn($orderMock);
$orderMock->expects($this->once())->method('getBaseTotalRefunded')->willReturn(0);
$orderMock->expects($this->once())->method('getBaseTotalPaid')->willReturn(10);
$creditMemoMock->expects($this->once())->method('getBaseGrandTotal')->willReturn(10);
$this->priceCurrency->expects($this->any())
->method('round')
->willReturnArgument(0);
// Set payment adapter dependency
$refundAdapterMock = $this->getMockBuilder(RefundAdapterInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->objectManagerHelper->setBackwardCompatibleProperty(
$this->creditmemoService,
'refundAdapter',
$refundAdapterMock
);
// Set resource dependency
$resourceMock = $this->getMockBuilder(ResourceConnection::class)
->disableOriginalConstructor()
->getMock();
$this->objectManagerHelper->setBackwardCompatibleProperty(
$this->creditmemoService,
'resource',
$resourceMock
);
// Set order repository dependency
$orderRepositoryMock = $this->getMockBuilder(OrderRepositoryInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->objectManagerHelper->setBackwardCompatibleProperty(
$this->creditmemoService,
'orderRepository',
$orderRepositoryMock
);
$adapterMock = $this->getMockBuilder(AdapterInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$resourceMock->expects($this->once())->method('getConnection')->with('sales')->willReturn($adapterMock);
$adapterMock->expects($this->once())->method('beginTransaction');
$refundAdapterMock->expects($this->once())
->method('refund')
->with($creditMemoMock, $orderMock, false)
->willReturn($orderMock);
$orderRepositoryMock->expects($this->once())
->method('save')
->with($orderMock);
$creditMemoMock->expects($this->once())
->method('getInvoice')
->willReturn(null);
$adapterMock->expects($this->once())->method('commit');
$this->creditmemoRepositoryMock->expects($this->once())
->method('save');
$this->assertSame($creditMemoMock, $this->creditmemoService->refund($creditMemoMock, true));
}
public function testRefundExpectsMoneyAvailableToReturn()
{
$this->expectException('Magento\Framework\Exception\LocalizedException');
$this->expectExceptionMessage('The most money available to refund is 1.');
$baseGrandTotal = 10;
$baseTotalRefunded = 9;
$baseTotalPaid = 10;
/** @var CreditmemoInterface|MockObject $creditMemo */
$creditMemo = $this->getMockBuilder(CreditmemoInterface::class)
->setMethods(['getId', 'getOrder', 'getOrderId'])
->getMockForAbstractClass();
$creditMemo->method('getId')
->willReturn(null);
/** @var Order|MockObject $order */
$order = $this->getMockBuilder(Order::class)
->disableOriginalConstructor()
->getMock();
$creditMemo->method('getOrder')
->willReturn($order);
$creditMemo->method('getOrderId')
->willReturn(1);
$creditMemo->method('getBaseGrandTotal')
->willReturn($baseGrandTotal);
$order->method('getBaseTotalRefunded')
->willReturn($baseTotalRefunded);
$this->priceCurrency->method('round')
->withConsecutive([$baseTotalRefunded + $baseGrandTotal], [$baseTotalPaid])
->willReturnOnConsecutiveCalls($baseTotalRefunded + $baseGrandTotal, $baseTotalPaid);
$order->method('getBaseTotalPaid')
->willReturn($baseTotalPaid);
$baseAvailableRefund = $baseTotalPaid - $baseTotalRefunded;
$baseCurrency = $this->createMock(Currency::class);
$baseCurrency->expects($this->once())
->method('formatTxt')
->with($baseAvailableRefund)
->willReturn($baseAvailableRefund);
$order->expects($this->once())
->method('getBaseCurrency')
->willReturn($baseCurrency);
$this->creditmemoService->refund($creditMemo, true);
}
public function testRefundDoNotExpectsId()
{
$this->expectException('Magento\Framework\Exception\LocalizedException');
$this->expectExceptionMessage('We cannot register an existing credit memo.');
$creditMemoMock = $this->getMockBuilder(CreditmemoInterface::class)
->setMethods(['getId'])
->getMockForAbstractClass();
$creditMemoMock->expects($this->once())->method('getId')->willReturn(444);
$this->creditmemoService->refund($creditMemoMock, true);
}
public function testRefundDoNotExpectsOrderId()
{
$this->expectException('Magento\Framework\Exception\LocalizedException');
$this->expectExceptionMessage('We found an invalid order to refund.');
$creditMemoMock = $this->getMockBuilder(CreditmemoInterface::class)
->setMethods(['getId', 'getOrderId'])
->getMockForAbstractClass();
$creditMemoMock->expects($this->once())->method('getId')->willReturn(null);
$creditMemoMock->expects($this->once())->method('getOrderId')->willReturn(null);
$this->creditmemoService->refund($creditMemoMock, true);
}
public function testMultiCurrencyRefundExpectsMoneyAvailableToReturn()
{
$this->expectException('Magento\Framework\Exception\LocalizedException');
$this->expectExceptionMessage('The most money available to refund is $1.00.');
$baseGrandTotal = 10.00;
$baseTotalRefunded = 9.00;
$baseTotalPaid = 10;
$grandTotal = 8.81;
$totalRefunded = 7.929;
$totalPaid = 8.81;
/** @var CreditmemoInterface|MockObject $creditMemo */
$creditMemo = $this->getMockBuilder(CreditmemoInterface::class)
->setMethods(['getId', 'getOrder', 'getOrderId'])
->getMockForAbstractClass();
$creditMemo->method('getId')
->willReturn(null);
/** @var Order|MockObject $order */
$order = $this->getMockBuilder(Order::class)
->disableOriginalConstructor()
->getMock();
$creditMemo->method('getOrder')
->willReturn($order);
$creditMemo->method('getOrderId')
->willReturn(1);
$creditMemo->method('getBaseGrandTotal')
->willReturn($baseGrandTotal);
$creditMemo->method('getGrandTotal')
->willReturn($grandTotal);
$order->method('getBaseTotalRefunded')
->willReturn($baseTotalRefunded);
$order->method('getTotalRefunded')
->willReturn($totalRefunded);
$this->priceCurrency->method('round')
->withConsecutive([$baseTotalRefunded + $baseGrandTotal], [$baseTotalPaid])
->willReturnOnConsecutiveCalls($baseTotalRefunded + $baseGrandTotal, $baseTotalPaid);
$order->method('getBaseTotalPaid')
->willReturn($baseTotalPaid);
$order->method('getTotalPaid')
->willReturn($totalPaid);
$baseAvailableRefund = $baseTotalPaid - $baseTotalRefunded;
$baseCurrency = $this->createMock(Currency::class);
$baseCurrency->expects($this->once())
->method('formatTxt')
->with($baseAvailableRefund)
->willReturn(sprintf('$%.2f', $baseAvailableRefund));
$order->expects($this->once())
->method('getBaseCurrency')
->willReturn($baseCurrency);
$this->creditmemoService->refund($creditMemo, true);
}
}