[AMQP] Add methods to count and test the number of messages in a queue (#5283)

Author: kardagan

src/Codeception/Module/AMQP.php

@@ -318,6 +318,76 @@ public function seeMessageInQueueContainsText($queue, $text)
         $this->assertContains($text, $msg->body);
     }
 
+    /**
+     * Count messages in queue.
+     *
+     * @param string $queue
+     *
+     * @return int
+     */
+    public function _countMessage($queue)
+    {
+        list($queue, $messageCount) = $this->getChannel()->queue_declare($queue, true);
+        return $messageCount;
+    }
+
+    /**
+     * Checks that queue have expected number of message
+     *
+     * ``` php
+     * <?php
+     * $I->pushToQueue('queue.emails', 'Hello, davert');
+     * $I->seeNumberOfMessagesInQueue('queue.emails',1);
+     * ?>
+     * ```
+     *
+     * @param string $queue
+     * @param int $expected
+     */
+    public function seeNumberOfMessagesInQueue($queue, $expected)
+    {
+        $messageCount = $this->_countMessage($queue);
+        $this->assertEquals($expected, $messageCount);
+    }
+
+    /**
+     * Checks that queue is empty
+     *
+     * ``` php
+     * <?php
+     * $I->pushToQueue('queue.emails', 'Hello, davert');
+     * $I->purgeQueue('queue.emails');
+     * $I->seeQueueIsEmpty('queue.emails');
+     * ?>
+     * ```
+     *
+     * @param string $queue
+     * @param int $expected
+     */
+    public function seeQueueIsEmpty($queue)
+    {
+        $messageCount = $this->_countMessage($queue);
+        $this->assertEquals(0, $messageCount);
+    }
+
+    /**
+     * Checks if queue is not empty.
+     *
+     * ``` php
+     * <?php
+     * $I->pushToQueue('queue.emails', 'Hello, davert');
+     * $I->dontSeeQueueIsEmpty('queue.emails');
+     * ?>
+     * ```
+     *
+     * @param string $queue
+     */
+    public function dontSeeQueueIsEmpty($queue)
+    {
+        $messageCount = $this->_countMessage($queue);
+        $this->assertNotEquals(0, $messageCount);
+    }
+
     /**
      * Takes last message from queue.
      *

tests/unit/Codeception/Module/AMQPTest.php

@@ -38,6 +38,16 @@ public function testPushToQueue()
         $this->module->seeMessageInQueueContainsText('queue1', 'hello');
     }
 
+    public function testCountQueue()
+    {
+        $this->module->pushToQueue('queue1', 'hello');
+        $this->module->pushToQueue('queue1', 'world');
+        $this->module->dontSeeQueueIsEmpty('queue1');
+        $this->module->seeNumberOfMessagesInQueue('queue1', 2);
+        $this->module->purgeAllQueues();
+        $this->module->seeQueueIsEmpty('queue1');
+    }
+
     public function testPushToExchange()
     {
         $queue = 'test-queue';
@@ -50,6 +60,6 @@ public function testPushToExchange()
         $this->module->bindQueueToExchange($queue, $exchange, 'test.#');
 
         $this->module->pushToExchange($exchange, $message, $topic);
-        $this->module->seeMessageInQueueContainsText($queue , $message);
+        $this->module->seeMessageInQueueContainsText($queue, $message);
     }
 }