add json schema

Author: Nyholm

Resources/errors.schema.json

@@ -0,0 +1,66 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/Roave/BackwardCompatibilityCheck/tree/8.10.x/Resources/errors.schema.json",
+  "title": "Backward Compatibility Errors",
+  "description": "A list of errors",
+  "required": [
+    "errors"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "errors": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/Error"
+      }
+    }
+  },
+  "definitions": {
+    "Error": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "description": {
+          "type": "string"
+        },
+        "path": {
+          "anyOf": [
+            {
+              "type": "null"
+            },
+            {
+              "type": "string"
+            }
+          ]
+        },
+        "line": {
+          "anyOf": [
+            {
+              "type": "integer"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "column": {
+          "anyOf": [
+            {
+              "type": "integer"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "required": [
+        "column",
+        "description",
+        "line",
+        "path"
+      ],
+      "title": "Error"
+    }
+  }
+}

composer.json

@@ -24,6 +24,7 @@
     ],
     "require-dev": {
         "doctrine/coding-standard": "^12.0.0",
+        "estahn/phpunit-json-assertions": "^4.0",
         "php-standard-library/psalm-plugin": "^2.3.0",
         "phpunit/phpunit": "^9.6.19",
         "psalm/plugin-phpunit": "^0.19.0",

composer.lock

@@ -8,7 +8,7 @@
 use Roave\BackwardCompatibility\Changes;
 use Roave\BackwardCompatibility\Git\CheckedOutRepository;
 use Symfony\Component\Console\Output\OutputInterface;
-
+use function json_encode;
 
 /** @internal */
 final class JsonFormatter implements OutputFormatter

src/Formatter/JsonFormatter.php

@@ -4,6 +4,7 @@
 
 namespace RoaveTest\BackwardCompatibility\Formatter;
 
+use EnricoStahn\JsonAssert\AssertClass as JsonAssert;
 use PHPUnit\Framework\TestCase;
 use Psl\Env;
 use Psl\Filesystem;
@@ -13,7 +14,6 @@
 use Roave\BackwardCompatibility\Formatter\JsonFormatter;
 use Roave\BackwardCompatibility\Git\CheckedOutRepository;
 use Symfony\Component\Console\Output\BufferedOutput;
-use function Psl\Filesystem;
 
 /** @covers \Roave\BackwardCompatibility\Formatter\JsonFormatter */
 final class JsonFormatterTest extends TestCase
@@ -56,30 +56,32 @@ public function testWrite(): void
 
         $expected = [
             'errors' => [
-                ['description' => 'foo', 'path'=>null, 'line'=>null, 'column'=>null],
-                ['description' => 'bar', 'path'=>null, 'line'=>null, 'column'=>null],
-                ['description' => 'baz', 'path' => 'baz-file.php', 'line'=>null, 'column'=>null],
-                ['description' => 'tab', 'path' => 'tab-file.php', 'line'=>5, 'column'=>null],
-                ['description' => 'taz', 'path' => 'taz-file.php', 'line'=>6, 'column'=>15],
-                ['description' => 'tar', 'path' => 'tar-file.php', 'line'=>-1, 'column'=>-1],
-                ['description' => 'file-in-checked-out-dir', 'path' => 'subpath/file-in-checked-out-dir.php', 'line'=>10, 'column'=>20],
+                ['description' => 'foo', 'path' => null, 'line' => null, 'column' => null],
+                ['description' => 'bar', 'path' => null, 'line' => null, 'column' => null],
+                ['description' => 'baz', 'path' => 'baz-file.php', 'line' => null, 'column' => null],
+                ['description' => 'tab', 'path' => 'tab-file.php', 'line' => 5, 'column' => null],
+                ['description' => 'taz', 'path' => 'taz-file.php', 'line' => 6, 'column' => 15],
+                ['description' => 'tar', 'path' => 'tar-file.php', 'line' => -1, 'column' => -1],
+                ['description' => 'file-in-checked-out-dir', 'path' => 'subpath/file-in-checked-out-dir.php', 'line' => 10, 'column' => 20],
             ]
         ];
 
-        $result = $output->fetch();
-        self::assertJson($result);
+        $json = $output->fetch();
+        self::assertJson($json);
 
-        $data = json_decode(trim($result), true);
+        $data = json_decode(trim($json), true);
         self::assertIsArray($data);
         self::assertEquals($expected, $data);
 
+        JsonAssert::assertJsonMatchesSchema($json, dirname(__DIR__, 3).'/Resources/errors.schema.json');
+
         self::assertJsonStringEqualsJsonString(
             <<<'OUTPUT'
 {"errors":[{"description":"foo","path":null,"line":null,"column":null},{"description":"bar","path":null,"line":null,"column":null},{"description":"baz","path":"baz-file.php","line":null,"column":null},{"description":"tab","path":"tab-file.php","line":5,"column":null},{"description":"taz","path":"taz-file.php","line":6,"column":15},{"description":"tar","path":"tar-file.php","line":-1,"column":-1},{"description":"file-in-checked-out-dir","path":"subpath\/file-in-checked-out-dir.php","line":10,"column":20}]}
 
 OUTPUT
             ,
-            $result,
+            $json,
         );
     }
 }