Added seeResponseIsValidOnJsonSchema

Resolves Codeception/Codeception#2472

Author: ruudboon

composer.json

@@ -15,7 +15,8 @@
     "require": {
         "php": ">=5.6.0 <8.0",
         "flow/jsonpath": "^0.5",
-        "codeception/codeception": "^4.0"
+        "codeception/codeception": "^4.0",
+        "justinrainbow/json-schema": "^5.2.9"
     },
     "require-dev": {
         "codeception/util-robohelpers": "dev-master",

src/Codeception/Module/REST.php

@@ -19,6 +19,8 @@
 use Codeception\Util\JsonType;
 use Codeception\Util\XmlStructure;
 use Codeception\Util\Soap as XmlUtils;
+use JsonSchema\Validator as JsonSchemaValidator;
+use JsonSchema\Constraints\Constraint as JsonContraint;
 
 /**
  * Module for testing REST WebService.
@@ -841,6 +843,57 @@ public function seeResponseContainsJson($json = [])
         );
     }
 
+    /**
+     * Checks whether last response matches the supplied json schema
+     * Supply schema as json string
+     *
+     * @part json
+     */
+    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
+            )
+        );
+
+        \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
+            )
+        );
+
+        $validator = new JsonSchemaValidator();
+        $validator->validate($responseObject, $schemaObject, JsonContraint::CHECK_MODE_VALIDATE_SCHEMA);
+        $outcome = $validator->isValid();
+        $error = "";
+        if (!$outcome) {
+            $errors = $validator->getErrors();
+            $error = array_shift($errors)["message"];
+        }
+        \PHPUnit\Framework\Assert::assertTrue(
+            $outcome,
+            $error
+        );
+    }
+
     /**
      * Returns current response so that it can be used in next scenario steps.
      *

tests/data/responses/invalid-basic-schema.json

@@ -0,0 +1,5 @@
+{
+  "firstName": "John",
+  "lastName": "Doe",
+  "age": -10
+}

tests/data/responses/invalid-complex-schema.json

@@ -0,0 +1,13 @@
+{
+  "fruits": [ "apple", "orange", "pear" ],
+  "vegetables": [
+    {
+      "veggieName": "potato",
+      "veggieLike": true
+    },
+    {
+      "veggieName": "broccoli",
+      "veggieLike": "false"
+    }
+  ]
+}

tests/data/responses/valid-basic-schema.json

@@ -0,0 +1,5 @@
+{
+  "firstName": "John",
+  "lastName": "Doe",
+  "age": 21
+}

tests/data/responses/valid-complex-schema.json

@@ -0,0 +1,13 @@
+{
+  "fruits": [ "apple", "orange", "pear" ],
+  "vegetables": [
+    {
+      "veggieName": "potato",
+      "veggieLike": true
+    },
+    {
+      "veggieName": "broccoli",
+      "veggieLike": false
+    }
+  ]
+}

tests/data/schemas/basic-schema.json

@@ -0,0 +1,21 @@
+{
+  "$id": "https://example.com/person.schema.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Person",
+  "type": "object",
+  "properties": {
+    "firstName": {
+      "type": "string",
+      "description": "The person's first name."
+    },
+    "lastName": {
+      "type": "string",
+      "description": "The person's last name."
+    },
+    "age": {
+      "description": "Age in years which must be equal to or greater than zero.",
+      "type": "integer",
+      "minimum": 0
+    }
+  }
+}

tests/data/schemas/complex-schema.json

@@ -0,0 +1,34 @@
+{
+  "$id": "https://example.com/arrays.schema.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "A representation of a person, company, organization, or place",
+  "type": "object",
+  "properties": {
+    "fruits": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "vegetables": {
+      "type": "array",
+      "items": { "$ref": "#/definitions/veggie" }
+    }
+  },
+  "definitions": {
+    "veggie": {
+      "type": "object",
+      "required": [ "veggieName", "veggieLike" ],
+      "properties": {
+        "veggieName": {
+          "type": "string",
+          "description": "The name of the vegetable."
+        },
+        "veggieLike": {
+          "type": "boolean",
+          "description": "Do I like this vegetable?"
+        }
+      }
+    }
+  }
+}

tests/unit/Codeception/Module/RestTest.php

@@ -442,6 +442,29 @@ public function testAmDigestAuthenticatedThrowsExceptionWithFunctionalModules()
         $this->module->amDigestAuthenticated('username', 'password');
     }
 
+    /**
+     * @param $schema
+     * @param $response
+     * @param $outcome
+     * @param $error
+     *
+     * @dataProvider schemaAndResponse
+     */
+
+    public function testSeeResponseIsValidOnJsonSchemachesJsonSchema($schema, $response, $outcome, $error) {
+
+        $response = file_get_contents(codecept_data_dir($response));
+        $this->setStubResponse($response);
+
+        $validSchema = file_get_contents(codecept_data_dir($schema));
+
+        if (!$outcome) {
+            $this->expectExceptionMessage($error);
+            $this->shouldFail();
+        }
+        $this->module->seeResponseIsValidOnJsonSchema($validSchema);
+    }
+
     /**
      * @param $configUrl
      * @param $requestUrl
@@ -481,6 +504,17 @@ public function testRestExecute($configUrl, $requestUrl, $expectedFullUrl)
         $module->sendGET($requestUrl);
     }
 
+    public static function schemaAndResponse()
+    {
+        return [
+            //schema, responsefile, valid
+            ['schemas/basic-schema.json', 'responses/valid-basic-schema.json', true, ""],
+            ['schemas/basic-schema.json', 'responses/invalid-basic-schema.json', false, "Must have a minimum value of 0"],
+            ['schemas/complex-schema.json', 'responses/valid-complex-schema.json', true, ""],
+            ['schemas/complex-schema.json', 'responses/invalid-complex-schema.json', false, "String value found, but a boolean is required"]
+        ];
+    }
+
     public static function configAndRequestUrls()
     {
         return [