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;
46 $wgExtraNamespaces[ 12312 ] = 'Dummy';
47 $wgExtraNamespaces[ 12313 ] = 'Dummy_talk';
49 $wgNamespaceContentModels[ 12312 ] = 'DUMMY';
50 $wgContentHandlers[ 'DUMMY' ] = 'DummyContentHandlerForTesting';
52 MWNamespace
::getCanonicalNamespaces( true ); # reset namespace cache
53 $wgContLang->resetNamespaces(); # reset namespace cache
54 if ( !$this->the_page
) {
55 $this->the_page
= $this->createPage( 'RevisionStorageTest_the_page', "just a dummy page", CONTENT_MODEL_WIKITEXT
);
59 public function tearDown() {
60 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
64 unset( $wgExtraNamespaces[ 12312 ] );
65 unset( $wgExtraNamespaces[ 12313 ] );
67 unset( $wgNamespaceContentModels[ 12312 ] );
68 unset( $wgContentHandlers[ 'DUMMY' ] );
70 MWNamespace
::getCanonicalNamespaces( true ); # reset namespace cache
71 $wgContLang->resetNamespaces(); # reset namespace cache
74 protected function makeRevision( $props = null ) {
75 if ( $props === null ) $props = array();
77 if ( !isset( $props['content'] ) && !isset( $props['text'] ) ) $props['text'] = 'Lorem Ipsum';
78 if ( !isset( $props['comment'] ) ) $props['comment'] = 'just a test';
79 if ( !isset( $props['page'] ) ) $props['page'] = $this->the_page
->getId();
81 $rev = new Revision( $props );
83 $dbw = wfgetDB( DB_MASTER
);
84 $rev->insertOn( $dbw );
89 protected function createPage( $page, $text, $model = null ) {
90 if ( is_string( $page ) ) {
91 if ( !preg_match( '/:/', $page ) &&
92 ( $model === null ||
$model === CONTENT_MODEL_WIKITEXT
) ) {
94 $ns = $this->getDefaultWikitextNS();
95 $page = MWNamespace
::getCanonicalName( $ns ) . ':' . $page;
98 $page = Title
::newFromText( $page );
101 if ( $page instanceof Title
) {
102 $page = new WikiPage( $page );
105 if ( $page->exists() ) {
106 $page->doDeleteArticle( "done" );
109 $content = ContentHandler
::makeContent( $text, $page->getTitle(), $model );
110 $page->doEditContent( $content, "testing", EDIT_NEW
);
115 protected function assertRevEquals( Revision
$orig, Revision
$rev = null ) {
116 $this->assertNotNull( $rev, 'missing revision' );
118 $this->assertEquals( $orig->getId(), $rev->getId() );
119 $this->assertEquals( $orig->getPage(), $rev->getPage() );
120 $this->assertEquals( $orig->getTimestamp(), $rev->getTimestamp() );
121 $this->assertEquals( $orig->getUser(), $rev->getUser() );
122 $this->assertEquals( $orig->getContentModel(), $rev->getContentModel() );
123 $this->assertEquals( $orig->getContentFormat(), $rev->getContentFormat() );
124 $this->assertEquals( $orig->getSha1(), $rev->getSha1() );
128 * @covers Revision::__construct
130 public function testConstructFromRow() {
131 $orig = $this->makeRevision();
133 $dbr = wfgetDB( DB_SLAVE
);
134 $res = $dbr->select( 'revision', '*', array( 'rev_id' => $orig->getId() ) );
135 $this->assertTrue( is_object( $res ), 'query failed' );
137 $row = $res->fetchObject();
140 $rev = new Revision( $row );
142 $this->assertRevEquals( $orig, $rev );
146 * @covers Revision::newFromRow
148 public function testNewFromRow() {
149 $orig = $this->makeRevision();
151 $dbr = wfgetDB( DB_SLAVE
);
152 $res = $dbr->select( 'revision', '*', array( 'rev_id' => $orig->getId() ) );
153 $this->assertTrue( is_object( $res ), 'query failed' );
155 $row = $res->fetchObject();
158 $rev = Revision
::newFromRow( $row );
160 $this->assertRevEquals( $orig, $rev );
165 * @covers Revision::newFromArchiveRow
167 public function testNewFromArchiveRow() {
168 $page = $this->createPage( 'RevisionStorageTest_testNewFromArchiveRow', 'Lorem Ipsum', CONTENT_MODEL_WIKITEXT
);
169 $orig = $page->getRevision();
170 $page->doDeleteArticle( 'test Revision::newFromArchiveRow' );
172 $dbr = wfgetDB( DB_SLAVE
);
173 $res = $dbr->select( 'archive', '*', array( 'ar_rev_id' => $orig->getId() ) );
174 $this->assertTrue( is_object( $res ), 'query failed' );
176 $row = $res->fetchObject();
179 $rev = Revision
::newFromArchiveRow( $row );
181 $this->assertRevEquals( $orig, $rev );
185 * @covers Revision::newFromId
187 public function testNewFromId() {
188 $orig = $this->makeRevision();
190 $rev = Revision
::newFromId( $orig->getId() );
192 $this->assertRevEquals( $orig, $rev );
196 * @covers Revision::fetchRevision
198 public function testFetchRevision() {
199 $page = $this->createPage( 'RevisionStorageTest_testFetchRevision', 'one', CONTENT_MODEL_WIKITEXT
);
200 $id1 = $page->getRevision()->getId();
202 $page->doEditContent( new WikitextContent( 'two' ), 'second rev' );
203 $id2 = $page->getRevision()->getId();
205 $res = Revision
::fetchRevision( $page->getTitle() );
207 #note: order is unspecified
209 while ( ( $row = $res->fetchObject() ) ) {
210 $rows[ $row->rev_id
]= $row;
213 $row = $res->fetchObject();
214 $this->assertEquals( 1, count($rows), 'expected exactly one revision' );
215 $this->assertArrayHasKey( $id2, $rows, 'missing revision with id ' . $id2 );
219 * @covers Revision::selectFields
221 public function testSelectFields() {
222 global $wgContentHandlerUseDB;
224 $fields = Revision
::selectFields();
226 $this->assertTrue( in_array( 'rev_id', $fields ), 'missing rev_id in list of fields');
227 $this->assertTrue( in_array( 'rev_page', $fields ), 'missing rev_page in list of fields');
228 $this->assertTrue( in_array( 'rev_timestamp', $fields ), 'missing rev_timestamp in list of fields');
229 $this->assertTrue( in_array( 'rev_user', $fields ), 'missing rev_user in list of fields');
231 if ( $wgContentHandlerUseDB ) {
232 $this->assertTrue( in_array( 'rev_content_model', $fields ),
233 'missing rev_content_model in list of fields');
234 $this->assertTrue( in_array( 'rev_content_format', $fields ),
235 'missing rev_content_format in list of fields');
240 * @covers Revision::getPage
242 public function testGetPage() {
243 $page = $this->the_page
;
245 $orig = $this->makeRevision( array( 'page' => $page->getId() ) );
246 $rev = Revision
::newFromId( $orig->getId() );
248 $this->assertEquals( $page->getId(), $rev->getPage() );
252 * @covers Revision::getText
254 public function testGetText() {
255 $this->hideDeprecated( 'Revision::getText' );
257 $orig = $this->makeRevision( array( 'text' => 'hello hello.' ) );
258 $rev = Revision
::newFromId( $orig->getId() );
260 $this->assertEquals( 'hello hello.', $rev->getText() );
264 * @covers Revision::getContent
266 public function testGetContent_failure() {
267 $rev = new Revision( array(
268 'page' => $this->the_page
->getId(),
269 'content_model' => $this->the_page
->getContentModel(),
270 'text_id' => 123456789, // not in the test DB
273 $this->assertNull( $rev->getContent(),
274 "getContent() should return null if the revision's text blob could not be loaded." );
276 //NOTE: check this twice, once for lazy initialization, and once with the cached value.
277 $this->assertNull( $rev->getContent(),
278 "getContent() should return null if the revision's text blob could not be loaded." );
282 * @covers Revision::getContent
284 public function testGetContent() {
285 $orig = $this->makeRevision( array( 'text' => 'hello hello.' ) );
286 $rev = Revision
::newFromId( $orig->getId() );
288 $this->assertEquals( 'hello hello.', $rev->getContent()->getNativeData() );
292 * @covers Revision::revText
294 public function testRevText() {
295 $this->hideDeprecated( 'Revision::revText' );
296 $orig = $this->makeRevision( array( 'text' => 'hello hello rev.' ) );
297 $rev = Revision
::newFromId( $orig->getId() );
299 $this->assertEquals( 'hello hello rev.', $rev->revText() );
303 * @covers Revision::getRawText
305 public function testGetRawText() {
306 $this->hideDeprecated( 'Revision::getRawText' );
308 $orig = $this->makeRevision( array( 'text' => 'hello hello raw.' ) );
309 $rev = Revision
::newFromId( $orig->getId() );
311 $this->assertEquals( 'hello hello raw.', $rev->getRawText() );
315 * @covers Revision::getContentModel
317 public function testGetContentModel() {
318 global $wgContentHandlerUseDB;
320 if ( !$wgContentHandlerUseDB ) {
321 $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
324 $orig = $this->makeRevision( array( 'text' => 'hello hello.',
325 'content_model' => CONTENT_MODEL_JAVASCRIPT
) );
326 $rev = Revision
::newFromId( $orig->getId() );
328 $this->assertEquals( CONTENT_MODEL_JAVASCRIPT
, $rev->getContentModel() );
332 * @covers Revision::getContentFormat
334 public function testGetContentFormat() {
335 global $wgContentHandlerUseDB;
337 if ( !$wgContentHandlerUseDB ) {
338 $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
341 $orig = $this->makeRevision( array( 'text' => 'hello hello.',
342 'content_model' => CONTENT_MODEL_JAVASCRIPT
,
343 'content_format' => CONTENT_FORMAT_JAVASCRIPT
) );
344 $rev = Revision
::newFromId( $orig->getId() );
346 $this->assertEquals( CONTENT_FORMAT_JAVASCRIPT
, $rev->getContentFormat() );
350 * @covers Revision::isCurrent
352 public function testIsCurrent() {
353 $page = $this->createPage( 'RevisionStorageTest_testIsCurrent', 'Lorem Ipsum', CONTENT_MODEL_WIKITEXT
);
354 $rev1 = $page->getRevision();
356 # @todo: find out if this should be true
357 # $this->assertTrue( $rev1->isCurrent() );
359 $rev1x = Revision
::newFromId( $rev1->getId() );
360 $this->assertTrue( $rev1x->isCurrent() );
362 $page->doEditContent( ContentHandler
::makeContent( 'Bla bla', $page->getTitle(), CONTENT_MODEL_WIKITEXT
), 'second rev' );
363 $rev2 = $page->getRevision();
365 # @todo: find out if this should be true
366 # $this->assertTrue( $rev2->isCurrent() );
368 $rev1x = Revision
::newFromId( $rev1->getId() );
369 $this->assertFalse( $rev1x->isCurrent() );
371 $rev2x = Revision
::newFromId( $rev2->getId() );
372 $this->assertTrue( $rev2x->isCurrent() );
376 * @covers Revision::getPrevious
378 public function testGetPrevious() {
379 $page = $this->createPage( 'RevisionStorageTest_testGetPrevious', 'Lorem Ipsum testGetPrevious', CONTENT_MODEL_WIKITEXT
);
380 $rev1 = $page->getRevision();
382 $this->assertNull( $rev1->getPrevious() );
384 $page->doEditContent( ContentHandler
::makeContent( 'Bla bla', $page->getTitle(), CONTENT_MODEL_WIKITEXT
),
385 'second rev testGetPrevious' );
386 $rev2 = $page->getRevision();
388 $this->assertNotNull( $rev2->getPrevious() );
389 $this->assertEquals( $rev1->getId(), $rev2->getPrevious()->getId() );
393 * @covers Revision::getNext
395 public function testGetNext() {
396 $page = $this->createPage( 'RevisionStorageTest_testGetNext', 'Lorem Ipsum testGetNext', CONTENT_MODEL_WIKITEXT
);
397 $rev1 = $page->getRevision();
399 $this->assertNull( $rev1->getNext() );
401 $page->doEditContent( ContentHandler
::makeContent( 'Bla bla', $page->getTitle(), CONTENT_MODEL_WIKITEXT
),
402 'second rev testGetNext' );
403 $rev2 = $page->getRevision();
405 $this->assertNotNull( $rev1->getNext() );
406 $this->assertEquals( $rev2->getId(), $rev1->getNext()->getId() );
410 * @covers Revision::newNullRevision
412 public function testNewNullRevision() {
413 $page = $this->createPage( 'RevisionStorageTest_testNewNullRevision', 'some testing text', CONTENT_MODEL_WIKITEXT
);
414 $orig = $page->getRevision();
416 $dbw = wfGetDB( DB_MASTER
);
417 $rev = Revision
::newNullRevision( $dbw, $page->getId(), 'a null revision', false );
419 $this->assertNotEquals( $orig->getId(), $rev->getId(),
420 'new null revision shold have a different id from the original revision' );
421 $this->assertEquals( $orig->getTextId(), $rev->getTextId(),
422 'new null revision shold have the same text id as the original revision' );
423 $this->assertEquals( 'some testing text', $rev->getContent()->getNativeData() );
426 public static function provideUserWasLastToEdit() {
429 3, true, # actually the last edit
432 2, true, # not the current edit, but still by this user
435 1, false, # edit by another user
438 0, false, # first edit, by this user, but another user edited in the mean time
444 * @dataProvider provideUserWasLastToEdit
446 public function testUserWasLastToEdit( $sinceIdx, $expectedLast ) {
447 $userA = \User
::newFromName( "RevisionStorageTest_userA" );
448 $userB = \User
::newFromName( "RevisionStorageTest_userB" );
450 if ( $userA->getId() === 0 ) {
451 $userA = \User
::createNew( $userA->getName() );
454 if ( $userB->getId() === 0 ) {
455 $userB = \User
::createNew( $userB->getName() );
458 $ns = $this->getDefaultWikitextNS();
460 $dbw = wfGetDB( DB_MASTER
);
461 $revisions = array();
463 // create revisions -----------------------------
464 $page = WikiPage
::factory( Title
::newFromText(
465 'RevisionStorageTest_testUserWasLastToEdit', $ns ) );
468 $revisions[0] = new Revision( array(
469 'page' => $page->getId(),
470 'title' => $page->getTitle(), // we need the title to determine the page's default content model
471 'timestamp' => '20120101000000',
472 'user' => $userA->getId(),
474 'content_model' => CONTENT_MODEL_WIKITEXT
,
475 'summary' => 'edit zero'
477 $revisions[0]->insertOn( $dbw );
480 $revisions[1] = new Revision( array(
481 'page' => $page->getId(),
482 'title' => $page->getTitle(), // still need the title, because $page->getId() is 0 (there's no entry in the page table)
483 'timestamp' => '20120101000100',
484 'user' => $userA->getId(),
486 'content_model' => CONTENT_MODEL_WIKITEXT
,
487 'summary' => 'edit one'
489 $revisions[1]->insertOn( $dbw );
492 $revisions[2] = new Revision( array(
493 'page' => $page->getId(),
494 'title' => $page->getTitle(),
495 'timestamp' => '20120101000200',
496 'user' => $userB->getId(),
498 'content_model' => CONTENT_MODEL_WIKITEXT
,
499 'summary' => 'edit two'
501 $revisions[2]->insertOn( $dbw );
504 $revisions[3] = new Revision( array(
505 'page' => $page->getId(),
506 'title' => $page->getTitle(),
507 'timestamp' => '20120101000300',
508 'user' => $userA->getId(),
510 'content_model' => CONTENT_MODEL_WIKITEXT
,
511 'summary' => 'edit three'
513 $revisions[3]->insertOn( $dbw );
516 $revisions[4] = new Revision( array(
517 'page' => $page->getId(),
518 'title' => $page->getTitle(),
519 'timestamp' => '20120101000200',
520 'user' => $userA->getId(),
522 'content_model' => CONTENT_MODEL_WIKITEXT
,
523 'summary' => 'edit four'
525 $revisions[4]->insertOn( $dbw );
527 // test it ---------------------------------
528 $since = $revisions[ $sinceIdx ]->getTimestamp();
530 $wasLast = Revision
::userWasLastToEdit( $dbw, $page->getId(), $userA->getId(), $since );
532 $this->assertEquals( $expectedLast, $wasLast );