feature #49705 [FrameworkBundle] Add support to easily clear all cache pools (bobvandevijver)

fabpot · fabpot · commit b01130d92e78 · 2023-03-25T10:01:28.000+01:00
This PR was squashed before being merged into the 6.3 branch. Discussion ---------- [FrameworkBundle] Add support to easily clear all cache pools | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | yes  | Deprecations? | no  | Tickets | Fix #22047 | License | MIT | Doc PR | symfony/symfony-docs#18072   As suggested in #22047, I've now added a `--all` option to clear all cache pools by just providing that argument to `cache:pool:clear`. I believe this is more convenient than remembering the `cache.global_clearer` clearer alias and more descriptive for the consumer. Commits ------- 3a50d2d [FrameworkBundle] Add support to easily clear all cache pools
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -21,6 +21,7 @@ CHANGELOG
  * Add autowiring aliases for `Http\Client\HttpAsyncClient`
  * Deprecate the `Http\Client\HttpClient` service, use `Psr\Http\Client\ClientInterface` instead
  * Add `stop_worker_on_signals` configuration option to `messenger` to define signals which would stop a worker
+ * Add support for `--all` option to clear all cache pools with `cache:pool:clear` command
 
 6.2
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/CachePoolClearCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/CachePoolClearCommand.php
@@ -19,6 +19,7 @@
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\HttpKernel\CacheClearer\Psr6CacheClearer;
@@ -49,8 +50,9 @@ protected function configure(): void
     {
         $this
             ->setDefinition([
-                new InputArgument('pools', InputArgument::IS_ARRAY | InputArgument::REQUIRED, 'A list of cache pools or cache pool clearers'),
+                new InputArgument('pools', InputArgument::IS_ARRAY | InputArgument::OPTIONAL, 'A list of cache pools or cache pool clearers'),
             ])
+            ->addOption('all', null, InputOption::VALUE_NONE, 'Clear all cache pools')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command clears the given cache pools or cache pool clearers.
 
@@ -67,7 +69,19 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $pools = [];
         $clearers = [];
 
-        foreach ($input->getArgument('pools') as $id) {
+        $poolNames = $input->getArgument('pools');
+        if ($input->getOption('all')) {
+            if (!$this->poolNames) {
+                throw new InvalidArgumentException('Could not clear all cache pools, try specifying a specific pool or cache clearer.');
+            }
+
+            $io->comment('Clearing all cache pools...');
+            $poolNames = $this->poolNames;
+        } elseif (!$poolNames) {
+            throw new InvalidArgumentException('Either specify at least one pool name, or provide the --all option to clear all pools.');
+        }
+
+        foreach ($poolNames as $id) {
             if ($this->poolClearer->hasPool($id)) {
                 $pools[$id] = $id;
             } else {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/CachePoolClearCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/CachePoolClearCommandTest.php
@@ -14,6 +14,7 @@
 use Symfony\Bundle\FrameworkBundle\Command\CachePoolClearCommand;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Tester\CommandTester;
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 use Symfony\Component\Finder\SplFileInfo;
@@ -76,6 +77,33 @@ public function testClearUnexistingPool()
             ->execute(['pools' => ['unknown_pool']], ['decorated' => false]);
     }
 
+    public function testClearAll()
+    {
+        $tester = $this->createCommandTester(['cache.app_clearer']);
+        $tester->execute(['--all' => true], ['decorated' => false]);
+
+        $tester->assertCommandIsSuccessful('cache:pool:clear exits with 0 in case of success');
+        $this->assertStringContainsString('Clearing all cache pools...', $tester->getDisplay());
+        $this->assertStringContainsString('Calling cache clearer: cache.app_clearer', $tester->getDisplay());
+        $this->assertStringContainsString('[OK] Cache was successfully cleared.', $tester->getDisplay());
+    }
+
+    public function testClearWithoutPoolNames()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Could not clear all cache pools, try specifying a specific pool or cache clearer.');
+
+        $this->createCommandTester()->execute(['--all' => true], ['decorated' => false]);
+    }
+
+    public function testClearNoOptions()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Either specify at least one pool name, or provide the --all option to clear all pools.');
+
+        $this->createCommandTester()->execute([], ['decorated' => false]);
+    }
+
     public function testClearFailed()
     {
         $tester = $this->createCommandTester();
@@ -104,10 +132,10 @@ public function testClearFailed()
         $this->assertStringContainsString('[WARNING] Cache pool "cache.public_pool" could not be cleared.', $tester->getDisplay());
     }
 
-    private function createCommandTester()
+    private function createCommandTester(array $poolNames = null)
     {
         $application = new Application(static::$kernel);
-        $application->add(new CachePoolClearCommand(static::getContainer()->get('cache.global_clearer')));
+        $application->add(new CachePoolClearCommand(static::getContainer()->get('cache.global_clearer'), $poolNames));
 
         return new CommandTester($application->find('cache:pool:clear'));
     }
