2 use MediaWiki\MediaWikiServices
;
3 use MediaWiki\Storage\RevisionStore
;
4 use MediaWiki\Storage\IncompleteRevisionException
;
5 use MediaWiki\Storage\RevisionRecord
;
8 * RevisionDbTestBase contains test cases for the Revision class that have Database interactions.
13 abstract class RevisionDbTestBase
extends MediaWikiTestCase
{
16 * @var WikiPage $testPage
20 public function __construct( $name = null, array $data = [], $dataName = '' ) {
21 parent
::__construct( $name, $data, $dataName );
23 $this->tablesUsed
= array_merge( $this->tablesUsed
,
46 protected function setUp() {
51 $this->mergeMwGlobalArrayValue(
55 12313 => 'Dummy_talk',
59 $this->mergeMwGlobalArrayValue(
60 'wgNamespaceContentModels',
62 12312 => DummyContentForTesting
::MODEL_ID
,
66 $this->mergeMwGlobalArrayValue(
69 DummyContentForTesting
::MODEL_ID
=> 'DummyContentHandlerForTesting',
70 RevisionTestModifyableContent
::MODEL_ID
=> 'RevisionTestModifyableContentHandler',
74 $this->setMwGlobals( 'wgContentHandlerUseDB', $this->getContentHandlerUseDB() );
76 MWNamespace
::clearCaches();
77 // Reset namespace cache
78 $wgContLang->resetNamespaces();
80 if ( !$this->testPage
) {
82 * We have to create a new page for each subclass as the page creation may result
83 * in different DB fields being filled based on configuration.
85 $this->testPage
= $this->createPage( __CLASS__
, __CLASS__
);
89 protected function tearDown() {
94 MWNamespace
::clearCaches();
95 // Reset namespace cache
96 $wgContLang->resetNamespaces();
99 abstract protected function getContentHandlerUseDB();
101 private function makeRevisionWithProps( $props = null ) {
102 if ( $props === null ) {
106 if ( !isset( $props['content'] ) && !isset( $props['text'] ) ) {
107 $props['text'] = 'Lorem Ipsum';
110 if ( !isset( $props['user_text'] ) ) {
111 $props['user_text'] = 'Tester';
114 if ( !isset( $props['user'] ) ) {
118 if ( !isset( $props['comment'] ) ) {
119 $props['comment'] = 'just a test';
122 if ( !isset( $props['page'] ) ) {
123 $props['page'] = $this->testPage
->getId();
126 if ( !isset( $props['content_model'] ) ) {
127 $props['content_model'] = CONTENT_MODEL_WIKITEXT
;
130 $rev = new Revision( $props );
132 $dbw = wfGetDB( DB_MASTER
);
133 $rev->insertOn( $dbw );
139 * @param string $titleString
140 * @param string $text
141 * @param string|null $model
145 private function createPage( $titleString, $text, $model = null ) {
146 if ( !preg_match( '/:/', $titleString ) &&
147 ( $model === null ||
$model === CONTENT_MODEL_WIKITEXT
)
149 $ns = $this->getDefaultWikitextNS();
150 $titleString = MWNamespace
::getCanonicalName( $ns ) . ':' . $titleString;
153 $title = Title
::newFromText( $titleString );
154 $wikipage = new WikiPage( $title );
156 // Delete the article if it already exists
157 if ( $wikipage->exists() ) {
158 $wikipage->doDeleteArticle( "done" );
161 $content = ContentHandler
::makeContent( $text, $title, $model );
162 $wikipage->doEditContent( $content, __METHOD__
, EDIT_NEW
);
167 private function assertRevEquals( Revision
$orig, Revision
$rev = null ) {
168 $this->assertNotNull( $rev, 'missing revision' );
170 $this->assertEquals( $orig->getId(), $rev->getId() );
171 $this->assertEquals( $orig->getPage(), $rev->getPage() );
172 $this->assertEquals( $orig->getTimestamp(), $rev->getTimestamp() );
173 $this->assertEquals( $orig->getUser(), $rev->getUser() );
174 $this->assertEquals( $orig->getContentModel(), $rev->getContentModel() );
175 $this->assertEquals( $orig->getContentFormat(), $rev->getContentFormat() );
176 $this->assertEquals( $orig->getSha1(), $rev->getSha1() );
180 * @covers Revision::getRecentChange
182 public function testGetRecentChange() {
183 $rev = $this->testPage
->getRevision();
184 $recentChange = $rev->getRecentChange();
186 // Make sure various attributes look right / the correct entry has been retrieved.
187 $this->assertEquals( $rev->getTimestamp(), $recentChange->getAttribute( 'rc_timestamp' ) );
189 $rev->getTitle()->getNamespace(),
190 $recentChange->getAttribute( 'rc_namespace' )
193 $rev->getTitle()->getDBkey(),
194 $recentChange->getAttribute( 'rc_title' )
196 $this->assertEquals( $rev->getUser(), $recentChange->getAttribute( 'rc_user' ) );
197 $this->assertEquals( $rev->getUserText(), $recentChange->getAttribute( 'rc_user_text' ) );
198 $this->assertEquals( $rev->getComment(), $recentChange->getAttribute( 'rc_comment' ) );
199 $this->assertEquals( $rev->getPage(), $recentChange->getAttribute( 'rc_cur_id' ) );
200 $this->assertEquals( $rev->getId(), $recentChange->getAttribute( 'rc_this_oldid' ) );
204 * @covers Revision::insertOn
206 public function testInsertOn_success() {
207 $parentId = $this->testPage
->getLatest();
209 // If an ExternalStore is set don't use it.
210 $this->setMwGlobals( 'wgDefaultExternalStore', false );
212 $rev = new Revision( [
213 'page' => $this->testPage
->getId(),
214 'title' => $this->testPage
->getTitle(),
215 'text' => 'Revision Text',
216 'comment' => 'Revision comment',
219 $revId = $rev->insertOn( wfGetDB( DB_MASTER
) );
221 $this->assertInternalType( 'integer', $revId );
222 $this->assertSame( $revId, $rev->getId() );
224 // getTextId() must be an int!
225 $this->assertInternalType( 'integer', $rev->getTextId() );
227 $mainSlot = $rev->getRevisionRecord()->getSlot( 'main', RevisionRecord
::RAW
);
229 // we currently only support storage in the text table
230 $textId = MediaWikiServices
::getInstance()
232 ->getTextIdFromAddress( $mainSlot->getAddress() );
236 [ 'old_id', 'old_text' ],
238 [ [ strval( $textId ), 'Revision Text' ] ]
253 "rev_id = {$rev->getId()}",
255 strval( $rev->getId() ),
256 strval( $this->testPage
->getId() ),
263 's0ngbdoxagreuf2vjtuxzwdz64n29xm',
269 * @covers Revision::insertOn
271 public function testInsertOn_exceptionOnNoPage() {
272 // If an ExternalStore is set don't use it.
273 $this->setMwGlobals( 'wgDefaultExternalStore', false );
274 $this->setExpectedException(
275 IncompleteRevisionException
::class,
276 "rev_page field must not be 0!"
279 $title = Title
::newFromText( 'Nonexistant-' . __METHOD__
);
280 $rev = new Revision( [], 0, $title );
282 $rev->insertOn( wfGetDB( DB_MASTER
) );
286 * @covers Revision::newFromTitle
288 public function testNewFromTitle_withoutId() {
289 $latestRevId = $this->testPage
->getLatest();
291 $rev = Revision
::newFromTitle( $this->testPage
->getTitle() );
293 $this->assertTrue( $this->testPage
->getTitle()->equals( $rev->getTitle() ) );
294 $this->assertEquals( $latestRevId, $rev->getId() );
298 * @covers Revision::newFromTitle
300 public function testNewFromTitle_withId() {
301 $latestRevId = $this->testPage
->getLatest();
303 $rev = Revision
::newFromTitle( $this->testPage
->getTitle(), $latestRevId );
305 $this->assertTrue( $this->testPage
->getTitle()->equals( $rev->getTitle() ) );
306 $this->assertEquals( $latestRevId, $rev->getId() );
310 * @covers Revision::newFromTitle
312 public function testNewFromTitle_withBadId() {
313 $latestRevId = $this->testPage
->getLatest();
315 $rev = Revision
::newFromTitle( $this->testPage
->getTitle(), $latestRevId +
1 );
317 $this->assertNull( $rev );
321 * @covers Revision::newFromRow
323 public function testNewFromRow() {
324 $orig = $this->makeRevisionWithProps();
326 $dbr = wfGetDB( DB_REPLICA
);
327 $revQuery = Revision
::getQueryInfo();
328 $res = $dbr->select( $revQuery['tables'], $revQuery['fields'], [ 'rev_id' => $orig->getId() ],
329 __METHOD__
, [], $revQuery['joins'] );
330 $this->assertTrue( is_object( $res ), 'query failed' );
332 $row = $res->fetchObject();
335 $rev = Revision
::newFromRow( $row );
337 $this->assertRevEquals( $orig, $rev );
340 public function provideNewFromArchiveRow() {
348 return $f +
[ 'ar_namespace', 'ar_title' ];
353 unset( $f['ar_text'] );
359 unset( $f['ar_text_id'] );
365 unset( $f['ar_page_id'] );
371 unset( $f['ar_parent_id'] );
377 unset( $f['ar_rev_id'] );
383 unset( $f['ar_sha1'] );
390 * @dataProvider provideNewFromArchiveRow
391 * @covers Revision::newFromArchiveRow
393 public function testNewFromArchiveRow( $selectModifier ) {
394 $services = MediaWikiServices
::getInstance();
396 $store = new RevisionStore(
397 $services->getDBLoadBalancer(),
398 $services->getService( '_SqlBlobStore' ),
399 $services->getMainWANObjectCache()
402 $store->setContentHandlerUseDB( $this->getContentHandlerUseDB() );
403 $this->setService( 'RevisionStore', $store );
405 $page = $this->createPage(
406 'RevisionStorageTest_testNewFromArchiveRow',
408 CONTENT_MODEL_WIKITEXT
410 $orig = $page->getRevision();
411 $page->doDeleteArticle( 'test Revision::newFromArchiveRow' );
413 $dbr = wfGetDB( DB_REPLICA
);
414 $arQuery = Revision
::getArchiveQueryInfo();
415 $arQuery['fields'] = $selectModifier( $arQuery['fields'] );
417 $arQuery['tables'], $arQuery['fields'], [ 'ar_rev_id' => $orig->getId() ],
418 __METHOD__
, [], $arQuery['joins']
420 $this->assertTrue( is_object( $res ), 'query failed' );
422 $row = $res->fetchObject();
425 // MCR migration note: $row is now required to contain ar_title and ar_namespace.
426 // Alternatively, a Title object can be passed to RevisionStore::newRevisionFromArchiveRow
427 $rev = Revision
::newFromArchiveRow( $row );
429 $this->assertRevEquals( $orig, $rev );
433 * @covers Revision::newFromArchiveRow
435 public function testNewFromArchiveRowOverrides() {
436 $page = $this->createPage(
437 'RevisionStorageTest_testNewFromArchiveRow',
439 CONTENT_MODEL_WIKITEXT
441 $orig = $page->getRevision();
442 $page->doDeleteArticle( 'test Revision::newFromArchiveRow' );
444 $dbr = wfGetDB( DB_REPLICA
);
445 $arQuery = Revision
::getArchiveQueryInfo();
447 $arQuery['tables'], $arQuery['fields'], [ 'ar_rev_id' => $orig->getId() ],
448 __METHOD__
, [], $arQuery['joins']
450 $this->assertTrue( is_object( $res ), 'query failed' );
452 $row = $res->fetchObject();
455 $rev = Revision
::newFromArchiveRow( $row, [ 'comment_text' => 'SOMEOVERRIDE' ] );
457 $this->assertNotEquals( $orig->getComment(), $rev->getComment() );
458 $this->assertEquals( 'SOMEOVERRIDE', $rev->getComment() );
462 * @covers Revision::newFromId
464 public function testNewFromId() {
465 $orig = $this->testPage
->getRevision();
466 $rev = Revision
::newFromId( $orig->getId() );
467 $this->assertRevEquals( $orig, $rev );
471 * @covers Revision::newFromPageId
473 public function testNewFromPageId() {
474 $rev = Revision
::newFromPageId( $this->testPage
->getId() );
475 $this->assertRevEquals(
476 $this->testPage
->getRevision(),
482 * @covers Revision::newFromPageId
484 public function testNewFromPageIdWithLatestId() {
485 $rev = Revision
::newFromPageId(
486 $this->testPage
->getId(),
487 $this->testPage
->getLatest()
489 $this->assertRevEquals(
490 $this->testPage
->getRevision(),
496 * @covers Revision::newFromPageId
498 public function testNewFromPageIdWithNotLatestId() {
499 $content = new WikitextContent( __METHOD__
);
500 $this->testPage
->doEditContent( $content, __METHOD__
);
501 $rev = Revision
::newFromPageId(
502 $this->testPage
->getId(),
503 $this->testPage
->getRevision()->getPrevious()->getId()
505 $this->assertRevEquals(
506 $this->testPage
->getRevision()->getPrevious(),
512 * @covers Revision::fetchRevision
514 public function testFetchRevision() {
515 // Hidden process cache assertion below
516 $this->testPage
->getRevision()->getId();
518 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
519 $id = $this->testPage
->getRevision()->getId();
521 $this->hideDeprecated( 'Revision::fetchRevision' );
522 $res = Revision
::fetchRevision( $this->testPage
->getTitle() );
524 # note: order is unspecified
526 while ( ( $row = $res->fetchObject() ) ) {
527 $rows[$row->rev_id
] = $row;
530 $this->assertEmpty( $rows, 'expected empty set' );
534 * @covers Revision::getPage
536 public function testGetPage() {
537 $page = $this->testPage
;
539 $orig = $this->makeRevisionWithProps( [ 'page' => $page->getId() ] );
540 $rev = Revision
::newFromId( $orig->getId() );
542 $this->assertEquals( $page->getId(), $rev->getPage() );
546 * @covers Revision::isCurrent
548 public function testIsCurrent() {
549 $rev1 = $this->testPage
->getRevision();
551 # @todo find out if this should be true
552 # $this->assertTrue( $rev1->isCurrent() );
554 $rev1x = Revision
::newFromId( $rev1->getId() );
555 $this->assertTrue( $rev1x->isCurrent() );
557 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
558 $rev2 = $this->testPage
->getRevision();
560 # @todo find out if this should be true
561 # $this->assertTrue( $rev2->isCurrent() );
563 $rev1x = Revision
::newFromId( $rev1->getId() );
564 $this->assertFalse( $rev1x->isCurrent() );
566 $rev2x = Revision
::newFromId( $rev2->getId() );
567 $this->assertTrue( $rev2x->isCurrent() );
571 * @covers Revision::getPrevious
573 public function testGetPrevious() {
574 $oldestRevision = $this->testPage
->getOldestRevision();
575 $latestRevision = $this->testPage
->getLatest();
577 $this->assertNull( $oldestRevision->getPrevious() );
579 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
580 $newRevision = $this->testPage
->getRevision();
582 $this->assertNotNull( $newRevision->getPrevious() );
583 $this->assertEquals( $latestRevision, $newRevision->getPrevious()->getId() );
587 * @covers Revision::getNext
589 public function testGetNext() {
590 $rev1 = $this->testPage
->getRevision();
592 $this->assertNull( $rev1->getNext() );
594 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
595 $rev2 = $this->testPage
->getRevision();
597 $this->assertNotNull( $rev1->getNext() );
598 $this->assertEquals( $rev2->getId(), $rev1->getNext()->getId() );
602 * @covers Revision::newNullRevision
604 public function testNewNullRevision() {
605 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
606 $orig = $this->testPage
->getRevision();
608 $dbw = wfGetDB( DB_MASTER
);
609 $rev = Revision
::newNullRevision( $dbw, $this->testPage
->getId(), 'a null revision', false );
611 $this->assertNotEquals( $orig->getId(), $rev->getId(),
612 'new null revision should have a different id from the original revision' );
613 $this->assertEquals( $orig->getTextId(), $rev->getTextId(),
614 'new null revision should have the same text id as the original revision' );
615 $this->assertEquals( $orig->getSha1(), $rev->getSha1(),
616 'new null revision should have the same SHA1 as the original revision' );
617 $this->assertTrue( $orig->getRevisionRecord()->hasSameContent( $rev->getRevisionRecord() ),
618 'new null revision should have the same content as the original revision' );
619 $this->assertEquals( __METHOD__
, $rev->getContent()->getNativeData() );
623 * @covers Revision::insertOn
625 public function testInsertOn() {
626 $ip = '2600:387:ed7:947e:8c16:a1ad:dd34:1dd7';
628 $orig = $this->makeRevisionWithProps( [
632 // Make sure the revision was copied to ip_changes
633 $dbr = wfGetDB( DB_REPLICA
);
634 $res = $dbr->select( 'ip_changes', '*', [ 'ipc_rev_id' => $orig->getId() ] );
635 $row = $res->fetchObject();
637 $this->assertEquals( IP
::toHex( $ip ), $row->ipc_hex
);
639 $orig->getTimestamp(),
640 wfTimestamp( TS_MW
, $row->ipc_rev_timestamp
)
644 public static function provideUserWasLastToEdit() {
645 yield
'actually the last edit' => [ 3, true ];
646 yield
'not the current edit, but still by this user' => [ 2, true ];
647 yield
'edit by another user' => [ 1, false ];
648 yield
'first edit, by this user, but another user edited in the mean time' => [ 0, false ];
652 * @dataProvider provideUserWasLastToEdit
654 public function testUserWasLastToEdit( $sinceIdx, $expectedLast ) {
655 $userA = User
::newFromName( "RevisionStorageTest_userA" );
656 $userB = User
::newFromName( "RevisionStorageTest_userB" );
658 if ( $userA->getId() === 0 ) {
659 $userA = User
::createNew( $userA->getName() );
662 if ( $userB->getId() === 0 ) {
663 $userB = User
::createNew( $userB->getName() );
666 $ns = $this->getDefaultWikitextNS();
668 $dbw = wfGetDB( DB_MASTER
);
671 // create revisions -----------------------------
672 $page = WikiPage
::factory( Title
::newFromText(
673 'RevisionStorageTest_testUserWasLastToEdit', $ns ) );
674 $page->insertOn( $dbw );
676 $revisions[0] = new Revision( [
677 'page' => $page->getId(),
678 // we need the title to determine the page's default content model
679 'title' => $page->getTitle(),
680 'timestamp' => '20120101000000',
681 'user' => $userA->getId(),
683 'content_model' => CONTENT_MODEL_WIKITEXT
,
684 'comment' => 'edit zero'
686 $revisions[0]->insertOn( $dbw );
688 $revisions[1] = new Revision( [
689 'page' => $page->getId(),
690 // still need the title, because $page->getId() is 0 (there's no entry in the page table)
691 'title' => $page->getTitle(),
692 'timestamp' => '20120101000100',
693 'user' => $userA->getId(),
695 'content_model' => CONTENT_MODEL_WIKITEXT
,
696 'comment' => 'edit one'
698 $revisions[1]->insertOn( $dbw );
700 $revisions[2] = new Revision( [
701 'page' => $page->getId(),
702 'title' => $page->getTitle(),
703 'timestamp' => '20120101000200',
704 'user' => $userB->getId(),
706 'content_model' => CONTENT_MODEL_WIKITEXT
,
707 'comment' => 'edit two'
709 $revisions[2]->insertOn( $dbw );
711 $revisions[3] = new Revision( [
712 'page' => $page->getId(),
713 'title' => $page->getTitle(),
714 'timestamp' => '20120101000300',
715 'user' => $userA->getId(),
717 'content_model' => CONTENT_MODEL_WIKITEXT
,
718 'comment' => 'edit three'
720 $revisions[3]->insertOn( $dbw );
722 $revisions[4] = new Revision( [
723 'page' => $page->getId(),
724 'title' => $page->getTitle(),
725 'timestamp' => '20120101000200',
726 'user' => $userA->getId(),
728 'content_model' => CONTENT_MODEL_WIKITEXT
,
729 'comment' => 'edit four'
731 $revisions[4]->insertOn( $dbw );
733 // test it ---------------------------------
734 $since = $revisions[$sinceIdx]->getTimestamp();
736 $allRows = iterator_to_array( $dbw->select(
738 [ 'rev_id', 'rev_timestamp', 'rev_user' ],
740 'rev_page' => $page->getId(),
741 //'rev_timestamp > ' . $dbw->addQuotes( $dbw->timestamp( $since ) )
744 [ 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 50 ]
747 $wasLast = Revision
::userWasLastToEdit( $dbw, $page->getId(), $userA->getId(), $since );
749 $this->assertEquals( $expectedLast, $wasLast );
753 * @param string $text
754 * @param string $title
755 * @param string $model
756 * @param string $format
760 private function newTestRevision( $text, $title = "Test",
761 $model = CONTENT_MODEL_WIKITEXT
, $format = null
763 if ( is_string( $title ) ) {
764 $title = Title
::newFromText( $title );
767 $content = ContentHandler
::makeContent( $text, $title, $model, $format );
775 'content' => $content,
776 'length' => $content->getSize(),
777 'comment' => "testing",
778 'minor_edit' => false,
780 'content_format' => $format,
787 public function provideGetContentModel() {
788 // NOTE: we expect the help namespace to always contain wikitext
790 [ 'hello world', 'Help:Hello', null, null, CONTENT_MODEL_WIKITEXT
],
791 [ 'hello world', 'User:hello/there.css', null, null, CONTENT_MODEL_CSS
],
792 [ serialize( 'hello world' ), 'Dummy:Hello', null, null, DummyContentForTesting
::MODEL_ID
],
797 * @dataProvider provideGetContentModel
798 * @covers Revision::getContentModel
800 public function testGetContentModel( $text, $title, $model, $format, $expectedModel ) {
801 $rev = $this->newTestRevision( $text, $title, $model, $format );
803 $this->assertEquals( $expectedModel, $rev->getContentModel() );
806 public function provideGetContentFormat() {
807 // NOTE: we expect the help namespace to always contain wikitext
809 [ 'hello world', 'Help:Hello', null, null, CONTENT_FORMAT_WIKITEXT
],
810 [ 'hello world', 'Help:Hello', CONTENT_MODEL_CSS
, null, CONTENT_FORMAT_CSS
],
811 [ 'hello world', 'User:hello/there.css', null, null, CONTENT_FORMAT_CSS
],
812 [ serialize( 'hello world' ), 'Dummy:Hello', null, null, DummyContentForTesting
::MODEL_ID
],
817 * @dataProvider provideGetContentFormat
818 * @covers Revision::getContentFormat
820 public function testGetContentFormat( $text, $title, $model, $format, $expectedFormat ) {
821 $rev = $this->newTestRevision( $text, $title, $model, $format );
823 $this->assertEquals( $expectedFormat, $rev->getContentFormat() );
826 public function provideGetContentHandler() {
827 // NOTE: we expect the help namespace to always contain wikitext
829 [ 'hello world', 'Help:Hello', null, null, 'WikitextContentHandler' ],
830 [ 'hello world', 'User:hello/there.css', null, null, 'CssContentHandler' ],
831 [ serialize( 'hello world' ), 'Dummy:Hello', null, null, 'DummyContentHandlerForTesting' ],
836 * @dataProvider provideGetContentHandler
837 * @covers Revision::getContentHandler
839 public function testGetContentHandler( $text, $title, $model, $format, $expectedClass ) {
840 $rev = $this->newTestRevision( $text, $title, $model, $format );
842 $this->assertEquals( $expectedClass, get_class( $rev->getContentHandler() ) );
845 public function provideGetContent() {
846 // NOTE: we expect the help namespace to always contain wikitext
848 [ 'hello world', 'Help:Hello', null, null, Revision
::FOR_PUBLIC
, 'hello world' ],
850 serialize( 'hello world' ),
852 DummyContentForTesting
::MODEL_ID
,
854 Revision
::FOR_PUBLIC
,
855 serialize( 'hello world' )
858 serialize( 'hello world' ),
862 Revision
::FOR_PUBLIC
,
863 serialize( 'hello world' )
869 * @dataProvider provideGetContent
870 * @covers Revision::getContent
872 public function testGetContent( $text, $title, $model, $format,
873 $audience, $expectedSerialization
875 $rev = $this->newTestRevision( $text, $title, $model, $format );
876 $content = $rev->getContent( $audience );
879 $expectedSerialization,
880 is_null( $content ) ?
null : $content->serialize( $format )
885 * @covers Revision::getContent
887 public function testGetContent_failure() {
888 $rev = new Revision( [
889 'page' => $this->testPage
->getId(),
890 'content_model' => $this->testPage
->getContentModel(),
891 'text_id' => 123456789, // not in the test DB
894 MediaWiki\
suppressWarnings(); // bad text_id will trigger a warning.
896 $this->assertNull( $rev->getContent(),
897 "getContent() should return null if the revision's text blob could not be loaded." );
899 // NOTE: check this twice, once for lazy initialization, and once with the cached value.
900 $this->assertNull( $rev->getContent(),
901 "getContent() should return null if the revision's text blob could not be loaded." );
903 MediaWiki\
suppressWarnings( 'end' );
906 public function provideGetSize() {
908 [ "hello world.", CONTENT_MODEL_WIKITEXT
, 12 ],
909 [ serialize( "hello world." ), DummyContentForTesting
::MODEL_ID
, 12 ],
914 * @covers Revision::getSize
915 * @dataProvider provideGetSize
917 public function testGetSize( $text, $model, $expected_size ) {
918 $rev = $this->newTestRevision( $text, 'RevisionTest_testGetSize', $model );
919 $this->assertEquals( $expected_size, $rev->getSize() );
922 public function provideGetSha1() {
924 [ "hello world.", CONTENT_MODEL_WIKITEXT
, Revision
::base36Sha1( "hello world." ) ],
926 serialize( "hello world." ),
927 DummyContentForTesting
::MODEL_ID
,
928 Revision
::base36Sha1( serialize( "hello world." ) )
934 * @covers Revision::getSha1
935 * @dataProvider provideGetSha1
937 public function testGetSha1( $text, $model, $expected_hash ) {
938 $rev = $this->newTestRevision( $text, 'RevisionTest_testGetSha1', $model );
939 $this->assertEquals( $expected_hash, $rev->getSha1() );
943 * Tests whether $rev->getContent() returns a clone when needed.
945 * @covers Revision::getContent
947 public function testGetContentClone() {
948 $content = new RevisionTestModifyableContent( "foo" );
954 'title' => Title
::newFromText( "testGetContentClone_dummy" ),
956 'content' => $content,
957 'length' => $content->getSize(),
958 'comment' => "testing",
959 'minor_edit' => false,
963 /** @var RevisionTestModifyableContent $content */
964 $content = $rev->getContent( Revision
::RAW
);
965 $content->setText( "bar" );
967 /** @var RevisionTestModifyableContent $content2 */
968 $content2 = $rev->getContent( Revision
::RAW
);
969 // content is mutable, expect clone
970 $this->assertNotSame( $content, $content2, "expected a clone" );
971 // clone should contain the original text
972 $this->assertEquals( "foo", $content2->getText() );
974 $content2->setText( "bla bla" );
975 // clones should be independent
976 $this->assertEquals( "bar", $content->getText() );
980 * Tests whether $rev->getContent() returns the same object repeatedly if appropriate.
981 * @covers Revision::getContent
983 public function testGetContentUncloned() {
984 $rev = $this->newTestRevision( "hello", "testGetContentUncloned_dummy", CONTENT_MODEL_WIKITEXT
);
985 $content = $rev->getContent( Revision
::RAW
);
986 $content2 = $rev->getContent( Revision
::RAW
);
988 // for immutable content like wikitext, this should be the same object
989 $this->assertSame( $content, $content2 );
993 * @covers Revision::loadFromId
995 public function testLoadFromId() {
996 $rev = $this->testPage
->getRevision();
997 $this->hideDeprecated( 'Revision::loadFromId' );
998 $this->assertRevEquals(
1000 Revision
::loadFromId( wfGetDB( DB_MASTER
), $rev->getId() )
1005 * @covers Revision::loadFromPageId
1007 public function testLoadFromPageId() {
1008 $this->assertRevEquals(
1009 $this->testPage
->getRevision(),
1010 Revision
::loadFromPageId( wfGetDB( DB_MASTER
), $this->testPage
->getId() )
1015 * @covers Revision::loadFromPageId
1017 public function testLoadFromPageIdWithLatestRevId() {
1018 $this->assertRevEquals(
1019 $this->testPage
->getRevision(),
1020 Revision
::loadFromPageId(
1021 wfGetDB( DB_MASTER
),
1022 $this->testPage
->getId(),
1023 $this->testPage
->getLatest()
1029 * @covers Revision::loadFromPageId
1031 public function testLoadFromPageIdWithNotLatestRevId() {
1032 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
1033 $this->assertRevEquals(
1034 $this->testPage
->getRevision()->getPrevious(),
1035 Revision
::loadFromPageId(
1036 wfGetDB( DB_MASTER
),
1037 $this->testPage
->getId(),
1038 $this->testPage
->getRevision()->getPrevious()->getId()
1044 * @covers Revision::loadFromTitle
1046 public function testLoadFromTitle() {
1047 $this->assertRevEquals(
1048 $this->testPage
->getRevision(),
1049 Revision
::loadFromTitle( wfGetDB( DB_MASTER
), $this->testPage
->getTitle() )
1054 * @covers Revision::loadFromTitle
1056 public function testLoadFromTitleWithLatestRevId() {
1057 $this->assertRevEquals(
1058 $this->testPage
->getRevision(),
1059 Revision
::loadFromTitle(
1060 wfGetDB( DB_MASTER
),
1061 $this->testPage
->getTitle(),
1062 $this->testPage
->getLatest()
1068 * @covers Revision::loadFromTitle
1070 public function testLoadFromTitleWithNotLatestRevId() {
1071 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
1072 $this->assertRevEquals(
1073 $this->testPage
->getRevision()->getPrevious(),
1074 Revision
::loadFromTitle(
1075 wfGetDB( DB_MASTER
),
1076 $this->testPage
->getTitle(),
1077 $this->testPage
->getRevision()->getPrevious()->getId()
1083 * @covers Revision::loadFromTimestamp()
1085 public function testLoadFromTimestamp() {
1086 $this->assertRevEquals(
1087 $this->testPage
->getRevision(),
1088 Revision
::loadFromTimestamp(
1089 wfGetDB( DB_MASTER
),
1090 $this->testPage
->getTitle(),
1091 $this->testPage
->getRevision()->getTimestamp()
1097 * @covers Revision::getParentLengths
1099 public function testGetParentLengths_noRevIds() {
1102 Revision
::getParentLengths(
1103 wfGetDB( DB_MASTER
),
1110 * @covers Revision::getParentLengths
1112 public function testGetParentLengths_oneRevId() {
1113 $text = '831jr091jr0921kr21kr0921kjr0921j09rj1';
1114 $textLength = strlen( $text );
1116 $this->testPage
->doEditContent( new WikitextContent( $text ), __METHOD__
);
1117 $rev[1] = $this->testPage
->getLatest();
1120 [ $rev[1] => $textLength ],
1121 Revision
::getParentLengths(
1122 wfGetDB( DB_MASTER
),
1129 * @covers Revision::getParentLengths
1131 public function testGetParentLengths_multipleRevIds() {
1132 $textOne = '831jr091jr0921kr21kr0921kjr0921j09rj1';
1133 $textOneLength = strlen( $textOne );
1134 $textTwo = '831jr091jr092121j09rj1';
1135 $textTwoLength = strlen( $textTwo );
1137 $this->testPage
->doEditContent( new WikitextContent( $textOne ), __METHOD__
);
1138 $rev[1] = $this->testPage
->getLatest();
1139 $this->testPage
->doEditContent( new WikitextContent( $textTwo ), __METHOD__
);
1140 $rev[2] = $this->testPage
->getLatest();
1143 [ $rev[1] => $textOneLength, $rev[2] => $textTwoLength ],
1144 Revision
::getParentLengths(
1145 wfGetDB( DB_MASTER
),
1146 [ $rev[1], $rev[2] ]
1152 * @covers Revision::getTitle
1154 public function testGetTitle_fromExistingRevision() {
1156 $this->testPage
->getTitle()->equals(
1157 $this->testPage
->getRevision()->getTitle()
1163 * @covers Revision::getTitle
1165 public function testGetTitle_fromRevisionWhichWillLoadTheTitle() {
1166 $rev = new Revision( [ 'id' => $this->testPage
->getLatest() ] );
1168 $this->testPage
->getTitle()->equals(
1175 * @covers Revision::isMinor
1177 public function testIsMinor_true() {
1178 // Use a sysop to ensure we can mark edits as minor
1179 $sysop = $this->getTestSysop()->getUser();
1181 $this->testPage
->doEditContent(
1182 new WikitextContent( __METHOD__
),
1188 $rev = $this->testPage
->getRevision();
1190 $this->assertSame( true, $rev->isMinor() );
1194 * @covers Revision::isMinor
1196 public function testIsMinor_false() {
1197 $this->testPage
->doEditContent(
1198 new WikitextContent( __METHOD__
),
1202 $rev = $this->testPage
->getRevision();
1204 $this->assertSame( false, $rev->isMinor() );
1208 * @covers Revision::getTimestamp
1210 public function testGetTimestamp() {
1211 $testTimestamp = wfTimestampNow();
1213 $this->testPage
->doEditContent(
1214 new WikitextContent( __METHOD__
),
1217 $rev = $this->testPage
->getRevision();
1219 $this->assertInternalType( 'string', $rev->getTimestamp() );
1220 $this->assertTrue( strlen( $rev->getTimestamp() ) == strlen( 'YYYYMMDDHHMMSS' ) );
1221 $this->assertContains( substr( $testTimestamp, 0, 10 ), $rev->getTimestamp() );
1225 * @covers Revision::getUser
1226 * @covers Revision::getUserText
1228 public function testGetUserAndText() {
1229 $sysop = $this->getTestSysop()->getUser();
1231 $this->testPage
->doEditContent(
1232 new WikitextContent( __METHOD__
),
1238 $rev = $this->testPage
->getRevision();
1240 $this->assertSame( $sysop->getId(), $rev->getUser() );
1241 $this->assertSame( $sysop->getName(), $rev->getUserText() );
1245 * @covers Revision::isDeleted
1247 public function testIsDeleted_nothingDeleted() {
1248 $rev = $this->testPage
->getRevision();
1250 $this->assertSame( false, $rev->isDeleted( Revision
::DELETED_TEXT
) );
1251 $this->assertSame( false, $rev->isDeleted( Revision
::DELETED_COMMENT
) );
1252 $this->assertSame( false, $rev->isDeleted( Revision
::DELETED_RESTRICTED
) );
1253 $this->assertSame( false, $rev->isDeleted( Revision
::DELETED_USER
) );
1257 * @covers Revision::getVisibility
1259 public function testGetVisibility_nothingDeleted() {
1260 $rev = $this->testPage
->getRevision();
1262 $this->assertSame( 0, $rev->getVisibility() );
1266 * @covers Revision::getComment
1268 public function testGetComment_notDeleted() {
1269 $expectedSummary = 'goatlicious summary';
1271 $this->testPage
->doEditContent(
1272 new WikitextContent( __METHOD__
),
1275 $rev = $this->testPage
->getRevision();
1277 $this->assertSame( $expectedSummary, $rev->getComment() );
1281 * @covers Revision::isUnpatrolled
1283 public function testIsUnpatrolled_returnsRecentChangesId() {
1284 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
1285 $rev = $this->testPage
->getRevision();
1287 $this->assertGreaterThan( 0, $rev->isUnpatrolled() );
1288 $this->assertSame( $rev->getRecentChange()->getAttribute( 'rc_id' ), $rev->isUnpatrolled() );
1292 * @covers Revision::isUnpatrolled
1294 public function testIsUnpatrolled_returnsZeroIfPatrolled() {
1295 // This assumes that sysops are auto patrolled
1296 $sysop = $this->getTestSysop()->getUser();
1297 $this->testPage
->doEditContent(
1298 new WikitextContent( __METHOD__
),
1304 $rev = $this->testPage
->getRevision();
1306 $this->assertSame( 0, $rev->isUnpatrolled() );
1310 * This is a simple blanket test for all simple content getters and is methods to provide some
1311 * coverage before the split of Revision into multiple classes for MCR work.
1312 * @covers Revision::getContent
1313 * @covers Revision::getSerializedData
1314 * @covers Revision::getContentModel
1315 * @covers Revision::getContentFormat
1316 * @covers Revision::getContentHandler
1318 public function testSimpleContentGetters() {
1319 $expectedText = 'testSimpleContentGetters in Revision. Goats love MCR...';
1320 $expectedSummary = 'goatlicious testSimpleContentGetters summary';
1322 $this->testPage
->doEditContent(
1323 new WikitextContent( $expectedText ),
1326 $rev = $this->testPage
->getRevision();
1328 $this->assertSame( $expectedText, $rev->getContent()->getNativeData() );
1329 $this->assertSame( $expectedText, $rev->getSerializedData() );
1330 $this->assertSame( $this->testPage
->getContentModel(), $rev->getContentModel() );
1331 $this->assertSame( $this->testPage
->getContent()->getDefaultFormat(), $rev->getContentFormat() );
1332 $this->assertSame( $this->testPage
->getContentHandler(), $rev->getContentHandler() );
1336 * @covers Revision::newKnownCurrent
1338 public function testNewKnownCurrent() {
1339 // Setup the services
1340 $cache = new WANObjectCache( [ 'cache' => new HashBagOStuff() ] );
1341 $this->setService( 'MainWANObjectCache', $cache );
1342 $db = wfGetDB( DB_MASTER
);
1344 // Get a fresh revision to use during testing
1345 $this->testPage
->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
1346 $rev = $this->testPage
->getRevision();
1348 // Clear any previous cache for the revision during creation
1349 $key = $cache->makeGlobalKey( 'revision-row-1.29',
1354 $cache->delete( $key, WANObjectCache
::HOLDOFF_NONE
);
1355 $this->assertFalse( $cache->get( $key ) );
1357 // Get the new revision and make sure it is in the cache and correct
1358 $newRev = Revision
::newKnownCurrent( $db, $rev->getPage(), $rev->getId() );
1359 $this->assertRevEquals( $rev, $newRev );
1361 $cachedRow = $cache->get( $key );
1362 $this->assertNotFalse( $cachedRow );
1363 $this->assertEquals( $rev->getId(), $cachedRow->rev_id
);
1366 public function provideUserCanBitfield() {
1367 yield
[ 0, 0, [], null, true ];
1368 // Bitfields match, user has no permissions
1369 yield
[ Revision
::DELETED_TEXT
, Revision
::DELETED_TEXT
, [], null, false ];
1370 yield
[ Revision
::DELETED_COMMENT
, Revision
::DELETED_COMMENT
, [], null, false ];
1371 yield
[ Revision
::DELETED_USER
, Revision
::DELETED_USER
, [], null, false ];
1372 yield
[ Revision
::DELETED_RESTRICTED
, Revision
::DELETED_RESTRICTED
, [], null, false ];
1373 // Bitfields match, user (admin) does have permissions
1374 yield
[ Revision
::DELETED_TEXT
, Revision
::DELETED_TEXT
, [ 'sysop' ], null, true ];
1375 yield
[ Revision
::DELETED_COMMENT
, Revision
::DELETED_COMMENT
, [ 'sysop' ], null, true ];
1376 yield
[ Revision
::DELETED_USER
, Revision
::DELETED_USER
, [ 'sysop' ], null, true ];
1377 // Bitfields match, user (admin) does not have permissions
1378 yield
[ Revision
::DELETED_RESTRICTED
, Revision
::DELETED_RESTRICTED
, [ 'sysop' ], null, false ];
1379 // Bitfields match, user (oversight) does have permissions
1380 yield
[ Revision
::DELETED_RESTRICTED
, Revision
::DELETED_RESTRICTED
, [ 'oversight' ], null, true ];
1381 // Check permissions using the title
1383 Revision
::DELETED_TEXT
,
1384 Revision
::DELETED_TEXT
,
1386 Title
::newFromText( __METHOD__
),
1390 Revision
::DELETED_TEXT
,
1391 Revision
::DELETED_TEXT
,
1393 Title
::newFromText( __METHOD__
),
1399 * @dataProvider provideUserCanBitfield
1400 * @covers Revision::userCanBitfield
1402 public function testUserCanBitfield( $bitField, $field, $userGroups, $title, $expected ) {
1403 $this->setMwGlobals(
1404 'wgGroupPermissions',
1407 'deletedtext' => true,
1408 'deletedhistory' => true,
1411 'viewsuppressed' => true,
1412 'suppressrevision' => true,
1416 $user = $this->getTestUser( $userGroups )->getUser();
1420 Revision
::userCanBitfield( $bitField, $field, $user, $title )
1423 // Fallback to $wgUser
1424 $this->setMwGlobals(
1430 Revision
::userCanBitfield( $bitField, $field, null, $title )
1434 public function provideUserCan() {
1435 yield
[ 0, 0, [], true ];
1436 // Bitfields match, user has no permissions
1437 yield
[ Revision
::DELETED_TEXT
, Revision
::DELETED_TEXT
, [], false ];
1438 yield
[ Revision
::DELETED_COMMENT
, Revision
::DELETED_COMMENT
, [], false ];
1439 yield
[ Revision
::DELETED_USER
, Revision
::DELETED_USER
, [], false ];
1440 yield
[ Revision
::DELETED_RESTRICTED
, Revision
::DELETED_RESTRICTED
, [], false ];
1441 // Bitfields match, user (admin) does have permissions
1442 yield
[ Revision
::DELETED_TEXT
, Revision
::DELETED_TEXT
, [ 'sysop' ], true ];
1443 yield
[ Revision
::DELETED_COMMENT
, Revision
::DELETED_COMMENT
, [ 'sysop' ], true ];
1444 yield
[ Revision
::DELETED_USER
, Revision
::DELETED_USER
, [ 'sysop' ], true ];
1445 // Bitfields match, user (admin) does not have permissions
1446 yield
[ Revision
::DELETED_RESTRICTED
, Revision
::DELETED_RESTRICTED
, [ 'sysop' ], false ];
1447 // Bitfields match, user (oversight) does have permissions
1448 yield
[ Revision
::DELETED_RESTRICTED
, Revision
::DELETED_RESTRICTED
, [ 'oversight' ], true ];
1452 * @dataProvider provideUserCan
1453 * @covers Revision::userCan
1455 public function testUserCan( $bitField, $field, $userGroups, $expected ) {
1456 $this->setMwGlobals(
1457 'wgGroupPermissions',
1460 'deletedtext' => true,
1461 'deletedhistory' => true,
1464 'viewsuppressed' => true,
1465 'suppressrevision' => true,
1469 $user = $this->getTestUser( $userGroups )->getUser();
1470 $revision = new Revision( [ 'deleted' => $bitField ], 0, $this->testPage
->getTitle() );
1474 $revision->userCan( $field, $user )