ReturnValidatorTest.php

Go to the documentation of this file.

<?php
namespace Magento\SalesInventory\Test\Unit\Model\Order;

use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Sales\Api\Data\CreditmemoInterface;
use Magento\Sales\Api\Data\CreditmemoItemInterface;
use Magento\Sales\Api\Data\OrderItemInterface;
use Magento\Sales\Api\OrderItemRepositoryInterface;
use Magento\SalesInventory\Model\Order\ReturnValidator;

class ReturnValidatorTest extends \PHPUnit\Framework\TestCase
{
    private $orderItemRepositoryMock;

    private $creditMemoMock;

    private $creditMemoItemMock;

    private $orderItemMock;

    private $returnValidator;

    protected function setUp()
    {
        $this->orderItemRepositoryMock = $this->getMockBuilder(OrderItemRepositoryInterface::class)
            ->disableOriginalConstructor()
            ->getMock();

        $this->creditMemoMock = $this->getMockBuilder(CreditmemoInterface::class)
            ->disableOriginalConstructor()
            ->getMock();

        $this->creditMemoItemMock = $this->getMockBuilder(CreditmemoItemInterface::class)
            ->disableOriginalConstructor()
            ->getMock();

        $this->orderItemMock = $this->getMockBuilder(OrderItemInterface::class)
            ->disableOriginalConstructor()
            ->getMock();

        $this->returnValidator = new ReturnValidator(
            $this->orderItemRepositoryMock
        );
    }

    public function testValidate(
        $expectedResult,
        $returnToStockItems,
        $orderItemId,
        $creditMemoItemId,
        $productSku = null
    ) {
        $this->creditMemoMock->expects($this->once())
            ->method('getItems')
            ->willReturn([$this->creditMemoItemMock]);

        $this->orderItemRepositoryMock->expects($this->once())
            ->method('get')
            ->with($returnToStockItems[0])
            ->willReturn($this->orderItemMock);

        $this->orderItemMock->expects($this->once())
            ->method('getItemId')
            ->willReturn($orderItemId);

        $this->creditMemoItemMock->expects($this->once())
            ->method('getOrderItemId')
            ->willReturn($creditMemoItemId);

        if ($productSku) {
            $this->orderItemMock->expects($this->once())
                ->method('getSku')
                ->willReturn($productSku);
        }

        $this->assertEquals(
            $this->returnValidator->validate($returnToStockItems, $this->creditMemoMock),
            $expectedResult
        );
    }

    public function testValidationWithWrongOrderItems()
    {
        $returnToStockItems = [1];
        $this->creditMemoMock->expects($this->once())
            ->method('getItems')
            ->willReturn([$this->creditMemoItemMock]);
        $this->orderItemRepositoryMock->expects($this->once())
            ->method('get')
            ->with($returnToStockItems[0])
            ->willThrowException(new NoSuchEntityException());

        $this->assertEquals(
            $this->returnValidator->validate($returnToStockItems, $this->creditMemoMock),
            __('The return to stock argument contains product item that is not part of the original order.')
        );
    }

    public function dataProvider()
    {
        return [
            'PostirivValidationTest' => [null, [1], 1, 1],
            'WithWrongReturnToStockItems' => [
                __('The "%1" product is not part of the current creditmemo.', 'sku1'), [2], 2, 1, 'sku1',
            ],
        ];
    }
}