4 * Test class for Revision storage.
6 * @group ContentHandler
8 * ^--- important, causes temporary tables to be used instead of the real database
11 * ^--- important, causes tests not to fail with timeout
13 class RevisionStorageTest
extends MediaWikiTestCase
{
16 * @var WikiPage $the_page
20 function __construct( $name = null, array $data = array(), $dataName = '' ) {
21 parent
::__construct( $name, $data, $dataName );
23 $this->tablesUsed
= array_merge( $this->tablesUsed
,
41 public function setUp() {
42 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
44 $wgExtraNamespaces[ 12312 ] = 'Dummy';
45 $wgExtraNamespaces[ 12313 ] = 'Dummy_talk';
47 $wgNamespaceContentModels[ 12312 ] = 'DUMMY';
48 $wgContentHandlers[ 'DUMMY' ] = 'DummyContentHandlerForTesting';
50 MWNamespace
::getCanonicalNamespaces( true ); # reset namespace cache
51 $wgContLang->resetNamespaces(); # reset namespace cache
53 if ( !$this->the_page
) {
54 $this->the_page
= $this->createPage( 'RevisionStorageTest_the_page', "just a dummy page" );
58 public function tearDown() {
59 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
61 unset( $wgExtraNamespaces[ 12312 ] );
62 unset( $wgExtraNamespaces[ 12313 ] );
64 unset( $wgNamespaceContentModels[ 12312 ] );
65 unset( $wgContentHandlers[ 'DUMMY' ] );
67 MWNamespace
::getCanonicalNamespaces( true ); # reset namespace cache
68 $wgContLang->resetNamespaces(); # reset namespace cache
71 protected function makeRevision( $props = null ) {
72 if ( $props === null ) $props = array();
74 if ( !isset( $props['content'] ) && !isset( $props['text'] ) ) $props['text'] = 'Lorem Ipsum';
75 if ( !isset( $props['comment'] ) ) $props['comment'] = 'just a test';
76 if ( !isset( $props['page'] ) ) $props['page'] = $this->the_page
->getId();
78 $rev = new Revision( $props );
80 $dbw = wfgetDB( DB_MASTER
);
81 $rev->insertOn( $dbw );
86 protected function createPage( $page, $text, $model = null ) {
87 if ( is_string( $page ) ) $page = Title
::newFromText( $page );
88 if ( $page instanceof Title
) $page = new WikiPage( $page );
90 if ( $page->exists() ) {
91 $page->doDeleteArticle( "done" );
94 $content = ContentHandler
::makeContent( $text, $page->getTitle(), $model );
95 $page->doEditContent( $content, "testing", EDIT_NEW
);
100 protected function assertRevEquals( Revision
$orig, Revision
$rev = null ) {
101 $this->assertNotNull( $rev, 'missing revision' );
103 $this->assertEquals( $orig->getId(), $rev->getId() );
104 $this->assertEquals( $orig->getPage(), $rev->getPage() );
105 $this->assertEquals( $orig->getTimestamp(), $rev->getTimestamp() );
106 $this->assertEquals( $orig->getUser(), $rev->getUser() );
107 $this->assertEquals( $orig->getContentModel(), $rev->getContentModel() );
108 $this->assertEquals( $orig->getContentFormat(), $rev->getContentFormat() );
109 $this->assertEquals( $orig->getSha1(), $rev->getSha1() );
113 * @covers Revision::__construct
115 public function testConstructFromRow()
117 $orig = $this->makeRevision();
119 $dbr = wfgetDB( DB_SLAVE
);
120 $res = $dbr->select( 'revision', '*', array( 'rev_id' => $orig->getId() ) );
121 $this->assertTrue( is_object( $res ), 'query failed' );
123 $row = $res->fetchObject();
126 $rev = new Revision( $row );
128 $this->assertRevEquals( $orig, $rev );
132 * @covers Revision::newFromRow
134 public function testNewFromRow()
136 $orig = $this->makeRevision();
138 $dbr = wfgetDB( DB_SLAVE
);
139 $res = $dbr->select( 'revision', '*', array( 'rev_id' => $orig->getId() ) );
140 $this->assertTrue( is_object( $res ), 'query failed' );
142 $row = $res->fetchObject();
145 $rev = Revision
::newFromRow( $row );
147 $this->assertRevEquals( $orig, $rev );
152 * @covers Revision::newFromArchiveRow
154 public function testNewFromArchiveRow()
156 $page = $this->createPage( 'RevisionStorageTest_testNewFromArchiveRow', 'Lorem Ipsum' );
157 $orig = $page->getRevision();
158 $page->doDeleteArticle( 'test Revision::newFromArchiveRow' );
160 $dbr = wfgetDB( DB_SLAVE
);
161 $res = $dbr->select( 'archive', '*', array( 'ar_rev_id' => $orig->getId() ) );
162 $this->assertTrue( is_object( $res ), 'query failed' );
164 $row = $res->fetchObject();
167 $rev = Revision
::newFromArchiveRow( $row );
169 $this->assertRevEquals( $orig, $rev );
173 * @covers Revision::newFromId
175 public function testNewFromId()
177 $orig = $this->makeRevision();
179 $rev = Revision
::newFromId( $orig->getId() );
181 $this->assertRevEquals( $orig, $rev );
185 * @covers Revision::fetchRevision
187 public function testFetchRevision()
189 $page = $this->createPage( 'RevisionStorageTest_testFetchRevision', 'one' );
190 $id1 = $page->getRevision()->getId();
192 $page->doEditContent( new WikitextContent( 'two' ), 'second rev' );
193 $id2 = $page->getRevision()->getId();
195 $res = Revision
::fetchRevision( $page->getTitle() );
197 #note: order is unspecified
199 while ( ( $row = $res->fetchObject() ) ) {
200 $rows[ $row->rev_id
]= $row;
203 $row = $res->fetchObject();
204 $this->assertEquals( 1, count($rows), 'expected exactly one revision' );
205 $this->assertArrayHasKey( $id2, $rows, 'missing revision with id ' . $id2 );
209 * @covers Revision::selectFields
211 public function testSelectFields()
213 global $wgContentHandlerUseDB;
215 $fields = Revision
::selectFields();
217 $this->assertTrue( in_array( 'rev_id', $fields ), 'missing rev_id in list of fields');
218 $this->assertTrue( in_array( 'rev_page', $fields ), 'missing rev_page in list of fields');
219 $this->assertTrue( in_array( 'rev_timestamp', $fields ), 'missing rev_timestamp in list of fields');
220 $this->assertTrue( in_array( 'rev_user', $fields ), 'missing rev_user in list of fields');
222 if ( $wgContentHandlerUseDB ) {
223 $this->assertTrue( in_array( 'rev_content_model', $fields ),
224 'missing rev_content_model in list of fields');
225 $this->assertTrue( in_array( 'rev_content_format', $fields ),
226 'missing rev_content_format in list of fields');
228 $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
233 * @covers Revision::getPage
235 public function testGetPage()
237 $page = $this->the_page
;
239 $orig = $this->makeRevision( array( 'page' => $page->getId() ) );
240 $rev = Revision
::newFromId( $orig->getId() );
242 $this->assertEquals( $page->getId(), $rev->getPage() );
246 * @covers Revision::getText
248 public function testGetText()
250 $this->hideDeprecated( 'Revision::getText' );
252 $orig = $this->makeRevision( array( 'text' => 'hello hello.' ) );
253 $rev = Revision
::newFromId( $orig->getId() );
255 $this->assertEquals( 'hello hello.', $rev->getText() );
259 * @covers Revision::getContent
261 public function testGetContent()
263 $orig = $this->makeRevision( array( 'text' => 'hello hello.' ) );
264 $rev = Revision
::newFromId( $orig->getId() );
266 $this->assertEquals( 'hello hello.', $rev->getContent()->getNativeData() );
270 * @covers Revision::revText
272 public function testRevText()
274 $this->hideDeprecated( 'Revision::revText' );
275 $orig = $this->makeRevision( array( 'text' => 'hello hello rev.' ) );
276 $rev = Revision
::newFromId( $orig->getId() );
278 $this->assertEquals( 'hello hello rev.', $rev->revText() );
282 * @covers Revision::getRawText
284 public function testGetRawText()
286 $this->hideDeprecated( 'Revision::getRawText' );
288 $orig = $this->makeRevision( array( 'text' => 'hello hello raw.' ) );
289 $rev = Revision
::newFromId( $orig->getId() );
291 $this->assertEquals( 'hello hello raw.', $rev->getRawText() );
295 * @covers Revision::getContentModel
297 public function testGetContentModel()
299 global $wgContentHandlerUseDB;
301 if ( !$wgContentHandlerUseDB ) {
302 $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
305 $orig = $this->makeRevision( array( 'text' => 'hello hello.',
306 'content_model' => CONTENT_MODEL_JAVASCRIPT
) );
307 $rev = Revision
::newFromId( $orig->getId() );
309 $this->assertEquals( CONTENT_MODEL_JAVASCRIPT
, $rev->getContentModel() );
313 * @covers Revision::getContentFormat
315 public function testGetContentFormat()
317 global $wgContentHandlerUseDB;
319 if ( !$wgContentHandlerUseDB ) {
320 $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
323 $orig = $this->makeRevision( array( 'text' => 'hello hello.',
324 'content_model' => CONTENT_MODEL_JAVASCRIPT
,
325 'content_format' => CONTENT_FORMAT_JAVASCRIPT
) );
326 $rev = Revision
::newFromId( $orig->getId() );
328 $this->assertEquals( CONTENT_FORMAT_JAVASCRIPT
, $rev->getContentFormat() );
332 * @covers Revision::isCurrent
334 public function testIsCurrent()
336 $page = $this->createPage( 'RevisionStorageTest_testIsCurrent', 'Lorem Ipsum' );
337 $rev1 = $page->getRevision();
339 # @todo: find out if this should be true
340 # $this->assertTrue( $rev1->isCurrent() );
342 $rev1x = Revision
::newFromId( $rev1->getId() );
343 $this->assertTrue( $rev1x->isCurrent() );
345 $page->doEditContent( ContentHandler
::makeContent( 'Bla bla', $page->getTitle() ), 'second rev' );
346 $rev2 = $page->getRevision();
348 # @todo: find out if this should be true
349 # $this->assertTrue( $rev2->isCurrent() );
351 $rev1x = Revision
::newFromId( $rev1->getId() );
352 $this->assertFalse( $rev1x->isCurrent() );
354 $rev2x = Revision
::newFromId( $rev2->getId() );
355 $this->assertTrue( $rev2x->isCurrent() );
359 * @covers Revision::getPrevious
361 public function testGetPrevious()
363 $page = $this->createPage( 'RevisionStorageTest_testGetPrevious', 'Lorem Ipsum testGetPrevious' );
364 $rev1 = $page->getRevision();
366 $this->assertNull( $rev1->getPrevious() );
368 $page->doEditContent( ContentHandler
::makeContent( 'Bla bla', $page->getTitle() ),
369 'second rev testGetPrevious' );
370 $rev2 = $page->getRevision();
372 $this->assertNotNull( $rev2->getPrevious() );
373 $this->assertEquals( $rev1->getId(), $rev2->getPrevious()->getId() );
377 * @covers Revision::getNext
379 public function testGetNext()
381 $page = $this->createPage( 'RevisionStorageTest_testGetNext', 'Lorem Ipsum testGetNext' );
382 $rev1 = $page->getRevision();
384 $this->assertNull( $rev1->getNext() );
386 $page->doEditContent( ContentHandler
::makeContent( 'Bla bla', $page->getTitle() ),
387 'second rev testGetNext' );
388 $rev2 = $page->getRevision();
390 $this->assertNotNull( $rev1->getNext() );
391 $this->assertEquals( $rev2->getId(), $rev1->getNext()->getId() );
395 * @covers Revision::newNullRevision
397 public function testNewNullRevision()
399 $page = $this->createPage( 'RevisionStorageTest_testNewNullRevision', 'some testing text' );
400 $orig = $page->getRevision();
402 $dbw = wfGetDB( DB_MASTER
);
403 $rev = Revision
::newNullRevision( $dbw, $page->getId(), 'a null revision', false );
405 $this->assertNotEquals( $orig->getId(), $rev->getId(),
406 'new null revision shold have a different id from the original revision' );
407 $this->assertEquals( $orig->getTextId(), $rev->getTextId(),
408 'new null revision shold have the same text id as the original revision' );
409 $this->assertEquals( 'some testing text', $rev->getContent()->getNativeData() );
412 public function dataUserWasLastToEdit() {
415 3, true, # actually the last edit
418 2, true, # not the current edit, but still by this user
421 1, false, # edit by another user
424 0, false, # first edit, by this user, but another user edited in the mean time
430 * @dataProvider dataUserWasLastToEdit
432 public function testUserWasLastToEdit( $sinceIdx, $expectedLast ) {
433 $userA = \User
::newFromName( "RevisionStorageTest_userA" );
434 $userB = \User
::newFromName( "RevisionStorageTest_userB" );
436 if ( $userA->getId() === 0 ) {
437 $userA = \User
::createNew( $userA->getName() );
440 if ( $userB->getId() === 0 ) {
441 $userB = \User
::createNew( $userB->getName() );
444 $dbw = wfGetDB( DB_MASTER
);
445 $revisions = array();
447 // create revisions -----------------------------
448 $page = WikiPage
::factory( Title
::newFromText( 'RevisionStorageTest_testUserWasLastToEdit' ) );
451 $revisions[0] = new Revision( array(
452 'page' => $page->getId(),
453 'title' => $page->getTitle(), // we need the title to determine the page's default content model
454 'timestamp' => '20120101000000',
455 'user' => $userA->getId(),
457 'summary' => 'edit zero'
459 $revisions[0]->insertOn( $dbw );
462 $revisions[1] = new Revision( array(
463 'page' => $page->getId(),
464 'title' => $page->getTitle(), // still need the title, because $page->getId() is 0 (there's no entry in the page table)
465 'timestamp' => '20120101000100',
466 'user' => $userA->getId(),
468 'summary' => 'edit one'
470 $revisions[1]->insertOn( $dbw );
473 $revisions[2] = new Revision( array(
474 'page' => $page->getId(),
475 'title' => $page->getTitle(),
476 'timestamp' => '20120101000200',
477 'user' => $userB->getId(),
479 'summary' => 'edit two'
481 $revisions[2]->insertOn( $dbw );
484 $revisions[3] = new Revision( array(
485 'page' => $page->getId(),
486 'title' => $page->getTitle(),
487 'timestamp' => '20120101000300',
488 'user' => $userA->getId(),
490 'summary' => 'edit three'
492 $revisions[3]->insertOn( $dbw );
495 $revisions[4] = new Revision( array(
496 'page' => $page->getId(),
497 'title' => $page->getTitle(),
498 'timestamp' => '20120101000200',
499 'user' => $userA->getId(),
501 'summary' => 'edit four'
503 $revisions[4]->insertOn( $dbw );
505 // test it ---------------------------------
506 $since = $revisions[ $sinceIdx ]->getTimestamp();
508 $wasLast = Revision
::userWasLastToEdit( $dbw, $page->getId(), $userA->getId(), $since );
510 $this->assertEquals( $expectedLast, $wasLast );