Request/Response validation

sirn-se · Oct 2, 2022 · afb7dfd · afb7dfd
1 parent 9135517
commit afb7dfd
Show file tree

Hide file tree

Showing 9 changed files with 108 additions and 19 deletions.
diff --git a/composer.json b/composer.json
@@ -32,14 +32,10 @@
     "slim/slim": "^4.0"
   },
   "require-dev": {
-    "phpstan/phpstan": "^1.8",
     "phpunit/phpunit": "^9.0",
     "php-coveralls/php-coveralls": "^2.0",
     "php-di/php-di": "^6.0",
     "slim/psr7": "^1.0",
     "squizlabs/php_codesniffer": "^3.0"
-  },
-  "suggests": {
-    "league/openapi-psr7-validator": "Provides validation of http request/response"
   }
 }
diff --git a/src/Phrity/Slim/OpenApi.php b/src/Phrity/Slim/OpenApi.php
@@ -39,7 +39,7 @@ class OpenApi implements IteratorAggregate
 
     /**
      * Constructor for Slim OpenApi route generator.
-     * @param OpenApiSpec|string $source        File path to OpenApi schema or OpenApi instance
+     * @param OpenApiSpec|string $source    File path to OpenApi schema or OpenApi instance
      * @param array<string,mixed> $settings Optional settings
      */
     public function __construct($source, array $settings = [])
@@ -77,7 +77,7 @@ public function getIterator(): Traversable
 
     /**
      * Register routes on Slim App.
-     * @param \Slim\App $app                Slim App instance to register routes on
+     * @param App $app                      Slim App instance to register routes on
      */
     public function route(App $app): void
     {
@@ -96,16 +96,28 @@ public function getSetting(string $key)
         return isset($this->settings->$key) ? $this->settings->$key : null;
     }
 
+    /**
+     * Get request validator.
+     * @return RoutedServerRequestValidator Validator
+     */
     public function getRequestValidator(): RoutedServerRequestValidator
     {
         return $this->getValidatorBuilder()->getRoutedRequestValidator();
     }
 
+    /**
+     * Get response validator.
+     * @return ResponseValidator            Validator
+     */
     public function getResponseValidator(): ResponseValidator
     {
         return $this->getValidatorBuilder()->getResponseValidator();
     }
 
+    /**
+     * Get validator builder.
+     * @return ValidatorBuilder             Builder
+     */
     private function getValidatorBuilder(): ValidatorBuilder
     {
         if (empty($this->validation_builder)) {

diff --git a/src/Phrity/Slim/Route.php b/src/Phrity/Slim/Route.php
@@ -45,7 +45,7 @@ public function __construct(OpenApi $openapi, string $path, string $method, Oper
 
     /**
      * Get string representation of route.
-     * @return string           String representation of route
+     * @return string               String representation of route
      */
     public function __toString(): string
     {
@@ -54,7 +54,7 @@ public function __toString(): string
 
     /**
      * Register route on Slim App.
-     * @param \Slim\App $app    Slim App instance to register routes on
+     * @param App $app              Slim App instance to register routes on
      */
     public function route(App $app): void
     {
@@ -80,6 +80,10 @@ public function route(App $app): void
         }
     }
 
+    /**
+     * Validate a request.
+     * @param Request $request      Server request message
+     */
     public function validateRequest(Request $request): void
     {
         $this->openapi->getRequestValidator()->validate(
@@ -88,6 +92,10 @@ public function validateRequest(Request $request): void
         );
     }
 
+    /**
+     * Validate a response.
+     * @param Response $response     Response message
+     */
     public function validateResponse(Response $response): void
     {
         $this->openapi->getResponseValidator()->validate(

diff --git a/tests/ControllerTest.php b/tests/ControllerTest.php
@@ -26,9 +26,8 @@ public function setUp(): void
         error_reporting(-1);
     }
 
-    // Test a simple schema with paths
     /**
-     *
+     * Test a simple schema with paths
      */
     public function testRoutesStrict(): void
     {

diff --git a/tests/RoutingTest.php b/tests/RoutingTest.php
@@ -89,6 +89,9 @@ public function testRoutingNoRoute(): void
         $response = $slim->handle($request);
     }
 
+    /**
+     * Test Slim routing using standard array argument
+     */
     public function testRequestResponse(): void
     {
         $slim = AppFactory::create();
@@ -104,6 +107,9 @@ public function testRequestResponse(): void
         $this->assertEquals("MyController::argument=something,else", $response->getBody()->__toString());
     }
 
+    /**
+     * Test Slim routing using listed arguments
+     */
     public function testRequestResponseArgs(): void
     {
         $slim = AppFactory::create();
@@ -120,6 +126,9 @@ public function testRequestResponseArgs(): void
         $this->assertEquals("MyController::arguments=something,else", $response->getBody()->__toString());
     }
 
+    /**
+     * Test Slim routing using container instance for mapping
+     */
     public function testContainer(): void
     {
         $container = new Container();
@@ -135,6 +144,9 @@ public function testContainer(): void
         $this->assertEquals("ContainerController::byContainer", $response->getBody()->__toString());
     }
 
+    /**
+     * Test binding Route to request
+     */
     public function testRouteBind(): void
     {
         $slim = AppFactory::create();

diff --git a/tests/classes/Phrity/Slim/FactoryTrait.php b/tests/classes/Phrity/Slim/FactoryTrait.php
@@ -1,20 +1,45 @@
 <?php
 
+/**
+ * File for Slim OpenApi tests
+ * @package Phrity > Slim > OpenApi
+ */
+
+declare(strict_types=1);
+
 namespace Phrity\Slim;
 
+use Psr\Http\Message\{
+    ServerRequestInterface,
+    StreamInterface
+};
 use Slim\Psr7\Factory\{
     ServerRequestFactory,
     StreamFactory,
 };
 
+/**
+ * Slim OpenApi test helper
+ */
 trait FactoryTrait
 {
-    private static function createStream(string $data)
+    /**
+     * Create a stream.
+     * @param string $data                  Data to write on stream
+     * @return StreamInterface              A stream
+     */
+    private static function createStream(string $data): StreamInterface
     {
         return (new StreamFactory())->createStream($data);
     }
 
-    private static function createServerRequest(string $method, string $path)
+    /**
+     * Create a server request.
+     * @param string $method                HTTP method
+     * @param string $path                  Request path
+     * @return StreamInterface              A server request
+     */
+    private static function createServerRequest(string $method, string $path): ServerRequestInterface
     {
         return (new ServerRequestFactory())->createServerRequest($method, $path);
     }

diff --git a/tests/classes/Test/ContainerController.php b/tests/classes/Test/ContainerController.php
@@ -1,5 +1,12 @@
 <?php
 
+/**
+ * File for Slim OpenApi tests
+ * @package Phrity > Slim > OpenApi
+ */
+
+declare(strict_types=1);
+
 namespace Test;
 
 use Psr\Container\ContainerInterface;
@@ -8,6 +15,9 @@
     ResponseInterface as Response
 };
 
+/**
+ * Slim OpenApi test controller
+ */
 class ContainerController
 {
     private ContainerInterface $container;

diff --git a/tests/classes/Test/MyController.php b/tests/classes/Test/MyController.php
@@ -1,12 +1,22 @@
 <?php
 
+/**
+ * File for Slim OpenApi tests
+ * @package Phrity > Slim > OpenApi
+ */
+
+declare(strict_types=1);
+
 namespace Test;
 
 use Psr\Http\Message\{
     ServerRequestInterface as Request,
     ResponseInterface as Response
 };
 
+/**
+ * Slim OpenApi test controller
+ */
 class MyController
 {
     /**
@@ -16,7 +26,7 @@ class MyController
      * @param array<string,mixed> $arguments
      * @return Response
      */
-    public function put(Request $request, Response $response, array $arguments)
+    public function put(Request $request, Response $response, array $arguments): Response
     {
         $response->getBody()->write("MyController::put");
         return $response;
@@ -29,7 +39,7 @@ public function put(Request $request, Response $response, array $arguments)
      * @param array<string,mixed> $arguments
      * @return Response
      */
-    public function __invoke(Request $request, Response $response, array $arguments)
+    public function __invoke(Request $request, Response $response, array $arguments): Response
     {
         $response->getBody()->write("MyController::__invoke");
         return $response;
@@ -42,7 +52,7 @@ public function __invoke(Request $request, Response $response, array $arguments)
      * @param array<string,string> $arguments
      * @return Response
      */
-    public function argument(Request $request, Response $response, array $arguments)
+    public function argument(Request $request, Response $response, array $arguments): Response
     {
         $response->getBody()->write("MyController::argument={$arguments['arg_1']},{$arguments['arg_2']}");
         return $response;
@@ -56,7 +66,7 @@ public function argument(Request $request, Response $response, array $arguments)
      * @param string $arg_2
      * @return Response
      */
-    public function arguments(Request $request, Response $response, string $arg_1, string $arg_2)
+    public function arguments(Request $request, Response $response, string $arg_1, string $arg_2): Response
     {
         $response->getBody()->write("MyController::arguments={$arg_1},{$arg_2}");
         return $response;
@@ -69,7 +79,7 @@ public function arguments(Request $request, Response $response, string $arg_1, s
      * @param array<string,string> $arguments
      * @return Response
      */
-    public function bind(Request $request, Response $response, array $arguments)
+    public function bind(Request $request, Response $response, array $arguments): Response
     {
         $route = $request->getAttribute('openapi-route');
         $response->getBody()->write("MyController::bind={$route}");

diff --git a/tests/classes/Test/ValidatingController.php b/tests/classes/Test/ValidatingController.php
@@ -1,5 +1,12 @@
 <?php
 
+/**
+ * File for Slim OpenApi tests
+ * @package Phrity > Slim > OpenApi
+ */
+
+declare(strict_types=1);
+
 namespace Test;
 
 use Phrity\Slim\FactoryTrait;
@@ -8,6 +15,9 @@
     ResponseInterface as Response
 };
 
+/**
+ * Slim OpenApi test controller
+ */
 class ValidatingController
 {
     use FactoryTrait;
@@ -19,7 +29,7 @@ class ValidatingController
      * @param array<string,string> $arguments
      * @return Response
      */
-    public function post(Request $request, Response $response, array $arguments)
+    public function post(Request $request, Response $response, array $arguments): Response
     {
         $route = $request->getAttribute('openapi-route');
         $route->validateRequest($request);
@@ -31,7 +41,14 @@ public function post(Request $request, Response $response, array $arguments)
         return $response;
     }
 
-    public function put(Request $request, Response $response, array $arguments)
+    /**
+     * Request method called by Slim.
+     * @param Request $request
+     * @param Response $response
+     * @param array<string,string> $arguments
+     * @return Response
+     */
+    public function put(Request $request, Response $response, array $arguments): Response
     {
         $route = $request->getAttribute('openapi-route');
         $data = json_decode($request->getBody()->__toString());