tests/phpunit/includes/RevisionStorageTest.php

   1 <?php
   2
   3 /**
   4  * Test class for Revision storage.
   5  *
   6  * @group Database
   7  * ^--- important, causes temporary tables to be used instead of the real database
   8  *
   9  * @group medium
  10  * ^--- important, causes tests not to fail with timeout
  11  */
  12 class RevisionStorageTest extends MediaWikiTestCase {
  13
  14         var $the_page;
  15
  16         function  __construct( $name = null, array $data = array(), $dataName = '' ) {
  17                 parent::__construct( $name, $data, $dataName );
  18
  19                 $this->tablesUsed = array_merge( $this->tablesUsed,
  20                                                  array( 'page',
  21                                                       'revision',
  22                                                       'text',
  23
  24                                                       'recentchanges',
  25                                                       'logging',
  26
  27                                                       'page_props',
  28                                                       'pagelinks',
  29                                                       'categorylinks',
  30                                                       'langlinks',
  31                                                       'externallinks',
  32                                                       'imagelinks',
  33                                                       'templatelinks',
  34                                                       'iwlinks' ) );
  35         }
  36
  37         public function setUp() {
  38                 if ( !$this->the_page ) {
  39                         $this->the_page = $this->createPage( 'RevisionStorageTest_the_page', "just a dummy page" );
  40                 }
  41         }
  42
  43         protected function makeRevision( $props = null ) {
  44                 if ( $props === null ) $props = array();
  45
  46                 if ( !isset( $props['content'] ) && !isset( $props['text'] ) ) $props['text'] = 'Lorem Ipsum';
  47                 if ( !isset( $props['comment'] ) ) $props['comment'] = 'just a test';
  48                 if ( !isset( $props['page'] ) ) $props['page'] = $this->the_page->getId();
  49
  50                 $rev = new Revision( $props );
  51
  52                 $dbw = wfgetDB( DB_MASTER );
  53                 $rev->insertOn( $dbw );
  54
  55                 return $rev;
  56         }
  57
  58         protected function createPage( $page, $text, $model = null ) {
  59                 if ( is_string( $page ) ) $page = Title::newFromText( $page );
  60                 if ( $page instanceof Title ) $page = new WikiPage( $page );
  61
  62                 if ( $page->exists() ) {
  63                         $page->doDeleteArticle( "done" );
  64                 }
  65
  66                 $page->doEdit( $text, "testing", EDIT_NEW );
  67
  68                 return $page;
  69         }
  70
  71         protected function assertRevEquals( Revision $orig, Revision $rev = null ) {
  72                 $this->assertNotNull( $rev, 'missing revision' );
  73
  74                 $this->assertEquals( $orig->getId(), $rev->getId() );
  75                 $this->assertEquals( $orig->getPage(), $rev->getPage() );
  76                 $this->assertEquals( $orig->getTimestamp(), $rev->getTimestamp() );
  77                 $this->assertEquals( $orig->getUser(), $rev->getUser() );
  78                 $this->assertEquals( $orig->getSha1(), $rev->getSha1() );
  79         }
  80
  81         /**
  82          * @covers Revision::__construct
  83          */
  84         public function testConstructFromRow()
  85         {
  86                 $orig = $this->makeRevision();
  87
  88                 $dbr = wfgetDB( DB_SLAVE );
  89                 $res = $dbr->select( 'revision', '*', array( 'rev_id' => $orig->getId() ) );
  90                 $this->assertTrue( is_object( $res ), 'query failed' );
  91
  92                 $row = $res->fetchObject();
  93                 $res->free();
  94
  95                 $rev = new Revision( $row );
  96
  97                 $this->assertRevEquals( $orig, $rev );
  98         }
  99
 100         /**
 101          * @covers Revision::newFromRow
 102          */
 103         public function testNewFromRow()
 104         {
 105                 $orig = $this->makeRevision();
 106
 107                 $dbr = wfgetDB( DB_SLAVE );
 108                 $res = $dbr->select( 'revision', '*', array( 'rev_id' => $orig->getId() ) );
 109                 $this->assertTrue( is_object( $res ), 'query failed' );
 110
 111                 $row = $res->fetchObject();
 112                 $res->free();
 113
 114                 $rev = Revision::newFromRow( $row );
 115
 116                 $this->assertRevEquals( $orig, $rev );
 117         }
 118
 119
 120         /**
 121          * @covers Revision::newFromArchiveRow
 122          */
 123         public function testNewFromArchiveRow()
 124         {
 125                 $page = $this->createPage( 'RevisionStorageTest_testNewFromArchiveRow', 'Lorem Ipsum' );
 126                 $orig = $page->getRevision();
 127                 $page->doDeleteArticle( 'test Revision::newFromArchiveRow' );
 128
 129                 $dbr = wfgetDB( DB_SLAVE );
 130                 $res = $dbr->select( 'archive', '*', array( 'ar_rev_id' => $orig->getId() ) );
 131                 $this->assertTrue( is_object( $res ), 'query failed' );
 132
 133                 $row = $res->fetchObject();
 134                 $res->free();
 135
 136                 $rev = Revision::newFromArchiveRow( $row );
 137
 138                 $this->assertRevEquals( $orig, $rev );
 139         }
 140
 141         /**
 142          * @covers Revision::newFromId
 143          */
 144         public function testNewFromId()
 145         {
 146                 $orig = $this->makeRevision();
 147
 148                 $rev = Revision::newFromId( $orig->getId() );
 149
 150                 $this->assertRevEquals( $orig, $rev );
 151         }
 152
 153         /**
 154          * @covers Revision::fetchRevision
 155          */
 156         public function testFetchRevision()
 157         {
 158                 $page = $this->createPage( 'RevisionStorageTest_testFetchRevision', 'one' );
 159                 $id1 = $page->getRevision()->getId();
 160
 161                 $page->doEdit( 'two', 'second rev' );
 162                 $id2 = $page->getRevision()->getId();
 163
 164                 $res = Revision::fetchRevision( $page->getTitle() );
 165
 166                 #note: order is unspecified
 167                 $rows = array();
 168                 while ( ( $row = $res->fetchObject() ) ) {
 169                         $rows[ $row->rev_id ]= $row;
 170                 }
 171
 172                 $row = $res->fetchObject();
 173                 $this->assertEquals( 1, count($rows), 'expected exactly one revision' );
 174                 $this->assertArrayHasKey( $id2, $rows, 'missing revision with id ' . $id2 );
 175         }
 176
 177         /**
 178          * @covers Revision::selectFields
 179          */
 180         public function testSelectFields()
 181         {
 182                 $fields = Revision::selectFields();
 183
 184                 $this->assertTrue( in_array( 'rev_id', $fields ), 'missing rev_id in list of fields');
 185                 $this->assertTrue( in_array( 'rev_page', $fields ), 'missing rev_page in list of fields');
 186                 $this->assertTrue( in_array( 'rev_timestamp', $fields ), 'missing rev_timestamp in list of fields');
 187                 $this->assertTrue( in_array( 'rev_user', $fields ), 'missing rev_user in list of fields');
 188         }
 189
 190         /**
 191          * @covers Revision::getPage
 192          */
 193         public function testGetPage()
 194         {
 195                 $page = $this->the_page;
 196
 197                 $orig = $this->makeRevision( array( 'page' => $page->getId() ) );
 198                 $rev = Revision::newFromId( $orig->getId() );
 199
 200                 $this->assertEquals( $page->getId(), $rev->getPage() );
 201         }
 202
 203         /**
 204          * @covers Revision::getText
 205          */
 206         public function testGetText()
 207         {
 208                 $orig = $this->makeRevision( array( 'text' => 'hello hello.' ) );
 209                 $rev = Revision::newFromId( $orig->getId() );
 210
 211                 $this->assertEquals( 'hello hello.', $rev->getText() );
 212         }
 213
 214         /**
 215          * @covers Revision::revText
 216          */
 217         public function testRevText()
 218         {
 219                 $this->hideDeprecated( 'Revision::revText' );
 220                 $orig = $this->makeRevision( array( 'text' => 'hello hello rev.' ) );
 221                 $rev = Revision::newFromId( $orig->getId() );
 222
 223                 $this->assertEquals( 'hello hello rev.', $rev->revText() );
 224         }
 225
 226         /**
 227          * @covers Revision::getRawText
 228          */
 229         public function testGetRawText()
 230         {
 231                 $orig = $this->makeRevision( array( 'text' => 'hello hello raw.' ) );
 232                 $rev = Revision::newFromId( $orig->getId() );
 233
 234                 $this->assertEquals( 'hello hello raw.', $rev->getRawText() );
 235         }
 236         /**
 237          * @covers Revision::isCurrent
 238          */
 239         public function testIsCurrent()
 240         {
 241                 $page = $this->createPage( 'RevisionStorageTest_testIsCurrent', 'Lorem Ipsum' );
 242                 $rev1 = $page->getRevision();
 243
 244                 # @todo: find out if this should be true
 245                 # $this->assertTrue( $rev1->isCurrent() );
 246
 247                 $rev1x = Revision::newFromId( $rev1->getId() );
 248                 $this->assertTrue( $rev1x->isCurrent() );
 249
 250                 $page->doEdit( 'Bla bla', 'second rev' );
 251                 $rev2 = $page->getRevision();
 252
 253                 # @todo: find out if this should be true
 254                 # $this->assertTrue( $rev2->isCurrent() );
 255
 256                 $rev1x = Revision::newFromId( $rev1->getId() );
 257                 $this->assertFalse( $rev1x->isCurrent() );
 258
 259                 $rev2x = Revision::newFromId( $rev2->getId() );
 260                 $this->assertTrue( $rev2x->isCurrent() );
 261         }
 262
 263         /**
 264          * @covers Revision::getPrevious
 265          */
 266         public function testGetPrevious()
 267         {
 268                 $page = $this->createPage( 'RevisionStorageTest_testGetPrevious', 'Lorem Ipsum testGetPrevious' );
 269                 $rev1 = $page->getRevision();
 270
 271                 $this->assertNull( $rev1->getPrevious() );
 272
 273                 $page->doEdit( 'Bla bla', 'second rev testGetPrevious' );
 274                 $rev2 = $page->getRevision();
 275
 276                 $this->assertNotNull( $rev2->getPrevious() );
 277                 $this->assertEquals( $rev1->getId(), $rev2->getPrevious()->getId() );
 278         }
 279
 280         /**
 281          * @covers Revision::getNext
 282          */
 283         public function testGetNext()
 284         {
 285                 $page = $this->createPage( 'RevisionStorageTest_testGetNext', 'Lorem Ipsum testGetNext' );
 286                 $rev1 = $page->getRevision();
 287
 288                 $this->assertNull( $rev1->getNext() );
 289
 290                 $page->doEdit( 'Bla bla', 'second rev testGetNext' );
 291                 $rev2 = $page->getRevision();
 292
 293                 $this->assertNotNull( $rev1->getNext() );
 294                 $this->assertEquals( $rev2->getId(), $rev1->getNext()->getId() );
 295         }
 296
 297         /**
 298          * @covers Revision::newNullRevision
 299          */
 300         public function testNewNullRevision()
 301         {
 302                 $page = $this->createPage( 'RevisionStorageTest_testNewNullRevision', 'some testing text' );
 303                 $orig = $page->getRevision();
 304
 305                 $dbw = wfGetDB( DB_MASTER );
 306                 $rev = Revision::newNullRevision( $dbw, $page->getId(), 'a null revision', false );
 307
 308                 $this->assertNotEquals( $orig->getId(), $rev->getId(), 'new null revision shold have a different id from the original revision' );
 309                 $this->assertEquals( $orig->getTextId(), $rev->getTextId(), 'new null revision shold have the same text id as the original revision' );
 310                 $this->assertEquals( 'some testing text', $rev->getText() );
 311         }
 312
 313         public function dataUserWasLastToEdit() {
 314                 return array(
 315                         array( #0
 316                                 3, true, # actually the last edit
 317                         ),
 318                         array( #1
 319                                 2, true, # not the current edit, but still by this user
 320                         ),
 321                         array( #2
 322                                 1, false, # edit by another user
 323                         ),
 324                         array( #3
 325                                 0, false, # first edit, by this user, but another user edited in the mean time
 326                         ),
 327                 );
 328         }
 329
 330         /**
 331          * @dataProvider dataUserWasLastToEdit
 332          */
 333         public function testUserWasLastToEdit( $sinceIdx, $expectedLast ) {
 334                 $userA = \User::newFromName( "RevisionStorageTest_userA" );
 335                 $userB = \User::newFromName( "RevisionStorageTest_userB" );
 336
 337                 if ( $userA->getId() === 0 ) {
 338                         $userA = \User::createNew( $userA->getName() );
 339                 }
 340
 341                 if ( $userB->getId() === 0 ) {
 342                         $userB = \User::createNew( $userB->getName() );
 343                 }
 344
 345                 $dbw = wfGetDB( DB_MASTER );
 346                 $revisions = array();
 347
 348                 // create revisions -----------------------------
 349                 $page = WikiPage::factory( Title::newFromText( 'RevisionStorageTest_testUserWasLastToEdit' ) );
 350
 351                 # zero
 352                 $revisions[0] = new Revision( array(
 353                         'page' => $page->getId(),
 354                         'timestamp' => '20120101000000',
 355                         'user' => $userA->getId(),
 356                         'text' => 'zero',
 357                         'summary' => 'edit zero'
 358                 ) );
 359                 $revisions[0]->insertOn( $dbw );
 360
 361                 # one
 362                 $revisions[1] = new Revision( array(
 363                         'page' => $page->getId(),
 364                         'timestamp' => '20120101000100',
 365                         'user' => $userA->getId(),
 366                         'text' => 'one',
 367                         'summary' => 'edit one'
 368                 ) );
 369                 $revisions[1]->insertOn( $dbw );
 370
 371                 # two
 372                 $revisions[2] = new Revision( array(
 373                         'page' => $page->getId(),
 374                         'timestamp' => '20120101000200',
 375                         'user' => $userB->getId(),
 376                         'text' => 'two',
 377                         'summary' => 'edit two'
 378                 ) );
 379                 $revisions[2]->insertOn( $dbw );
 380
 381                 # three
 382                 $revisions[3] = new Revision( array(
 383                         'page' => $page->getId(),
 384                         'timestamp' => '20120101000300',
 385                         'user' => $userA->getId(),
 386                         'text' => 'three',
 387                         'summary' => 'edit three'
 388                 ) );
 389                 $revisions[3]->insertOn( $dbw );
 390
 391                 # four
 392                 $revisions[4] = new Revision( array(
 393                         'page' => $page->getId(),
 394                         'timestamp' => '20120101000200',
 395                         'user' => $userA->getId(),
 396                         'text' => 'zero',
 397                         'summary' => 'edit four'
 398                 ) );
 399                 $revisions[4]->insertOn( $dbw );
 400
 401                 // test it ---------------------------------
 402                 $since = $revisions[ $sinceIdx ]->getTimestamp();
 403
 404                 $wasLast = Revision::userWasLastToEdit( $dbw, $page->getId(), $userA->getId(), $since );
 405
 406                 $this->assertEquals( $expectedLast, $wasLast );
 407         }
 408 }