tests/parser/parserTest.inc

   1 <?php
   2 /**
   3  * Helper code for the MediaWiki parser test suite. Some code is duplicated
   4  * in PHPUnit's NewParserTests.php, so you'll probably want to update both
   5  * at the same time.
   6  *
   7  * Copyright © 2004, 2010 Brion Vibber <brion@pobox.com>
   8  * http://www.mediawiki.org/
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  *
  25  * @todo Make this more independent of the configuration (and if possible the database)
  26  * @todo document
  27  * @file
  28  * @ingroup Testing
  29  */
  30
  31 /**
  32  * @ingroup Testing
  33  */
  34 class ParserTest {
  35         /**
  36          * boolean $color whereas output should be colorized
  37          */
  38         private $color;
  39
  40         /**
  41          * boolean $showOutput Show test output
  42          */
  43         private $showOutput;
  44
  45         /**
  46          * boolean $useTemporaryTables Use temporary tables for the temporary database
  47          */
  48         private $useTemporaryTables = true;
  49
  50         /**
  51          * boolean $databaseSetupDone True if the database has been set up
  52          */
  53         private $databaseSetupDone = false;
  54
  55         /**
  56          * Our connection to the database
  57          * @var DatabaseBase
  58          */
  59         private $db;
  60
  61         /**
  62          * Database clone helper
  63          * @var CloneDatabase
  64          */
  65         private $dbClone;
  66
  67         /**
  68          * string $oldTablePrefix Original table prefix
  69          */
  70         private $oldTablePrefix;
  71
  72         private $maxFuzzTestLength = 300;
  73         private $fuzzSeed = 0;
  74         private $memoryLimit = 50;
  75         private $uploadDir = null;
  76
  77         public $regex = "";
  78         private $savedGlobals = array();
  79
  80         /**
  81          * Sets terminal colorization and diff/quick modes depending on OS and
  82          * command-line options (--color and --quick).
  83          */
  84         public function __construct( $options = array() ) {
  85                 # Only colorize output if stdout is a terminal.
  86                 $this->color = !wfIsWindows() && Maintenance::posix_isatty( 1 );
  87
  88                 if ( isset( $options['color'] ) ) {
  89                         switch ( $options['color'] ) {
  90                                 case 'no':
  91                                         $this->color = false;
  92                                         break;
  93                                 case 'yes':
  94                                 default:
  95                                         $this->color = true;
  96                                         break;
  97                         }
  98                 }
  99
 100                 $this->term = $this->color
 101                         ? new AnsiTermColorer()
 102                         : new DummyTermColorer();
 103
 104                 $this->showDiffs = !isset( $options['quick'] );
 105                 $this->showProgress = !isset( $options['quiet'] );
 106                 $this->showFailure = !(
 107                         isset( $options['quiet'] )
 108                                 && ( isset( $options['record'] )
 109                                 || isset( $options['compare'] ) ) ); // redundant output
 110
 111                 $this->showOutput = isset( $options['show-output'] );
 112
 113                 if ( isset( $options['filter'] ) ) {
 114                         $options['regex'] = $options['filter'];
 115                 }
 116
 117                 if ( isset( $options['regex'] ) ) {
 118                         if ( isset( $options['record'] ) ) {
 119                                 echo "Warning: --record cannot be used with --regex, disabling --record\n";
 120                                 unset( $options['record'] );
 121                         }
 122                         $this->regex = $options['regex'];
 123                 } else {
 124                         # Matches anything
 125                         $this->regex = '';
 126                 }
 127
 128                 $this->setupRecorder( $options );
 129                 $this->keepUploads = isset( $options['keep-uploads'] );
 130
 131                 if ( isset( $options['seed'] ) ) {
 132                         $this->fuzzSeed = intval( $options['seed'] ) - 1;
 133                 }
 134
 135                 $this->runDisabled = isset( $options['run-disabled'] );
 136                 $this->runParsoid = isset( $options['run-parsoid'] );
 137
 138                 $this->hooks = array();
 139                 $this->functionHooks = array();
 140                 self::setUp();
 141         }
 142
 143         static function setUp() {
 144                 global $wgParser, $wgParserConf, $IP, $messageMemc, $wgMemc,
 145                         $wgUser, $wgLang, $wgOut, $wgRequest, $wgStyleDirectory, $wgEnableParserCache,
 146                         $wgNamespaceAliases, $wgNamespaceProtection, $wgLocalFileRepo,
 147                         $parserMemc, $wgThumbnailScriptPath, $wgScriptPath,
 148                         $wgArticlePath, $wgScript, $wgStylePath, $wgExtensionAssetsPath,
 149                         $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType, $wgLockManagers;
 150
 151                 $wgScript = '/index.php';
 152                 $wgScriptPath = '/';
 153                 $wgArticlePath = '/wiki/$1';
 154                 $wgStylePath = '/skins';
 155                 $wgExtensionAssetsPath = '/extensions';
 156                 $wgThumbnailScriptPath = false;
 157                 $wgLockManagers = array( array(
 158                         'name' => 'fsLockManager',
 159                         'class' => 'FSLockManager',
 160                         'lockDirectory' => wfTempDir() . '/test-repo/lockdir',
 161                 ), array(
 162                         'name' => 'nullLockManager',
 163                         'class' => 'NullLockManager',
 164                 ) );
 165                 $wgLocalFileRepo = array(
 166                         'class' => 'LocalRepo',
 167                         'name' => 'local',
 168                         'url' => 'http://example.com/images',
 169                         'hashLevels' => 2,
 170                         'transformVia404' => false,
 171                         'backend' => new FSFileBackend( array(
 172                                 'name' => 'local-backend',
 173                                 'lockManager' => 'fsLockManager',
 174                                 'containerPaths' => array(
 175                                         'local-public' => wfTempDir() . '/test-repo/public',
 176                                         'local-thumb' => wfTempDir() . '/test-repo/thumb',
 177                                         'local-temp' => wfTempDir() . '/test-repo/temp',
 178                                         'local-deleted' => wfTempDir() . '/test-repo/deleted',
 179                                 )
 180                         ) )
 181                 );
 182                 $wgNamespaceProtection[NS_MEDIAWIKI] = 'editinterface';
 183                 $wgNamespaceAliases['Image'] = NS_FILE;
 184                 $wgNamespaceAliases['Image_talk'] = NS_FILE_TALK;
 185
 186                 // XXX: tests won't run without this (for CACHE_DB)
 187                 if ( $wgMainCacheType === CACHE_DB ) {
 188                         $wgMainCacheType = CACHE_NONE;
 189                 }
 190                 if ( $wgMessageCacheType === CACHE_DB ) {
 191                         $wgMessageCacheType = CACHE_NONE;
 192                 }
 193                 if ( $wgParserCacheType === CACHE_DB ) {
 194                         $wgParserCacheType = CACHE_NONE;
 195                 }
 196
 197                 $wgEnableParserCache = false;
 198                 DeferredUpdates::clearPendingUpdates();
 199                 $wgMemc = wfGetMainCache(); // checks $wgMainCacheType
 200                 $messageMemc = wfGetMessageCacheStorage();
 201                 $parserMemc = wfGetParserCacheStorage();
 202
 203                 // $wgContLang = new StubContLang;
 204                 $wgUser = new User;
 205                 $context = new RequestContext;
 206                 $wgLang = $context->getLanguage();
 207                 $wgOut = $context->getOutput();
 208                 $wgParser = new StubObject( 'wgParser', $wgParserConf['class'], array( $wgParserConf ) );
 209                 $wgRequest = $context->getRequest();
 210
 211                 if ( $wgStyleDirectory === false ) {
 212                         $wgStyleDirectory = "$IP/skins";
 213                 }
 214
 215                 self::setupInterwikis();
 216         }
 217
 218         /**
 219          * Insert hardcoded interwiki in the lookup table.
 220          *
 221          * This function insert a set of well known interwikis that are used in
 222          * the parser tests. They can be considered has fixtures are injected in
 223          * the interwiki cache by using the 'InterwikiLoadPrefix' hook.
 224          * Since we are not interested in looking up interwikis in the database,
 225          * the hook completely replace the existing mechanism (hook returns false).
 226          */
 227         public static function setupInterwikis() {
 228                 # Hack: insert a few Wikipedia in-project interwiki prefixes,
 229                 # for testing inter-language links
 230                 Hooks::register( 'InterwikiLoadPrefix', function ( $prefix, &$iwData ) {
 231                         static $testInterwikis = array(
 232                                 'wikipedia' => array(
 233                                         'iw_url' => 'http://en.wikipedia.org/wiki/$1',
 234                                         'iw_api' => '',
 235                                         'iw_wikiid' => '',
 236                                         'iw_local' => 0 ),
 237                                 'meatball' => array(
 238                                         'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
 239                                         'iw_api' => '',
 240                                         'iw_wikiid' => '',
 241                                         'iw_local' => 0 ),
 242                                 'zh' => array(
 243                                         'iw_url' => 'http://zh.wikipedia.org/wiki/$1',
 244                                         'iw_api' => '',
 245                                         'iw_wikiid' => '',
 246                                         'iw_local' => 1 ),
 247                                 'es' => array(
 248                                         'iw_url' => 'http://es.wikipedia.org/wiki/$1',
 249                                         'iw_api' => '',
 250                                         'iw_wikiid' => '',
 251                                         'iw_local' => 1 ),
 252                                 'fr' => array(
 253                                         'iw_url' => 'http://fr.wikipedia.org/wiki/$1',
 254                                         'iw_api' => '',
 255                                         'iw_wikiid' => '',
 256                                         'iw_local' => 1 ),
 257                                 'ru' => array(
 258                                         'iw_url' => 'http://ru.wikipedia.org/wiki/$1',
 259                                         'iw_api' => '',
 260                                         'iw_wikiid' => '',
 261                                         'iw_local' => 1 ),
 262                         );
 263                         if( array_key_exists( $prefix, $testInterwikis ) ) {
 264                                 $iwData = $testInterwikis[$prefix];
 265                         }
 266
 267                         // We only want to rely on the above fixtures
 268                         return false;
 269                 } );// hooks::register
 270         }
 271
 272         public function setupRecorder( $options ) {
 273                 if ( isset( $options['record'] ) ) {
 274                         $this->recorder = new DbTestRecorder( $this );
 275                         $this->recorder->version = isset( $options['setversion'] ) ?
 276                                 $options['setversion'] : SpecialVersion::getVersion();
 277                 } elseif ( isset( $options['compare'] ) ) {
 278                         $this->recorder = new DbTestPreviewer( $this );
 279                 } else {
 280                         $this->recorder = new TestRecorder( $this );
 281                 }
 282         }
 283
 284         /**
 285          * Remove last character if it is a newline
 286          * @group utility
 287          */
 288         public static function chomp( $s ) {
 289                 if ( substr( $s, -1 ) === "\n" ) {
 290                         return substr( $s, 0, -1 );
 291                 } else {
 292                         return $s;
 293                 }
 294         }
 295
 296         /**
 297          * Run a fuzz test series
 298          * Draw input from a set of test files
 299          */
 300         function fuzzTest( $filenames ) {
 301                 $GLOBALS['wgContLang'] = Language::factory( 'en' );
 302                 $dict = $this->getFuzzInput( $filenames );
 303                 $dictSize = strlen( $dict );
 304                 $logMaxLength = log( $this->maxFuzzTestLength );
 305                 $this->setupDatabase();
 306                 ini_set( 'memory_limit', $this->memoryLimit * 1048576 );
 307
 308                 $numTotal = 0;
 309                 $numSuccess = 0;
 310                 $user = new User;
 311                 $opts = ParserOptions::newFromUser( $user );
 312                 $title = Title::makeTitle( NS_MAIN, 'Parser_test' );
 313
 314                 while ( true ) {
 315                         // Generate test input
 316                         mt_srand( ++$this->fuzzSeed );
 317                         $totalLength = mt_rand( 1, $this->maxFuzzTestLength );
 318                         $input = '';
 319
 320                         while ( strlen( $input ) < $totalLength ) {
 321                                 $logHairLength = mt_rand( 0, 1000000 ) / 1000000 * $logMaxLength;
 322                                 $hairLength = min( intval( exp( $logHairLength ) ), $dictSize );
 323                                 $offset = mt_rand( 0, $dictSize - $hairLength );
 324                                 $input .= substr( $dict, $offset, $hairLength );
 325                         }
 326
 327                         $this->setupGlobals();
 328                         $parser = $this->getParser();
 329
 330                         // Run the test
 331                         try {
 332                                 $parser->parse( $input, $title, $opts );
 333                                 $fail = false;
 334                         } catch ( Exception $exception ) {
 335                                 $fail = true;
 336                         }
 337
 338                         if ( $fail ) {
 339                                 echo "Test failed with seed {$this->fuzzSeed}\n";
 340                                 echo "Input:\n";
 341                                 printf( "string(%d) \"%s\"\n\n", strlen( $input ), $input );
 342                                 echo "$exception\n";
 343                         } else {
 344                                 $numSuccess++;
 345                         }
 346
 347                         $numTotal++;
 348                         $this->teardownGlobals();
 349                         $parser->__destruct();
 350
 351                         if ( $numTotal % 100 == 0 ) {
 352                                 $usage = intval( memory_get_usage( true ) / $this->memoryLimit / 1048576 * 100 );
 353                                 echo "{$this->fuzzSeed}: $numSuccess/$numTotal (mem: $usage%)\n";
 354                                 if ( $usage > 90 ) {
 355                                         echo "Out of memory:\n";
 356                                         $memStats = $this->getMemoryBreakdown();
 357
 358                                         foreach ( $memStats as $name => $usage ) {
 359                                                 echo "$name: $usage\n";
 360                                         }
 361                                         $this->abort();
 362                                 }
 363                         }
 364                 }
 365         }
 366
 367         /**
 368          * Get an input dictionary from a set of parser test files
 369          */
 370         function getFuzzInput( $filenames ) {
 371                 $dict = '';
 372
 373                 foreach ( $filenames as $filename ) {
 374                         $contents = file_get_contents( $filename );
 375                         preg_match_all( '/!!\s*input\n(.*?)\n!!\s*result/s', $contents, $matches );
 376
 377                         foreach ( $matches[1] as $match ) {
 378                                 $dict .= $match . "\n";
 379                         }
 380                 }
 381
 382                 return $dict;
 383         }
 384
 385         /**
 386          * Get a memory usage breakdown
 387          */
 388         function getMemoryBreakdown() {
 389                 $memStats = array();
 390
 391                 foreach ( $GLOBALS as $name => $value ) {
 392                         $memStats['$' . $name] = strlen( serialize( $value ) );
 393                 }
 394
 395                 $classes = get_declared_classes();
 396
 397                 foreach ( $classes as $class ) {
 398                         $rc = new ReflectionClass( $class );
 399                         $props = $rc->getStaticProperties();
 400                         $memStats[$class] = strlen( serialize( $props ) );
 401                         $methods = $rc->getMethods();
 402
 403                         foreach ( $methods as $method ) {
 404                                 $memStats[$class] += strlen( serialize( $method->getStaticVariables() ) );
 405                         }
 406                 }
 407
 408                 $functions = get_defined_functions();
 409
 410                 foreach ( $functions['user'] as $function ) {
 411                         $rf = new ReflectionFunction( $function );
 412                         $memStats["$function()"] = strlen( serialize( $rf->getStaticVariables() ) );
 413                 }
 414
 415                 asort( $memStats );
 416
 417                 return $memStats;
 418         }
 419
 420         function abort() {
 421                 $this->abort();
 422         }
 423
 424         /**
 425          * Run a series of tests listed in the given text files.
 426          * Each test consists of a brief description, wikitext input,
 427          * and the expected HTML output.
 428          *
 429          * Prints status updates on stdout and counts up the total
 430          * number and percentage of passed tests.
 431          *
 432          * @param $filenames Array of strings
 433          * @return Boolean: true if passed all tests, false if any tests failed.
 434          */
 435         public function runTestsFromFiles( $filenames ) {
 436                 $ok = false;
 437
 438                 // be sure, ParserTest::addArticle has correct language set,
 439                 // so that system messages gets into the right language cache
 440                 $GLOBALS['wgLanguageCode'] = 'en';
 441                 $GLOBALS['wgContLang'] = Language::factory( 'en' );
 442
 443                 $this->recorder->start();
 444                 try {
 445                         $this->setupDatabase();
 446                         $ok = true;
 447
 448                         foreach ( $filenames as $filename ) {
 449                                 $tests = new TestFileIterator( $filename, $this );
 450                                 $ok = $this->runTests( $tests ) && $ok;
 451                         }
 452
 453                         $this->teardownDatabase();
 454                         $this->recorder->report();
 455                 } catch ( DBError $e ) {
 456                         echo $e->getMessage();
 457                 }
 458                 $this->recorder->end();
 459
 460                 return $ok;
 461         }
 462
 463         function runTests( $tests ) {
 464                 $ok = true;
 465
 466                 foreach ( $tests as $t ) {
 467                         $result =
 468                                 $this->runTest( $t['test'], $t['input'], $t['result'], $t['options'], $t['config'] );
 469                         $ok = $ok && $result;
 470                         $this->recorder->record( $t['test'], $result );
 471                 }
 472
 473                 if ( $this->showProgress ) {
 474                         print "\n";
 475                 }
 476
 477                 return $ok;
 478         }
 479
 480         /**
 481          * Get a Parser object
 482          */
 483         function getParser( $preprocessor = null ) {
 484                 global $wgParserConf;
 485
 486                 $class = $wgParserConf['class'];
 487                 $parser = new $class( array( 'preprocessorClass' => $preprocessor ) + $wgParserConf );
 488
 489                 foreach ( $this->hooks as $tag => $callback ) {
 490                         $parser->setHook( $tag, $callback );
 491                 }
 492
 493                 foreach ( $this->functionHooks as $tag => $bits ) {
 494                         list( $callback, $flags ) = $bits;
 495                         $parser->setFunctionHook( $tag, $callback, $flags );
 496                 }
 497
 498                 wfRunHooks( 'ParserTestParser', array( &$parser ) );
 499
 500                 return $parser;
 501         }
 502
 503         /**
 504          * Run a given wikitext input through a freshly-constructed wiki parser,
 505          * and compare the output against the expected results.
 506          * Prints status and explanatory messages to stdout.
 507          *
 508          * @param $desc String: test's description
 509          * @param $input String: wikitext to try rendering
 510          * @param $result String: result to output
 511          * @param $opts Array: test's options
 512          * @param $config String: overrides for global variables, one per line
 513          * @return Boolean
 514          */
 515         public function runTest( $desc, $input, $result, $opts, $config ) {
 516                 if ( $this->showProgress ) {
 517                         $this->showTesting( $desc );
 518                 }
 519
 520                 $opts = $this->parseOptions( $opts );
 521                 $context = $this->setupGlobals( $opts, $config );
 522
 523                 $user = $context->getUser();
 524                 $options = ParserOptions::newFromContext( $context );
 525
 526                 if ( isset( $opts['title'] ) ) {
 527                         $titleText = $opts['title'];
 528                 } else {
 529                         $titleText = 'Parser test';
 530                 }
 531
 532                 $local = isset( $opts['local'] );
 533                 $preprocessor = isset( $opts['preprocessor'] ) ? $opts['preprocessor'] : null;
 534                 $parser = $this->getParser( $preprocessor );
 535                 $title = Title::newFromText( $titleText );
 536
 537                 if ( isset( $opts['pst'] ) ) {
 538                         $out = $parser->preSaveTransform( $input, $title, $user, $options );
 539                 } elseif ( isset( $opts['msg'] ) ) {
 540                         $out = $parser->transformMsg( $input, $options, $title );
 541                 } elseif ( isset( $opts['section'] ) ) {
 542                         $section = $opts['section'];
 543                         $out = $parser->getSection( $input, $section );
 544                 } elseif ( isset( $opts['replace'] ) ) {
 545                         $section = $opts['replace'][0];
 546                         $replace = $opts['replace'][1];
 547                         $out = $parser->replaceSection( $input, $section, $replace );
 548                 } elseif ( isset( $opts['comment'] ) ) {
 549                         $out = Linker::formatComment( $input, $title, $local );
 550                 } elseif ( isset( $opts['preload'] ) ) {
 551                         $out = $parser->getPreloadText( $input, $title, $options );
 552                 } else {
 553                         $output = $parser->parse( $input, $title, $options, true, true, 1337 );
 554                         $out = $output->getText();
 555
 556                         if ( isset( $opts['showtitle'] ) ) {
 557                                 if ( $output->getTitleText() ) {
 558                                         $title = $output->getTitleText();
 559                                 }
 560
 561                                 $out = "$title\n$out";
 562                         }
 563
 564                         if ( isset( $opts['ill'] ) ) {
 565                                 $out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
 566                         } elseif ( isset( $opts['cat'] ) ) {
 567                                 $outputPage = $context->getOutput();
 568                                 $outputPage->addCategoryLinks( $output->getCategories() );
 569                                 $cats = $outputPage->getCategoryLinks();
 570
 571                                 if ( isset( $cats['normal'] ) ) {
 572                                         $out = $this->tidy( implode( ' ', $cats['normal'] ) );
 573                                 } else {
 574                                         $out = '';
 575                                 }
 576                         }
 577
 578                         $result = $this->tidy( $result );
 579                 }
 580
 581                 $this->teardownGlobals();
 582
 583                 $testResult = new ParserTestResult( $desc );
 584                 $testResult->expected = $result;
 585                 $testResult->actual = $out;
 586
 587                 return $this->showTestResult( $testResult );
 588         }
 589
 590         /**
 591          * Refactored in 1.22 to use ParserTestResult
 592          */
 593         function showTestResult( ParserTestResult $testResult ) {
 594                 if ( $testResult->isSuccess() ) {
 595                         $this->showSuccess( $testResult );
 596                         return true;
 597                 } else {
 598                         $this->showFailure( $testResult );
 599                         return false;
 600                 }
 601         }
 602
 603         /**
 604          * Use a regex to find out the value of an option
 605          * @param $key String: name of option val to retrieve
 606          * @param $opts Options array to look in
 607          * @param $default Mixed: default value returned if not found
 608          */
 609         private static function getOptionValue( $key, $opts, $default ) {
 610                 $key = strtolower( $key );
 611
 612                 if ( isset( $opts[$key] ) ) {
 613                         return $opts[$key];
 614                 } else {
 615                         return $default;
 616                 }
 617         }
 618
 619         private function parseOptions( $instring ) {
 620                 $opts = array();
 621                 // foo
 622                 // foo=bar
 623                 // foo="bar baz"
 624                 // foo=[[bar baz]]
 625                 // foo=bar,"baz quux"
 626                 $regex = '/\b
 627                         ([\w-]+)                                                # Key
 628                         \b
 629                         (?:\s*
 630                                 =                                               # First sub-value
 631                                 \s*
 632                                 (
 633                                         "
 634                                                 [^"]*                   # Quoted val
 635                                         "
 636                                 |
 637                                         \[\[
 638                                                 [^]]*                   # Link target
 639                                         \]\]
 640                                 |
 641                                         [\w-]+                          # Plain word
 642                                 )
 643                                 (?:\s*
 644                                         ,                                       # Sub-vals 1..N
 645                                         \s*
 646                                         (
 647                                                 "[^"]*"                 # Quoted val
 648                                         |
 649                                                 \[\[[^]]*\]\]   # Link target
 650                                         |
 651                                                 [\w-]+                  # Plain word
 652                                         )
 653                                 )*
 654                         )?
 655                         /x';
 656
 657                 if ( preg_match_all( $regex, $instring, $matches, PREG_SET_ORDER ) ) {
 658                         foreach ( $matches as $bits ) {
 659                                 array_shift( $bits );
 660                                 $key = strtolower( array_shift( $bits ) );
 661                                 if ( count( $bits ) == 0 ) {
 662                                         $opts[$key] = true;
 663                                 } elseif ( count( $bits ) == 1 ) {
 664                                         $opts[$key] = $this->cleanupOption( array_shift( $bits ) );
 665                                 } else {
 666                                         // Array!
 667                                         $opts[$key] = array_map( array( $this, 'cleanupOption' ), $bits );
 668                                 }
 669                         }
 670                 }
 671                 return $opts;
 672         }
 673
 674         private function cleanupOption( $opt ) {
 675                 if ( substr( $opt, 0, 1 ) == '"' ) {
 676                         return substr( $opt, 1, -1 );
 677                 }
 678
 679                 if ( substr( $opt, 0, 2 ) == '[[' ) {
 680                         return substr( $opt, 2, -2 );
 681                 }
 682                 return $opt;
 683         }
 684
 685         /**
 686          * Set up the global variables for a consistent environment for each test.
 687          * Ideally this should replace the global configuration entirely.
 688          */
 689         private function setupGlobals( $opts = '', $config = '' ) {
 690                 # Find out values for some special options.
 691                 $lang =
 692                         self::getOptionValue( 'language', $opts, 'en' );
 693                 $variant =
 694                         self::getOptionValue( 'variant', $opts, false );
 695                 $maxtoclevel =
 696                         self::getOptionValue( 'wgMaxTocLevel', $opts, 999 );
 697                 $linkHolderBatchSize =
 698                         self::getOptionValue( 'wgLinkHolderBatchSize', $opts, 1000 );
 699
 700                 $settings = array(
 701                         'wgServer' => 'http://example.org',
 702                         'wgScript' => '/index.php',
 703                         'wgScriptPath' => '/',
 704                         'wgArticlePath' => '/wiki/$1',
 705                         'wgActionPaths' => array(),
 706                         'wgLockManagers' => array( array(
 707                                 'name' => 'fsLockManager',
 708                                 'class' => 'FSLockManager',
 709                                 'lockDirectory' => $this->uploadDir . '/lockdir',
 710                         ), array(
 711                                 'name' => 'nullLockManager',
 712                                 'class' => 'NullLockManager',
 713                         ) ),
 714                         'wgLocalFileRepo' => array(
 715                                 'class' => 'LocalRepo',
 716                                 'name' => 'local',
 717                                 'url' => 'http://example.com/images',
 718                                 'hashLevels' => 2,
 719                                 'transformVia404' => false,
 720                                 'backend' => new FSFileBackend( array(
 721                                         'name' => 'local-backend',
 722                                         'lockManager' => 'fsLockManager',
 723                                         'containerPaths' => array(
 724                                                 'local-public' => $this->uploadDir,
 725                                                 'local-thumb' => $this->uploadDir . '/thumb',
 726                                                 'local-temp' => $this->uploadDir . '/temp',
 727                                                 'local-deleted' => $this->uploadDir . '/delete',
 728                                         )
 729                                 ) )
 730                         ),
 731                         'wgEnableUploads' => self::getOptionValue( 'wgEnableUploads', $opts, true ),
 732                         'wgStylePath' => '/skins',
 733                         'wgSitename' => 'MediaWiki',
 734                         'wgLanguageCode' => $lang,
 735                         'wgDBprefix' => $this->db->getType() != 'oracle' ? 'parsertest_' : 'pt_',
 736                         'wgRawHtml' => self::getOptionValue( 'wgRawHtml', $opts, false ),
 737                         'wgLang' => null,
 738                         'wgContLang' => null,
 739                         'wgNamespacesWithSubpages' => array( 0 => isset( $opts['subpage'] ) ),
 740                         'wgMaxTocLevel' => $maxtoclevel,
 741                         'wgCapitalLinks' => true,
 742                         'wgNoFollowLinks' => true,
 743                         'wgNoFollowDomainExceptions' => array(),
 744                         'wgThumbnailScriptPath' => false,
 745                         'wgUseImageResize' => true,
 746                         'wgSVGConverter' => 'null',
 747                         'wgSVGConverters' => array( 'null' => 'echo "1">$output' ),
 748                         'wgLocaltimezone' => 'UTC',
 749                         'wgAllowExternalImages' => self::getOptionValue( 'wgAllowExternalImages', $opts, true ),
 750                         'wgUseTidy' => false,
 751                         'wgDefaultLanguageVariant' => $variant,
 752                         'wgVariantArticlePath' => false,
 753                         'wgGroupPermissions' => array( '*' => array(
 754                                 'createaccount' => true,
 755                                 'read' => true,
 756                                 'edit' => true,
 757                                 'createpage' => true,
 758                                 'createtalk' => true,
 759                         ) ),
 760                         'wgNamespaceProtection' => array( NS_MEDIAWIKI => 'editinterface' ),
 761                         'wgDefaultExternalStore' => array(),
 762                         'wgForeignFileRepos' => array(),
 763                         'wgLinkHolderBatchSize' => $linkHolderBatchSize,
 764                         'wgExperimentalHtmlIds' => false,
 765                         'wgExternalLinkTarget' => false,
 766                         'wgAlwaysUseTidy' => false,
 767                         'wgHtml5' => true,
 768                         'wgWellFormedXml' => true,
 769                         'wgAllowMicrodataAttributes' => true,
 770                         'wgAdaptiveMessageCache' => true,
 771                         'wgDisableLangConversion' => false,
 772                         'wgDisableTitleConversion' => false,
 773                 );
 774
 775                 if ( $config ) {
 776                         $configLines = explode( "\n", $config );
 777
 778                         foreach ( $configLines as $line ) {
 779                                 list( $var, $value ) = explode( '=', $line, 2 );
 780
 781                                 $settings[$var] = eval( "return $value;" );
 782                         }
 783                 }
 784
 785                 $this->savedGlobals = array();
 786
 787                 /** @since 1.20 */
 788                 wfRunHooks( 'ParserTestGlobals', array( &$settings ) );
 789
 790                 foreach ( $settings as $var => $val ) {
 791                         if ( array_key_exists( $var, $GLOBALS ) ) {
 792                                 $this->savedGlobals[$var] = $GLOBALS[$var];
 793                         }
 794
 795                         $GLOBALS[$var] = $val;
 796                 }
 797
 798                 $GLOBALS['wgContLang'] = Language::factory( $lang );
 799                 $GLOBALS['wgMemc'] = new EmptyBagOStuff;
 800
 801                 $context = new RequestContext();
 802                 $GLOBALS['wgLang'] = $context->getLanguage();
 803                 $GLOBALS['wgOut'] = $context->getOutput();
 804
 805                 $GLOBALS['wgUser'] = new User();
 806
 807                 global $wgHooks;
 808
 809                 $wgHooks['ParserTestParser'][] = 'ParserTestParserHook::setup';
 810                 $wgHooks['ParserGetVariableValueTs'][] = 'ParserTest::getFakeTimestamp';
 811
 812                 MagicWord::clearCache();
 813
 814                 return $context;
 815         }
 816
 817         /**
 818          * List of temporary tables to create, without prefix.
 819          * Some of these probably aren't necessary.
 820          */
 821         private function listTables() {
 822                 $tables = array( 'user', 'user_properties', 'user_former_groups', 'page', 'page_restrictions',
 823                         'protected_titles', 'revision', 'text', 'pagelinks', 'imagelinks',
 824                         'categorylinks', 'templatelinks', 'externallinks', 'langlinks', 'iwlinks',
 825                         'site_stats', 'hitcounter', 'ipblocks', 'image', 'oldimage',
 826                         'recentchanges', 'watchlist', 'interwiki', 'logging',
 827                         'querycache', 'objectcache', 'job', 'l10n_cache', 'redirect', 'querycachetwo',
 828                         'archive', 'user_groups', 'page_props', 'category', 'msg_resource', 'msg_resource_links'
 829                 );
 830
 831                 if ( in_array( $this->db->getType(), array( 'mysql', 'sqlite', 'oracle' ) ) ) {
 832                         array_push( $tables, 'searchindex' );
 833                 }
 834
 835                 // Allow extensions to add to the list of tables to duplicate;
 836                 // may be necessary if they hook into page save or other code
 837                 // which will require them while running tests.
 838                 wfRunHooks( 'ParserTestTables', array( &$tables ) );
 839
 840                 return $tables;
 841         }
 842
 843         /**
 844          * Set up a temporary set of wiki tables to work with for the tests.
 845          * Currently this will only be done once per run, and any changes to
 846          * the db will be visible to later tests in the run.
 847          */
 848         public function setupDatabase() {
 849                 global $wgDBprefix;
 850
 851                 if ( $this->databaseSetupDone ) {
 852                         return;
 853                 }
 854
 855                 $this->db = wfGetDB( DB_MASTER );
 856                 $dbType = $this->db->getType();
 857
 858                 if ( $wgDBprefix === 'parsertest_' || ( $dbType == 'oracle' && $wgDBprefix === 'pt_' ) ) {
 859                         throw new MWException( 'setupDatabase should be called before setupGlobals' );
 860                 }
 861
 862                 $this->databaseSetupDone = true;
 863                 $this->oldTablePrefix = $wgDBprefix;
 864
 865                 # SqlBagOStuff broke when using temporary tables on r40209 (bug 15892).
 866                 # It seems to have been fixed since (r55079?), but regressed at some point before r85701.
 867                 # This works around it for now...
 868                 ObjectCache::$instances[CACHE_DB] = new HashBagOStuff;
 869
 870                 # CREATE TEMPORARY TABLE breaks if there is more than one server
 871                 if ( wfGetLB()->getServerCount() != 1 ) {
 872                         $this->useTemporaryTables = false;
 873                 }
 874
 875                 $temporary = $this->useTemporaryTables || $dbType == 'postgres';
 876                 $prefix = $dbType != 'oracle' ? 'parsertest_' : 'pt_';
 877
 878                 $this->dbClone = new CloneDatabase( $this->db, $this->listTables(), $prefix );
 879                 $this->dbClone->useTemporaryTables( $temporary );
 880                 $this->dbClone->cloneTableStructure();
 881
 882                 if ( $dbType == 'oracle' ) {
 883                         $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' );
 884                         # Insert 0 user to prevent FK violations
 885
 886                         # Anonymous user
 887                         $this->db->insert( 'user', array(
 888                                 'user_id' => 0,
 889                                 'user_name' => 'Anonymous' ) );
 890                 }
 891
 892                 # Update certain things in site_stats
 893                 $this->db->insert( 'site_stats', array( 'ss_row_id' => 1, 'ss_images' => 2, 'ss_good_articles' => 1 ) );
 894
 895                 # Reinitialise the LocalisationCache to match the database state
 896                 Language::getLocalisationCache()->unloadAll();
 897
 898                 # Clear the message cache
 899                 MessageCache::singleton()->clear();
 900
 901                 // Remember to update newParserTests.php after changing the below
 902                 // (and it uses a slightly different syntax just for teh lulz)
 903                 $this->uploadDir = $this->setupUploadDir();
 904                 $user = User::createNew( 'WikiSysop' );
 905                 $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Foobar.jpg' ) );
 906                 # note that the size/width/height/bits/etc of the file
 907                 # are actually set by inspecting the file itself; the arguments
 908                 # to recordUpload2 have no effect.  That said, we try to make things
 909                 # match up so it is less confusing to readers of the code & tests.
 910                 $image->recordUpload2( '', 'Upload of some lame file', 'Some lame file', array(
 911                         'size' => 7881,
 912                         'width' => 1941,
 913                         'height' => 220,
 914                         'bits' => 8,
 915                         'media_type' => MEDIATYPE_BITMAP,
 916                         'mime' => 'image/jpeg',
 917                         'metadata' => serialize( array() ),
 918                         'sha1' => wfBaseConvert( '1', 16, 36, 31 ),
 919                         'fileExists' => true
 920                 ), $this->db->timestamp( '20010115123500' ), $user );
 921
 922                 $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Thumb.png' ) );
 923                 # again, note that size/width/height below are ignored; see above.
 924                 $image->recordUpload2( '', 'Upload of some lame thumbnail', 'Some lame thumbnail', array(
 925                         'size' => 22589,
 926                         'width' => 135,
 927                         'height' => 135,
 928                         'bits' => 8,
 929                         'media_type' => MEDIATYPE_BITMAP,
 930                         'mime' => 'image/png',
 931                         'metadata' => serialize( array() ),
 932                         'sha1' => wfBaseConvert( '2', 16, 36, 31 ),
 933                         'fileExists' => true
 934                 ), $this->db->timestamp( '20130225203040' ), $user );
 935
 936                 $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Foobar.svg' ) );
 937                 $image->recordUpload2( '', 'Upload of some lame SVG', 'Some lame SVG', array(
 938                                 'size'        => 12345,
 939                                 'width'       => 240,
 940                                 'height'      => 180,
 941                                 'bits'        => 24,
 942                                 'media_type'  => MEDIATYPE_DRAWING,
 943                                 'mime'        => 'image/svg+xml',
 944                                 'metadata'    => serialize( array() ),
 945                                 'sha1'        => wfBaseConvert( '', 16, 36, 31 ),
 946                                 'fileExists'  => true
 947                 ), $this->db->timestamp( '20010115123500' ), $user );
 948
 949                 # This image will be blacklisted in [[MediaWiki:Bad image list]]
 950                 $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Bad.jpg' ) );
 951                 $image->recordUpload2( '', 'zomgnotcensored', 'Borderline image', array(
 952                         'size' => 12345,
 953                         'width' => 320,
 954                         'height' => 240,
 955                         'bits' => 24,
 956                         'media_type' => MEDIATYPE_BITMAP,
 957                         'mime' => 'image/jpeg',
 958                         'metadata' => serialize( array() ),
 959                         'sha1' => wfBaseConvert( '3', 16, 36, 31 ),
 960                         'fileExists' => true
 961                 ), $this->db->timestamp( '20010115123500' ), $user );
 962         }
 963
 964         public function teardownDatabase() {
 965                 if ( !$this->databaseSetupDone ) {
 966                         $this->teardownGlobals();
 967                         return;
 968                 }
 969                 $this->teardownUploadDir( $this->uploadDir );
 970
 971                 $this->dbClone->destroy();
 972                 $this->databaseSetupDone = false;
 973
 974                 if ( $this->useTemporaryTables ) {
 975                         if ( $this->db->getType() == 'sqlite' ) {
 976                                 # Under SQLite the searchindex table is virtual and need
 977                                 # to be explicitly destroyed. See bug 29912
 978                                 # See also MediaWikiTestCase::destroyDB()
 979                                 wfDebug( __METHOD__ . " explicitly destroying sqlite virtual table parsertest_searchindex\n" );
 980                                 $this->db->query( "DROP TABLE `parsertest_searchindex`" );
 981                         }
 982                         # Don't need to do anything
 983                         $this->teardownGlobals();
 984                         return;
 985                 }
 986
 987                 $tables = $this->listTables();
 988
 989                 foreach ( $tables as $table ) {
 990                         $sql = $this->db->getType() == 'oracle' ? "DROP TABLE pt_$table DROP CONSTRAINTS" : "DROP TABLE `parsertest_$table`";
 991                         $this->db->query( $sql );
 992                 }
 993
 994                 if ( $this->db->getType() == 'oracle' ) {
 995                         $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' );
 996                 }
 997
 998                 $this->teardownGlobals();
 999         }
1000
1001         /**
1002          * Create a dummy uploads directory which will contain a couple
1003          * of files in order to pass existence tests.
1004          *
1005          * @return String: the directory
1006          */
1007         private function setupUploadDir() {
1008                 global $IP;
1009
1010                 if ( $this->keepUploads ) {
1011                         $dir = wfTempDir() . '/mwParser-images';
1012
1013                         if ( is_dir( $dir ) ) {
1014                                 return $dir;
1015                         }
1016                 } else {
1017                         $dir = wfTempDir() . "/mwParser-" . mt_rand() . "-images";
1018                 }
1019
1020                 // wfDebug( "Creating upload directory $dir\n" );
1021                 if ( file_exists( $dir ) ) {
1022                         wfDebug( "Already exists!\n" );
1023                         return $dir;
1024                 }
1025
1026                 wfMkdirParents( $dir . '/3/3a', null, __METHOD__ );
1027                 copy( "$IP/skins/monobook/headbg.jpg", "$dir/3/3a/Foobar.jpg" );
1028                 wfMkdirParents( $dir . '/e/ea', null, __METHOD__ );
1029                 copy( "$IP/skins/monobook/wiki.png", "$dir/e/ea/Thumb.png" );
1030                 wfMkdirParents( $dir . '/0/09', null, __METHOD__ );
1031                 copy( "$IP/skins/monobook/headbg.jpg", "$dir/0/09/Bad.jpg" );
1032                 wfMkdirParents( $dir . '/f/ff', null, __METHOD__ );
1033                 copy( "$IP/skins/monobook/headbg.jpg", "$dir/f/ff/Foobar.svg" );
1034                 file_put_contents( "$dir/f/ff/Foobar.svg",
1035                         '<?xml version="1.0" encoding="utf-8"?>' .
1036                         '<svg xmlns="http://www.w3.org/2000/svg" />' );
1037                 return $dir;
1038         }
1039
1040         /**
1041          * Restore default values and perform any necessary clean-up
1042          * after each test runs.
1043          */
1044         private function teardownGlobals() {
1045                 RepoGroup::destroySingleton();
1046                 FileBackendGroup::destroySingleton();
1047                 LockManagerGroup::destroySingletons();
1048                 LinkCache::singleton()->clear();
1049
1050                 foreach ( $this->savedGlobals as $var => $val ) {
1051                         $GLOBALS[$var] = $val;
1052                 }
1053         }
1054
1055         /**
1056          * Remove the dummy uploads directory
1057          */
1058         private function teardownUploadDir( $dir ) {
1059                 if ( $this->keepUploads ) {
1060                         return;
1061                 }
1062
1063                 // delete the files first, then the dirs.
1064                 self::deleteFiles(
1065                         array(
1066                                 "$dir/3/3a/Foobar.jpg",
1067                                 "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg",
1068                                 "$dir/thumb/3/3a/Foobar.jpg/200px-Foobar.jpg",
1069                                 "$dir/thumb/3/3a/Foobar.jpg/640px-Foobar.jpg",
1070                                 "$dir/thumb/3/3a/Foobar.jpg/120px-Foobar.jpg",
1071                                 "$dir/thumb/3/3a/Foobar.jpg/1280px-Foobar.jpg",
1072                                 "$dir/thumb/3/3a/Foobar.jpg/20px-Foobar.jpg",
1073                                 "$dir/thumb/3/3a/Foobar.jpg/270px-Foobar.jpg",
1074                                 "$dir/thumb/3/3a/Foobar.jpg/300px-Foobar.jpg",
1075                                 "$dir/thumb/3/3a/Foobar.jpg/30px-Foobar.jpg",
1076                                 "$dir/thumb/3/3a/Foobar.jpg/360px-Foobar.jpg",
1077                                 "$dir/thumb/3/3a/Foobar.jpg/400px-Foobar.jpg",
1078                                 "$dir/thumb/3/3a/Foobar.jpg/40px-Foobar.jpg",
1079                                 "$dir/thumb/3/3a/Foobar.jpg/70px-Foobar.jpg",
1080                                 "$dir/thumb/3/3a/Foobar.jpg/960px-Foobar.jpg",
1081
1082                                 "$dir/e/ea/Thumb.png",
1083
1084                                 "$dir/0/09/Bad.jpg",
1085
1086                                 "$dir/f/ff/Foobar.svg",
1087                                 "$dir/thumb/f/ff/Foobar.svg/180px-Foobar.svg.png",
1088                                 "$dir/thumb/f/ff/Foobar.svg/360px-Foobar.svg.png",
1089                                 "$dir/thumb/f/ff/Foobar.svg/langde-270px-Foobar.svg.png",
1090                                 "$dir/thumb/f/ff/Foobar.svg/270px-Foobar.svg.png",
1091                                 "$dir/thumb/f/ff/Foobar.svg/langde-180px-Foobar.svg.png",
1092                                 "$dir/thumb/f/ff/Foobar.svg/langde-360px-Foobar.svg.png",
1093
1094                                 "$dir/math/f/a/5/fa50b8b616463173474302ca3e63586b.png",
1095                         )
1096                 );
1097
1098                 self::deleteDirs(
1099                         array(
1100                                 "$dir/3/3a",
1101                                 "$dir/3",
1102                                 "$dir/thumb/6/65",
1103                                 "$dir/thumb/6",
1104                                 "$dir/thumb/3/3a/Foobar.jpg",
1105                                 "$dir/thumb/3/3a",
1106                                 "$dir/thumb/3",
1107                                 "$dir/e/ea",
1108                                 "$dir/e",
1109                                 "$dir/f/ff/",
1110                                 "$dir/f/",
1111                                 "$dir/thumb/f/ff/Foobar.svg",
1112                                 "$dir/thumb/f/ff/",
1113                                 "$dir/thumb/f/",
1114                                 "$dir/0/09/",
1115                                 "$dir/0/",
1116                                 "$dir/thumb",
1117                                 "$dir/math/f/a/5",
1118                                 "$dir/math/f/a",
1119                                 "$dir/math/f",
1120                                 "$dir/math",
1121                                 "$dir",
1122                         )
1123                 );
1124         }
1125
1126         /**
1127          * Delete the specified files, if they exist.
1128          * @param $files Array: full paths to files to delete.
1129          */
1130         private static function deleteFiles( $files ) {
1131                 foreach ( $files as $file ) {
1132                         if ( file_exists( $file ) ) {
1133                                 unlink( $file );
1134                         }
1135                 }
1136         }
1137
1138         /**
1139          * Delete the specified directories, if they exist. Must be empty.
1140          * @param $dirs Array: full paths to directories to delete.
1141          */
1142         private static function deleteDirs( $dirs ) {
1143                 foreach ( $dirs as $dir ) {
1144                         if ( is_dir( $dir ) ) {
1145                                 rmdir( $dir );
1146                         }
1147                 }
1148         }
1149
1150         /**
1151          * "Running test $desc..."
1152          */
1153         protected function showTesting( $desc ) {
1154                 print "Running test $desc... ";
1155         }
1156
1157         /**
1158          * Print a happy success message.
1159          *
1160          * Refactored in 1.22 to use ParserTestResult
1161          *
1162          * @param $testResult ParserTestResult
1163          * @return Boolean
1164          */
1165         protected function showSuccess( ParserTestResult $testResult ) {
1166                 if ( $this->showProgress ) {
1167                         print $this->term->color( '1;32' ) . 'PASSED' . $this->term->reset() . "\n";
1168                 }
1169
1170                 return true;
1171         }
1172
1173         /**
1174          * Print a failure message and provide some explanatory output
1175          * about what went wrong if so configured.
1176          *
1177          * Refactored in 1.22 to use ParserTestResult
1178          *
1179          * @param $testResult ParserTestResult
1180          * @return Boolean
1181          */
1182         protected function showFailure( ParserTestResult $testResult ) {
1183                 if ( $this->showFailure ) {
1184                         if ( !$this->showProgress ) {
1185                                 # In quiet mode we didn't show the 'Testing' message before the
1186                                 # test, in case it succeeded. Show it now:
1187                                 $this->showTesting( $testResult->description );
1188                         }
1189
1190                         print $this->term->color( '31' ) . 'FAILED!' . $this->term->reset() . "\n";
1191
1192                         if ( $this->showOutput ) {
1193                                 print "--- Expected ---\n{$testResult->expected}\n";
1194                                 print "--- Actual ---\n{$testResult->actual}\n";
1195                         }
1196
1197                         if ( $this->showDiffs ) {
1198                                 print $this->quickDiff( $testResult->expected, $testResult->actual );
1199                                 if ( !$this->wellFormed( $testResult->actual ) ) {
1200                                         print "XML error: $this->mXmlError\n";
1201                                 }
1202                         }
1203                 }
1204
1205                 return false;
1206         }
1207
1208         /**
1209          * Run given strings through a diff and return the (colorized) output.
1210          * Requires writable /tmp directory and a 'diff' command in the PATH.
1211          *
1212          * @param $input String
1213          * @param $output String
1214          * @param $inFileTail String: tailing for the input file name
1215          * @param $outFileTail String: tailing for the output file name
1216          * @return String
1217          */
1218         protected function quickDiff( $input, $output, $inFileTail = 'expected', $outFileTail = 'actual' ) {
1219                 # Windows, or at least the fc utility, is retarded
1220                 $slash = wfIsWindows() ? '\\' : '/';
1221                 $prefix = wfTempDir() . "{$slash}mwParser-" . mt_rand();
1222
1223                 $infile = "$prefix-$inFileTail";
1224                 $this->dumpToFile( $input, $infile );
1225
1226                 $outfile = "$prefix-$outFileTail";
1227                 $this->dumpToFile( $output, $outfile );
1228
1229                 $shellInfile = wfEscapeShellArg( $infile );
1230                 $shellOutfile = wfEscapeShellArg( $outfile );
1231
1232                 global $wgDiff3;
1233                 // we assume that people with diff3 also have usual diff
1234                 $shellCommand = ( wfIsWindows() && !$wgDiff3 ) ? 'fc' : 'diff -au';
1235
1236                 $diff = wfShellExec( "$shellCommand $shellInfile $shellOutfile" );
1237
1238                 unlink( $infile );
1239                 unlink( $outfile );
1240
1241                 return $this->colorDiff( $diff );
1242         }
1243
1244         /**
1245          * Write the given string to a file, adding a final newline.
1246          *
1247          * @param $data String
1248          * @param $filename String
1249          */
1250         private function dumpToFile( $data, $filename ) {
1251                 $file = fopen( $filename, "wt" );
1252                 fwrite( $file, $data . "\n" );
1253                 fclose( $file );
1254         }
1255
1256         /**
1257          * Colorize unified diff output if set for ANSI color output.
1258          * Subtractions are colored blue, additions red.
1259          *
1260          * @param $text String
1261          * @return String
1262          */
1263         protected function colorDiff( $text ) {
1264                 return preg_replace(
1265                         array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
1266                         array( $this->term->color( 34 ) . '$1' . $this->term->reset(),
1267                                 $this->term->color( 31 ) . '$1' . $this->term->reset() ),
1268                         $text );
1269         }
1270
1271         /**
1272          * Show "Reading tests from ..."
1273          *
1274          * @param $path String
1275          */
1276         public function showRunFile( $path ) {
1277                 print $this->term->color( 1 ) .
1278                         "Reading tests from \"$path\"..." .
1279                         $this->term->reset() .
1280                         "\n";
1281         }
1282
1283         /**
1284          * Insert a temporary test article
1285          * @param $name String: the title, including any prefix
1286          * @param $text String: the article text
1287          * @param $line Integer: the input line number, for reporting errors
1288          * @param $ignoreDuplicate Boolean: whether to silently ignore duplicate pages
1289          */
1290         public static function addArticle( $name, $text, $line = 'unknown', $ignoreDuplicate = '' ) {
1291                 global $wgCapitalLinks;
1292
1293                 $oldCapitalLinks = $wgCapitalLinks;
1294                 $wgCapitalLinks = true; // We only need this from SetupGlobals() See r70917#c8637
1295
1296                 $text = self::chomp( $text );
1297                 $name = self::chomp( $name );
1298
1299                 $title = Title::newFromText( $name );
1300
1301                 if ( is_null( $title ) ) {
1302                         throw new MWException( "invalid title '$name' at line $line\n" );
1303                 }
1304
1305                 $page = WikiPage::factory( $title );
1306                 $page->loadPageData( 'fromdbmaster' );
1307
1308                 if ( $page->exists() ) {
1309                         if ( $ignoreDuplicate == 'ignoreduplicate' ) {
1310                                 return;
1311                         } else {
1312                                 throw new MWException( "duplicate article '$name' at line $line\n" );
1313                         }
1314                 }
1315
1316                 $page->doEditContent( ContentHandler::makeContent( $text, $title ), '', EDIT_NEW );
1317
1318                 $wgCapitalLinks = $oldCapitalLinks;
1319         }
1320
1321         /**
1322          * Steal a callback function from the primary parser, save it for
1323          * application to our scary parser. If the hook is not installed,
1324          * abort processing of this file.
1325          *
1326          * @param $name String
1327          * @return Bool true if tag hook is present
1328          */
1329         public function requireHook( $name ) {
1330                 global $wgParser;
1331
1332                 $wgParser->firstCallInit(); // make sure hooks are loaded.
1333
1334                 if ( isset( $wgParser->mTagHooks[$name] ) ) {
1335                         $this->hooks[$name] = $wgParser->mTagHooks[$name];
1336                 } else {
1337                         echo "   This test suite requires the '$name' hook extension, skipping.\n";
1338                         return false;
1339                 }
1340
1341                 return true;
1342         }
1343
1344         /**
1345          * Steal a callback function from the primary parser, save it for
1346          * application to our scary parser. If the hook is not installed,
1347          * abort processing of this file.
1348          *
1349          * @param $name String
1350          * @return Bool true if function hook is present
1351          */
1352         public function requireFunctionHook( $name ) {
1353                 global $wgParser;
1354
1355                 $wgParser->firstCallInit(); // make sure hooks are loaded.
1356
1357                 if ( isset( $wgParser->mFunctionHooks[$name] ) ) {
1358                         $this->functionHooks[$name] = $wgParser->mFunctionHooks[$name];
1359                 } else {
1360                         echo "   This test suite requires the '$name' function hook extension, skipping.\n";
1361                         return false;
1362                 }
1363
1364                 return true;
1365         }
1366
1367         /**
1368          * Run the "tidy" command on text if the $wgUseTidy
1369          * global is true
1370          *
1371          * @param $text String: the text to tidy
1372          * @return String
1373          */
1374         private function tidy( $text ) {
1375                 global $wgUseTidy;
1376
1377                 if ( $wgUseTidy ) {
1378                         $text = MWTidy::tidy( $text );
1379                 }
1380
1381                 return $text;
1382         }
1383
1384         private function wellFormed( $text ) {
1385                 $html =
1386                         Sanitizer::hackDocType() .
1387                                 '<html>' .
1388                                 $text .
1389                                 '</html>';
1390
1391                 $parser = xml_parser_create( "UTF-8" );
1392
1393                 # case folding violates XML standard, turn it off
1394                 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
1395
1396                 if ( !xml_parse( $parser, $html, true ) ) {
1397                         $err = xml_error_string( xml_get_error_code( $parser ) );
1398                         $position = xml_get_current_byte_index( $parser );
1399                         $fragment = $this->extractFragment( $html, $position );
1400                         $this->mXmlError = "$err at byte $position:\n$fragment";
1401                         xml_parser_free( $parser );
1402
1403                         return false;
1404                 }
1405
1406                 xml_parser_free( $parser );
1407
1408                 return true;
1409         }
1410
1411         private function extractFragment( $text, $position ) {
1412                 $start = max( 0, $position - 10 );
1413                 $before = $position - $start;
1414                 $fragment = '...' .
1415                         $this->term->color( 34 ) .
1416                         substr( $text, $start, $before ) .
1417                         $this->term->color( 0 ) .
1418                         $this->term->color( 31 ) .
1419                         $this->term->color( 1 ) .
1420                         substr( $text, $position, 1 ) .
1421                         $this->term->color( 0 ) .
1422                         $this->term->color( 34 ) .
1423                         substr( $text, $position + 1, 9 ) .
1424                         $this->term->color( 0 ) .
1425                         '...';
1426                 $display = str_replace( "\n", ' ', $fragment );
1427                 $caret = '   ' .
1428                         str_repeat( ' ', $before ) .
1429                         $this->term->color( 31 ) .
1430                         '^' .
1431                         $this->term->color( 0 );
1432
1433                 return "$display\n$caret";
1434         }
1435
1436         static function getFakeTimestamp( &$parser, &$ts ) {
1437                 $ts = 123;
1438                 return true;
1439         }
1440 }