Use swagger dump as json schemas source

Author: gpenverne

src/Context/JsonContext.php

@@ -273,8 +273,7 @@ public function theJsonNodeShouldExist($name)
 
         try {
             $node = $this->inspector->evaluate($json, $name);
-        }
-        catch (\Exception $e) {
+        } catch (\Exception $e) {
             throw new \Exception("The node '$name' does not exist.");
         }
         return $node;
@@ -287,7 +286,7 @@ public function theJsonNodeShouldExist($name)
      */
     public function theJsonNodeShouldNotExist($name)
     {
-        $this->not(function () use($name) {
+        $this->not(function () use ($name) {
             return $this->theJsonNodeShouldExist($name);
         }, "The node '$name' exists.");
     }
@@ -308,7 +307,7 @@ public function theJsonShouldBeValidAccordingToThisSchema(PyStringNode $schema)
      */
     public function theJsonShouldBeInvalidAccordingToThisSchema(PyStringNode $schema)
     {
-        $this->not(function() use($schema) {
+        $this->not(function () use ($schema) {
             return $this->theJsonShouldBeValidAccordingToThisSchema($schema);
         }, 'Expected to receive invalid json, got valid one');
     }
@@ -336,7 +335,7 @@ public function theJsonShouldBeInvalidAccordingToTheSchema($filename)
     {
         $this->checkSchemaFile($filename);
 
-        $this->not(function () use($filename) {
+        $this->not(function () use ($filename) {
             return $this->theJsonShouldBeValidAccordingToTheSchema($filename);
         }, "The schema was valid");
     }
@@ -350,8 +349,7 @@ public function theJsonShouldBeEqualTo(PyStringNode $content)
 
         try {
             $expected = new Json($content);
-        }
-        catch (\Exception $e) {
+        } catch (\Exception $e) {
             throw new \Exception('The expected JSON is not a valid');
         }
 
@@ -371,6 +369,44 @@ public function printLastJsonResponse()
             ->encode();
     }
 
+    /**
+     * Checks, that response JSON matches with a swagger dump
+     *
+     * @Then the JSON should be valid according to swagger :dumpPath dump schema :schemaName
+     */
+    public function theJsonShouldBeValidAccordingToTheSwaggerSchema($dumpPath, $schemaName)
+    {
+        $this->checkSchemaFile($dumpPath);
+
+        $dumpJson = file_get_contents($dumpPath);
+        $schemas = json_decode($dumpJson, true);
+        $definition = json_encode(
+            $schemas['definitions'][$schemaName]
+        );
+        $this->inspector->validate(
+            $this->getJson(),
+            new JsonSchema(
+                $definition
+            )
+        );
+    }
+    /**
+     *
+     * Checks, that response JSON not matches with a swagger dump
+     *
+     * @Then the JSON should not be valid according to swagger :dumpPath dump schema :schemaName
+     */
+    public function theJsonShouldNotBeValidAccordingToTheSwaggerSchema($dumpPath, $schemaName)
+    {
+        try {
+            $this->theJsonShouldBeValidAccordingToTheSwaggerSchema($dumpPath, $schemaName);
+        } catch (\Exception $e) {
+            return;
+        }
+
+        throw new \RuntimeException('JSON Schema matches but it should not');
+    }
+
     protected function getJson()
     {
         return new Json($this->httpCallResultPool->getResult()->getValue());

tests/features/json.feature

@@ -1,3 +1,5 @@
+@JSON
+
 Feature: Testing JSONContext
 
     Scenario: Am I a JSON ?
@@ -186,3 +188,13 @@ Feature: Testing JSONContext
         And the JSON node "four" should be equal to the string "foo"
         And the JSON node "five" should not be null
         And the JSON node "five" should be equal to the number 5
+
+    Scenario: Json validation against swagger dump file
+        Given I am on "/json/swaggerpartial.json"
+        Then the response should be in JSON
+        And the JSON should be valid according to swagger "tests/fixtures/www/json/swagger.json" dump schema "sample-definition"
+
+    Scenario: Json validation against swagger dump file
+        Given I am on "/json/swaggerpartial.json"
+        Then the response should be in JSON
+        And the JSON should not be valid according to swagger "tests/fixtures/www/json/swagger.json" dump schema "sample-invalid-definition"

tests/fixtures/www/json/swagger.json

@@ -0,0 +1,56 @@
+{
+    "swagger": "2.0",
+    "basePath": "\/",
+    "info": {
+        "title": "Sample API",
+        "version": "2.0.0",
+        "description": "Sample API"
+    },
+    "paths": {
+        "\/a\/path": {
+            "get": {
+                "tags": [
+                    "sample"
+                ],
+                "operationId": "sampleId",
+                "produces": [
+                    "application\/json",
+                    "text\/html"
+                ],
+                "summary": "Just a fixture sample endpoint",
+                "responses": {},
+                "parameters": []
+            }
+        }
+    },
+    "definitions": {
+        "sample-invalid-definition": {
+            "type": "object",
+            "description": "",
+            "properties": {
+                "stringValue": {
+                    "readOnly": true,
+                    "type": "integer"
+                },
+                "intValue": {
+                    "readOnly": true,
+                    "type": "integer"
+                }
+            }
+        },
+        "sample-definition": {
+            "type": "object",
+            "description": "",
+            "properties": {
+                "stringValue": {
+                    "readOnly": true,
+                    "type": "string"
+                },
+                "intValue": {
+                    "readOnly": true,
+                    "type": "integer"
+                }
+            }
+        }
+    }
+}

tests/fixtures/www/json/swaggerpartial.json

@@ -0,0 +1,4 @@
+{
+    "stringValue": "value",
+    "intValue": 7
+}