Test suite was refactored and tests about atomic capabilities of the tested libraries was added as part of the JsonPatchCompliance.php

blancks · blancks · commit 564c34956fb0 · 2024-09-10T01:52:28.000+02:00
diff --git a/tests/Blancks_fast_jsonpatchTest.php b/tests/Blancks_fast_jsonpatchTest.php
@@ -1,10 +1,9 @@
 <?php declare(strict_types=1);
 
 namespace blancks\JsonPatchBenchmarkTests;
-
 use PHPUnit\Framework\Attributes\DataProvider;
 
-class Blancks_fast_jsonpatchTest extends JsonPatchComplianceTest
+class Blancks_fast_jsonpatchTest extends JsonPatchCompliance
 {
     #[DataProvider('validOperationsProvider')]
     public function testJsonPatchCompliance(string $json, string $patch, string $expected): void
@@ -14,4 +13,21 @@ public function testJsonPatchCompliance(string $json, string $patch, string $exp
             \blancks\JsonPatch\FastJsonPatch::apply($json, $patch)
         );
     }
+
+    #[DataProvider('atomicOperationsProvider')]
+    public function testAtomicOperations(string $json, string $patch, string $expected): void
+    {
+        $document = json_decode($json);
+
+        try {
+            \blancks\JsonPatch\FastJsonPatch::applyByReference($document, json_decode($patch));
+        } catch (\Throwable) {
+            // expecting some error
+        }
+
+        $this->assertSame(
+            $this->normalizeJson($expected),
+            $this->normalizeJson(json_encode($document))
+        );
+    }
 }
diff --git a/tests/Gamringer_php_json_patchTest.php b/tests/Gamringer_php_json_patchTest.php
@@ -4,7 +4,7 @@
 
 use PHPUnit\Framework\Attributes\DataProvider;
 
-class Gamringer_php_json_patchTest extends JsonPatchComplianceTest
+class Gamringer_php_json_patchTest extends JsonPatchCompliance
 {
     #[DataProvider('validOperationsProvider')]
     public function testJsonPatchCompliance(string $json, string $patch, string $expected): void
@@ -18,4 +18,22 @@ public function testJsonPatchCompliance(string $json, string $patch, string $exp
             $this->normalizeJson(json_encode($document))
         );
     }
+
+    #[DataProvider('atomicOperationsProvider')]
+    public function testAtomicOperations(string $json, string $patch, string $expected): void
+    {
+        $document = json_decode($json);
+
+        try {
+            $Patch = \gamringer\JSONPatch\Patch::fromJSON($patch);
+            $Patch->apply($document);
+        } catch (\Throwable) {
+            // expecting some error
+        }
+
+        $this->assertSame(
+            $this->normalizeJson($expected),
+            $this->normalizeJson(json_encode($document))
+        );
+    }
 }
diff --git a/tests/JsonPatchCompliance.php b/tests/JsonPatchCompliance.php
@@ -4,31 +4,93 @@
 
 use PHPUnit\Framework\TestCase;
 
-abstract class JsonPatchComplianceTest extends TestCase
+abstract class JsonPatchCompliance extends TestCase
 {
+    public static function atomicOperationsProvider(): array
+    {
+        return [
+            'Atomic Operations, object: ADD' => [
+                '{"foo":"Hello"}',
+                '[{"op": "add", "path": "/bar", "value": "World"}, {"op": "test", "path": "/a", "value": ""}]',
+                '{"foo":"Hello"}',
+            ],
+            'Atomic Operations, object: REPLACE' => [
+                '{"foo":"Hello"}',
+                '[{"op": "replace", "path": "/foo", "value": "Hello World"}, {"op": "test", "path": "/a", "value": ""}]',
+                '{"foo":"Hello"}',
+            ],
+            'Atomic Operations, object: COPY' => [
+                '{"foo":"Hello"}',
+                '[{"op": "copy", "from": "/foo", "path": "/bar"}, {"op": "test", "path": "/a", "value": ""}]',
+                '{"foo":"Hello"}',
+            ],
+            'Atomic Operations, object: MOVE' => [
+                '{"foo":"Hello"}',
+                '[{"op": "move", "from": "/foo", "path": "/bar"}, {"op": "test", "path": "/a", "value": ""}]',
+                '{"foo":"Hello"}',
+            ],
+            'Atomic Operations, object: REMOVE' => [
+                '{"foo":"Hello"}',
+                '[{"op": "remove", "path": "/foo"}, {"op": "test", "path": "/a", "value": ""}]',
+                '{"foo":"Hello"}',
+            ],
+            'Atomic Operations, array: ADD' => [
+                '[]',
+                '[{"op": "add", "path": "/-", "value": "World"}, {"op": "test", "path": "/a", "value": ""}]',
+                '[]',
+            ],
+            'Atomic Operations, array: REPLACE' => [
+                '["Hello"]',
+                '[{"op": "replace", "path": "/0", "value": "Hello World"}, {"op": "test", "path": "/a", "value": ""}]',
+                '["Hello"]',
+            ],
+            'Atomic Operations, array: COPY' => [
+                '["Hello"]',
+                '[{"op": "copy", "from": "/0", "path": "/1"}, {"op": "test", "path": "/a", "value": ""}]',
+                '["Hello"]',
+            ],
+            'Atomic Operations, array: MOVE' => [
+                '[["Hello"],[]]',
+                '[{"op": "move", "from": "/0/0", "path": "/1/0"}, {"op": "test", "path": "/a", "value": ""}]',
+                '[["Hello"],[]]',
+            ],
+            'Atomic Operations, array: REMOVE' => [
+                '["Hello"]',
+                '[{"op": "remove", "path": "/0"}, {"op": "test", "path": "/a", "value": ""}]',
+                '["Hello"]',
+            ],
+            'Atomic operations, mixed' => [
+                '{"foo":[{"bar":"start"}]}',
+                '[{"op": "add", "path": "/foo/-", "value": "Hello"},
+                {"op": "add", "path": "/foo/0/foobar", "value": "Hello"},
+                {"op": "add", "path": "/foo/0/bar", "value": "World"},
+                {"op": "remove", "path": "/foo/0/foobar"},
+                {"op": "copy", "from": "/foo/0", "path": "/foo/-"},
+                {"op": "replace", "path": "/foo", "value": "Hello World"},
+                {"op": "test", "path": "/bar", "value": "Hello World"}]',
+                '{"foo":[{"bar":"start"}]}'
+            ],
+        ];
+    }
+
     public static function validOperationsProvider(): array
     {
         return [
-            /*
-             * Some classes handles empty patch by throwing an exception.
-             * I'll avoid these test cases to be as fair as possible
-             *
-             * 'Empty patch against empty document' => [
-             *     '{}',
-             *     '[]',
-             *     '{}'
-             * ],
-             * 'Empty patch against non-empty document' => [
-             *     '{"foo": 1}',
-             *     '[]',
-             *     '{"foo": 1}'
-             * ],
-             * 'Empty patch against top-level array document' => [
-             *     '["foo"]',
-             *     '[]',
-             *     '["foo"]'
-             * ],
-             */
+            'Empty patch against empty document' => [
+                '{}',
+                '[]',
+                '{}'
+            ],
+            'Empty patch against non-empty document' => [
+                '{"foo": 1}',
+                '[]',
+                '{"foo": 1}'
+            ],
+            'Empty patch against top-level array document' => [
+                '["foo"]',
+                '[]',
+                '["foo"]'
+            ],
             'Add patch replaces existing value' => [
                 '{"foo": 1}',
                 '[{"op": "add", "path": "/foo", "value": "Hello World"}]',
diff --git a/tests/Mikemccabe_json_patch_phpTest.php b/tests/Mikemccabe_json_patch_phpTest.php
@@ -4,7 +4,7 @@
 
 use PHPUnit\Framework\Attributes\DataProvider;
 
-class Mikemccabe_json_patch_phpTest extends JsonPatchComplianceTest
+class Mikemccabe_json_patch_phpTest extends JsonPatchCompliance
 {
     #[DataProvider('validOperationsProvider')]
     public function testJsonPatchCompliance(string $json, string $patch, string $expected): void
@@ -18,4 +18,22 @@ public function testJsonPatchCompliance(string $json, string $patch, string $exp
             $this->normalizeJson(json_encode($document))
         );
     }
+
+    #[DataProvider('atomicOperationsProvider')]
+    public function testAtomicOperations(string $json, string $patch, string $expected): void
+    {
+        $document = json_decode($json, true);
+        $patch = json_decode($patch, true);
+
+        try {
+            $document = \mikemccabe\JsonPatch\JsonPatch::patch($json, $patch);
+        } catch (\Throwable) {
+            // expecting some error
+        }
+
+        $this->assertSame(
+            $this->normalizeJson($expected),
+            $this->normalizeJson(json_encode($document))
+        );
+    }
 }
diff --git a/tests/Php_jsonpatch_php_jsonpatchTest.php b/tests/Php_jsonpatch_php_jsonpatchTest.php
@@ -4,7 +4,7 @@
 
 use PHPUnit\Framework\Attributes\DataProvider;
 
-class Php_jsonpatch_php_jsonpatchTest extends JsonPatchComplianceTest
+class Php_jsonpatch_php_jsonpatchTest extends JsonPatchCompliance
 {
     #[DataProvider('validOperationsProvider')]
     public function testJsonPatchCompliance(string $json, string $patch, string $expected): void
@@ -17,4 +17,22 @@ public function testJsonPatchCompliance(string $json, string $patch, string $exp
             $this->normalizeJson(json_encode($document))
         );
     }
+
+    #[DataProvider('atomicOperationsProvider')]
+    public function testAtomicOperations(string $json, string $patch, string $expected): void
+    {
+        $document = json_decode($json, true);
+
+        try {
+            $Patch = new \Rs\Json\Patch($json, $patch);
+            $document = json_decode($Patch->apply(), false, 512, JSON_THROW_ON_ERROR);
+        } catch (\Throwable) {
+            // expecting some error
+        }
+
+        $this->assertSame(
+            $this->normalizeJson($expected),
+            $this->normalizeJson(json_encode($document))
+        );
+    }
 }
diff --git a/tests/Remorhaz_php_json_patchTest.php b/tests/Remorhaz_php_json_patchTest.php
@@ -4,7 +4,7 @@
 
 use PHPUnit\Framework\Attributes\DataProvider;
 
-class Remorhaz_php_json_patchTest extends JsonPatchComplianceTest
+class Remorhaz_php_json_patchTest extends JsonPatchCompliance
 {
     #[DataProvider('validOperationsProvider')]
     public function testJsonPatchCompliance(string $json, string $patch, string $expected): void
@@ -24,4 +24,29 @@ public function testJsonPatchCompliance(string $json, string $patch, string $exp
             $this->normalizeJson($documentString)
         );
     }
+
+    #[DataProvider('atomicOperationsProvider')]
+    public function testAtomicOperations(string $json, string $patch, string $expected): void
+    {
+        $documentString = $json;
+
+        try {
+            $encodedValueFactory = \Remorhaz\JSON\Data\Value\EncodedJson\NodeValueFactory::create();
+            $queryFactory = \Remorhaz\JSON\Patch\Query\QueryFactory::create();
+            $processor = \Remorhaz\JSON\Patch\Processor\Processor::create();
+
+            $patch = $encodedValueFactory->createValue($patch);
+            $query = $queryFactory->createQuery($patch);
+            $document = $encodedValueFactory->createValue($json);
+            $result = $processor->apply($query, $document);
+            $documentString = $result->encode();
+        } catch (\Throwable) {
+            // expecting some error
+        }
+
+        $this->assertSame(
+            $this->normalizeJson($expected),
+            $this->normalizeJson($documentString)
+        );
+    }
 }
diff --git a/tests/Swaggest_json_diffTest.php b/tests/Swaggest_json_diffTest.php
@@ -4,7 +4,7 @@
 
 use PHPUnit\Framework\Attributes\DataProvider;
 
-class Swaggest_json_diffTest extends JsonPatchComplianceTest
+class Swaggest_json_diffTest extends JsonPatchCompliance
 {
     #[DataProvider('validOperationsProvider')]
     public function testJsonPatchCompliance(string $json, string $patch, string $expected): void
@@ -19,4 +19,23 @@ public function testJsonPatchCompliance(string $json, string $patch, string $exp
             $this->normalizeJson(json_encode($document))
         );
     }
+
+    #[DataProvider('atomicOperationsProvider')]
+    public function testAtomicOperations(string $json, string $patch, string $expected): void
+    {
+        $document = json_decode($json);
+        $patch = json_decode($patch);
+
+        try {
+            $patch = \Swaggest\JsonDiff\JsonPatch::import($patch);
+            $patch->apply($document);
+        } catch (\Throwable) {
+            // expecting some error
+        }
+
+        $this->assertSame(
+            $this->normalizeJson($expected),
+            $this->normalizeJson(json_encode($document))
+        );
+    }
 }
diff --git a/tests/Xp_forge_json_patchTest.php b/tests/Xp_forge_json_patchTest.php
@@ -4,7 +4,7 @@
 
 use PHPUnit\Framework\Attributes\DataProvider;
 
-class Xp_forge_json_patchTest extends JsonPatchComplianceTest
+class Xp_forge_json_patchTest extends JsonPatchCompliance
 {
     #[DataProvider('validOperationsProvider')]
     public function testJsonPatchCompliance(string $json, string $patch, string $expected): void
@@ -20,4 +20,23 @@ public function testJsonPatchCompliance(string $json, string $patch, string $exp
             $this->normalizeJson(json_encode($document))
         );
     }
+
+    #[DataProvider('atomicOperationsProvider')]
+    public function testAtomicOperations(string $json, string $patch, string $expected): void
+    {
+        $document = json_decode($json, true);
+        $patch = json_decode($patch, true);
+
+        try {
+            $Changes = new \text\json\patch\Changes(...$patch);
+            $document = $Changes->apply($document)->value();
+        } catch (\Throwable) {
+            // expecting some error
+        }
+
+        $this->assertSame(
+            $this->normalizeJson($expected),
+            $this->normalizeJson(json_encode($document))
+        );
+    }
 }
