magento2-docker/dev/tests/integration/testsuite/Magento/Sales/Block/Order/ItemsTest.php

<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\Sales\Block\Order;

use Magento\Framework\ObjectManagerInterface;
use Magento\Framework\Registry;
use Magento\Framework\View\LayoutInterface;
use Magento\Framework\View\Result\PageFactory;
use Magento\Sales\Api\Data\OrderInterface;
use Magento\Sales\Api\Data\OrderInterfaceFactory;
use Magento\Sales\Model\ResourceModel\Order\Item\Collection;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\Helper\Xpath;
use Magento\Theme\Block\Html\Pager;
use PHPUnit\Framework\TestCase;

/**
 * Tests order items block.
 *
 * @magentoAppArea frontend
 * @magentoDbIsolation enabled
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class ItemsTest extends TestCase
{
    /** @var Items */
    private $block;

    /** @var LayoutInterface */
    private $layout;

    /** @var ObjectManagerInterface */
    private $objectManager;

    /** @var Registry */
    private $registry;

    /** @var OrderInterfaceFactory */
    private $orderFactory;

    /** @var PageFactory */
    private $pageFactory;

    /**
     * @inheritdoc
     */
    protected function setUp(): void
    {
        $this->objectManager = Bootstrap::getObjectManager();
        $this->layout = $this->objectManager->get(LayoutInterface::class);
        $this->registry = $this->objectManager->get(Registry::class);
        $this->orderFactory = $this->objectManager->get(OrderInterfaceFactory::class);
        $this->pageFactory = $this->objectManager->get(PageFactory::class);
    }

    /**
     * @inheritdoc
     */
    protected function tearDown(): void
    {
        $this->registry->unregister('current_order');

        parent::tearDown();
    }

    /**
     * @magentoDataFixture Magento/Sales/_files/order.php
     *
     * @return void
     */
    public function testGetOrderItems(): void
    {
        $order = $this->orderFactory->create()->loadByIncrementId('100000001');
        $this->registerOrder($order);
        $this->block = $this->layout->createBlock(Items::class);
        $this->assertCount(1, $this->block->getItems());
    }

    /**
     * @magentoDataFixture Magento/Sales/_files/order_configurable_product.php
     *
     * @return void
     */
    public function testGetPagerCountConfigurable(): void
    {
        $order = $this->orderFactory->create()->loadByIncrementId('100000001');
        $this->registerOrder($order);
        $this->prepareBlockWithPager();

        /** @var Pager $pagerBlock */
        $pagerBlock = $this->block->getChildBlock('sales_order_item_pager');
        $this->assertCount(1, $pagerBlock->getCollection()->getItems());
    }

    /**
     * @magentoConfigFixture default/sales/orders/items_per_page 3
     * @magentoDataFixture Magento/Sales/_files/order_item_list.php
     *
     * @return void
     */
    public function testPagerIsDisplayed(): void
    {
        $order = $this->orderFactory->create()->loadByIncrementId('100000001');
        $this->registerOrder($order);
        $this->prepareBlockWithPager();
        $this->assertTrue($this->block->isPagerDisplayed());
    }

    /**
     * @magentoDataFixture Magento/Sales/_files/order_item_list.php
     *
     * @return void
     */
    public function testPagerIsNotDisplayed(): void
    {
        $order = $this->orderFactory->create()->loadByIncrementId('100000001');
        $this->registerOrder($order);
        $this->prepareBlockWithPager();
        $this->assertFalse($this->block->isPagerDisplayed());
        $this->assertEmpty(preg_replace('/\s+/', '', strip_tags($this->block->getPagerHtml())));
    }

    /**
     * @magentoConfigFixture default/sales/orders/items_per_page 3
     * @magentoDataFixture Magento/Sales/_files/order_item_list.php
     *
     * @return void
     */
    public function testGetPagerHtml(): void
    {
        $order = $this->orderFactory->create()->loadByIncrementId('100000001');
        $this->registerOrder($order);
        $this->prepareBlockWithPager();
        $this->assertNotEmpty(preg_replace('/\s+/', '', strip_tags($this->block->getPagerHtml())));
        $this->assertTrue($this->block->isPagerDisplayed());
    }

    /**
     * @magentoDataFixture Magento/Sales/_files/order.php
     *
     * @return void
     */
    public function testGetOrder(): void
    {
        $order = $this->orderFactory->create()->loadByIncrementId('100000001');
        $this->registerOrder($order);
        $this->block = $this->layout->createBlock(Items::class, 'items_block');
        $this->assertEquals($order, $this->block->getOrder());
    }

    /**
     * @magentoDataFixture Magento/Sales/_files/customer_order_with_two_items.php
     *
     * @return void
     */
    public function testDisplayingOrderItems(): void
    {
        $order = $this->orderFactory->create()->loadByIncrementId('100000555');
        $this->registerOrder($order);
        $blockHtml = $this->renderOrderItemsBlock();
        $this->assertOrderItems($order->getItemsCollection(), $blockHtml);
    }

    /**
     * Render order items block.
     *
     * @return string
     */
    private function renderOrderItemsBlock(): string
    {
        $page = $this->pageFactory->create();
        $page->addHandle([
            'default',
            'sales_order_view',
        ]);
        $page->getLayout()->generateXml();
        $orderItemsBlock = $page->getLayout()->getBlock('order_items')->unsetChild('order_totals');

        return $orderItemsBlock->toHtml();
    }

    /**
     * Assert order items list.
     *
     * @param Collection $orderItems
     * @param string $blockHtml
     * @return void
     */
    private function assertOrderItems(Collection $orderItems, string $blockHtml): void
    {
        $this->assertNotCount(0, $orderItems, 'Order items collection is empty');
        $fieldsToCheck = [
            'name' => "/td[contains(@class, 'name')]/strong[contains(text(), '%s')]",
            'sku' => "/td[contains(@class, 'sku') and contains(text(), '%s')]",
            'price' => "/td[contains(@class, 'price')]//span[contains(text(), '%01.2f')]",
            'qty_ordered' => "/td[contains(@class, 'qty')]//span[contains(text(), '" . __('Ordered')
                . "')]/following-sibling::span[contains(text(), '%d')]",
            'row_total' => "/td[contains(@class, 'subtotal')]//span[contains(text(), '%01.2f')]",
        ];
        foreach ($orderItems as $item) {
            $itemRowXpath = sprintf("//tr[@id='order-item-row-%s']", $item->getItemId());
            foreach ($fieldsToCheck as $key => $xpath) {
                $this->assertEquals(
                    1,
                    Xpath::getElementsCountForXpath(sprintf($itemRowXpath . $xpath, $item->getData($key)), $blockHtml),
                    sprintf('Item %s wasn\'t found or not equals to %s.', $key, $item->getData($key))
                );
            }
        }
    }

    /**
     * Register order in registry.
     *
     * @param OrderInterface $order
     * @return void
     */
    private function registerOrder(OrderInterface $order): void
    {
        $this->registry->unregister('current_order');
        $this->registry->register('current_order', $order);
    }

    /**
     * Create items block with pager
     */
    private function prepareBlockWithPager(): void
    {
        $this->block = $this->layout->createBlock(Items::class, 'items_block');
        $this->layout->addBlock(
            $this->objectManager->get(Pager::class),
            'sales_order_item_pager',
            'items_block'
        );
        $this->block->setLayout($this->layout);
    }
}