MC-40089: Create automated test for: "Try to add a simple product to configurableproduct as an option"

Author: ysapiga

dev/tests/api-functional/testsuite/Magento/ConfigurableProduct/Api/LinkManagementTest.php

@@ -4,6 +4,8 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\ConfigurableProduct\Api;
 
 use Magento\Catalog\Model\ResourceModel\Eav\Attribute;
@@ -43,8 +45,10 @@ protected function setUp(): void
 
     /**
      * @magentoApiDataFixture Magento/ConfigurableProduct/_files/product_configurable.php
+     *
+     * @return void
      */
-    public function testGetChildren()
+    public function testGetChildren(): void
     {
         $productSku = 'configurable';
 
@@ -72,8 +76,10 @@ public function testGetChildren()
      * @magentoApiDataFixture Magento/ConfigurableProduct/_files/product_configurable.php
      * @magentoApiDataFixture Magento/ConfigurableProduct/_files/product_simple_77.php
      * @magentoApiDataFixture Magento/ConfigurableProduct/_files/delete_association.php
+     *
+     * @return void
      */
-    public function testAddChild()
+    public function testAddChild(): void
     {
         $productSku = 'configurable';
         $childSku = 'simple_77';
@@ -85,8 +91,10 @@ public function testAddChild()
      * Test the full flow of creating a configurable product and adding a child via REST
      *
      * @magentoApiDataFixture Magento/ConfigurableProduct/_files/configurable_attribute.php
+     *
+     * @return void
      */
-    public function testAddChildFullRestCreation()
+    public function testAddChildFullRestCreation(): void
     {
         $productSku = 'configurable-product-sku';
         $childSku = 'simple-product-sku';
@@ -96,7 +104,7 @@ public function testAddChildFullRestCreation()
 
         $this->addOptionToConfigurableProduct(
             $productSku,
-            $attribute->getAttributeId(),
+            (int)$attribute->getAttributeId(),
             [
                 [
                     'value_index' => $attribute->getOptions()[1]->getValue()
@@ -139,8 +147,10 @@ public function testAddChildFullRestCreation()
      * configurable product.
      *
      * @magentoApiDataFixture Magento/ConfigurableProduct/_files/configurable_attributes_for_position_test.php
+     *
+     * @return void
      */
-    public function testConfigurableOptionPositionPreservation()
+    public function testConfigurableOptionPositionPreservation(): void
     {
         $productSku = 'configurable-product-sku';
         $childProductSkus = [
@@ -160,19 +170,19 @@ public function testConfigurableOptionPositionPreservation()
             /** @var Attribute $attribute */
             $attribute = $this->attributeRepository->get('catalog_product', $attributeToAdd);
 
-            /** @var Option $options[] */
+            /** @var Option $options [] */
             $options = $attribute->getOptions();
             array_shift($options);
 
             $attributeOptions[$attributeToAdd] = $options;
 
             $valueIndexesData = [];
             foreach ($options as $option) {
-                $valueIndexesData []['value_index']= $option->getValue();
+                $valueIndexesData []['value_index'] = $option->getValue();
             }
             $this->addOptionToConfigurableProduct(
                 $productSku,
-                $attribute->getAttributeId(),
+                (int)$attribute->getAttributeId(),
                 $valueIndexesData,
                 $position
             );
@@ -284,7 +294,14 @@ protected function getConfigurableAttribute(string $productSku): array
         return $this->_webApiCall($serviceInfo, ['sku' => $productSku]);
     }
 
-    private function addChild($productSku, $childSku)
+    /**
+     * Perform add child product Api call
+     *
+     * @param string $productSku
+     * @param string $childSku
+     * @return array|int|string|float|bool
+     */
+    private function addChild(string $productSku, string $childSku)
     {
         $serviceInfo = [
             'rest' => [
@@ -300,7 +317,13 @@ private function addChild($productSku, $childSku)
         return $this->_webApiCall($serviceInfo, ['sku' => $productSku, 'childSku' => $childSku]);
     }
 
-    protected function createConfigurableProduct($productSku)
+    /**
+     * Perform create configurable product api call
+     *
+     * @param string $productSku
+     * @return array|bool|float|int|string
+     */
+    protected function createConfigurableProduct(string $productSku)
     {
         $requestData = [
             'product' => [
@@ -325,8 +348,21 @@ protected function createConfigurableProduct($productSku)
         return $this->_webApiCall($serviceInfo, $requestData);
     }
 
-    protected function addOptionToConfigurableProduct($productSku, $attributeId, $attributeValues, $position = 0)
-    {
+    /**
+     * Add option to configurable product
+     *
+     * @param string $productSku
+     * @param int $attributeId
+     * @param array $attributeValues
+     * @param int $position
+     * @return array|bool|float|int|string
+     */
+    protected function addOptionToConfigurableProduct(
+        string $productSku,
+        int $attributeId,
+        array $attributeValues,
+        int $position = 0
+    ) {
         $requestData = [
             'sku' => $productSku,
             'option' => [
@@ -339,7 +375,7 @@ protected function addOptionToConfigurableProduct($productSku, $attributeId, $at
         ];
         $serviceInfo = [
             'rest' => [
-                'resourcePath' => '/V1/configurable-products/'. $productSku .'/options',
+                'resourcePath' => '/V1/configurable-products/' . $productSku . '/options',
                 'httpMethod' => Request::HTTP_METHOD_POST,
             ],
             'soap' => [
@@ -381,15 +417,63 @@ protected function createSimpleProduct($sku, $customAttributes)
 
     /**
      * @magentoApiDataFixture Magento/ConfigurableProduct/_files/product_configurable.php
+     *
+     * @return void
      */
-    public function testRemoveChild()
+    public function testRemoveChild(): void
     {
         $productSku = 'configurable';
         $childSku = 'simple_10';
         $this->assertTrue($this->removeChild($productSku, $childSku));
     }
 
-    protected function removeChild($productSku, $childSku)
+    /**
+     * @dataProvider errorsDataProvider
+     *
+     * @magentoApiDataFixture Magento/ConfigurableProduct/_files/product_configurable.php
+     * @magentoApiDataFixture Magento/Catalog/_files/second_product_simple.php
+     *
+     * @param string $parentSku
+     * @param string $childSku
+     * @param string $errorMessage
+     * @return void
+     */
+    public function testAddChildWithError(string $parentSku, string $childSku, string $errorMessage): void
+    {
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage($errorMessage);
+        $this->addChild($parentSku, $childSku);
+    }
+
+    /**
+     * @return array
+     */
+    public function errorsDataProvider(): array
+    {
+        return [
+            'simple_instead_of_configurable' => [
+                'parent_sku' => 'simple2',
+                'child_sku' => 'configurable',
+                'error_message' => (string)__("The parent product doesn't have configurable product options."),
+            ],
+            'simple_with_empty_configurable_attribute_value' => [
+                'parent_sku' => 'configurable',
+                'child_sku' => 'simple2',
+                'error_message' => (string)__(
+                    'The child product doesn\'t have the \\"%1\\" attribute value. Verify the value and try again.'
+                ),
+            ]
+        ];
+    }
+
+    /**
+     * Remove child product
+     *
+     * @param string $productSku
+     * @param string $childSku
+     * @return array|bool|float|int|string
+     */
+    protected function removeChild(string $productSku, string $childSku)
     {
         $resourcePath = self::RESOURCE_PATH . '/%s/children/%s';
         $serviceInfo = [
@@ -408,14 +492,16 @@ protected function removeChild($productSku, $childSku)
     }
 
     /**
+     * get child products
+     *
      * @param string $productSku
      * @return string[]
      */
-    protected function getChildren($productSku)
+    protected function getChildren(string $productSku)
     {
         $serviceInfo = [
             'rest' => [
-                'resourcePath' => self::RESOURCE_PATH . '/' . $productSku  . '/children',
+                'resourcePath' => self::RESOURCE_PATH . '/' . $productSku . '/children',
                 'httpMethod' => Request::HTTP_METHOD_GET
             ],
             'soap' => [