ENGCOM-4764: magento/graphql-ce#540: Replace deprecated fixture #541

 - Merge Pull Request magento/graphql-ce#541 from magento/graphql-ce:540-new-fixture-for-SetUpsShippingMethodsOnCartTest
 - Merged commits:
   1. 37b4855
   2. 8d107c5
   3. 5dd5e3a
   4. ba6c523
   5. 844fc58
   6. 3d891d3
   7. 38b106f
   8. b946dd0
   9. 17ca1ef
   10. 78f02fa
   11. b027198
   12. 8f0c233
   13. 9d475b8
   14. c9cf1a9
   15. 259ee45

dev/tests/api-functional/testsuite/Magento/GraphQl/Ups/SetUpsShippingMethodsOnCartTest.php

@@ -7,86 +7,194 @@
 
 namespace Magento\GraphQl\Ups;
 
+use Magento\GraphQl\Quote\GetMaskedQuoteIdByReservedOrderId;
+use Magento\GraphQl\Quote\GetQuoteShippingAddressIdByReservedQuoteId;
 use Magento\Integration\Api\CustomerTokenServiceInterface;
-use Magento\Quote\Model\QuoteFactory;
-use Magento\Quote\Model\QuoteIdToMaskedQuoteIdInterface;
-use Magento\Quote\Model\ResourceModel\Quote as QuoteResource;
 use Magento\TestFramework\Helper\Bootstrap;
 use Magento\TestFramework\TestCase\GraphQlAbstract;
 
 /**
- * Test for setting "UPS" shipping method on cart
+ * Test for setting "UPS" shipping method on cart. Current class covers the next UPS shipping methods:
+ *
+ * | Code      | Label
+ * --------------------------------------
+ * | 1DM       | Next Day Air Early AM
+ * | 1DA       | Next Day Air
+ * | 2DA       | 2nd Day Air
+ * | 3DS       | 3 Day Select
+ * | GND       | Ground
+ * | STD       | Canada Standard
+ * | XPR       | Worldwide Express
+ * | WXS       | Worldwide Express Saver
+ * | XDM       | Worldwide Express Plus
+ * | XPD       | Worldwide Expedited
+ *
+ * Current class does not cover these UPS shipping methods (depends on address and sandbox settings)
+ *
+ * | Code      | Label
+ * --------------------------------------
+ * | 1DML      | Next Day Air Early AM Letter
+ * | 1DAL      | Next Day Air Letter
+ * | 1DAPI     | Next Day Air Intra (Puerto Rico)
+ * | 1DP       | Next Day Air Saver
+ * | 1DPL      | Next Day Air Saver Letter
+ * | 2DM       | 2nd Day Air AM
+ * | 2DML      | 2nd Day Air AM Letter
+ * | 2DAL      | 2nd Day Air Letter
+ * | GNDCOM    | Ground Commercial
+ * | GNDRES    | Ground Residential
+ * | XPRL      | Worldwide Express Letter
+ * | XDML      | Worldwide Express Plus Letter
  */
 class SetUpsShippingMethodsOnCartTest extends GraphQlAbstract
 {
     /**
-     * Defines carrier code for "UPS" shipping method
-     */
-    const CARRIER_CODE = 'ups';
-
-    /**
-     * Defines method code for the "Ground" UPS shipping
+     * Defines carrier label for "UPS" shipping method
      */
-    const CARRIER_METHOD_CODE_GROUND = 'GND';
+    const CARRIER_LABEL = 'United Parcel Service';
 
     /**
-     * @var QuoteFactory
+     * Defines carrier code for "UPS" shipping method
      */
-    private $quoteFactory;
+    const CARRIER_CODE = 'ups';
 
     /**
      * @var CustomerTokenServiceInterface
      */
     private $customerTokenService;
 
     /**
-     * @var QuoteResource
+     * @var GetMaskedQuoteIdByReservedOrderId
      */
-    private $quoteResource;
+    private $getMaskedQuoteIdByReservedOrderId;
 
     /**
-     * @var QuoteIdToMaskedQuoteIdInterface
+     * @var GetQuoteShippingAddressIdByReservedQuoteId
      */
-    private $quoteIdToMaskedId;
+    private $getQuoteShippingAddressIdByReservedQuoteId;
 
     /**
      * @inheritdoc
      */
     protected function setUp()
     {
         $objectManager = Bootstrap::getObjectManager();
-        $this->quoteResource = $objectManager->get(QuoteResource::class);
-        $this->quoteFactory = $objectManager->get(QuoteFactory::class);
-        $this->quoteIdToMaskedId = $objectManager->get(QuoteIdToMaskedQuoteIdInterface::class);
         $this->customerTokenService = $objectManager->get(CustomerTokenServiceInterface::class);
+        $this->getMaskedQuoteIdByReservedOrderId = $objectManager->get(GetMaskedQuoteIdByReservedOrderId::class);
+        $this->getQuoteShippingAddressIdByReservedQuoteId = $objectManager->get(
+            GetQuoteShippingAddressIdByReservedQuoteId::class
+        );
     }
 
     /**
-     * @magentoApiDataFixture Magento/Checkout/_files/quote_with_address_saved.php
-     * @magentoApiDataFixture Magento/Ups/_files/enable_ups_shipping_method.php
+     * @magentoApiDataFixture Magento/Customer/_files/customer.php
+     * @magentoApiDataFixture Magento/GraphQl/Catalog/_files/simple_product.php
+     * @magentoApiDataFixture Magento/GraphQl/Quote/_files/customer/create_empty_cart.php
+     * @magentoApiDataFixture Magento/GraphQl/Quote/_files/add_simple_product.php
+     * @magentoApiDataFixture Magento/GraphQl/Quote/_files/set_new_shipping_address.php
+     * @magentoApiDataFixture Magento/GraphQl/Ups/_files/enable_ups_shipping_method.php
+     *
+     * @dataProvider dataProviderShippingMethods
+     * @param string $methodCode
+     * @param string $methodLabel
      */
-    public function testSetUpsShippingMethod()
+    public function testSetUpsShippingMethod(string $methodCode, string $methodLabel)
     {
-        $quote = $this->quoteFactory->create();
-        $this->quoteResource->load($quote, 'test_order_1', 'reserved_order_id');
-        $maskedQuoteId = $this->quoteIdToMaskedId->execute((int)$quote->getId());
-        $shippingAddressId = (int)$quote->getShippingAddress()->getId();
-
-        $query = $this->getAddUpsShippingMethodQuery(
-            $maskedQuoteId,
-            $shippingAddressId,
-            self::CARRIER_CODE,
-            self::CARRIER_METHOD_CODE_GROUND
+        $quoteReservedId = 'test_quote';
+        $maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute($quoteReservedId);
+        $shippingAddressId = $this->getQuoteShippingAddressIdByReservedQuoteId->execute($quoteReservedId);
+
+        $query = $this->getQuery($maskedQuoteId, $shippingAddressId, self::CARRIER_CODE, $methodCode);
+        $response = $this->sendRequestWithToken($query);
+
+        self::assertArrayHasKey('setShippingMethodsOnCart', $response);
+        self::assertArrayHasKey('cart', $response['setShippingMethodsOnCart']);
+        self::assertArrayHasKey('shipping_addresses', $response['setShippingMethodsOnCart']['cart']);
+        self::assertCount(1, $response['setShippingMethodsOnCart']['cart']['shipping_addresses']);
+
+        $shippingAddress = current($response['setShippingMethodsOnCart']['cart']['shipping_addresses']);
+        self::assertArrayHasKey('selected_shipping_method', $shippingAddress);
+
+        self::assertArrayHasKey('carrier_code', $shippingAddress['selected_shipping_method']);
+        self::assertEquals(self::CARRIER_CODE, $shippingAddress['selected_shipping_method']['carrier_code']);
+
+        self::assertArrayHasKey('method_code', $shippingAddress['selected_shipping_method']);
+        self::assertEquals($methodCode, $shippingAddress['selected_shipping_method']['method_code']);
+
+        self::assertArrayHasKey('label', $shippingAddress['selected_shipping_method']);
+        self::assertEquals(
+            self::CARRIER_LABEL . ' - ' . $methodLabel,
+            $shippingAddress['selected_shipping_method']['label']
         );
+    }
 
+    /**
+     * @return array
+     */
+    public function dataProviderShippingMethods(): array
+    {
+        return [
+            'Next Day Air Early AM' => ['1DM', 'Next Day Air Early AM'],
+            'Next Day Air' => ['1DA', 'Next Day Air'],
+            '2nd Day Air' => ['2DA', '2nd Day Air'],
+            '3 Day Select' => ['3DS', '3 Day Select'],
+            'Ground' => ['GND', 'Ground'],
+        ];
+    }
+
+    /**
+     * @magentoApiDataFixture Magento/Customer/_files/customer.php
+     * @magentoApiDataFixture Magento/GraphQl/Catalog/_files/simple_product.php
+     * @magentoApiDataFixture Magento/GraphQl/Quote/_files/customer/create_empty_cart.php
+     * @magentoApiDataFixture Magento/GraphQl/Quote/_files/add_simple_product.php
+     * @magentoApiDataFixture Magento/GraphQl/Quote/_files/set_new_shipping_canada_address.php
+     * @magentoApiDataFixture Magento/GraphQl/Ups/_files/enable_ups_shipping_method.php
+     *
+     * @dataProvider dataProviderShippingMethodsBasedOnCanadaAddress
+     * @param string $methodCode
+     * @param string $methodLabel
+     */
+    public function testSetUpsShippingMethodBasedOnCanadaAddress(string $methodCode, string $methodLabel)
+    {
+        $quoteReservedId = 'test_quote';
+        $maskedQuoteId = $this->getMaskedQuoteIdByReservedOrderId->execute($quoteReservedId);
+        $shippingAddressId = $this->getQuoteShippingAddressIdByReservedQuoteId->execute($quoteReservedId);
+
+        $query = $this->getQuery($maskedQuoteId, $shippingAddressId, self::CARRIER_CODE, $methodCode);
         $response = $this->sendRequestWithToken($query);
-        $addressesInformation = $response['setShippingMethodsOnCart']['cart']['shipping_addresses'];
-        $expectedResult = [
-            'carrier_code' => self::CARRIER_CODE,
-            'method_code' => self::CARRIER_METHOD_CODE_GROUND,
-            'label' => 'United Parcel Service - Ground',
+
+        self::assertArrayHasKey('setShippingMethodsOnCart', $response);
+        self::assertArrayHasKey('cart', $response['setShippingMethodsOnCart']);
+        self::assertArrayHasKey('shipping_addresses', $response['setShippingMethodsOnCart']['cart']);
+        self::assertCount(1, $response['setShippingMethodsOnCart']['cart']['shipping_addresses']);
+
+        $shippingAddress = current($response['setShippingMethodsOnCart']['cart']['shipping_addresses']);
+        self::assertArrayHasKey('selected_shipping_method', $shippingAddress);
+
+        self::assertArrayHasKey('carrier_code', $shippingAddress['selected_shipping_method']);
+        self::assertEquals(self::CARRIER_CODE, $shippingAddress['selected_shipping_method']['carrier_code']);
+
+        self::assertArrayHasKey('method_code', $shippingAddress['selected_shipping_method']);
+        self::assertEquals($methodCode, $shippingAddress['selected_shipping_method']['method_code']);
+
+        self::assertArrayHasKey('label', $shippingAddress['selected_shipping_method']);
+        self::assertEquals(
+            self::CARRIER_LABEL . ' - ' . $methodLabel,
+            $shippingAddress['selected_shipping_method']['label']
+        );
+    }
+
+    /**
+     * @return array
+     */
+    public function dataProviderShippingMethodsBasedOnCanadaAddress(): array
+    {
+        return [
+            'Canada Standard' => ['STD', 'Canada Standard'],
+            'Worldwide Express' => ['XPR', 'Worldwide Express'],
+            'Worldwide Express Saver' => ['WXS', 'Worldwide Express Saver'],
+            'Worldwide Express Plus' => ['XDM', 'Worldwide Express Plus'],
         ];
-        self::assertEquals($addressesInformation[0]['selected_shipping_method'], $expectedResult);
     }
 
     /**
@@ -98,7 +206,7 @@ public function testSetUpsShippingMethod()
      * @param string $methodCode
      * @return string
      */
-    private function getAddUpsShippingMethodQuery(
+    private function getQuery(
         string $maskedQuoteId,
         int $shippingAddressId,
         string $carrierCode,

dev/tests/integration/testsuite/Magento/GraphQl/Quote/_files/set_new_shipping_address.php

@@ -26,7 +26,7 @@
 
 $quoteAddressData = [
     AddressInterface::KEY_TELEPHONE => 3468676,
-    AddressInterface::KEY_POSTCODE => 75477,
+    AddressInterface::KEY_POSTCODE => '75477',
     AddressInterface::KEY_COUNTRY_ID => 'US',
     AddressInterface::KEY_CITY => 'CityM',
     AddressInterface::KEY_COMPANY => 'CompanyName',

dev/tests/integration/testsuite/Magento/GraphQl/Quote/_files/set_new_shipping_canada_address.php

@@ -0,0 +1,43 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+use Magento\Framework\Api\DataObjectHelper;
+use Magento\Quote\Api\Data\AddressInterface;
+use Magento\Quote\Api\Data\AddressInterfaceFactory;
+use Magento\Quote\Model\QuoteFactory;
+use Magento\Quote\Model\ResourceModel\Quote as QuoteResource;
+use Magento\Quote\Model\ShippingAddressManagementInterface;
+use Magento\TestFramework\Helper\Bootstrap;
+
+/** @var QuoteFactory $quoteFactory */
+$quoteFactory = Bootstrap::getObjectManager()->get(QuoteFactory::class);
+/** @var QuoteResource $quoteResource */
+$quoteResource = Bootstrap::getObjectManager()->get(QuoteResource::class);
+/** @var AddressInterfaceFactory $quoteAddressFactory */
+$quoteAddressFactory = Bootstrap::getObjectManager()->get(AddressInterfaceFactory::class);
+/** @var DataObjectHelper $dataObjectHelper */
+$dataObjectHelper = Bootstrap::getObjectManager()->get(DataObjectHelper::class);
+/** @var ShippingAddressManagementInterface $shippingAddressManagement */
+$shippingAddressManagement = Bootstrap::getObjectManager()->get(ShippingAddressManagementInterface::class);
+
+$quoteAddressData = [
+    AddressInterface::KEY_TELEPHONE => 3468676,
+    AddressInterface::KEY_POSTCODE => 'M4L 1V3',
+    AddressInterface::KEY_COUNTRY_ID => 'CA',
+    AddressInterface::KEY_CITY => 'Toronto',
+    AddressInterface::KEY_COMPANY => 'CompanyName',
+    AddressInterface::KEY_STREET => '500 Kingston Rd',
+    AddressInterface::KEY_LASTNAME => 'Smith',
+    AddressInterface::KEY_FIRSTNAME => 'John',
+    AddressInterface::KEY_REGION_CODE => 'ON',
+];
+$quoteAddress = $quoteAddressFactory->create();
+$dataObjectHelper->populateWithArray($quoteAddress, $quoteAddressData, AddressInterfaceFactory::class);
+
+$quote = $quoteFactory->create();
+$quoteResource->load($quote, 'test_quote', 'reserved_order_id');
+$shippingAddressManagement->assign($quote->getId(), $quoteAddress);

dev/tests/integration/testsuite/Magento/Ups/_files/enable_ups_shipping_method.php → dev/tests/integration/testsuite/Magento/GraphQl/Ups/_files/enable_ups_shipping_method.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+// TODO: Should be removed in scope of https://github.com/magento/graphql-ce/issues/167
 declare(strict_types=1);
 
 use Magento\Framework\App\Config\Storage\Writer;

dev/tests/integration/testsuite/Magento/Ups/_files/enable_ups_shipping_method_rollback.php → dev/tests/integration/testsuite/Magento/GraphQl/Ups/_files/enable_ups_shipping_method_rollback.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+// TODO: Should be removed in scope of https://github.com/magento/graphql-ce/issues/167
 declare(strict_types=1);
 
 use Magento\Framework\App\Config\Storage\Writer;