MC-40044: Create automated test for: "Delete product link by API call"

Author: ysapiga

dev/tests/api-functional/testsuite/Magento/Catalog/Api/ProductLinkRepositoryInterfaceTest.php

@@ -4,61 +4,84 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Catalog\Api;
 
+use Magento\Framework\ObjectManagerInterface;
+use Magento\Framework\Webapi\Rest\Request;
 use Magento\TestFramework\Helper\Bootstrap;
 use Magento\TestFramework\TestCase\WebapiAbstract;
 
+/**
+ * Class ProductLinkRepositoryInterfaceTest
+ *
+ * @see \Magento\Catalog\Api\ProductLinkRepository
+ */
 class ProductLinkRepositoryInterfaceTest extends WebapiAbstract
 {
+    /**
+     * @var string
+     */
     const SERVICE_NAME = 'catalogProductLinkRepositoryV1';
+
+    /**
+     * @var string
+     */
     const SERVICE_VERSION = 'V1';
+
+    /**
+     * @var string
+     */
     const RESOURCE_PATH = '/V1/products/';
 
     /**
-     * @var \Magento\Framework\ObjectManagerInterface
+     * @var ObjectManagerInterface
      */
-    protected $objectManager;
+    private $objectManager;
 
+    /**
+     * @var ProductLinkManagementInterface
+     */
+    private $linkManagement;
+
+    /**
+     * @inheritdoc
+     */
     protected function setUp(): void
     {
+        parent::setUp();
+
         $this->objectManager = Bootstrap::getObjectManager();
+        $this->linkManagement = $this->objectManager->get(ProductLinkManagementInterface::class);
     }
 
     /**
      * @magentoApiDataFixture Magento/Catalog/_files/products_related_multiple.php
-     * @magentoAppIsolation enabled
+     *
+     * @return void
      */
-    public function testDelete()
+    public function testDelete(): void
     {
         $productSku = 'simple_with_cross';
-        $linkedSku = 'simple';
         $linkType = 'related';
-        $this->_webApiCall(
-            [
-                'rest' => [
-                    'resourcePath' => self::RESOURCE_PATH . $productSku . '/links/' . $linkType . '/' . $linkedSku,
-                    'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_DELETE,
-                ],
-                'soap' => [
-                    'service' => self::SERVICE_NAME,
-                    'serviceVersion' => self::SERVICE_VERSION,
-                    'operation' => self::SERVICE_NAME . 'DeleteById',
-                ],
-            ],
-            [
-                'sku' => $productSku,
-                'type' => $linkType,
-                'linkedProductSku' => $linkedSku
-            ]
-        );
-        /** @var \Magento\Catalog\Model\ProductLink\Management $linkManagement */
-        $linkManagement = $this->objectManager->create(\Magento\Catalog\Api\ProductLinkManagementInterface::class);
-        $linkedProducts = $linkManagement->getLinkedItemsByType($productSku, $linkType);
+        $this->deleteApiCall($productSku, $linkType, 'simple');
+        $linkedProducts = $this->linkManagement->getLinkedItemsByType($productSku, $linkType);
         $this->assertCount(1, $linkedProducts);
-        /** @var \Magento\Catalog\Api\Data\ProductLinkInterface $product */
         $product = current($linkedProducts);
-        $this->assertEquals($product->getLinkedProductSku(), 'simple_with_cross_two');
+        $this->assertEquals('simple_with_cross_two', $product->getLinkedProductSku());
+    }
+
+    /**
+     * @magentoApiDataFixture Magento/Catalog/_files/product_simple.php
+     *
+     * @return void
+     */
+    public function testDeleteNotExistedProductLink(): void
+    {
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage((string)__("Product %1 doesn't have linked %2 as %3"));
+        $this->deleteApiCall('simple', 'related', 'not_exists_product');
     }
 
     /**
@@ -68,36 +91,85 @@ public function testSave()
     {
         $productSku = 'simple_with_cross';
         $linkType = 'related';
+        $data = [
+            'entity' => [
+                'sku' => 'simple_with_cross',
+                'link_type' => 'related',
+                'linked_product_sku' => 'simple',
+                'linked_product_type' => 'simple',
+                'position' => 1000,
+            ],
+        ];
+        $this->saveApiCall($productSku, $data);
+        $actual = $this->linkManagement->getLinkedItemsByType($productSku, $linkType);
+        $this->assertCount(1, $actual, 'Invalid actual linked products count');
+        $this->assertEquals(1000, $actual[0]->getPosition(), 'Product position is not updated');
+    }
 
-        $serviceInfo = [
+    /**
+     * Get service info for api call
+     *
+     * @param string $resourcePath
+     * @param string $httpMethod
+     * @param string $operation
+     * @return array
+     */
+    private function getServiceInfo(string $resourcePath, string $httpMethod, string $operation): array
+    {
+        return [
             'rest' => [
-                'resourcePath' => self::RESOURCE_PATH . $productSku . '/links',
-                'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_PUT,
+                'resourcePath' => self::RESOURCE_PATH . $resourcePath,
+                'httpMethod' => $httpMethod,
             ],
             'soap' => [
                 'service' => self::SERVICE_NAME,
                 'serviceVersion' => self::SERVICE_VERSION,
-                'operation' => self::SERVICE_NAME . 'Save',
+                'operation' => self::SERVICE_NAME . $operation,
             ],
         ];
+    }
 
-        $this->_webApiCall(
+    /**
+     * Make api call to delete product link
+     *
+     * @param string $productSku
+     * @param string $linkType
+     * @param string $linkedSku
+     * @return array|int|string|float|bool
+     */
+    private function deleteApiCall(string $productSku, string $linkType, string $linkedSku)
+    {
+        $serviceInfo = $this->getServiceInfo(
+            $productSku . '/links/' . $linkType . '/' . $linkedSku,
+            Request::HTTP_METHOD_DELETE,
+            'DeleteById'
+        );
+
+        return $this->_webApiCall(
             $serviceInfo,
             [
-                'entity' => [
-                    'sku' => 'simple_with_cross',
-                    'link_type' => 'related',
-                    'linked_product_sku' => 'simple',
-                    'linked_product_type' => 'simple',
-                    'position' => 1000,
-                ]
+                'sku' => $productSku,
+                'type' => $linkType,
+                'linkedProductSku' => $linkedSku,
             ]
         );
+    }
 
-        /** @var \Magento\Catalog\Model\ProductLink\Management $linkManagement */
-        $linkManagement = $this->objectManager->get(\Magento\Catalog\Api\ProductLinkManagementInterface::class);
-        $actual = $linkManagement->getLinkedItemsByType($productSku, $linkType);
-        $this->assertCount(1, $actual, 'Invalid actual linked products count');
-        $this->assertEquals(1000, $actual[0]->getPosition(), 'Product position is not updated');
+    /**
+     * Make api call to save product link
+     *
+     * @param $productSku
+     * @param $data
+     * @return array|bool|float|int|string
+     */
+    private function saveApiCall($productSku, $data)
+    {
+        $serviceInfo = $this->getServiceInfo(
+            $productSku . '/links',
+            Request::HTTP_METHOD_PUT,
+            'Save'
+        );
+
+        return $this->_webApiCall($serviceInfo, $data);
     }
 }