Addiks\SymfonyGenerics\Tests\Unit\Controllers\GenericExceptionResponseControllerTest

Complexity

Total Complexity

16

Size/Duplication

Total Lines	409
Duplicated Lines	38.14 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	6	1
A	shouldexecuteInnerControllerSafely()	0	18	1
A	shouldOverrideSuccessResponse()	20	20	1
A	shouldOverrideSuccessResponseWithDefaultResponseCode()	19	19	1
A	shouldTriggerSuccessFlashMessage()	0	20	1
A	shouldAddFlashMessageUponException()	0	34	1
A	shouldForwardThrowExceptionIfNotHandled()	0	21	1
A	shouldThrowExceptionIfInnerControllerDidNotReturnAResponse()	0	14	1
A	shouldThrowExceptionIfHandledExceptionClassIsNotException()	0	15	1
A	shouldHandleThrowables()	0	27	1
A	shouldRejectNonObjectInnerController()	9	9	1
A	shouldRejectControllerBeingCalledAgain()	14	14	1
A	shouldRejectNonArrayGivenAsInnerControllerArguments()	10	10	1
A	shouldRedirectFromException()	41	41	1
A	shouldBeCallableByInvokingController()	43	43	1
A	shouldRejectCallWithoutRequest()	0	13	1

<?php
/**
 * Copyright (C) 2017  Gerrit Addiks.
 * This package (including this file) was released under the terms of the GPL-3.0.
 * You should have received a copy of the GNU General Public License along with this program.
 * If not, see <http://www.gnu.org/licenses/> or send me a mail so i can send you a copy.
 * @license GPL-3.0
 * @author Gerrit Addiks <gerrit@addiks.de>
 */

namespace Addiks\SymfonyGenerics\Tests\Unit\Controllers;

use PHPUnit\Framework\TestCase;
use Addiks\SymfonyGenerics\Controllers\GenericExceptionResponseController;
use Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface;
use Serializable;
use Symfony\Component\HttpFoundation\Response;
use InvalidArgumentException;
use DivisionByZeroError;
use Addiks\SymfonyGenerics\Services\ArgumentCompilerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\ParameterBag;

final class GenericExceptionResponseControllerTest extends TestCase
{

    /**
     * @var GenericExceptionResponseController
     */
    private $controller;

    /**
     * @var ControllerHelperInterface
     */
    private $controllerHelper;

    /**
     * @var Serializable
     */
    private $innerController;

    /**
     * @var ArgumentCompilerInterface
     */
    private $argumentBuilder;

    public function setUp()
    {
        $this->controllerHelper = $this->createMock(ControllerHelperInterface::class);

It seems like $this->createMock(\Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface::class) of type object<PHPUnit\Framework\MockObject\MockObject> is incompatible with the declared type object<Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface> of property $controllerHelper.

        $this->innerController = $this->createMock(Serializable::class);

It seems like $this->createMock(\Serializable::class) of type object<PHPUnit\Framework\MockObject\MockObject> is incompatible with the declared type object<Serializable> of property $innerController.

        $this->argumentBuilder = $this->createMock(ArgumentCompilerInterface::class);

It seems like $this->createMock(\Addiks\SymfonyGenerics\Services\ArgumentCompilerInterface::class) of type object<PHPUnit\Framework\MockObject\MockObject> is incompatible with the declared type object<Addiks\SymfonyGenerics\Services\ArgumentCompilerInterface> of property $argumentBuilder.

    }

    /**
     * @test
     */
    public function shouldexecuteInnerControllerSafely()
    {
        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [
            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
        ]);

        $this->innerController->method("serialize")->willReturn(new Response("foo", 205));

        /** @var Request $request */
        $request = $this->createMock(Request::class);

        /** @var Response $response */
        $response = $controller->executeInnerControllerSafely($request);

        $this->assertEquals("foo", $response->getContent());
        $this->assertEquals(205, $response->getStatusCode());
    }

    /**
     * @test
     */
    public function shouldOverrideSuccessResponse()

This method seems to be duplicated in your project.

    {
        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [
            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
            'success-response' => "Some success!",
            'success-response-code' => 234,
        ]);

        $this->innerController->method("serialize")->willReturn(new Response("foo", 205));

        /** @var Request $request */
        $request = $this->createMock(Request::class);

        /** @var Response $response */
        $response = $controller->executeInnerControllerSafely($request);

        $this->assertEquals("Some success!", $response->getContent());
        $this->assertEquals(234, $response->getStatusCode());
    }

    /**
     * @test
     */
    public function shouldOverrideSuccessResponseWithDefaultResponseCode()

This method seems to be duplicated in your project.

    {
        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [
            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
            'success-response' => "Some success!",
        ]);

        $this->innerController->method("serialize")->willReturn(new Response("foo", 205));

        /** @var Request $request */
        $request = $this->createMock(Request::class);

        /** @var Response $response */
        $response = $controller->executeInnerControllerSafely($request);

        $this->assertEquals("Some success!", $response->getContent());
        $this->assertEquals(200, $response->getStatusCode());
    }

    /**
     * @test
     */
    public function shouldTriggerSuccessFlashMessage()
    {
        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [
            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
            'success-flash-message' => 'Some Success Message!'
        ]);

        $this->controllerHelper->expects($this->once())->method('addFlashMessage')->with(

The method expects() does not seem to exist on object<Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface>.

            $this->equalTo('Some Success Message!'),
            $this->equalTo('success')
        );

        $this->innerController->method("serialize")->willReturn(new Response("foo", 200));

        /** @var Request $request */
        $request = $this->createMock(Request::class);

        $controller->executeInnerControllerSafely($request);
    }

    /**
     * @test
     */
    public function shouldAddFlashMessageUponException()
    {
        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [
            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
            'exception-responses' => [
                InvalidArgumentException::class => [
                    'flash-type' => 'danger',
                    'flash-message' => 'Something happened: %s'
                ]
            ]
        ]);

        $this->innerController->method("serialize")->will($this->returnCallback(
            function () {
                throw new InvalidArgumentException("Lorem ipsum!");
            }
        ));

        $this->controllerHelper->expects($this->once())->method('handleException');

The method expects() does not seem to exist on object<Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface>.

        $this->controllerHelper->expects($this->once())->method('addFlashMessage')->with(

The method expects() does not seem to exist on object<Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface>.

            $this->equalTo('Something happened: Lorem ipsum!'),
            $this->equalTo('danger')
        );

        /** @var Request $request */
        $request = $this->createMock(Request::class);

        /** @var Response $response */
        $response = $controller->executeInnerControllerSafely($request);

        $this->assertEquals("Lorem ipsum!", $response->getContent());
        $this->assertEquals(500, $response->getStatusCode());
    }

    /**
     * @test
     */
    public function shouldForwardThrowExceptionIfNotHandled()
    {
        /** @var mixed $controller */
        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [
            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
        ]);

        $this->innerController->method("serialize")->will($this->returnCallback(
            function () {
                throw new InvalidArgumentException("Lorem ipsum!");
            }
        ));

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

        /** @var Request $request */
        $request = $this->createMock(Request::class);

        $controller->executeInnerControllerSafely($request);
    }

    /**
     * @test
     */
    public function shouldThrowExceptionIfInnerControllerDidNotReturnAResponse()
    {
        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [
            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
        ]);

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

        /** @var Request $request */
        $request = $this->createMock(Request::class);

        $controller->executeInnerControllerSafely($request);
    }

    /**
     * @test
     */
    public function shouldThrowExceptionIfHandledExceptionClassIsNotException()
    {
        $this->expectException(InvalidArgumentException::class);

        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [

$controller is not used, you could remove the assignment.

            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
            'exception-responses' => [
                "TotallyNotAnException" => [
                    'flash-type' => 'danger',
                    'flash-message' => 'Something happened: %s'
                ]
            ]
        ]);
    }

    /**
     * @test
     */
    public function shouldHandleThrowables()
    {
        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [
            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
            'exception-responses' => [
                DivisionByZeroError::class => [
                    'flash-type' => 'danger',
                    'flash-message' => 'Something happened: %s'
                ]
            ]
        ]);

        $this->innerController->method("serialize")->will($this->returnCallback(
            function () {
                throw new DivisionByZeroError("Lorem ipsum");

The call to DivisionByZeroError::__construct() has too many arguments starting with 'Lorem ipsum'.

            }
        ));

        /** @var Request $request */
        $request = $this->createMock(Request::class);

        /** @var Response $response */
        $response = $controller->executeInnerControllerSafely($request);

        $this->assertEquals("Lorem ipsum", $response->getContent());
    }

    /**
     * @test
     */
    public function shouldRejectNonObjectInnerController()

This method seems to be duplicated in your project.

    {
        $this->expectException(InvalidArgumentException::class);

        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [

$controller is not used, you could remove the assignment.

            'inner-controller' => false,
            'inner-controller-method' => "serialize",
        ]);
    }

    /**
     * @test
     */
    public function shouldRejectControllerBeingCalledAgain()

This method seems to be duplicated in your project.

    {
        $this->expectException(InvalidArgumentException::class);

        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [
            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
        ]);

        $controller->__construct($this->controllerHelper, $this->argumentBuilder, [
            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
        ]);
    }

    /**
     * @test
     */
    public function shouldRejectNonArrayGivenAsInnerControllerArguments()

This method seems to be duplicated in your project.

    {
        $this->expectException(InvalidArgumentException::class);

        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [

$controller is not used, you could remove the assignment.

            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
            'arguments' => "Lorem ipsum",
        ]);
    }

    /**
     * @test
     */
    public function shouldRedirectFromException()

This method seems to be duplicated in your project.

    {
        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [
            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
            'exception-responses' => [
                InvalidArgumentException::class => [
                    'redirect-route' => 'some_redirect_route',
                    'redirect-route-parameters' => [
                        'foo' => 'bar'
                    ]
                ]
            ]
        ]);

        $this->innerController->method("serialize")->will($this->returnCallback(
            function () {
                throw new InvalidArgumentException("Lorem ipsum!");
            }
        ));

        /** @var RedirectResponse $redirectResponse */
        $redirectResponse = $this->createMock(RedirectResponse::class);

        $this->controllerHelper->expects($this->once())->method('handleException');

The method expects() does not seem to exist on object<Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface>.

        $this->controllerHelper->expects($this->once())->method('redirectToRoute')->with(

The method expects() does not seem to exist on object<Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface>.

            $this->equalTo('some_redirect_route'),
            $this->equalTo([]),
            $this->equalTo(301)
        )->willReturn($redirectResponse);

        /** @var Request $request */
        $request = $this->createMock(Request::class);
        $request->attributes = $this->createMock(ParameterBag::class);

It seems like $this->createMock(\Symfony\Component\HttpFoundation\ParameterBag::class) of type object<PHPUnit\Framework\MockObject\MockObject> is incompatible with the declared type object<Symfony\Component\HttpFoundation\ParameterBag> of property $attributes.

        $request->attributes->method('get')->willReturn([]);

        /** @var Response $response */
        $response = $controller->executeInnerControllerSafely($request);

        $this->assertSame($redirectResponse, $response);
    }

    /**
     * @test
     */
    public function shouldBeCallableByInvokingController()

This method seems to be duplicated in your project.

    {
        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [
            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
            'exception-responses' => [
                InvalidArgumentException::class => [
                    'redirect-route' => 'some_redirect_route',
                    'redirect-route-parameters' => [
                        'foo' => 'bar'
                    ]
                ]
            ]
        ]);

        $this->innerController->method("serialize")->will($this->returnCallback(
            function () {
                throw new InvalidArgumentException("Lorem ipsum!");
            }
        ));

        /** @var RedirectResponse $redirectResponse */
        $redirectResponse = $this->createMock(RedirectResponse::class);

        $this->controllerHelper->expects($this->once())->method('handleException');

The method expects() does not seem to exist on object<Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface>.

        $this->controllerHelper->expects($this->once())->method('redirectToRoute')->with(

The method expects() does not seem to exist on object<Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface>.

            $this->equalTo('some_redirect_route'),
            $this->equalTo([]),
            $this->equalTo(301)
        )->willReturn($redirectResponse);

        /** @var Request $request */
        $request = $this->createMock(Request::class);
        $request->attributes = $this->createMock(ParameterBag::class);

It seems like $this->createMock(\Symfony\Component\HttpFoundation\ParameterBag::class) of type object<PHPUnit\Framework\MockObject\MockObject> is incompatible with the declared type object<Symfony\Component\HttpFoundation\ParameterBag> of property $attributes.

        $request->attributes->method('get')->willReturn([]);

        $this->controllerHelper->method('getCurrentRequest')->willReturn($request);

The method method() does not seem to exist on object<Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface>.

        /** @var Response $response */
        $response = $controller();

        $this->assertSame($redirectResponse, $response);
    }

    /**
     * @test
     */
    public function shouldRejectCallWithoutRequest()
    {
        $this->expectException(InvalidArgumentException::class);

        $controller = new GenericExceptionResponseController($this->controllerHelper, $this->argumentBuilder, [
            'inner-controller' => $this->innerController,
            'inner-controller-method' => "serialize",
        ]);

        $this->controllerHelper->method('getCurrentRequest')->willReturn(null);

The method method() does not seem to exist on object<Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface>.

        $controller();
    }

}