Refactor seeResponseIsJson and seeResponseIsValidOnJsonSchema to share functionality.

Author: ruudboon

src/Codeception/Module/REST.php

@@ -773,18 +773,7 @@ public function seeResponseIsJson()
     {
         $responseContent = $this->connectionModule->_getResponseContent();
         \PHPUnit\Framework\Assert::assertNotEquals('', $responseContent, 'response is empty');
-        json_decode($responseContent);
-        $errorCode = json_last_error();
-        $errorMessage = json_last_error_msg();
-        \PHPUnit\Framework\Assert::assertEquals(
-            JSON_ERROR_NONE,
-            $errorCode,
-            sprintf(
-                "Invalid json: %s. System message: %s.",
-                $responseContent,
-                $errorMessage
-            )
-        );
+        $this->decodeAndValidateJson($responseContent);
     }
 
     /**
@@ -853,32 +842,10 @@ public function seeResponseIsValidOnJsonSchema($schema)
     {
         $responseContent = $this->connectionModule->_getResponseContent();
         \PHPUnit\Framework\Assert::assertNotEquals('', $responseContent, 'response is empty');
-        $responseObject = json_decode($responseContent);
-        $errorCode = json_last_error();
-        $errorMessage = json_last_error_msg();
-        \PHPUnit\Framework\Assert::assertEquals(
-            JSON_ERROR_NONE,
-            $errorCode,
-            sprintf(
-                "Invalid json: %s. System message: %s.",
-                $responseContent,
-                $errorMessage
-            )
-        );
+        $responseObject = $this->decodeAndValidateJson($responseContent);
 
         \PHPUnit\Framework\Assert::assertNotEquals('', $schema, 'schema is empty');
-        $schemaObject = json_decode($schema, true);
-        $errorCode = json_last_error();
-        $errorMessage = json_last_error_msg();
-        \PHPUnit\Framework\Assert::assertEquals(
-            JSON_ERROR_NONE,
-            $errorCode,
-            sprintf(
-                "Invalid schema json: %s. System message: %s.",
-                $responseContent,
-                $errorMessage
-            )
-        );
+        $schemaObject = $this->decodeAndValidateJson($schema, "Invalid schema json: %s. System message: %s.");
 
         $validator = new JsonSchemaValidator();
         $validator->validate($responseObject, $schemaObject, JsonContraint::CHECK_MODE_VALIDATE_SCHEMA);
@@ -894,6 +861,29 @@ public function seeResponseIsValidOnJsonSchema($schema)
         );
     }
 
+    /**
+     * Converts string to json and asserts that no error occured while decoding.
+     *
+     * @param string $jsonString the json encoded string
+     * @param string $errorFormat optional string for custom sprintf format
+     */
+    protected function decodeAndValidateJson($jsonString, $errorFormat="Invalid json: %s. System message: %s.")
+    {
+        $json = json_decode($jsonString);
+        $errorCode = json_last_error();
+        $errorMessage = json_last_error_msg();
+        \PHPUnit\Framework\Assert::assertEquals(
+            JSON_ERROR_NONE,
+            $errorCode,
+            sprintf(
+                $errorFormat,
+                $jsonString,
+                $errorMessage
+            )
+        );
+        return $json;
+    }
+
     /**
      * Returns current response so that it can be used in next scenario steps.
      *