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
{
15 * @var WikiPage $the_page
19 function __construct( $name = null, array $data = [], $dataName = '' ) {
20 parent
::__construct( $name, $data, $dataName );
22 $this->tablesUsed
= array_merge( $this->tablesUsed
,
40 protected function setUp() {
41 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
45 $wgExtraNamespaces[12312] = 'Dummy';
46 $wgExtraNamespaces[12313] = 'Dummy_talk';
48 $wgNamespaceContentModels[12312] = 'DUMMY';
49 $wgContentHandlers['DUMMY'] = 'DummyContentHandlerForTesting';
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',
57 CONTENT_MODEL_WIKITEXT
61 $this->tablesUsed
[] = 'archive';
64 protected function tearDown() {
65 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
69 unset( $wgExtraNamespaces[12312] );
70 unset( $wgExtraNamespaces[12313] );
72 unset( $wgNamespaceContentModels[12312] );
73 unset( $wgContentHandlers['DUMMY'] );
75 MWNamespace
::getCanonicalNamespaces( true ); # reset namespace cache
76 $wgContLang->resetNamespaces(); # reset namespace cache
79 protected function makeRevision( $props = null ) {
80 if ( $props === null ) {
84 if ( !isset( $props['content'] ) && !isset( $props['text'] ) ) {
85 $props['text'] = 'Lorem Ipsum';
88 if ( !isset( $props['comment'] ) ) {
89 $props['comment'] = 'just a test';
92 if ( !isset( $props['page'] ) ) {
93 $props['page'] = $this->the_page
->getId();
96 $rev = new Revision( $props );
98 $dbw = wfGetDB( DB_MASTER
);
99 $rev->insertOn( $dbw );
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
)
109 $ns = $this->getDefaultWikitextNS();
110 $page = MWNamespace
::getCanonicalName( $ns ) . ':' . $page;
113 $page = Title
::newFromText( $page );
116 if ( $page instanceof Title
) {
117 $page = new WikiPage( $page );
120 if ( $page->exists() ) {
121 $page->doDeleteArticle( "done" );
124 $content = ContentHandler
::makeContent( $text, $page->getTitle(), $model );
125 $page->doEditContent( $content, "testing", EDIT_NEW
);
130 protected function assertRevEquals( Revision
$orig, Revision
$rev = null ) {
131 $this->assertNotNull( $rev, 'missing revision' );
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() );
143 * @covers Revision::__construct
145 public function testConstructFromRow() {
146 $orig = $this->makeRevision();
148 $dbr = wfGetDB( DB_SLAVE
);
149 $res = $dbr->select( 'revision', '*', [ 'rev_id' => $orig->getId() ] );
150 $this->assertTrue( is_object( $res ), 'query failed' );
152 $row = $res->fetchObject();
155 $rev = new Revision( $row );
157 $this->assertRevEquals( $orig, $rev );
161 * @covers Revision::newFromRow
163 public function testNewFromRow() {
164 $orig = $this->makeRevision();
166 $dbr = wfGetDB( DB_SLAVE
);
167 $res = $dbr->select( 'revision', '*', [ 'rev_id' => $orig->getId() ] );
168 $this->assertTrue( is_object( $res ), 'query failed' );
170 $row = $res->fetchObject();
173 $rev = Revision
::newFromRow( $row );
175 $this->assertRevEquals( $orig, $rev );
179 * @covers Revision::newFromArchiveRow
181 public function testNewFromArchiveRow() {
182 $page = $this->createPage(
183 'RevisionStorageTest_testNewFromArchiveRow',
185 CONTENT_MODEL_WIKITEXT
187 $orig = $page->getRevision();
188 $page->doDeleteArticle( 'test Revision::newFromArchiveRow' );
190 $dbr = wfGetDB( DB_SLAVE
);
191 $res = $dbr->select( 'archive', '*', [ 'ar_rev_id' => $orig->getId() ] );
192 $this->assertTrue( is_object( $res ), 'query failed' );
194 $row = $res->fetchObject();
197 $rev = Revision
::newFromArchiveRow( $row );
199 $this->assertRevEquals( $orig, $rev );
203 * @covers Revision::newFromId
205 public function testNewFromId() {
206 $orig = $this->makeRevision();
208 $rev = Revision
::newFromId( $orig->getId() );
210 $this->assertRevEquals( $orig, $rev );
214 * @covers Revision::fetchRevision
216 public function testFetchRevision() {
217 $page = $this->createPage(
218 'RevisionStorageTest_testFetchRevision',
220 CONTENT_MODEL_WIKITEXT
223 // Hidden process cache assertion below
224 $page->getRevision()->getId();
226 $page->doEditContent( new WikitextContent( 'two' ), 'second rev' );
227 $id = $page->getRevision()->getId();
229 $res = Revision
::fetchRevision( $page->getTitle() );
231 # note: order is unspecified
233 while ( ( $row = $res->fetchObject() ) ) {
234 $rows[$row->rev_id
] = $row;
237 $this->assertEquals( 1, count( $rows ), 'expected exactly one revision' );
238 $this->assertArrayHasKey( $id, $rows, 'missing revision with id ' . $id );
242 * @covers Revision::selectFields
244 public function testSelectFields() {
245 global $wgContentHandlerUseDB;
247 $fields = Revision
::selectFields();
249 $this->assertTrue( in_array( 'rev_id', $fields ), 'missing rev_id in list of fields' );
250 $this->assertTrue( in_array( 'rev_page', $fields ), 'missing rev_page in list of fields' );
252 in_array( 'rev_timestamp', $fields ),
253 'missing rev_timestamp in list of fields'
255 $this->assertTrue( in_array( 'rev_user', $fields ), 'missing rev_user in list of fields' );
257 if ( $wgContentHandlerUseDB ) {
258 $this->assertTrue( in_array( 'rev_content_model', $fields ),
259 'missing rev_content_model in list of fields' );
260 $this->assertTrue( in_array( 'rev_content_format', $fields ),
261 'missing rev_content_format in list of fields' );
266 * @covers Revision::getPage
268 public function testGetPage() {
269 $page = $this->the_page
;
271 $orig = $this->makeRevision( [ 'page' => $page->getId() ] );
272 $rev = Revision
::newFromId( $orig->getId() );
274 $this->assertEquals( $page->getId(), $rev->getPage() );
278 * @covers Revision::getText
280 public function testGetText() {
281 $this->hideDeprecated( 'Revision::getText' );
283 $orig = $this->makeRevision( [ 'text' => 'hello hello.' ] );
284 $rev = Revision
::newFromId( $orig->getId() );
286 $this->assertEquals( 'hello hello.', $rev->getText() );
290 * @covers Revision::getContent
292 public function testGetContent_failure() {
293 $rev = new Revision( [
294 'page' => $this->the_page
->getId(),
295 'content_model' => $this->the_page
->getContentModel(),
296 'text_id' => 123456789, // not in the test DB
299 $this->assertNull( $rev->getContent(),
300 "getContent() should return null if the revision's text blob could not be loaded." );
302 // NOTE: check this twice, once for lazy initialization, and once with the cached value.
303 $this->assertNull( $rev->getContent(),
304 "getContent() should return null if the revision's text blob could not be loaded." );
308 * @covers Revision::getContent
310 public function testGetContent() {
311 $orig = $this->makeRevision( [ 'text' => 'hello hello.' ] );
312 $rev = Revision
::newFromId( $orig->getId() );
314 $this->assertEquals( 'hello hello.', $rev->getContent()->getNativeData() );
318 * @covers Revision::getContentModel
320 public function testGetContentModel_default_model() {
321 global $wgContentHandlerUseDB;
323 if ( !$wgContentHandlerUseDB ) {
324 $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
327 $orig = $this->makeRevision( [ 'text' => 'hello hello.', ] );
329 // Change namespace default content model, to make sure getContentModel() uses the
330 // page content model, not the namespace default.
331 $ns = $this->getDefaultWikitextNS();
332 $this->mergeMwGlobalArrayValue( 'wgNamespaceContentModels', [ $ns => CONTENT_MODEL_JSON
] );
334 $rev = Revision
::newFromId( $orig->getId() );
336 // we should still get the correct content model from the page table
337 $this->assertEquals( CONTENT_MODEL_WIKITEXT
, $rev->getContentModel() );
339 // check that we don't null the revision model if it's equal to the default, but not to
340 // the current page model.
341 $second = $this->makeRevision( [
342 'text' => '{ "say":"hello" }',
343 'content_model' => CONTENT_MODEL_JAVASCRIPT
346 $rev = Revision
::newFromId( $second->getId() );
348 // we should now get the content model from the revision table
349 $this->assertEquals( CONTENT_MODEL_JAVASCRIPT
, $rev->getContentModel() );
353 * @covers Revision::getContentModel
355 public function testGetContentModel_other_model() {
356 global $wgContentHandlerUseDB;
358 if ( !$wgContentHandlerUseDB ) {
359 $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
362 $orig = $this->makeRevision( [ 'text' => 'hello hello.',
363 'content_model' => CONTENT_MODEL_JAVASCRIPT
] );
364 $rev = Revision
::newFromId( $orig->getId() );
366 $this->assertEquals( CONTENT_MODEL_JAVASCRIPT
, $rev->getContentModel() );
370 * @covers Revision::getContentFormat
372 public function testGetContentFormat() {
373 global $wgContentHandlerUseDB;
375 if ( !$wgContentHandlerUseDB ) {
376 $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
379 $orig = $this->makeRevision( [
380 'text' => 'hello hello.',
381 'content_model' => CONTENT_MODEL_JAVASCRIPT
,
382 'content_format' => CONTENT_FORMAT_JAVASCRIPT
384 $rev = Revision
::newFromId( $orig->getId() );
386 $this->assertEquals( CONTENT_FORMAT_JAVASCRIPT
, $rev->getContentFormat() );
390 * @covers Revision::isCurrent
392 public function testIsCurrent() {
393 $page = $this->createPage(
394 'RevisionStorageTest_testIsCurrent',
396 CONTENT_MODEL_WIKITEXT
398 $rev1 = $page->getRevision();
400 # @todo find out if this should be true
401 # $this->assertTrue( $rev1->isCurrent() );
403 $rev1x = Revision
::newFromId( $rev1->getId() );
404 $this->assertTrue( $rev1x->isCurrent() );
406 $page->doEditContent(
407 ContentHandler
::makeContent( 'Bla bla', $page->getTitle(), CONTENT_MODEL_WIKITEXT
),
410 $rev2 = $page->getRevision();
412 # @todo find out if this should be true
413 # $this->assertTrue( $rev2->isCurrent() );
415 $rev1x = Revision
::newFromId( $rev1->getId() );
416 $this->assertFalse( $rev1x->isCurrent() );
418 $rev2x = Revision
::newFromId( $rev2->getId() );
419 $this->assertTrue( $rev2x->isCurrent() );
423 * @covers Revision::getPrevious
425 public function testGetPrevious() {
426 $page = $this->createPage(
427 'RevisionStorageTest_testGetPrevious',
428 'Lorem Ipsum testGetPrevious',
429 CONTENT_MODEL_WIKITEXT
431 $rev1 = $page->getRevision();
433 $this->assertNull( $rev1->getPrevious() );
435 $page->doEditContent(
436 ContentHandler
::makeContent( 'Bla bla', $page->getTitle(), CONTENT_MODEL_WIKITEXT
),
437 'second rev testGetPrevious' );
438 $rev2 = $page->getRevision();
440 $this->assertNotNull( $rev2->getPrevious() );
441 $this->assertEquals( $rev1->getId(), $rev2->getPrevious()->getId() );
445 * @covers Revision::getNext
447 public function testGetNext() {
448 $page = $this->createPage(
449 'RevisionStorageTest_testGetNext',
450 'Lorem Ipsum testGetNext',
451 CONTENT_MODEL_WIKITEXT
453 $rev1 = $page->getRevision();
455 $this->assertNull( $rev1->getNext() );
457 $page->doEditContent(
458 ContentHandler
::makeContent( 'Bla bla', $page->getTitle(), CONTENT_MODEL_WIKITEXT
),
459 'second rev testGetNext'
461 $rev2 = $page->getRevision();
463 $this->assertNotNull( $rev1->getNext() );
464 $this->assertEquals( $rev2->getId(), $rev1->getNext()->getId() );
468 * @covers Revision::newNullRevision
470 public function testNewNullRevision() {
471 $page = $this->createPage(
472 'RevisionStorageTest_testNewNullRevision',
474 CONTENT_MODEL_WIKITEXT
476 $orig = $page->getRevision();
478 $dbw = wfGetDB( DB_MASTER
);
479 $rev = Revision
::newNullRevision( $dbw, $page->getId(), 'a null revision', false );
481 $this->assertNotEquals( $orig->getId(), $rev->getId(),
482 'new null revision shold have a different id from the original revision' );
483 $this->assertEquals( $orig->getTextId(), $rev->getTextId(),
484 'new null revision shold have the same text id as the original revision' );
485 $this->assertEquals( 'some testing text', $rev->getContent()->getNativeData() );
488 public static function provideUserWasLastToEdit() {
491 3, true, # actually the last edit
494 2, true, # not the current edit, but still by this user
497 1, false, # edit by another user
500 0, false, # first edit, by this user, but another user edited in the mean time
506 * @dataProvider provideUserWasLastToEdit
508 public function testUserWasLastToEdit( $sinceIdx, $expectedLast ) {
509 $userA = User
::newFromName( "RevisionStorageTest_userA" );
510 $userB = User
::newFromName( "RevisionStorageTest_userB" );
512 if ( $userA->getId() === 0 ) {
513 $userA = User
::createNew( $userA->getName() );
516 if ( $userB->getId() === 0 ) {
517 $userB = User
::createNew( $userB->getName() );
520 $ns = $this->getDefaultWikitextNS();
522 $dbw = wfGetDB( DB_MASTER
);
525 // create revisions -----------------------------
526 $page = WikiPage
::factory( Title
::newFromText(
527 'RevisionStorageTest_testUserWasLastToEdit', $ns ) );
528 $page->insertOn( $dbw );
531 $revisions[0] = new Revision( [
532 'page' => $page->getId(),
533 // we need the title to determine the page's default content model
534 'title' => $page->getTitle(),
535 'timestamp' => '20120101000000',
536 'user' => $userA->getId(),
538 'content_model' => CONTENT_MODEL_WIKITEXT
,
539 'summary' => 'edit zero'
541 $revisions[0]->insertOn( $dbw );
544 $revisions[1] = new Revision( [
545 'page' => $page->getId(),
546 // still need the title, because $page->getId() is 0 (there's no entry in the page table)
547 'title' => $page->getTitle(),
548 'timestamp' => '20120101000100',
549 'user' => $userA->getId(),
551 'content_model' => CONTENT_MODEL_WIKITEXT
,
552 'summary' => 'edit one'
554 $revisions[1]->insertOn( $dbw );
557 $revisions[2] = new Revision( [
558 'page' => $page->getId(),
559 'title' => $page->getTitle(),
560 'timestamp' => '20120101000200',
561 'user' => $userB->getId(),
563 'content_model' => CONTENT_MODEL_WIKITEXT
,
564 'summary' => 'edit two'
566 $revisions[2]->insertOn( $dbw );
569 $revisions[3] = new Revision( [
570 'page' => $page->getId(),
571 'title' => $page->getTitle(),
572 'timestamp' => '20120101000300',
573 'user' => $userA->getId(),
575 'content_model' => CONTENT_MODEL_WIKITEXT
,
576 'summary' => 'edit three'
578 $revisions[3]->insertOn( $dbw );
581 $revisions[4] = new Revision( [
582 'page' => $page->getId(),
583 'title' => $page->getTitle(),
584 'timestamp' => '20120101000200',
585 'user' => $userA->getId(),
587 'content_model' => CONTENT_MODEL_WIKITEXT
,
588 'summary' => 'edit four'
590 $revisions[4]->insertOn( $dbw );
592 // test it ---------------------------------
593 $since = $revisions[$sinceIdx]->getTimestamp();
595 $wasLast = Revision
::userWasLastToEdit( $dbw, $page->getId(), $userA->getId(), $since );
597 $this->assertEquals( $expectedLast, $wasLast );