add unit tests and change docs

Alexandru Panturu · Alexandru Panturu · commit d09cfc9367f1 · 2016-06-24T17:36:50.000+03:00
diff --git a/Event/AMQPEvent.php b/Event/AMQPEvent.php
@@ -9,6 +9,7 @@
  * Class AMQPEvent
  *
  * @package OldSound\RabbitMqBundle\Event
+ * @codeCoverageIgnore
  */
 class AMQPEvent extends Event
 {
@@ -20,7 +21,7 @@ class AMQPEvent extends Event
      * @var AMQPMessage
      */
     protected $AMQPMessage;
-    
+
     /**
      * @return AMQPMessage
      */
diff --git a/Event/OnConsumeEvent.php b/Event/OnConsumeEvent.php
@@ -6,6 +6,7 @@
  * Class OnConsumeEvent
  *
  * @package OldSound\RabbitMqBundle\Command
+ * @codeCoverageIgnore
  */
 class OnConsumeEvent extends AMQPEvent
 {
diff --git a/README.md b/README.md
@@ -274,6 +274,62 @@ For deleting the consumer's queue, use this command:
 $ ./app/console rabbitmq:delete --no-confirmation upload_picture
 ```
 
+#### Consumer Events ####
+
+This can be useful in many scenarios.
+There are 3 AMQPEvents:
+##### ON CONSUME #####
+```php
+class OnConsumeEvent extends AMQPEvent
+{
+    const NAME = AMQPEvent::ON_CONSUME;
+}
+```
+
+Let`s say you need to sleep / stop consumer/s on a new application deploy.
+You can listen for OnConsumeEvent (\OldSound\RabbitMqBundle\Event\OnConsumeEvent) and check for new application deploy.
+
+##### BEFORE PROCESSING MESSAGE #####
+
+```php
+class BeforeProcessingMessageEvent extends AMQPEvent
+{
+    const NAME = AMQPEvent::BEFORE_PROCESSING_MESSAGE;
+
+    /**
+     * BeforeProcessingMessageEvent constructor.
+     *
+     * @param AMQPMessage $AMQPMessage
+     */
+    public function __construct(AMQPMessage $AMQPMessage)
+    {
+        $this->AMQPMessage = $AMQPMessage;
+    }
+}
+``` 
+Event raised before processing a AMQPMessage.
+
+##### AFTER PROCESSING MESSAGE #####
+
+```php
+class AfterProcessingMessageEvent extends AMQPEvent
+{
+    const NAME = AMQPEvent::AFTER_PROCESSING_MESSAGE;
+
+    /**
+     * AfterProcessingMessageEvent constructor.
+     *
+     * @param AMQPMessage $AMQPMessage
+     */
+    public function __construct(AMQPMessage $AMQPMessage)
+    {
+        $this->AMQPMessage = $AMQPMessage;
+    }
+}
+``` 
+Event raised after processing a AMQPMessage.
+If the process message will throw an Exception the event will not raise.
+
 #### 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:
diff --git a/RabbitMq/BaseAmqp.php b/RabbitMq/BaseAmqp.php
@@ -1,6 +1,7 @@
 <?php
 
 namespace OldSound\RabbitMqBundle\RabbitMq;
+use OldSound\RabbitMqBundle\Event\AMQPEvent;
 use PhpAmqpLib\Channel\AMQPChannel;
 use PhpAmqpLib\Connection\AbstractConnection;
 use PhpAmqpLib\Connection\AMQPLazyConnection;
@@ -256,15 +257,23 @@ public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
 
     /**
      * @param string $eventName
-     * @param Event  $event
+     * @param AMQPEvent  $event
      */
-    protected function dispatchEvent($eventName, Event $event)
+    protected function dispatchEvent($eventName, AMQPEvent $event)
     {
-        if ($this->eventDispatcher) {
-            $this->eventDispatcher->dispatch(
+        if ($this->getEventDispatcher()) {
+            $this->getEventDispatcher()->dispatch(
                 $eventName,
                 $event
             );
         }
     }
+
+    /**
+     * @return EventDispatcherInterface
+     */
+    public function getEventDispatcher()
+    {
+        return $this->eventDispatcher;
+    }
 }
diff --git a/RabbitMq/DynamicConsumer.php b/RabbitMq/DynamicConsumer.php
@@ -46,7 +46,10 @@ protected function setupConsumer()
     }
     
     protected function mergeQueueOptions()
-    {   
+    {
+        if (null === $this->queueOptionsProvider) {
+            return;
+        }
         $this->queueOptions = array_merge($this->queueOptions, $this->queueOptionsProvider->getQueueOptions($this->context));
     }
 }
diff --git a/Tests/Event/AfterProcessingMessageEventTest.php b/Tests/Event/AfterProcessingMessageEventTest.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace OldSound\RabbitMqBundle\Tests\Event;
+
+use OldSound\RabbitMqBundle\Event\AfterProcessingMessageEvent;
+use PhpAmqpLib\Message\AMQPMessage;
+
+/**
+ * Class AfterProcessingMessageEventTest
+ *
+ * @package OldSound\RabbitMqBundle\Tests\Event
+ */
+class AfterProcessingMessageEventTest extends \PHPUnit_Framework_TestCase
+{
+    
+    public function testEvent()
+    {
+        $AMQPMessage = new AMQPMessage('body');
+        $event = new AfterProcessingMessageEvent($AMQPMessage);
+        $this->assertSame($AMQPMessage, $event->getAMQPMessage());
+    }
+}
diff --git a/Tests/Event/BeforeProcessingMessageEventTest.php b/Tests/Event/BeforeProcessingMessageEventTest.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace OldSound\RabbitMqBundle\Tests\Event;
+
+use OldSound\RabbitMqBundle\Event\BeforeProcessingMessageEvent;
+use PhpAmqpLib\Message\AMQPMessage;
+
+/**
+ * Class BeforeProcessingMessageEventTest
+ *
+ * @package OldSound\RabbitMqBundle\Tests\Event
+ */
+class BeforeProcessingMessageEventTest extends \PHPUnit_Framework_TestCase
+{
+    public function testEvent()
+    {
+        $AMQPMessage = new AMQPMessage('body');
+        $event = new BeforeProcessingMessageEvent($AMQPMessage);
+        $this->assertSame($AMQPMessage, $event->getAMQPMessage());
+    }
+}
diff --git a/Tests/RabbitMq/BaseAmqpTest.php b/Tests/RabbitMq/BaseAmqpTest.php
@@ -2,6 +2,9 @@
 
 namespace OldSound\RabbitMqBundle\Tests\RabbitMq;
 
+use OldSound\RabbitMqBundle\Event\AMQPEvent;
+use OldSound\RabbitMqBundle\Event\OnConsumeEvent;
+use OldSound\RabbitMqBundle\RabbitMq\BaseAmqp;
 use OldSound\RabbitMqBundle\RabbitMq\Consumer;
 use PhpAmqpLib\Connection\AMQPLazyConnection;
 
@@ -17,4 +20,40 @@ public function testLazyConnection()
         $consumer = new Consumer($amqpLazyConnection, null);
         $consumer->getChannel();
     }
+
+    public function testDispatchEvent()
+    {
+        /** @var BaseAmqp|\PHPUnit_Framework_MockObject_MockObject $baseAmqpConsumer */
+        $baseAmqpConsumer = $this->getMockBuilder('OldSound\RabbitMqBundle\RabbitMq\BaseAmqp')
+            ->disableOriginalConstructor()
+            ->getMock();
+        $eventDispatcher = $this->getMockBuilder('Symfony\Component\EventDispatcher\EventDispatcher')
+            ->disableOriginalConstructor()
+            ->getMock();
+        $baseAmqpConsumer->expects($this->atLeastOnce())
+            ->method('getEventDispatcher')
+            ->willReturn($eventDispatcher);
+
+        $eventDispatcher->expects($this->once())
+            ->method('dispatch')
+            ->with(AMQPEvent::ON_CONSUME, new AMQPEvent())
+            ->willReturn(true);
+        $this->invokeMethod('dispatchEvent', $baseAmqpConsumer, array(AMQPEvent::ON_CONSUME, new AMQPEvent()));
+    }
+
+    /**
+     * @param $name
+     * @param $obj
+     * @param $params
+     *
+     * @return mixed
+     */
+    protected function invokeMethod($name, $obj, $params)
+    {
+        $class = new \ReflectionClass(get_class($obj));
+        $method = $class->getMethod($name);
+        $method->setAccessible(true);
+
+        return $method->invokeArgs($obj, $params);
+    }
 }
diff --git a/Tests/RabbitMq/ConsumerTest.php b/Tests/RabbitMq/ConsumerTest.php
@@ -2,6 +2,8 @@
 
 namespace OldSound\RabbitMqBundle\Tests\RabbitMq;
 
+use OldSound\RabbitMqBundle\Event\AfterProcessingMessageEvent;
+use OldSound\RabbitMqBundle\Event\BeforeProcessingMessageEvent;
 use OldSound\RabbitMqBundle\RabbitMq\Consumer;
 use PhpAmqpLib\Message\AMQPMessage;
 use OldSound\RabbitMqBundle\RabbitMq\ConsumerInterface;
@@ -58,7 +60,17 @@ public function testProcessMessage($processFlag, $expectedMethod, $expectedReque
             ->will($this->returnCallback(function($delivery_tag) use ($expectedMethod) {
                 \PHPUnit_Framework_Assert::assertSame($expectedMethod, 'basic_ack'); // Check if this function should be called.
             }));
+        $eventDispatcher = $this->getMockBuilder('Symfony\Component\EventDispatcher\EventDispatcherInterface')
+            ->getMock();
+        $consumer->setEventDispatcher($eventDispatcher);
 
+        $eventDispatcher->expects($this->atLeastOnce())
+            ->method('dispatch')
+            ->withConsecutive(
+                array(BeforeProcessingMessageEvent::NAME, new BeforeProcessingMessageEvent($amqpMessage)),
+                array(AfterProcessingMessageEvent::NAME, new AfterProcessingMessageEvent($amqpMessage))
+            )
+            ->willReturn(true);
         $consumer->processMessage($amqpMessage);
     }
 
@@ -73,4 +85,87 @@ public function processMessageProvider()
             array(ConsumerInterface::MSG_REJECT, 'basic_reject', false), // Reject and drop
         );
     }
+
+    /**
+     * @return array
+     */
+    public function consumeProvider()
+    {
+        $testCases[ "All ok 4 callbacks"] =  array(
+            array(
+                "messages" => array(
+                    "msgCallback1",
+                    "msgCallback2",
+                    "msgCallback3",
+                    "msgCallback4",
+                )
+            )
+        );
+
+        $testCases[ "No callbacks"] =  array(
+            array(
+                "messages" => array(
+                )
+            )
+        );
+
+        return $testCases;
+    }
+
+    /**
+     * @dataProvider consumeProvider
+     *
+     * @param $data
+     */
+    public function testConsume($data)
+    {
+        $consumerCallBacks = $data['messages'];
+
+        // set up amqp connection
+        $amqpConnection = $this->prepareAMQPConnection();
+        // set up amqp channel
+        $amqpChannel = $this->prepareAMQPChannel();
+        $amqpChannel->expects($this->atLeastOnce())
+            ->method('getChannelId')
+            ->with()
+            ->willReturn(true);
+        $amqpChannel->expects($this->once())
+            ->method('basic_consume')
+            ->withAnyParameters()
+            ->willReturn(true);
+
+        // set up consumer
+        $consumer = $this->getConsumer($amqpConnection, $amqpChannel);
+        // disable autosetup fabric so we do not mock more objects
+        $consumer->disableAutoSetupFabric();
+        $consumer->setChannel($amqpChannel);
+        $amqpChannel->callbacks = $consumerCallBacks;
+
+        /**
+         * Mock ait method and use a callback to remove one element each time from callbacks
+         * This will simulate a basic consumer consume with provided messages count
+         */
+        $amqpChannel->expects($this->exactly(count($consumerCallBacks)))
+            ->method('wait')
+            ->with(null, false, $consumer->getIdleTimeout())
+            ->will(
+                $this->returnCallback(
+                    function () use ($amqpChannel) {
+                        /** remove an element on each loop like ... simulate an ACK */
+                        array_splice($amqpChannel->callbacks, 0, 1);
+                    })
+            );
+
+        // set up event dispatcher
+        $eventDispatcher = $this->getMockBuilder('Symfony\Component\EventDispatcher\EventDispatcher')
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $eventDispatcher->expects($this->exactly(count($consumerCallBacks)))
+            ->method('dispatch')
+            ->willReturn($eventDispatcher);
+
+        $consumer->setEventDispatcher($eventDispatcher);
+        $consumer->consume(1);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`* Class OnConsumeEvent`
`7`	`7`	`*`
`8`	`8`	`* @package OldSound\RabbitMqBundle\Command`
	`9`	`+ * @codeCoverageIgnore`
`9`	`10`	`*/`
`10`	`11`	`class OnConsumeEvent extends AMQPEvent`
`11`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,10 @@ protected function setupConsumer()`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`protected function mergeQueueOptions()`
`49`		`- {`
	`49`	`+ {`
	`50`	`+ if (null === $this->queueOptionsProvider) {`
	`51`	`+ return;`
	`52`	`+ }`
`50`	`53`	`$this->queueOptions = array_merge($this->queueOptions, $this->queueOptionsProvider->getQueueOptions($this->context));`
`51`	`54`	`}`
`52`	`55`	`}`