MC-33071: Stabilize Web-API tests

zakdma · zakdma · commit 548bdc0726be · 2020-04-22T15:30:37.000+03:00
diff --git a/dev/tests/api-functional/framework/Magento/TestFramework/TestCase/WebapiAbstract.php b/dev/tests/api-functional/framework/Magento/TestFramework/TestCase/WebapiAbstract.php
@@ -258,10 +258,10 @@ public static function getFixture($key)
      *
      * @param \Magento\Framework\Model\AbstractModel $model
      * @param bool $secure
-     * @return \Magento\TestFramework\TestCase\WebapiAbstract
+     * @return void
      * //phpcs:disable
      */
-    public static function callModelDelete($model, $secure = false)
+    public static function callModelDelete($model, $secure = false) : void
     {
         //phpcs:enable
         if ($model instanceof \Magento\Framework\Model\AbstractModel && $model->getId()) {
diff --git a/dev/tests/api-functional/testsuite/Magento/Catalog/Api/CostStorageTest.php b/dev/tests/api-functional/testsuite/Magento/Catalog/Api/CostStorageTest.php
@@ -10,7 +10,7 @@
 use Magento\Framework\Webapi\Exception as HTTPExceptionCodes;
 
 /**
- * CostStorage test.
+ * Catalog Cost Storage API test.
  */
 class CostStorageTest extends WebapiAbstract
 {
diff --git a/dev/tests/api-functional/testsuite/Magento/ConfigurableProduct/Api/OptionRepositoryTest.php b/dev/tests/api-functional/testsuite/Magento/ConfigurableProduct/Api/OptionRepositoryTest.php
@@ -94,7 +94,9 @@ public function testGetList()
     public function testGetUndefinedProduct()
     {
         $this->expectException(\Exception::class);
-        $this->expectExceptionMessage('The product that was requested doesn\'t exist. Verify the product and try again.');
+        $this->expectExceptionMessage(
+            'The product that was requested doesn\'t exist. Verify the product and try again.'
+        );
 
         $productSku = 'product_not_exist';
         $this->getList($productSku);
diff --git a/dev/tests/api-functional/testsuite/Magento/Customer/Api/AddressMetadataTest.php b/dev/tests/api-functional/testsuite/Magento/Customer/Api/AddressMetadataTest.php
@@ -14,7 +14,7 @@
 use Magento\TestFramework\TestCase\WebapiAbstract;
 
 /**
- * Class AddressMetadataTest
+ * Customer Address Metadata API test
  */
 class AddressMetadataTest extends WebapiAbstract
 {
diff --git a/dev/tests/api-functional/testsuite/Magento/Customer/Api/CustomerMetadataTest.php b/dev/tests/api-functional/testsuite/Magento/Customer/Api/CustomerMetadataTest.php
@@ -12,7 +12,7 @@
 use Magento\TestFramework\Helper\Bootstrap;
 
 /**
- * Class CustomerMetadataTest
+ * Customer Metadata API test
  */
 class CustomerMetadataTest extends WebapiAbstract
 {
@@ -274,6 +274,7 @@ public function getAttributesDataProvider()
         ];
     }
 
+    // phpcs:disable Generic.Metrics.NestingLevel
     /**
      * Checks that expected and actual attribute metadata validation rules are equal
      * and removes the validation rules entry from expected and actual attribute metadata
@@ -317,6 +318,7 @@ public function checkValidationRules($expectedResult, $actualResult)
         }
         return [$expectedResult, $actualResult];
     }
+    // phpcs:enable
 
     /**
      * Check specific attribute validation rules in set of multiple attributes
diff --git a/dev/tests/api-functional/testsuite/Magento/Customer/Api/GroupManagementTest.php b/dev/tests/api-functional/testsuite/Magento/Customer/Api/GroupManagementTest.php
@@ -13,7 +13,7 @@
 use Magento\TestFramework\TestCase\WebapiAbstract;
 
 /**
- * Class GroupManagementTest
+ * Customer Group Management API test
  */
 class GroupManagementTest extends WebapiAbstract
 {
diff --git a/dev/tests/api-functional/testsuite/Magento/Customer/Api/GroupRepositoryTest.php b/dev/tests/api-functional/testsuite/Magento/Customer/Api/GroupRepositoryTest.php
@@ -19,7 +19,7 @@
 use Magento\TestFramework\TestCase\WebapiAbstract;
 
 /**
- * Class GroupRepositoryTest
+ * Customer Group Repository API test
  *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
@@ -40,7 +40,7 @@ class GroupRepositoryTest extends WebapiAbstract
     private $groupRepository;
 
     /**
-     * @var \Magento\Customer\Api\Data\groupInterfaceFactory
+     * @var \Magento\Customer\Api\Data\GroupInterfaceFactory
      */
     private $customerGroupFactory;
 
diff --git a/dev/tests/api-functional/testsuite/Magento/Downloadable/Api/LinkRepositoryTest.php b/dev/tests/api-functional/testsuite/Magento/Downloadable/Api/LinkRepositoryTest.php
@@ -677,7 +677,9 @@ public function getInvalidNumberOfDownloads()
     public function testCreateThrowsExceptionIfTargetProductTypeIsNotDownloadable()
     {
         $this->expectException(\Exception::class);
-        $this->expectExceptionMessage('The product needs to be the downloadable type. Verify the product and try again.');
+        $this->expectExceptionMessage(
+            'The product needs to be the downloadable type. Verify the product and try again.'
+        );
 
         $this->createServiceInfo['rest']['resourcePath'] = '/V1/products/simple/downloadable-links';
         $requestData = [
@@ -703,7 +705,9 @@ public function testCreateThrowsExceptionIfTargetProductTypeIsNotDownloadable()
     public function testCreateThrowsExceptionIfTargetProductDoesNotExist()
     {
         $this->expectException(\Exception::class);
-        $this->expectExceptionMessage('The product that was requested doesn\'t exist. Verify the product and try again.');
+        $this->expectExceptionMessage(
+            'The product that was requested doesn\'t exist. Verify the product and try again.'
+        );
 
         $this->createServiceInfo['rest']['resourcePath'] = '/V1/products/wrong-sku/downloadable-links';
         $requestData = [
@@ -803,7 +807,9 @@ public function testUpdateSavesDataInGlobalScopeAndDoesNotAffectValuesStoredInSt
     public function testUpdateThrowsExceptionIfTargetProductDoesNotExist()
     {
         $this->expectException(\Exception::class);
-        $this->expectExceptionMessage('The product that was requested doesn\'t exist. Verify the product and try again.');
+        $this->expectExceptionMessage(
+            'The product that was requested doesn\'t exist. Verify the product and try again.'
+        );
 
         $this->updateServiceInfo['rest']['resourcePath'] = '/V1/products/wrong-sku/downloadable-links/1';
         $requestData = [
@@ -829,7 +835,9 @@ public function testUpdateThrowsExceptionIfTargetProductDoesNotExist()
     public function testUpdateThrowsExceptionIfThereIsNoDownloadableLinkWithGivenId()
     {
         $this->expectException(\Exception::class);
-        $this->expectExceptionMessage('No downloadable link with the provided ID was found. Verify the ID and try again.');
+        $this->expectExceptionMessage(
+            'No downloadable link with the provided ID was found. Verify the ID and try again.'
+        );
 
         $linkId = 9999;
         $this->updateServiceInfo['rest']['resourcePath']
@@ -961,7 +969,9 @@ public function testDelete()
     public function testDeleteThrowsExceptionIfThereIsNoDownloadableLinkWithGivenId()
     {
         $this->expectException(\Exception::class);
-        $this->expectExceptionMessage('No downloadable link with the provided ID was found. Verify the ID and try again.');
+        $this->expectExceptionMessage(
+            'No downloadable link with the provided ID was found. Verify the ID and try again.'
+        );
 
         $linkId = 9999;
         $this->deleteServiceInfo['rest']['resourcePath'] = "/V1/products/downloadable-links/{$linkId}";
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/Catalog/ProductTextAttributesTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/Catalog/ProductTextAttributesTest.php
@@ -134,9 +134,21 @@ public function testHtmlDirectivesRendering()
 QUERY;
         $response = $this->graphQlQuery($query);
 
-        self::assertStringContainsString($assertionCmsBlockText, $response['products']['items'][0]['description']['html']);
-        self::assertStringNotContainsString('{{block id', $response['products']['items'][0]['description']['html']);
-        self::assertStringContainsString($assertionCmsBlockText, $response['products']['items'][0]['short_description']['html']);
-        self::assertStringNotContainsString('{{block id', $response['products']['items'][0]['short_description']['html']);
+        self::assertStringContainsString(
+            $assertionCmsBlockText,
+            $response['products']['items'][0]['description']['html']
+        );
+        self::assertStringNotContainsString(
+            '{{block id',
+            $response['products']['items'][0]['description']['html']
+        );
+        self::assertStringContainsString(
+            $assertionCmsBlockText,
+            $response['products']['items'][0]['short_description']['html']
+        );
+        self::assertStringNotContainsString(
+            '{{block id',
+            $response['products']['items'][0]['short_description']['html']
+        );
     }
 }
diff --git a/dev/tests/api-functional/testsuite/Magento/Quote/Api/CartManagementTest.php b/dev/tests/api-functional/testsuite/Magento/Quote/Api/CartManagementTest.php
@@ -11,8 +11,7 @@
 use Magento\TestFramework\TestCase\WebapiAbstract;
 
 /**
- * Class CartManagementTest
- * @package Magento\Quote\Api
+ * Quote Cart Management API test
  * @magentoAppIsolation enabled
  */
 class CartManagementTest extends WebapiAbstract
@@ -282,7 +281,9 @@ public function testAssignCustomerThrowsExceptionIfTargetCartIsNotAnonymous()
     public function testAssignCustomerThrowsExceptionIfCartIsAssignedToDifferentStore()
     {
         $this->expectException(\Exception::class);
-        $this->expectExceptionMessage('The customer can\'t be assigned to the cart. The cart belongs to a different store.');
+        $this->expectExceptionMessage(
+            'The customer can\'t be assigned to the cart. The cart belongs to a different store.'
+        );
 
         $repository = $this->objectManager->create(\Magento\Customer\Api\CustomerRepositoryInterface::class);
         /** @var $customer \Magento\Customer\Api\Data\CustomerInterface */
diff --git a/dev/tests/api-functional/testsuite/Magento/Sales/Service/V1/ShipmentAddTrackTest.php b/dev/tests/api-functional/testsuite/Magento/Sales/Service/V1/ShipmentAddTrackTest.php
@@ -15,7 +15,7 @@
 use Magento\TestFramework\TestCase\WebapiAbstract;
 
 /**
- * Class ShipmentAddTrackTest
+ * Sales Shipment Track Repository API test
  */
 class ShipmentAddTrackTest extends WebapiAbstract
 {
diff --git a/dev/tests/api-functional/testsuite/Magento/Tax/Api/TaxRuleRepositoryInterfaceTest.php b/dev/tests/api-functional/testsuite/Magento/Tax/Api/TaxRuleRepositoryInterfaceTest.php
@@ -14,8 +14,7 @@
 use Magento\Webapi\Model\Rest\Config as HttpConstants;
 
 /**
- * Class TaxRuleRepositoryInterfaceTest
- * @package Magento\Tax\Api
+ * Tax Rule Repository API test
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class TaxRuleRepositoryInterfaceTest extends WebapiAbstract
@@ -195,9 +194,15 @@ public function testCreateTaxRuleInvalidTaxClassIds()
             $this->_webApiCall($serviceInfo, $requestData);
             $this->fail('Did not throw expected InputException');
         } catch (\SoapFault $e) {
-            $this->assertStringContainsString('No such entity with customer_tax_class_ids = %fieldValue', $e->getMessage());
+            $this->assertStringContainsString(
+                'No such entity with customer_tax_class_ids = %fieldValue',
+                $e->getMessage()
+            );
         } catch (\Exception $e) {
-            $this->assertStringContainsString('No such entity with customer_tax_class_ids = %fieldValue', $e->getMessage());
+            $this->assertStringContainsString(
+                'No such entity with customer_tax_class_ids = %fieldValue',
+                $e->getMessage()
+            );
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -258,10 +258,10 @@ public static function getFixture($key)`
`258`	`258`	`*`
`259`	`259`	`* @param \Magento\Framework\Model\AbstractModel $model`
`260`	`260`	`* @param bool $secure`
`261`		`- * @return \Magento\TestFramework\TestCase\WebapiAbstract`
	`261`	`+ * @return void`
`262`	`262`	`* //phpcs:disable`
`263`	`263`	`*/`
`264`		`- public static function callModelDelete($model, $secure = false)`
	`264`	`+ public static function callModelDelete($model, $secure = false) : void`
`265`	`265`	`{`
`266`	`266`	`//phpcs:enable`
`267`	`267`	`if ($model instanceof \Magento\Framework\Model\AbstractModel && $model->getId()) {`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`use Magento\Framework\Webapi\Exception as HTTPExceptionCodes;`
`11`	`11`
`12`	`12`	`/**`
`13`		`- * CostStorage test.`
	`13`	`+ * Catalog Cost Storage API test.`
`14`	`14`	`*/`
`15`	`15`	`class CostStorageTest extends WebapiAbstract`
`16`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`use Magento\TestFramework\TestCase\WebapiAbstract;`
`15`	`15`
`16`	`16`	`/**`
`17`		`- * Class AddressMetadataTest`
	`17`	`+ * Customer Address Metadata API test`
`18`	`18`	`*/`
`19`	`19`	`class AddressMetadataTest extends WebapiAbstract`
`20`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`use Magento\TestFramework\Helper\Bootstrap;`
`13`	`13`
`14`	`14`	`/**`
`15`		`- * Class CustomerMetadataTest`
	`15`	`+ * Customer Metadata API test`
`16`	`16`	`*/`
`17`	`17`	`class CustomerMetadataTest extends WebapiAbstract`
`18`	`18`	`{`
`@@ -274,6 +274,7 @@ public function getAttributesDataProvider()`
`274`	`274`	`];`
`275`	`275`	`}`
`276`	`276`
	`277`	`+ // phpcs:disable Generic.Metrics.NestingLevel`
`277`	`278`	`/**`
`278`	`279`	`* Checks that expected and actual attribute metadata validation rules are equal`
`279`	`280`	`* and removes the validation rules entry from expected and actual attribute metadata`
`@@ -317,6 +318,7 @@ public function checkValidationRules($expectedResult, $actualResult)`
`317`	`318`	`}`
`318`	`319`	`return [$expectedResult, $actualResult];`
`319`	`320`	`}`
	`321`	`+ // phpcs:enable`
`320`	`322`
`321`	`323`	`/**`
`322`	`324`	`* Check specific attribute validation rules in set of multiple attributes`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`use Magento\TestFramework\TestCase\WebapiAbstract;`
`14`	`14`
`15`	`15`	`/**`
`16`		`- * Class GroupManagementTest`
	`16`	`+ * Customer Group Management API test`
`17`	`17`	`*/`
`18`	`18`	`class GroupManagementTest extends WebapiAbstract`
`19`	`19`	`{`