Add Symfony response assertion trait (#11)

New assertion trait with assertJsonResponse

checks response content is not false + decodes to expected array

composer.json

@@ -38,6 +38,7 @@
         "fix": "@fix:phpcbf",
         "fix:phpcbf": "phpcbf src tests",
         "test": "phpunit",
+        "test:unit": "phpunit --testsuite unit",
         "test:integration": "phpunit --testsuite integration"
     },
     "suggest": {

phpunit.xml.dist

@@ -11,6 +11,9 @@
         <testsuite name="integration">
             <directory>tests/Integration</directory>
         </testsuite>
+        <testsuite name="unit">
+            <directory>tests/Unit</directory>
+        </testsuite>
     </testsuites>
     <source>
         <include>

phpunit9.xml.dist

@@ -14,6 +14,9 @@
         <testsuite name="integration">
             <directory>tests/Integration</directory>
         </testsuite>
+        <testsuite name="unit">
+            <directory>tests/Unit</directory>
+        </testsuite>
     </testsuites>
     <coverage>
         <include>

src/Symfony/ResponseAssertions.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DR\PHPUnitExtensions\Symfony;
+
+use PHPUnit\Framework\Assert;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
+
+trait ResponseAssertions
+{
+    /**
+     * @param mixed[] $expected
+     */
+    protected static function assertJsonResponse(array $expected, JsonResponse $response): void
+    {
+        Assert::assertNotFalse($response->getContent());
+
+        $content = json_decode($response->getContent(), true);
+        Assert::assertSame($expected, $content);
+    }
+}

tests/Integration/Symfony/Controller/GenerateUrlControllerTest.php

@@ -5,6 +5,7 @@
 namespace DR\PHPUnitExtensions\Tests\Integration\Symfony\Controller;
 
 use DR\PHPUnitExtensions\Symfony\AbstractControllerTestCase;
+use DR\PHPUnitExtensions\Symfony\ResponseAssertions;
 use DR\PHPUnitExtensions\Tests\Resources\Symfony\Controller\GenerateUrlController;
 
 /**
@@ -13,16 +14,18 @@
  */
 class GenerateUrlControllerTest extends AbstractControllerTestCase
 {
+    use ResponseAssertions;
+
     public function testSingleGenerate(): void
     {
         $this->expectGenerateUrl("first_route")->willReturn('first_url');
-        static::assertSame('{"url":"first_url"}', ($this->controller)()->getContent());
+        static::assertJsonResponse(["url" => "first_url"], ($this->controller)());
     }
 
     public function testMultiGenerate(): void
     {
         $this->expectGenerateUrlWithConsecutive(["first_route"], ["second_route"])->willReturnOnConsecutiveCalls('first_url', 'second_url');
-        static::assertSame('{"first":"first_url","second":"second_url"}', ($this->controller)(true)->getContent());
+        static::assertJsonResponse(["first" => "first_url", "second" => "second_url"], ($this->controller)(true));
     }
 
     public function getController(): GenerateUrlController

tests/Resources/Symfony/Controller/GenerateUrlController.php

@@ -6,11 +6,10 @@
 
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\JsonResponse;
-use Symfony\Component\HttpFoundation\Response;
 
 class GenerateUrlController extends AbstractController
 {
-    public function __invoke(bool $multi = false): Response
+    public function __invoke(bool $multi = false): JsonResponse
     {
         if ($multi) {
             return new JsonResponse(

tests/Unit/Symfony/ResponseAssertionsTest.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DR\PHPUnitExtensions\Tests\Unit\Symfony;
+
+use DR\PHPUnitExtensions\Symfony\ResponseAssertions;
+use PHPUnit\Framework\AssertionFailedError;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\JsonResponse;
+
+/**
+ * @covers \DR\PHPUnitExtensions\Symfony\ResponseAssertions
+ */
+class ResponseAssertionsTest extends TestCase
+{
+    use ResponseAssertions;
+
+    public function testAssertJsonResponse(): void
+    {
+        $expected = ['foo' => 'bar'];
+        $response = new JsonResponse($expected);
+
+        self::assertJsonResponse($expected, $response);
+    }
+
+    public function testAssertJsonResponseFails(): void
+    {
+        $expected = ['foo' => 'bar'];
+        $response = new JsonResponse(['bar' => 'foo']);
+
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage('Failed asserting that two arrays are identical.');
+        self::assertJsonResponse($expected, $response);
+    }
+
+    public function testAssertJsonResponseFalse(): void
+    {
+        $expected = ['foo' => 'bar'];
+        $response = new JsonResponse(false);
+
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage('Failed asserting that false is identical to Array');
+        self::assertJsonResponse($expected, $response);
+    }
+}