MAGETWO-99585: When backorders are allowed on an item, the qty_backordered value in sales_order_item is 0

- fixed
- modified test

Author: Oleksandr Dubovyk

app/code/Magento/CatalogInventory/Model/Quote/Item/QuantityValidator/Initializer/StockItem.php

@@ -7,8 +7,14 @@
 
 use Magento\Catalog\Model\ProductTypes\ConfigInterface;
 use Magento\CatalogInventory\Api\StockStateInterface;
+use Magento\CatalogInventory\Api\Data\StockItemInterface;
 use Magento\CatalogInventory\Model\Quote\Item\QuantityValidator\QuoteItemQtyList;
+use Magento\CatalogInventory\Model\Spi\StockStateProviderInterface;
+use Magento\Quote\Model\Quote\Item;
 
+/**
+ * Class StockItem initializes stock item and populates it with data
+ */
 class StockItem
 {
     /**
@@ -26,26 +32,34 @@ class StockItem
      */
     protected $stockState;
 
+    /**
+     * @var StockStateProviderInterface
+     */
+    private $stockStateProvider;
+
     /**
      * @param ConfigInterface $typeConfig
      * @param QuoteItemQtyList $quoteItemQtyList
      * @param StockStateInterface $stockState
+     * @param StockStateProviderInterface $stockStateProvider
      */
     public function __construct(
         ConfigInterface $typeConfig,
         QuoteItemQtyList $quoteItemQtyList,
-        StockStateInterface $stockState
+        StockStateInterface $stockState,
+        StockStateProviderInterface $stockStateProvider
     ) {
         $this->quoteItemQtyList = $quoteItemQtyList;
         $this->typeConfig = $typeConfig;
         $this->stockState = $stockState;
+        $this->stockStateProvider = $stockStateProvider;
     }
 
     /**
      * Initialize stock item
      *
-     * @param \Magento\CatalogInventory\Api\Data\StockItemInterface $stockItem
-     * @param \Magento\Quote\Model\Quote\Item $quoteItem
+     * @param StockItemInterface $stockItem
+     * @param Item $quoteItem
      * @param int $qty
      *
      * @return \Magento\Framework\DataObject
@@ -54,11 +68,14 @@ public function __construct(
      * @SuppressWarnings(PHPMD.NPathComplexity)
      */
     public function initialize(
-        \Magento\CatalogInventory\Api\Data\StockItemInterface $stockItem,
-        \Magento\Quote\Model\Quote\Item $quoteItem,
+        StockItemInterface $stockItem,
+        Item $quoteItem,
         $qty
     ) {
         $product = $quoteItem->getProduct();
+        $quoteItemId = $quoteItem->getId();
+        $quoteId = $quoteItem->getQuoteId();
+        $productId = $product->getId();
         /**
          * When we work with subitem
          */
@@ -68,14 +85,14 @@ public function initialize(
              * we are using 0 because original qty was processed
              */
             $qtyForCheck = $this->quoteItemQtyList
-                ->getQty($product->getId(), $quoteItem->getId(), $quoteItem->getQuoteId(), 0);
+                ->getQty($productId, $quoteItemId, $quoteId, 0);
         } else {
             $increaseQty = $quoteItem->getQtyToAdd() ? $quoteItem->getQtyToAdd() : $qty;
             $rowQty = $qty;
             $qtyForCheck = $this->quoteItemQtyList->getQty(
-                $product->getId(),
-                $quoteItem->getId(),
-                $quoteItem->getQuoteId(),
+                $productId,
+                $quoteItemId,
+                $quoteId,
                 $increaseQty
             );
         }
@@ -90,14 +107,20 @@ public function initialize(
 
         $stockItem->setProductName($product->getName());
 
+        /** @var \Magento\Framework\DataObject $result */
         $result = $this->stockState->checkQuoteItemQty(
-            $product->getId(),
+            $productId,
             $rowQty,
             $qtyForCheck,
             $qty,
             $product->getStore()->getWebsiteId()
         );
 
+        /* We need to ensure that any possible plugin will not erase the data */
+        $backOrdersQty = $this->stockStateProvider->checkQuoteItemQty($stockItem, $rowQty, $qtyForCheck, $qty)
+            ->getItemBackorders();
+        $result->setItemBackorders($backOrdersQty);
+
         if ($stockItem->hasIsChildItem()) {
             $stockItem->unsIsChildItem();
         }

app/code/Magento/CatalogInventory/Test/Unit/Model/Quote/Item/QuantityValidator/Initializer/StockItemTest.php

@@ -8,6 +8,7 @@
 use Magento\CatalogInventory\Model\Quote\Item\QuantityValidator\QuoteItemQtyList;
 
 /**
+ * Class StockItemTest
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class StockItemTest extends \PHPUnit\Framework\TestCase
@@ -28,10 +29,18 @@ class StockItemTest extends \PHPUnit\Framework\TestCase
     protected $typeConfig;
 
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\CatalogInventory\Api\StockStateInterface\PHPUnit_Framework_MockObject_MockObject
      */
     protected $stockStateMock;
 
+    /**
+     * @var \Magento\CatalogInventory\Model\StockStateProviderInterface| \PHPUnit_Framework_MockObject_MockObject
+     */
+    private $stockStateProviderMock;
+
+    /**
+     * @inheritdoc
+     */
     protected function setUp()
     {
         $this->quoteItemQtyList = $this
@@ -48,17 +57,25 @@ protected function setUp()
         $this->stockStateMock = $this->getMockBuilder(\Magento\CatalogInventory\Api\StockStateInterface::class)
             ->disableOriginalConstructor()
             ->getMock();
+
+        $this->stockStateProviderMock = $this
+            ->getMockBuilder(\Magento\CatalogInventory\Model\StockStateProvider::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
         $this->model = $objectManagerHelper->getObject(
             \Magento\CatalogInventory\Model\Quote\Item\QuantityValidator\Initializer\StockItem::class,
             [
                 'quoteItemQtyList' => $this->quoteItemQtyList,
                 'typeConfig' => $this->typeConfig,
-                'stockState' => $this->stockStateMock
+                'stockState' => $this->stockStateMock,
+                'stockStateProvider' => $this->stockStateProviderMock
             ]
         );
     }
 
     /**
+     * Test initialize with Subitem
      * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
      */
     public function testInitializeWithSubitem()
@@ -141,6 +158,10 @@ public function testInitializeWithSubitem()
             ->method('checkQuoteItemQty')
             ->withAnyParameters()
             ->will($this->returnValue($result));
+        $this->stockStateProviderMock->expects($this->once())
+            ->method('checkQuoteItemQty')
+            ->withAnyParameters()
+            ->will($this->returnValue($result));
         $product->expects($this->once())
             ->method('getCustomOption')
             ->with('product_type')
@@ -177,13 +198,16 @@ public function testInitializeWithSubitem()
         $quoteItem->expects($this->once())->method('setUseOldQty')->with('item')->will($this->returnSelf());
         $result->expects($this->exactly(2))->method('getMessage')->will($this->returnValue('message'));
         $quoteItem->expects($this->once())->method('setMessage')->with('message')->will($this->returnSelf());
-        $result->expects($this->exactly(2))->method('getItemBackorders')->will($this->returnValue('backorders'));
+        $result->expects($this->exactly(3))->method('getItemBackorders')->will($this->returnValue('backorders'));
         $quoteItem->expects($this->once())->method('setBackorders')->with('backorders')->will($this->returnSelf());
         $quoteItem->expects($this->once())->method('setStockStateResult')->with($result)->will($this->returnSelf());
 
         $this->model->initialize($stockItem, $quoteItem, $qty);
     }
 
+    /**
+     * Test initialize without Subitem
+     */
     public function testInitializeWithoutSubitem()
     {
         $qty = 3;
@@ -234,6 +258,10 @@ public function testInitializeWithoutSubitem()
             ->with($productId, 'quote_item_id', 'quote_id', $qty)
             ->will($this->returnValue('summary_qty'));
         $this->stockStateMock->expects($this->once())
+                ->method('checkQuoteItemQty')
+                ->withAnyParameters()
+                ->will($this->returnValue($result));
+        $this->stockStateProviderMock->expects($this->once())
             ->method('checkQuoteItemQty')
             ->withAnyParameters()
             ->will($this->returnValue($result));
@@ -256,7 +284,7 @@ public function testInitializeWithoutSubitem()
         $result->expects($this->once())->method('getHasQtyOptionUpdate')->will($this->returnValue(false));
         $result->expects($this->once())->method('getItemUseOldQty')->will($this->returnValue(null));
         $result->expects($this->once())->method('getMessage')->will($this->returnValue(null));
-        $result->expects($this->once())->method('getItemBackorders')->will($this->returnValue(null));
+        $result->expects($this->exactly(2))->method('getItemBackorders')->will($this->returnValue(null));
 
         $this->model->initialize($stockItem, $quoteItem, $qty);
     }