Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
1 | <?php |
||
14 | class RequestListenerTest extends TestCase |
||
15 | { |
||
16 | /** |
||
17 | * @var \PHPUnit_Framework_MockObject_MockObject |
||
18 | */ |
||
19 | protected $matcherMock; |
||
20 | |||
21 | /** |
||
22 | * @var \Netgen\Bundle\SiteAccessRoutesBundle\EventListener\RequestListener |
||
23 | */ |
||
24 | protected $listener; |
||
25 | |||
26 | public function setUp() |
||
27 | { |
||
28 | $this->matcherMock = $this->createMock(MatcherInterface::class); |
||
29 | |||
30 | $this->listener = new RequestListener($this->matcherMock); |
||
31 | } |
||
32 | |||
33 | /** |
||
34 | * @covers \Netgen\Bundle\SiteAccessRoutesBundle\EventListener\RequestListener::__construct |
||
35 | * @covers \Netgen\Bundle\SiteAccessRoutesBundle\EventListener\RequestListener::getSubscribedEvents |
||
36 | */ |
||
37 | public function testGetSubscribedEvents() |
||
38 | { |
||
39 | $this->assertEquals( |
||
40 | array(KernelEvents::REQUEST => array('onKernelRequest', 31)), |
||
41 | $this->listener->getSubscribedEvents() |
||
42 | ); |
||
43 | } |
||
44 | |||
45 | /** |
||
46 | * @covers \Netgen\Bundle\SiteAccessRoutesBundle\EventListener\RequestListener::onKernelRequest |
||
47 | */ |
||
48 | public function testOnKernelRequest() |
||
49 | { |
||
50 | $kernelMock = $this->createMock(HttpKernelInterface::class); |
||
51 | $request = Request::create('/'); |
||
52 | |||
53 | $request->attributes->set('allowed_siteaccess', 'cro'); |
||
54 | $request->attributes->set('siteaccess', new SiteAccess('eng')); |
||
55 | |||
56 | $this->matcherMock |
||
57 | ->expects($this->once()) |
||
58 | ->method('isAllowed') |
||
59 | ->with($this->equalTo('eng'), $this->equalTo(array('cro'))) |
||
60 | ->will($this->returnValue(true)); |
||
61 | |||
62 | $event = new GetResponseEvent($kernelMock, $request, HttpKernelInterface::MASTER_REQUEST); |
||
63 | self::assertNull($this->listener->onKernelRequest($event)); |
||
64 | } |
||
65 | |||
66 | /** |
||
67 | * @covers \Netgen\Bundle\SiteAccessRoutesBundle\EventListener\RequestListener::onKernelRequest |
||
68 | */ |
||
69 | public function testOnKernelRequestWithConfigArray() |
||
70 | { |
||
71 | $kernelMock = $this->createMock(HttpKernelInterface::class); |
||
72 | $request = Request::create('/'); |
||
73 | |||
74 | $request->attributes->set('allowed_siteaccess', array('cro', 'eng')); |
||
75 | $request->attributes->set('siteaccess', new SiteAccess('eng')); |
||
76 | |||
77 | $this->matcherMock |
||
78 | ->expects($this->once()) |
||
79 | ->method('isAllowed') |
||
80 | ->with($this->equalTo('eng'), $this->equalTo(array('cro', 'eng'))) |
||
81 | ->will($this->returnValue(true)); |
||
82 | |||
83 | $event = new GetResponseEvent($kernelMock, $request, HttpKernelInterface::MASTER_REQUEST); |
||
84 | self::assertNull($this->listener->onKernelRequest($event)); |
||
85 | } |
||
86 | |||
87 | /** |
||
88 | * @covers \Netgen\Bundle\SiteAccessRoutesBundle\EventListener\RequestListener::onKernelRequest |
||
89 | * @expectedException \Symfony\Component\HttpKernel\Exception\NotFoundHttpException |
||
90 | */ |
||
91 | public function testOnKernelRequestThrowsNotFoundHttpException() |
||
92 | { |
||
93 | $kernelMock = $this->createMock(HttpKernelInterface::class); |
||
94 | $request = Request::create('/'); |
||
95 | |||
96 | $request->attributes->set('allowed_siteaccess', array('cro', 'eng')); |
||
97 | $request->attributes->set('siteaccess', new SiteAccess('eng')); |
||
98 | |||
99 | $this->matcherMock |
||
100 | ->expects($this->once()) |
||
101 | ->method('isAllowed') |
||
102 | ->with($this->equalTo('eng'), $this->equalTo(array('cro', 'eng'))) |
||
103 | ->will($this->returnValue(false)); |
||
104 | |||
105 | $event = new GetResponseEvent($kernelMock, $request, HttpKernelInterface::MASTER_REQUEST); |
||
106 | $this->listener->onKernelRequest($event); |
||
107 | } |
||
108 | |||
109 | /** |
||
110 | * @covers \Netgen\Bundle\SiteAccessRoutesBundle\EventListener\RequestListener::onKernelRequest |
||
111 | */ |
||
112 | public function testOnKernelRequestInSubRequest() |
||
113 | { |
||
114 | $kernelMock = $this->createMock(HttpKernelInterface::class); |
||
115 | $request = Request::create('/'); |
||
116 | |||
117 | $request->attributes->set('allowed_siteaccess', array('cro', 'eng')); |
||
118 | $request->attributes->set('siteaccess', new SiteAccess('eng')); |
||
119 | |||
120 | $this->matcherMock |
||
121 | ->expects($this->never()) |
||
122 | ->method('isAllowed'); |
||
123 | |||
124 | $event = new GetResponseEvent($kernelMock, $request, HttpKernelInterface::SUB_REQUEST); |
||
125 | self::assertNull($this->listener->onKernelRequest($event)); |
||
126 | } |
||
127 | |||
128 | /** |
||
129 | * @covers \Netgen\Bundle\SiteAccessRoutesBundle\EventListener\RequestListener::onKernelRequest |
||
130 | */ |
||
131 | public function testOnKernelRequestWithNoSiteAccess() |
||
132 | { |
||
133 | $kernelMock = $this->createMock(HttpKernelInterface::class); |
||
134 | $request = Request::create('/'); |
||
135 | |||
136 | $request->attributes->set('allowed_siteaccess', array('cro', 'eng')); |
||
137 | |||
138 | $this->matcherMock |
||
139 | ->expects($this->never()) |
||
140 | ->method('isAllowed'); |
||
141 | |||
142 | $event = new GetResponseEvent($kernelMock, $request, HttpKernelInterface::MASTER_REQUEST); |
||
143 | self::assertNull($this->listener->onKernelRequest($event)); |
||
144 | } |
||
145 | |||
146 | /** |
||
147 | * @covers \Netgen\Bundle\SiteAccessRoutesBundle\EventListener\RequestListener::onKernelRequest |
||
148 | */ |
||
149 | public function testOnKernelRequestWithNoConfig() |
||
150 | { |
||
151 | $kernelMock = $this->createMock(HttpKernelInterface::class); |
||
152 | $request = Request::create('/'); |
||
153 | |||
154 | $request->attributes->set('siteaccess', new SiteAccess('eng')); |
||
155 | |||
156 | $this->matcherMock |
||
157 | ->expects($this->never()) |
||
158 | ->method('isAllowed'); |
||
159 | |||
160 | $event = new GetResponseEvent($kernelMock, $request, HttpKernelInterface::MASTER_REQUEST); |
||
161 | self::assertNull($this->listener->onKernelRequest($event)); |
||
162 | } |
||
163 | |||
164 | /** |
||
165 | * @covers \Netgen\Bundle\SiteAccessRoutesBundle\EventListener\RequestListener::onKernelRequest |
||
166 | */ |
||
167 | public function testOnKernelRequestWithEmptyConfig() |
||
168 | { |
||
169 | $kernelMock = $this->createMock(HttpKernelInterface::class); |
||
170 | $request = Request::create('/'); |
||
171 | |||
172 | $request->attributes->set('allowed_siteaccess', array()); |
||
173 | $request->attributes->set('siteaccess', new SiteAccess('eng')); |
||
174 | |||
175 | $this->matcherMock |
||
176 | ->expects($this->never()) |
||
177 | ->method('isAllowed'); |
||
178 | |||
179 | $event = new GetResponseEvent($kernelMock, $request, HttpKernelInterface::MASTER_REQUEST); |
||
180 | self::assertNull($this->listener->onKernelRequest($event)); |
||
181 | } |
||
182 | } |
||
183 |