Adding a trait for Symfony WebTestCase

Author: Florian Krämer

src/OpenAPISymfonySchemaValidator.php renamed to src/Symfony/OpenAPISymfonySchemaValidator.php

@@ -2,9 +2,10 @@
 
 declare(strict_types=1);
 
-namespace Phauthentic\PHPUnit\OpenAPIValidator;
+namespace Phauthentic\PHPUnit\OpenAPIValidator\Symfony;
 
 use Nyholm\Psr7\Factory\Psr17Factory;
+use Phauthentic\PHPUnit\OpenAPIValidator\OpenAPISchemaValidator;
 use Psr\Http\Message\RequestInterface as PsrRequestInterface;
 use Psr\Http\Message\ResponseInterface as PsrResponseInterface;
 use Symfony\Bridge\PsrHttpMessage\Factory\PsrHttpFactory;

src/Symfony/OpenAPIValidatorSymfonyTrait.php

@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phauthentic\PHPUnit\OpenAPIValidator\Symfony;
+
+use Phauthentic\PHPUnit\OpenAPIValidator\OpenAPISchemaValidationFailedException;
+use Phauthentic\PHPUnit\OpenAPIValidator\OpenAPISchemaValidatorInterface;
+use PHPUnit\Framework\Exception;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use RuntimeException;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+
+/**
+ * @phpstan-ignore-next-line
+ */
+trait OpenAPIValidatorSymfonyTrait
+{
+    protected static ?OpenAPISymfonySchemaValidator $openAPISchemaValidator;
+
+    protected static function getOpenAPISchemaValidator(): OpenAPISchemaValidatorInterface
+    {
+        if (null === self::$openAPISchemaValidator) {
+            throw new Exception(
+                'OpenAPISchemaValidator is not set. '
+                . 'Call self::setOpenAPISchemaValidator() before using this method.'
+            );
+        }
+
+        return self::$openAPISchemaValidator;
+    }
+
+    protected static function setOpenAPISchemaValidator(OpenAPISymfonySchemaValidator $validator): void
+    {
+        self::$openAPISchemaValidator = $validator;
+    }
+
+    protected static function assertRequestMatchesOpenAPISchema(?RequestInterface $request = null): void
+    {
+        if (null === $request) {
+            self::assertWebTestCase();
+            $request = self::getClient()->getRequest();
+        }
+
+        try {
+            self::getOpenAPISchemaValidator()->validateRequest($request);
+        } catch (OpenAPISchemaValidationFailedException $exception) {
+            self::fail('OpenAPI request validation failed: ' . $exception->getMessage());
+        }
+    }
+
+    protected static function assertResponseMatchesOpenAPISchema(
+        ?ResponseInterface $response,
+        string $path,
+        string $method,
+    ): void {
+        if (null === $response) {
+            self::assertWebTestCase();
+            $response = self::getClient()->getResponse();
+        }
+
+        try {
+            self::getOpenAPISchemaValidator()->validateResponse(
+                response: $response,
+                path: $path,
+                method: $method
+            );
+        } catch (OpenAPISchemaValidationFailedException $exception) {
+            self::fail('OpenAPI response validation failed: ' . $exception->getMessage());
+        }
+    }
+
+    private static function assertWebTestCase(): void
+    {
+        if (!is_subclass_of(static::class, WebTestCase::class)) {
+            throw new RuntimeException(
+                'OpenAPIValidatorSymfonyTrait can only be used in a class that extends '
+                . 'Symfony\Bundle\FrameworkBundle\Test\WebTestCase.'
+            );
+        }
+    }
+}

tests/OpenAPISymfonySchemaValidatorTest.php

@@ -4,10 +4,10 @@
 
 namespace Phauthentic\PHPUnit\OpenAPIValidator\Tests;
 
+use Phauthentic\PHPUnit\OpenAPIValidator\OpenAPISchemaValidationFailedException;
+use Phauthentic\PHPUnit\OpenAPIValidator\Symfony\OpenAPISymfonySchemaValidator;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
-use Phauthentic\PHPUnit\OpenAPIValidator\OpenAPISchemaValidationFailedException;
-use Phauthentic\PHPUnit\OpenAPIValidator\OpenAPISymfonySchemaValidator;
 use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
 use Symfony\Component\HttpFoundation\Response as SymfonyResponse;