3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 require_once 'CiviTest/CiviUnitTestCase.php';
32 * Ensure that various queue implementations comply with the interface
34 class CRM_Queue_QueueTest
extends CiviUnitTestCase
{
36 /* ----------------------- Queue providers ----------------------- */
38 /* Define a list of queue providers which should be tested */
41 * Return a list of persistent and transient queue providers
43 function getQueueSpecs() {
44 $queueSpecs = array();
45 $queueSpecs[] = array(
48 'name' => 'test-queue',
50 $queueSpecs[] = array(
53 'name' => 'test-queue',
58 /* ----------------------- Per-provider tests ----------------------- */
61 $this->queueService
= CRM_Queue_Service
::singleton(TRUE);
65 CRM_Utils_Time
::resetTime();
67 $tablesToTruncate = array('civicrm_queue_item');
68 $this->quickCleanup($tablesToTruncate);
72 * Create a few queue items; alternately enqueue and dequeue various
74 * @dataProvider getQueueSpecs
76 function testBasicUsage($queueSpec) {
77 $this->queue
= $this->queueService
->create($queueSpec);
78 $this->assertTrue($this->queue
instanceof CRM_Queue_Queue
);
80 $this->queue
->createItem(array(
83 $this->queue
->createItem(array(
86 $this->queue
->createItem(array(
90 $this->assertEquals(3, $this->queue
->numberOfItems());
91 $item = $this->queue
->claimItem();
92 $this->assertEquals('a', $item->data
['test-key']);
93 $this->queue
->deleteItem($item);
95 $this->assertEquals(2, $this->queue
->numberOfItems());
96 $item = $this->queue
->claimItem();
97 $this->assertEquals('b', $item->data
['test-key']);
98 $this->queue
->deleteItem($item);
100 $this->queue
->createItem(array(
104 $this->assertEquals(2, $this->queue
->numberOfItems());
105 $item = $this->queue
->claimItem();
106 $this->assertEquals('c', $item->data
['test-key']);
107 $this->queue
->deleteItem($item);
109 $this->assertEquals(1, $this->queue
->numberOfItems());
110 $item = $this->queue
->claimItem();
111 $this->assertEquals('d', $item->data
['test-key']);
112 $this->queue
->deleteItem($item);
114 $this->assertEquals(0, $this->queue
->numberOfItems());
118 * Claim an item from the queue and release it back for subsequent processing
120 * @dataProvider getQueueSpecs
122 function testManualRelease($queueSpec) {
123 $this->queue
= $this->queueService
->create($queueSpec);
124 $this->assertTrue($this->queue
instanceof CRM_Queue_Queue
);
126 $this->queue
->createItem(array(
130 $item = $this->queue
->claimItem();
131 $this->assertEquals('a', $item->data
['test-key']);
132 $this->assertEquals(1, $this->queue
->numberOfItems());
133 $this->queue
->releaseItem($item);
135 $this->assertEquals(1, $this->queue
->numberOfItems());
136 $item = $this->queue
->claimItem();
137 $this->assertEquals('a', $item->data
['test-key']);
138 $this->queue
->deleteItem($item);
140 $this->assertEquals(0, $this->queue
->numberOfItems());
144 * Test that item leases expire at the expected time
146 * @dataProvider getQueueSpecs
148 function testTimeoutRelease($queueSpec) {
149 $this->queue
= $this->queueService
->create($queueSpec);
150 $this->assertTrue($this->queue
instanceof CRM_Queue_Queue
);
152 CRM_Utils_Time
::setTime('2012-04-01 1:00:00');
153 $this->queue
->createItem(array(
157 $item = $this->queue
->claimItem();
158 $this->assertEquals('a', $item->data
['test-key']);
159 $this->assertEquals(1, $this->queue
->numberOfItems());
162 // haven't reach expiration yet
163 CRM_Utils_Time
::setTime('2012-04-01 1:59:00');
164 $item2 = $this->queue
->claimItem();
165 $this->assertEquals(FALSE, $item2);
167 // pass expiration mark
168 CRM_Utils_Time
::setTime('2012-04-01 2:00:01');
169 $item3 = $this->queue
->claimItem();
170 $this->assertEquals('a', $item3->data
['test-key']);
171 $this->assertEquals(1, $this->queue
->numberOfItems());
172 $this->queue
->deleteItem($item3);
174 $this->assertEquals(0, $this->queue
->numberOfItems());
178 * Test that item leases can be ignored
180 * @dataProvider getQueueSpecs
182 function testStealItem($queueSpec) {
183 $this->queue
= $this->queueService
->create($queueSpec);
184 $this->assertTrue($this->queue
instanceof CRM_Queue_Queue
);
186 require_once 'CRM/Utils/Time.php';
187 CRM_Utils_Time
::setTime('2012-04-01 1:00:00');
188 $this->queue
->createItem(array(
192 $item = $this->queue
->claimItem();
193 $this->assertEquals('a', $item->data
['test-key']);
194 $this->assertEquals(1, $this->queue
->numberOfItems());
197 // haven't reached expiration yet, so claimItem fails
198 CRM_Utils_Time
::setTime('2012-04-01 1:59:00');
199 $item2 = $this->queue
->claimItem();
200 $this->assertEquals(FALSE, $item2);
202 // but stealItem works
203 $item3 = $this->queue
->stealItem();
204 $this->assertEquals('a', $item3->data
['test-key']);
205 $this->assertEquals(1, $this->queue
->numberOfItems());
206 $this->queue
->deleteItem($item3);
208 $this->assertEquals(0, $this->queue
->numberOfItems());
212 * Test that queue content is reset when reset=>TRUE
214 * @dataProvider getQueueSpecs
216 function testCreateResetTrue($queueSpec) {
217 $this->queue
= $this->queueService
->create($queueSpec);
218 $this->queue
->createItem(array(
221 $this->queue
->createItem(array(
224 $this->assertEquals(2, $this->queue
->numberOfItems());
227 $queue2 = $this->queueService
->create(
228 $queueSpec +
array('reset' => TRUE)
230 $this->assertEquals(0, $queue2->numberOfItems());
234 * Test that queue content is not reset when reset is omitted
236 * @dataProvider getQueueSpecs
238 function testCreateResetFalse($queueSpec) {
239 $this->queue
= $this->queueService
->create($queueSpec);
240 $this->queue
->createItem(array(
243 $this->queue
->createItem(array(
246 $this->assertEquals(2, $this->queue
->numberOfItems());
249 $queue2 = $this->queueService
->create($queueSpec);
250 $this->assertEquals(2, $queue2->numberOfItems());
252 $item = $queue2->claimItem();
253 $this->assertEquals('a', $item->data
['test-key']);
254 $queue2->releaseItem($item);
258 * Test that queue content is not reset when using load()
260 * @dataProvider getQueueSpecs
262 function testLoad($queueSpec) {
263 $this->queue
= $this->queueService
->create($queueSpec);
264 $this->queue
->createItem(array(
267 $this->queue
->createItem(array(
270 $this->assertEquals(2, $this->queue
->numberOfItems());
273 $queue2 = $this->queueService
->create($queueSpec);
274 $this->assertEquals(2, $queue2->numberOfItems());
276 $item = $queue2->claimItem();
277 $this->assertEquals('a', $item->data
['test-key']);
278 $queue2->releaseItem($item);