Add invalidate domain command

Author: alexander-schranz

src/Command/InvalidateDomainCommand.php

@@ -0,0 +1,86 @@
+<?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\Command;
+
+use FOS\HttpCacheBundle\CacheManager;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * A command to trigger cache invalidation by path from the command line.
+ *
+ * @author David Buchmann <[email protected]>
+ */
+class InvalidateDomainCommand extends BaseInvalidateCommand
+{
+    use PathSanityCheck;
+
+    protected static $defaultName = 'fos:httpcache:invalidate:domain';
+
+    /**
+     * If no cache manager is specified explicitly, fos_http_cache.cache_manager
+     * is automatically loaded.
+     *
+     * @param CacheManager|null $cacheManager The cache manager to talk to
+     */
+    public function __construct(CacheManager $cacheManager = null)
+    {
+        if (2 <= func_num_args()) {
+            @trigger_error('Passing a command name in the constructor is deprecated and will be removed in version 3', E_USER_DEPRECATED);
+            static::$defaultName = func_get_arg(1);
+        }
+        parent::__construct($cacheManager);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this
+            ->setName(static::$defaultName) // BC with 2.8
+            ->setDescription('Invalidate a domain on all configured caching proxies')
+            ->addArgument(
+                'domains',
+                InputArgument::IS_ARRAY | InputArgument::REQUIRED,
+                'URL domains you want to invalidate, you can specify any number of domains'
+            )
+            ->setHelp(<<<'EOF'
+The <info>%command.name%</info> command invalidates a list of paths on the configured caching proxies.
+
+Example:
+
+    <info>php %command.full_name% /some/path /other/path</info>
+EOF
+            )
+        ;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $domains = $input->getArgument('domains');
+
+        foreach ($domains as $domain) {
+            if ($this->looksLikeRegularExpression($domain)) {
+                $output->writeln(sprintf('Domain %s looks like a regular expression. Invalidation requests operate on exact domains. Use regex invalidation for regular expressions.', $domain));
+            }
+
+            $this->getCacheManager()->invalidateDomain($domain);
+        }
+
+        return 0;
+    }
+}

src/Resources/config/cache_manager_commands.xml

@@ -20,6 +20,11 @@
             <argument type="service" id="fos_http_cache.cache_manager" />
             <tag name="console.command"/>
         </service>
+
+        <service id="fos_http_cache.command.invalidate_domain" class="FOS\HttpCacheBundle\Command\InvalidateDomainCommand">
+            <argument type="service" id="fos_http_cache.cache_manager" />
+            <tag name="console.command"/>
+        </service>
     </services>
 
 </container>

tests/Functional/Command/InvalidateDomainCommandTest.php

@@ -0,0 +1,45 @@
+<?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\Functional\Command;
+
+use FOS\HttpCacheBundle\CacheManager;
+
+class InvalidateDomainCommandTest extends CommandTestCase
+{
+    public function testExecuteVerbose()
+    {
+        $client = self::createClient();
+
+        $mock = \Mockery::mock(CacheManager::class);
+        $mock->shouldReceive('supports')
+            ->zeroOrMoreTimes()
+            ->andReturnTrue()
+        ;
+        $mock->shouldReceive('invalidateDomain')
+            ->once()
+            ->with('localhost')
+        ;
+        $mock->shouldReceive('invalidateDomain')
+            ->once()
+            ->with('example.localhost')
+        ;
+        $mock->shouldReceive('flush')
+            ->once()
+            ->andReturn(2)
+        ;
+        $client->getContainer()->set('fos_http_cache.cache_manager', $mock);
+
+        $output = $this->runCommand($client, 'fos:httpcache:invalidate:domain localhost example.localhost');
+
+        $this->assertEquals("Sent 2 invalidation request(s)\n", $output);
+    }
+}

tests/Unit/Command/InvalidateDomainCommandTest.php

@@ -0,0 +1,61 @@
+<?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\CacheManager;
+use FOS\HttpCacheBundle\Command\InvalidateDomainCommand;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Tester\CommandTester;
+
+class InvalidateDomainCommandTest extends TestCase
+{
+    use MockeryPHPUnitIntegration;
+
+    /**
+     * @expectedException \RuntimeException
+     */
+    public function testExecuteMissingParameters()
+    {
+        $invalidator = \Mockery::mock(CacheManager::class);
+
+        $application = new Application();
+        $application->add(new InvalidateDomainCommand($invalidator));
+
+        $command = $application->find('fos:httpcache:invalidate:domain');
+        $commandTester = new CommandTester($command);
+        $commandTester->execute(['command' => $command->getName()]);
+    }
+
+    public function testExecuteParameter()
+    {
+        $invalidator = \Mockery::mock(CacheManager::class)
+            ->shouldReceive('invalidateDomain')->once()->with('localhost')
+            ->shouldReceive('invalidateDomain')->once()->with('example.localhost')
+            ->getMock()
+        ;
+
+        $application = new Application();
+        $application->add(new InvalidateDomainCommand($invalidator));
+
+        $command = $application->find('fos:httpcache:invalidate:domain');
+        $commandTester = new CommandTester($command);
+        $commandTester->execute([
+            'command' => $command->getName(),
+            'domains' => ['localhost', 'example.localhost'],
+        ]);
+
+        // the only output should be generated by the listener in verbose mode
+        $this->assertEquals('', $commandTester->getDisplay());
+    }
+}