ACP2E-1650:Create Shipment API

- added validation for create shipment API call when order contains bundle products

Author: aplapana

app/code/Magento/Bundle/Model/Sales/Order/BundleOrderTypeValidator.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Magento\Bundle\Model\Sales\Order;
+
+use Magento\Bundle\Model\Sales\Order\Shipment\BundleShipmentTypeValidator;
+use \Laminas\Validator\ValidatorInterface;
+use Magento\Sales\Model\Order\Shipment;
+
+class BundleOrderTypeValidator extends BundleShipmentTypeValidator implements ValidatorInterface
+{
+    /**
+     * @var array
+     */
+    private array $messages = [];
+
+    /**
+     * @param Shipment $value
+     * @return bool
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     * @throws \Magento\Sales\Exception\DocumentValidationException
+     */
+    public function isValid($value): bool
+    {
+        foreach ($value->getOrder()->getAllItems() as $orderItem) {
+            foreach ($value->getItems() as $shipmentItem) {
+                if ($orderItem->getItemId() == $shipmentItem->getOrderItemId()) {
+                    $this->messages = array_merge($this->messages, $this->validate($orderItem));
+                }
+            }
+        }
+
+        return empty($this->messages);
+    }
+
+    /**
+     * @return array|string[]
+     */
+    public function getMessages(): array
+    {
+        return $this->messages;
+    }
+}

app/code/Magento/Bundle/etc/webapi_rest/di.xml

@@ -17,4 +17,9 @@
         <plugin name="reindex_after_add_child_by_sku" type="Magento\Bundle\Plugin\Api\ProductLinkManagement\ReindexAfterAddChildBySkuPlugin"/>
         <plugin name="reindex_after_remove_child" type="Magento\Bundle\Plugin\Api\ProductLinkManagement\ReindexAfterRemoveChildPlugin"/>
     </type>
+    <type name="Magento\Sales\Model\Order\Shipment">
+        <arguments>
+            <argument name="validator" xsi:type="object">Magento\Bundle\Model\Sales\Order\BundleOrderTypeValidator</argument>
+        </arguments>
+    </type>
 </config>

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

@@ -5,11 +5,13 @@
  */
 namespace Magento\Sales\Model\Order;
 
+use Magento\Bundle\Model\Sales\Order\BundleOrderTypeValidator;
 use Magento\Framework\Api\AttributeValueFactory;
 use Magento\Sales\Api\Data\ShipmentInterface;
 use Magento\Sales\Model\AbstractModel;
 use Magento\Sales\Model\EntityInterface;
 use Magento\Sales\Model\ResourceModel\Order\Shipment\Comment\Collection as CommentsCollection;
+use Magento\Sales\Model\ValidatorInterface;
 
 /**
  * Sales order shipment model
@@ -104,6 +106,11 @@ class Shipment extends AbstractModel implements EntityInterface, ShipmentInterfa
      */
     private $commentsCollection;
 
+    /**
+     * @var ValidatorInterface|null
+     */
+    private $validator;
+
     /**
      * @param \Magento\Framework\Model\Context $context
      * @param \Magento\Framework\Registry $registry
@@ -117,6 +124,7 @@ class Shipment extends AbstractModel implements EntityInterface, ShipmentInterfa
      * @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
      * @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
      * @param array $data
+     * @param ValidatorInterface|null $validator
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -131,13 +139,15 @@ public function __construct(
         \Magento\Sales\Api\OrderRepositoryInterface $orderRepository,
         \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
         \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
-        array $data = []
+        array $data = [],
+        ?ValidatorInterface $validator = null
     ) {
         $this->_shipmentItemCollectionFactory = $shipmentItemCollectionFactory;
         $this->_trackCollectionFactory = $trackCollectionFactory;
         $this->_commentFactory = $commentFactory;
         $this->_commentCollectionFactory = $commentCollectionFactory;
         $this->orderRepository = $orderRepository;
+        $this->validator = $validator;
         parent::__construct(
             $context,
             $registry,
@@ -159,6 +169,14 @@ protected function _construct()
         $this->_init(\Magento\Sales\Model\ResourceModel\Order\Shipment::class);
     }
 
+    /**
+     * @inheritDoc
+     */
+    protected function _getValidationRulesBeforeSave(): ?ValidatorInterface
+    {
+        return $this->validator;
+    }
+
     /**
      * Load shipment by increment id
      *

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

@@ -146,6 +146,8 @@ public function save(\Magento\Sales\Api\Data\ShipmentInterface $entity)
         try {
             $this->metadata->getMapper()->save($entity);
             $this->registry[$entity->getEntityId()] = $entity;
+        } catch (\Magento\Framework\Validator\Exception $exception) {
+            throw new CouldNotSaveException(__($exception->getMessage()), $exception);
         } catch (\Exception $e) {
             throw new CouldNotSaveException(__("The shipment couldn't be saved."), $e);
         }

lib/internal/Magento/Framework/Model/AbstractModel.php

@@ -8,6 +8,7 @@
 use Laminas\Validator\ValidatorChain;
 use Laminas\Validator\ValidatorInterface;
 use Magento\Framework\DataObject;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Phrase;
 
 /**
@@ -754,6 +755,7 @@ protected function _getValidatorBeforeSave()
      * Returns FALSE, if no validation rules exist.
      *
      * @return ValidatorInterface|bool
+     * @throws LocalizedException
      */
     protected function _createValidatorBeforeSave()
     {
@@ -763,19 +765,25 @@ protected function _createValidatorBeforeSave()
             return false;
         }
 
-        if ($modelRules && $resourceRules) {
-            $validator = new ValidatorChain();
-            $validator->addValidator($modelRules);
-            $validator->addValidator($resourceRules);
-        } elseif ($modelRules) {
-            $validator = $modelRules;
-        } else {
-            $validator = $resourceRules;
+        $validator = $this->getValidator();
+        if ($modelRules) {
+            $validator->attach($modelRules);
+        }
+        if ($resourceRules) {
+            $validator->attach($resourceRules);
         }
 
         return $validator;
     }
 
+    /**
+     * @return ValidatorChain
+     */
+    protected function getValidator(): ValidatorChain
+    {
+        return \Magento\Framework\App\ObjectManager::getInstance()->create(ValidatorChain::class);
+    }
+
     /**
      * Template method to return validate rules for the entity
      *