EndpointTest.php$1 ➔ testProcessWorksWithMiddleware() - Code Metrics - Inspection of "Update readme and add scrutinizer" - usox/json-schema-api - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 1ccf8a...1e427b )

by Daniel
created 2021-03-02 19:50 UTC
php$1 ➔ testProcessWorksWithMiddleware() A

↳ Parent: EndpointTest
Complexity

Conditions
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
c	0
b	0
f	0
dl	0
loc	41
rs	9.264
<?php

declare(strict_types=1);

namespace Usox\JsonSchemaApi;

use Exception;
use Mockery;
use Mockery\Adapter\Phpunit\MockeryTestCase;
use Mockery\MockInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamFactoryInterface;
use Psr\Http\Message\StreamInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Psr\Log\LoggerInterface;
use Ramsey\Uuid\UuidFactoryInterface;
use Ramsey\Uuid\UuidInterface;
use stdClass;
use Teapot\StatusCode;
use Usox\JsonSchemaApi\Contract\MethodProviderInterface;
use Usox\JsonSchemaApi\Dispatch\MethodDispatcherInterface;
use Usox\JsonSchemaApi\Dispatch\RequestValidatorInterface;
use Usox\JsonSchemaApi\Exception\ApiException;
use Usox\JsonSchemaApi\Exception\ApiMethodException;
use Usox\JsonSchemaApi\Exception\ResponseMalformedException;
use Usox\JsonSchemaApi\Response\ResponseBuilderInterface;

class EndpointTest extends MockeryTestCase
{
    /** @var RequestValidatorInterface|MockInterface */
    private MockInterface $requestValidator;

    /** @var MethodDispatcherInterface|MockInterface */
    private MockInterface $methodDispatcher;

    /** @var ResponseBuilderInterface|MockInterface */
    private MockInterface $responseBuilder;

    /** @var UuidFactoryInterface|MockInterface */
    private MockInterface $uuidFactory;

    /** @var StreamFactoryInterface|MockInterface */
    private MockInterface $streamFactory;

    /** @var LoggerInterface|MockInterface */
    private MockInterface $logger;
    
    private Endpoint $subject;
    
    public function setUp(): void
    {
        $this->requestValidator = Mockery::mock(RequestValidatorInterface::class);
        $this->methodDispatcher = Mockery::mock(MethodDispatcherInterface::class);
        $this->responseBuilder = Mockery::mock(ResponseBuilderInterface::class);
        $this->uuidFactory = Mockery::mock(UuidFactoryInterface::class);
        $this->streamFactory = Mockery::mock(StreamFactoryInterface::class);
        $this->logger = Mockery::mock(LoggerInterface::class);
        
        $this->subject = new Endpoint(
            $this->requestValidator,
            /** @scrutinizer ignore-type */ $this->requestValidator,
            $this->methodDispatcher,
            /** @scrutinizer ignore-type */ $this->methodDispatcher,
            $this->responseBuilder,
            /** @scrutinizer ignore-type */ $this->responseBuilder,
            $this->uuidFactory,
            /** @scrutinizer ignore-type */ $this->uuidFactory,
            $this->streamFactory,
            /** @scrutinizer ignore-type */ $this->streamFactory,
            $this->logger
            /** @scrutinizer ignore-type */ $this->logger
        );
    }
    
    public function testServeReturnsHandlerOutput(): void
    {
        $request = Mockery::mock(ServerRequestInterface::class);
        $response = Mockery::mock(ResponseInterface::class);
        
        $parameter = new stdClass();
        $decodedInput = new stdClass();
        $decodedInput->parameter = $parameter;
        $responseData = ['some-response'];
        $processedResponse = ['some-processed-response'];
        
        $this->requestValidator->shouldReceive('validate')
            ->with($request)
            ->once()
            ->andReturn($decodedInput);
        
        $this->methodDispatcher->shouldReceive('dispatch')
            ->with($request, $decodedInput)
            ->once()
            ->andReturn($responseData);
        
        $this->responseBuilder->shouldReceive('buildResponse')
            ->with($responseData)
            ->once()
            ->andReturn($processedResponse);
        
        $this->createResponseExpectations(
            $response,
            $processedResponse,
            StatusCode::OK
        );
        
        static::assertSame(
            $response,
            $this->subject->serve($request, $response)
            $this->subject->serve($request, /** @scrutinizer ignore-type */ $response)
        );
    }

    public function testServeCatchesApiMethodException(): void
    {
        $request = Mockery::mock(ServerRequestInterface::class);
        $response = Mockery::mock(ResponseInterface::class);
        $uuid = Mockery::mock(UuidInterface::class);
        
        $errorMessage = 'some-error';
        $errorCode = 666;
        $processedResponse = ['some-processed-response'];
        $uuidValue = 'some-uuid';

        $error = new class($errorMessage, $errorCode) extends ApiMethodException {};

        $this->requestValidator->shouldReceive('validate')
            ->with($request)
            ->once()
            ->andThrow($error);

        $this->responseBuilder->shouldReceive('buildErrorResponse')
            ->with($error, $uuid)
            ->once()
            ->andReturn($processedResponse);
        
        $this->uuidFactory->shouldReceive('uuid4')
            ->withNoArgs()
            ->once()
            ->andReturn($uuid);
        
        $uuid->shouldReceive('toString')
            ->withNoArgs()
            ->once()
            ->andReturn($uuidValue);

        $this->createResponseExpectations(
            $response,
            $processedResponse,
            StatusCode::BAD_REQUEST
        );
        
        $this->logger->shouldReceive('error')
            ->with(
                sprintf('%s (%d)', $errorMessage, $errorCode),
                Mockery::type('array')
            )
            ->once();

        static::assertSame(
            $response,
            $this->subject->serve($request, $response)
            $this->subject->serve($request, /** @scrutinizer ignore-type */ $response)
        );
    }

    public function testServeCatchesApiException(): void
    {
        $request = Mockery::mock(ServerRequestInterface::class);
        $response = Mockery::mock(ResponseInterface::class);
        $uuid = Mockery::mock(UuidInterface::class);

        $errorMessage = 'some-error';
        $errorCode = 666;
        $processedResponse = ['some-processed-response'];
        $uuidValue = 'some-uuid';

        $error = new class($errorMessage, $errorCode) extends ApiException {};

        $this->requestValidator->shouldReceive('validate')
            ->with($request)
            ->once()
            ->andThrow($error);

        $this->responseBuilder->shouldReceive('buildErrorResponse')
            ->with($error, $uuid)
            ->once()
            ->andReturn($processedResponse);

        $this->uuidFactory->shouldReceive('uuid4')
            ->withNoArgs()
            ->once()
            ->andReturn($uuid);

        $uuid->shouldReceive('toString')
            ->withNoArgs()
            ->once()
            ->andReturn($uuidValue);

        $this->createResponseExpectations(
            $response,
            $processedResponse,
            StatusCode::BAD_REQUEST
        );

        $this->logger->shouldReceive('error')
            ->with(
                sprintf('%s (%d)', $errorMessage, $errorCode),
                Mockery::type('array')
            )
            ->once();

        static::assertSame(
            $response,
            $this->subject->serve($request, $response)
            $this->subject->serve($request, /** @scrutinizer ignore-type */ $response)
        );
    }

    public function testServeCatchesGenericException(): void
    {
        $request = Mockery::mock(ServerRequestInterface::class);
        $response = Mockery::mock(ResponseInterface::class);
        $uuid = Mockery::mock(UuidInterface::class);

        $errorMessage = 'some-error';
        $errorCode = 666;
        $uuidValue = 'some-uuid';

        $error = new Exception($errorMessage, $errorCode);

        $this->requestValidator->shouldReceive('validate')
            ->with($request)
            ->once()
            ->andThrow($error);

        $this->uuidFactory->shouldReceive('uuid4')
            ->withNoArgs()
            ->once()
            ->andReturn($uuid);

        $uuid->shouldReceive('toString')
            ->withNoArgs()
            ->once()
            ->andReturn($uuidValue);

        $this->createResponseExpectations(
            $response,
            '',
            StatusCode::INTERNAL_SERVER_ERROR
        );

        $this->logger->shouldReceive('error')
            ->with(
                sprintf('%s (%d)', $errorMessage, $errorCode),
                Mockery::type('array')
            )
            ->once();

        static::assertSame(
            $response,
            $this->subject->serve($request, $response)
            $this->subject->serve(/** @scrutinizer ignore-type */ $request, $response)
        );
    }

    public function testServeCatchesInternalException(): void
    {
        $request = Mockery::mock(ServerRequestInterface::class);
        $response = Mockery::mock(ResponseInterface::class);
        $uuid = Mockery::mock(UuidInterface::class);

        $errorMessage = 'some-error';
        $errorCode = 666;
        $uuidValue = 'some-uuid';
        $context = ['some' => 'context'];

        $error = new ResponseMalformedException($errorMessage, $errorCode, null, $context);

        $this->requestValidator->shouldReceive('validate')
            ->with($request)
            ->once()
            ->andThrow($error);

        $this->uuidFactory->shouldReceive('uuid4')
            ->withNoArgs()
            ->once()
            ->andReturn($uuid);

        $uuid->shouldReceive('toString')
            ->withNoArgs()
            ->once()
            ->andReturn($uuidValue);

        $this->createResponseExpectations(
            $response,
            '',
            StatusCode::INTERNAL_SERVER_ERROR
        );

        $this->logger->shouldReceive('error')
            ->with(
                sprintf('%s (%d)', $errorMessage, $errorCode),
                Mockery::type('array')
            )
            ->once();

        static::assertSame(
            $response,
            $this->subject->serve($request, $response)
            $this->subject->serve(/** @scrutinizer ignore-type */ $request, $response)
        );
    }
    
    public function testFactoryReturnsInstance(): void
    {
        static::assertInstanceOf(
            Endpoint::class,
            Endpoint::factory(
                Mockery::mock(MethodProviderInterface::class),
                /** @scrutinizer ignore-type */ Mockery::mock(MethodProviderInterface::class),
                Mockery::mock(StreamFactoryInterface::class)
                /** @scrutinizer ignore-type */ Mockery::mock(StreamFactoryInterface::class)
            )
        );
    }

    public function testProcessWorksWithMiddleware(): void
    {
        $request = Mockery::mock(ServerRequestInterface::class);
        $response = Mockery::mock(ResponseInterface::class);
        $requestHandler = Mockery::mock(RequestHandlerInterface::class);

        $parameter = new stdClass();
        $decodedInput = new stdClass();
        $decodedInput->parameter = $parameter;
        $responseData = ['some-response'];
        $processedResponse = ['some-processed-response'];

        $this->requestValidator->shouldReceive('validate')
            ->with($request)
            ->once()
            ->andReturn($decodedInput);

        $this->methodDispatcher->shouldReceive('dispatch')
            ->with($request, $decodedInput)
            ->once()
            ->andReturn($responseData);

        $this->responseBuilder->shouldReceive('buildResponse')
            ->with($responseData)
            ->once()
            ->andReturn($processedResponse);

        $this->createResponseExpectations(
            $response,
            $processedResponse,
            StatusCode::OK
        );
        
        $requestHandler->shouldReceive('handle')
            ->with($request)
            ->once()
            ->andReturn($response);

        static::assertSame(
            $response,
            $this->subject->process($request, $requestHandler)
            $this->subject->process(/** @scrutinizer ignore-type */ $request, $requestHandler)
        );
    }

    /**
     * @param MockInterface $response
     * @param string|array<mixed, mixed> $responseData
     * @param int $statusCode
     */
    private function createResponseExpectations(
        MockInterface $response,
        $responseData,
        int $statusCode
    ): void {
        $stream = Mockery::mock(StreamInterface::class);
        
        $this->streamFactory->shouldReceive('createStream')
            ->with(json_encode($responseData))
            ->once()
            ->andReturn($stream);
        
        $response->shouldReceive('withHeader')
            ->with('Content-Type', 'application/json')
            ->once()
            ->andReturnSelf();
            ->/** @scrutinizer ignore-call */ andReturnSelf();
        $response->shouldReceive('withStatus')
            ->with($statusCode)
            ->once()
            ->andReturnSelf();
        $response->shouldReceive('withBody')
            ->with($stream)
            ->once()
            ->andReturnSelf();
    }
}

usox / json-schema-api

Push — master ( 1ccf8a...1e427b )

php$1 ➔ testProcessWorksWithMiddleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
