haoshengxin/vendor/codeception/base/docs/modules/AMQP.md

AMQP

This module interacts with message broker software that implements the Advanced Message Queuing Protocol (AMQP) standard. For example, RabbitMQ (tested). Use it to cleanup the queue between tests.

To use this module with Composer you need "videlalvaro/php-amqplib": "*" package.

Status

• Maintainer: davert, tiger-seo
• Stability: alpha
• Contact: codecept@davert.mail.ua
• Contact: tiger.seo@gmail.com

Please review the code of non-stable modules and provide patches if you have issues.

Config

• host: localhost - host to connect
• username: guest - username to connect
• password: guest - password to connect
• vhost: '/' - vhost to connect
• cleanup: true - defined queues will be purged before running every test.
• queues: [mail, twitter] - queues to cleanup

Example

modules:
    enabled:
        - AMQP:
            host: 'localhost'
            port: '5672'
            username: 'guest'
            password: 'guest'
            vhost: '/'
            queues: [queue1, queue2]

Public Properties

• connection - AMQPStreamConnection - current connection

@since 1.1.2 @author tiger.seo@gmail.com @author davert

Actions

grabMessageFromQueue

Takes last message from queue.

$message = $I->grabMessageFromQueue('queue.emails');

• param $queue
• return AMQPMessage

purgeAllQueues

Purge all queues defined in config.

<?php
$I->purgeAllQueues();
?>

purgeQueue

Purge a specific queue defined in config.

<?php
$I->purgeQueue('queue.emails');
?>

pushToExchange

Sends message to exchange by sending exchange name, message and (optionally) a routing key

<?php
$I->pushToExchange('exchange.emails', 'thanks');
$I->pushToExchange('exchange.emails', new AMQPMessage('Thanks!'));
$I->pushToExchange('exchange.emails', new AMQPMessage('Thanks!'), 'severity');
?>

• param $exchange
• param $message string|AMQPMessage
• param $routing_key

pushToQueue

Sends message to queue

<?php
$I->pushToQueue('queue.jobs', 'create user');
$I->pushToQueue('queue.jobs', new AMQPMessage('create'));
?>

• param $queue
• param $message string|AMQPMessage

seeMessageInQueueContainsText

Checks if message containing text received.

This method drops message from queue This method will wait for message. If none is sent the script will stuck.

<?php
$I->pushToQueue('queue.emails', 'Hello, davert');
$I->seeMessageInQueueContainsText('queue.emails','davert');
?>

• param $queue
• param $text

 

Module reference is taken from the source code. Help us to improve documentation. Edit module reference