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