UserContextSubscriberTest::testOnKernelRequestNonMaster() - Code Metrics - Inspection of "Merge pull request #299 from FriendsOfSymfony/upda..." - FriendsOfSymfony/FOSHttpCacheBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9de1be...100987 )

by David

created 2016-07-01 17:14 UTC

testOnKernelRequestNonMaster() A

↳ Parent: UserContextSubscriberTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	16
Code Lines	10

Duplication

Lines	16
Ratio	100 %

Importance

Changes

Metric	Value
dl	16
loc	16
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	10
nc	1
nop	0

<?php

/*
 * This file is part of the FOSHttpCacheBundle package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\HttpCacheBundle\Tests\Unit\EventListener;

use FOS\HttpCacheBundle\EventListener\UserContextSubscriber;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Symfony\Component\HttpKernel\HttpKernelInterface;
use Symfony\Component\Routing\Matcher\RequestMatcherInterface;

class UserContextSubscriberTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @expectedException \InvalidArgumentException
     */
    public function testMisconfiguration()
    {
        new UserContextSubscriber(
            \Mockery::mock('\Symfony\Component\HttpFoundation\RequestMatcherInterface'),
            \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator'),
            array()
        );
    }

    public function testOnKernelRequest()

    {
        $request = new Request();
        $request->setMethod('HEAD');

        $requestMatcher = $this->getRequestMatcher($request, true);
        $hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
        $hashGenerator->shouldReceive('generateHash')->andReturn('hash');

        $userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
        $event = $this->getKernelRequestEvent($request);

        $userContextSubscriber->onKernelRequest($event);

        $response = $event->getResponse();

        $this->assertNotNull($response);
        $this->assertInstanceOf('\Symfony\Component\HttpFoundation\Response', $response);
        $this->assertEquals('hash', $response->headers->get('X-Hash'));
        $this->assertNull($response->headers->get('Vary'));
        $this->assertEquals('max-age=0, no-cache, private', $response->headers->get('Cache-Control'));
    }

    public function testOnKernelRequestNonMaster()

    {
        $request = new Request();
        $request->setMethod('HEAD');

        $requestMatcher = $this->getRequestMatcher($request, true);
        $hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
        $hashGenerator->shouldReceive('generateHash')->never();

        $userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
        $event = $this->getKernelRequestEvent($request, HttpKernelInterface::SUB_REQUEST);

        $userContextSubscriber->onKernelRequest($event);

        $this->assertNull($event->getResponse());
    }

    public function testOnKernelRequestCached()

    {
        $request = new Request();
        $request->setMethod('HEAD');

        $requestMatcher = $this->getRequestMatcher($request, true);
        $hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
        $hashGenerator->shouldReceive('generateHash')->andReturn('hash');

        $userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash', 30);
        $event = $this->getKernelRequestEvent($request);

        $userContextSubscriber->onKernelRequest($event);

        $response = $event->getResponse();

        $this->assertNotNull($response);
        $this->assertInstanceOf('\Symfony\Component\HttpFoundation\Response', $response);
        $this->assertEquals('hash', $response->headers->get('X-Hash'));
        $this->assertEquals('X-SessionId', $response->headers->get('Vary'));
        $this->assertEquals('max-age=30, public', $response->headers->get('Cache-Control'));
    }

    public function testOnKernelRequestNotMatched()

    {
        $request = new Request();
        $request->setMethod('HEAD');

        $requestMatcher = $this->getRequestMatcher($request, false);
        $hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
        $hashGenerator->shouldReceive('generateHash')->andReturn('hash');

        $userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
        $event = $this->getKernelRequestEvent($request);

        $userContextSubscriber->onKernelRequest($event);

        $response = $event->getResponse();

        $this->assertNull($response);
    }

    public function testOnKernelResponse()
    {
        $request = new Request();
        $request->setMethod('HEAD');
        $request->headers->set('X-Hash', 'hash');

        $requestMatcher = $this->getRequestMatcher($request, false);
        $hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');

        $userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
        $event = $this->getKernelResponseEvent($request);

        $userContextSubscriber->onKernelResponse($event);

        $this->assertTrue($event->getResponse()->headers->has('Vary'), 'Vary header must be set');
        $this->assertContains('X-Hash', $event->getResponse()->headers->get('Vary'));
    }

    public function testOnKernelResponseNotMaster()

    {
        $request = new Request();
        $request->setMethod('HEAD');
        $request->headers->set('X-Hash', 'hash');

        $requestMatcher = $this->getRequestMatcher($request, false);
        $hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');

        $userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
        $event = $this->getKernelResponseEvent($request, null, HttpKernelInterface::SUB_REQUEST);

        $userContextSubscriber->onKernelResponse($event);

        $this->assertFalse($event->getResponse()->headers->has('Vary'));
    }

    /**
     * If there is no hash in the request, vary on the user identifier.
     */
    public function testOnKernelResponseNotCached()

    {
        $request = new Request();
        $request->setMethod('HEAD');

        $requestMatcher = $this->getRequestMatcher($request, false);
        $hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');

        $userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
        $event = $this->getKernelResponseEvent($request);

        $userContextSubscriber->onKernelResponse($event);

        $this->assertEquals('X-SessionId', $event->getResponse()->headers->get('Vary'));
    }

    /**
     * If there is no hash in the request, vary on the user identifier.
     */
    public function testFullRequestHashOk()
    {
        $request = new Request();
        $request->setMethod('GET');
        $request->headers->set('X-Hash', 'hash');

        $requestMatcher = $this->getRequestMatcher($request, false);
        $hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
        $hashGenerator->shouldReceive('generateHash')->andReturn('hash');

        // onKernelRequest
        $userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
        $event = $this->getKernelRequestEvent($request);

        $userContextSubscriber->onKernelRequest($event);

        $response = $event->getResponse();

        $this->assertNull($response);

        // onKernelResponse
        $event = $this->getKernelResponseEvent($request);
        $userContextSubscriber->onKernelResponse($event);

        $this->assertContains('X-Hash', $event->getResponse()->headers->get('Vary'));
    }

    /**
     * If there is no hash in the requests but session changed, prevent setting bad cache.
     */
    public function testFullRequestHashChanged()
    {
        $request = new Request();
        $request->setMethod('GET');
        $request->headers->set('X-Hash', 'hash');

        $requestMatcher = $this->getRequestMatcher($request, false);
        $hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
        $hashGenerator->shouldReceive('generateHash')->andReturn('hash-changed');

        // onKernelRequest
        $userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
        $event = $this->getKernelRequestEvent($request);

        $userContextSubscriber->onKernelRequest($event);

        $response = $event->getResponse();

        $this->assertNull($response);

        // onKernelResponse
        $event = $this->getKernelResponseEvent($request);
        $userContextSubscriber->onKernelResponse($event);

        $this->assertFalse($event->getResponse()->headers->has('Vary'));
        $this->assertEquals('max-age=0, no-cache, private', $event->getResponse()->headers->get('Cache-Control'));
    }

    protected function getKernelRequestEvent(Request $request, $type = HttpKernelInterface::MASTER_REQUEST)
    {
        return new GetResponseEvent(
            \Mockery::mock('\Symfony\Component\HttpKernel\HttpKernelInterface'),
            $request,
            $type
        );
    }

    protected function getKernelResponseEvent(Request $request, Response $response = null, $type = HttpKernelInterface::MASTER_REQUEST)

    {
        return new FilterResponseEvent(
            \Mockery::mock('\Symfony\Component\HttpKernel\HttpKernelInterface'),
            $request,
            $type,
            $response ?: new Response()
        );
    }

    /**
     * @param Request $request
     * @param bool    $match
     *
     * @return \Mockery\MockInterface|RequestMatcherInterface
     */
    private function getRequestMatcher(Request $request, $match)
    {
        $requestMatcher = \Mockery::mock('\Symfony\Component\HttpFoundation\RequestMatcherInterface');
        $requestMatcher->shouldReceive('matches')->with($request)->andReturn($match);

        return $requestMatcher;
    }
}


1		<?php
2
3		/*
4		* This file is part of the FOSHttpCacheBundle package.
5		*
6		* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace FOS\HttpCacheBundle\Tests\Unit\EventListener;
13
14		use FOS\HttpCacheBundle\EventListener\UserContextSubscriber;
15		use Symfony\Component\HttpFoundation\Request;
16		use Symfony\Component\HttpFoundation\Response;
17		use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
18		use Symfony\Component\HttpKernel\Event\GetResponseEvent;
19		use Symfony\Component\HttpKernel\HttpKernelInterface;
20		use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
21
22		class UserContextSubscriberTest extends \PHPUnit_Framework_TestCase
23		{
24		/**
25		* @expectedException \InvalidArgumentException
26		*/
27		public function testMisconfiguration()
28		{
29		new UserContextSubscriber(
30		\Mockery::mock('\Symfony\Component\HttpFoundation\RequestMatcherInterface'),
31		\Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator'),
32		array()
33		);
34		}
35
36	View Code Duplication	public function testOnKernelRequest()
		0 ignored issues – show Duplication introduced 2015-12-04 10:14 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...
37		{
38		$request = new Request();
39		$request->setMethod('HEAD');
40
41		$requestMatcher = $this->getRequestMatcher($request, true);
42		$hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
43		$hashGenerator->shouldReceive('generateHash')->andReturn('hash');
44
45		$userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
46		$event = $this->getKernelRequestEvent($request);
47
48		$userContextSubscriber->onKernelRequest($event);
49
50		$response = $event->getResponse();
51
52		$this->assertNotNull($response);
53		$this->assertInstanceOf('\Symfony\Component\HttpFoundation\Response', $response);
54		$this->assertEquals('hash', $response->headers->get('X-Hash'));
55		$this->assertNull($response->headers->get('Vary'));
56		$this->assertEquals('max-age=0, no-cache, private', $response->headers->get('Cache-Control'));
57		}
58
59	View Code Duplication	public function testOnKernelRequestNonMaster()
		0 ignored issues – show Duplication introduced 2016-01-08 10:19 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...
60		{
61		$request = new Request();
62		$request->setMethod('HEAD');
63
64		$requestMatcher = $this->getRequestMatcher($request, true);
65		$hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
66		$hashGenerator->shouldReceive('generateHash')->never();
67
68		$userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
69		$event = $this->getKernelRequestEvent($request, HttpKernelInterface::SUB_REQUEST);
70
71		$userContextSubscriber->onKernelRequest($event);
72
73		$this->assertNull($event->getResponse());
74		}
75
76	View Code Duplication	public function testOnKernelRequestCached()
		0 ignored issues – show Duplication introduced 2015-12-04 10:14 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...
77		{
78		$request = new Request();
79		$request->setMethod('HEAD');
80
81		$requestMatcher = $this->getRequestMatcher($request, true);
82		$hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
83		$hashGenerator->shouldReceive('generateHash')->andReturn('hash');
84
85		$userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash', 30);
86		$event = $this->getKernelRequestEvent($request);
87
88		$userContextSubscriber->onKernelRequest($event);
89
90		$response = $event->getResponse();
91
92		$this->assertNotNull($response);
93		$this->assertInstanceOf('\Symfony\Component\HttpFoundation\Response', $response);
94		$this->assertEquals('hash', $response->headers->get('X-Hash'));
95		$this->assertEquals('X-SessionId', $response->headers->get('Vary'));
96		$this->assertEquals('max-age=30, public', $response->headers->get('Cache-Control'));
97		}
98
99	View Code Duplication	public function testOnKernelRequestNotMatched()
		0 ignored issues – show Duplication introduced 2016-01-08 10:19 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...
100		{
101		$request = new Request();
102		$request->setMethod('HEAD');
103
104		$requestMatcher = $this->getRequestMatcher($request, false);
105		$hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
106		$hashGenerator->shouldReceive('generateHash')->andReturn('hash');
107
108		$userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
109		$event = $this->getKernelRequestEvent($request);
110
111		$userContextSubscriber->onKernelRequest($event);
112
113		$response = $event->getResponse();
114
115		$this->assertNull($response);
116		}
117
118		public function testOnKernelResponse()
119		{
120		$request = new Request();
121		$request->setMethod('HEAD');
122		$request->headers->set('X-Hash', 'hash');
123
124		$requestMatcher = $this->getRequestMatcher($request, false);
125		$hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
126
127		$userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
128		$event = $this->getKernelResponseEvent($request);
129
130		$userContextSubscriber->onKernelResponse($event);
131
132		$this->assertTrue($event->getResponse()->headers->has('Vary'), 'Vary header must be set');
133		$this->assertContains('X-Hash', $event->getResponse()->headers->get('Vary'));
134		}
135
136	View Code Duplication	public function testOnKernelResponseNotMaster()
		0 ignored issues – show Duplication introduced 2015-12-04 10:14 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...
137		{
138		$request = new Request();
139		$request->setMethod('HEAD');
140		$request->headers->set('X-Hash', 'hash');
141
142		$requestMatcher = $this->getRequestMatcher($request, false);
143		$hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
144
145		$userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
146		$event = $this->getKernelResponseEvent($request, null, HttpKernelInterface::SUB_REQUEST);
147
148		$userContextSubscriber->onKernelResponse($event);
149
150		$this->assertFalse($event->getResponse()->headers->has('Vary'));
151		}
152
153		/**
154		* If there is no hash in the request, vary on the user identifier.
155		*/
156	View Code Duplication	public function testOnKernelResponseNotCached()
		0 ignored issues – show Duplication introduced 2015-12-04 10:14 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...
157		{
158		$request = new Request();
159		$request->setMethod('HEAD');
160
161		$requestMatcher = $this->getRequestMatcher($request, false);
162		$hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
163
164		$userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
165		$event = $this->getKernelResponseEvent($request);
166
167		$userContextSubscriber->onKernelResponse($event);
168
169		$this->assertEquals('X-SessionId', $event->getResponse()->headers->get('Vary'));
170		}
171
172		/**
173		* If there is no hash in the request, vary on the user identifier.
174		*/
175		public function testFullRequestHashOk()
176		{
177		$request = new Request();
178		$request->setMethod('GET');
179		$request->headers->set('X-Hash', 'hash');
180
181		$requestMatcher = $this->getRequestMatcher($request, false);
182		$hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
183		$hashGenerator->shouldReceive('generateHash')->andReturn('hash');
184
185		// onKernelRequest
186		$userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
187		$event = $this->getKernelRequestEvent($request);
188
189		$userContextSubscriber->onKernelRequest($event);
190
191		$response = $event->getResponse();
192
193		$this->assertNull($response);
194
195		// onKernelResponse
196		$event = $this->getKernelResponseEvent($request);
197		$userContextSubscriber->onKernelResponse($event);
198
199		$this->assertContains('X-Hash', $event->getResponse()->headers->get('Vary'));
200		}
201
202		/**
203		* If there is no hash in the requests but session changed, prevent setting bad cache.
204		*/
205		public function testFullRequestHashChanged()
206		{
207		$request = new Request();
208		$request->setMethod('GET');
209		$request->headers->set('X-Hash', 'hash');
210
211		$requestMatcher = $this->getRequestMatcher($request, false);
212		$hashGenerator = \Mockery::mock('\FOS\HttpCache\UserContext\HashGenerator');
213		$hashGenerator->shouldReceive('generateHash')->andReturn('hash-changed');
214
215		// onKernelRequest
216		$userContextSubscriber = new UserContextSubscriber($requestMatcher, $hashGenerator, array('X-SessionId'), 'X-Hash');
217		$event = $this->getKernelRequestEvent($request);
218
219		$userContextSubscriber->onKernelRequest($event);
220
221		$response = $event->getResponse();
222
223		$this->assertNull($response);
224
225		// onKernelResponse
226		$event = $this->getKernelResponseEvent($request);
227		$userContextSubscriber->onKernelResponse($event);
228
229		$this->assertFalse($event->getResponse()->headers->has('Vary'));
230		$this->assertEquals('max-age=0, no-cache, private', $event->getResponse()->headers->get('Cache-Control'));
231		}
232
233		protected function getKernelRequestEvent(Request $request, $type = HttpKernelInterface::MASTER_REQUEST)
234		{
235		return new GetResponseEvent(
236		\Mockery::mock('\Symfony\Component\HttpKernel\HttpKernelInterface'),
237		$request,
238		$type
239		);
240		}
241
242	View Code Duplication	protected function getKernelResponseEvent(Request $request, Response $response = null, $type = HttpKernelInterface::MASTER_REQUEST)
		0 ignored issues – show Duplication introduced 2015-12-04 10:14 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...
243		{
244		return new FilterResponseEvent(
245		\Mockery::mock('\Symfony\Component\HttpKernel\HttpKernelInterface'),
246		$request,
247		$type,
248		$response ?: new Response()
249		);
250		}
251
252		/**
253		* @param Request $request
254		* @param bool $match
255		*
256		* @return \Mockery\MockInterface\|RequestMatcherInterface
257		*/
258		private function getRequestMatcher(Request $request, $match)
259		{
260		$requestMatcher = \Mockery::mock('\Symfony\Component\HttpFoundation\RequestMatcherInterface');
261		$requestMatcher->shouldReceive('matches')->with($request)->andReturn($match);
262
263		return $requestMatcher;
264		}
265		}
266

FriendsOfSymfony / FOSHttpCacheBundle

Push — master ( 9de1be...100987 )

testOnKernelRequestNonMaster() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like