increase test coverage and fix a bug in TagSubscriberPass

Configuration/InvalidatePath.php

@@ -23,6 +23,11 @@ class InvalidatePath extends ConfigurationAnnotation
      */
     private $paths;
 
+    /**
+     * Handle path given without explicit key.
+     *
+     * @param string $data
+     */
     public function setValue($data)
     {
         $this->setPaths((is_array($data) ? $data: array($data)));

Configuration/InvalidateRoute.php

@@ -29,6 +29,11 @@ class InvalidateRoute extends ConfigurationAnnotation
      */
     private $params;
 
+    /**
+     * Handle route name given without explicit key.
+     *
+     * @param string $value The route name.
+     */
     public function setValue($value)
     {
         $this->setName($value);
@@ -67,12 +72,14 @@ public function setParams($params)
                         print_r($value, true)
                     ));
                 }
+                // @codeCoverageIgnoreStart
                 if (!class_exists('Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {
                     throw new InvalidConfigurationException(sprintf(
                         '@InvalidateRoute param %s uses an expression but the ExpressionLanguage is not available.',
                         $name
                     ));
                 }
+                // @codeCoverageIgnoreEnd
             }
         }
 

Configuration/Tag.php

@@ -23,6 +23,11 @@ class Tag extends ConfigurationAnnotation
     private $tags;
     private $expression;
 
+    /**
+     * Handle tags given without explicit key.
+     *
+     * @param string|array $data
+     */
     public function setValue($data)
     {
         $this->setTags(is_array($data) ? $data: array($data));
@@ -33,9 +38,11 @@ public function setValue($data)
      */
     public function setExpression($expression)
     {
+        // @codeCoverageIgnoreStart
         if (!class_exists('Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {
             throw new InvalidConfigurationException('@Tag param %s uses an expression but the ExpressionLanguage is not available.');
         }
+        // @codeCoverageIgnoreEnd
         $this->expression = $expression;
     }
 

DependencyInjection/Compiler/UserContextListenerPass.php → DependencyInjection/Compiler/HashGeneratorPass.php

@@ -19,7 +19,7 @@
 /**
  * Add tagged provider to the hash generator for user context
  */
-class UserContextListenerPass implements CompilerPassInterface
+class HashGeneratorPass implements CompilerPassInterface
 {
     const TAG_NAME = "fos_http_cache.user_context_provider";
 

DependencyInjection/Compiler/TagListenerPass.php → DependencyInjection/Compiler/TagSubscriberPass.php

@@ -15,20 +15,20 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
- * Check for required ControllerListener if TagListener is enabled
+ * Check for required ControllerListener if TagSubscriber is enabled
  */
-class TagListenerPass implements CompilerPassInterface
+class TagSubscriberPass implements CompilerPassInterface
 {
     /**
      * {@inheritdoc}
      */
     public function process(ContainerBuilder $container)
     {
-        if ($container->has('fos_http_cache.tag_listener')
+        if ($container->has('fos_http_cache.event_listener.tag')
             && !$container->has('sensio_framework_extra.controller.listener')
         ) {
             throw new \RuntimeException(
-                'The TagListener requires SensioFrameworkExtraBundle’s ControllerListener. '
+                'Tag support requires SensioFrameworkExtraBundle’s ControllerListener for the annotations. '
                 . 'Please install sensio/framework-extra-bundle and add it to your AppKernel.'
             );
         }

DependencyInjection/FOSHttpCacheExtension.php

@@ -11,7 +11,7 @@
 
 namespace FOS\HttpCacheBundle\DependencyInjection;
 
-use FOS\HttpCacheBundle\DependencyInjection\Compiler\UserContextListenerPass;
+use FOS\HttpCacheBundle\DependencyInjection\Compiler\HashGeneratorPass;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\Config\FileLocator;
@@ -174,7 +174,7 @@ private function loadUserContext(ContainerBuilder $container, XmlFileLoader $loa
 
         if ($config['role_provider']) {
             $container->getDefinition($this->getAlias().'.user_context.role_provider')
-                ->addTag(UserContextListenerPass::TAG_NAME)
+                ->addTag(HashGeneratorPass::TAG_NAME)
                 ->setAbstract(false);
         }
     }

FOSHttpCacheBundle.php

@@ -12,8 +12,8 @@
 namespace FOS\HttpCacheBundle;
 
 use FOS\HttpCacheBundle\DependencyInjection\Compiler\LoggerPass;
-use FOS\HttpCacheBundle\DependencyInjection\Compiler\TagListenerPass;
-use FOS\HttpCacheBundle\DependencyInjection\Compiler\UserContextListenerPass;
+use FOS\HttpCacheBundle\DependencyInjection\Compiler\TagSubscriberPass;
+use FOS\HttpCacheBundle\DependencyInjection\Compiler\HashGeneratorPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
@@ -25,7 +25,7 @@ class FOSHttpCacheBundle extends Bundle
     public function build(ContainerBuilder $container)
     {
         $container->addCompilerPass(new LoggerPass());
-        $container->addCompilerPass(new TagListenerPass());
-        $container->addCompilerPass(new UserContextListenerPass());
+        $container->addCompilerPass(new TagSubscriberPass());
+        $container->addCompilerPass(new HashGeneratorPass());
     }
 }

Tests/Unit/Command/BaseInvalidateCommandTest.php

@@ -0,0 +1,54 @@
+<?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\Command;
+
+use FOS\HttpCacheBundle\Command\InvalidatePathCommand;
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Tester\CommandTester;
+
+class BaseInvalidateCommandTest extends \PHPUnit_Framework_TestCase
+{
+    public function testContainerAccess()
+    {
+        $invalidator = \Mockery::mock('\FOS\HttpCacheBundle\CacheManager')
+            ->shouldReceive('invalidatePath')->once()->with('/my/path')
+            ->shouldReceive('invalidatePath')->once()->with('/other/path')
+            ->shouldReceive('invalidatePath')->once()->with('/another')
+            ->getMock()
+        ;
+        $container = \Mockery::mock('\Symfony\Component\DependencyInjection\ContainerInterface')
+            ->shouldReceive('get')->once()->with('fos_http_cache.cache_manager')->andReturn($invalidator)
+            ->getMock()
+        ;
+
+        $application = new Application();
+        $command = new InvalidatePathCommand();
+        $command->setContainer($container);
+        $application->add($command);
+
+        $command = $application->find('fos:httpcache:invalidate:path');
+        $commandTester = new CommandTester($command);
+        $commandTester->execute(array(
+            'command' => $command->getName(),
+            'paths' => array('/my/path', '/other/path'),
+        ));
+
+        // the only output should be generated by the listener in verbose mode
+        $this->assertEquals('', $commandTester->getDisplay());
+
+        // the cache manager is only fetched once
+        $commandTester->execute(array(
+            'command' => $command->getName(),
+            'paths' => array('/another'),
+        ));
+    }
+}

Tests/Unit/Configuration/InvalidateRouteTest.php

@@ -0,0 +1,51 @@
+<?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\Configuration;
+
+use FOS\HttpCacheBundle\Command\InvalidatePathCommand;
+use FOS\HttpCacheBundle\Configuration\InvalidateRoute;
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Tester\CommandTester;
+
+/**
+ * Test the @InvalidateRoute annotation.
+ */
+class InvalidateRouteTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @expectedException \RuntimeException
+     * @expectedExceptionMessage InvalidateRoute params must be an array
+     */
+    public function testExecuteInvalidParams()
+    {
+        new InvalidateRoute(array(
+            'name' => 'test',
+            'params' => 'foo',
+        ));
+    }
+
+    /**
+     * @expectedException \RuntimeException
+     * @expectedExceptionMessage InvalidateRoute param id must be string
+     */
+    public function testExecuteNoExpression()
+    {
+        new InvalidateRoute(array(
+            'name' => 'test',
+            'params' => array(
+                'id' => array(
+                    'this-is-not-expression' => 'something',
+                )
+            ),
+        ));
+    }
+}

Tests/Unit/Configuration/TagTest.php

@@ -0,0 +1,31 @@
+<?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\Configuration;
+
+use FOS\HttpCacheBundle\Configuration\Tag;
+
+/**
+ * Test the @InvalidateRoute annotation.
+ */
+class TagTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @expectedException \FOS\HttpCacheBundle\Exception\InvalidTagException
+     * @expectedExceptionMessage is invalid because it contains ,
+     */
+    public function testExecuteInvalidParams()
+    {
+        new Tag(array(
+            'tags' => array('foo,bar'),
+        ));
+    }
+}

Tests/Unit/DependencyInjection/Compiler/HashGeneratorPassTest.php

@@ -0,0 +1,83 @@
+<?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\DependencyInjection\Compiler;
+
+use FOS\HttpCacheBundle\DependencyInjection\Compiler\HashGeneratorPass;
+use FOS\HttpCacheBundle\DependencyInjection\FOSHttpCacheExtension;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\DefinitionDecorator;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
+
+class HashGeneratorPassTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var FOSHttpCacheExtension
+     */
+    private $extension;
+
+    /**
+     * @var HashGeneratorPass
+     */
+    private $userContextListenerPass;
+
+    protected function setUp()
+    {
+        $this->extension = new FOSHttpCacheExtension();
+        $this->userContextListenerPass = new HashGeneratorPass();
+    }
+
+    /**
+     * Nothing happens when user_context.hash_generator is not enabled
+     */
+    public function testConfigNoContext()
+    {
+        $container = $this->createContainer();
+        $config = $this->getBaseConfig();
+        $this->extension->load(array($config), $container);
+        $this->userContextListenerPass->process($container);
+        $this->assertCount(9, $container->getDefinitions());
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     * @expectedExceptionMessage No user context providers found
+     */
+    public function testConfigNoProviders()
+    {
+        $container = $this->createContainer();
+        $config = $this->getBaseConfig();
+        $config['user_context']['enabled'] = true;
+        $this->extension->load(array($config), $container);
+        $this->userContextListenerPass->process($container);
+    }
+
+    protected function createContainer()
+    {
+        return new ContainerBuilder(new ParameterBag(array(
+            'kernel.debug'       => false,
+        )));
+    }
+
+    protected function getBaseConfig()
+    {
+        return array(
+            'proxy_client' => array(
+                'varnish' => array(
+                    'base_url' => 'my_hostname',
+                    'servers' => array(
+                        '127.0.0.1'
+                    )
+                )
+            )
+        );
+    }
+}