Skip to content

Commit c33478b

Browse files
committed
MSI-1542: Provide MSI support for Shipment Web API endpoint
1 parent a5107ab commit c33478b

File tree

4 files changed

+237
-2
lines changed

4 files changed

+237
-2
lines changed

app/code/Magento/Sales/Model/Order/ShipmentDocumentFactory.php

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
*/
66
namespace Magento\Sales\Model\Order;
77

8+
use Magento\Framework\App\ObjectManager;
89
use Magento\Sales\Api\Data\ShipmentInterface;
910
use Magento\Sales\Api\Data\ShipmentItemCreationInterface;
1011
use Magento\Sales\Api\Data\ShipmentPackageCreationInterface;
@@ -15,6 +16,7 @@
1516
use Magento\Sales\Api\Data\ShipmentCommentCreationInterface;
1617
use Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface;
1718
use Magento\Sales\Api\Data\OrderItemInterface;
19+
use Magento\Sales\Model\Order\ShipmentDocumentFactory\ExtensionAttributesProcessor;
1820

1921
/**
2022
* Class ShipmentDocumentFactory
@@ -39,21 +41,30 @@ class ShipmentDocumentFactory
3941
*/
4042
private $hydratorPool;
4143

44+
/**
45+
* @var ExtensionAttributesProcessor|null
46+
*/
47+
private $extensionAttributesProcessor;
48+
4249
/**
4350
* ShipmentDocumentFactory constructor.
4451
*
4552
* @param ShipmentFactory $shipmentFactory
4653
* @param HydratorPool $hydratorPool
4754
* @param TrackFactory $trackFactory
55+
* @param ExtensionAttributesProcessor $extensionAttributesProcessor
4856
*/
4957
public function __construct(
5058
ShipmentFactory $shipmentFactory,
5159
HydratorPool $hydratorPool,
52-
TrackFactory $trackFactory
60+
TrackFactory $trackFactory,
61+
ExtensionAttributesProcessor $extensionAttributesProcessor = null
5362
) {
5463
$this->shipmentFactory = $shipmentFactory;
5564
$this->trackFactory = $trackFactory;
5665
$this->hydratorPool = $hydratorPool;
66+
$this->extensionAttributesProcessor = $extensionAttributesProcessor ?: ObjectManager::getInstance()
67+
->get(ExtensionAttributesProcessor::class);
5768
}
5869

5970
/**
@@ -88,6 +99,8 @@ public function create(
8899
$shipmentItems
89100
);
90101

102+
$this->extensionAttributesProcessor->execute($shipment, $arguments);
103+
91104
foreach ($tracks as $track) {
92105
$hydrator = $this->hydratorPool->getHydrator(
93106
\Magento\Sales\Api\Data\ShipmentTrackCreationInterface::class
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
declare(strict_types=1);
7+
8+
namespace Magento\Sales\Model\Order\ShipmentDocumentFactory;
9+
10+
use Magento\Framework\Api\SimpleDataObjectConverter;
11+
use Magento\Framework\Reflection\ExtensionAttributesProcessor as AttributesProcessor;
12+
use Magento\Sales\Api\Data\ShipmentCreationArgumentsExtensionInterface;
13+
use Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface;
14+
use Magento\Sales\Api\Data\ShipmentExtensionFactory;
15+
use Magento\Sales\Api\Data\ShipmentInterface;
16+
17+
/**
18+
* Build and set extension attributes for shipment.
19+
*/
20+
class ExtensionAttributesProcessor
21+
{
22+
/**
23+
* @var ShipmentExtensionFactory
24+
*/
25+
private $shipmentExtensionFactory;
26+
27+
/**
28+
* @var ExtensionAttributesProcessor
29+
*/
30+
private $extensionAttributesProcessor;
31+
32+
/**
33+
* @param ShipmentExtensionFactory $shipmentExtensionFactory
34+
* @param AttributesProcessor $extensionAttributesProcessor
35+
*/
36+
public function __construct(
37+
ShipmentExtensionFactory $shipmentExtensionFactory,
38+
AttributesProcessor $extensionAttributesProcessor
39+
) {
40+
$this->shipmentExtensionFactory = $shipmentExtensionFactory;
41+
$this->extensionAttributesProcessor = $extensionAttributesProcessor;
42+
}
43+
44+
/**
45+
* @param ShipmentInterface $shipment
46+
* @param ShipmentCreationArgumentsInterface $arguments
47+
* @return void
48+
*/
49+
public function execute(
50+
ShipmentInterface $shipment,
51+
ShipmentCreationArgumentsInterface $arguments = null
52+
): void {
53+
if (null === $arguments) {
54+
return;
55+
}
56+
57+
$shipmentExtensionAttributes = $shipment->getExtensionAttributes();
58+
if (null === $shipmentExtensionAttributes) {
59+
$shipmentExtensionAttributes = $this->shipmentExtensionFactory->create();
60+
}
61+
62+
$attributes = $arguments->getExtensionAttributes();
63+
$extensionAttributes = $this->extensionAttributesProcessor->buildOutputDataArray(
64+
$attributes,
65+
ShipmentCreationArgumentsExtensionInterface::class
66+
);
67+
68+
foreach ($extensionAttributes as $code => $value) {
69+
$setMethod = 'set' . SimpleDataObjectConverter::snakeCaseToUpperCamelCase($code);
70+
71+
if (method_exists($shipmentExtensionAttributes, $setMethod)) {
72+
$shipmentExtensionAttributes->$setMethod($value);
73+
}
74+
}
75+
}
76+
}
Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
declare(strict_types=1);
7+
8+
namespace Magento\Sales\Test\Unit\Model\Order\ShipmentDocumentFactory;
9+
10+
use Magento\Framework\Reflection\ExtensionAttributesProcessor as AttributesProcessor;
11+
use Magento\Sales\Api\Data\ShipmentCreationArgumentsExtensionInterface;
12+
use Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface;
13+
use Magento\Sales\Api\Data\ShipmentExtensionFactory;
14+
use Magento\Sales\Api\Data\ShipmentExtensionInterface;
15+
use Magento\Sales\Api\Data\ShipmentInterface;
16+
use Magento\Sales\Model\Order\ShipmentDocumentFactory\ExtensionAttributesProcessor;
17+
use PHPUnit\Framework\TestCase;
18+
19+
/**
20+
* Provide tests for shipment document factory extension attributes processor.
21+
*/
22+
class ExtensionAttributesProcessorTest extends TestCase
23+
{
24+
/**
25+
* Test subject.
26+
*
27+
* @var ExtensionAttributesProcessor
28+
*/
29+
private $extensionAttributesProcessor;
30+
31+
/**
32+
* @var AttributesProcessor|\PHPUnit_Framework_MockObject_MockObject
33+
*/
34+
private $extensionAttributesProcessorMock;
35+
36+
/**
37+
* @var ShipmentExtensionFactory|\PHPUnit_Framework_MockObject_MockObject
38+
*/
39+
private $shipmentExtensionFactoryMock;
40+
41+
/**
42+
* @inheritdoc
43+
*/
44+
protected function setUp()
45+
{
46+
$this->shipmentExtensionFactoryMock = $this->getMockBuilder(ShipmentExtensionFactory::class)
47+
->disableOriginalConstructor()
48+
->getMock();
49+
50+
$this->extensionAttributesProcessorMock = $this->getMockBuilder(AttributesProcessor::class)
51+
->disableOriginalConstructor()
52+
->getMock();
53+
54+
$this->extensionAttributesProcessor = new ExtensionAttributesProcessor(
55+
$this->shipmentExtensionFactoryMock,
56+
$this->extensionAttributesProcessorMock
57+
);
58+
}
59+
60+
/**
61+
* Build and set extension attributes for shipment with shipment creation arguments.
62+
*
63+
* @return void
64+
*/
65+
public function testExecuteWithParameter(): void
66+
{
67+
/** @var ShipmentInterface|\PHPUnit_Framework_MockObject_MockObject $shipmentMock */
68+
$shipmentMock = $this->getMockBuilder(ShipmentInterface::class)
69+
->disableOriginalConstructor()
70+
->getMock();
71+
$shipmentMock->expects($this->once())
72+
->method('getExtensionAttributes')
73+
->willReturn(null);
74+
75+
$attributes = $this->getMockBuilder(ShipmentCreationArgumentsExtensionInterface::class)
76+
->disableOriginalConstructor()
77+
->getMockForAbstractClass();
78+
79+
/** @var ShipmentCreationArgumentsInterface|\PHPUnit_Framework_MockObject_MockObject $argumentsMock */
80+
$argumentsMock = $this->getMockBuilder(ShipmentCreationArgumentsInterface::class)
81+
->disableOriginalConstructor()
82+
->setMethods(['getExtensionAttributes'])
83+
->getMockForAbstractClass();
84+
$argumentsMock->expects($this->once())
85+
->method('getExtensionAttributes')
86+
->willReturn($attributes);
87+
88+
$shipmentExtensionAttributes = $this->getMockBuilder(ShipmentExtensionInterface::class)
89+
->disableOriginalConstructor()
90+
->setMethods(['setTestAttribute'])
91+
->getMockForAbstractClass();
92+
$shipmentExtensionAttributes->expects($this->once())
93+
->method('setTestAttribute')
94+
->with('test_value')
95+
->willReturnSelf();
96+
97+
$this->shipmentExtensionFactoryMock->expects($this->once())
98+
->method('create')
99+
->willReturn($shipmentExtensionAttributes);
100+
101+
$this->extensionAttributesProcessorMock->expects($this->once())
102+
->method('buildOutputDataArray')
103+
->with($attributes, ShipmentCreationArgumentsExtensionInterface::class)
104+
->willReturn(['test_attribute' => 'test_value']);
105+
106+
$this->extensionAttributesProcessor->execute($shipmentMock, $argumentsMock);
107+
}
108+
109+
/**
110+
* Build and set extension attributes for shipment without shipment creation arguments.
111+
*
112+
* @return void
113+
*/
114+
public function testExecuteWithoutParameter(): void
115+
{
116+
/** @var ShipmentInterface|\PHPUnit_Framework_MockObject_MockObject $shipmentMock */
117+
$shipmentMock = $this->getMockBuilder(ShipmentInterface::class)
118+
->disableOriginalConstructor()
119+
->getMock();
120+
$shipmentMock->expects($this->never())
121+
->method('getExtensionAttributes')
122+
->willReturn(null);
123+
124+
$this->shipmentExtensionFactoryMock->expects($this->never())
125+
->method('create');
126+
127+
$this->extensionAttributesProcessorMock->expects($this->never())
128+
->method('buildOutputDataArray');
129+
130+
$this->extensionAttributesProcessor->execute($shipmentMock, null);
131+
}
132+
}

app/code/Magento/Sales/Test/Unit/Model/Order/ShipmentDocumentFactoryTest.php

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use Magento\Sales\Model\Order\Shipment\TrackFactory;
1717
use Magento\Sales\Model\Order\Shipment\Track;
1818
use Magento\Framework\EntityManager\HydratorInterface;
19+
use Magento\Sales\Model\Order\ShipmentDocumentFactory\ExtensionAttributesProcessor;
1920

2021
/**
2122
* Class ShipmentDocumentFactoryTest
@@ -68,6 +69,11 @@ class ShipmentDocumentFactoryTest extends \PHPUnit\Framework\TestCase
6869
*/
6970
private $hydratorMock;
7071

72+
/**
73+
* @var \PHPUnit_Framework_MockObject_MockObject|ExtensionAttributesProcessor
74+
*/
75+
private $extensionAttributeProcessorMock;
76+
7177
/**
7278
* @var \PHPUnit_Framework_MockObject_MockObject|Track
7379
*/
@@ -113,10 +119,15 @@ protected function setUp()
113119
->disableOriginalConstructor()
114120
->getMockForAbstractClass();
115121

122+
$this->extensionAttributeProcessorMock = $this->getMockBuilder(ExtensionAttributesProcessor::class)
123+
->disableOriginalConstructor()
124+
->getMock();
125+
116126
$this->shipmentDocumentFactory = new ShipmentDocumentFactory(
117127
$this->shipmentFactoryMock,
118128
$this->hydratorPoolMock,
119-
$this->trackFactoryMock
129+
$this->trackFactoryMock,
130+
$this->extensionAttributeProcessorMock
120131
);
121132
}
122133

@@ -129,6 +140,9 @@ public function testCreate()
129140
$packages = [];
130141
$items = [1 => 10];
131142

143+
$this->extensionAttributeProcessorMock->expects($this->once())
144+
->method('execute')
145+
->with($this->shipmentMock, null);
132146
$this->itemMock->expects($this->once())->method('getOrderItemId')->willReturn(1);
133147
$this->itemMock->expects($this->once())->method('getQty')->willReturn(10);
134148
$this->itemMock->expects($this->once())

0 commit comments

Comments
 (0)