7 * ^--- tell jenkins this test needs the database
10 * ^--- tell phpunit that these test cases may take longer than 2 seconds.
12 class EditPageTest
extends MediaWikiLangTestCase
{
14 protected function setUp() {
15 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
19 $this->setMwGlobals( [
20 'wgExtraNamespaces' => $wgExtraNamespaces,
21 'wgNamespaceContentModels' => $wgNamespaceContentModels,
22 'wgContentHandlers' => $wgContentHandlers,
23 'wgContLang' => $wgContLang,
26 $wgExtraNamespaces[12312] = 'Dummy';
27 $wgExtraNamespaces[12313] = 'Dummy_talk';
29 $wgNamespaceContentModels[12312] = "testing";
30 $wgContentHandlers["testing"] = 'DummyContentHandlerForTesting';
32 MWNamespace
::getCanonicalNamespaces( true ); # reset namespace cache
33 $wgContLang->resetNamespaces(); # reset namespace cache
37 * @dataProvider provideExtractSectionTitle
38 * @covers EditPage::extractSectionTitle
40 public function testExtractSectionTitle( $section, $title ) {
41 $extracted = EditPage
::extractSectionTitle( $section );
42 $this->assertEquals( $title, $extracted );
45 public static function provideExtractSectionTitle() {
48 "== Test ==\n\nJust a test section.",
52 "An initial section, no header.",
56 "An initial section with a fake heder (T34617)\n\n== Test == ??\nwtf",
60 "== Section ==\nfollowed by a fake == Non-section == ??\nnoooo",
64 "== Section== \t\r\n followed by whitespace (T37051)",
70 protected function forceRevisionDate( WikiPage
$page, $timestamp ) {
71 $dbw = wfGetDB( DB_MASTER
);
73 $dbw->update( 'revision',
74 [ 'rev_timestamp' => $dbw->timestamp( $timestamp ) ],
75 [ 'rev_id' => $page->getLatest() ] );
81 * User input text is passed to rtrim() by edit page. This is a simple
82 * wrapper around assertEquals() which calls rrtrim() to normalize the
83 * expected and actual texts.
84 * @param string $expected
85 * @param string $actual
88 protected function assertEditedTextEquals( $expected, $actual, $msg = '' ) {
89 $this->assertEquals( rtrim( $expected ), rtrim( $actual ), $msg );
93 * Performs an edit and checks the result.
95 * @param string|Title $title The title of the page to edit
96 * @param string|null $baseText Some text to create the page with before attempting the edit.
97 * @param User|string|null $user The user to perform the edit as.
98 * @param array $edit An array of request parameters used to define the edit to perform.
99 * Some well known fields are:
100 * * wpTextbox1: the text to submit
101 * * wpSummary: the edit summary
102 * * wpEditToken: the edit token (will be inserted if not provided)
103 * * wpEdittime: timestamp of the edit's base revision (will be inserted
105 * * wpStarttime: timestamp when the edit started (will be inserted if not provided)
106 * * wpSectionTitle: the section to edit
107 * * wpMinorEdit: mark as minor edit
108 * * wpWatchthis: whether to watch the page
109 * @param int|null $expectedCode The expected result code (EditPage::AS_XXX constants).
110 * Set to null to skip the check.
111 * @param string|null $expectedText The text expected to be on the page after the edit.
112 * Set to null to skip the check.
113 * @param string|null $message An optional message to show along with any error message.
115 * @return WikiPage The page that was just edited, useful for getting the edit's rev_id, etc.
117 protected function assertEdit( $title, $baseText, $user = null, array $edit,
118 $expectedCode = null, $expectedText = null, $message = null
120 if ( is_string( $title ) ) {
121 $ns = $this->getDefaultWikitextNS();
122 $title = Title
::newFromText( $title, $ns );
124 $this->assertNotNull( $title );
126 if ( is_string( $user ) ) {
127 $user = User
::newFromName( $user );
129 if ( $user->getId() === 0 ) {
130 $user->addToDatabase();
134 $page = WikiPage
::factory( $title );
136 if ( $baseText !== null ) {
137 $content = ContentHandler
::makeContent( $baseText, $title );
138 $page->doEditContent( $content, "base text for test" );
139 $this->forceRevisionDate( $page, '20120101000000' );
143 $currentText = ContentHandler
::getContentText( $page->getContent() );
145 # EditPage rtrim() the user input, so we alter our expected text
147 $this->assertEditedTextEquals( $baseText, $currentText );
150 if ( $user == null ) {
151 $user = $GLOBALS['wgUser'];
153 $this->setMwGlobals( 'wgUser', $user );
156 if ( !isset( $edit['wpEditToken'] ) ) {
157 $edit['wpEditToken'] = $user->getEditToken();
160 if ( !isset( $edit['wpEdittime'] ) ) {
161 $edit['wpEdittime'] = $page->exists() ?
$page->getTimestamp() : '';
164 if ( !isset( $edit['wpStarttime'] ) ) {
165 $edit['wpStarttime'] = wfTimestampNow();
168 if ( !isset( $edit['wpUnicodeCheck'] ) ) {
169 $edit['wpUnicodeCheck'] = EditPage
::UNICODE_CHECK
;
172 $req = new FauxRequest( $edit, true ); // session ??
174 $article = new Article( $title );
175 $article->getContext()->setTitle( $title );
176 $ep = new EditPage( $article );
177 $ep->setContextTitle( $title );
178 $ep->importFormData( $req );
180 $bot = isset( $edit['bot'] ) ?
(bool)$edit['bot'] : false;
182 // this is where the edit happens!
183 // Note: don't want to use EditPage::AttemptSave, because it messes with $wgOut
184 // and throws exceptions like PermissionsError
185 $status = $ep->internalAttemptSave( $result, $bot );
187 if ( $expectedCode !== null ) {
189 $this->assertEquals( $expectedCode, $status->value
,
190 "Expected result code mismatch. $message" );
193 $page = WikiPage
::factory( $title );
195 if ( $expectedText !== null ) {
196 // check resulting page text
197 $content = $page->getContent();
198 $text = ContentHandler
::getContentText( $content );
200 # EditPage rtrim() the user input, so we alter our expected text
202 $this->assertEditedTextEquals( $expectedText, $text,
203 "Expected article text mismatch. $message" );
209 public static function provideCreatePages() {
211 [ 'expected article being created',
212 'EditPageTest_testCreatePage',
215 EditPage
::AS_SUCCESS_NEW_ARTICLE
,
218 [ 'expected article not being created if empty',
219 'EditPageTest_testCreatePage',
222 EditPage
::AS_BLANK_ARTICLE
,
225 [ 'expected MediaWiki: page being created',
229 EditPage
::AS_SUCCESS_NEW_ARTICLE
,
232 [ 'expected not-registered MediaWiki: page not being created if empty',
233 'MediaWiki:EditPageTest_testCreatePage',
236 EditPage
::AS_BLANK_ARTICLE
,
239 [ 'expected registered MediaWiki: page being created even if empty',
243 EditPage
::AS_SUCCESS_NEW_ARTICLE
,
246 [ 'expected registered MediaWiki: page whose default content is empty'
247 . ' not being created if empty',
248 'MediaWiki:Ipb-default-expiry',
251 EditPage
::AS_BLANK_ARTICLE
,
254 [ 'expected MediaWiki: page not being created if text equals default message',
258 EditPage
::AS_BLANK_ARTICLE
,
261 [ 'expected empty article being created',
262 'EditPageTest_testCreatePage',
265 EditPage
::AS_SUCCESS_NEW_ARTICLE
,
273 * @dataProvider provideCreatePages
276 public function testCreatePage(
277 $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank = false
281 $this->setMwGlobals( 'wgHooks', [
282 'PageContentInsertComplete' => [ function (
283 WikiPage
&$page, User
&$user, Content
$content,
284 $summary, $minor, $u1, $u2, &$flags, Revision
$revision
286 // types/refs checked
288 'PageContentSaveComplete' => [ function (
289 WikiPage
&$page, User
&$user, Content
$content,
290 $summary, $minor, $u1, $u2, &$flags, Revision
$revision,
291 Status
&$status, $baseRevId
292 ) use ( &$checkId ) {
293 $checkId = $status->value
['revision']->getId();
294 // types/refs checked
298 $edit = [ 'wpTextbox1' => $editText ];
299 if ( $ignoreBlank ) {
300 $edit['wpIgnoreBlankArticle'] = 1;
303 $page = $this->assertEdit( $pageTitle, null, $user, $edit, $expectedCode, $expectedText, $desc );
305 if ( $expectedCode != EditPage
::AS_BLANK_ARTICLE
) {
306 $latest = $page->getLatest();
307 $page->doDeleteArticleReal( $pageTitle );
309 $this->assertGreaterThan( 0, $latest, "Page revision ID updated in object" );
310 $this->assertEquals( $latest, $checkId, "Revision in Status for hook" );
315 * @dataProvider provideCreatePages
318 public function testCreatePageTrx(
319 $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank = false
322 $this->setMwGlobals( 'wgHooks', [
323 'PageContentInsertComplete' => [ function (
324 WikiPage
&$page, User
&$user, Content
$content,
325 $summary, $minor, $u1, $u2, &$flags, Revision
$revision
327 // types/refs checked
329 'PageContentSaveComplete' => [ function (
330 WikiPage
&$page, User
&$user, Content
$content,
331 $summary, $minor, $u1, $u2, &$flags, Revision
$revision,
332 Status
&$status, $baseRevId
333 ) use ( &$checkIds ) {
334 $checkIds[] = $status->value
['revision']->getId();
335 // types/refs checked
339 wfGetDB( DB_MASTER
)->begin( __METHOD__
);
341 $edit = [ 'wpTextbox1' => $editText ];
342 if ( $ignoreBlank ) {
343 $edit['wpIgnoreBlankArticle'] = 1;
346 $page = $this->assertEdit(
347 $pageTitle, null, $user, $edit, $expectedCode, $expectedText, $desc );
349 $pageTitle2 = (string)$pageTitle . '/x';
350 $page2 = $this->assertEdit(
351 $pageTitle2, null, $user, $edit, $expectedCode, $expectedText, $desc );
353 wfGetDB( DB_MASTER
)->commit( __METHOD__
);
355 $this->assertEquals( 0, DeferredUpdates
::pendingUpdatesCount(), 'No deferred updates' );
357 if ( $expectedCode != EditPage
::AS_BLANK_ARTICLE
) {
358 $latest = $page->getLatest();
359 $page->doDeleteArticleReal( $pageTitle );
361 $this->assertGreaterThan( 0, $latest, "Page #1 revision ID updated in object" );
362 $this->assertEquals( $latest, $checkIds[0], "Revision #1 in Status for hook" );
364 $latest2 = $page2->getLatest();
365 $page2->doDeleteArticleReal( $pageTitle2 );
367 $this->assertGreaterThan( 0, $latest2, "Page #2 revision ID updated in object" );
368 $this->assertEquals( $latest2, $checkIds[1], "Revision #2 in Status for hook" );
372 public function testUpdatePage() {
375 $this->setMwGlobals( 'wgHooks', [
376 'PageContentInsertComplete' => [ function (
377 WikiPage
&$page, User
&$user, Content
$content,
378 $summary, $minor, $u1, $u2, &$flags, Revision
$revision
380 // types/refs checked
382 'PageContentSaveComplete' => [ function (
383 WikiPage
&$page, User
&$user, Content
$content,
384 $summary, $minor, $u1, $u2, &$flags, Revision
$revision,
385 Status
&$status, $baseRevId
386 ) use ( &$checkIds ) {
387 $checkIds[] = $status->value
['revision']->getId();
388 // types/refs checked
394 'wpTextbox1' => $text,
395 'wpSummary' => 'first update',
398 $page = $this->assertEdit( 'EditPageTest_testUpdatePage', "zero", null, $edit,
399 EditPage
::AS_SUCCESS_UPDATE
, $text,
400 "expected successfull update with given text" );
401 $this->assertGreaterThan( 0, $checkIds[0], "First event rev ID set" );
403 $this->forceRevisionDate( $page, '20120101000000' );
407 'wpTextbox1' => $text,
408 'wpSummary' => 'second update',
411 $this->assertEdit( 'EditPageTest_testUpdatePage', null, null, $edit,
412 EditPage
::AS_SUCCESS_UPDATE
, $text,
413 "expected successfull update with given text" );
414 $this->assertGreaterThan( 0, $checkIds[1], "Second edit hook rev ID set" );
415 $this->assertGreaterThan( $checkIds[0], $checkIds[1], "Second event rev ID is higher" );
418 public function testUpdatePageTrx() {
421 'wpTextbox1' => $text,
422 'wpSummary' => 'first update',
425 $page = $this->assertEdit( 'EditPageTest_testTrxUpdatePage', "zero", null, $edit,
426 EditPage
::AS_SUCCESS_UPDATE
, $text,
427 "expected successfull update with given text" );
429 $this->forceRevisionDate( $page, '20120101000000' );
432 $this->setMwGlobals( 'wgHooks', [
433 'PageContentSaveComplete' => [ function (
434 WikiPage
&$page, User
&$user, Content
$content,
435 $summary, $minor, $u1, $u2, &$flags, Revision
$revision,
436 Status
&$status, $baseRevId
437 ) use ( &$checkIds ) {
438 $checkIds[] = $status->value
['revision']->getId();
439 // types/refs checked
443 wfGetDB( DB_MASTER
)->begin( __METHOD__
);
447 'wpTextbox1' => $text,
448 'wpSummary' => 'second update',
451 $this->assertEdit( 'EditPageTest_testTrxUpdatePage', null, null, $edit,
452 EditPage
::AS_SUCCESS_UPDATE
, $text,
453 "expected successfull update with given text" );
457 'wpTextbox1' => $text,
458 'wpSummary' => 'third update',
461 $this->assertEdit( 'EditPageTest_testTrxUpdatePage', null, null, $edit,
462 EditPage
::AS_SUCCESS_UPDATE
, $text,
463 "expected successfull update with given text" );
465 wfGetDB( DB_MASTER
)->commit( __METHOD__
);
467 $this->assertGreaterThan( 0, $checkIds[0], "First event rev ID set" );
468 $this->assertGreaterThan( 0, $checkIds[1], "Second edit hook rev ID set" );
469 $this->assertGreaterThan( $checkIds[0], $checkIds[1], "Second event rev ID is higher" );
472 public static function provideSectionEdit() {
482 $sectionOne = '== one ==
486 $newSection = '== new section ==
491 $textWithNewSectionOne = preg_replace(
492 '/== one ==.*== two ==/ms',
493 "$sectionOne\n== two ==", $text
496 $textWithNewSectionAdded = "$text\n$newSection";
511 'replace first section',
512 $textWithNewSectionOne,
520 $textWithNewSectionAdded,
526 * @dataProvider provideSectionEdit
529 public function testSectionEdit( $base, $section, $text, $summary, $expected ) {
531 'wpTextbox1' => $text,
532 'wpSummary' => $summary,
533 'wpSection' => $section,
536 $this->assertEdit( 'EditPageTest_testSectionEdit', $base, null, $edit,
537 EditPage
::AS_SUCCESS_UPDATE
, $expected,
538 "expected successfull update of section" );
541 public static function provideAutoMerge() {
544 $tests[] = [ # 0: plain conflict
545 "Elmo", # base edit user
546 "one\n\ntwo\n\nthree\n",
549 'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
553 'wpTextbox1' => "(one)\n\ntwo\n\nthree\n",
555 EditPage
::AS_CONFLICT_DETECTED
, # expected code
556 "ONE\n\ntwo\n\nthree\n", # expected text
557 'expected edit conflict', # message
560 $tests[] = [ # 1: successful merge
561 "Elmo", # base edit user
562 "one\n\ntwo\n\nthree\n",
565 'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
569 'wpTextbox1' => "one\n\ntwo\n\nTHREE\n",
571 EditPage
::AS_SUCCESS_UPDATE
, # expected code
572 "ONE\n\ntwo\n\nTHREE\n", # expected text
573 'expected automatic merge', # message
577 $text .= "== first section ==\n\n";
578 $text .= "one\n\ntwo\n\nthree\n\n";
579 $text .= "== second section ==\n\n";
580 $text .= "four\n\nfive\n\nsix\n\n";
582 // extract the first section.
583 $section = preg_replace( '/.*(== first section ==.*)== second section ==.*/sm', '$1', $text );
585 // generate expected text after merge
586 $expected = str_replace( 'one', 'ONE', str_replace( 'three', 'THREE', $text ) );
588 $tests[] = [ # 2: merge in section
589 "Elmo", # base edit user
593 'wpTextbox1' => str_replace( 'one', 'ONE', $section ),
598 'wpTextbox1' => str_replace( 'three', 'THREE', $section ),
601 EditPage
::AS_SUCCESS_UPDATE
, # expected code
602 $expected, # expected text
603 'expected automatic section merge', # message
606 // see whether it makes a difference who did the base edit
607 $testsWithAdam = array_map( function ( $test ) {
608 $test[0] = 'Adam'; // change base edit user
612 $testsWithBerta = array_map( function ( $test ) {
613 $test[0] = 'Berta'; // change base edit user
617 return array_merge( $tests, $testsWithAdam, $testsWithBerta );
621 * @dataProvider provideAutoMerge
624 public function testAutoMerge( $baseUser, $text, $adamsEdit, $bertasEdit,
625 $expectedCode, $expectedText, $message = null
627 $this->markTestSkippedIfNoDiff3();
630 $ns = $this->getDefaultWikitextNS();
631 $title = Title
::newFromText( 'EditPageTest_testAutoMerge', $ns );
632 $page = WikiPage
::factory( $title );
634 if ( $page->exists() ) {
635 $page->doDeleteArticle( "clean slate for testing" );
639 'wpTextbox1' => $text,
642 $page = $this->assertEdit( 'EditPageTest_testAutoMerge', null,
643 $baseUser, $baseEdit, null, null, __METHOD__
);
645 $this->forceRevisionDate( $page, '20120101000000' );
647 $edittime = $page->getTimestamp();
649 // start timestamps for conflict detection
650 if ( !isset( $adamsEdit['wpStarttime'] ) ) {
651 $adamsEdit['wpStarttime'] = 1;
654 if ( !isset( $bertasEdit['wpStarttime'] ) ) {
655 $bertasEdit['wpStarttime'] = 2;
658 $starttime = wfTimestampNow();
659 $adamsTime = wfTimestamp(
661 (int)wfTimestamp( TS_UNIX
, $starttime ) +
(int)$adamsEdit['wpStarttime']
663 $bertasTime = wfTimestamp(
665 (int)wfTimestamp( TS_UNIX
, $starttime ) +
(int)$bertasEdit['wpStarttime']
668 $adamsEdit['wpStarttime'] = $adamsTime;
669 $bertasEdit['wpStarttime'] = $bertasTime;
671 $adamsEdit['wpSummary'] = 'Adam\'s edit';
672 $bertasEdit['wpSummary'] = 'Bertas\'s edit';
674 $adamsEdit['wpEdittime'] = $edittime;
675 $bertasEdit['wpEdittime'] = $edittime;
678 $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Adam', $adamsEdit,
679 EditPage
::AS_SUCCESS_UPDATE
, null, "expected successfull update" );
682 $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Berta', $bertasEdit,
683 $expectedCode, $expectedText, $message );
687 * @depends testAutoMerge
689 public function testCheckDirectEditingDisallowed_forNonTextContent() {
690 $title = Title
::newFromText( 'Dummy:NonTextPageForEditPage' );
691 $page = WikiPage
::factory( $title );
693 $article = new Article( $title );
694 $article->getContext()->setTitle( $title );
695 $ep = new EditPage( $article );
696 $ep->setContextTitle( $title );
698 $user = $GLOBALS['wgUser'];
701 'wpTextbox1' => serialize( 'non-text content' ),
702 'wpEditToken' => $user->getEditToken(),
704 'wpStarttime' => wfTimestampNow(),
705 'wpUnicodeCheck' => EditPage
::UNICODE_CHECK
,
708 $req = new FauxRequest( $edit, true );
709 $ep->importFormData( $req );
711 $this->setExpectedException(
713 'This content model is not supported: testing'
716 $ep->internalAttemptSave( $result, false );