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
{
15 * @dataProvider provideExtractSectionTitle
16 * @covers EditPage::extractSectionTitle
18 public function testExtractSectionTitle( $section, $title ) {
19 $extracted = EditPage
::extractSectionTitle( $section );
20 $this->assertEquals( $title, $extracted );
23 public static function provideExtractSectionTitle() {
26 "== Test ==\n\nJust a test section.",
30 "An initial section, no header.",
34 "An initial section with a fake heder (bug 32617)\n\n== Test == ??\nwtf",
38 "== Section ==\nfollowed by a fake == Non-section == ??\nnoooo",
42 "== Section== \t\r\n followed by whitespace (bug 35051)",
48 protected function forceRevisionDate( WikiPage
$page, $timestamp ) {
49 $dbw = wfGetDB( DB_MASTER
);
51 $dbw->update( 'revision',
52 array( 'rev_timestamp' => $dbw->timestamp( $timestamp ) ),
53 array( 'rev_id' => $page->getLatest() ) );
59 * User input text is passed to rtrim() by edit page. This is a simple
60 * wrapper around assertEquals() which calls rrtrim() to normalize the
61 * expected and actual texts.
63 protected function assertEditedTextEquals( $expected, $actual, $msg = '' ) {
64 return $this->assertEquals( rtrim( $expected ), rtrim( $actual ), $msg );
68 * Performs an edit and checks the result.
70 * @param String|Title $title The title of the page to edit
71 * @param String|null $baseText Some text to create the page with before attempting the edit.
72 * @param User|String|null $user The user to perform the edit as.
73 * @param array $edit An array of request parameters used to define the edit to perform.
74 * Some well known fields are:
75 * * wpTextbox1: the text to submit
76 * * wpSummary: the edit summary
77 * * wpEditToken: the edit token (will be inserted if not provided)
78 * * wpEdittime: timestamp of the edit's base revision (will be inserted if not provided)
79 * * wpStarttime: timestamp when the edit started (will be inserted if not provided)
80 * * wpSectionTitle: the section to edit
81 * * wpMinorEdit: mark as minor edit
82 * * wpWatchthis: whether to watch the page
83 * @param int|null $expectedCode The expected result code (EditPage::AS_XXX constants).
84 * Set to null to skip the check. Defaults to EditPage::AS_OK.
85 * @param String|null $expectedText The text expected to be on the page after the edit.
86 * Set to null to skip the check.
87 * @param String|null $message An optional message to show along with any error message.
89 * @return WikiPage The page that was just edited, useful for getting the edit's rev_id, etc.
91 protected function assertEdit( $title, $baseText, $user = null, array $edit,
92 $expectedCode = EditPage
::AS_OK
, $expectedText = null, $message = null
94 if ( is_string( $title ) ) {
95 $ns = $this->getDefaultWikitextNS();
96 $title = Title
::newFromText( $title, $ns );
99 if ( is_string( $user ) ) {
100 $user = User
::newFromName( $user );
102 if ( $user->getId() === 0 ) {
103 $user->addToDatabase();
107 $page = WikiPage
::factory( $title );
109 if ( $baseText !== null ) {
110 $content = ContentHandler
::makeContent( $baseText, $title );
111 $page->doEditContent( $content, "base text for test" );
112 $this->forceRevisionDate( $page, '20120101000000' );
116 $currentText = ContentHandler
::getContentText( $page->getContent() );
118 # EditPage rtrim() the user input, so we alter our expected text
120 $this->assertEditedTextEquals( $baseText, $currentText );
123 if ( $user == null ) {
124 $user = $GLOBALS['wgUser'];
126 $this->setMwGlobals( 'wgUser', $user );
129 if ( !isset( $edit['wpEditToken'] ) ) {
130 $edit['wpEditToken'] = $user->getEditToken();
133 if ( !isset( $edit['wpEdittime'] ) ) {
134 $edit['wpEdittime'] = $page->exists() ?
$page->getTimestamp() : '';
137 if ( !isset( $edit['wpStarttime'] ) ) {
138 $edit['wpStarttime'] = wfTimestampNow();
141 $req = new FauxRequest( $edit, true ); // session ??
143 $ep = new EditPage( new Article( $title ) );
144 $ep->setContextTitle( $title );
145 $ep->importFormData( $req );
147 $bot = isset( $edit['bot'] ) ?
(bool)$edit['bot'] : false;
149 // this is where the edit happens!
150 // Note: don't want to use EditPage::AttemptSave, because it messes with $wgOut
151 // and throws exceptions like PermissionsError
152 $status = $ep->internalAttemptSave( $result, $bot );
154 if ( $expectedCode !== null ) {
156 $this->assertEquals( $expectedCode, $status->value
,
157 "Expected result code mismatch. $message" );
160 $page = WikiPage
::factory( $title );
162 if ( $expectedText !== null ) {
163 // check resulting page text
164 $content = $page->getContent();
165 $text = ContentHandler
::getContentText( $content );
167 # EditPage rtrim() the user input, so we alter our expected text
169 $this->assertEditedTextEquals( $expectedText, $text,
170 "Expected article text mismatch. $message" );
177 * @todo split into a dataprovider and test method
180 public function testCreatePage() {
182 'EditPageTest_testCreatePage',
186 'wpTextbox1' => "Hello World!",
188 EditPage
::AS_SUCCESS_NEW_ARTICLE
,
190 "expected article being created"
191 )->doDeleteArticleReal( 'EditPageTest_testCreatePage' );
194 'EditPageTest_testCreatePage',
200 EditPage
::AS_BLANK_ARTICLE
,
202 "expected article not being created if empty"
210 'wpTextbox1' => "Not January",
212 EditPage
::AS_SUCCESS_NEW_ARTICLE
,
214 "expected MediaWiki: page being created"
215 )->doDeleteArticleReal( 'EditPageTest_testCreatePage' );
218 'MediaWiki:EditPageTest_testCreatePage',
224 EditPage
::AS_BLANK_ARTICLE
,
226 "expected not-registered MediaWiki: page not being created if empty"
236 EditPage
::AS_SUCCESS_NEW_ARTICLE
,
238 "expected registered MediaWiki: page being created even if empty"
239 )->doDeleteArticleReal( 'EditPageTest_testCreatePage' );
242 'MediaWiki:Ipb-default-expiry',
248 EditPage
::AS_BLANK_ARTICLE
,
250 "expected registered MediaWiki: page whose default content is empty not being created if empty"
258 'wpTextbox1' => "January",
260 EditPage
::AS_BLANK_ARTICLE
,
262 "expected MediaWiki: page not being created if text equals default message"
266 public function testUpdatePage() {
269 'wpTextbox1' => $text,
270 'wpSummary' => 'first update',
273 $page = $this->assertEdit( 'EditPageTest_testUpdatePage', "zero", null, $edit,
274 EditPage
::AS_SUCCESS_UPDATE
, $text,
275 "expected successfull update with given text" );
277 $this->forceRevisionDate( $page, '20120101000000' );
281 'wpTextbox1' => $text,
282 'wpSummary' => 'second update',
285 $this->assertEdit( 'EditPageTest_testUpdatePage', null, null, $edit,
286 EditPage
::AS_SUCCESS_UPDATE
, $text,
287 "expected successfull update with given text" );
290 public static function provideSectionEdit() {
300 $sectionOne = '== one ==
304 $newSection = '== new section ==
309 $textWithNewSectionOne = preg_replace(
310 '/== one ==.*== two ==/ms',
311 "$sectionOne\n== two ==", $text
314 $textWithNewSectionAdded = "$text\n$newSection";
329 'replace first section',
330 $textWithNewSectionOne,
338 $textWithNewSectionAdded,
344 * @dataProvider provideSectionEdit
347 public function testSectionEdit( $base, $section, $text, $summary, $expected ) {
349 'wpTextbox1' => $text,
350 'wpSummary' => $summary,
351 'wpSection' => $section,
354 $this->assertEdit( 'EditPageTest_testSectionEdit', $base, null, $edit,
355 EditPage
::AS_SUCCESS_UPDATE
, $expected,
356 "expected successfull update of section" );
359 public static function provideAutoMerge() {
362 $tests[] = array( #0: plain conflict
363 "Elmo", # base edit user
364 "one\n\ntwo\n\nthree\n",
367 'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
371 'wpTextbox1' => "(one)\n\ntwo\n\nthree\n",
373 EditPage
::AS_CONFLICT_DETECTED
, # expected code
374 "ONE\n\ntwo\n\nthree\n", # expected text
375 'expected edit conflict', # message
378 $tests[] = array( #1: successful merge
379 "Elmo", # base edit user
380 "one\n\ntwo\n\nthree\n",
383 'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
387 'wpTextbox1' => "one\n\ntwo\n\nTHREE\n",
389 EditPage
::AS_SUCCESS_UPDATE
, # expected code
390 "ONE\n\ntwo\n\nTHREE\n", # expected text
391 'expected automatic merge', # message
395 $text .= "== first section ==\n\n";
396 $text .= "one\n\ntwo\n\nthree\n\n";
397 $text .= "== second section ==\n\n";
398 $text .= "four\n\nfive\n\nsix\n\n";
400 // extract the first section.
401 $section = preg_replace( '/.*(== first section ==.*)== second section ==.*/sm', '$1', $text );
403 // generate expected text after merge
404 $expected = str_replace( 'one', 'ONE', str_replace( 'three', 'THREE', $text ) );
406 $tests[] = array( #2: merge in section
407 "Elmo", # base edit user
411 'wpTextbox1' => str_replace( 'one', 'ONE', $section ),
416 'wpTextbox1' => str_replace( 'three', 'THREE', $section ),
419 EditPage
::AS_SUCCESS_UPDATE
, # expected code
420 $expected, # expected text
421 'expected automatic section merge', # message
424 // see whether it makes a difference who did the base edit
425 $testsWithAdam = array_map( function ( $test ) {
426 $test[0] = 'Adam'; // change base edit user
430 $testsWithBerta = array_map( function ( $test ) {
431 $test[0] = 'Berta'; // change base edit user
435 return array_merge( $tests, $testsWithAdam, $testsWithBerta );
439 * @dataProvider provideAutoMerge
442 public function testAutoMerge( $baseUser, $text, $adamsEdit, $bertasEdit,
443 $expectedCode, $expectedText, $message = null
445 $this->checkHasDiff3();
448 $ns = $this->getDefaultWikitextNS();
449 $title = Title
::newFromText( 'EditPageTest_testAutoMerge', $ns );
450 $page = WikiPage
::factory( $title );
452 if ( $page->exists() ) {
453 $page->doDeleteArticle( "clean slate for testing" );
457 'wpTextbox1' => $text,
460 $page = $this->assertEdit( 'EditPageTest_testAutoMerge', null,
461 $baseUser, $baseEdit, null, null, __METHOD__
);
463 $this->forceRevisionDate( $page, '20120101000000' );
465 $edittime = $page->getTimestamp();
467 // start timestamps for conflict detection
468 if ( !isset( $adamsEdit['wpStarttime'] ) ) {
469 $adamsEdit['wpStarttime'] = 1;
472 if ( !isset( $bertasEdit['wpStarttime'] ) ) {
473 $bertasEdit['wpStarttime'] = 2;
476 $starttime = wfTimestampNow();
477 $adamsTime = wfTimestamp( TS_MW
, (int)wfTimestamp( TS_UNIX
, $starttime ) +
(int)$adamsEdit['wpStarttime'] );
478 $bertasTime = wfTimestamp( TS_MW
, (int)wfTimestamp( TS_UNIX
, $starttime ) +
(int)$bertasEdit['wpStarttime'] );
480 $adamsEdit['wpStarttime'] = $adamsTime;
481 $bertasEdit['wpStarttime'] = $bertasTime;
483 $adamsEdit['wpSummary'] = 'Adam\'s edit';
484 $bertasEdit['wpSummary'] = 'Bertas\'s edit';
486 $adamsEdit['wpEdittime'] = $edittime;
487 $bertasEdit['wpEdittime'] = $edittime;
490 $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Adam', $adamsEdit,
491 EditPage
::AS_SUCCESS_UPDATE
, null, "expected successfull update" );
494 $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Berta', $bertasEdit,
495 $expectedCode, $expectedText, $message );