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;
use Magento\Framework\App\ResourceConnection;
use Magento\Framework\DB\Adapter\AdapterInterface;
use Magento\Framework\DB\Select;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
use Magento\Sales\Api\Data\OrderInterface;
use Magento\Sales\Api\Data\ShipmentCommentCreationInterface;
use Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface;
use Magento\Sales\Api\Data\ShipmentInterface;
use Magento\Sales\Api\Data\ShipmentPackageInterface;
use Magento\Sales\Api\Data\ShipmentTrackCreationInterface;
use Magento\Sales\Api\OrderRepositoryInterface;
use Magento\Sales\Api\ShipmentRepositoryInterface;
use Magento\Sales\Exception\CouldNotShipException;
use Magento\Sales\Exception\DocumentValidationException;
use Magento\Sales\Model\Order;
use Magento\Sales\Model\Order\Config as OrderConfig;
use Magento\Sales\Model\Order\OrderStateResolverInterface;
use Magento\Sales\Model\Order\Shipment\NotifierInterface;
use Magento\Sales\Model\Order\Shipment\OrderRegistrarInterface;
use Magento\Sales\Model\Order\ShipmentDocumentFactory;
use Magento\Sales\Model\Order\Validation\ShipOrderInterface;
use Magento\Sales\Model\OrderMutex;
use Magento\Sales\Model\ShipOrder;
use Magento\Sales\Model\ValidatorResultInterface;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;
/**
* Class ShipOrderTest
*
* Test Save shipment and order data
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.TooManyFields)
*/
class ShipOrderTest extends TestCase
{
/**
* @var ResourceConnection|MockObject
*/
private $resourceConnectionMock;
/**
* @var OrderRepositoryInterface|MockObject
*/
private $orderRepositoryMock;
/**
* @var ShipmentDocumentFactory|MockObject
*/
private $shipmentDocumentFactoryMock;
/**
* @var ShipOrderInterface|MockObject
*/
private $shipOrderValidatorMock;
/**
* @var OrderRegistrarInterface|MockObject
*/
private $orderRegistrarMock;
/**
* @var OrderStateResolverInterface|MockObject
*/
private $orderStateResolverMock;
/**
* @var OrderConfig|MockObject
*/
private $configMock;
/**
* @var ShipmentRepositoryInterface|MockObject
*/
private $shipmentRepositoryMock;
/**
* @var NotifierInterface|MockObject
*/
private $notifierInterfaceMock;
/**
* @var ShipOrder|MockObject
*/
private $model;
/**
* @var ShipmentCreationArgumentsInterface|MockObject
*/
private $shipmentCommentCreationMock;
/**
* @var ShipmentCommentCreationInterface|MockObject
*/
private $shipmentCreationArgumentsMock;
/**
* @var OrderInterface|MockObject
*/
private $orderMock;
/**
* @var ShipmentInterface|MockObject
*/
private $shipmentMock;
/**
* @var AdapterInterface|MockObject
*/
private $adapterMock;
/**
* @var ShipmentTrackCreationInterface|MockObject
*/
private $trackMock;
/**
* @var ShipmentPackageInterface|MockObject
*/
private $packageMock;
/**
* @var ValidatorResultInterface|MockObject
*/
private $validationMessagesMock;
/**
* @var LoggerInterface|MockObject
*/
private $loggerMock;
protected function setUp(): void
{
$this->resourceConnectionMock = $this->getMockBuilder(ResourceConnection::class)
->disableOriginalConstructor()
->getMock();
$this->orderRepositoryMock = $this->getMockBuilder(OrderRepositoryInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->shipmentDocumentFactoryMock = $this->getMockBuilder(ShipmentDocumentFactory::class)
->disableOriginalConstructor()
->getMock();
$this->orderRegistrarMock = $this->getMockBuilder(OrderRegistrarInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->orderStateResolverMock = $this->getMockBuilder(OrderStateResolverInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->configMock = $this->getMockBuilder(OrderConfig::class)
->disableOriginalConstructor()
->getMock();
$this->shipmentRepositoryMock = $this->getMockBuilder(ShipmentRepositoryInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->notifierInterfaceMock = $this->getMockBuilder(NotifierInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->loggerMock = $this->getMockBuilder(LoggerInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->shipmentCommentCreationMock = $this->getMockBuilder(ShipmentCommentCreationInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->shipmentCreationArgumentsMock = $this->getMockBuilder(ShipmentCreationArgumentsInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->orderMock = $this->getMockBuilder(OrderInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->shipmentMock = $this->getMockBuilder(ShipmentInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->packageMock = $this->getMockBuilder(ShipmentPackageInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->trackMock = $this->getMockBuilder(ShipmentTrackCreationInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->adapterMock = $this->getMockBuilder(AdapterInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->shipOrderValidatorMock = $this->getMockBuilder(ShipOrderInterface::class)
->disableOriginalConstructor()
->getMockForAbstractClass();
$this->validationMessagesMock = $this->getMockBuilder(ValidatorResultInterface::class)
->disableOriginalConstructor()
->setMethods(['hasMessages', 'getMessages', 'addMessage'])
->getMockForAbstractClass();
$helper = new ObjectManager($this);
$this->model = $helper->getObject(
ShipOrder::class,
[
'resourceConnection' => $this->resourceConnectionMock,
'orderRepository' => $this->orderRepositoryMock,
'shipmentDocumentFactory' => $this->shipmentDocumentFactoryMock,
'orderStateResolver' => $this->orderStateResolverMock,
'config' => $this->configMock,
'shipmentRepository' => $this->shipmentRepositoryMock,
'shipOrderValidator' => $this->shipOrderValidatorMock,
'notifierInterface' => $this->notifierInterfaceMock,
'logger' => $this->loggerMock,
'orderRegistrar' => $this->orderRegistrarMock,
'orderMutex' => new OrderMutex($this->resourceConnectionMock)
]
);
}
/**
* @param int $orderId
* @param array $items
* @param bool $notify
* @param bool $appendComment
* @throws CouldNotShipException
* @throws DocumentValidationException
* @dataProvider dataProvider
*/
public function testExecute($orderId, $items, $notify, $appendComment)
{
$this->mockConnection($orderId);
$this->orderRepositoryMock->expects($this->once())
->method('get')
->willReturn($this->orderMock);
$this->shipmentDocumentFactoryMock->expects($this->once())
->method('create')
->with(
$this->orderMock,
$items,
[$this->trackMock],
$this->shipmentCommentCreationMock,
($appendComment && $notify),
[$this->packageMock],
$this->shipmentCreationArgumentsMock
)->willReturn($this->shipmentMock);
$this->shipOrderValidatorMock->expects($this->once())
->method('validate')
->with(
$this->orderMock,
$this->shipmentMock,
$items,
$notify,
$appendComment,
$this->shipmentCommentCreationMock,
[$this->trackMock],
[$this->packageMock]
)
->willReturn($this->validationMessagesMock);
$hasMessages = false;
$this->validationMessagesMock->expects($this->once())
->method('hasMessages')->willReturn($hasMessages);
$this->orderRegistrarMock->expects($this->once())
->method('register')
->with($this->orderMock, $this->shipmentMock)
->willReturn($this->orderMock);
$this->orderStateResolverMock->expects($this->once())
->method('getStateForOrder')
->with($this->orderMock, [OrderStateResolverInterface::IN_PROGRESS])
->willReturn(Order::STATE_PROCESSING);
$this->orderMock->expects($this->once())
->method('setState')
->with(Order::STATE_PROCESSING)
->willReturnSelf();
$this->orderMock->expects($this->exactly(2))
->method('getState')
->willReturn(Order::STATE_NEW);
$this->configMock->expects($this->once())
->method('getStateDefaultStatus')
->with(Order::STATE_NEW)
->willReturn('Processing');
$this->orderMock->expects($this->once())
->method('setStatus')
->with('Processing')
->willReturnSelf();
$this->shipmentRepositoryMock->expects($this->once())
->method('save')
->with($this->shipmentMock)
->willReturn($this->shipmentMock);
$this->orderRepositoryMock->expects($this->once())
->method('save')
->with($this->orderMock)
->willReturn($this->orderMock);
if ($notify) {
$this->notifierInterfaceMock->expects($this->once())
->method('notify')
->with($this->orderMock, $this->shipmentMock, $this->shipmentCommentCreationMock);
}
$this->shipmentMock->expects($this->exactly(1))
->method('getEntityId')
->willReturn(2);
$this->assertEquals(
2,
$this->model->execute(
$orderId,
$items,
$notify,
$appendComment,
$this->shipmentCommentCreationMock,
[$this->trackMock],
[$this->packageMock],
$this->shipmentCreationArgumentsMock
)
);
}
public function testDocumentValidationException()
{
$this->expectException('Magento\Sales\Api\Exception\DocumentValidationExceptionInterface');
$orderId = 1;
$items = [1 => 2];
$notify = true;
$appendComment = true;
$errorMessages = ['error1', 'error2'];
$this->mockConnection($orderId);
$this->orderRepositoryMock->expects($this->once())
->method('get')
->willReturn($this->orderMock);
$this->shipmentDocumentFactoryMock->expects($this->once())
->method('create')
->with(
$this->orderMock,
$items,
[$this->trackMock],
$this->shipmentCommentCreationMock,
($appendComment && $notify),
[$this->packageMock],
$this->shipmentCreationArgumentsMock
)->willReturn($this->shipmentMock);
$this->shipOrderValidatorMock->expects($this->once())
->method('validate')
->with(
$this->orderMock,
$this->shipmentMock,
$items,
$notify,
$appendComment,
$this->shipmentCommentCreationMock,
[$this->trackMock],
[$this->packageMock]
)
->willReturn($this->validationMessagesMock);
$hasMessages = true;
$this->validationMessagesMock->expects($this->once())
->method('hasMessages')->willReturn($hasMessages);
$this->validationMessagesMock->expects($this->once())
->method('getMessages')->willReturn($errorMessages);
$this->model->execute(
$orderId,
$items,
$notify,
$appendComment,
$this->shipmentCommentCreationMock,
[$this->trackMock],
[$this->packageMock],
$this->shipmentCreationArgumentsMock
);
}
public function testCouldNotShipException()
{
$this->expectException('Magento\Sales\Api\Exception\CouldNotShipExceptionInterface');
$orderId = 1;
$items = [1 => 2];
$notify = true;
$appendComment = true;
$this->mockConnection($orderId);
$this->orderRepositoryMock->expects($this->once())
->method('get')
->willReturn($this->orderMock);
$this->shipmentDocumentFactoryMock->expects($this->once())
->method('create')
->with(
$this->orderMock,
$items,
[$this->trackMock],
$this->shipmentCommentCreationMock,
($appendComment && $notify),
[$this->packageMock],
$this->shipmentCreationArgumentsMock
)->willReturn($this->shipmentMock);
$this->shipOrderValidatorMock->expects($this->once())
->method('validate')
->with(
$this->orderMock,
$this->shipmentMock,
$items,
$notify,
$appendComment,
$this->shipmentCommentCreationMock,
[$this->trackMock],
[$this->packageMock]
)
->willReturn($this->validationMessagesMock);
$hasMessages = false;
$this->validationMessagesMock->expects($this->once())
->method('hasMessages')->willReturn($hasMessages);
$exception = new \Exception();
$this->orderRegistrarMock->expects($this->once())
->method('register')
->with($this->orderMock, $this->shipmentMock)
->willThrowException($exception);
$this->loggerMock->expects($this->once())
->method('critical')
->with($exception);
$this->adapterMock->expects($this->once())
->method('rollBack');
$this->model->execute(
$orderId,
$items,
$notify,
$appendComment,
$this->shipmentCommentCreationMock,
[$this->trackMock],
[$this->packageMock],
$this->shipmentCreationArgumentsMock
);
}
/**
* @return array
*/
public function dataProvider()
{
return [
'TestWithNotifyTrue' => [1, [1 => 2], true, true],
'TestWithNotifyFalse' => [1, [1 => 2], false, true],
];
}
/**
* @param int $orderId
*/
private function mockConnection(int $orderId): void
{
$select = $this->createMock(Select::class);
$select->expects($this->once())
->method('from')
->with('sales_order', 'entity_id')
->willReturnSelf();
$select->expects($this->once())
->method('where')
->with('entity_id = ?', $orderId)
->willReturnSelf();
$select->expects($this->once())
->method('forUpdate')
->with(true)
->willReturnSelf();
$this->adapterMock->expects($this->once())
->method('select')
->willReturn($select);
$this->resourceConnectionMock->expects($this->once())
->method('getConnection')
->with('sales')
->willReturn($this->adapterMock);
$this->resourceConnectionMock->expects($this->once())
->method('getTableName')
->willReturnArgument(0);
}
}