[FrameworkBundle] Add command to delete an item from a cache pool #26223
Next
Next commit
Add command to delete an item from a cache pool
- Loading branch information
commit 89355ba7ac04301858eb8f4663075b36c33414f3
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| <?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\Input\InputArgument; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
| use Symfony\Component\Console\Style\SymfonyStyle; | ||
| use Symfony\Component\HttpKernel\CacheClearer\Psr6CacheClearer; | ||
|
|
||
| /** | ||
| * Delete an item from a cachhe pool. | ||
| * | ||
| * @author Pierre du Plessis <pdples@gmail.com> | ||
| */ | ||
| final class CachePoolDeleteCommand extends Command | ||
| { | ||
| protected static $defaultName = 'cache:pool:delete'; | ||
|
|
||
| private $poolClearer; | ||
|
|
||
| public function __construct(Psr6CacheClearer $poolClearer) | ||
|
There was a problem hiding this comment. Do we really want to inject the cache clearer to then use it to fetch a pool? Shouldn't we rather inject the pools directly? |
||
| { | ||
| parent::__construct(); | ||
|
|
||
| $this->poolClearer = $poolClearer; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function configure() | ||
| { | ||
| $this | ||
| ->setDefinition(array( | ||
| new InputArgument('pool', InputArgument::REQUIRED, 'The cache pool to delete an item from'), | ||
|
There was a problem hiding this comment.
|
||
| new InputArgument('key', InputArgument::REQUIRED, 'The cache key to delete from the pool'), | ||
| )) | ||
| ->setDescription('Deletes an item from a cache pool') | ||
| ->setHelp(<<<'EOF' | ||
| The <info>%command.name%</info> deletes an item from a given cache pool. | ||
|
|
||
| %command.full_name% <pool> <key> | ||
| EOF | ||
| ) | ||
| ; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function execute(InputInterface $input, OutputInterface $output) | ||
| { | ||
| $io = new SymfonyStyle($input, $output); | ||
| $pool = $input->getArgument('pool'); | ||
| $key = $input->getArgument('key'); | ||
| $cachePool = $this->poolClearer->getPool($pool); | ||
|
|
||
| if (!$cachePool->hasItem($key)) { | ||
| $io->warning(sprintf('Cache item "%s" does not exist in cache pool "%s".', $key, $pool)); | ||
|
There was a problem hiding this comment. Right, forgot about this. Thanks |
||
|
|
||
| return; | ||
| } | ||
|
|
||
| if (!$cachePool->deleteItem($key)) { | ||
| throw new \Exception(sprintf('Cache item "%s" could not be deleted.', $key)); | ||
| } | ||
|
|
||
| $io->success(sprintf('Cache item "%s" was successfully deleted.', $key)); | ||
|
There was a problem hiding this comment. I'd suggest to log only in verbose mode (same above) There was a problem hiding this comment. hum, maybe not actually :) |
||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| <?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\Command; | ||
|
|
||
| use Psr\Cache\CacheItemPoolInterface; | ||
| use Symfony\Bundle\FrameworkBundle\Command\CachePoolDeleteCommand; | ||
| use Symfony\Bundle\FrameworkBundle\Console\Application; | ||
| use Symfony\Bundle\FrameworkBundle\Tests\TestCase; | ||
| use Symfony\Component\Console\Tester\CommandTester; | ||
| use Symfony\Component\HttpKernel\CacheClearer\Psr6CacheClearer; | ||
| use Symfony\Component\HttpKernel\KernelInterface; | ||
|
|
||
| class CachePoolDeleteCommandTest extends TestCase | ||
| { | ||
| private $cachePool; | ||
|
|
||
| protected function setUp() | ||
| { | ||
| $this->cachePool = $this->getMockBuilder(CacheItemPoolInterface::class) | ||
| ->getMock(); | ||
| } | ||
|
|
||
| public function testCommandWithValidKey() | ||
| { | ||
| $this->cachePool->expects($this->once()) | ||
| ->method('hasItem') | ||
| ->with('bar') | ||
| ->willReturn(true); | ||
|
|
||
| $this->cachePool->expects($this->once()) | ||
| ->method('deleteItem') | ||
| ->with('bar') | ||
| ->willReturn(true); | ||
|
|
||
| $tester = $this->getCommandTester($this->getKernel()); | ||
| $tester->execute(array('pool' => 'foo', 'key' => 'bar')); | ||
|
|
||
| $this->assertContains('[OK] Cache item "bar" was successfully deleted.', $tester->getDisplay()); | ||
| } | ||
|
|
||
| public function testCommandWithInValidKey() | ||
| { | ||
| $this->cachePool->expects($this->once()) | ||
| ->method('hasItem') | ||
| ->with('bar') | ||
| ->willReturn(false); | ||
|
|
||
| $this->cachePool->expects($this->never()) | ||
| ->method('deleteItem') | ||
| ->with('bar'); | ||
|
|
||
| $tester = $this->getCommandTester($this->getKernel()); | ||
| $tester->execute(array('pool' => 'foo', 'key' => 'bar')); | ||
|
|
||
| $this->assertContains('[WARNING] Cache item "bar" does not exist in cache pool "foo".', $tester->getDisplay()); | ||
| } | ||
|
|
||
| public function testCommandDeleteFailed() | ||
| { | ||
| $this->cachePool->expects($this->once()) | ||
| ->method('hasItem') | ||
| ->with('bar') | ||
| ->willReturn(true); | ||
|
|
||
| $this->cachePool->expects($this->once()) | ||
| ->method('deleteItem') | ||
| ->with('bar') | ||
| ->willReturn(false); | ||
|
|
||
| if (method_exists($this, 'expectExceptionMessage')) { | ||
| $this->expectExceptionMessage('Cache item "bar" could not be deleted.'); | ||
| } else { | ||
| $this->setExpectedException('Exception', 'Cache item "bar" could not be deleted.'); | ||
| } | ||
|
|
||
| $tester = $this->getCommandTester($this->getKernel()); | ||
| $tester->execute(array('pool' => 'foo', 'key' => 'bar')); | ||
| } | ||
|
|
||
| /** | ||
| * @return \PHPUnit_Framework_MockObject_MockObject|KernelInterface | ||
| */ | ||
| private function getKernel() | ||
| { | ||
| $container = $this | ||
| ->getMockBuilder('Symfony\Component\DependencyInjection\ContainerInterface') | ||
| ->getMock(); | ||
|
|
||
| $kernel = $this | ||
| ->getMockBuilder(KernelInterface::class) | ||
| ->getMock(); | ||
|
|
||
| $kernel | ||
| ->expects($this->any()) | ||
| ->method('getContainer') | ||
| ->willReturn($container); | ||
|
|
||
| $kernel | ||
| ->expects($this->once()) | ||
| ->method('getBundles') | ||
| ->willReturn(array()); | ||
|
|
||
| return $kernel; | ||
| } | ||
|
|
||
| private function getCommandTester(KernelInterface $kernel): CommandTester | ||
| { | ||
| $application = new Application($kernel); | ||
| $application->add(new CachePoolDeleteCommand(new Psr6CacheClearer(array('foo' => $this->cachePool)))); | ||
|
|
||
| return new CommandTester($application->find('cache:pool:delete')); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this can only delete an item as specified in descriptions (
keyis required), wouldn'tCachePooltemDeleteCommandbe more accurate? Also, there's a tyop in the comment above.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This matches the name of the command, and is good enough IMHO as nothing else than an item can be deleted.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was thinking about renaming both.
Not everyone may know that though and can have different expectations. But as long as it's documented well, it's ok, I guess.