eMAGTechLabs / RabbitMqBundle

Tests/RabbitMq/MultipleConsumerTest.php

<?php

namespace OldSound\RabbitMqBundle\Tests\RabbitMq;

use OldSound\RabbitMqBundle\Provider\QueuesProviderInterface;
use OldSound\RabbitMqBundle\RabbitMq\ConsumerInterface;
use OldSound\RabbitMqBundle\RabbitMq\MultipleConsumer;
use PhpAmqpLib\Channel\AMQPChannel;
use PhpAmqpLib\Connection\AMQPStreamConnection;
use PhpAmqpLib\Message\AMQPMessage;
use PHPUnit\Framework\Assert;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;

class MultipleConsumerTest extends TestCase
{
    /**
     * Multiple consumer
     *
     * @var MultipleConsumer
     */
    private $multipleConsumer;

    /**
     * AMQP channel
     *
     * @var MockObject|AMQPChannel
     */
    private $amqpChannel;

    /**
     * AMQP connection
     *
     * @var MockObject|AMQPStreamConnection
     */
    private $amqpConnection;

    /**
     * Set up
     *
     * @return void
     */
    public function setUp(): void
    {
        $this->amqpConnection = $this->prepareAMQPConnection();
        $this->amqpChannel = $this->prepareAMQPChannel();
        $this->multipleConsumer = new MultipleConsumer($this->amqpConnection, $this->amqpChannel);
    }

    /**
     * Check if the message is requeued or not correctly.
     *
     * @dataProvider processMessageProvider
     */
    public function testProcessMessage($processFlag, $expectedMethod, $expectedRequeue = null)
    {
        $callback = $this->prepareCallback($processFlag);

        $this->multipleConsumer->setQueues(
            array(
                'test-1' => array('callback' => $callback),
                'test-2' => array('callback' => $callback)
            )
        );

        $this->prepareAMQPChannelExpectations($expectedMethod, $expectedRequeue);

        // Create a default message
        $amqpMessage = new AMQPMessage('foo body');
        $amqpMessage->delivery_info['channel'] = $this->amqpChannel;

The property PhpAmqpLib\Message\AMQPMessage::$delivery_info has been deprecated.

        $amqpMessage->delivery_info['delivery_tag'] = 0;

The property PhpAmqpLib\Message\AMQPMessage::$delivery_info has been deprecated.

        $this->multipleConsumer->processQueueMessage('test-1', $amqpMessage);
        $this->multipleConsumer->processQueueMessage('test-2', $amqpMessage);
    }

    /**
     * Check queues provider works well
     *
     * @dataProvider processMessageProvider
     */
    public function testQueuesProvider($processFlag, $expectedMethod, $expectedRequeue = null)
    {
        $callback = $this->prepareCallback($processFlag);

        $queuesProvider = $this->prepareQueuesProvider();
        $queuesProvider->expects($this->once())
            ->method('getQueues')
            ->will($this->returnValue(
                array(
                    'test-1' => array('callback' => $callback),
                    'test-2' => array('callback' => $callback)
                )
            ));

        $this->multipleConsumer->setQueuesProvider($queuesProvider);

        /**
         * We don't test consume method, which merges queues by calling $this->setupConsumer();
         * So we need to invoke it manually
         */
        $reflectionClass = new \ReflectionClass(get_class($this->multipleConsumer));
        $reflectionMethod = $reflectionClass->getMethod('mergeQueues');
        $reflectionMethod->setAccessible(true);
        $reflectionMethod->invoke($this->multipleConsumer);

        $this->prepareAMQPChannelExpectations($expectedMethod, $expectedRequeue);

        // Create a default message
        $amqpMessage = new AMQPMessage('foo body');
        $amqpMessage->delivery_info['channel'] = $this->amqpChannel;

The property PhpAmqpLib\Message\AMQPMessage::$delivery_info has been deprecated.

        $amqpMessage->delivery_info['delivery_tag'] = 0;

The property PhpAmqpLib\Message\AMQPMessage::$delivery_info has been deprecated.

        $this->multipleConsumer->processQueueMessage('test-1', $amqpMessage);
        $this->multipleConsumer->processQueueMessage('test-2', $amqpMessage);
    }

    public function testQueuesPrivider()
    {
        $amqpConnection = $this->prepareAMQPConnection();

The assignment to $amqpConnection is dead and can be removed.

        $amqpChannel = $this->prepareAMQPChannel();

The assignment to $amqpChannel is dead and can be removed.

        $this->multipleConsumer->setContext('foo');

        $queuesProvider = $this->prepareQueuesProvider();
        $queuesProvider->expects($this->once())
            ->method('getQueues')
            ->will($this->returnValue(
                array(
                    'queue_foo' => array()
                )
            ));

        $this->multipleConsumer->setQueuesProvider($queuesProvider);

        $reflectionClass = new \ReflectionClass(get_class($this->multipleConsumer));
        $reflectionMethod = $reflectionClass->getMethod('mergeQueues');
        $reflectionMethod->setAccessible(true);
        $reflectionMethod->invoke($this->multipleConsumer);
    }

    /**
     * Check queues provider works well with static queues together
     *
     * @dataProvider processMessageProvider
     */
    public function testQueuesProviderAndStaticQueuesTogether($processFlag, $expectedMethod, $expectedRequeue = null)
    {
        $callback = $this->prepareCallback($processFlag);

        $this->multipleConsumer->setQueues(
            array(
                'test-1' => array('callback' => $callback),
                'test-2' => array('callback' => $callback)
            )
        );

        $queuesProvider = $this->prepareQueuesProvider();
        $queuesProvider->expects($this->once())
            ->method('getQueues')
            ->will($this->returnValue(
                array(
                    'test-3' => array('callback' => $callback),
                    'test-4' => array('callback' => $callback)
                )
            ));

        $this->multipleConsumer->setQueuesProvider($queuesProvider);

        /**
         * We don't test consume method, which merges queues by calling $this->setupConsumer();
         * So we need to invoke it manually
         */
        $reflectionClass = new \ReflectionClass(get_class($this->multipleConsumer));
        $reflectionMethod = $reflectionClass->getMethod('mergeQueues');
        $reflectionMethod->setAccessible(true);
        $reflectionMethod->invoke($this->multipleConsumer);

        $this->prepareAMQPChannelExpectations($expectedMethod, $expectedRequeue);

        // Create a default message
        $amqpMessage = new AMQPMessage('foo body');
        $amqpMessage->delivery_info['channel'] = $this->amqpChannel;

The property PhpAmqpLib\Message\AMQPMessage::$delivery_info has been deprecated.

        $amqpMessage->delivery_info['delivery_tag'] = 0;

The property PhpAmqpLib\Message\AMQPMessage::$delivery_info has been deprecated.

        $this->multipleConsumer->processQueueMessage('test-1', $amqpMessage);
        $this->multipleConsumer->processQueueMessage('test-2', $amqpMessage);
        $this->multipleConsumer->processQueueMessage('test-3', $amqpMessage);
        $this->multipleConsumer->processQueueMessage('test-4', $amqpMessage);
    }

    public function processMessageProvider()
    {
        return array(
            array(null, 'basic_ack'), // Remove message from queue only if callback return not false
            array(true, 'basic_ack'), // Remove message from queue only if callback return not false
            array(false, 'basic_reject', true), // Reject and requeue message to RabbitMQ
            array(ConsumerInterface::MSG_ACK, 'basic_ack'), // Remove message from queue only if callback return not false
            array(ConsumerInterface::MSG_REJECT_REQUEUE, 'basic_reject', true), // Reject and requeue message to RabbitMQ
            array(ConsumerInterface::MSG_REJECT, 'basic_reject', false), // Reject and drop
        );
    }

    /**
     * @dataProvider queueBindingRoutingKeyProvider
     */
    public function testShouldConsiderQueueArgumentsOnQueueDeclaration($routingKeysOption, $expectedRoutingKey)
    {
        $queueName = 'test-queue-name';
        $exchangeName = 'test-exchange-name';
        $expectedArgs = ['test-argument' => ['S', 'test-value']];

        $this->amqpChannel->expects($this->any())
            ->method('getChannelId')->willReturn(0);

        $this->amqpChannel->expects($this->any())
            ->method('queue_declare')
            ->willReturn([$queueName, 5, 0]);


        $this->multipleConsumer->setExchangeOptions([
            'declare' => false,
            'name' => $exchangeName,
            'type' => 'topic']);

        $this->multipleConsumer->setQueues([
            $queueName => [
                'passive' => true,
                'durable' => true,
                'exclusive' => true,
                'auto_delete' => true,
                'nowait' => true,
                'arguments' => $expectedArgs,
                'ticket' => null,
                'routing_keys' => $routingKeysOption]
        ]);

        $this->multipleConsumer->setRoutingKey('test-routing-key');

        // we assert that arguments are passed to the bind method
        $this->amqpChannel->expects($this->once())
            ->method('queue_bind')
            ->with($queueName, $exchangeName, $expectedRoutingKey, false, $expectedArgs);

        $this->multipleConsumer->setupFabric();
    }

    public function queueBindingRoutingKeyProvider()
    {
        return array(
            array(array(), 'test-routing-key'),
            array(array('test-routing-key-2'), 'test-routing-key-2'),
        );
    }

    /**
     * Preparing AMQP Connection
     *
     * @return MockObject|AMQPStreamConnection
     */
    private function prepareAMQPConnection()
    {
        return $this->getMockBuilder('\PhpAmqpLib\Connection\AMQPStreamConnection')
            ->disableOriginalConstructor()
            ->getMock();
    }

    /**
     * Preparing AMQP Connection
     *
     * @return MockObject|AMQPChannel
     */
    private function prepareAMQPChannel()
    {
        return $this->getMockBuilder('\PhpAmqpLib\Channel\AMQPChannel')
            ->disableOriginalConstructor()
            ->getMock();
    }

    /**
     * Preparing QueuesProviderInterface instance
     *
     * @return MockObject|QueuesProviderInterface
     */
    private function prepareQueuesProvider()
    {
        return $this->getMockBuilder('\OldSound\RabbitMqBundle\Provider\QueuesProviderInterface')
            ->getMock();
    }

    /**
     * Preparing AMQP Channel Expectations
     *
     * @param mixed $expectedMethod
     * @param string $expectedRequeue
     *
     * @return void
     */
    private function prepareAMQPChannelExpectations($expectedMethod, $expectedRequeue)
    {
        $this->amqpChannel->expects($this->any())
            ->method('basic_reject')
            ->will($this->returnCallback(function ($delivery_tag, $requeue) use ($expectedMethod, $expectedRequeue) {
                Assert::assertSame($expectedMethod, 'basic_reject'); // Check if this function should be called.
                Assert::assertSame($requeue, $expectedRequeue); // Check if the message should be requeued.
            }));

        $this->amqpChannel->expects($this->any())
            ->method('basic_ack')
            ->will($this->returnCallback(function ($delivery_tag) use ($expectedMethod) {

The parameter $delivery_tag is not used and could be removed.

                Assert::assertSame($expectedMethod, 'basic_ack'); // Check if this function should be called.
            }));
    }

    /**
     * Prepare callback
     *
     * @param bool $processFlag
     * @return callable
     */
    private function prepareCallback($processFlag)
    {
        return function ($msg) use ($processFlag) {

The parameter $msg is not used and could be removed.

            return $processFlag;
        };
    }
}