Added the try-catch-ignore and updated the headers management in YAML tests

Author: ezimuel

util/ActionTest.php

@@ -25,6 +25,7 @@
 class ActionTest
 {
     const TEMPLATE_ENDPOINT             = __DIR__ . '/template/test/endpoint';
+    const TEMPLATE_ENDPOINT_TRY_CATCH   = __DIR__ . '/template/test/endpoint-try-catch';
     const TEMPLATE_MATCH_EQUAL          = __DIR__ . '/template/test/match-equal';
     const TEMPLATE_MATCH_REGEX          = __DIR__ . '/template/test/match-regex';
     const TEMPLATE_IS_FALSE             = __DIR__ . '/template/test/is-false';
@@ -69,6 +70,7 @@ class ActionTest
     private $skippedTest = false;
     private $output = '';
     private $phpUnitVersion;
+    private $clientParams = [];
 
     public function __construct(array $steps)
     {
@@ -89,20 +91,19 @@ private function do(array $actions): string
             ':endpoint'       => '',
             ':params'         => '',
             ':catch'          => '',
-            ':response-check' => ''
+            ':response-check' => '',
+            ':code'           => '',
+            ':headers'        => '',
+            ':reset-headers'  => ''
         ];
         foreach ($actions as $key => $value) {
             if (method_exists($this, $key)) {
                 $this->$key($value, $vars);
             } else {
                 // headers
                 if (!empty($this->headers)) {
-                    if ($value instanceof stdClass && empty(get_object_vars($value))) {
-                        $value = [];
-                    }
-                    $value['client'] = [
-                        'headers' => $this->formatHeaders($this->headers)
-                    ];
+                    $vars[':headers'] = $this->formatHeaders($this->headers);
+                    $vars[':reset-headers'] = $this->resetHeaders($this->headers);
                     $this->headers = [];
                 }
                 // Check if {} (new stdClass) is the parameter of an endpoint
@@ -119,9 +120,34 @@ private function do(array $actions): string
                 $vars[':params']   = $params;
             }
         }
+        // ignore client parameter
+        if (isset($this->clientParams['ignore'])) {
+            $vars[':code'] = $this->clientParams['ignore'];
+            return YamlTests::render(self::TEMPLATE_ENDPOINT_TRY_CATCH, $vars);
+        }
         return YamlTests::render(self::TEMPLATE_ENDPOINT, $vars);
     }
 
+    /**
+     * Adjust the client parameters (e.g. ignore)
+     */
+    private function adjustClientParams($params)
+    {
+        if (!is_array($params)) {
+            return $params;
+        }
+        $this->clientParams = [];
+        foreach ($params as $key => $value) {
+            switch($key) {
+                case 'ignore':
+                    $this->clientParams['ignore'] = $value;
+                    unset($params[$key]);
+                    break;
+            }        
+        }
+        return $params;
+    }
+
     /**
      * ---------- FEATURE FUNCTIONS (BEGIN) ----------
      */
@@ -479,36 +505,20 @@ private function convertStdClass(string $value): string
         return preg_replace("/stdClass::__set_state\(array\(\s+\)\)/", '(object) []', $value);
     }
 
-    /**
-     * Adjust the client parameters (e.g. ignore)
-     */
-    private function adjustClientParams($params)
+    private function formatHeaders(array $headers): string
     {
-        if (!is_array($params)) {
-            return $params;
-        }
-        foreach ($params as $key => $value) {
-            if (in_array($key, ['ignore'])) {
-                if (isset($params['client'])) {
-                    $params['client'][$key] = $value;
-                } else {
-                    $params['client'] = [
-                        'ignore' => $value
-                    ];
-                }
-                unset($params[$key]);
-            }
+        $result = '';
+        foreach ($headers as $key => $value) {
+            $result .= sprintf("\$this->client->getTransport()->setHeader('%s','%s');\n", $key, $value);
         }
-        return $params;
+        return $result;
     }
 
-    private function formatHeaders(array $headers): array
+    private function resetHeaders(array $headers): string
     {
-        $result = $headers;
+        $result = '';
         foreach ($headers as $key => $value) {
-            if (!is_array($value)) {
-                $result[$key] = [$value];
-            }
+            $result .= sprintf("\$this->client->getTransport()->setHeader('%s', null);\n", $key);
         }
         return $result;
     }

util/template/test/endpoint

@@ -1,4 +1,6 @@
+        :headers
         :catch$response = $this->client->:endpoint(
             :params
         );
+        :reset-headers
 :response-check

util/template/test/endpoint-try-catch

@@ -0,0 +1,12 @@
+        :headers
+        try {
+            :catch$response = $this->client->:endpoint(
+                :params
+            );           
+        } catch (ClientResponseException $e) {
+            if ($e->getCode() !== :code) {
+                throw $e;
+            }
+        }
+        :reset-headers
+:response-check

util/template/test/unit-test-oss

@@ -17,6 +17,7 @@ declare(strict_types = 1);
 namespace :namespace;
 
 use PHPUnit\Framework\TestCase;
+use Elastic\Elasticsearch\Exception\ClientResponseException;
 use Elastic\Elasticsearch\Tests\Utility;
 use stdClass;
 

util/template/test/unit-test-skipped

@@ -17,6 +17,7 @@ declare(strict_types = 1);
 namespace :namespace;
 
 use PHPUnit\Framework\TestCase;
+use Elastic\Elasticsearch\Exception\ClientResponseException;
 use Elastic\Elasticsearch\Tests\Utility;
 use stdClass;
 

util/template/test/unit-test-xpack

@@ -17,6 +17,7 @@ declare(strict_types = 1);
 namespace :namespace;
 
 use PHPUnit\Framework\TestCase;
+use Elastic\Elasticsearch\Exception\ClientResponseException;
 use Elastic\Elasticsearch\Tests\Utility;
 use stdClass;