RouterIntegrationTest::createInvalidResponseFactory() - Code Metrics - Inspection of "Merge pull request #9 from biustudio/patch-1" - divineniiquaye/flight-routing - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 5e779b...23e82e )

by Divine Niiquaye
created 2020-07-04 05:36 UTC
createInvalidResponseFactory() A

↳ Parent: RouterIntegrationTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	4
rs	10
<?php

declare(strict_types=1);

/*
 * This file is part of Flight Routing.
 *
 * PHP version 7.2 and above required
 *
 * @author    Divine Niiquaye Ibok <[email protected]>
 * @copyright 2019 Biurad Group (https://biurad.com/)
 * @license   https://opensource.org/licenses/BSD-3-Clause License
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Flight\Routing\Tests;

use Flight\Routing\Concerns\HttpMethods;
use Flight\Routing\Exceptions\MethodNotAllowedException;
use Flight\Routing\Exceptions\RouteNotFoundException;
use Flight\Routing\Interfaces\RouteCollectorInterface;
use Flight\Routing\Interfaces\RouteGroupInterface;
use Flight\Routing\Interfaces\RouteInterface;
use Flight\Routing\Interfaces\RouterInterface;
use Flight\Routing\Interfaces\RouterProxyInterface;
use Flight\Routing\Route;
use Flight\Routing\RouteCollector;
use Flight\Routing\RouteResults;
use Flight\Routing\Tests\Fixtures\SampleController;
use Flight\Routing\Tests\Fixtures\SampleMiddleware;
use Generator;
use Laminas\Stratigility\Next;
use PHPUnit\Framework\Assert;
use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
use Psr\Container\ContainerInterface;
filter:
    dependency_paths: ["lib/*"]
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;

/**
 * Base class for testing adapter integrations.
 *
 * Implementers of adapters should extend this class in their test suite,
 * implementing the `getRouter()` method.
 *
 * This test class tests that the router correctly marshals the allowed methods
 * for a match that matches the path, but not the request method.
 */
abstract class RouterIntegrationTest extends TestCase
{
    /**
     * Delegate dispatcher selection to routing functionality
     * Based on implemented Router.
     *
     * @return RouterInterface
     */
    abstract public function getRouter(): RouterInterface;

    /**
     * Delegate psr factories on selected router.
     *
     * @see getRouter() method.
     *
     * @return array
     */
    abstract public function psrServerResponseFactory(): array;

    /**
     * The Delegate RouteCollector.
     *
     * @param ContainerInterface $container
     *
     * @return RouteCollectorInterface
     */
    public function getRouteCollection(ContainerInterface $container = null): RouteCollectorInterface
    {
        [, $responseFactory] = $this->psrServerResponseFactory();

        return new RouteCollector($responseFactory, $this->getRouter(), null, $container);
    }

    public function createInvalidResponseFactory(): callable
    {
        return function (): void {
            Assert::fail('Response generated when it should not have been');
        };
    }

    public function method(): Generator
    {
        yield 'HEAD: head, post' => [
            HttpMethods::METHOD_HEAD,
            [HttpMethods::METHOD_HEAD, HttpMethods::METHOD_POST],
        ];

        yield 'HEAD: head, get' => [
            HttpMethods::METHOD_HEAD,
            [HttpMethods::METHOD_HEAD, HttpMethods::METHOD_GET],
        ];

        yield 'HEAD: post, head' => [
            HttpMethods::METHOD_HEAD,
            [HttpMethods::METHOD_POST, HttpMethods::METHOD_HEAD],
        ];

        yield 'HEAD: get, head' => [
            HttpMethods::METHOD_HEAD,
            [HttpMethods::METHOD_GET, HttpMethods::METHOD_HEAD],
        ];

        yield 'PUT: put, patch' => [
            HttpMethods::METHOD_PATCH,
            [HttpMethods::METHOD_PUT, HttpMethods::METHOD_PATCH],
        ];

        yield 'PATCH: patch, put' => [
            HttpMethods::METHOD_PUT,
            [HttpMethods::METHOD_PUT, HttpMethods::METHOD_PATCH],
        ];

        yield 'DELETE: patch, delete' => [
            HttpMethods::METHOD_DELETE,
            [HttpMethods::METHOD_DELETE, HttpMethods::METHOD_PATCH],
        ];

        yield 'OPTIONS: options, post' => [
            HttpMethods::METHOD_OPTIONS,
            [HttpMethods::METHOD_OPTIONS, HttpMethods::METHOD_POST],
        ];

        yield 'OPTIONS: options, get' => [
            HttpMethods::METHOD_OPTIONS,
            [HttpMethods::METHOD_OPTIONS, HttpMethods::METHOD_GET],
        ];

        yield 'OPTIONS: post, options' => [
            HttpMethods::METHOD_OPTIONS,
            [HttpMethods::METHOD_POST, HttpMethods::METHOD_OPTIONS],
        ];

        yield 'OPTIONS: get, options' => [
            HttpMethods::METHOD_OPTIONS,
            [HttpMethods::METHOD_GET, HttpMethods::METHOD_OPTIONS],
        ];
    }

    /**
     * @dataProvider method
     */
    public function testExplicitWithRouteCollector(string $method, array $routes): void
    {
        $router                            = $this->getRouteCollection();
        [$serverRequest, $responseFactory] = $this->psrServerResponseFactory();

        $finalResponse = $responseFactory->createResponse();
        $finalResponse = $finalResponse->withHeader('foo-bar', 'baz');
        $finalResponse->getBody()->write('FOO BAR BODY');

        $finalHandler = $this->prophesize(RequestHandlerInterface::class);
        $finalHandler
            ->handle(Argument::that(function (ServerRequestInterface $request) use ($method) {
                Assert::assertSame($method, $request->getMethod());

                $routeResult = $request->getAttribute(RouteResults::class);
                Assert::assertInstanceOf(RouteResults::class, $routeResult);
                Assert::assertTrue(RouteResults::FOUND === $routeResult->getROuteStatus());

                $matchedRoute = $routeResult->getMatchedRoute();
                Assert::assertNotFalse($matchedRoute);

                return true;
            }))
            ->willReturn($finalResponse)
            ->shouldBeCalledTimes(1);

        foreach ($routes as $routeMethod) {
            $route = new Route([$routeMethod], '/api/v1/me', $finalHandler->reveal());

            if ($routeMethod === $method) {
                $router->setRoute($route);
            }
        }

        $path     = $serverRequest->getUri()->withPath('/api/v1/me');
        $response = $router->handle($serverRequest->withMethod($method)->withUri($path));

        $this->assertEquals(200, $response->getStatusCode());
        $this->assertSame('FOO BAR BODY', (string) $response->getBody());
        $this->assertTrue($response->hasHeader('foo-bar'));
        $this->assertSame('baz', $response->getHeaderLine('foo-bar'));
    }

    /**
     * @dataProvider method
     */
    public function testExplicitWithoutCollector(string $method, array $routes): void
    {
        $router           = $this->getRouter();
        [$serverRequest,] = $this->psrServerResponseFactory();

        $finalHandler = $this->prophesize(RequestHandlerInterface::class);
        $finalHandler->handle(Argument::any())->shouldNotBeCalled();

        foreach ($routes as $routeMethod) {
            $route = new Route([$routeMethod], '/api/v1/me', $finalHandler->reveal());

            if ($routeMethod === $method) {
                $router->addRoute($route);
            }
        }

        $path    = $serverRequest->getUri()->withPath('/api/v1/me');
        $results = $router->match($serverRequest->withMethod($method)->withUri($path));

        $this->assertTrue($results::FOUND === $results->getRouteStatus());
        $this->assertNotFalse($results->getMatchedRoute());
    }

    public function withoutImplicitMiddleware()
    {
        // @codingStandardsIgnoreStart
        // request method, array of allowed methods for a route.
        yield 'HEAD: get'          => [HttpMethods::METHOD_HEAD, [HttpMethods::METHOD_GET]];

        yield 'HEAD: post'         => [HttpMethods::METHOD_HEAD, [HttpMethods::METHOD_POST]];

        yield 'HEAD: get, post'    => [HttpMethods::METHOD_HEAD, [HttpMethods::METHOD_GET, HttpMethods::METHOD_POST]];

        yield 'OPTIONS: get'       => [HttpMethods::METHOD_OPTIONS, [HttpMethods::METHOD_GET]];

        yield 'OPTIONS: post'      => [HttpMethods::METHOD_OPTIONS, [HttpMethods::METHOD_POST]];

        yield 'OPTIONS: get, post' => [HttpMethods::METHOD_OPTIONS, [HttpMethods::METHOD_GET, HttpMethods::METHOD_POST]];
        // @codingStandardsIgnoreEnd
    }

    /**
     * In case we are not using Implicit*Middlewares and we don't have any route with explicit method
     * returned response should be 405: Method Not Allowed - handled by MethodNotAllowedMiddleware.
     *
     * @dataProvider withoutImplicitMiddleware
     */
    public function testWithoutImplicitMiddleware(string $requestMethod, array $allowedMethods): void
    {
        $router           = $this->getRouteCollection();
        [$serverRequest,] = $this->psrServerResponseFactory();

        $finalResponse = $this->prophesize(ResponseInterface::class);
        $finalResponse->withStatus(405)->will([$finalResponse, 'reveal']);
        $finalResponse->withHeader('Allow', \implode(',', $allowedMethods))->will([$finalResponse, 'reveal']);

        $finalHandler = $this->prophesize(RequestHandlerInterface::class);
        $finalHandler->handle(Argument::any())->shouldNotBeCalled();

        foreach ($allowedMethods as $routeMethod) {
            $route = (new Route([$routeMethod], '/api/v1/me', $finalHandler->reveal()))
                ->addMiddleware(
                    function (ServerRequestInterface $request, RequestHandlerInterface $handler) {
                        return $handler->handle($request);
                    }
                );

            $router->setRoute($route);
        }

        $this->expectException(MethodNotAllowedException::class);

        $path = $serverRequest->getUri()->withPath('/api/v1/me');
        $router->handle($serverRequest->withMethod($requestMethod)->withUri($path));
    }

    /**
     * Provider for the testImplicitHeadRequest method.
     *
     * Implementations must provide this method. Each test case returned
     * must consist of the following three elements, in order:
     *
     * - string route path (the match string)
     * - string request path (the path in the ServerRequest instance)
     * - string request method (for ServerRequest instance)
     * - callable|object|string|null, returning route's response
     * - array route options (if any/required): selected keys:
     *   - [
     *        name => {subject},
     *        generate => [$params, $query]
     *        domain => {host}, (for ServerRequest instance)
     *        scheme => {scheme}, (for ServerRequest instance)
     *        scheme => {scheme},
     *        middlewares => [...],
     *        regex => [{param} => {pattern}...],
     *        defaults => [{$key} => {$value}...]
     *     ]
     * - array of asserts options (if any/required): selected keys:
     *   - [
     *        body => {contents},
     *        generate => {$path}
     *        scheme => {scheme}
     *        status => {code},
     *        content-type => {content-type},
     *        header => {header}
     *     ]
     */
    abstract public function implicitRoutesAndRequests(): Generator;

    /**
     * @dataProvider implicitRoutesAndRequests
     */
    public function testWithImplicitMiddleware(
        string $routePath,
        string $requestPath,
        string $requestMethod,
        $controller,
        /** @scrutinizer ignore-unused */ $controller,
        array $routeOptions = [],
        array $asserts = []
        /** @scrutinizer ignore-unused */ array $asserts = []
    ): void {
        $router                            = $this->getRouteCollection();
        [$serverRequest, $responseFactory] = $this->psrServerResponseFactory();

        $finalResponse = (new $responseFactory())->createResponse();
        $finalResponse = $finalResponse->withHeader('foo-bar', 'baz');

        $middleware = $this->prophesize(MiddlewareInterface::class);
        $middleware
            ->process(Argument::type(ServerRequestInterface::class), Argument::type(RequestHandlerInterface::class))
            ->willReturn($finalResponse)
            ->shouldBeCalledTimes(1);

        $router->map([$requestMethod], $routePath, function () use ($finalResponse) {
            return $finalResponse;
        })
        ->addMiddleware(
            function (ServerRequestInterface $req, RequestHandlerInterface $handle) use ($middleware, $requestMethod) {
                Assert::assertEquals($requestMethod, $req->getMethod());
                Assert::assertInstanceOf(Next::class, $handle);

                return $middleware->reveal()->process($req, $handle);
            }
        )
        ->addDomain($routeOptions['domain'] ?? '')
        ->setName($routeOptions['name'] ?? null)
        ->whereArray($routeOptions['regex'] ?? [])
        ->addDefaults($routeOptions['defaults'] ?? [])
        ->addSchemes($routeOptions['scheme'] ?? null);

        $path = $serverRequest->getUri()->withPath($requestPath);

        if (isset($routeOptions['domain'])) {
            $path = $path->withHost($routeOptions['domain']);
        }

        if (isset($routeOptions['scheme'])) {
            $path = $path->withScheme($routeOptions['scheme']);
        }

        $response = $router->handle($serverRequest->withMethod($requestMethod)->withUri($path));

        $this->assertSame($finalResponse, $response);
        $this->assertEquals('baz', $response->getHeaderLine('foo-bar'));
    }

    /**
     * @dataProvider implicitRoutesAndRequests
     */
    public function testWithImplicitRouteMatch(
        string $routePath,
        string $requestPath,
        string $requestMethod,
        $controller,
        array $routeOptions = [],
        array $asserts = []
    ): void {
        $router           = $this->getRouteCollection();
        [$serverRequest,] = $this->psrServerResponseFactory();

        $router->map([$requestMethod], $routePath, $controller)
        ->setName($routeOptions['name'] ?? null)
        ->addMiddleware($routeOptions['middlewares'] ?? [])
        ->whereArray($routeOptions['regex'] ?? [])
        ->addDefaults($routeOptions['defaults'] ?? [])
        ->addSchemes($routeOptions['scheme'] ?? null);

        $path = $serverRequest->getUri()->withPath($requestPath);

        if (isset($routeOptions['domain'])) {
            $path = $path->withHost($routeOptions['domain']);
        }

        if (isset($routeOptions['scheme'])) {
            $path = $path->withScheme($routeOptions['scheme']);
        }

        $response = $router->handle($serverRequest->withMethod($requestMethod)->withUri($path));

        if (isset($asserts['status'])) {
            $this->assertSame($asserts['status'], $response->getStatusCode());
        }

        if (isset($asserts['body'])) {
            $this->assertEquals($asserts['body'], (string) $response->getBody());
        }

        if (isset($asserts['content-type'])) {
            $this->assertEquals($asserts['content-type'], $response->getHeaderLine('Content-Type'));
        }

        if (isset($asserts['header'])) {
            $this->assertTrue($response->hasHeader($asserts['header']));
        }

        $this->assertInstanceOf(ResponseInterface::class, $response);
        $this->assertInstanceOf(RouteInterface::class, $route = $router->currentRoute());

        if (isset($asserts['scheme'])) {
            $this->assertTrue(\in_array($asserts['scheme'], $route->getSchemes()));
            $this->assertTrue(\in_array($asserts['scheme'], /** @scrutinizer ignore-type */ $route->getSchemes()));
        }

        if (isset($asserts['generate'], $routeOptions['generate'], $routeOptions['name'])) {
            $generated = \call_user_func(
                [$router, 'generateUri'],
                $routeOptions['name'],
                ...$routeOptions['generate']
            );

            $this->assertEquals($asserts['generate'], $generated);
        }
    }

    public function groups(): Generator
    {
        yield 'Group: Simple Grouping'          => [
            [
                RouteGroupInterface::NAME           => 'group',
                RouteGroupInterface::PREFIX         => 'group',
                RouteGroupInterface::REQUIREMENTS   => [],
                RouteGroupInterface::DOMAIN         => '',
                RouteGroupInterface::DEFAULTS       => ['how' => 'What to do?'],
                RouteGroupInterface::MIDDLEWARES    => [SampleMiddleware::class],
                RouteGroupInterface::SCHEMES        => null,
            ],
            [
                'path'       => 'group/test',
                'default'    => 'how',
                'middleware' => SampleMiddleware::class,
            ],
        ];

        yield 'Group: Prefix Grouping'          => [
            [
                RouteGroupInterface::PREFIX         => 'group/',
            ],
            [
                'path' => 'group/test',
            ],
        ];

        yield 'Group: Namespace Grouping'       => [
            [
                RouteGroupInterface::PREFIX            => 'group_',
                RouteGroupInterface::DEFAULTS          => ['how' => 'What to do?'],
                RouteGroupInterface::NAMESPACE         => '\\Fixtures',
            ],
            [
                'path'      => 'group_test',
                'namespace' => true,
            ],
        ];
    }

    /**
     * @dataProvider groups
     */
    public function testWithImplicitRouteGroup(array $groupAttributes, array $asserts = []): void
    {
        $router = $this->getRouteCollection();
        $router->setNamespace('Flight\\Routing\\Tests\\');

        [$serverRequest,] = $this->psrServerResponseFactory();
        $path             = $serverRequest->getUri()->withPath('/' . ($asserts['path'] ?? 'group/test'));

        $router->group($groupAttributes, function (RouterProxyInterface $route) use ($asserts): void {
            $route->get(
                'test*<homePageRequestResponse>',
                isset($asserts['namespace']) ? 'SampleController' : SampleController::class
            )
            ->setName('_hello');
        });

        $router->handle($serverRequest->withMethod(HttpMethods::METHOD_GET)->withUri($path));

        $this->assertInstanceOf(RouteInterface::class, $route = $router->currentRoute());

        if (isset($asserts['default'])) {
            $this->assertTrue($route->hasDefault($asserts['default']));
        }

        if (isset($asserts['path'])) {
            $this->assertEquals($asserts['path'], $route->getPath());
        }

        if (isset($asserts['middleware'])) {
            $this->assertTrue(\in_array($asserts['middleware'], $route->getMiddlewares(), true));
        }

        if ('_hello' !== $route->getName()) {
            $this->assertEquals('group_hello', $route->getName());
        }

        $this->assertTrue($route->hasGroup());
    }

    public function testImplicitRouteNotFound(): void
    {
        $router           = $this->getRouteCollection();
        [$serverRequest,] = $this->psrServerResponseFactory();

        $router->map([HttpMethods::METHOD_GET], '/error', function () {
            return 'This is an error page';
        })->setName('error');

        $path = $serverRequest->getUri()->withPath('/error');
        $router->handle($serverRequest->withMethod(HttpMethods::METHOD_GET)->withUri($path));

        $this->assertInstanceOf(RouteInterface::class, $router->getNamedRoute('error'));
        $this->assertNotEmpty($router->getRoutes());
        $this->assertCount(1, $router->getRoutes());

        $this->expectException(RouteNotFoundException::class);

        $path = $serverRequest->getUri()->withPath('/not-found');
        $router->handle($serverRequest->withMethod(HttpMethods::METHOD_GET)->withUri($path));
    }
}

divineniiquaye / flight-routing

Push — master ( 5e779b...23e82e )

createInvalidResponseFactory() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
