[GiftMessage] Cover Observer SalesEventOrderItemToQuoteItemObserver by Unit Test

Author: edenduong

app/code/Magento/GiftMessage/Test/Unit/Observer/SalesEventOrderItemToQuoteItemObserverTest.php

@@ -0,0 +1,196 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\GiftMessage\Test\Unit\Observer;
+
+use Magento\Framework\Event;
+use Magento\Framework\Event\Observer;
+use Magento\Framework\Message\MessageInterface;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\GiftMessage\Helper\Message as MessageHelper;
+use Magento\GiftMessage\Model\Message as MessageModel;
+use Magento\GiftMessage\Model\MessageFactory;
+use Magento\GiftMessage\Observer\SalesEventOrderItemToQuoteItemObserver;
+use Magento\Quote\Model\Quote\Item as QuoteItem;
+use Magento\Sales\Model\Order;
+use Magento\Sales\Model\Order\Item as OrderItem;
+use Magento\Store\Model\Store;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
+class SalesEventOrderItemToQuoteItemObserverTest extends TestCase
+{
+    /**
+     * Stub message id
+     */
+    private const STUB_MESSAGE_ID = 1;
+
+    /**
+     * Stub new message id
+     */
+    private const STUB_NEW_MESSAGE_ID = 2;
+
+    /**
+     * @var SalesEventOrderItemToQuoteItemObserver
+     */
+    private $observer;
+
+    /**
+     * @var MessageFactory|MockObject
+     */
+    private $messageFactoryMock;
+
+    /**
+     * @var MessageHelper|MockObject
+     */
+    private $giftMessageHelperMock;
+
+    /**
+     * @var Observer|MockObject
+     */
+    private $observerMock;
+
+    /**
+     * @var Event|MockObject
+     */
+    private $eventMock;
+
+    /**
+     * @var Order|MockObject
+     */
+    private $orderMock;
+
+    /**
+     * @var OrderItem|MockObject
+     */
+    private $orderItemMock;
+
+    /**
+     * @var Store|MockObject
+     */
+    private $storeMock;
+
+    /**
+     * @var MessageInterface|MockObject
+     */
+    private $messageMock;
+
+    /**
+     * @var QuoteItem|MockObject
+     */
+    private $quoteItemMock;
+
+    /**
+     * Prepare environment for test
+     */
+    public function setUp(): void
+    {
+        $this->messageFactoryMock = $this->createMock(MessageFactory::class);
+        $this->giftMessageHelperMock = $this->createMock(MessageHelper::class);
+        $this->observerMock = $this->createMock(Observer::class);
+        $this->eventMock = $this->createPartialMock(Event::class, ['getOrderItem', 'getQuoteItem']);
+        $this->orderItemMock = $this->createPartialMock(
+            OrderItem::class,
+            ['getOrder', 'getStoreId', 'getGiftMessageId']
+        );
+        $this->quoteItemMock = $this->createPartialMock(QuoteItem::class, ['setGiftMessageId']);
+        $this->orderMock = $this->createPartialMock(Order::class, ['getReordered']);
+        $this->storeMock = $this->createMock(Store::class);
+        $this->messageMock = $this->createMock(MessageModel::class);
+
+        $objectManager = new ObjectManager($this);
+
+        $this->observer = $objectManager->getObject(
+            SalesEventOrderItemToQuoteItemObserver::class,
+            [
+                'messageFactory' => $this->messageFactoryMock,
+                'giftMessageMessage' => $this->giftMessageHelperMock
+            ]
+        );
+    }
+
+    /**
+     * Tests duplicating gift message from order item to quote item
+     *
+     * @param bool $orderIsReordered
+     * @param bool $isMessagesAllowed
+     * @dataProvider giftMessageDataProvider
+     */
+    public function testExecute($orderIsReordered, $isMessagesAllowed)
+    {
+        $this->eventMock->expects($this->atLeastOnce())
+            ->method('getOrderItem')
+            ->willReturn($this->orderItemMock);
+
+        $this->orderItemMock->expects($this->atLeastOnce())
+            ->method('getOrder')
+            ->willReturn($this->orderMock);
+
+        $this->observerMock->expects($this->atLeastOnce())
+            ->method('getEvent')
+            ->willReturn($this->eventMock);
+
+        if (!$orderIsReordered && $isMessagesAllowed) {
+            $this->eventMock
+                ->expects($this->atLeastOnce())
+                ->method('getQuoteItem')
+                ->willReturn($this->quoteItemMock);
+            $this->orderMock->expects($this->once())
+                ->method('getReordered')
+                ->willReturn($orderIsReordered);
+            $this->orderItemMock->expects($this->once())
+                ->method('getGiftMessageId')
+                ->willReturn(self::STUB_MESSAGE_ID);
+            $this->giftMessageHelperMock->expects($this->once())
+                ->method('isMessagesAllowed')
+                ->willReturn($isMessagesAllowed);
+            $this->messageFactoryMock->expects($this->once())
+                ->method('create')
+                ->willReturn($this->messageMock);
+            $this->messageMock->expects($this->once())
+                ->method('load')
+                ->with(self::STUB_MESSAGE_ID)
+                ->willReturnSelf();
+            $this->messageMock->expects($this->once())
+                ->method('setId')
+                ->with(null)
+                ->willReturnSelf();
+            $this->messageMock->expects($this->once())
+                ->method('save')
+                ->willReturnSelf();
+            $this->messageMock->expects($this->once())
+                ->method('getId')
+                ->willReturn(self::STUB_NEW_MESSAGE_ID);
+            $this->quoteItemMock->expects($this->once())
+                ->method('setGiftMessageId')
+                ->with(self::STUB_NEW_MESSAGE_ID)
+                ->willReturnSelf();
+        }
+
+        /** Run observer */
+        $this->observer->execute($this->observerMock);
+    }
+
+    /**
+     * Providing gift message data for test
+     *
+     * @return array
+     */
+    public function giftMessageDataProvider()
+    {
+        return [
+            'order is not reordered, messages is allowed' => [false, true],
+            'order is reordered, messages is allowed' => [true, true],
+            'order is reordered, messages is not allowed' => [true, false],
+            'order is not reordered, messages is not allowed' => [false, false]
+        ];
+    }
+}