StockItemDataChecker.php

Go to the documentation of this file.

<?php
namespace Magento\CatalogInventory\Model\StockItemSave;

use Magento\Catalog\Api\Data\ProductInterfaceFactory;
use Magento\Catalog\Api\ProductRepositoryInterface;
use Magento\Catalog\Model\Product;
use Magento\CatalogInventory\Api\Data\StockItemInterface;
use Magento\CatalogInventory\Api\StockItemCriteriaInterfaceFactory;
use Magento\CatalogInventory\Api\StockItemRepositoryInterface;
use Magento\Framework\Api\SearchCriteriaBuilder;
use Magento\Framework\EntityManager\HydratorInterface;
use PHPUnit\Framework\Assert;

class StockItemDataChecker
{
    private $hydrator;

    private $stockItemRepository;

    private $stockItemCriteriaFactory;

    private $productRepository;

    private $productFactory;

    private $searchCriteriaBuilder;

    public function __construct(
        HydratorInterface $hydrator,
        StockItemRepositoryInterface $stockItemRepository,
        StockItemCriteriaInterfaceFactory $stockItemCriteriaFactory,
        ProductRepositoryInterface $productRepository,
        ProductInterfaceFactory $productFactory,
        SearchCriteriaBuilder $searchCriteriaBuilder
    ) {
        $this->hydrator = $hydrator;
        $this->stockItemRepository = $stockItemRepository;
        $this->stockItemCriteriaFactory = $stockItemCriteriaFactory;
        $this->productRepository = $productRepository;
        $this->productFactory = $productFactory;
        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
    }

    public function checkStockItemData($sku, array $expectedData)
    {
        $product = $this->productRepository->get($sku, false, null, true);
        $this->doCheckStockItemData($product, $expectedData);

        $productLoadedByModel = $this->productFactory->create();
        $productLoadedByModel->load($product->getId());
        $this->doCheckStockItemData($product, $expectedData);
    }

    private function doCheckStockItemData(Product $product, array $expectedData)
    {
        $stockItem = $product->getExtensionAttributes()->getStockItem();
        $stockItem = $this->stockItemRepository->get($stockItem->getItemId());

        $this->assertArrayContains($expectedData, $this->hydrator->extract($stockItem));

        $criteria = $this->stockItemCriteriaFactory->create();
        $result = $this->stockItemRepository->getList($criteria);
        $items = $result->getItems();
        $stockItem = current($items);
        $this->assertArrayContains($expectedData, $this->hydrator->extract($stockItem));

        $expectedQuantityAndStockStatusData = array_intersect_key($expectedData, [
            StockItemInterface::IS_IN_STOCK => 0,
            StockItemInterface::QTY => 0,
        ]);
        Assert::assertNotNull($product->getQuantityAndStockStatus());
        $this->assertArrayContains($expectedQuantityAndStockStatusData, $product->getQuantityAndStockStatus());

        Assert::assertNotNull($product->getData('quantity_and_stock_status'));
        $this->assertArrayContains($expectedQuantityAndStockStatusData, $product->getData('quantity_and_stock_status'));
    }

    private function assertArrayContains(array $expected, array $actual)
    {
        foreach ($expected as $key => $value) {
            Assert::assertArrayHasKey(
                $key,
                $actual,
                "Expected value for key '{$key}' is missed"
            );
            if (is_array($value)) {
                $this->assertArrayContains($value, $actual[$key]);
            } else {
                Assert::assertEquals(
                    $value,
                    $actual[$key],
                    "Expected value for key '{$key}' doesn't match"
                );
            }
        }
    }
}