Repository navigation
Expand file tree
/
Copy pathQueue.php
More file actions
400 lines (379 loc) · 10.9 KB
/
Copy pathQueue.php
File metadata and controls
400 lines (379 loc) · 10.9 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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
<?php
namespace Codeception\Module;
use Codeception\Module as CodeceptionModule;
use Codeception\TestInterface;
use Codeception\Exception\ModuleConfigException;
use Codeception\Lib\Driver\AmazonSQS;
use Codeception\Lib\Driver\Beanstalk;
use Codeception\Lib\Driver\Iron;
/**
*
* Works with Queue servers.
*
* Testing with a selection of remote/local queueing services, including Amazon's SQS service
* Iron.io service and beanstalkd service.
*
* Supported and tested queue types are:
*
* * [Iron.io](http://iron.io/)
* * [Beanstalkd](http://kr.github.io/beanstalkd/)
* * [Amazon SQS](http://aws.amazon.com/sqs/)
*
* The following dependencies are needed for the listed queue servers:
*
* * Beanstalkd: pda/pheanstalk ~3.0
* * Amazon SQS: aws/aws-sdk-php
* * IronMQ: iron-io/iron_mq
*
* ## Status
*
* * Maintainer: **nathanmac**
* * Stability:
* - Iron.io: **stable**
* - Beanstalkd: **stable**
* - Amazon SQS: **stable**
* * Contact: nathan.macnamara@outlook.com
*
* ## Config
*
* The configuration settings depending on which queueing service is being used, all the options are listed
* here. Refer to the configuration examples below to identify the configuration options required for your chosen
* service.
*
* * type - type of queueing server (defaults to beanstalkd).
* * host - hostname/ip address of the queue server or the host for the iron.io when using iron.io service.
* * port: 11300 - port number for the queue server.
* * timeout: 90 - timeout settings for connecting the queue server.
* * token - Iron.io access token.
* * project - Iron.io project ID.
* * key - AWS access key ID.
* * secret - AWS secret access key.
* Warning:
* Hard-coding your credentials can be dangerous, because it is easy to accidentally commit your credentials
* into an SCM repository, potentially exposing your credentials to more people than intended.
* It can also make it difficult to rotate credentials in the future.
* * profile - AWS credential profile
* - it should be located in ~/.aws/credentials file
* - eg: [default]
* aws_access_key_id = YOUR_AWS_ACCESS_KEY_ID
* aws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY
* [project1]
* aws_access_key_id = YOUR_AWS_ACCESS_KEY_ID
* aws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY
* - Note: Using IAM roles is the preferred technique for providing credentials
* to applications running on Amazon EC2
* http://docs.aws.amazon.com/aws-sdk-php/v3/guide/guide/credentials.html?highlight=credentials
*
* * region - A region parameter is also required for AWS, refer to the AWS documentation for possible values list.
*
* ### Example
* #### Example (beanstalkd)
*
* modules:
* enabled: [Queue]
* config:
* Queue:
* type: 'beanstalkd'
* host: '127.0.0.1'
* port: 11300
* timeout: 120
*
* #### Example (Iron.io)
*
* modules:
* enabled: [Queue]
* config:
* Queue:
* 'type' => 'iron',
* 'host' => 'mq-aws-us-east-1.iron.io',
* 'token' => 'your-token',
* 'project' => 'your-project-id'
*
* #### Example (AWS SQS)
*
* modules:
* enabled: [Queue]
* config:
* Queue:
* 'type' => 'aws',
* 'key' => 'your-public-key',
* 'secret' => 'your-secret-key',
* 'region' => 'us-west-2'
*
* #### Example AWS SQS using profile credentials
*
* modules:
* enabled: [Queue]
* config:
* Queue:
* 'type' => 'aws',
* 'profile' => 'project1', //see documentation
* 'region' => 'us-west-2'
*
* #### Example AWS SQS running on Anazon EC2 instance
*
* modules:
* enabled: [Queue]
* config:
* Queue:
* 'type' => 'aws',
* 'region' => 'us-west-2'
*
*/
class Queue extends CodeceptionModule
{
/**
* @var \Codeception\Lib\Interfaces\Queue
*/
public $queueDriver;
/**
* Setup connection and open/setup the connection with config settings
*
* @param \Codeception\TestInterface $test
*/
public function _before(TestInterface $test)
{
$this->queueDriver->openConnection($this->config);
}
/**
* Provide and override for the config settings and allow custom settings depending on the service being used.
*/
protected function validateConfig()
{
$this->queueDriver = $this->createQueueDriver();
$this->requiredFields = $this->queueDriver->getRequiredConfig();
$this->config = array_merge($this->queueDriver->getDefaultConfig(), $this->config);
parent::validateConfig();
}
/**
* @return \Codeception\Lib\Interfaces\Queue
* @throws ModuleConfigException
*/
protected function createQueueDriver()
{
switch ($this->config['type']) {
case 'aws':
case 'sqs':
case 'aws_sqs':
return new AmazonSQS();
case 'iron':
case 'iron_mq':
return new Iron();
case 'beanstalk':
case 'beanstalkd':
case 'beanstalkq':
return new Beanstalk();
default:
throw new ModuleConfigException(
__CLASS__,
"Unknown queue type {$this->config}; Supported queue types are: aws, iron, beanstalk"
);
}
}
// ----------- SEARCH METHODS BELOW HERE ------------------------//
/**
* Check if a queue/tube exists on the queueing server.
*
* ```php
* <?php
* $I->seeQueueExists('default');
* ?>
* ```
*
* @param string $queue Queue Name
*/
public function seeQueueExists($queue)
{
$this->assertContains($queue, $this->queueDriver->getQueues());
}
/**
* Check if a queue/tube does NOT exist on the queueing server.
*
* ```php
* <?php
* $I->dontSeeQueueExists('default');
* ?>
* ```
*
* @param string $queue Queue Name
*/
public function dontSeeQueueExists($queue)
{
$this->assertNotContains($queue, $this->queueDriver->getQueues());
}
/**
* Check if a queue/tube is empty of all messages
*
* ```php
* <?php
* $I->seeEmptyQueue('default');
* ?>
* ```
*
* @param string $queue Queue Name
*/
public function seeEmptyQueue($queue)
{
$this->assertEquals(0, $this->queueDriver->getMessagesCurrentCountOnQueue($queue));
}
/**
* Check if a queue/tube is NOT empty of all messages
*
* ```php
* <?php
* $I->dontSeeEmptyQueue('default');
* ?>
* ```
*
* @param string $queue Queue Name
*/
public function dontSeeEmptyQueue($queue)
{
$this->assertNotEquals(0, $this->queueDriver->getMessagesCurrentCountOnQueue($queue));
}
/**
* Check if a queue/tube has a given current number of messages
*
* ```php
* <?php
* $I->seeQueueHasCurrentCount('default', 10);
* ?>
* ```
*
* @param string $queue Queue Name
* @param int $expected Number of messages expected
*/
public function seeQueueHasCurrentCount($queue, $expected)
{
$this->assertEquals($expected, $this->queueDriver->getMessagesCurrentCountOnQueue($queue));
}
/**
* Check if a queue/tube does NOT have a given current number of messages
*
* ```php
* <?php
* $I->dontSeeQueueHasCurrentCount('default', 10);
* ?>
* ```
*
* @param string $queue Queue Name
* @param int $expected Number of messages expected
*/
public function dontSeeQueueHasCurrentCount($queue, $expected)
{
$this->assertNotEquals($expected, $this->queueDriver->getMessagesCurrentCountOnQueue($queue));
}
/**
* Check if a queue/tube has a given total number of messages
*
* ```php
* <?php
* $I->seeQueueHasTotalCount('default', 10);
* ?>
* ```
*
* @param string $queue Queue Name
* @param int $expected Number of messages expected
*/
public function seeQueueHasTotalCount($queue, $expected)
{
$this->assertEquals($expected, $this->queueDriver->getMessagesTotalCountOnQueue($queue));
}
/**
* Check if a queue/tube does NOT have a given total number of messages
*
* ```php
* <?php
* $I->dontSeeQueueHasTotalCount('default', 10);
* ?>
* ```
*
* @param string $queue Queue Name
* @param int $expected Number of messages expected
*/
public function dontSeeQueueHasTotalCount($queue, $expected)
{
$this->assertNotEquals($expected, $this->queueDriver->getMessagesTotalCountOnQueue($queue));
}
// ----------- UTILITY METHODS BELOW HERE -------------------------//
/**
* Add a message to a queue/tube
*
* ```php
* <?php
* $I->addMessageToQueue('this is a messages', 'default');
* ?>
* ```
*
* @param string $message Message Body
* @param string $queue Queue Name
*/
public function addMessageToQueue($message, $queue)
{
$this->queueDriver->addMessageToQueue($message, $queue);
}
/**
* Clear all messages of the queue/tube
*
* ```php
* <?php
* $I->clearQueue('default');
* ?>
* ```
*
* @param string $queue Queue Name
*/
public function clearQueue($queue)
{
$this->queueDriver->clearQueue($queue);
}
// ----------- GRABBER METHODS BELOW HERE -----------------------//
/**
* Grabber method to get the list of queues/tubes on the server
*
* ```php
* <?php
* $queues = $I->grabQueues();
* ?>
* ```
*
* @return array List of Queues/Tubes
*/
public function grabQueues()
{
return $this->queueDriver->getQueues();
}
/**
* Grabber method to get the current number of messages on the queue/tube (pending/ready)
*
* ```php
* <?php
* $I->grabQueueCurrentCount('default');
* ?>
* ```
* @param string $queue Queue Name
*
* @return int Count
*/
public function grabQueueCurrentCount($queue)
{
return $this->queueDriver->getMessagesCurrentCountOnQueue($queue);
}
/**
* Grabber method to get the total number of messages on the queue/tube
*
* ```php
* <?php
* $I->grabQueueTotalCount('default');
* ?>
* ```
*
* @param $queue Queue Name
*
* @return int Count
*/
public function grabQueueTotalCount($queue)
{
return $this->queueDriver->getMessagesTotalCountOnQueue($queue);
}
}