Skip to content

Commit a793712

Browse files
author
Stanislav Idolov
authored
ENGCOM-2906: MSI-1542: Provide MSI support for Shipment Web API endpoint #17392 
2 parents 6b0874c + bb408ea commit a793712

File tree

5 files changed

+199
-2
lines changed

5 files changed

+199
-2
lines changed

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

Lines changed: 16 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
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,10 @@ public function create(
8899
$shipmentItems
89100
);
90101

102+
if (null !== $arguments) {
103+
$this->extensionAttributesProcessor->execute($shipment, $arguments);
104+
}
105+
91106
foreach ($tracks as $track) {
92107
$hydrator = $this->hydratorPool->getHydrator(
93108
\Magento\Sales\Api\Data\ShipmentTrackCreationInterface::class

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

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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\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+
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
52+
): void {
53+
$shipmentExtensionAttributes = [];
54+
if (null !== $shipment->getExtensionAttributes()) {
55+
$shipmentExtensionAttributes = $this->extensionAttributesProcessor->buildOutputDataArray(
56+
$shipment->getExtensionAttributes(),
57+
ShipmentExtensionInterface::class
58+
);
59+
}
60+
$argumentsExtensionAttributes = [];
61+
if (null !== $arguments->getExtensionAttributes()) {
62+
$argumentsExtensionAttributes = $this->extensionAttributesProcessor->buildOutputDataArray(
63+
$arguments->getExtensionAttributes(),
64+
ShipmentCreationArgumentsExtensionInterface::class
65+
);
66+
}
67+
68+
$mergedExtensionAttributes = $this->shipmentExtensionFactory->create([
69+
'data' => array_merge($shipmentExtensionAttributes, $argumentsExtensionAttributes)
70+
]);
71+
72+
$shipment->setExtensionAttributes($mergedExtensionAttributes);
73+
}
74+
}

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

Lines changed: 13 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,7 @@ public function testCreate()
129140
$packages = [];
130141
$items = [1 => 10];
131142

143+
$this->extensionAttributeProcessorMock->expects($this->never())->method('execute');
132144
$this->itemMock->expects($this->once())->method('getOrderItemId')->willReturn(1);
133145
$this->itemMock->expects($this->once())->method('getQty')->willReturn(10);
134146
$this->itemMock->expects($this->once())

‎dev/tests/integration/testsuite/Magento/Sales/Model/Order/ShipmentDocumentFactoryTest.php

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
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;
9+
10+
use Magento\Sales\Api\Data\ShipmentCreationArgumentsExtensionInterfaceFactory;
11+
use Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface;
12+
use Magento\Sales\Model\Order;
13+
use Magento\TestFramework\Helper\Bootstrap;
14+
use PHPUnit\Framework\TestCase;
15+
16+
/**
17+
* Provide tests for shipment document factory.
18+
*/
19+
class ShipmentDocumentFactoryTest extends TestCase
20+
{
21+
/**
22+
* @var Order
23+
*/
24+
private $order;
25+
26+
/**
27+
* @var ShipmentDocumentFactory
28+
*/
29+
private $shipmentDocumentFactory;
30+
31+
/**
32+
* @var ShipmentCreationArgumentsInterface
33+
*/
34+
private $shipmentCreationArgumentsInterface;
35+
36+
/**
37+
* @var ShipmentCreationArgumentsExtensionInterfaceFactory
38+
*/
39+
private $shipmentCreationArgumentsExtensionInterfaceFactory;
40+
41+
/**
42+
* @inheritdoc
43+
*/
44+
protected function setUp(): void
45+
{
46+
$objectManager = Bootstrap::getObjectManager();
47+
48+
$this->order = $objectManager->create(Order::class);
49+
$this->shipmentDocumentFactory = $objectManager->create(ShipmentDocumentFactory::class);
50+
$this->shipmentCreationArgumentsInterface = $objectManager
51+
->create(ShipmentCreationArgumentsInterface::class);
52+
$this->shipmentCreationArgumentsExtensionInterfaceFactory = $objectManager
53+
->create(ShipmentCreationArgumentsExtensionInterfaceFactory::class);
54+
}
55+
56+
/**
57+
* Create shipment with shipment creation arguments.
58+
*
59+
* @magentoDataFixture Magento/Sales/_files/order.php
60+
*/
61+
public function testCreate(): void
62+
{
63+
$order = $this->order->loadByIncrementId('100000001');
64+
$argumentsExtensionAttributes = $this->shipmentCreationArgumentsExtensionInterfaceFactory->create([
65+
'data' => ['test_attribute_value' => 'test_value']
66+
]);
67+
$this->shipmentCreationArgumentsInterface->setExtensionAttributes($argumentsExtensionAttributes);
68+
$shipment = $this->shipmentDocumentFactory->create(
69+
$order,
70+
[],
71+
[],
72+
null,
73+
false,
74+
[],
75+
$this->shipmentCreationArgumentsInterface
76+
);
77+
$shipmentExtensionAttributes = $shipment->getExtensionAttributes();
78+
self::assertEquals('test_value', $shipmentExtensionAttributes->getTestAttributeValue());
79+
}
80+
}

‎dev/tests/integration/testsuite/Magento/Sales/etc/extension_attributes.xml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?xml version="1.0"?>
2+
<!--
3+
/**
4+
* Copyright © Magento, Inc. All rights reserved.
5+
* See COPYING.txt for license details.
6+
*/
7+
-->
8+
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
9+
xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">
10+
<extension_attributes for="Magento\Sales\Api\Data\ShipmentInterface">
11+
<attribute code="test_attribute_value" type="string"/>
12+
</extension_attributes>
13+
<extension_attributes for="Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface">
14+
<attribute code="test_attribute_value" type="string"/>
15+
</extension_attributes>
16+
</config>

0 commit comments

Comments
 (0)