[HttpKernel] Add test coverage for cache warming

symfony · jmikola · Feb 5, 2011 · Jan 24, 2011 · Feb 5, 2011 · Feb 2, 2011
commit bd97471954f18ac3843a618ccc968e2d297a3b80
diff --git a/tests/Symfony/Tests/Component/HttpKernel/CacheWarmer/CacheWarmerAggregateTest.php b/tests/Symfony/Tests/Component/HttpKernel/CacheWarmer/CacheWarmerAggregateTest.php
@@ -0,0 +1,97 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Tests\Component\HttpKernel\CacheWarmer;
+
+use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
+use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerAggregate;
+use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmer;
+
+class CacheWarmerAggregateTest extends \PHPUnit_Framework_TestCase
+{
+    protected static $cacheDir;
+
+    public static function setUpBeforeClass()
+    {
+        self::$cacheDir = tempnam(sys_get_temp_dir(), 'sf2_cache_warmer_dir');
+    }
+
+    public function testInjectWarmersUsingConstructor()
+    {
+        $warmer = $this->getCacheWarmerMock();
+        $warmer
+            ->expects($this->once())
+            ->method('warmUp');
+        $aggregate = new CacheWarmerAggregate(array($warmer));
+        $aggregate->warmUp(self::$cacheDir);
+    }
+
+    public function testInjectWarmersUsingAdd()
+    {
+        $warmer = $this->getCacheWarmerMock();
+        $warmer
+            ->expects($this->once())
+            ->method('warmUp');
+        $aggregate = new CacheWarmerAggregate();
+        $aggregate->add($warmer);
+        $aggregate->warmUp(self::$cacheDir);
+    }
+
+    public function testInjectWarmersUsingSetWarmers()
+    {
+        $warmer = $this->getCacheWarmerMock();
+        $warmer
+            ->expects($this->once())
+            ->method('warmUp');
+        $aggregate = new CacheWarmerAggregate();
+        $aggregate->setWarmers(array($warmer));
+        $aggregate->warmUp(self::$cacheDir);
+    }
+
+    public function testWarmupDoesCallWarmupOnOptionalWarmersWhenEnableOptionalWarmersIsEnabled()
+    {
+        $warmer = $this->getCacheWarmerMock();
+        $warmer
+            ->expects($this->never())
+            ->method('isOptional');
+        $warmer
+            ->expects($this->once())
+            ->method('warmUp');
+
+        $aggregate = new CacheWarmerAggregate(array($warmer));
+        $aggregate->enableOptionalWarmers();
+        $aggregate->warmUp(self::$cacheDir);
+    }
+
+    public function testWarmupDoesNotCallWarmupOnOptionalWarmersWhenEnableOptionalWarmersIsNotEnabled()
+    {
+        $warmer = $this->getCacheWarmerMock();
+        $warmer
+            ->expects($this->once())
+            ->method('isOptional')
+            ->will($this->returnValue(true));
+        $warmer
+            ->expects($this->never())
+            ->method('warmUp');
+
+        $aggregate = new CacheWarmerAggregate(array($warmer));
+        $aggregate->warmUp(self::$cacheDir);
+    }
+
+    protected function getCacheWarmerMock()
+    {
+        $warmer = $this->getMockBuilder('Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface')
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        return $warmer;
+    }
+}
diff --git a/tests/Symfony/Tests/Component/HttpKernel/CacheWarmer/CacheWarmerTest.php b/tests/Symfony/Tests/Component/HttpKernel/CacheWarmer/CacheWarmerTest.php
@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Tests\Component\HttpKernel\CacheWarmer;
+
+use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
+use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmer;
+
+class CacheWarmerTest extends \PHPUnit_Framework_TestCase
+{
+    protected static $cacheFile;
+
+    public static function setUpBeforeClass()
+    {
+        self::$cacheFile = tempnam(sys_get_temp_dir(), 'sf2_cache_warmer_dir');
+    }
+
+    public static function tearDownAfterClass()
+    {
+        @unlink(self::$cacheFile);
+    }
+
+    public function testWriteCacheFileCreatesTheFile()
+    {
+        $warmer = new TestCacheWarmer(self::$cacheFile);
+        $warmer->warmUp(dirname(self::$cacheFile));
+
+        $this->assertTrue(file_exists(self::$cacheFile));
+    }
+
+    /**
+     * @expectedException \RuntimeException
+     */
+    public function testWriteNonWritableCacheFileThrowsARuntimeException()
+    {
+        $nonWritableFile = '/this/file/is/very/probably/not/writable';
+        $warmer = new TestCacheWarmer($nonWritableFile);
+        $warmer->warmUp(dirname($nonWritableFile));
+    }
+}
+
+class TestCacheWarmer extends CacheWarmer
+{
+    protected $file;
+
+    public function __construct($file)
+    {
+        $this->file = $file;
+    }
+
+    public function warmUp($cacheDir)
+    {
+        $this->writeCacheFile($this->file, 'content');
+    }
+
+    public function isOptional()
+    {
+        return false;
+    }
+}