rdbms: Rename "memCache" to "memStash" in LBFactory
[mediawiki.git] / tests / phpunit / includes / RevisionStorageTest.php
blob3ba82a6f59d9c09c1937a96f40531a643e3a722c
1 <?php
3 /**
4 * Test class for Revision storage.
6 * @group ContentHandler
7 * @group Database
8 * ^--- important, causes temporary tables to be used instead of the real database
10 * @group medium
11 * ^--- important, causes tests not to fail with timeout
13 class RevisionStorageTest extends MediaWikiTestCase {
14 /**
15 * @var WikiPage $the_page
17 private $the_page;
19 function __construct( $name = null, array $data = [], $dataName = '' ) {
20 parent::__construct( $name, $data, $dataName );
22 $this->tablesUsed = array_merge( $this->tablesUsed,
23 [ 'page',
24 'revision',
25 'text',
27 'recentchanges',
28 'logging',
30 'page_props',
31 'pagelinks',
32 'categorylinks',
33 'langlinks',
34 'externallinks',
35 'imagelinks',
36 'templatelinks',
37 'iwlinks' ] );
40 protected function setUp() {
41 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
43 parent::setUp();
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',
56 "just a dummy page",
57 CONTENT_MODEL_WIKITEXT
61 $this->tablesUsed[] = 'archive';
64 protected function tearDown() {
65 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
67 parent::tearDown();
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 ) {
81 $props = [];
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 );
101 return $rev;
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 );
127 return $page;
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_REPLICA );
149 $res = $dbr->select( 'revision', '*', [ 'rev_id' => $orig->getId() ] );
150 $this->assertTrue( is_object( $res ), 'query failed' );
152 $row = $res->fetchObject();
153 $res->free();
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_REPLICA );
167 $res = $dbr->select( 'revision', '*', [ 'rev_id' => $orig->getId() ] );
168 $this->assertTrue( is_object( $res ), 'query failed' );
170 $row = $res->fetchObject();
171 $res->free();
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',
184 'Lorem Ipsum',
185 CONTENT_MODEL_WIKITEXT
187 $orig = $page->getRevision();
188 $page->doDeleteArticle( 'test Revision::newFromArchiveRow' );
190 $dbr = wfGetDB( DB_REPLICA );
191 $res = $dbr->select( 'archive', '*', [ 'ar_rev_id' => $orig->getId() ] );
192 $this->assertTrue( is_object( $res ), 'query failed' );
194 $row = $res->fetchObject();
195 $res->free();
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',
219 'one',
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
232 $rows = [];
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' );
251 $this->assertTrue(
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::getContent
280 public function testGetContent_failure() {
281 $rev = new Revision( [
282 'page' => $this->the_page->getId(),
283 'content_model' => $this->the_page->getContentModel(),
284 'text_id' => 123456789, // not in the test DB
285 ] );
287 $this->assertNull( $rev->getContent(),
288 "getContent() should return null if the revision's text blob could not be loaded." );
290 // NOTE: check this twice, once for lazy initialization, and once with the cached value.
291 $this->assertNull( $rev->getContent(),
292 "getContent() should return null if the revision's text blob could not be loaded." );
296 * @covers Revision::getContent
298 public function testGetContent() {
299 $orig = $this->makeRevision( [ 'text' => 'hello hello.' ] );
300 $rev = Revision::newFromId( $orig->getId() );
302 $this->assertEquals( 'hello hello.', $rev->getContent()->getNativeData() );
306 * @covers Revision::getContentModel
308 public function testGetContentModel() {
309 global $wgContentHandlerUseDB;
311 if ( !$wgContentHandlerUseDB ) {
312 $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
315 $orig = $this->makeRevision( [ 'text' => 'hello hello.',
316 'content_model' => CONTENT_MODEL_JAVASCRIPT ] );
317 $rev = Revision::newFromId( $orig->getId() );
319 $this->assertEquals( CONTENT_MODEL_JAVASCRIPT, $rev->getContentModel() );
323 * @covers Revision::getContentFormat
325 public function testGetContentFormat() {
326 global $wgContentHandlerUseDB;
328 if ( !$wgContentHandlerUseDB ) {
329 $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
332 $orig = $this->makeRevision( [
333 'text' => 'hello hello.',
334 'content_model' => CONTENT_MODEL_JAVASCRIPT,
335 'content_format' => CONTENT_FORMAT_JAVASCRIPT
336 ] );
337 $rev = Revision::newFromId( $orig->getId() );
339 $this->assertEquals( CONTENT_FORMAT_JAVASCRIPT, $rev->getContentFormat() );
343 * @covers Revision::isCurrent
345 public function testIsCurrent() {
346 $page = $this->createPage(
347 'RevisionStorageTest_testIsCurrent',
348 'Lorem Ipsum',
349 CONTENT_MODEL_WIKITEXT
351 $rev1 = $page->getRevision();
353 # @todo find out if this should be true
354 # $this->assertTrue( $rev1->isCurrent() );
356 $rev1x = Revision::newFromId( $rev1->getId() );
357 $this->assertTrue( $rev1x->isCurrent() );
359 $page->doEditContent(
360 ContentHandler::makeContent( 'Bla bla', $page->getTitle(), CONTENT_MODEL_WIKITEXT ),
361 '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(
380 'RevisionStorageTest_testGetPrevious',
381 'Lorem Ipsum testGetPrevious',
382 CONTENT_MODEL_WIKITEXT
384 $rev1 = $page->getRevision();
386 $this->assertNull( $rev1->getPrevious() );
388 $page->doEditContent(
389 ContentHandler::makeContent( 'Bla bla', $page->getTitle(), CONTENT_MODEL_WIKITEXT ),
390 'second rev testGetPrevious' );
391 $rev2 = $page->getRevision();
393 $this->assertNotNull( $rev2->getPrevious() );
394 $this->assertEquals( $rev1->getId(), $rev2->getPrevious()->getId() );
398 * @covers Revision::getNext
400 public function testGetNext() {
401 $page = $this->createPage(
402 'RevisionStorageTest_testGetNext',
403 'Lorem Ipsum testGetNext',
404 CONTENT_MODEL_WIKITEXT
406 $rev1 = $page->getRevision();
408 $this->assertNull( $rev1->getNext() );
410 $page->doEditContent(
411 ContentHandler::makeContent( 'Bla bla', $page->getTitle(), CONTENT_MODEL_WIKITEXT ),
412 'second rev testGetNext'
414 $rev2 = $page->getRevision();
416 $this->assertNotNull( $rev1->getNext() );
417 $this->assertEquals( $rev2->getId(), $rev1->getNext()->getId() );
421 * @covers Revision::newNullRevision
423 public function testNewNullRevision() {
424 $page = $this->createPage(
425 'RevisionStorageTest_testNewNullRevision',
426 'some testing text',
427 CONTENT_MODEL_WIKITEXT
429 $orig = $page->getRevision();
431 $dbw = wfGetDB( DB_MASTER );
432 $rev = Revision::newNullRevision( $dbw, $page->getId(), 'a null revision', false );
434 $this->assertNotEquals( $orig->getId(), $rev->getId(),
435 'new null revision shold have a different id from the original revision' );
436 $this->assertEquals( $orig->getTextId(), $rev->getTextId(),
437 'new null revision shold have the same text id as the original revision' );
438 $this->assertEquals( 'some testing text', $rev->getContent()->getNativeData() );
441 public static function provideUserWasLastToEdit() {
442 return [
443 [ # 0
444 3, true, # actually the last edit
446 [ # 1
447 2, true, # not the current edit, but still by this user
449 [ # 2
450 1, false, # edit by another user
452 [ # 3
453 0, false, # first edit, by this user, but another user edited in the mean time
459 * @dataProvider provideUserWasLastToEdit
461 public function testUserWasLastToEdit( $sinceIdx, $expectedLast ) {
462 $userA = User::newFromName( "RevisionStorageTest_userA" );
463 $userB = User::newFromName( "RevisionStorageTest_userB" );
465 if ( $userA->getId() === 0 ) {
466 $userA = User::createNew( $userA->getName() );
469 if ( $userB->getId() === 0 ) {
470 $userB = User::createNew( $userB->getName() );
473 $ns = $this->getDefaultWikitextNS();
475 $dbw = wfGetDB( DB_MASTER );
476 $revisions = [];
478 // create revisions -----------------------------
479 $page = WikiPage::factory( Title::newFromText(
480 'RevisionStorageTest_testUserWasLastToEdit', $ns ) );
481 $page->insertOn( $dbw );
483 # zero
484 $revisions[0] = new Revision( [
485 'page' => $page->getId(),
486 // we need the title to determine the page's default content model
487 'title' => $page->getTitle(),
488 'timestamp' => '20120101000000',
489 'user' => $userA->getId(),
490 'text' => 'zero',
491 'content_model' => CONTENT_MODEL_WIKITEXT,
492 'summary' => 'edit zero'
493 ] );
494 $revisions[0]->insertOn( $dbw );
496 # one
497 $revisions[1] = new Revision( [
498 'page' => $page->getId(),
499 // still need the title, because $page->getId() is 0 (there's no entry in the page table)
500 'title' => $page->getTitle(),
501 'timestamp' => '20120101000100',
502 'user' => $userA->getId(),
503 'text' => 'one',
504 'content_model' => CONTENT_MODEL_WIKITEXT,
505 'summary' => 'edit one'
506 ] );
507 $revisions[1]->insertOn( $dbw );
509 # two
510 $revisions[2] = new Revision( [
511 'page' => $page->getId(),
512 'title' => $page->getTitle(),
513 'timestamp' => '20120101000200',
514 'user' => $userB->getId(),
515 'text' => 'two',
516 'content_model' => CONTENT_MODEL_WIKITEXT,
517 'summary' => 'edit two'
518 ] );
519 $revisions[2]->insertOn( $dbw );
521 # three
522 $revisions[3] = new Revision( [
523 'page' => $page->getId(),
524 'title' => $page->getTitle(),
525 'timestamp' => '20120101000300',
526 'user' => $userA->getId(),
527 'text' => 'three',
528 'content_model' => CONTENT_MODEL_WIKITEXT,
529 'summary' => 'edit three'
530 ] );
531 $revisions[3]->insertOn( $dbw );
533 # four
534 $revisions[4] = new Revision( [
535 'page' => $page->getId(),
536 'title' => $page->getTitle(),
537 'timestamp' => '20120101000200',
538 'user' => $userA->getId(),
539 'text' => 'zero',
540 'content_model' => CONTENT_MODEL_WIKITEXT,
541 'summary' => 'edit four'
542 ] );
543 $revisions[4]->insertOn( $dbw );
545 // test it ---------------------------------
546 $since = $revisions[$sinceIdx]->getTimestamp();
548 $wasLast = Revision::userWasLastToEdit( $dbw, $page->getId(), $userA->getId(), $since );
550 $this->assertEquals( $expectedLast, $wasLast );