8 class JobQueueTest
extends MediaWikiTestCase
{
10 protected $queueRand, $queueRandTTL, $queueFifo, $queueFifoTTL;
12 function __construct( $name = null, array $data = array(), $dataName = '' ) {
13 parent
::__construct( $name, $data, $dataName );
15 $this->tablesUsed
[] = 'job';
18 protected function setUp() {
19 global $wgJobTypeConf;
22 $this->setMwGlobals( 'wgMemc', new HashBagOStuff() );
24 if ( $this->getCliArg( 'use-jobqueue=' ) ) {
25 $name = $this->getCliArg( 'use-jobqueue=' );
26 if ( !isset( $wgJobTypeConf[$name] ) ) {
27 throw new MWException( "No \$wgJobTypeConf entry for '$name'." );
29 $baseConfig = $wgJobTypeConf[$name];
31 $baseConfig = array( 'class' => 'JobQueueDB' );
33 $baseConfig['type'] = 'null';
34 $baseConfig['wiki'] = wfWikiID();
36 'queueRand' => array( 'order' => 'random', 'claimTTL' => 0 ),
37 'queueRandTTL' => array( 'order' => 'random', 'claimTTL' => 10 ),
38 'queueTimestamp' => array( 'order' => 'timestamp', 'claimTTL' => 0 ),
39 'queueTimestampTTL' => array( 'order' => 'timestamp', 'claimTTL' => 10 ),
40 'queueFifo' => array( 'order' => 'fifo', 'claimTTL' => 0 ),
41 'queueFifoTTL' => array( 'order' => 'fifo', 'claimTTL' => 10 ),
43 foreach ( $variants as $q => $settings ) {
45 $this->$q = JobQueue
::factory( $settings +
$baseConfig );
46 if ( !( $this->$q instanceof JobQueueDB
) ) {
47 $this->$q->setTestingPrefix( 'unittests-' . wfRandomString( 32 ) );
49 } catch ( MWException
$e ) {}; // unsupported? (@TODO: what if it was another error?)
53 protected function tearDown() {
57 'queueRand', 'queueRandTTL', 'queueTimestamp', 'queueTimestampTTL',
58 'queueFifo', 'queueFifoTTL'
63 $job = $this->$q->pop();
65 $this->$q->ack( $job );
74 * @dataProvider provider_queueLists
76 function testProperties( $queue, $recycles, $desc ) {
77 $queue = $this->$queue;
79 $this->markTestSkipped( $desc );
82 $this->assertEquals( wfWikiID(), $queue->getWiki(), "Proper wiki ID ($desc)" );
83 $this->assertEquals( 'null', $queue->getType(), "Proper job type ($desc)" );
87 * @dataProvider provider_queueLists
89 function testBasicOperations( $queue, $recycles, $desc ) {
90 $queue = $this->$queue;
92 $this->markTestSkipped( $desc );
95 $this->assertTrue( $queue->isEmpty(), "Queue is empty ($desc)" );
97 $queue->flushCaches();
98 $this->assertEquals( 0, $queue->getSize(), "Queue is empty ($desc)" );
99 $this->assertEquals( 0, $queue->getAcquiredCount(), "Queue is empty ($desc)" );
101 $this->assertTrue( $queue->push( $this->newJob() ), "Push worked ($desc)" );
102 $this->assertTrue( $queue->batchPush( array( $this->newJob() ) ), "Push worked ($desc)" );
104 $this->assertFalse( $queue->isEmpty(), "Queue is not empty ($desc)" );
106 $queue->flushCaches();
107 $this->assertEquals( 2, $queue->getSize(), "Queue size is correct ($desc)" );
108 $this->assertEquals( 0, $queue->getAcquiredCount(), "No jobs active ($desc)" );
109 $jobs = iterator_to_array( $queue->getAllQueuedJobs() );
110 $this->assertEquals( 2, count( $jobs ), "Queue iterator size is correct ($desc)" );
113 $job1 = $queue->pop();
114 $this->assertFalse( $queue->isEmpty(), "Queue is not empty ($desc)" );
116 $queue->flushCaches();
117 $this->assertEquals( 1, $queue->getSize(), "Queue size is correct ($desc)" );
119 $queue->flushCaches();
121 $this->assertEquals( 1, $queue->getAcquiredCount(), "Active job count ($desc)" );
123 $this->assertEquals( 0, $queue->getAcquiredCount(), "Active job count ($desc)" );
126 $job2 = $queue->pop();
127 $this->assertTrue( $queue->isEmpty(), "Queue is empty ($desc)" );
128 $this->assertEquals( 0, $queue->getSize(), "Queue is empty ($desc)" );
130 $queue->flushCaches();
132 $this->assertEquals( 2, $queue->getAcquiredCount(), "Active job count ($desc)" );
134 $this->assertEquals( 0, $queue->getAcquiredCount(), "Active job count ($desc)" );
137 $queue->ack( $job1 );
139 $queue->flushCaches();
141 $this->assertEquals( 1, $queue->getAcquiredCount(), "Active job count ($desc)" );
143 $this->assertEquals( 0, $queue->getAcquiredCount(), "Active job count ($desc)" );
146 $queue->ack( $job2 );
148 $queue->flushCaches();
149 $this->assertEquals( 0, $queue->getAcquiredCount(), "Active job count ($desc)" );
153 * @dataProvider provider_queueLists
155 function testBasicDeduplication( $queue, $recycles, $desc ) {
156 $queue = $this->$queue;
158 $this->markTestSkipped( $desc );
161 $this->assertTrue( $queue->isEmpty(), "Queue is empty ($desc)" );
163 $queue->flushCaches();
164 $this->assertEquals( 0, $queue->getSize(), "Queue is empty ($desc)" );
165 $this->assertEquals( 0, $queue->getAcquiredCount(), "Queue is empty ($desc)" );
169 array( $this->newDedupedJob(), $this->newDedupedJob(), $this->newDedupedJob() )
171 "Push worked ($desc)" );
173 $this->assertFalse( $queue->isEmpty(), "Queue is not empty ($desc)" );
175 $queue->flushCaches();
176 $this->assertEquals( 1, $queue->getSize(), "Queue size is correct ($desc)" );
177 $this->assertEquals( 0, $queue->getAcquiredCount(), "No jobs active ($desc)" );
181 array( $this->newDedupedJob(), $this->newDedupedJob(), $this->newDedupedJob() )
183 "Push worked ($desc)"
186 $this->assertFalse( $queue->isEmpty(), "Queue is not empty ($desc)" );
188 $queue->flushCaches();
189 $this->assertEquals( 1, $queue->getSize(), "Queue size is correct ($desc)" );
190 $this->assertEquals( 0, $queue->getAcquiredCount(), "No jobs active ($desc)" );
192 $job1 = $queue->pop();
193 $this->assertTrue( $queue->isEmpty(), "Queue is empty ($desc)" );
195 $queue->flushCaches();
196 $this->assertEquals( 0, $queue->getSize(), "Queue is empty ($desc)" );
198 $this->assertEquals( 1, $queue->getAcquiredCount(), "Active job count ($desc)" );
200 $this->assertEquals( 0, $queue->getAcquiredCount(), "Active job count ($desc)" );
203 $queue->ack( $job1 );
205 $queue->flushCaches();
206 $this->assertEquals( 0, $queue->getAcquiredCount(), "Active job count ($desc)" );
210 * @dataProvider provider_queueLists
212 function testRootDeduplication( $queue, $recycles, $desc ) {
213 $queue = $this->$queue;
215 $this->markTestSkipped( $desc );
218 $this->assertTrue( $queue->isEmpty(), "Queue is empty ($desc)" );
220 $queue->flushCaches();
221 $this->assertEquals( 0, $queue->getSize(), "Queue is empty ($desc)" );
222 $this->assertEquals( 0, $queue->getAcquiredCount(), "Queue is empty ($desc)" );
224 $id = wfRandomString( 32 );
225 $root1 = Job
::newRootJobParams( "nulljobspam:$id" ); // task ID/timestamp
226 for ( $i = 0; $i < 5; ++
$i ) {
227 $this->assertTrue( $queue->push( $this->newJob( 0, $root1 ) ), "Push worked ($desc)" );
229 $queue->deduplicateRootJob( $this->newJob( 0, $root1 ) );
230 sleep( 1 ); // roo job timestamp will increase
231 $root2 = Job
::newRootJobParams( "nulljobspam:$id" ); // task ID/timestamp
232 $this->assertNotEquals( $root1['rootJobTimestamp'], $root2['rootJobTimestamp'],
233 "Root job signatures have different timestamps." );
234 for ( $i = 0; $i < 5; ++
$i ) {
235 $this->assertTrue( $queue->push( $this->newJob( 0, $root2 ) ), "Push worked ($desc)" );
237 $queue->deduplicateRootJob( $this->newJob( 0, $root2 ) );
239 $this->assertFalse( $queue->isEmpty(), "Queue is not empty ($desc)" );
241 $queue->flushCaches();
242 $this->assertEquals( 10, $queue->getSize(), "Queue size is correct ($desc)" );
243 $this->assertEquals( 0, $queue->getAcquiredCount(), "No jobs active ($desc)" );
248 $job = $queue->pop();
253 if ( $job instanceof DuplicateJob
) {
258 $this->assertEquals( 10, count( $jobs ), "Correct number of jobs popped ($desc)" );
259 $this->assertEquals( 5, $dupcount, "Correct number of duplicate jobs popped ($desc)" );
263 * @dataProvider provider_fifoQueueLists
265 function testJobOrder( $queue, $recycles, $desc ) {
266 $queue = $this->$queue;
268 $this->markTestSkipped( $desc );
271 $this->assertTrue( $queue->isEmpty(), "Queue is empty ($desc)" );
273 $queue->flushCaches();
274 $this->assertEquals( 0, $queue->getSize(), "Queue is empty ($desc)" );
275 $this->assertEquals( 0, $queue->getAcquiredCount(), "Queue is empty ($desc)" );
277 for ( $i = 0; $i < 10; ++
$i ) {
278 $this->assertTrue( $queue->push( $this->newJob( $i ) ), "Push worked ($desc)" );
281 for ( $i = 0; $i < 10; ++
$i ) {
282 $job = $queue->pop();
283 $this->assertTrue( $job instanceof Job
, "Jobs popped from queue ($desc)" );
284 $params = $job->getParams();
285 $this->assertEquals( $i, $params['i'], "Job popped from queue is FIFO ($desc)" );
289 $this->assertFalse( $queue->pop(), "Queue is not empty ($desc)" );
291 $queue->flushCaches();
292 $this->assertEquals( 0, $queue->getSize(), "Queue is empty ($desc)" );
293 $this->assertEquals( 0, $queue->getAcquiredCount(), "No jobs active ($desc)" );
296 public static function provider_queueLists() {
298 array( 'queueRand', false, 'Random queue without ack()' ),
299 array( 'queueRandTTL', true, 'Random queue with ack()' ),
300 array( 'queueTimestamp', false, 'Time ordered queue without ack()' ),
301 array( 'queueTimestampTTL', true, 'Time ordered queue with ack()' ),
302 array( 'queueFifo', false, 'FIFO ordered queue without ack()' ),
303 array( 'queueFifoTTL', true, 'FIFO ordered queue with ack()' )
307 public static function provider_fifoQueueLists() {
309 array( 'queueFifo', false, 'Ordered queue without ack()' ),
310 array( 'queueFifoTTL', true, 'Ordered queue with ack()' )
314 function newJob( $i = 0, $rootJob = array() ) {
315 return new NullJob( Title
::newMainPage(),
316 array( 'lives' => 0, 'usleep' => 0, 'removeDuplicates' => 0, 'i' => $i ) +
$rootJob );
319 function newDedupedJob( $i = 0, $rootJob = array() ) {
320 return new NullJob( Title
::newMainPage(),
321 array( 'lives' => 0, 'usleep' => 0, 'removeDuplicates' => 1, 'i' => $i ) +
$rootJob );