2010-06-23 20:42:41 +01:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/*
|
2011-01-15 13:29:43 +00:00
|
|
|
* This file is part of the Symfony package.
|
2010-06-23 20:42:41 +01:00
|
|
|
*
|
2011-03-06 11:40:06 +00:00
|
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
2010-06-23 20:42:41 +01:00
|
|
|
*
|
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
|
|
|
*/
|
|
|
|
|
2012-03-28 14:43:52 +01:00
|
|
|
namespace Symfony\Component\HttpKernel\Tests\HttpCache;
|
2010-06-23 20:42:41 +01:00
|
|
|
|
2010-08-20 22:09:55 +01:00
|
|
|
use Symfony\Component\HttpFoundation\Request;
|
|
|
|
use Symfony\Component\HttpFoundation\Response;
|
2011-01-26 20:38:45 +00:00
|
|
|
use Symfony\Component\HttpKernel\HttpCache\Store;
|
2010-06-23 20:42:41 +01:00
|
|
|
|
2011-01-26 20:38:45 +00:00
|
|
|
class StoreTest extends \PHPUnit_Framework_TestCase
|
2010-06-23 20:42:41 +01:00
|
|
|
{
|
|
|
|
protected $request;
|
|
|
|
protected $response;
|
|
|
|
protected $store;
|
|
|
|
|
2010-12-06 14:45:37 +00:00
|
|
|
protected function setUp()
|
2010-06-23 20:42:41 +01:00
|
|
|
{
|
|
|
|
$this->request = Request::create('/');
|
|
|
|
$this->response = new Response('hello world', 200, array());
|
|
|
|
|
2011-01-26 20:38:45 +00:00
|
|
|
HttpCacheTestCase::clearDirectory(sys_get_temp_dir().'/http_cache');
|
2010-06-23 20:42:41 +01:00
|
|
|
|
|
|
|
$this->store = new Store(sys_get_temp_dir().'/http_cache');
|
|
|
|
}
|
|
|
|
|
2010-12-06 14:45:37 +00:00
|
|
|
protected function tearDown()
|
2010-06-23 20:42:41 +01:00
|
|
|
{
|
|
|
|
$this->store = null;
|
2011-06-14 09:44:38 +01:00
|
|
|
$this->request = null;
|
|
|
|
$this->response = null;
|
2010-06-23 20:42:41 +01:00
|
|
|
|
2011-01-26 20:38:45 +00:00
|
|
|
HttpCacheTestCase::clearDirectory(sys_get_temp_dir().'/http_cache');
|
2010-06-23 20:42:41 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
public function testReadsAnEmptyArrayWithReadWhenNothingCachedAtKey()
|
|
|
|
{
|
2011-01-31 13:10:53 +00:00
|
|
|
$this->assertEmpty($this->getStoreMetadata('/nothing'));
|
2010-06-23 20:42:41 +01:00
|
|
|
}
|
|
|
|
|
2012-11-08 17:03:02 +00:00
|
|
|
public function testUnlockFileThatDoesExist()
|
|
|
|
{
|
|
|
|
$cacheKey = $this->storeSimpleEntry();
|
|
|
|
$this->store->lock($this->request);
|
|
|
|
|
|
|
|
$this->assertTrue($this->store->unlock($this->request));
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testUnlockFileThatDoesNotExist()
|
|
|
|
{
|
|
|
|
$this->assertFalse($this->store->unlock($this->request));
|
|
|
|
}
|
|
|
|
|
2010-06-23 20:42:41 +01:00
|
|
|
public function testRemovesEntriesForKeyWithPurge()
|
|
|
|
{
|
|
|
|
$request = Request::create('/foo');
|
|
|
|
$this->store->write($request, new Response('foo'));
|
2013-03-17 13:48:26 +00:00
|
|
|
|
|
|
|
$metadata = $this->getStoreMetadata($request);
|
|
|
|
$this->assertNotEmpty($metadata);
|
2010-06-23 20:42:41 +01:00
|
|
|
|
2010-10-30 15:36:56 +01:00
|
|
|
$this->assertTrue($this->store->purge('/foo'));
|
2011-01-31 13:10:53 +00:00
|
|
|
$this->assertEmpty($this->getStoreMetadata($request));
|
2010-10-30 15:36:56 +01:00
|
|
|
|
2013-03-17 13:48:26 +00:00
|
|
|
// cached content should be kept after purging
|
|
|
|
$path = $this->store->getPath($metadata[0][1]['x-content-digest'][0]);
|
|
|
|
$this->assertTrue(is_file($path));
|
|
|
|
|
2010-10-30 15:36:56 +01:00
|
|
|
$this->assertFalse($this->store->purge('/bar'));
|
2010-06-23 20:42:41 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
public function testStoresACacheEntry()
|
|
|
|
{
|
|
|
|
$cacheKey = $this->storeSimpleEntry();
|
|
|
|
|
2011-01-31 13:10:53 +00:00
|
|
|
$this->assertNotEmpty($this->getStoreMetadata($cacheKey));
|
2010-06-23 20:42:41 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
public function testSetsTheXContentDigestResponseHeaderBeforeStoring()
|
|
|
|
{
|
|
|
|
$cacheKey = $this->storeSimpleEntry();
|
2011-01-31 13:10:53 +00:00
|
|
|
$entries = $this->getStoreMetadata($cacheKey);
|
2014-12-02 19:42:47 +00:00
|
|
|
list($req, $res) = $entries[0];
|
2010-06-23 20:42:41 +01:00
|
|
|
|
|
|
|
$this->assertEquals('ena94a8fe5ccb19ba61c4c0873d391e987982fbbd3', $res['x-content-digest'][0]);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testFindsAStoredEntryWithLookup()
|
|
|
|
{
|
|
|
|
$this->storeSimpleEntry();
|
|
|
|
$response = $this->store->lookup($this->request);
|
|
|
|
|
|
|
|
$this->assertNotNull($response);
|
2010-08-20 22:09:55 +01:00
|
|
|
$this->assertInstanceOf('Symfony\Component\HttpFoundation\Response', $response);
|
2010-06-23 20:42:41 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
public function testDoesNotFindAnEntryWithLookupWhenNoneExists()
|
|
|
|
{
|
|
|
|
$request = Request::create('/test', 'get', array(), array(), array(), array('HTTP_FOO' => 'Foo', 'HTTP_BAR' => 'Bar'));
|
|
|
|
|
|
|
|
$this->assertNull($this->store->lookup($request));
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testCanonizesUrlsForCacheKeys()
|
|
|
|
{
|
|
|
|
$this->storeSimpleEntry($path = '/test?x=y&p=q');
|
|
|
|
$hitsReq = Request::create($path);
|
|
|
|
$missReq = Request::create('/test?p=x');
|
|
|
|
|
|
|
|
$this->assertNotNull($this->store->lookup($hitsReq));
|
|
|
|
$this->assertNull($this->store->lookup($missReq));
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testDoesNotFindAnEntryWithLookupWhenTheBodyDoesNotExist()
|
|
|
|
{
|
|
|
|
$this->storeSimpleEntry();
|
|
|
|
$this->assertNotNull($this->response->headers->get('X-Content-Digest'));
|
2011-01-31 13:10:53 +00:00
|
|
|
$path = $this->getStorePath($this->response->headers->get('X-Content-Digest'));
|
2010-06-23 20:42:41 +01:00
|
|
|
@unlink($path);
|
|
|
|
$this->assertNull($this->store->lookup($this->request));
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testRestoresResponseHeadersProperlyWithLookup()
|
|
|
|
{
|
|
|
|
$this->storeSimpleEntry();
|
|
|
|
$response = $this->store->lookup($this->request);
|
|
|
|
|
2011-01-31 13:10:53 +00:00
|
|
|
$this->assertEquals($response->headers->all(), array_merge(array('content-length' => 4, 'x-body-file' => array($this->getStorePath($response->headers->get('X-Content-Digest')))), $this->response->headers->all()));
|
2010-06-23 20:42:41 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
public function testRestoresResponseContentFromEntityStoreWithLookup()
|
|
|
|
{
|
|
|
|
$this->storeSimpleEntry();
|
|
|
|
$response = $this->store->lookup($this->request);
|
2011-01-31 13:10:53 +00:00
|
|
|
$this->assertEquals($this->getStorePath('en'.sha1('test')), $response->getContent());
|
2010-06-23 20:42:41 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
public function testInvalidatesMetaAndEntityStoreEntriesWithInvalidate()
|
|
|
|
{
|
|
|
|
$this->storeSimpleEntry();
|
|
|
|
$this->store->invalidate($this->request);
|
|
|
|
$response = $this->store->lookup($this->request);
|
2010-08-20 22:09:55 +01:00
|
|
|
$this->assertInstanceOf('Symfony\Component\HttpFoundation\Response', $response);
|
2010-06-23 20:42:41 +01:00
|
|
|
$this->assertFalse($response->isFresh());
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testSucceedsQuietlyWhenInvalidateCalledWithNoMatchingEntries()
|
|
|
|
{
|
|
|
|
$req = Request::create('/test');
|
|
|
|
$this->store->invalidate($req);
|
|
|
|
$this->assertNull($this->store->lookup($this->request));
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testDoesNotReturnEntriesThatVaryWithLookup()
|
|
|
|
{
|
|
|
|
$req1 = Request::create('/test', 'get', array(), array(), array(), array('HTTP_FOO' => 'Foo', 'HTTP_BAR' => 'Bar'));
|
|
|
|
$req2 = Request::create('/test', 'get', array(), array(), array(), array('HTTP_FOO' => 'Bling', 'HTTP_BAR' => 'Bam'));
|
|
|
|
$res = new Response('test', 200, array('Vary' => 'Foo Bar'));
|
|
|
|
$this->store->write($req1, $res);
|
|
|
|
|
|
|
|
$this->assertNull($this->store->lookup($req2));
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testStoresMultipleResponsesForEachVaryCombination()
|
|
|
|
{
|
|
|
|
$req1 = Request::create('/test', 'get', array(), array(), array(), array('HTTP_FOO' => 'Foo', 'HTTP_BAR' => 'Bar'));
|
|
|
|
$res1 = new Response('test 1', 200, array('Vary' => 'Foo Bar'));
|
|
|
|
$key = $this->store->write($req1, $res1);
|
|
|
|
|
|
|
|
$req2 = Request::create('/test', 'get', array(), array(), array(), array('HTTP_FOO' => 'Bling', 'HTTP_BAR' => 'Bam'));
|
|
|
|
$res2 = new Response('test 2', 200, array('Vary' => 'Foo Bar'));
|
|
|
|
$this->store->write($req2, $res2);
|
|
|
|
|
|
|
|
$req3 = Request::create('/test', 'get', array(), array(), array(), array('HTTP_FOO' => 'Baz', 'HTTP_BAR' => 'Boom'));
|
|
|
|
$res3 = new Response('test 3', 200, array('Vary' => 'Foo Bar'));
|
|
|
|
$this->store->write($req3, $res3);
|
|
|
|
|
2011-01-31 13:10:53 +00:00
|
|
|
$this->assertEquals($this->getStorePath('en'.sha1('test 3')), $this->store->lookup($req3)->getContent());
|
|
|
|
$this->assertEquals($this->getStorePath('en'.sha1('test 2')), $this->store->lookup($req2)->getContent());
|
|
|
|
$this->assertEquals($this->getStorePath('en'.sha1('test 1')), $this->store->lookup($req1)->getContent());
|
2010-06-23 20:42:41 +01:00
|
|
|
|
2012-01-18 13:42:47 +00:00
|
|
|
$this->assertCount(3, $this->getStoreMetadata($key));
|
2010-06-23 20:42:41 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
public function testOverwritesNonVaryingResponseWithStore()
|
|
|
|
{
|
|
|
|
$req1 = Request::create('/test', 'get', array(), array(), array(), array('HTTP_FOO' => 'Foo', 'HTTP_BAR' => 'Bar'));
|
|
|
|
$res1 = new Response('test 1', 200, array('Vary' => 'Foo Bar'));
|
|
|
|
$key = $this->store->write($req1, $res1);
|
2011-01-31 13:10:53 +00:00
|
|
|
$this->assertEquals($this->getStorePath('en'.sha1('test 1')), $this->store->lookup($req1)->getContent());
|
2010-06-23 20:42:41 +01:00
|
|
|
|
|
|
|
$req2 = Request::create('/test', 'get', array(), array(), array(), array('HTTP_FOO' => 'Bling', 'HTTP_BAR' => 'Bam'));
|
|
|
|
$res2 = new Response('test 2', 200, array('Vary' => 'Foo Bar'));
|
|
|
|
$this->store->write($req2, $res2);
|
2011-01-31 13:10:53 +00:00
|
|
|
$this->assertEquals($this->getStorePath('en'.sha1('test 2')), $this->store->lookup($req2)->getContent());
|
2010-06-23 20:42:41 +01:00
|
|
|
|
|
|
|
$req3 = Request::create('/test', 'get', array(), array(), array(), array('HTTP_FOO' => 'Foo', 'HTTP_BAR' => 'Bar'));
|
|
|
|
$res3 = new Response('test 3', 200, array('Vary' => 'Foo Bar'));
|
|
|
|
$key = $this->store->write($req3, $res3);
|
2011-01-31 13:10:53 +00:00
|
|
|
$this->assertEquals($this->getStorePath('en'.sha1('test 3')), $this->store->lookup($req3)->getContent());
|
2010-06-23 20:42:41 +01:00
|
|
|
|
2012-01-18 13:42:47 +00:00
|
|
|
$this->assertCount(2, $this->getStoreMetadata($key));
|
2010-06-23 20:42:41 +01:00
|
|
|
}
|
|
|
|
|
2012-08-30 05:05:27 +01:00
|
|
|
public function testLocking()
|
|
|
|
{
|
|
|
|
$req = Request::create('/test', 'get', array(), array(), array(), array('HTTP_FOO' => 'Foo', 'HTTP_BAR' => 'Bar'));
|
|
|
|
$this->assertTrue($this->store->lock($req));
|
|
|
|
|
|
|
|
$path = $this->store->lock($req);
|
|
|
|
$this->assertTrue($this->store->isLocked($req));
|
|
|
|
|
|
|
|
$this->store->unlock($req);
|
|
|
|
$this->assertFalse($this->store->isLocked($req));
|
|
|
|
}
|
|
|
|
|
2010-06-23 20:42:41 +01:00
|
|
|
protected function storeSimpleEntry($path = null, $headers = array())
|
|
|
|
{
|
|
|
|
if (null === $path) {
|
|
|
|
$path = '/test';
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->request = Request::create($path, 'get', array(), array(), array(), $headers);
|
|
|
|
$this->response = new Response('test', 200, array('Cache-Control' => 'max-age=420'));
|
|
|
|
|
|
|
|
return $this->store->write($this->request, $this->response);
|
|
|
|
}
|
2011-01-31 13:10:53 +00:00
|
|
|
|
|
|
|
protected function getStoreMetadata($key)
|
|
|
|
{
|
|
|
|
$r = new \ReflectionObject($this->store);
|
|
|
|
$m = $r->getMethod('getMetadata');
|
|
|
|
$m->setAccessible(true);
|
|
|
|
|
|
|
|
if ($key instanceof Request) {
|
|
|
|
$m1 = $r->getMethod('getCacheKey');
|
|
|
|
$m1->setAccessible(true);
|
|
|
|
$key = $m1->invoke($this->store, $key);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $m->invoke($this->store, $key);
|
|
|
|
}
|
|
|
|
|
|
|
|
protected function getStorePath($key)
|
|
|
|
{
|
|
|
|
$r = new \ReflectionObject($this->store);
|
|
|
|
$m = $r->getMethod('getPath');
|
|
|
|
$m->setAccessible(true);
|
|
|
|
|
|
|
|
return $m->invoke($this->store, $key);
|
|
|
|
}
|
2010-06-23 20:42:41 +01:00
|
|
|
}
|