[Cache] Added command for list all available cache pools

symfony · nicolas-grekas · Apr 10, 2019 · Apr 8, 2019 · Apr 10, 2019 · 5c210e6fd5544bc018225abd6be7c942c6d6b213
commit 5c210e6fd5544bc018225abd6be7c942c6d6b213
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -31,6 +31,7 @@ CHANGELOG
 * Added the `messenger:setup-transports` command to setup messenger transports
 * Added a `InMemoryTransport` to Messenger. Use it with a DSN starting with `in-memory://`.
 * Added `framework.property_access.throw_exception_on_invalid_property_path` config option.
+ * Added `cache:pool:list` command to list all available cache pools.

 4.2.0
 -----

diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/CachePoolListCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/CachePoolListCommand.php
@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+/**
+ * List available cache pools.
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+final class CachePoolListCommand extends Command
+{
+    protected static $defaultName = 'cache:pool:list';
+
+    private $poolNames;
+
+    public function __construct(array $poolNames)
+    {
+        parent::__construct();
+
+        $this->poolNames = $poolNames;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this
+            ->setDescription('List available cache pools')
+            ->setHelp(<<<'EOF'
+The <info>%command.name%</info> command lists all available cache pools.
+EOF
+            )
+        ;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        $io->table(['Pool name'], array_map(function ($pool) {
+            return [$pool];
+        }, $this->poolNames));
+    }
+}
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/console.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/console.xml
@@ -48,6 +48,11 @@
            <tag name="console.command" command="cache:pool:delete" />
        </service>

+        <service id="console.command.cache_pool_list" class="Symfony\Bundle\FrameworkBundle\Command\CachePoolListCommand">
+            <argument /> <!-- Pool names -->
+            <tag name="console.command" command="cache:pool:list" />
+        </service>
+
        <service id="console.command.cache_warmup" class="Symfony\Bundle\FrameworkBundle\Command\CacheWarmupCommand">
            <argument type="service" id="cache_warmer" />
            <tag name="console.command" command="cache:warmup" />

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/CachePoolListCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/CachePoolListCommandTest.php
@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Functional;
+
+use Symfony\Bundle\FrameworkBundle\Command\CachePoolListCommand;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Component\Console\Tester\CommandTester;
+
+/**
+ * @group functional
+ */
+class CachePoolListCommandTest extends WebTestCase
+{
+    protected function setUp()
+    {
+        static::bootKernel(['test_case' => 'CachePools', 'root_config' => 'config.yml']);
+    }
+
+    public function testListPools()
+    {
+        $tester = $this->createCommandTester(['cache.app', 'cache.system']);
+        $tester->execute([]);
+
+        $this->assertSame(0, $tester->getStatusCode(), 'cache:pool:list exits with 0 in case of success');
+        $this->assertContains('cache.app', $tester->getDisplay());
+        $this->assertContains('cache.system', $tester->getDisplay());
+    }
+
+    public function testEmptyList()
+    {
+        $tester = $this->createCommandTester([]);
+        $tester->execute([]);
+
+        $this->assertSame(0, $tester->getStatusCode(), 'cache:pool:list exits with 0 in case of success');
+    }
+
+    private function createCommandTester(array $poolNames)
+    {
+        $application = new Application(static::$kernel);
+        $application->add(new CachePoolListCommand($poolNames));
+
+        return new CommandTester($application->find('cache:pool:list'));
+    }
+}
diff --git a/src/Symfony/Component/Cache/DependencyInjection/CachePoolPass.php b/src/Symfony/Component/Cache/DependencyInjection/CachePoolPass.php
@@ -136,6 +136,10 @@ public function process(ContainerBuilder $container)
                $clearer->addTag($this->cacheSystemClearerTag);
            }
        }
+
+        if ($container->hasDefinition('console.command.cache_pool_list')) {
+            $container->getDefinition('console.command.cache_pool_list')->replaceArgument(0, array_keys($pools));
+        }
    }

    private function getNamespace($seed, $id)