tests/phpunit/includes/EditPageTest.php

   1 <?php
   2
   3 /**
   4  * @group Editing
   5  *
   6  * @group Database
   7  *        ^--- tell jenkins this test needs the database
   8  *
   9  * @group medium
  10  *        ^--- tell phpunit that these test cases may take longer than 2 seconds.
  11  */
  12 class EditPageTest extends MediaWikiLangTestCase {
  13
  14         /**
  15          * @dataProvider provideExtractSectionTitle
  16          * @covers EditPage::extractSectionTitle
  17          */
  18         public function testExtractSectionTitle( $section, $title ) {
  19                 $extracted = EditPage::extractSectionTitle( $section );
  20                 $this->assertEquals( $title, $extracted );
  21         }
  22
  23         public static function provideExtractSectionTitle() {
  24                 return array(
  25                         array(
  26                                 "== Test ==\n\nJust a test section.",
  27                                 "Test"
  28                         ),
  29                         array(
  30                                 "An initial section, no header.",
  31                                 false
  32                         ),
  33                         array(
  34                                 "An initial section with a fake heder (bug 32617)\n\n== Test == ??\nwtf",
  35                                 false
  36                         ),
  37                         array(
  38                                 "== Section ==\nfollowed by a fake == Non-section == ??\nnoooo",
  39                                 "Section"
  40                         ),
  41                         array(
  42                                 "== Section== \t\r\n followed by whitespace (bug 35051)",
  43                                 'Section',
  44                         ),
  45                 );
  46         }
  47
  48         protected function forceRevisionDate( WikiPage $page, $timestamp ) {
  49                 $dbw = wfGetDB( DB_MASTER );
  50
  51                 $dbw->update( 'revision',
  52                         array( 'rev_timestamp' => $dbw->timestamp( $timestamp ) ),
  53                         array( 'rev_id' => $page->getLatest() ) );
  54
  55                 $page->clear();
  56         }
  57
  58         /**
  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.
  62          * @param string $expected
  63          * @param string $actual
  64          * @param string $msg
  65          */
  66         protected function assertEditedTextEquals( $expected, $actual, $msg = '' ) {
  67                 return $this->assertEquals( rtrim( $expected ), rtrim( $actual ), $msg );
  68         }
  69
  70         /**
  71          * Performs an edit and checks the result.
  72          *
  73          * @param string|Title $title The title of the page to edit
  74          * @param string|null $baseText Some text to create the page with before attempting the edit.
  75          * @param User|string|null $user The user to perform the edit as.
  76          * @param array $edit An array of request parameters used to define the edit to perform.
  77          *              Some well known fields are:
  78          *              * wpTextbox1: the text to submit
  79          *              * wpSummary: the edit summary
  80          *              * wpEditToken: the edit token (will be inserted if not provided)
  81          *              * wpEdittime: timestamp of the edit's base revision (will be inserted
  82          *                if not provided)
  83          *              * wpStarttime: timestamp when the edit started (will be inserted if not provided)
  84          *              * wpSectionTitle: the section to edit
  85          *              * wpMinorEdit: mark as minor edit
  86          *              * wpWatchthis: whether to watch the page
  87          * @param int|null $expectedCode The expected result code (EditPage::AS_XXX constants).
  88          *                  Set to null to skip the check.
  89          * @param string|null $expectedText The text expected to be on the page after the edit.
  90          *                  Set to null to skip the check.
  91          * @param string|null $message An optional message to show along with any error message.
  92          *
  93          * @return WikiPage The page that was just edited, useful for getting the edit's rev_id, etc.
  94          */
  95         protected function assertEdit( $title, $baseText, $user = null, array $edit,
  96                 $expectedCode = null, $expectedText = null, $message = null
  97         ) {
  98                 if ( is_string( $title ) ) {
  99                         $ns = $this->getDefaultWikitextNS();
 100                         $title = Title::newFromText( $title, $ns );
 101                 }
 102                 $this->assertNotNull( $title );
 103
 104                 if ( is_string( $user ) ) {
 105                         $user = User::newFromName( $user );
 106
 107                         if ( $user->getId() === 0 ) {
 108                                 $user->addToDatabase();
 109                         }
 110                 }
 111
 112                 $page = WikiPage::factory( $title );
 113
 114                 if ( $baseText !== null ) {
 115                         $content = ContentHandler::makeContent( $baseText, $title );
 116                         $page->doEditContent( $content, "base text for test" );
 117                         $this->forceRevisionDate( $page, '20120101000000' );
 118
 119                         //sanity check
 120                         $page->clear();
 121                         $currentText = ContentHandler::getContentText( $page->getContent() );
 122
 123                         # EditPage rtrim() the user input, so we alter our expected text
 124                         # to reflect that.
 125                         $this->assertEditedTextEquals( $baseText, $currentText );
 126                 }
 127
 128                 if ( $user == null ) {
 129                         $user = $GLOBALS['wgUser'];
 130                 } else {
 131                         $this->setMwGlobals( 'wgUser', $user );
 132                 }
 133
 134                 if ( !isset( $edit['wpEditToken'] ) ) {
 135                         $edit['wpEditToken'] = $user->getEditToken();
 136                 }
 137
 138                 if ( !isset( $edit['wpEdittime'] ) ) {
 139                         $edit['wpEdittime'] = $page->exists() ? $page->getTimestamp() : '';
 140                 }
 141
 142                 if ( !isset( $edit['wpStarttime'] ) ) {
 143                         $edit['wpStarttime'] = wfTimestampNow();
 144                 }
 145
 146                 $req = new FauxRequest( $edit, true ); // session ??
 147
 148                 $article = new Article( $title );
 149                 $article->getContext()->setTitle( $title );
 150                 $ep = new EditPage( $article );
 151                 $ep->setContextTitle( $title );
 152                 $ep->importFormData( $req );
 153
 154                 $bot = isset( $edit['bot'] ) ? (bool)$edit['bot'] : false;
 155
 156                 // this is where the edit happens!
 157                 // Note: don't want to use EditPage::AttemptSave, because it messes with $wgOut
 158                 // and throws exceptions like PermissionsError
 159                 $status = $ep->internalAttemptSave( $result, $bot );
 160
 161                 if ( $expectedCode !== null ) {
 162                         // check edit code
 163                         $this->assertEquals( $expectedCode, $status->value,
 164                                 "Expected result code mismatch. $message" );
 165                 }
 166
 167                 $page = WikiPage::factory( $title );
 168
 169                 if ( $expectedText !== null ) {
 170                         // check resulting page text
 171                         $content = $page->getContent();
 172                         $text = ContentHandler::getContentText( $content );
 173
 174                         # EditPage rtrim() the user input, so we alter our expected text
 175                         # to reflect that.
 176                         $this->assertEditedTextEquals( $expectedText, $text,
 177                                 "Expected article text mismatch. $message" );
 178                 }
 179
 180                 return $page;
 181         }
 182
 183         public static function provideCreatePages() {
 184                 return array(
 185                         array( 'expected article being created',
 186                                 'EditPageTest_testCreatePage',
 187                                 null,
 188                                 'Hello World!',
 189                                 EditPage::AS_SUCCESS_NEW_ARTICLE,
 190                                 'Hello World!'
 191                         ),
 192                         array( 'expected article not being created if empty',
 193                                 'EditPageTest_testCreatePage',
 194                                 null,
 195                                 '',
 196                                 EditPage::AS_BLANK_ARTICLE,
 197                                 null
 198                         ),
 199                         array( 'expected MediaWiki: page being created',
 200                                 'MediaWiki:January',
 201                                 'UTSysop',
 202                                 'Not January',
 203                                 EditPage::AS_SUCCESS_NEW_ARTICLE,
 204                                 'Not January'
 205                         ),
 206                         array( 'expected not-registered MediaWiki: page not being created if empty',
 207                                 'MediaWiki:EditPageTest_testCreatePage',
 208                                 'UTSysop',
 209                                 '',
 210                                 EditPage::AS_BLANK_ARTICLE,
 211                                 null
 212                         ),
 213                         array( 'expected registered MediaWiki: page being created even if empty',
 214                                 'MediaWiki:January',
 215                                 'UTSysop',
 216                                 '',
 217                                 EditPage::AS_SUCCESS_NEW_ARTICLE,
 218                                 ''
 219                         ),
 220                         array( 'expected registered MediaWiki: page whose default content is empty not being created if empty',
 221                                 'MediaWiki:Ipb-default-expiry',
 222                                 'UTSysop',
 223                                 '',
 224                                 EditPage::AS_BLANK_ARTICLE,
 225                                 ''
 226                         ),
 227                         array( 'expected MediaWiki: page not being created if text equals default message',
 228                                 'MediaWiki:January',
 229                                 'UTSysop',
 230                                 'January',
 231                                 EditPage::AS_BLANK_ARTICLE,
 232                                 null
 233                         ),
 234                         array( 'expected empty article being created',
 235                                 'EditPageTest_testCreatePage',
 236                                 null,
 237                                 '',
 238                                 EditPage::AS_SUCCESS_NEW_ARTICLE,
 239                                 '',
 240                                 true
 241                         ),
 242                 );
 243         }
 244
 245         /**
 246          * @dataProvider provideCreatePages
 247          * @covers EditPage
 248          */
 249         public function testCreatePage( $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank = false ) {
 250                 $edit = array( 'wpTextbox1' => $editText );
 251                 if ( $ignoreBlank ) {
 252                         $edit['wpIgnoreBlankArticle'] = 1;
 253                 }
 254
 255                 $page = $this->assertEdit( $pageTitle, null, $user, $edit, $expectedCode, $expectedText, $desc );
 256
 257                 if ( $expectedCode != EditPage::AS_BLANK_ARTICLE ) {
 258                         $page->doDeleteArticleReal( $pageTitle );
 259                 }
 260         }
 261
 262         public function testUpdatePage() {
 263                 $text = "one";
 264                 $edit = array(
 265                         'wpTextbox1' => $text,
 266                         'wpSummary' => 'first update',
 267                 );
 268
 269                 $page = $this->assertEdit( 'EditPageTest_testUpdatePage', "zero", null, $edit,
 270                         EditPage::AS_SUCCESS_UPDATE, $text,
 271                         "expected successfull update with given text" );
 272
 273                 $this->forceRevisionDate( $page, '20120101000000' );
 274
 275                 $text = "two";
 276                 $edit = array(
 277                         'wpTextbox1' => $text,
 278                         'wpSummary' => 'second update',
 279                 );
 280
 281                 $this->assertEdit( 'EditPageTest_testUpdatePage', null, null, $edit,
 282                         EditPage::AS_SUCCESS_UPDATE, $text,
 283                         "expected successfull update with given text" );
 284         }
 285
 286         public static function provideSectionEdit() {
 287                 $text = 'Intro
 288
 289 == one ==
 290 first section.
 291
 292 == two ==
 293 second section.
 294 ';
 295
 296                 $sectionOne = '== one ==
 297 hello
 298 ';
 299
 300                 $newSection = '== new section ==
 301
 302 hello
 303 ';
 304
 305                 $textWithNewSectionOne = preg_replace(
 306                         '/== one ==.*== two ==/ms',
 307                         "$sectionOne\n== two ==", $text
 308                 );
 309
 310                 $textWithNewSectionAdded = "$text\n$newSection";
 311
 312                 return array(
 313                         array( #0
 314                                 $text,
 315                                 '',
 316                                 'hello',
 317                                 'replace all',
 318                                 'hello'
 319                         ),
 320
 321                         array( #1
 322                                 $text,
 323                                 '1',
 324                                 $sectionOne,
 325                                 'replace first section',
 326                                 $textWithNewSectionOne,
 327                         ),
 328
 329                         array( #2
 330                                 $text,
 331                                 'new',
 332                                 'hello',
 333                                 'new section',
 334                                 $textWithNewSectionAdded,
 335                         ),
 336                 );
 337         }
 338
 339         /**
 340          * @dataProvider provideSectionEdit
 341          * @covers EditPage
 342          */
 343         public function testSectionEdit( $base, $section, $text, $summary, $expected ) {
 344                 $edit = array(
 345                         'wpTextbox1' => $text,
 346                         'wpSummary' => $summary,
 347                         'wpSection' => $section,
 348                 );
 349
 350                 $this->assertEdit( 'EditPageTest_testSectionEdit', $base, null, $edit,
 351                         EditPage::AS_SUCCESS_UPDATE, $expected,
 352                         "expected successfull update of section" );
 353         }
 354
 355         public static function provideAutoMerge() {
 356                 $tests = array();
 357
 358                 $tests[] = array( #0: plain conflict
 359                         "Elmo", # base edit user
 360                         "one\n\ntwo\n\nthree\n",
 361                         array( #adam's edit
 362                                 'wpStarttime' => 1,
 363                                 'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
 364                         ),
 365                         array( #berta's edit
 366                                 'wpStarttime' => 2,
 367                                 'wpTextbox1' => "(one)\n\ntwo\n\nthree\n",
 368                         ),
 369                         EditPage::AS_CONFLICT_DETECTED, # expected code
 370                         "ONE\n\ntwo\n\nthree\n", # expected text
 371                         'expected edit conflict', # message
 372                 );
 373
 374                 $tests[] = array( #1: successful merge
 375                         "Elmo", # base edit user
 376                         "one\n\ntwo\n\nthree\n",
 377                         array( #adam's edit
 378                                 'wpStarttime' => 1,
 379                                 'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
 380                         ),
 381                         array( #berta's edit
 382                                 'wpStarttime' => 2,
 383                                 'wpTextbox1' => "one\n\ntwo\n\nTHREE\n",
 384                         ),
 385                         EditPage::AS_SUCCESS_UPDATE, # expected code
 386                         "ONE\n\ntwo\n\nTHREE\n", # expected text
 387                         'expected automatic merge', # message
 388                 );
 389
 390                 $text = "Intro\n\n";
 391                 $text .= "== first section ==\n\n";
 392                 $text .= "one\n\ntwo\n\nthree\n\n";
 393                 $text .= "== second section ==\n\n";
 394                 $text .= "four\n\nfive\n\nsix\n\n";
 395
 396                 // extract the first section.
 397                 $section = preg_replace( '/.*(== first section ==.*)== second section ==.*/sm', '$1', $text );
 398
 399                 // generate expected text after merge
 400                 $expected = str_replace( 'one', 'ONE', str_replace( 'three', 'THREE', $text ) );
 401
 402                 $tests[] = array( #2: merge in section
 403                         "Elmo", # base edit user
 404                         $text,
 405                         array( #adam's edit
 406                                 'wpStarttime' => 1,
 407                                 'wpTextbox1' => str_replace( 'one', 'ONE', $section ),
 408                                 'wpSection' => '1'
 409                         ),
 410                         array( #berta's edit
 411                                 'wpStarttime' => 2,
 412                                 'wpTextbox1' => str_replace( 'three', 'THREE', $section ),
 413                                 'wpSection' => '1'
 414                         ),
 415                         EditPage::AS_SUCCESS_UPDATE, # expected code
 416                         $expected, # expected text
 417                         'expected automatic section merge', # message
 418                 );
 419
 420                 // see whether it makes a difference who did the base edit
 421                 $testsWithAdam = array_map( function ( $test ) {
 422                         $test[0] = 'Adam'; // change base edit user
 423                         return $test;
 424                 }, $tests );
 425
 426                 $testsWithBerta = array_map( function ( $test ) {
 427                         $test[0] = 'Berta'; // change base edit user
 428                         return $test;
 429                 }, $tests );
 430
 431                 return array_merge( $tests, $testsWithAdam, $testsWithBerta );
 432         }
 433
 434         /**
 435          * @dataProvider provideAutoMerge
 436          * @covers EditPage
 437          */
 438         public function testAutoMerge( $baseUser, $text, $adamsEdit, $bertasEdit,
 439                 $expectedCode, $expectedText, $message = null
 440         ) {
 441                 $this->checkHasDiff3();
 442
 443                 //create page
 444                 $ns = $this->getDefaultWikitextNS();
 445                 $title = Title::newFromText( 'EditPageTest_testAutoMerge', $ns );
 446                 $page = WikiPage::factory( $title );
 447
 448                 if ( $page->exists() ) {
 449                         $page->doDeleteArticle( "clean slate for testing" );
 450                 }
 451
 452                 $baseEdit = array(
 453                         'wpTextbox1' => $text,
 454                 );
 455
 456                 $page = $this->assertEdit( 'EditPageTest_testAutoMerge', null,
 457                         $baseUser, $baseEdit, null, null, __METHOD__ );
 458
 459                 $this->forceRevisionDate( $page, '20120101000000' );
 460
 461                 $edittime = $page->getTimestamp();
 462
 463                 // start timestamps for conflict detection
 464                 if ( !isset( $adamsEdit['wpStarttime'] ) ) {
 465                         $adamsEdit['wpStarttime'] = 1;
 466                 }
 467
 468                 if ( !isset( $bertasEdit['wpStarttime'] ) ) {
 469                         $bertasEdit['wpStarttime'] = 2;
 470                 }
 471
 472                 $starttime = wfTimestampNow();
 473                 $adamsTime = wfTimestamp(
 474                         TS_MW,
 475                         (int)wfTimestamp( TS_UNIX, $starttime ) + (int)$adamsEdit['wpStarttime']
 476                 );
 477                 $bertasTime = wfTimestamp(
 478                         TS_MW,
 479                         (int)wfTimestamp( TS_UNIX, $starttime ) + (int)$bertasEdit['wpStarttime']
 480                 );
 481
 482                 $adamsEdit['wpStarttime'] = $adamsTime;
 483                 $bertasEdit['wpStarttime'] = $bertasTime;
 484
 485                 $adamsEdit['wpSummary'] = 'Adam\'s edit';
 486                 $bertasEdit['wpSummary'] = 'Bertas\'s edit';
 487
 488                 $adamsEdit['wpEdittime'] = $edittime;
 489                 $bertasEdit['wpEdittime'] = $edittime;
 490
 491                 // first edit
 492                 $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Adam', $adamsEdit,
 493                         EditPage::AS_SUCCESS_UPDATE, null, "expected successfull update" );
 494
 495                 // second edit
 496                 $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Berta', $bertasEdit,
 497                         $expectedCode, $expectedText, $message );
 498         }
 499 }