dev/tests/api-functional/testsuite/Magento/GraphQl/GiftMessage/OrderItemWithGiftMessageTest.php - 2.4-develop - githubmirror/magento2

dev/tests/api-functional/testsuite/Magento/GraphQl/GiftMessage/OrderItemWithGiftMessageTest.php
282 строки9 KB
Deepak Soni
LYNX-692: Gift Options - Fixed issue with customer.orders query
04 мар 2025, 17:06
04 мар 2025, 17:06b4572ec
<?php
/**
 * Copyright 2025 Adobe
 * All Rights Reserved.
 */
declare(strict_types=1);

namespace Magento\GraphQl\GiftMessage;

use Exception;
use Magento\Catalog\Test\Fixture\Product as ProductFixture;
use Magento\Checkout\Test\Fixture\SetBillingAddress as SetBillingAddressFixture;
use Magento\Checkout\Test\Fixture\SetDeliveryMethod as SetDeliveryMethodFixture;
use Magento\Checkout\Test\Fixture\SetGuestEmail as SetGuestEmailFixture;
use Magento\Checkout\Test\Fixture\SetPaymentMethod as SetPaymentMethodFixture;
use Magento\Checkout\Test\Fixture\SetShippingAddress as SetShippingAddressFixture;
use Magento\Framework\App\ResourceConnection;
use Magento\GiftMessage\Api\Data\MessageInterface;
use Magento\GiftMessage\Test\Fixture\GiftMessage;
use Magento\Quote\Test\Fixture\AddProductToCart as AddProductToCartFixture;
use Magento\Quote\Test\Fixture\GuestCart;
use Magento\Quote\Test\Fixture\QuoteIdMask;
use Magento\TestFramework\Fixture\Config;
use Magento\TestFramework\Fixture\DataFixture;
use Magento\TestFramework\Fixture\DataFixtureStorage;
use Magento\TestFramework\Fixture\DataFixtureStorageManager;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\TestCase\GraphQlAbstract;

class OrderItemWithGiftMessageTest extends GraphQlAbstract
{
    /**
     * @var DataFixtureStorage
     */
    private $fixtures;

    /**
     * @var ResourceConnection
     */
    private $resourceConnection;

    /**
     * @inheritdoc
     */
    protected function setUp(): void
    {
        $this->fixtures = Bootstrap::getObjectManager()->get(DataFixtureStorageManager::class)->getStorage();
        $this->resourceConnection = Bootstrap::getObjectManager()->get(ResourceConnection::class);
    }

    /**
     * @throws Exception
     */
    #[
        DataFixture(GiftMessage::class, as: 'message'),
        DataFixture(ProductFixture::class, as: 'product'),
        DataFixture(GuestCart::class, ['message_id' => '$message.id$'], as: 'cart'),
        DataFixture(QuoteIdMask::class, ['cart_id' => '$cart.id$'], 'quoteIdMask'),
        DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart.id$', 'product_id' => '$product.id$']),
        DataFixture(SetGuestEmailFixture::class, ['cart_id' => '$cart.id$'], as: 'email'),
        DataFixture(SetBillingAddressFixture::class, ['cart_id' => '$cart.id$']),
        DataFixture(SetShippingAddressFixture::class, ['cart_id' => '$cart.id$']),
        DataFixture(SetDeliveryMethodFixture::class, ['cart_id' => '$cart.id$']),
        DataFixture(SetPaymentMethodFixture::class, ['cart_id' => '$cart.id$']),
        Config('sales/gift_options/allow_order', 1),
        Config('sales/gift_options/allow_items', 1),
    ]
    public function testGuestOrderWithGiftMessage(): void
    {
        $maskedQuoteId = $this->fixtures->get('quoteIdMask')->getMaskedId();
        /** @var MessageInterface $message */
        $message = $this->fixtures->get('message');

        $this->graphQlMutation(
            $this->updateGiftMessageMutation(
                [
                    'message_from' => $message->getSender(),
                    'message_to' => $message->getRecipient(),
                    'message' => $message->getMessage(),
                ],
                $maskedQuoteId,
                $this->getItemId(
                    (int)$this->fixtures->get('cart')->getId(),
                    (int)$this->fixtures->get('product')->getId()
                )
            )
        );

        $orderResponse = $this->graphQlMutation($this->getPlaceOrderMutation($maskedQuoteId));

        self::assertEquals(
            [
                'guestOrderByToken' => [
                    'items' => [
                        [
                            'gift_message' => [
                                'from' => $message->getSender(),
                                'to' => $message->getRecipient(),
                                'message' => $message->getMessage()
                            ]
                        ]
                    ]
                ]
            ],
            $this->graphQlQuery($this->getGuestOrderByTokenQuery($orderResponse['placeOrder']['orderV2']['token']))
        );

        //Revert order as it is created through mutations and not fixtures
        $this->revertOrder($orderResponse['placeOrder']['orderV2']['number']);
    }

    /**
     * @throws Exception
     */
    #[
        DataFixture(ProductFixture::class, as: 'product'),
        DataFixture(GuestCart::class, as: 'cart'),
        DataFixture(QuoteIdMask::class, ['cart_id' => '$cart.id$'], 'quoteIdMask'),
        DataFixture(AddProductToCartFixture::class, ['cart_id' => '$cart.id$', 'product_id' => '$product.id$']),
        DataFixture(SetGuestEmailFixture::class, ['cart_id' => '$cart.id$'], 'email'),
        DataFixture(SetBillingAddressFixture::class, ['cart_id' => '$cart.id$']),
        DataFixture(SetShippingAddressFixture::class, ['cart_id' => '$cart.id$']),
        DataFixture(SetDeliveryMethodFixture::class, ['cart_id' => '$cart.id$']),
        DataFixture(SetPaymentMethodFixture::class, ['cart_id' => '$cart.id$']),
        Config('sales/gift_options/allow_order', 1),
        Config('sales/gift_options/allow_items', 1),
    ]
    public function testGuestOrderWithoutGiftMessage(): void
    {
        $orderResponse = $this->graphQlMutation(
            $this->getPlaceOrderMutation($this->fixtures->get('quoteIdMask')->getMaskedId())
        );

        self::assertEquals(
            [
                'guestOrderByToken' => [
                    'items' => [
                        [
                            'gift_message' => null
                        ]
                    ]
                ]
            ],
            $this->graphQlQuery(
                $this->getGuestOrderByTokenQuery(
                    $orderResponse['placeOrder']['orderV2']['token']
                )
            )
        );

        //Revert order as it is created through mutations and not fixtures
        $this->revertOrder($orderResponse['placeOrder']['orderV2']['number']);
    }

    /**
     * Get item id from quote_id and product_id
     *
     * @param int $cartId
     * @param int $productId
     * @return int
     */
    private function getItemId(int $cartId, int $productId): int
    {
        $connection = $this->resourceConnection->getConnection();

        return (int)$connection->fetchOne(
            $connection->select()
                ->from($this->resourceConnection->getTableName('quote_item'))
                ->reset('columns')
                ->columns('item_id')
                ->where('quote_id = ?', $cartId)
                ->where('product_id = ?', $productId)
        );
    }

    /**
     * Get update gift message mutation
     *
     * @param array $giftData
     * @param string $maskedQuoteId
     * @param int $itemId
     * @return string
     */
    private function updateGiftMessageMutation(array $giftData, string $maskedQuoteId, int $itemId): string
    {
        return <<<MUTATION
            mutation {
              updateCartItems(
                input: {
                  cart_id: "$maskedQuoteId",
                  cart_items: [
                    {
                     cart_item_id: $itemId
                      quantity: 2
                     gift_message: {
                        from: "{$giftData['message_from']}"
                        to: "{$giftData['message_to']}"
                        message: "{$giftData['message']}"
                      }
                    }
                  ]
                }
              ) {
                cart {
                  items {
                    id
                      ... on SimpleCartItem {
                      gift_message {
                        from
                        to
                        message
                      }
                    }
                 }
                }
              }
            }
        MUTATION;
    }

    /**
     * Get guest order by token query
     *
     * @param string $token
     * @return string
     */
    private function getGuestOrderByTokenQuery(string $token): string
    {
        return <<<QUERY
            query GuestOrderByToken {
                guestOrderByToken(input: { token: "{$token}" }) {
                    items {
                        gift_message {
                            from
                            to
                            message
                        }
                    }
                }
            }
        QUERY;
    }

    /**
     * Get place order mutation with orderV2 data
     *
     * @param string $maskedQuoteId
     * @return string
     */
    private function getPlaceOrderMutation(string $maskedQuoteId): string
    {
        return <<<MUTATION
            mutation {
              placeOrder(input: {cart_id: "{$maskedQuoteId}"}) {
                orderV2 {
                    token
                    number
                }
              }
            }
        MUTATION;
    }

    /**
     * Delete Orders from sales_order and sales_order_grid table
     *
     * @param string $orderNumber
     * @return void
     */
    private function revertOrder(string $orderNumber): void
    {
        $connection = $this->resourceConnection->getConnection();
        $connection->delete(
            $this->resourceConnection->getTableName('sales_order'),
            ['increment_id = ?' => $orderNumber]
        );
        $connection->delete(
            $this->resourceConnection->getTableName('sales_order_grid'),
            ['increment_id = ?' => $orderNumber]
        );
    }
}