Merge pull request #117 from passkey1510/feat-dev-purge

Add purge command

Author: videlalvaro

Command/PurgeConsumerCommand.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace OldSound\RabbitMqBundle\Command;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Command to purge a queue
+ */
+class PurgeConsumerCommand extends ConsumerCommand
+{
+    protected function configure()
+    {
+        $this->addArgument('name', InputArgument::REQUIRED, 'Consumer Name')
+             ->addOption('no-confirmation', null, InputOption::VALUE_NONE, 'Whether it must be confirmed before purging');
+
+        $this->setName('rabbitmq:purge');
+    }
+
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     *
+     * @return void
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $noConfirmation = (bool) $input->getOption('no-confirmation');
+
+        if (!$noConfirmation && $input->isInteractive()) {
+            $confirmation = $this->getHelper('dialog')->askConfirmation($output, sprintf('<question>Are you sure you wish to purge "%s" queue? (y/n)</question>', $input->getArgument('name')), false);
+            if (!$confirmation) {
+                $output->writeln('<error>Purging cancelled!</error>');
+
+                return 1;
+            }
+        }
+
+        $this->consumer = $this->getContainer()
+            ->get(sprintf($this->getConsumerService(), $input->getArgument('name')));
+        $this->consumer->purge($input->getArgument('name'));
+    }
+}

README.md

@@ -265,6 +265,12 @@ If you want to establish a consumer memory limit, you can do it by using flag `-
 $ ./app/console rabbitmq:consumer -l 256
 ```
 
+If you want to remove all the messages awaiting in a queue, you can execute this command to purge this queue:
+
+```bash
+$ ./app/console rabbitmq:purge --no-confirmation upload_picture
+```
+
 #### Idle timeout ####
 
 If you need to set a timeout when there are no messages from your queue during a period of time, you can set the `idle_timeout` in seconds:

RabbitMq/Consumer.php

@@ -49,6 +49,14 @@ public function consume($msgAmount)
         }
     }
 
+    /**
+     * Purge the queue
+     */
+    public function purge()
+    {
+        $this->ch->queue_purge($this->queueOptions['name'], true);
+    }
+
     public function processMessage(AMQPMessage $msg)
     {
 

Tests/Command/BaseCommandTest.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace OldSound\RabbitMqBundle\Tests\Command;
+
+abstract class BaseCommandTest extends \PHPUnit_Framework_TestCase
+{
+    protected $application;
+    protected $definition;
+    protected $helperSet;
+    protected $command;
+
+    protected function setUp()
+    {
+        $this->application = $this->getMockBuilder('Symfony\\Bundle\\FrameworkBundle\\Console\\Application')
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->definition = $this->getMockBuilder('Symfony\\Component\\Console\\Input\\InputDefinition')
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->helperSet = $this->getMock('Symfony\\Component\\Console\\Helper\\HelperSet');
+
+        $this->application->expects($this->any())
+            ->method('getDefinition')
+            ->will($this->returnValue($this->definition));
+        $this->definition->expects($this->any())
+            ->method('getArguments')
+            ->will($this->returnValue(array()));
+    }
+}

Tests/Command/ConsumerCommandTest.php

@@ -6,29 +6,11 @@
 
 use Symfony\Component\Console\Input\InputOption;
 
-class ConsumerCommandTest extends \PHPUnit_Framework_TestCase
+class ConsumerCommandTest extends BaseCommandTest
 {
-    private $application;
-    private $definition;
-    private $helperSet;
-    private $command;
-
     protected function setUp()
     {
-        $this->application = $this->getMockBuilder('Symfony\\Bundle\\FrameworkBundle\\Console\\Application')
-            ->disableOriginalConstructor()
-            ->getMock();
-        $this->definition = $this->getMockBuilder('Symfony\\Component\\Console\\Input\\InputDefinition')
-            ->disableOriginalConstructor()
-            ->getMock();
-        $this->helperSet = $this->getMock('Symfony\\Component\\Console\\Helper\\HelperSet');
-
-        $this->application->expects($this->any())
-            ->method('getDefinition')
-            ->will($this->returnValue($this->definition));
-        $this->definition->expects($this->any())
-            ->method('getArguments')
-            ->will($this->returnValue(array()));
+        parent::setUp();
         $this->definition->expects($this->any())
             ->method('getOptions')
             ->will($this->returnValue(array(

Tests/Command/PurgeCommandTest.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace OldSound\RabbitMqBundle\Tests\Command;
+
+use OldSound\RabbitMqBundle\Command\ConsumerCommand;
+
+use OldSound\RabbitMqBundle\Command\PurgeConsumerCommand;
+use Symfony\Component\Console\Input\InputOption;
+
+class PurgeCommandTest extends BaseCommandTest
+{
+    protected function setUp()
+    {
+        parent::setUp();
+        $this->definition->expects($this->any())
+            ->method('getOptions')
+            ->will($this->returnValue(array(
+                new InputOption('--no-confirmation', null, InputOption::VALUE_NONE, 'Switches off confirmation mode.'),
+            )));
+        $this->application->expects($this->once())
+            ->method('getHelperSet')
+            ->will($this->returnValue($this->helperSet));
+
+        $this->command = new PurgeConsumerCommand();
+        $this->command->setApplication($this->application);
+    }
+
+    /**
+     * testInputsDefinitionCommand
+     */
+    public function testInputsDefinitionCommand()
+    {
+        // check argument
+        $this->assertTrue($this->command->getDefinition()->hasArgument('name'));
+        $this->assertTrue($this->command->getDefinition()->getArgument('name')->isRequired()); // Name is required to find the service
+
+        //check options
+        $this->assertTrue($this->command->getDefinition()->hasOption('no-confirmation'));
+        $this->assertFalse($this->command->getDefinition()->getOption('no-confirmation')->acceptValue()); // It shouldn't accept value because it is a true/false input
+    }
+}