tests/phpunit/includes/RevisionStorageTest.php

   1 <?php
   2
   3 /**
   4  * Test class for Revision storage.
   5  *
   6  * @group ContentHandler
   7  * @group Database
   8  * ^--- important, causes temporary tables to be used instead of the real database
   9  *
  10  * @group medium
  11  * ^--- important, causes tests not to fail with timeout
  12  */
  13 class RevisionStorageTest extends MediaWikiTestCase {
  14
  15         /**
  16          * @var WikiPage $the_page
  17          */
  18         var $the_page;
  19
  20         function  __construct( $name = null, array $data = array(), $dataName = '' ) {
  21                 parent::__construct( $name, $data, $dataName );
  22
  23                 $this->tablesUsed = array_merge( $this->tablesUsed,
  24                                                  array( 'page',
  25                                                       'revision',
  26                                                       'text',
  27
  28                                                       'recentchanges',
  29                                                       'logging',
  30
  31                                                       'page_props',
  32                                                       'pagelinks',
  33                                                       'categorylinks',
  34                                                       'langlinks',
  35                                                       'externallinks',
  36                                                       'imagelinks',
  37                                                       'templatelinks',
  38                                                       'iwlinks' ) );
  39         }
  40
  41         public function setUp() {
  42                 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
  43
  44                 $wgExtraNamespaces[ 12312 ] = 'Dummy';
  45                 $wgExtraNamespaces[ 12313 ] = 'Dummy_talk';
  46
  47                 $wgNamespaceContentModels[ 12312 ] = 'DUMMY';
  48                 $wgContentHandlers[ 'DUMMY' ] = 'DummyContentHandlerForTesting';
  49
  50                 MWNamespace::getCanonicalNamespaces( true ); # reset namespace cache
  51                 $wgContLang->resetNamespaces(); # reset namespace cache
  52                 if ( !$this->the_page ) {
  53                         $this->the_page = $this->createPage( 'RevisionStorageTest_the_page', "just a dummy page", CONTENT_MODEL_WIKITEXT );
  54                 }
  55         }
  56
  57         public function tearDown() {
  58                 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
  59
  60                 unset( $wgExtraNamespaces[ 12312 ] );
  61                 unset( $wgExtraNamespaces[ 12313 ] );
  62
  63                 unset( $wgNamespaceContentModels[ 12312 ] );
  64                 unset( $wgContentHandlers[ 'DUMMY' ] );
  65
  66                 MWNamespace::getCanonicalNamespaces( true ); # reset namespace cache
  67                 $wgContLang->resetNamespaces(); # reset namespace cache
  68         }
  69
  70         protected function makeRevision( $props = null ) {
  71                 if ( $props === null ) $props = array();
  72
  73                 if ( !isset( $props['content'] ) && !isset( $props['text'] ) ) $props['text'] = 'Lorem Ipsum';
  74                 if ( !isset( $props['comment'] ) ) $props['comment'] = 'just a test';
  75                 if ( !isset( $props['page'] ) ) $props['page'] = $this->the_page->getId();
  76
  77                 $rev = new Revision( $props );
  78
  79                 $dbw = wfgetDB( DB_MASTER );
  80                 $rev->insertOn( $dbw );
  81
  82                 return $rev;
  83         }
  84
  85         protected function createPage( $page, $text, $model = null ) {
  86                 if ( is_string( $page ) ) {
  87                         if ( !preg_match( '/:/', $page ) &&
  88                                 ( $model === null || $model === CONTENT_MODEL_WIKITEXT ) ) {
  89
  90                                 $ns = $this->getDefaultWikitextNS();
  91                                 $page = MWNamespace::getCanonicalName( $ns ) . ':' . $page;
  92                         }
  93
  94                         $page = Title::newFromText( $page );
  95                 }
  96
  97                 if ( $page instanceof Title ) {
  98                         $page = new WikiPage( $page );
  99                 }
 100
 101                 if ( $page->exists() ) {
 102                         $page->doDeleteArticle( "done" );
 103                 }
 104
 105                 $content = ContentHandler::makeContent( $text, $page->getTitle(), $model );
 106                 $page->doEditContent( $content, "testing", EDIT_NEW );
 107
 108                 return $page;
 109         }
 110
 111         protected function assertRevEquals( Revision $orig, Revision $rev = null ) {
 112                 $this->assertNotNull( $rev, 'missing revision' );
 113
 114                 $this->assertEquals( $orig->getId(), $rev->getId() );
 115                 $this->assertEquals( $orig->getPage(), $rev->getPage() );
 116                 $this->assertEquals( $orig->getTimestamp(), $rev->getTimestamp() );
 117                 $this->assertEquals( $orig->getUser(), $rev->getUser() );
 118                 $this->assertEquals( $orig->getContentModel(), $rev->getContentModel() );
 119                 $this->assertEquals( $orig->getContentFormat(), $rev->getContentFormat() );
 120                 $this->assertEquals( $orig->getSha1(), $rev->getSha1() );
 121         }
 122
 123         /**
 124          * @covers Revision::__construct
 125          */
 126         public function testConstructFromRow()
 127         {
 128                 $orig = $this->makeRevision();
 129
 130                 $dbr = wfgetDB( DB_SLAVE );
 131                 $res = $dbr->select( 'revision', '*', array( 'rev_id' => $orig->getId() ) );
 132                 $this->assertTrue( is_object( $res ), 'query failed' );
 133
 134                 $row = $res->fetchObject();
 135                 $res->free();
 136
 137                 $rev = new Revision( $row );
 138
 139                 $this->assertRevEquals( $orig, $rev );
 140         }
 141
 142         /**
 143          * @covers Revision::newFromRow
 144          */
 145         public function testNewFromRow()
 146         {
 147                 $orig = $this->makeRevision();
 148
 149                 $dbr = wfgetDB( DB_SLAVE );
 150                 $res = $dbr->select( 'revision', '*', array( 'rev_id' => $orig->getId() ) );
 151                 $this->assertTrue( is_object( $res ), 'query failed' );
 152
 153                 $row = $res->fetchObject();
 154                 $res->free();
 155
 156                 $rev = Revision::newFromRow( $row );
 157
 158                 $this->assertRevEquals( $orig, $rev );
 159         }
 160
 161
 162         /**
 163          * @covers Revision::newFromArchiveRow
 164          */
 165         public function testNewFromArchiveRow()
 166         {
 167                 $page = $this->createPage( 'RevisionStorageTest_testNewFromArchiveRow', 'Lorem Ipsum', CONTENT_MODEL_WIKITEXT );
 168                 $orig = $page->getRevision();
 169                 $page->doDeleteArticle( 'test Revision::newFromArchiveRow' );
 170
 171                 $dbr = wfgetDB( DB_SLAVE );
 172                 $res = $dbr->select( 'archive', '*', array( 'ar_rev_id' => $orig->getId() ) );
 173                 $this->assertTrue( is_object( $res ), 'query failed' );
 174
 175                 $row = $res->fetchObject();
 176                 $res->free();
 177
 178                 $rev = Revision::newFromArchiveRow( $row );
 179
 180                 $this->assertRevEquals( $orig, $rev );
 181         }
 182
 183         /**
 184          * @covers Revision::newFromId
 185          */
 186         public function testNewFromId()
 187         {
 188                 $orig = $this->makeRevision();
 189
 190                 $rev = Revision::newFromId( $orig->getId() );
 191
 192                 $this->assertRevEquals( $orig, $rev );
 193         }
 194
 195         /**
 196          * @covers Revision::fetchRevision
 197          */
 198         public function testFetchRevision()
 199         {
 200                 $page = $this->createPage( 'RevisionStorageTest_testFetchRevision', 'one', CONTENT_MODEL_WIKITEXT );
 201                 $id1 = $page->getRevision()->getId();
 202
 203                 $page->doEditContent( new WikitextContent( 'two' ), 'second rev' );
 204                 $id2 = $page->getRevision()->getId();
 205
 206                 $res = Revision::fetchRevision( $page->getTitle() );
 207
 208                 #note: order is unspecified
 209                 $rows = array();
 210                 while ( ( $row = $res->fetchObject() ) ) {
 211                         $rows[ $row->rev_id ]= $row;
 212                 }
 213
 214                 $row = $res->fetchObject();
 215                 $this->assertEquals( 1, count($rows), 'expected exactly one revision' );
 216                 $this->assertArrayHasKey( $id2, $rows, 'missing revision with id ' . $id2 );
 217         }
 218
 219         /**
 220          * @covers Revision::selectFields
 221          */
 222         public function testSelectFields()
 223         {
 224                 global $wgContentHandlerUseDB;
 225
 226                 $fields = Revision::selectFields();
 227
 228                 $this->assertTrue( in_array( 'rev_id', $fields ), 'missing rev_id in list of fields');
 229                 $this->assertTrue( in_array( 'rev_page', $fields ), 'missing rev_page in list of fields');
 230                 $this->assertTrue( in_array( 'rev_timestamp', $fields ), 'missing rev_timestamp in list of fields');
 231                 $this->assertTrue( in_array( 'rev_user', $fields ), 'missing rev_user in list of fields');
 232
 233                 if ( $wgContentHandlerUseDB ) {
 234                         $this->assertTrue( in_array( 'rev_content_model', $fields ),
 235                                                                 'missing rev_content_model in list of fields');
 236                         $this->assertTrue( in_array( 'rev_content_format', $fields ),
 237                                                                 'missing rev_content_format in list of fields');
 238                 }
 239         }
 240
 241         /**
 242          * @covers Revision::getPage
 243          */
 244         public function testGetPage()
 245         {
 246                 $page = $this->the_page;
 247
 248                 $orig = $this->makeRevision( array( 'page' => $page->getId() ) );
 249                 $rev = Revision::newFromId( $orig->getId() );
 250
 251                 $this->assertEquals( $page->getId(), $rev->getPage() );
 252         }
 253
 254         /**
 255          * @covers Revision::getText
 256          */
 257         public function testGetText()
 258         {
 259                 $this->hideDeprecated( 'Revision::getText' );
 260
 261                 $orig = $this->makeRevision( array( 'text' => 'hello hello.' ) );
 262                 $rev = Revision::newFromId( $orig->getId() );
 263
 264                 $this->assertEquals( 'hello hello.', $rev->getText() );
 265         }
 266
 267         /**
 268          * @covers Revision::getContent
 269          */
 270         public function testGetContent()
 271         {
 272                 $orig = $this->makeRevision( array( 'text' => 'hello hello.' ) );
 273                 $rev = Revision::newFromId( $orig->getId() );
 274
 275                 $this->assertEquals( 'hello hello.', $rev->getContent()->getNativeData() );
 276         }
 277
 278         /**
 279          * @covers Revision::revText
 280          */
 281         public function testRevText()
 282         {
 283                 $this->hideDeprecated( 'Revision::revText' );
 284                 $orig = $this->makeRevision( array( 'text' => 'hello hello rev.' ) );
 285                 $rev = Revision::newFromId( $orig->getId() );
 286
 287                 $this->assertEquals( 'hello hello rev.', $rev->revText() );
 288         }
 289
 290         /**
 291          * @covers Revision::getRawText
 292          */
 293         public function testGetRawText()
 294         {
 295                 $this->hideDeprecated( 'Revision::getRawText' );
 296
 297                 $orig = $this->makeRevision( array( 'text' => 'hello hello raw.' ) );
 298                 $rev = Revision::newFromId( $orig->getId() );
 299
 300                 $this->assertEquals( 'hello hello raw.', $rev->getRawText() );
 301         }
 302
 303         /**
 304          * @covers Revision::getContentModel
 305          */
 306         public function testGetContentModel()
 307         {
 308                 global $wgContentHandlerUseDB;
 309
 310                 if ( !$wgContentHandlerUseDB ) {
 311                         $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
 312                 }
 313
 314                 $orig = $this->makeRevision( array( 'text' => 'hello hello.',
 315                                                                                         'content_model' => CONTENT_MODEL_JAVASCRIPT ) );
 316                 $rev = Revision::newFromId( $orig->getId() );
 317
 318                 $this->assertEquals( CONTENT_MODEL_JAVASCRIPT, $rev->getContentModel() );
 319         }
 320
 321         /**
 322          * @covers Revision::getContentFormat
 323          */
 324         public function testGetContentFormat()
 325         {
 326                 global $wgContentHandlerUseDB;
 327
 328                 if ( !$wgContentHandlerUseDB ) {
 329                         $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
 330                 }
 331
 332                 $orig = $this->makeRevision( array( 'text' => 'hello hello.',
 333                                                                                         'content_model' => CONTENT_MODEL_JAVASCRIPT,
 334                                                                                         'content_format' => CONTENT_FORMAT_JAVASCRIPT ) );
 335                 $rev = Revision::newFromId( $orig->getId() );
 336
 337                 $this->assertEquals( CONTENT_FORMAT_JAVASCRIPT, $rev->getContentFormat() );
 338         }
 339
 340         /**
 341          * @covers Revision::isCurrent
 342          */
 343         public function testIsCurrent()
 344         {
 345                 $page = $this->createPage( 'RevisionStorageTest_testIsCurrent', 'Lorem Ipsum', CONTENT_MODEL_WIKITEXT );
 346                 $rev1 = $page->getRevision();
 347
 348                 # @todo: find out if this should be true
 349                 # $this->assertTrue( $rev1->isCurrent() );
 350
 351                 $rev1x = Revision::newFromId( $rev1->getId() );
 352                 $this->assertTrue( $rev1x->isCurrent() );
 353
 354                 $page->doEditContent( ContentHandler::makeContent( 'Bla bla', $page->getTitle(), CONTENT_MODEL_WIKITEXT ), 'second rev' );
 355                 $rev2 = $page->getRevision();
 356
 357                 # @todo: find out if this should be true
 358                 # $this->assertTrue( $rev2->isCurrent() );
 359
 360                 $rev1x = Revision::newFromId( $rev1->getId() );
 361                 $this->assertFalse( $rev1x->isCurrent() );
 362
 363                 $rev2x = Revision::newFromId( $rev2->getId() );
 364                 $this->assertTrue( $rev2x->isCurrent() );
 365         }
 366
 367         /**
 368          * @covers Revision::getPrevious
 369          */
 370         public function testGetPrevious()
 371         {
 372                 $page = $this->createPage( 'RevisionStorageTest_testGetPrevious', 'Lorem Ipsum testGetPrevious', CONTENT_MODEL_WIKITEXT );
 373                 $rev1 = $page->getRevision();
 374
 375                 $this->assertNull( $rev1->getPrevious() );
 376
 377                 $page->doEditContent( ContentHandler::makeContent( 'Bla bla', $page->getTitle(), CONTENT_MODEL_WIKITEXT ),
 378                                                                 'second rev testGetPrevious' );
 379                 $rev2 = $page->getRevision();
 380
 381                 $this->assertNotNull( $rev2->getPrevious() );
 382                 $this->assertEquals( $rev1->getId(), $rev2->getPrevious()->getId() );
 383         }
 384
 385         /**
 386          * @covers Revision::getNext
 387          */
 388         public function testGetNext()
 389         {
 390                 $page = $this->createPage( 'RevisionStorageTest_testGetNext', 'Lorem Ipsum testGetNext', CONTENT_MODEL_WIKITEXT );
 391                 $rev1 = $page->getRevision();
 392
 393                 $this->assertNull( $rev1->getNext() );
 394
 395                 $page->doEditContent( ContentHandler::makeContent( 'Bla bla', $page->getTitle(), CONTENT_MODEL_WIKITEXT ),
 396                                                                 'second rev testGetNext' );
 397                 $rev2 = $page->getRevision();
 398
 399                 $this->assertNotNull( $rev1->getNext() );
 400                 $this->assertEquals( $rev2->getId(), $rev1->getNext()->getId() );
 401         }
 402
 403         /**
 404          * @covers Revision::newNullRevision
 405          */
 406         public function testNewNullRevision()
 407         {
 408                 $page = $this->createPage( 'RevisionStorageTest_testNewNullRevision', 'some testing text', CONTENT_MODEL_WIKITEXT );
 409                 $orig = $page->getRevision();
 410
 411                 $dbw = wfGetDB( DB_MASTER );
 412                 $rev = Revision::newNullRevision( $dbw, $page->getId(), 'a null revision', false );
 413
 414                 $this->assertNotEquals( $orig->getId(), $rev->getId(),
 415                                                                 'new null revision shold have a different id from the original revision' );
 416                 $this->assertEquals( $orig->getTextId(), $rev->getTextId(),
 417                                                                 'new null revision shold have the same text id as the original revision' );
 418                 $this->assertEquals( 'some testing text', $rev->getContent()->getNativeData() );
 419         }
 420
 421         public static function provideUserWasLastToEdit() {
 422                 return array(
 423                         array( #0
 424                                 3, true, # actually the last edit
 425                         ),
 426                         array( #1
 427                                 2, true, # not the current edit, but still by this user
 428                         ),
 429                         array( #2
 430                                 1, false, # edit by another user
 431                         ),
 432                         array( #3
 433                                 0, false, # first edit, by this user, but another user edited in the mean time
 434                         ),
 435                 );
 436         }
 437
 438         /**
 439          * @dataProvider provideUserWasLastToEdit
 440          */
 441         public function testUserWasLastToEdit( $sinceIdx, $expectedLast ) {
 442                 $userA = \User::newFromName( "RevisionStorageTest_userA" );
 443                 $userB = \User::newFromName( "RevisionStorageTest_userB" );
 444
 445                 if ( $userA->getId() === 0 ) {
 446                         $userA = \User::createNew( $userA->getName() );
 447                 }
 448
 449                 if ( $userB->getId() === 0 ) {
 450                         $userB = \User::createNew( $userB->getName() );
 451                 }
 452
 453                 $ns = $this->getDefaultWikitextNS();
 454
 455                 $dbw = wfGetDB( DB_MASTER );
 456                 $revisions = array();
 457
 458                 // create revisions -----------------------------
 459                 $page = WikiPage::factory( Title::newFromText(
 460                         'RevisionStorageTest_testUserWasLastToEdit', $ns ) );
 461
 462                 # zero
 463                 $revisions[0] = new Revision( array(
 464                         'page' => $page->getId(),
 465                         'title' => $page->getTitle(), // we need the title to determine the page's default content model
 466                         'timestamp' => '20120101000000',
 467                         'user' => $userA->getId(),
 468                         'text' => 'zero',
 469                         'content_model' => CONTENT_MODEL_WIKITEXT,
 470                         'summary' => 'edit zero'
 471                 ) );
 472                 $revisions[0]->insertOn( $dbw );
 473
 474                 # one
 475                 $revisions[1] = new Revision( array(
 476                         'page' => $page->getId(),
 477                         'title' => $page->getTitle(), // still need the title, because $page->getId() is 0 (there's no entry in the page table)
 478                         'timestamp' => '20120101000100',
 479                         'user' => $userA->getId(),
 480                         'text' => 'one',
 481                         'content_model' => CONTENT_MODEL_WIKITEXT,
 482                         'summary' => 'edit one'
 483                 ) );
 484                 $revisions[1]->insertOn( $dbw );
 485
 486                 # two
 487                 $revisions[2] = new Revision( array(
 488                         'page' => $page->getId(),
 489                         'title' => $page->getTitle(),
 490                         'timestamp' => '20120101000200',
 491                         'user' => $userB->getId(),
 492                         'text' => 'two',
 493                         'content_model' => CONTENT_MODEL_WIKITEXT,
 494                         'summary' => 'edit two'
 495                 ) );
 496                 $revisions[2]->insertOn( $dbw );
 497
 498                 # three
 499                 $revisions[3] = new Revision( array(
 500                         'page' => $page->getId(),
 501                         'title' => $page->getTitle(),
 502                         'timestamp' => '20120101000300',
 503                         'user' => $userA->getId(),
 504                         'text' => 'three',
 505                         'content_model' => CONTENT_MODEL_WIKITEXT,
 506                         'summary' => 'edit three'
 507                 ) );
 508                 $revisions[3]->insertOn( $dbw );
 509
 510                 # four
 511                 $revisions[4] = new Revision( array(
 512                         'page' => $page->getId(),
 513                         'title' => $page->getTitle(),
 514                         'timestamp' => '20120101000200',
 515                         'user' => $userA->getId(),
 516                         'text' => 'zero',
 517                         'content_model' => CONTENT_MODEL_WIKITEXT,
 518                         'summary' => 'edit four'
 519                 ) );
 520                 $revisions[4]->insertOn( $dbw );
 521
 522                 // test it ---------------------------------
 523                 $since = $revisions[ $sinceIdx ]->getTimestamp();
 524
 525                 $wasLast = Revision::userWasLastToEdit( $dbw, $page->getId(), $userA->getId(), $since );
 526
 527                 $this->assertEquals( $expectedLast, $wasLast );
 528         }
 529 }