AccessControlListenerTest - Code Metrics - Inspection of "Merge pull request #6 from SimLibaud/feature/tests" - SimLibaud/SilRouteSecurityBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 078409...14d907 )

by Simon

created 2017-07-26 19:58 UTC

AccessControlListenerTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	190
Duplicated Lines	42.63 %

Importance

Changes

Metric	Value
wmc	9
dl	81
loc	190
rs	10
c	0
b	0
f	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	testWhenAccessControlIsDisabled()	0	14	1
A	testWithEmptyTokenStorage()	20	20	1
A	testWithIncorrectAccessForUser()	20	20	1
B	testWithIncorrectAccessForUserAndCustomResponse()	0	27	1
A	testWithCorrectAccessForUser()	19	19	1
B	testWithInvalidTokenStorage()	0	24	1
A	mockTokenStorage()	0	16	1
A	mockGetResponseEvent()	0	14	1
A	testWithNonSecureRoute()	18	18	1

How to fix Duplicated Code

<?php

namespace Sil\RouteSecurityBundle\Tests\Listener;

use PHPUnit\Framework\TestCase;
filter:
    dependency_paths: ["lib/*"]
use Sil\RouteSecurityBundle\Event\AccessDeniedToRouteEvent;
use Sil\RouteSecurityBundle\Exception\LogicException;
use Sil\RouteSecurityBundle\Listener\AccessControlListener;
use Sil\RouteSecurityBundle\Security\AccessControl;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;
use Symfony\Component\HttpFoundation\ParameterBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\User\UserInterface;

class AccessControlListenerTest extends TestCase
{
    public function testWhenAccessControlIsDisabled()
    {
        $accessControl = $this->createMock(AccessControl::class);
        $accessControl
            ->method('isEnable')
            ->willReturn(false);
        $tokenStorage = $this->createMock(TokenStorageInterface::class);
        $eventDispatcher = $this->createMock(EventDispatcherInterface::class);
        $event = $this->mockGetResponseEvent();

        $accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
        $accessControlListener->onKernelRequest($event);

        $this->assertNull($accessControlListener->onKernelRequest($event));
    }

    public function testWithNonSecureRoute()

    {
        $accessControl = $this->createMock(AccessControl::class);
        $accessControl
            ->method('isEnable')
            ->willReturn(true);
        $accessControl
            ->method('isRouteSecure')
            ->with('non_secure_route')
            ->willReturn(false);
        $tokenStorage = $this->createMock(TokenStorageInterface::class);
        $eventDispatcher = $this->createMock(EventDispatcherInterface::class);
        $event = $this->mockGetResponseEvent('non_secure_route');

        $accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
        $accessControlListener->onKernelRequest($event);

        $this->assertNull($accessControlListener->onKernelRequest($event));
    }

    public function testWithEmptyTokenStorage()

    {
        $accessControl = $this->createMock(AccessControl::class);
        $accessControl
            ->method('isEnable')
            ->willReturn(true);
        $accessControl
            ->method('isRouteSecure')
            ->with('secure_route')
            ->willReturn(true);
        $tokenStorage = $this->createMock(TokenStorageInterface::class);
        $tokenStorage
            ->method('getToken')
            ->willReturn(null);
        $eventDispatcher = $this->createMock(EventDispatcherInterface::class);
        $event = $this->mockGetResponseEvent('secure_route');

        $accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
        $this->expectException(LogicException::class);
        $accessControlListener->onKernelRequest($event);
    }

    public function testWithInvalidTokenStorage()
    {
        $accessControl = $this->createMock(AccessControl::class);
        $accessControl
            ->method('isEnable')
            ->willReturn(true);
        $accessControl
            ->method('isRouteSecure')
            ->with('secure_route')
            ->willReturn(true);
        $token = $this->createMock(TokenInterface::class);
        $token
            ->method('getUser')
            ->willReturn('invalid user type');
        $tokenStorage = $this->createMock(TokenStorageInterface::class);
        $tokenStorage
            ->method('getToken')
            ->willReturn($token);
        $eventDispatcher = $this->createMock(EventDispatcherInterface::class);
        $event = $this->mockGetResponseEvent('secure_route');

        $accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
        $this->expectException(LogicException::class);
        $accessControlListener->onKernelRequest($event);
    }

    public function testWithCorrectAccessForUser()

    {
        $accessControl = $this->createMock(AccessControl::class);
        $accessControl
            ->method('isEnable')
            ->willReturn(true);
        $accessControl
            ->method('isRouteSecure')
            ->with('secure_route')
            ->willReturn(true);
        $accessControl
            ->method('hasUserAccessToRoute')
            ->willReturn(true);
        $tokenStorage = $this->mockTokenStorage();
        $eventDispatcher = $this->createMock(EventDispatcherInterface::class);
        $event = $this->mockGetResponseEvent('secure_route');

        $accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
        $this->assertNull($accessControlListener->onKernelRequest($event));
    }

    public function testWithIncorrectAccessForUser()

    {
        $accessControl = $this->createMock(AccessControl::class);
        $accessControl
            ->method('isEnable')
            ->willReturn(true);
        $accessControl
            ->method('isRouteSecure')
            ->with('secure_route')
            ->willReturn(true);
        $accessControl
            ->method('hasUserAccessToRoute')
            ->willReturn(false);
        $tokenStorage = $this->mockTokenStorage();
        $eventDispatcher = $this->createMock(EventDispatcherInterface::class);
        $event = $this->mockGetResponseEvent('secure_route');

        $accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
        $this->expectException(AccessDeniedException::class);
        $this->assertNull($accessControlListener->onKernelRequest($event));
    }

    public function testWithIncorrectAccessForUserAndCustomResponse()
    {
        $accessControl = $this->createMock(AccessControl::class);
        $accessControl
            ->method('isEnable')
            ->willReturn(true);
        $accessControl
            ->method('isRouteSecure')
            ->with('secure_route')
            ->willReturn(true);
        $accessControl
            ->method('hasUserAccessToRoute')
            ->willReturn(false);
        $tokenStorage = $this->mockTokenStorage();
        $event = $this->mockGetResponseEvent('secure_route');
        $eventDispatcher = $this->createMock(EventDispatcherInterface::class);
        $response = new Response('Custom Response');
        $eventDispatcher
            ->expects($this->once())
            ->method('dispatch')
            ->with(AccessDeniedToRouteEvent::ON_ACCESS_DENIED_TO_ROUTE, $this->isInstanceOf(AccessDeniedToRouteEvent::class))
            ->will($this->returnCallback(function ($name, $access_denied_event) use ($response) {
                $access_denied_event->setResponse($response);
            }));

        $accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
        $this->assertInstanceOf(GetResponseEvent::class, $accessControlListener->onKernelRequest($event));
    }

    protected function mockGetResponseEvent($route = null)
    {
        $event = $this->createMock(GetResponseEvent::class);
        $request = $this->createMock(Request::class);
        $parameterBag = $this->createMock(ParameterBag::class);
        $parameterBag
            ->method('get')
            ->with('_route')
            ->willReturn($route);

        $request->attributes = $parameterBag;
        $event->method('getRequest')->willReturn($request);

        return $event;
    }

    protected function mockTokenStorage($roles = [])
    {
        $tokenStorage = $this->createMock(TokenStorageInterface::class);
        $user = $this->createMock(UserInterface::class);
        $user
            ->method('getRoles')
            ->willReturn($roles);
        $token = $this->createMock(TokenInterface::class);
        $token
            ->method('getUser')
            ->willReturn($user);
        $tokenStorage
            ->method('getToken')
            ->willReturn($token);

        return $tokenStorage;
    }
}


1		<?php
2
3		namespace Sil\RouteSecurityBundle\Tests\Listener;
4
5		use PHPUnit\Framework\TestCase;
		0 ignored issues – show Bug introduced 2017-07-25 21:46 UTC by Report Bug Copy Issue Report The type `PHPUnit\Framework\TestCase` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
6		use Sil\RouteSecurityBundle\Event\AccessDeniedToRouteEvent;
7		use Sil\RouteSecurityBundle\Exception\LogicException;
8		use Sil\RouteSecurityBundle\Listener\AccessControlListener;
9		use Sil\RouteSecurityBundle\Security\AccessControl;
10		use Symfony\Component\EventDispatcher\EventDispatcherInterface;
11		use Symfony\Component\HttpFoundation\Response;
12		use Symfony\Component\Security\Core\Exception\AccessDeniedException;
13		use Symfony\Component\HttpFoundation\ParameterBag;
14		use Symfony\Component\HttpFoundation\Request;
15		use Symfony\Component\HttpKernel\Event\GetResponseEvent;
16		use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
17		use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
18		use Symfony\Component\Security\Core\User\UserInterface;
19
20		class AccessControlListenerTest extends TestCase
21		{
22		public function testWhenAccessControlIsDisabled()
23		{
24		$accessControl = $this->createMock(AccessControl::class);
25		$accessControl
26		->method('isEnable')
27		->willReturn(false);
28		$tokenStorage = $this->createMock(TokenStorageInterface::class);
29		$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
30		$event = $this->mockGetResponseEvent();
31
32		$accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
33		$accessControlListener->onKernelRequest($event);
34
35		$this->assertNull($accessControlListener->onKernelRequest($event));
36		}
37
38	View Code Duplication	public function testWithNonSecureRoute()
		0 ignored issues – show Duplication introduced 2017-07-25 21:46 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
39		{
40		$accessControl = $this->createMock(AccessControl::class);
41		$accessControl
42		->method('isEnable')
43		->willReturn(true);
44		$accessControl
45		->method('isRouteSecure')
46		->with('non_secure_route')
47		->willReturn(false);
48		$tokenStorage = $this->createMock(TokenStorageInterface::class);
49		$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
50		$event = $this->mockGetResponseEvent('non_secure_route');
51
52		$accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
53		$accessControlListener->onKernelRequest($event);
54
55		$this->assertNull($accessControlListener->onKernelRequest($event));
56		}
57
58	View Code Duplication	public function testWithEmptyTokenStorage()
		0 ignored issues – show Duplication introduced 2017-07-25 21:46 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
59		{
60		$accessControl = $this->createMock(AccessControl::class);
61		$accessControl
62		->method('isEnable')
63		->willReturn(true);
64		$accessControl
65		->method('isRouteSecure')
66		->with('secure_route')
67		->willReturn(true);
68		$tokenStorage = $this->createMock(TokenStorageInterface::class);
69		$tokenStorage
70		->method('getToken')
71		->willReturn(null);
72		$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
73		$event = $this->mockGetResponseEvent('secure_route');
74
75		$accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
76		$this->expectException(LogicException::class);
77		$accessControlListener->onKernelRequest($event);
78		}
79
80		public function testWithInvalidTokenStorage()
81		{
82		$accessControl = $this->createMock(AccessControl::class);
83		$accessControl
84		->method('isEnable')
85		->willReturn(true);
86		$accessControl
87		->method('isRouteSecure')
88		->with('secure_route')
89		->willReturn(true);
90		$token = $this->createMock(TokenInterface::class);
91		$token
92		->method('getUser')
93		->willReturn('invalid user type');
94		$tokenStorage = $this->createMock(TokenStorageInterface::class);
95		$tokenStorage
96		->method('getToken')
97		->willReturn($token);
98		$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
99		$event = $this->mockGetResponseEvent('secure_route');
100
101		$accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
102		$this->expectException(LogicException::class);
103		$accessControlListener->onKernelRequest($event);
104		}
105
106	View Code Duplication	public function testWithCorrectAccessForUser()
		0 ignored issues – show Duplication introduced 2017-07-25 21:46 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
107		{
108		$accessControl = $this->createMock(AccessControl::class);
109		$accessControl
110		->method('isEnable')
111		->willReturn(true);
112		$accessControl
113		->method('isRouteSecure')
114		->with('secure_route')
115		->willReturn(true);
116		$accessControl
117		->method('hasUserAccessToRoute')
118		->willReturn(true);
119		$tokenStorage = $this->mockTokenStorage();
120		$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
121		$event = $this->mockGetResponseEvent('secure_route');
122
123		$accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
124		$this->assertNull($accessControlListener->onKernelRequest($event));
125		}
126
127	View Code Duplication	public function testWithIncorrectAccessForUser()
		0 ignored issues – show Duplication introduced 2017-07-25 21:46 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
128		{
129		$accessControl = $this->createMock(AccessControl::class);
130		$accessControl
131		->method('isEnable')
132		->willReturn(true);
133		$accessControl
134		->method('isRouteSecure')
135		->with('secure_route')
136		->willReturn(true);
137		$accessControl
138		->method('hasUserAccessToRoute')
139		->willReturn(false);
140		$tokenStorage = $this->mockTokenStorage();
141		$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
142		$event = $this->mockGetResponseEvent('secure_route');
143
144		$accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
145		$this->expectException(AccessDeniedException::class);
146		$this->assertNull($accessControlListener->onKernelRequest($event));
147		}
148
149		public function testWithIncorrectAccessForUserAndCustomResponse()
150		{
151		$accessControl = $this->createMock(AccessControl::class);
152		$accessControl
153		->method('isEnable')
154		->willReturn(true);
155		$accessControl
156		->method('isRouteSecure')
157		->with('secure_route')
158		->willReturn(true);
159		$accessControl
160		->method('hasUserAccessToRoute')
161		->willReturn(false);
162		$tokenStorage = $this->mockTokenStorage();
163		$event = $this->mockGetResponseEvent('secure_route');
164		$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
165		$response = new Response('Custom Response');
166		$eventDispatcher
167		->expects($this->once())
168		->method('dispatch')
169		->with(AccessDeniedToRouteEvent::ON_ACCESS_DENIED_TO_ROUTE, $this->isInstanceOf(AccessDeniedToRouteEvent::class))
170		->will($this->returnCallback(function ($name, $access_denied_event) use ($response) {
171		$access_denied_event->setResponse($response);
172		}));
173
174		$accessControlListener = new AccessControlListener($accessControl, $tokenStorage, $eventDispatcher);
175		$this->assertInstanceOf(GetResponseEvent::class, $accessControlListener->onKernelRequest($event));
176		}
177
178		protected function mockGetResponseEvent($route = null)
179		{
180		$event = $this->createMock(GetResponseEvent::class);
181		$request = $this->createMock(Request::class);
182		$parameterBag = $this->createMock(ParameterBag::class);
183		$parameterBag
184		->method('get')
185		->with('_route')
186		->willReturn($route);
187
188		$request->attributes = $parameterBag;
189		$event->method('getRequest')->willReturn($request);
190
191		return $event;
192		}
193
194		protected function mockTokenStorage($roles = [])
195		{
196		$tokenStorage = $this->createMock(TokenStorageInterface::class);
197		$user = $this->createMock(UserInterface::class);
198		$user
199		->method('getRoles')
200		->willReturn($roles);
201		$token = $this->createMock(TokenInterface::class);
202		$token
203		->method('getUser')
204		->willReturn($user);
205		$tokenStorage
206		->method('getToken')
207		->willReturn($token);
208
209		return $tokenStorage;
210		}
211		}
212

SimLibaud / SilRouteSecurityBundle

Push — master ( 078409...14d907 )

AccessControlListenerTest A

Complexity

Size/Duplication

Importance

9 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like