Repository navigation
Expand file tree
/
Copy pathQueue.php
More file actions
599 lines (569 loc) · 18.1 KB
/
Copy pathQueue.php
File metadata and controls
599 lines (569 loc) · 18.1 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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
<?php
namespace Codeception\Module;
/**
*
* 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 ~2.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.
* * 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'
*
*/
class Queue extends \Codeception\Module
{
/**
* @var
*/
protected $queue;
// ----------- SETUP METHODS BELOW HERE -------------------------//
/**
* Setup connection and open/setup the connection with config settings
*
* @param \Codeception\TestCase $test
*/
public function _before(\Codeception\TestCase $test)
{
$this->_openConnection();
}
/**
* Provide and override for the config settings and allow custom settings depending on the service being used.
*/
protected function validateConfig()
{
// Customisable requirement fields depending on the queue type selected. (aws_sqs, iron_mq, beanstalkq)
switch (strtolower($this->config['type']))
{
case 'aws':
case 'sqs':
case 'aws_sqs':
$this->requiredFields = array('key', 'secret', 'region');
break;
case 'iron':
case 'iron_mq':
$this->requiredFields = array('host', 'token', 'project');
break;
default:
$this->requiredFields = array('host');
$this->config = array_merge(array('port' => 11300, 'timeout' => 90), $this->config);
}
parent::validateConfig();
}
// ----------- 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->debug("see queue: [{$queue}]");
\PHPUnit_Framework_Assert::assertContains($queue, $this->_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->debug("don't see queue: [{$queue}]");
\PHPUnit_Framework_Assert::assertNotContains($queue, $this->_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)
{
$count = $this->_getMessagesCurrentCountOnQueue($queue);
$this->debug("see empty queue: queue [{$queue}] has [{$count}] messages");
\PHPUnit_Framework_Assert::assertEquals(0, $count);
}
/**
* 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)
{
$count = $this->_getMessagesCurrentCountOnQueue($queue);
$this->debug("don't see empty queue: queue [{$queue}] has [{$count}] messages");
\PHPUnit_Framework_Assert::assertNotEquals(0, $count);
}
/**
* 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)
{
$count = $this->_getMessagesCurrentCountOnQueue($queue);
$this->debug("see queue has current count: queue [{$queue}] has [{$count}] messages");
\PHPUnit_Framework_Assert::assertEquals($expected, $count);
}
/**
* 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)
{
$count = $this->_getMessagesCurrentCountOnQueue($queue);
$this->debug("don't see queue has current count: queue [{$queue}] has [{$count}] messages");
\PHPUnit_Framework_Assert::assertNotEquals($expected, $count);
}
/**
* 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)
{
$count = $this->_getMessagesTotalCountOnQueue($queue);
$this->debug("see queue has total count: queue [{$queue}] has [{$count}] messages");
\PHPUnit_Framework_Assert::assertEquals($expected, $count);
}
/**
* 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)
{
$count = $this->_getMessagesTotalCountOnQueue($queue);
$this->debug("don't see queue has total count: queue [{$queue}] has [{$count}] messages");
\PHPUnit_Framework_Assert::assertNotEquals($expected, $count);
}
// ----------- 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->_addMessageToQueue($message, $queue);
$this->debug('message queued: ['. $queue . ']');
}
/**
* Clear all messages of the queue/tube
*
* ```php
* <?php
* $I->clearQueue('default');
* ?>
* ```
*
* @param string $queue Queue Name
*/
public function clearQueue($queue)
{
$this->debug('clear queue: [' . $queue . ']');
$this->_clearQueue($queue);
}
// ----------- GRABBER METHODS BELOW HERE -----------------------//
/**
* Grabber method to get the list of queues/tubes on the server
*
* ```php
* <?php
* $I->grabQueues();
* ?>
* ```
*
* @return array List of Queues/Tubes
*/
public function grabQueues()
{
$queues = $this->_getQueues();
$this->debug('grab queues:');
foreach ($queues as $queue) {
$this->debug(' - [' . $queue . ']');
}
return $queues;
}
/**
* 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->_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->_getMessagesTotalCountOnQueue($queue);
}
// ----------- CONNECTION METHODS BELOW HERE -------------//
/**
* Connect to the queueing server. (AWS, Iron.io and Beanstalkd)
*/
private function _openConnection()
{
$this->debug('');
switch(strtolower($this->config['type']))
{
case 'aws':
case 'sqs':
case 'aws_sqs':
$this->queue = \Aws\Sqs\SqsClient::factory(array(
'credentials' => new \Aws\Common\Credentials\Credentials($this->config['key'], $this->config['secret']),
'region' => $this->config['region']
)) OR \PHPUnit_Framework_Assert::fail('connection failed or timed-out.');
break;
case 'iron':
case 'iron_mq':
$this->queue = new \IronMQ(array(
"token" => $this->config['token'],
"project_id" => $this->config['project'],
"host" => $this->config['host']
)) OR \PHPUnit_Framework_Assert::fail('connection failed or timed-out.');
break;
default:
$this->queue = new \Pheanstalk_Pheanstalk($this->config['host'], $this->config['port'], $this->config['timeout'])
OR \PHPUnit_Framework_Assert::fail('connection failed or timed-out.');
}
}
/**
* Post/Put a message on to the queue server
*
* @param string $message Message Body to be send
* @param string $queue Queue Name
*/
private function _addMessageToQueue($message, $queue)
{
switch(strtolower($this->config['type']))
{
case 'aws':
case 'sqs':
case 'aws_sqs':
$this->queue->sendMessage(array(
'QueueUrl' => $this->_getQueueURL($queue),
'MessageBody' => $message,
));
break;
case 'iron':
case 'iron_mq':
$this->queue->postMessage($queue, $message);
break;
default:
$this->queue->putInTube($queue, $message);
}
}
/**
* Return a list of queues/tubes on the queueing server
*
* @return array Array of Queues
*/
private function _getQueues()
{
switch(strtolower($this->config['type']))
{
case 'aws':
case 'sqs':
case 'aws_sqs':
$queueNames = array();
$queues = $this->queue->listQueues(array('QueueNamePrefix' => ''))->get('QueueUrls');
foreach ($queues as $queue) {
$tokens = explode('/', $queue);
$queueNames[] = $tokens[sizeof($tokens)-1];
}
return $queueNames;
case 'iron':
case 'iron_mq':
// Format the output to suit
$queues = array();
foreach($this->queue->getQueues() as $queue) {
$queues[] = $queue->name;
}
return $queues;
default:
return $this->queue->listTubes();
}
}
/**
* Count the current number of messages on the queue.
*
* @param $queue Queue Name
*
* @return int Count
*/
private function _getMessagesCurrentCountOnQueue($queue)
{
switch(strtolower($this->config['type']))
{
case 'aws':
case 'sqs':
case 'aws_sqs':
return $this->queue->getQueueAttributes(array(
'QueueUrl' => $this->_getQueueURL($queue),
'AttributeNames' => array('ApproximateNumberOfMessages'),
))->get('Attributes')['ApproximateNumberOfMessages'];
break;
case 'iron':
case 'iron_mq':
try {
return $this->queue->getQueue('my_queue')->size;
} catch (\Http_Exception $ex) {
$this->debug('queue: [' . $queue . '] not found');
\PHPUnit_Framework_Assert::fail('queue [' . $queue . '] not found');
}
default:
try {
return $this->queue->statsTube($queue)['current-jobs-ready'];
} catch (\Pheanstalk_Exception_ServerException $ex) {
$this->debug('queue: [' . $queue . '] not found');
\PHPUnit_Framework_Assert::fail('queue [' . $queue . '] not found');
}
}
}
/**
* Count the total number of messages on the queue.
*
* @param $queue Queue Name
*
* @return int Count
*/
private function _getMessagesTotalCountOnQueue($queue)
{
switch(strtolower($this->config['type']))
{
case 'aws':
case 'sqs':
case 'aws_sqs':
return $this->queue->getQueueAttributes(array(
'QueueUrl' => $this->_getQueueURL($queue),
'AttributeNames' => array('ApproximateNumberOfMessages'),
))->get('Attributes')['ApproximateNumberOfMessages'];
break;
case 'iron':
case 'iron_mq':
try {
return $this->queue->getQueue($queue)->total_messages;
} catch (\Http_Exception $ex) {
$this->debug('queue: [' . $queue . '] not found');
\PHPUnit_Framework_Assert::fail('queue [' . $queue . '] not found');
}
default:
try {
return $this->queue->statsTube($queue)['total-jobs'];
} catch (\Pheanstalk_Exception_ServerException $ex) {
$this->debug('queue: [' . $queue . '] not found');
\PHPUnit_Framework_Assert::fail('queue [' . $queue . '] not found');
}
}
}
/**
* Clear the queue/tube of all messages
*
* @param $queue Queue Name
*/
private function _clearQueue($queue)
{
switch(strtolower($this->config['type']))
{
case 'aws':
case 'sqs':
case 'aws_sqs':
$queueURL = $this->_getQueueURL($queue);
while(true) {
$res = $this->queue->receiveMessage(array('QueueUrl' => $queueURL));
if ($res->getPath('Messages')) {
foreach ($res->getPath('Messages') as $msg) {
$this->debug(" - delete message: ".$msg['MessageId']);
}
// Do something useful with $msg['Body'] here
$this->queue->deleteMessage(array(
'QueueUrl' => $queueURL,
'ReceiptHandle' => $msg['ReceiptHandle']
));
} else {
break;
}
}
break;
case 'iron':
case 'iron_mq':
try {
$this->queue->clearQueue($queue);
} catch (\Http_Exception $ex) {
$this->debug('queue: [' . $queue . '] not found');
\PHPUnit_Framework_Assert::fail('queue [' . $queue . '] not found');
}
break;
default:
while($job = $this->queue->reserve(0)) {
$this->queue->delete($job);
}
}
}
/**
* Get the queue/tube URL from the queue name (AWS function only)
*
* @param $queue Queue Name
*
* @return string Queue URL
*/
private function _getQueueURL($queue)
{
$queues = $this->queue->listQueues(array('QueueNamePrefix' => ''))->get('QueueUrls');
foreach ($queues as $queueURL) {
$tokens = explode('/', $queueURL);
if (strtolower($queue) == strtolower($tokens[sizeof($tokens)-1]))
return $queueURL;
}
$this->debug('queue: [' . $queue . '] not found');
\PHPUnit_Framework_Assert::fail('queue [' . $queue . '] not found');
}
}