tests/phpunit/includes/jobqueue/JobTest.php

   1 <?php
   2
   3 /**
   4  * @author Addshore
   5  */
   6 class JobTest extends MediaWikiTestCase {
   7
   8         /**
   9          * @dataProvider provideTestToString
  10          *
  11          * @param Job $job
  12          * @param string $expected
  13          *
  14          * @covers Job::toString
  15          */
  16         public function testToString( $job, $expected ) {
  17                 $this->assertEquals( $expected, $job->toString() );
  18         }
  19
  20         public function provideTestToString() {
  21                 $mockToStringObj = $this->getMockBuilder( stdClass::class )
  22                         ->setMethods( [ '__toString' ] )->getMock();
  23                 $mockToStringObj->expects( $this->any() )
  24                         ->method( '__toString' )
  25                         ->will( $this->returnValue( '{STRING_OBJ_VAL}' ) );
  26
  27                 $requestId = 'requestId=' . WebRequest::getRequestId();
  28
  29                 return [
  30                         [
  31                                 $this->getMockJob( [ 'key' => 'val' ] ),
  32                                 'someCommand Special: key=val ' . $requestId
  33                         ],
  34                         [
  35                                 $this->getMockJob( [ 'key' => [ 'inkey' => 'inval' ] ] ),
  36                                 'someCommand Special: key={"inkey":"inval"} ' . $requestId
  37                         ],
  38                         [
  39                                 $this->getMockJob( [ 'val1' ] ),
  40                                 'someCommand Special: 0=val1 ' . $requestId
  41                         ],
  42                         [
  43                                 $this->getMockJob( [ 'val1', 'val2' ] ),
  44                                 'someCommand Special: 0=val1 1=val2 ' . $requestId
  45                         ],
  46                         [
  47                                 $this->getMockJob( [ new stdClass() ] ),
  48                                 'someCommand Special: 0=object(stdClass) ' . $requestId
  49                         ],
  50                         [
  51                                 $this->getMockJob( [ $mockToStringObj ] ),
  52                                 'someCommand Special: 0={STRING_OBJ_VAL} ' . $requestId
  53                         ],
  54                         [
  55                                 $this->getMockJob( [
  56                                         "pages" => [
  57                                                 "932737" => [
  58                                                         0,
  59                                                         "Robert_James_Waller"
  60                                                 ]
  61                                         ],
  62                                         "rootJobSignature" => "45868e99bba89064e4483743ebb9b682ef95c1a7",
  63                                         "rootJobTimestamp" => "20160309110158",
  64                                         "masterPos" => [
  65                                                 "file" => "db1023-bin.001288",
  66                                                 "pos" => "308257743",
  67                                                 "asOfTime" => 1457521464.3814
  68                                         ],
  69                                         "triggeredRecursive" => true
  70                                 ] ),
  71                                 'someCommand Special: pages={"932737":[0,"Robert_James_Waller"]} ' .
  72                                 'rootJobSignature=45868e99bba89064e4483743ebb9b682ef95c1a7 ' .
  73                                 'rootJobTimestamp=20160309110158 masterPos=' .
  74                                 '{"file":"db1023-bin.001288","pos":"308257743","asOfTime":' .
  75                                 // Embed dynamically because TestSetup sets serialize_precision=17
  76                                 // which, in PHP 7.1 and 7.2, produces 1457521464.3814001 instead
  77                                 json_encode( 1457521464.3814 ) . '} triggeredRecursive=1 ' .
  78                                 $requestId
  79                         ],
  80                 ];
  81         }
  82
  83         public function getMockJob( $params ) {
  84                 $mock = $this->getMockForAbstractClass(
  85                         Job::class,
  86                         [ 'someCommand', $params ],
  87                         'SomeJob'
  88                 );
  89
  90                 return $mock;
  91         }
  92
  93         /**
  94          * @covers Job::__construct()
  95          */
  96         public function testInvalidParamsArgument() {
  97                 $params = false;
  98                 $this->setExpectedException( InvalidArgumentException::class, '$params must be an array' );
  99                 $job = $this->getMockJob( $params );
 100         }
 101
 102         /**
 103          * @dataProvider provideTestJobFactory
 104          *
 105          * @param mixed $handler
 106          *
 107          * @covers Job::factory
 108          */
 109         public function testJobFactory( $handler ) {
 110                 $this->mergeMwGlobalArrayValue( 'wgJobClasses', [ 'testdummy' => $handler ] );
 111
 112                 $job = Job::factory( 'testdummy', Title::newMainPage(), [] );
 113                 $this->assertInstanceOf( NullJob::class, $job );
 114
 115                 $job2 = Job::factory( 'testdummy', Title::newMainPage(), [] );
 116                 $this->assertInstanceOf( NullJob::class, $job2 );
 117                 $this->assertNotSame( $job, $job2, 'should not reuse instance' );
 118         }
 119
 120         public function provideTestJobFactory() {
 121                 return [
 122                         'class name' => [ 'NullJob' ],
 123                         'closure' => [ function ( Title $title, array $params ) {
 124                                 return Job::factory( 'null', $title, $params );
 125                         } ],
 126                         'function' => [ [ $this, 'newNullJob' ] ],
 127                         'static function' => [ self::class . '::staticNullJob' ]
 128                 ];
 129         }
 130
 131         public function newNullJob( Title $title, array $params ) {
 132                 return Job::factory( 'null', $title, $params );
 133         }
 134
 135         public static function staticNullJob( Title $title, array $params ) {
 136                 return Job::factory( 'null', $title, $params );
 137         }
 138
 139         /**
 140          * @covers Job::factory
 141          * @covers Job::__construct()
 142          */
 143         public function testJobSignatureGeneric() {
 144                 $testPage = Title::makeTitle( NS_PROJECT, 'x' );
 145                 $blankTitle = Title::makeTitle( NS_SPECIAL, '' );
 146                 $params = [ 'z' => 1, 'lives' => 1, 'usleep' => 0 ];
 147                 $paramsWithTitle = $params + [ 'namespace' => NS_PROJECT, 'title' => 'x' ];
 148
 149                 $job = new NullJob( [ 'namespace' => NS_PROJECT, 'title' => 'x' ] + $params );
 150                 $this->assertEquals( $testPage->getPrefixedText(), $job->getTitle()->getPrefixedText() );
 151                 $this->assertJobParamsMatch( $job, $paramsWithTitle );
 152
 153                 $job = Job::factory( 'null', $testPage, $params );
 154                 $this->assertEquals( $blankTitle->getPrefixedText(), $job->getTitle()->getPrefixedText() );
 155                 $this->assertJobParamsMatch( $job, $params );
 156
 157                 $job = Job::factory( 'null', $paramsWithTitle );
 158                 $this->assertEquals( $testPage->getPrefixedText(), $job->getTitle()->getPrefixedText() );
 159                 $this->assertJobParamsMatch( $job, $paramsWithTitle );
 160
 161                 $job = Job::factory( 'null', $params );
 162                 $this->assertTrue( $blankTitle->equals( $job->getTitle() ) );
 163                 $this->assertJobParamsMatch( $job, $params );
 164         }
 165
 166         /**
 167          * @covers Job::factory
 168          * @covers Job::__construct()
 169          */
 170         public function testJobSignatureTitleBased() {
 171                 $testPage = Title::makeTitle( NS_PROJECT, 'x' );
 172                 $blankPage = Title::makeTitle( NS_SPECIAL, 'Blankpage' );
 173                 $params = [ 'z' => 1, 'causeAction' => 'unknown', 'causeAgent' => 'unknown' ];
 174                 $paramsWithTitle = $params + [ 'namespace' => NS_PROJECT, 'title' => 'x' ];
 175                 $paramsWithBlankpage = $params + [ 'namespace' => NS_SPECIAL, 'title' => 'Blankpage' ];
 176
 177                 $job = new RefreshLinksJob( $testPage, $params );
 178                 $this->assertEquals( $testPage->getPrefixedText(), $job->getTitle()->getPrefixedText() );
 179                 $this->assertTrue( $testPage->equals( $job->getTitle() ) );
 180                 $this->assertJobParamsMatch( $job, $paramsWithTitle );
 181
 182                 $job = Job::factory( 'refreshLinks', $testPage, $params );
 183                 $this->assertEquals( $testPage->getPrefixedText(), $job->getTitle()->getPrefixedText() );
 184                 $this->assertJobParamsMatch( $job, $paramsWithTitle );
 185
 186                 $job = Job::factory( 'refreshLinks', $paramsWithTitle );
 187                 $this->assertEquals( $testPage->getPrefixedText(), $job->getTitle()->getPrefixedText() );
 188                 $this->assertJobParamsMatch( $job, $paramsWithTitle );
 189
 190                 $job = Job::factory( 'refreshLinks', $params );
 191                 $this->assertTrue( $blankPage->equals( $job->getTitle() ) );
 192                 $this->assertJobParamsMatch( $job, $paramsWithBlankpage );
 193         }
 194
 195         /**
 196          * @covers Job::factory
 197          * @covers Job::__construct()
 198          */
 199         public function testJobSignatureTitleBasedIncomplete() {
 200                 $testPage = Title::makeTitle( NS_PROJECT, 'x' );
 201                 $blankTitle = Title::makeTitle( NS_SPECIAL, '' );
 202                 $params = [ 'z' => 1, 'causeAction' => 'unknown', 'causeAgent' => 'unknown' ];
 203
 204                 $job = new RefreshLinksJob( $testPage, $params + [ 'namespace' => 0 ] );
 205                 $this->assertEquals( $blankTitle->getPrefixedText(), $job->getTitle()->getPrefixedText() );
 206                 $this->assertJobParamsMatch( $job, $params + [ 'namespace' => 0 ] );
 207
 208                 $job = new RefreshLinksJob( $testPage, $params + [ 'title' => 'x' ] );
 209                 $this->assertEquals( $blankTitle->getPrefixedText(), $job->getTitle()->getPrefixedText() );
 210                 $this->assertJobParamsMatch( $job, $params + [ 'title' => 'x' ] );
 211         }
 212
 213         private function assertJobParamsMatch( IJobSpecification $job, array $params ) {
 214                 $actual = $job->getParams();
 215                 unset( $actual['requestId'] );
 216
 217                 $this->assertEquals( $actual, $params );
 218         }
 219 }