symfony · alexandre-daubois · Mar 29, 2025
diff --git a/src/Symfony/Component/JsonPath/Test/JsonPathAssertionsTrait.php b/src/Symfony/Component/JsonPath/Test/JsonPathAssertionsTrait.php
@@ -0,0 +1,80 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonPath\Test;
+
+use PHPUnit\Framework\Assert;
+use PHPUnit\Framework\ExpectationFailedException;
+use Symfony\Component\JsonPath\JsonPath;
+
+/**
+ * @author Alexandre Daubois <alex.daubois@gmail.com>
+ *
+ * @experimental
+ */
+trait JsonPathAssertionsTrait
+{
+    /**
+     * @throws ExpectationFailedException
+     */
+    final public static function assertJsonPathEquals(mixed $expectedValue, JsonPath|string $jsonPath, string $json, string $message = ''): void
+    {
+        Assert::assertThat($expectedValue, new JsonPathEquals($jsonPath, $json), $message);
+    }
+
+    /**
+     * @throws ExpectationFailedException
+     */
+    final public static function assertJsonPathNotEquals(mixed $expectedValue, JsonPath|string $jsonPath, string $json, string $message = ''): void
+    {
+        Assert::assertThat($expectedValue, new JsonPathNotEquals($jsonPath, $json), $message);
+    }
+
+    /**
+     * @throws ExpectationFailedException
+     */
+    final public static function assertJsonPathCount(int $expectedCount, JsonPath|string $jsonPath, string $json, string $message = ''): void
+    {
+        Assert::assertThat($expectedCount, new JsonPathCount($jsonPath, $json), $message);
+    }
+
+    /**
+     * @throws ExpectationFailedException
+     */
+    final public static function assertJsonPathSame(mixed $expectedValue, JsonPath|string $jsonPath, string $json, string $message = ''): void
+    {
+        Assert::assertThat($expectedValue, new JsonPathSame($jsonPath, $json), $message);
+    }
+
+    /**
+     * @throws ExpectationFailedException
+     */
+    final public static function assertJsonPathNotSame(mixed $expectedValue, JsonPath|string $jsonPath, string $json, string $message = ''): void
+    {
+        Assert::assertThat($expectedValue, new JsonPathNotSame($jsonPath, $json), $message);
+    }
+
+    /**
+     * @throws ExpectationFailedException
+     */
+    final public static function assertJsonPathContains(mixed $expectedValue, JsonPath|string $jsonPath, string $json, bool $strict = true, string $message = ''): void
+    {
+        Assert::assertThat($expectedValue, new JsonPathContains($jsonPath, $json, $strict), $message);
+    }
+
+    /**
+     * @throws ExpectationFailedException
+     */
+    final public static function assertJsonPathNotContains(mixed $expectedValue, JsonPath|string $jsonPath, string $json, bool $strict = true, string $message = ''): void
+    {
+        Assert::assertThat($expectedValue, new JsonPathNotContains($jsonPath, $json, $strict), $message);
+    }
+}
diff --git a/src/Symfony/Component/JsonPath/Test/JsonPathContains.php b/src/Symfony/Component/JsonPath/Test/JsonPathContains.php
@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonPath\Test;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\JsonPath\JsonCrawler;
+use Symfony\Component\JsonPath\JsonPath;
+
+/**
+ * @author Alexandre Daubois <alex.daubois@gmail.com>
+ *
+ * @experimental
+ */
+class JsonPathContains extends Constraint
+{
+    public function __construct(
+        private JsonPath|string $jsonPath,
+        private string $json,
+        private bool $strict = true,
+    ) {
+    }
+
+    public function toString(): string
+    {
+        return \sprintf('is found in elements at JSON path "%s"', $this->jsonPath);
+    }
+
+    protected function matches(mixed $other): bool
+    {
+        $result = (new JsonCrawler($this->json))->find($this->jsonPath);
+
+        return \in_array($other, $result, $this->strict);
+    }
+}
diff --git a/src/Symfony/Component/JsonPath/Test/JsonPathCount.php b/src/Symfony/Component/JsonPath/Test/JsonPathCount.php
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonPath\Test;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\JsonPath\JsonCrawler;
+use Symfony\Component\JsonPath\JsonPath;
+
+/**
+ * @author Alexandre Daubois <alex.daubois@gmail.com>
+ *
+ * @experimental
+ */
+class JsonPathCount extends Constraint
+{
+    public function __construct(
+        private JsonPath|string $jsonPath,
+        private string $json,
+    ) {
+    }
+
+    public function toString(): string
+    {
+        return \sprintf('matches expected count of JSON path "%s"', $this->jsonPath);
+    }
+
+    protected function matches(mixed $other): bool
+    {
+        return $other === \count((new JsonCrawler($this->json))->find($this->jsonPath));
+    }
+}
diff --git a/src/Symfony/Component/JsonPath/Test/JsonPathEquals.php b/src/Symfony/Component/JsonPath/Test/JsonPathEquals.php
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonPath\Test;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\JsonPath\JsonCrawler;
+use Symfony\Component\JsonPath\JsonPath;
+
+/**
+ * @author Alexandre Daubois <alex.daubois@gmail.com>
+ *
+ * @experimental
+ */
+class JsonPathEquals extends Constraint
+{
+    public function __construct(
+        private JsonPath|string $jsonPath,
+        private string $json,
+    ) {
+    }
+
+    public function toString(): string
+    {
+        return \sprintf('equals JSON path "%s" result', $this->jsonPath);
+    }
+
+    protected function matches(mixed $other): bool
+    {
+        return (new JsonCrawler($this->json))->find($this->jsonPath) == $other;
+    }
+}
diff --git a/src/Symfony/Component/JsonPath/Test/JsonPathNotContains.php b/src/Symfony/Component/JsonPath/Test/JsonPathNotContains.php
@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonPath\Test;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\JsonPath\JsonCrawler;
+use Symfony\Component\JsonPath\JsonPath;
+
+/**
+ * @author Alexandre Daubois <alex.daubois@gmail.com>
+ *
+ * @experimental
+ */
+class JsonPathNotContains extends Constraint
+{
+    public function __construct(
+        private JsonPath|string $jsonPath,
+        private string $json,
+        private bool $strict = true,
+    ) {
+    }
+
+    public function toString(): string
+    {
+        return \sprintf('is not found in elements at JSON path "%s"', $this->jsonPath);
+    }
+
+    protected function matches(mixed $other): bool
+    {
+        $result = (new JsonCrawler($this->json))->find($this->jsonPath);
+
+        return !\in_array($other, $result, $this->strict);
+    }
+}
diff --git a/src/Symfony/Component/JsonPath/Test/JsonPathNotEquals.php b/src/Symfony/Component/JsonPath/Test/JsonPathNotEquals.php
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonPath\Test;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\JsonPath\JsonCrawler;
+use Symfony\Component\JsonPath\JsonPath;
+
+/**
+ * @author Alexandre Daubois <alex.daubois@gmail.com>
+ *
+ * @experimental
+ */
+class JsonPathNotEquals extends Constraint
+{
+    public function __construct(
+        private JsonPath|string $jsonPath,
+        private string $json,
+    ) {
+    }
+
+    public function toString(): string
+    {
+        return \sprintf('does not equal JSON path "%s" result', $this->jsonPath);
+    }
+
+    protected function matches(mixed $other): bool
+    {
+        return (new JsonCrawler($this->json))->find($this->jsonPath) != $other;
+    }
+}
diff --git a/src/Symfony/Component/JsonPath/Test/JsonPathNotSame.php b/src/Symfony/Component/JsonPath/Test/JsonPathNotSame.php
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonPath\Test;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\JsonPath\JsonCrawler;
+use Symfony\Component\JsonPath\JsonPath;
+
+/**
+ * @author Alexandre Daubois <alex.daubois@gmail.com>
+ *
+ * @experimental
+ */
+class JsonPathNotSame extends Constraint
+{
+    public function __construct(
+        private JsonPath|string $jsonPath,
+        private string $json,
+    ) {
+    }
+
+    public function toString(): string
+    {
+        return \sprintf('is not identical to JSON path "%s" result', $this->jsonPath);
+    }
+
+    protected function matches(mixed $other): bool
+    {
+        return (new JsonCrawler($this->json))->find($this->jsonPath) !== $other;
+    }
+}
diff --git a/src/Symfony/Component/JsonPath/Test/JsonPathSame.php b/src/Symfony/Component/JsonPath/Test/JsonPathSame.php
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonPath\Test;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\JsonPath\JsonCrawler;
+use Symfony\Component\JsonPath\JsonPath;
+
+/**
+ * @author Alexandre Daubois <alex.daubois@gmail.com>
+ *
+ * @experimental
+ */
+class JsonPathSame extends Constraint
+{
+    public function __construct(
+        private JsonPath|string $jsonPath,
+        private string $json,
+    ) {
+    }
+
+    public function toString(): string
+    {
+        return \sprintf('is identical to JSON path "%s" result', $this->jsonPath);
+    }
+
+    protected function matches(mixed $other): bool
+    {
+        return (new JsonCrawler($this->json))->find($this->jsonPath) === $other;
+    }
+}