Repository navigation
Expand file tree
/
Copy pathAMQP.php
More file actions
207 lines (192 loc) · 5.88 KB
/
Copy pathAMQP.php
File metadata and controls
207 lines (192 loc) · 5.88 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<?php
namespace Codeception\Module;
use Codeception\Exception\Module as ModuleException;
use Exception;
use PhpAmqpLib\Message\AMQPMessage;
use PhpAmqpLib\Connection\AMQPConnection;
use PhpAmqpLib\Channel\AMQPChannel;
use PhpAmqpLib\Exception\AMQPChannelException;
/**
* 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.
*
* <div class="alert alert-info">
* To use this module with Composer you need <em>"videlalvaro/php-amqplib": "*"</em> package.
* </div>
*
* ## 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]
* config:
* AMQP:
* host: 'localhost'
* port: '5672'
* username: 'guest'
* password: 'guest'
* vhost: '/'
* queues: [queue1, queue2]
*
* ## Public Properties
*
* * connection - AMQPConnection - current connection
*
* @since 1.1.2
* @author tiger.seo@gmail.com
* @author davert
*/
class AMQP extends \Codeception\Module
{
protected $config = array(
'host' => 'locahost',
'username' => 'guest',
'password' => 'guest',
'port' => '5672',
'vhost' => '/',
'cleanup' => true,
);
/**
* @var AMQPConnection
*/
public $connection;
/**
* @var AMQPChannel
*/
protected $channel;
protected $requiredFields = array('host', 'username', 'password', 'vhost');
public function _initialize()
{
$host = $this->config['host'];
$port = $this->config['port'];
$username = $this->config['username'];
$password = $this->config['password'];
$vhost = $this->config['vhost'];
try {
$this->connection = new AMQPConnection($host, $port, $username, $password, $vhost);
} catch (\Exception $e) {
throw new ModuleException(__CLASS__, $e->getMessage() . ' while establishing connection to MQ server');
}
}
public function _before(\Codeception\TestCase $test)
{
if ($this->config['cleanup']) {
$this->cleanup();
}
}
/**
* Sends message to exchange by sending exchange name, message
* and (optionally) a routing key
*
* ``` php
* <?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
*/
public function pushToExchange($exchange, $message, $routing_key = null)
{
$message = $message instanceof AMQPMessage
? $message
: new AMQPMessage($message);
$this->connection->channel()->basic_publish($message, $exchange, $routing_key);
}
/**
* Sends message to queue
*
* ``` php
* <?php
* $I->pushToQueue('queue.jobs', 'create user');
* $I->pushToQueue('queue.jobs', new AMQPMessage('create'));
* ?>
* ```
*
* @param $queue
* @param $message string|AMQPMessage
*/
public function pushToQueue($queue, $message)
{
$message = $message instanceof AMQPMessage
? $message
: new AMQPMessage($message);
$this->connection->channel()->queue_declare($queue);
$this->connection->channel()->basic_publish($message, '',$queue);
}
/**
* 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
* <?php
* $I->pushToQueue('queue.emails', 'Hello, davert');
* $I->seeMessageInQueueContainsText('queue.emails','davert');
* ?>
* ```
*
* @param $queue
* @param $text
*/
public function seeMessageInQueueContainsText($queue, $text)
{
$msg = $this->connection->channel()->basic_get($queue);
if (!$msg) $this->fail("Message was not received");
if (!$msg instanceof AMQPMessage) $this->fail("Received message is not format of AMQPMessage");
$this->debugSection("Message",$msg->body);
$this->assertContains($text, $msg->body);
}
/**
* Takes last message from queue.
*
* $message = $I->grabMessageFromQueue('queue.emails');
*
* @param $queue
* @return AMQPMessage
*/
public function grabMessageFromQueue($queue)
{
$message = $this->connection->channel()->basic_get($queue);
return $message;
}
protected function cleanup()
{
if (! isset($this->config['queues'])) {
throw new ModuleException(__CLASS__, "please set queues for cleanup");
}
if (!$this->connection) return;
foreach ($this->config['queues'] as $queue) {
try {
$this->connection->channel()->queue_purge($queue);
} catch (\PhpAmqpLib\Exception\AMQPProtocolChannelException $e) {
# ignore if exchange/queue doesn't exist and rethrow exception if it's something else
if ($e->getCode() !== 404) {
throw $e;
}
}
}
}
}