3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 * Ensure that various queue implementations comply with the interface
32 class CRM_Queue_QueueTest
extends CiviUnitTestCase
{
34 /* ----------------------- Queue providers ----------------------- */
36 /* Define a list of queue providers which should be tested */
39 * Return a list of persistent and transient queue providers.
41 public function getQueueSpecs() {
42 $queueSpecs = array();
43 $queueSpecs[] = array(
46 'name' => 'test-queue',
49 $queueSpecs[] = array(
52 'name' => 'test-queue',
61 public function setUp() {
63 $this->queueService
= CRM_Queue_Service
::singleton(TRUE);
66 public function tearDown() {
67 CRM_Utils_Time
::resetTime();
69 $tablesToTruncate = array('civicrm_queue_item');
70 $this->quickCleanup($tablesToTruncate);
74 * Create a few queue items; alternately enqueue and dequeue various
76 * @dataProvider getQueueSpecs
79 public function testBasicUsage($queueSpec) {
80 $this->queue
= $this->queueService
->create($queueSpec);
81 $this->assertTrue($this->queue
instanceof CRM_Queue_Queue
);
83 $this->queue
->createItem(array(
86 $this->queue
->createItem(array(
89 $this->queue
->createItem(array(
93 $this->assertEquals(3, $this->queue
->numberOfItems());
94 $item = $this->queue
->claimItem();
95 $this->assertEquals('a', $item->data
['test-key']);
96 $this->queue
->deleteItem($item);
98 $this->assertEquals(2, $this->queue
->numberOfItems());
99 $item = $this->queue
->claimItem();
100 $this->assertEquals('b', $item->data
['test-key']);
101 $this->queue
->deleteItem($item);
103 $this->queue
->createItem(array(
107 $this->assertEquals(2, $this->queue
->numberOfItems());
108 $item = $this->queue
->claimItem();
109 $this->assertEquals('c', $item->data
['test-key']);
110 $this->queue
->deleteItem($item);
112 $this->assertEquals(1, $this->queue
->numberOfItems());
113 $item = $this->queue
->claimItem();
114 $this->assertEquals('d', $item->data
['test-key']);
115 $this->queue
->deleteItem($item);
117 $this->assertEquals(0, $this->queue
->numberOfItems());
121 * Claim an item from the queue and release it back for subsequent processing.
123 * @dataProvider getQueueSpecs
126 public function testManualRelease($queueSpec) {
127 $this->queue
= $this->queueService
->create($queueSpec);
128 $this->assertTrue($this->queue
instanceof CRM_Queue_Queue
);
130 $this->queue
->createItem(array(
134 $item = $this->queue
->claimItem();
135 $this->assertEquals('a', $item->data
['test-key']);
136 $this->assertEquals(1, $this->queue
->numberOfItems());
137 $this->queue
->releaseItem($item);
139 $this->assertEquals(1, $this->queue
->numberOfItems());
140 $item = $this->queue
->claimItem();
141 $this->assertEquals('a', $item->data
['test-key']);
142 $this->queue
->deleteItem($item);
144 $this->assertEquals(0, $this->queue
->numberOfItems());
148 * Test that item leases expire at the expected time.
150 * @dataProvider getQueueSpecs
154 public function testTimeoutRelease($queueSpec) {
155 $this->queue
= $this->queueService
->create($queueSpec);
156 $this->assertTrue($this->queue
instanceof CRM_Queue_Queue
);
158 CRM_Utils_Time
::setTime('2012-04-01 1:00:00');
159 $this->queue
->createItem(array(
163 $item = $this->queue
->claimItem();
164 $this->assertEquals('a', $item->data
['test-key']);
165 $this->assertEquals(1, $this->queue
->numberOfItems());
168 // haven't reach expiration yet
169 CRM_Utils_Time
::setTime('2012-04-01 1:59:00');
170 $item2 = $this->queue
->claimItem();
171 $this->assertEquals(FALSE, $item2);
173 // pass expiration mark
174 CRM_Utils_Time
::setTime('2012-04-01 2:00:01');
175 $item3 = $this->queue
->claimItem();
176 $this->assertEquals('a', $item3->data
['test-key']);
177 $this->assertEquals(1, $this->queue
->numberOfItems());
178 $this->queue
->deleteItem($item3);
180 $this->assertEquals(0, $this->queue
->numberOfItems());
184 * Test that item leases can be ignored.
186 * @dataProvider getQueueSpecs
189 public function testStealItem($queueSpec) {
190 $this->queue
= $this->queueService
->create($queueSpec);
191 $this->assertTrue($this->queue
instanceof CRM_Queue_Queue
);
193 CRM_Utils_Time
::setTime('2012-04-01 1:00:00');
194 $this->queue
->createItem(array(
198 $item = $this->queue
->claimItem();
199 $this->assertEquals('a', $item->data
['test-key']);
200 $this->assertEquals(1, $this->queue
->numberOfItems());
203 // haven't reached expiration yet, so claimItem fails
204 CRM_Utils_Time
::setTime('2012-04-01 1:59:00');
205 $item2 = $this->queue
->claimItem();
206 $this->assertEquals(FALSE, $item2);
208 // but stealItem works
209 $item3 = $this->queue
->stealItem();
210 $this->assertEquals('a', $item3->data
['test-key']);
211 $this->assertEquals(1, $this->queue
->numberOfItems());
212 $this->queue
->deleteItem($item3);
214 $this->assertEquals(0, $this->queue
->numberOfItems());
218 * Test that queue content is reset when reset=>TRUE
220 * @dataProvider getQueueSpecs
223 public function testCreateResetTrue($queueSpec) {
224 $this->queue
= $this->queueService
->create($queueSpec);
225 $this->queue
->createItem(array(
228 $this->queue
->createItem(array(
231 $this->assertEquals(2, $this->queue
->numberOfItems());
234 $queue2 = $this->queueService
->create(
235 $queueSpec +
array('reset' => TRUE)
237 $this->assertEquals(0, $queue2->numberOfItems());
241 * Test that queue content is not reset when reset is omitted.
243 * @dataProvider getQueueSpecs
246 public function testCreateResetFalse($queueSpec) {
247 $this->queue
= $this->queueService
->create($queueSpec);
248 $this->queue
->createItem(array(
251 $this->queue
->createItem(array(
254 $this->assertEquals(2, $this->queue
->numberOfItems());
257 $queue2 = $this->queueService
->create($queueSpec);
258 $this->assertEquals(2, $queue2->numberOfItems());
260 $item = $queue2->claimItem();
261 $this->assertEquals('a', $item->data
['test-key']);
262 $queue2->releaseItem($item);
266 * Test that queue content is not reset when using load()
268 * @dataProvider getQueueSpecs
271 public function testLoad($queueSpec) {
272 $this->queue
= $this->queueService
->create($queueSpec);
273 $this->queue
->createItem(array(
276 $this->queue
->createItem(array(
279 $this->assertEquals(2, $this->queue
->numberOfItems());
282 $queue2 = $this->queueService
->create($queueSpec);
283 $this->assertEquals(2, $queue2->numberOfItems());
285 $item = $queue2->claimItem();
286 $this->assertEquals('a', $item->data
['test-key']);
287 $queue2->releaseItem($item);