MQE-260: ApiExecutor - Logging/Error detection for failed API Calls

Author: tomreece

src/Magento/AcceptanceTestFramework/Util/ApiClientUtil.php

@@ -43,6 +43,13 @@ class ApiClientUtil
      */
     private $jsonBody;
 
+    /**
+     * A list of successful HTTP responses that will not trigger an exception
+     *
+     * @var int[] SUCCESSFUL_HTTP_CODES
+     */
+    const SUCCESSFUL_HTTP_CODES = [200, 201, 202, 203, 204, 205];
+
     /**
      * ApiClientUtil constructor.
      * @param string $apiPath
@@ -65,6 +72,7 @@ public function __construct($apiPath, $headers, $apiOperation, $jsonBody)
      *
      * @param bool $verbose
      * @return string|bool
+     * @throws \Exception
      */
     public function submit($verbose = false)
     {
@@ -95,20 +103,11 @@ public function submit($verbose = false)
             CURLOPT_URL => $url . $this->apiPath
         ]);
 
-        try {
-            $response = curl_exec($this->curl);
-            if ($response === false) {
-                throw new \Exception(curl_error($this->curl), curl_errno($this->curl));
-            }
-        } catch (\Exception $e) {
-            trigger_error(
-                sprintf(
-                    'Curl failed with error #%d: %s',
-                    $e->getCode(),
-                    $e->getMessage()
-                ),
-                E_USER_ERROR
-            );
+        $response = curl_exec($this->curl);
+        $http_code = curl_getinfo($this->curl, CURLINFO_HTTP_CODE);
+
+        if ($response === false || !in_array($http_code, ApiClientUtil::SUCCESSFUL_HTTP_CODES)) {
+            throw new \Exception('API returned response code: ' . $http_code . '    Response:' . $response);
         }
 
         curl_close($this->curl);

src/Magento/AcceptanceTestFramework/Util/TestGenerator.php

@@ -389,6 +389,12 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
                 case "createData":
                     $entity = $customActionAttributes['entity'];
                     $key = $steps->getMergeKey();
+                    //Add an informative statement to help the user debug test runs
+                    $testSteps .= sprintf(
+                        "\t\t$%s->amGoingTo(\"create entity that has the mergeKey: %s\");\n",
+                        $actor,
+                        $key
+                    );
                     //Get Entity from Static data.
                     $testSteps .= sprintf(
                         "\t\t$%s = DataObjectHandler::getInstance()->getObject(\"%s\");\n",
@@ -462,6 +468,12 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
                     break;
                 case "deleteData":
                     $key = $customActionAttributes['createDataKey'];
+                    //Add an informative statement to help the user debug test runs
+                    $testSteps .= sprintf(
+                        "\t\t$%s->amGoingTo(\"delete entity that has the createDataKey: %s\");\n",
+                        $actor,
+                        $key
+                    );
 
                     if ($hookObject) {
                         $testSteps .= sprintf("\t\t\$this->%s->deleteEntity();\n", $key);