maintenance/parserTests.inc

   1 <?php
   2 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
   3 # http://www.mediawiki.org/
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License along
  16 # with this program; if not, write to the Free Software Foundation, Inc.,
  17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18 # http://www.gnu.org/copyleft/gpl.html
  19
  20 /**
  21  * @todo Make this more independent of the configuration (and if possible the database)
  22  * @todo document
  23  * @file
  24  * @ingroup Maintenance
  25  */
  26
  27 /** */
  28 $options = array( 'quick', 'color', 'quiet', 'help', 'show-output', 'record'. 'run-disabled' );
  29 $optionsWithArgs = array( 'regex', 'seed', 'setversion' );
  30
  31 require_once( dirname(__FILE__) . '/commandLine.inc' );
  32 require_once( "$IP/maintenance/parserTestsParserHook.php" );
  33 require_once( "$IP/maintenance/parserTestsStaticParserHook.php" );
  34 require_once( "$IP/maintenance/parserTestsParserTime.php" );
  35
  36 /**
  37  * @ingroup Maintenance
  38  */
  39 class ParserTest {
  40         /**
  41          * boolean $color whereas output should be colorized
  42          */
  43         private $color;
  44
  45         /**
  46          * boolean $showOutput Show test output
  47          */
  48         private $showOutput;
  49
  50         /**
  51          * boolean $useTemporaryTables Use temporary tables for the temporary database
  52          */
  53         private $useTemporaryTables = true;
  54
  55         /**
  56          * boolean $databaseSetupDone True if the database has been set up
  57          */
  58         private $databaseSetupDone = false;
  59
  60         /**
  61          * string $oldTablePrefix Original table prefix
  62          */
  63         private $oldTablePrefix;
  64
  65         private $maxFuzzTestLength = 300;
  66         private $fuzzSeed = 0;
  67         private $memoryLimit = 50;
  68
  69         /**
  70          * Sets terminal colorization and diff/quick modes depending on OS and
  71          * command-line options (--color and --quick).
  72          */
  73         public function ParserTest() {
  74                 global $options;
  75
  76                 # Only colorize output if stdout is a terminal.
  77                 $this->color = !wfIsWindows() && posix_isatty(1);
  78
  79                 if( isset( $options['color'] ) ) {
  80                         switch( $options['color'] ) {
  81                         case 'no':
  82                                 $this->color = false;
  83                                 break;
  84                         case 'yes':
  85                         default:
  86                                 $this->color = true;
  87                                 break;
  88                         }
  89                 }
  90                 $this->term = $this->color
  91                         ? new AnsiTermColorer()
  92                         : new DummyTermColorer();
  93
  94                 $this->showDiffs = !isset( $options['quick'] );
  95                 $this->showProgress = !isset( $options['quiet'] );
  96                 $this->showFailure = !(
  97                         isset( $options['quiet'] )
  98                         && ( isset( $options['record'] )
  99                                 || isset( $options['compare'] ) ) ); // redundant output
 100
 101                 $this->showOutput = isset( $options['show-output'] );
 102
 103
 104                 if (isset($options['regex'])) {
 105                         if ( isset( $options['record'] ) ) {
 106                                 echo "Warning: --record cannot be used with --regex, disabling --record\n";
 107                                 unset( $options['record'] );
 108                         }
 109                         $this->regex = $options['regex'];
 110                 } else {
 111                         # Matches anything
 112                         $this->regex = '';
 113                 }
 114
 115                 if( isset( $options['record'] ) ) {
 116                         $this->recorder = new DbTestRecorder( $this );
 117                 } elseif( isset( $options['compare'] ) ) {
 118                         $this->recorder = new DbTestPreviewer( $this );
 119                 } elseif( isset( $options['upload'] ) ) {
 120                         $this->recorder = new RemoteTestRecorder( $this );
 121                 } else {
 122                         $this->recorder = new TestRecorder( $this );
 123                 }
 124                 $this->keepUploads = isset( $options['keep-uploads'] );
 125
 126                 if ( isset( $options['seed'] ) ) {
 127                         $this->fuzzSeed = intval( $options['seed'] ) - 1;
 128                 }
 129
 130                 $this->runDisabled = isset( $options['run-disabled'] );
 131
 132                 $this->hooks = array();
 133                 $this->functionHooks = array();
 134         }
 135
 136         /**
 137          * Remove last character if it is a newline
 138          */
 139         private function chomp($s) {
 140                 if (substr($s, -1) === "\n") {
 141                         return substr($s, 0, -1);
 142                 }
 143                 else {
 144                         return $s;
 145                 }
 146         }
 147
 148         /**
 149          * Run a fuzz test series
 150          * Draw input from a set of test files
 151          */
 152         function fuzzTest( $filenames ) {
 153                 $dict = $this->getFuzzInput( $filenames );
 154                 $dictSize = strlen( $dict );
 155                 $logMaxLength = log( $this->maxFuzzTestLength );
 156                 $this->setupDatabase();
 157                 ini_set( 'memory_limit', $this->memoryLimit * 1048576 );
 158
 159                 $numTotal = 0;
 160                 $numSuccess = 0;
 161                 $user = new User;
 162                 $opts = ParserOptions::newFromUser( $user );
 163                 $title = Title::makeTitle( NS_MAIN, 'Parser_test' );
 164
 165                 while ( true ) {
 166                         // Generate test input
 167                         mt_srand( ++$this->fuzzSeed );
 168                         $totalLength = mt_rand( 1, $this->maxFuzzTestLength );
 169                         $input = '';
 170                         while ( strlen( $input ) < $totalLength ) {
 171                                 $logHairLength = mt_rand( 0, 1000000 ) / 1000000 * $logMaxLength;
 172                                 $hairLength = min( intval( exp( $logHairLength ) ), $dictSize );
 173                                 $offset = mt_rand( 0, $dictSize - $hairLength );
 174                                 $input .= substr( $dict, $offset, $hairLength );
 175                         }
 176
 177                         $this->setupGlobals();
 178                         $parser = $this->getParser();
 179                         // Run the test
 180                         try {
 181                                 $parser->parse( $input, $title, $opts );
 182                                 $fail = false;
 183                         } catch ( Exception $exception ) {
 184                                 $fail = true;
 185                         }
 186
 187                         if ( $fail ) {
 188                                 echo "Test failed with seed {$this->fuzzSeed}\n";
 189                                 echo "Input:\n";
 190                                 var_dump( $input );
 191                                 echo "\n\n";
 192                                 echo "$exception\n";
 193                         } else {
 194                                 $numSuccess++;
 195                         }
 196                         $numTotal++;
 197                         $this->teardownGlobals();
 198                         $parser->__destruct();
 199
 200                         if ( $numTotal % 100 == 0 ) {
 201                                 $usage = intval( memory_get_usage( true ) / $this->memoryLimit / 1048576 * 100 );
 202                                 echo "{$this->fuzzSeed}: $numSuccess/$numTotal (mem: $usage%)\n";
 203                                 if ( $usage > 90 ) {
 204                                         echo "Out of memory:\n";
 205                                         $memStats = $this->getMemoryBreakdown();
 206                                         foreach ( $memStats as $name => $usage ) {
 207                                                 echo "$name: $usage\n";
 208                                         }
 209                                         $this->abort();
 210                                 }
 211                         }
 212                 }
 213         }
 214
 215         /**
 216          * Get an input dictionary from a set of parser test files
 217          */
 218         function getFuzzInput( $filenames ) {
 219                 $dict = '';
 220                 foreach( $filenames as $filename ) {
 221                         $contents = file_get_contents( $filename );
 222                         preg_match_all( '/!!\s*input\n(.*?)\n!!\s*result/s', $contents, $matches );
 223                         foreach ( $matches[1] as $match ) {
 224                                 $dict .= $match . "\n";
 225                         }
 226                 }
 227                 return $dict;
 228         }
 229
 230         /**
 231          * Get a memory usage breakdown
 232          */
 233         function getMemoryBreakdown() {
 234                 $memStats = array();
 235                 foreach ( $GLOBALS as $name => $value ) {
 236                         $memStats['$'.$name] = strlen( serialize( $value ) );
 237                 }
 238                 $classes = get_declared_classes();
 239                 foreach ( $classes as $class ) {
 240                         $rc = new ReflectionClass( $class );
 241                         $props = $rc->getStaticProperties();
 242                         $memStats[$class] = strlen( serialize( $props ) );
 243                         $methods = $rc->getMethods();
 244                         foreach ( $methods as $method ) {
 245                                 $memStats[$class] += strlen( serialize( $method->getStaticVariables() ) );
 246                         }
 247                 }
 248                 $functions = get_defined_functions();
 249                 foreach ( $functions['user'] as $function ) {
 250                         $rf = new ReflectionFunction( $function );
 251                         $memStats["$function()"] = strlen( serialize( $rf->getStaticVariables() ) );
 252                 }
 253                 asort( $memStats );
 254                 return $memStats;
 255         }
 256
 257         function abort() {
 258                 $this->abort();
 259         }
 260
 261         /**
 262          * Run a series of tests listed in the given text files.
 263          * Each test consists of a brief description, wikitext input,
 264          * and the expected HTML output.
 265          *
 266          * Prints status updates on stdout and counts up the total
 267          * number and percentage of passed tests.
 268          *
 269          * @param array of strings $filenames
 270          * @return bool True if passed all tests, false if any tests failed.
 271          */
 272         public function runTestsFromFiles( $filenames ) {
 273                 $this->recorder->start();
 274                 $this->setupDatabase();
 275                 $ok = true;
 276                 foreach( $filenames as $filename ) {
 277                         $ok = $this->runFile( $filename ) && $ok;
 278                 }
 279                 $this->teardownDatabase();
 280                 $this->recorder->report();
 281                 $this->recorder->end();
 282                 return $ok;
 283         }
 284
 285         private function runFile( $filename ) {
 286                 $infile = fopen( $filename, 'rt' );
 287                 if( !$infile ) {
 288                         wfDie( "Couldn't open file '$filename'\n" );
 289                 } else {
 290                         global $IP;
 291                         $relative = wfRelativePath( $filename, $IP );
 292                         $this->showRunFile( $relative );
 293                 }
 294
 295                 $data = array();
 296                 $section = null;
 297                 $n = 0;
 298                 $ok = true;
 299                 while( false !== ($line = fgets( $infile ) ) ) {
 300                         $n++;
 301                         $matches = array();
 302                         if( preg_match( '/^!!\s*(\w+)/', $line, $matches ) ) {
 303                                 $section = strtolower( $matches[1] );
 304                                 if( $section == 'endarticle') {
 305                                         if( !isset( $data['text'] ) ) {
 306                                                 wfDie( "'endarticle' without 'text' at line $n of $filename\n" );
 307                                         }
 308                                         if( !isset( $data['article'] ) ) {
 309                                                 wfDie( "'endarticle' without 'article' at line $n of $filename\n" );
 310                                         }
 311                                         $this->addArticle($this->chomp($data['article']), $this->chomp($data['text']), $n);
 312                                         $data = array();
 313                                         $section = null;
 314                                         continue;
 315                                 }
 316                                 if( $section == 'endhooks' ) {
 317                                         if( !isset( $data['hooks'] ) ) {
 318                                                 wfDie( "'endhooks' without 'hooks' at line $n of $filename\n" );
 319                                         }
 320                                         foreach( explode( "\n", $data['hooks'] ) as $line ) {
 321                                                 $line = trim( $line );
 322                                                 if( $line ) {
 323                                                         $this->requireHook( $line );
 324                                                 }
 325                                         }
 326                                         $data = array();
 327                                         $section = null;
 328                                         continue;
 329                                 }
 330                                 if( $section == 'endfunctionhooks' ) {
 331                                         if( !isset( $data['functionhooks'] ) ) {
 332                                                 wfDie( "'endfunctionhooks' without 'functionhooks' at line $n of $filename\n" );
 333                                         }
 334                                         foreach( explode( "\n", $data['functionhooks'] ) as $line ) {
 335                                                 $line = trim( $line );
 336                                                 if( $line ) {
 337                                                         $this->requireFunctionHook( $line );
 338                                                 }
 339                                         }
 340                                         $data = array();
 341                                         $section = null;
 342                                         continue;
 343                                 }
 344                                 if( $section == 'end' ) {
 345                                         if( !isset( $data['test'] ) ) {
 346                                                 wfDie( "'end' without 'test' at line $n of $filename\n" );
 347                                         }
 348                                         if( !isset( $data['input'] ) ) {
 349                                                 wfDie( "'end' without 'input' at line $n of $filename\n" );
 350                                         }
 351                                         if( !isset( $data['result'] ) ) {
 352                                                 wfDie( "'end' without 'result' at line $n of $filename\n" );
 353                                         }
 354                                         if( !isset( $data['options'] ) ) {
 355                                                 $data['options'] = '';
 356                                         }
 357                                         else {
 358                                                 $data['options'] = $this->chomp( $data['options'] );
 359                                         }
 360                                         if (!isset( $data['config'] ) )
 361                                                 $data['config'] = '';
 362
 363                                         if ( (preg_match('/\\bdisabled\\b/i', $data['options'])
 364                                                 || !preg_match("/{$this->regex}/i", $data['test'])) && !$this->runDisabled ) {
 365                                                 # disabled test
 366                                                 $data = array();
 367                                                 $section = null;
 368                                                 continue;
 369                                         }
 370                                         $result = $this->runTest(
 371                                                 $this->chomp( $data['test'] ),
 372                                                 $this->chomp( $data['input'] ),
 373                                                 $this->chomp( $data['result'] ),
 374                                                 $this->chomp( $data['options'] ),
 375                                                 $this->chomp( $data['config']   )
 376                                                 );
 377                                         $ok = $ok && $result;
 378                                         $this->recorder->record( $this->chomp( $data['test'] ), $result );
 379                                         $data = array();
 380                                         $section = null;
 381                                         continue;
 382                                 }
 383                                 if ( isset ($data[$section] ) ) {
 384                                         wfDie( "duplicate section '$section' at line $n of $filename\n" );
 385                                 }
 386                                 $data[$section] = '';
 387                                 continue;
 388                         }
 389                         if( $section ) {
 390                                 $data[$section] .= $line;
 391                         }
 392                 }
 393                 if ( $this->showProgress ) {
 394                         print "\n";
 395                 }
 396                 return $ok;
 397         }
 398
 399         /**
 400          * Get a Parser object
 401          */
 402         function getParser() {
 403                 global $wgParserConf;
 404                 $class = $wgParserConf['class'];
 405                 $parser = new $class( $wgParserConf );
 406                 foreach( $this->hooks as $tag => $callback ) {
 407                         $parser->setHook( $tag, $callback );
 408                 }
 409                 foreach( $this->functionHooks as $tag => $bits ) {
 410                         list( $callback, $flags ) = $bits;
 411                         $parser->setFunctionHook( $tag, $callback, $flags );
 412                 }
 413                 wfRunHooks( 'ParserTestParser', array( &$parser ) );
 414                 return $parser;
 415         }
 416
 417         /**
 418          * Run a given wikitext input through a freshly-constructed wiki parser,
 419          * and compare the output against the expected results.
 420          * Prints status and explanatory messages to stdout.
 421          *
 422          * @param string $input Wikitext to try rendering
 423          * @param string $result Result to output
 424          * @return bool
 425          */
 426         private function runTest( $desc, $input, $result, $opts, $config ) {
 427                 if( $this->showProgress ) {
 428                         $this->showTesting( $desc );
 429                 }
 430
 431                 $opts = $this->parseOptions( $opts );
 432                 $this->setupGlobals($opts, $config);
 433
 434                 $user = new User();
 435                 $options = ParserOptions::newFromUser( $user );
 436
 437                 if ( isset( $opts['math'] ) ) {
 438                         # XXX this should probably be done by the ParserOptions
 439                         $options->setUseTex(true);
 440                 }
 441
 442                 $m = array();
 443                 if (isset( $opts['title'] ) ) {
 444                         $titleText = $opts['title'];
 445                 }
 446                 else {
 447                         $titleText = 'Parser test';
 448                 }
 449
 450                 $noxml = isset( $opts['noxml'] );
 451                 $local = isset( $opts['local'] );
 452                 $parser = $this->getParser();
 453                 $title = Title::newFromText( $titleText );
 454
 455                 $matches = array();
 456                 if( isset( $opts['pst'] ) ) {
 457                         $out = $parser->preSaveTransform( $input, $title, $user, $options );
 458                 } elseif( isset( $opts['msg'] ) ) {
 459                         $out = $parser->transformMsg( $input, $options );
 460                 } elseif( isset( $opts['section'] ) ) {
 461                         $section = $opts['section'];
 462                         $out = $parser->getSection( $input, $section );
 463                 } elseif( isset( $opts['replace'] ) ) {
 464                         $section = $opts['replace'][0];
 465                         $replace = $opts['replace'][1];
 466                         $out = $parser->replaceSection( $input, $section, $replace );
 467                 } elseif( isset( $opts['comment'] ) ) {
 468                         $linker = $user->getSkin();
 469                         $out = $linker->formatComment( $input, $title, $local );
 470                 } else {
 471                         $output = $parser->parse( $input, $title, $options, true, true, 1337 );
 472                         $out = $output->getText();
 473
 474                         if (isset( $opts['ill'] ) ) {
 475                                 $out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
 476                         } elseif( isset( $opts['cat'] ) ) {
 477                                 global $wgOut;
 478                                 $wgOut->addCategoryLinks($output->getCategories());
 479                                 $cats = $wgOut->getCategoryLinks();
 480                                 if ( isset( $cats['normal'] ) ) {
 481                                         $out = $this->tidy( implode( ' ', $cats['normal'] ) );
 482                                 } else {
 483                                         $out = '';
 484                                 }
 485                         }
 486
 487                         $result = $this->tidy($result);
 488                 }
 489
 490                 $this->teardownGlobals();
 491
 492                 if( $result === $out && ( $noxml === true || $this->wellFormed( $out ) ) ) {
 493                         return $this->showSuccess( $desc );
 494                 } else {
 495                         return $this->showFailure( $desc, $result, $out );
 496                 }
 497         }
 498
 499
 500         /**
 501          * Use a regex to find out the value of an option
 502          * @param $key name of option val to retrieve
 503          * @param $opts Options array to look in
 504          * @param $defaults Default value returned if not found
 505          */
 506         private static function getOptionValue( $key, $opts, $default ) {
 507                 $key = strtolower( $key );
 508                 if( isset( $opts[$key] ) ) {
 509                         return $opts[$key];
 510                 } else {
 511                         return $default;
 512                 }
 513         }
 514
 515         private function parseOptions( $instring ) {
 516                 $opts = array();
 517                 $lines = explode( "\n", $instring );
 518                 // foo
 519                 // foo=bar
 520                 // foo="bar baz"
 521                 // foo=[[bar baz]]
 522                 // foo=bar,"baz quux"
 523                 $regex = '/\b
 524                         ([\w-]+)                                                # Key
 525                         \b
 526                         (?:\s*
 527                                 =                                               # First sub-value
 528                                 \s*
 529                                 (
 530                                         "
 531                                                 [^"]*                   # Quoted val
 532                                         "
 533                                 |
 534                                         \[\[
 535                                                 [^]]*                   # Link target
 536                                         \]\]
 537                                 |
 538                                         [\w-]+                          # Plain word
 539                                 )
 540                                 (?:\s*
 541                                         ,                                       # Sub-vals 1..N
 542                                         \s*
 543                                         (
 544                                                 "[^"]*"                 # Quoted val
 545                                         |
 546                                                 \[\[[^]]*\]\]   # Link target
 547                                         |
 548                                                 [\w-]+                  # Plain word
 549                                         )
 550                                 )*
 551                         )?
 552                         /x';
 553
 554                 if( preg_match_all( $regex, $instring, $matches, PREG_SET_ORDER ) ) {
 555                         foreach( $matches as $bits ) {
 556                                 $match = array_shift( $bits );
 557                                 $key = strtolower( array_shift( $bits ) );
 558                                 if( count( $bits ) == 0 ) {
 559                                         $opts[$key] = true;
 560                                 } elseif( count( $bits ) == 1 ) {
 561                                         $opts[$key] = $this->cleanupOption( array_shift( $bits ) );
 562                                 } else {
 563                                         // Array!
 564                                         $opts[$key] = array_map( array( $this, 'cleanupOption' ), $bits );
 565                                 }
 566                         }
 567                 }
 568                 return $opts;
 569         }
 570
 571         private function cleanupOption( $opt ) {
 572                 if( substr( $opt, 0, 1 ) == '"' ) {
 573                         return substr( $opt, 1, -1 );
 574                 }
 575                 if( substr( $opt, 0, 2 ) == '[[' ) {
 576                         return substr( $opt, 2, -2 );
 577                 }
 578                 return $opt;
 579         }
 580
 581         /**
 582          * Set up the global variables for a consistent environment for each test.
 583          * Ideally this should replace the global configuration entirely.
 584          */
 585         private function setupGlobals($opts = '', $config = '') {
 586                 if( !isset( $this->uploadDir ) ) {
 587                         $this->uploadDir = $this->setupUploadDir();
 588                 }
 589
 590                 # Find out values for some special options.
 591                 $lang =
 592                         self::getOptionValue( 'language', $opts, 'en' );
 593                 $variant =
 594                         self::getOptionValue( 'variant', $opts, false );
 595                 $maxtoclevel =
 596                         self::getOptionValue( 'wgMaxTocLevel', $opts, 999 );
 597                 $linkHolderBatchSize =
 598                         self::getOptionValue( 'wgLinkHolderBatchSize', $opts, 1000 );
 599
 600                 $settings = array(
 601                         'wgServer' => 'http://localhost',
 602                         'wgScript' => '/index.php',
 603                         'wgScriptPath' => '/',
 604                         'wgArticlePath' => '/wiki/$1',
 605                         'wgActionPaths' => array(),
 606                         'wgLocalFileRepo' => array(
 607                                 'class' => 'LocalRepo',
 608                                 'name' => 'local',
 609                                 'directory' => $this->uploadDir,
 610                                 'url' => 'http://example.com/images',
 611                                 'hashLevels' => 2,
 612                                 'transformVia404' => false,
 613                         ),
 614                         'wgEnableUploads' => true,
 615                         'wgStyleSheetPath' => '/skins',
 616                         'wgSitename' => 'MediaWiki',
 617                         'wgServerName' => 'Britney Spears',
 618                         'wgLanguageCode' => $lang,
 619                         'wgContLanguageCode' => $lang,
 620                         'wgDBprefix' => 'parsertest_',
 621                         'wgRawHtml' => isset( $opts['rawhtml'] ),
 622                         'wgLang' => null,
 623                         'wgContLang' => null,
 624                         'wgNamespacesWithSubpages' => array( 0 => isset( $opts['subpage'] ) ),
 625                         'wgMaxTocLevel' => $maxtoclevel,
 626                         'wgCapitalLinks' => true,
 627                         'wgNoFollowLinks' => true,
 628                         'wgNoFollowDomainExceptions' => array(),
 629                         'wgThumbnailScriptPath' => false,
 630                         'wgUseTeX' => false,
 631                         'wgLocaltimezone' => 'UTC',
 632                         'wgAllowExternalImages' => true,
 633                         'wgUseTidy' => false,
 634                         'wgDefaultLanguageVariant' => $variant,
 635                         'wgVariantArticlePath' => false,
 636                         'wgGroupPermissions' => array( '*' => array(
 637                                 'createaccount' => true,
 638                                 'read'          => true,
 639                                 'edit'          => true,
 640                                 'createpage'    => true,
 641                                 'createtalk'    => true,
 642                         ) ),
 643                         'wgNamespaceProtection' => array( NS_MEDIAWIKI => 'editinterface' ),
 644                         'wgDefaultExternalStore' => array(),
 645                         'wgForeignFileRepos' => array(),
 646                         'wgLinkHolderBatchSize' => $linkHolderBatchSize,
 647                         'wgEnforceHtmlIds' => true,
 648                         'wgExternalLinkTarget' => false,
 649                         'wgAlwaysUseTidy' => false,
 650                         );
 651
 652                 if ($config) {
 653                         $configLines = explode( "\n", $config );
 654
 655                         foreach( $configLines as $line ) {
 656                                 list( $var, $value ) = explode( '=', $line, 2 );
 657
 658                                 $settings[$var] = eval("return $value;" );
 659                         }
 660                 }
 661
 662                 $this->savedGlobals = array();
 663                 foreach( $settings as $var => $val ) {
 664                         $this->savedGlobals[$var] = $GLOBALS[$var];
 665                         $GLOBALS[$var] = $val;
 666                 }
 667                 $langObj = Language::factory( $lang );
 668                 $GLOBALS['wgLang'] = $langObj;
 669                 $GLOBALS['wgContLang'] = $langObj;
 670                 $GLOBALS['wgMemc'] = new FakeMemCachedClient;
 671
 672                 //$GLOBALS['wgMessageCache'] = new MessageCache( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
 673
 674                 global $wgUser;
 675                 $wgUser = new User();
 676         }
 677
 678         /**
 679          * List of temporary tables to create, without prefix.
 680          * Some of these probably aren't necessary.
 681          */
 682         private function listTables() {
 683                 global $wgDBtype;
 684                 $tables = array('user', 'page', 'page_restrictions',
 685                         'protected_titles', 'revision', 'text', 'pagelinks', 'imagelinks',
 686                         'categorylinks', 'templatelinks', 'externallinks', 'langlinks',
 687                         'site_stats', 'hitcounter',     'ipblocks', 'image', 'oldimage',
 688                         'recentchanges', 'watchlist', 'math', 'interwiki',
 689                         'querycache', 'objectcache', 'job', 'l10n_cache', 'redirect', 'querycachetwo',
 690                         'archive', 'user_groups', 'page_props', 'category'
 691                 );
 692
 693                 if ($wgDBtype === 'mysql')
 694                         array_push( $tables, 'searchindex' );
 695
 696                 // Allow extensions to add to the list of tables to duplicate;
 697                 // may be necessary if they hook into page save or other code
 698                 // which will require them while running tests.
 699                 wfRunHooks( 'ParserTestTables', array( &$tables ) );
 700
 701                 return $tables;
 702         }
 703
 704         /**
 705          * Set up a temporary set of wiki tables to work with for the tests.
 706          * Currently this will only be done once per run, and any changes to
 707          * the db will be visible to later tests in the run.
 708          */
 709         private function setupDatabase() {
 710                 global $wgDBprefix, $wgDBtype;
 711                 if ( $this->databaseSetupDone ) {
 712                         return;
 713                 }
 714                 if ( $wgDBprefix === 'parsertest_' ) {
 715                         throw new MWException( 'setupDatabase should be called before setupGlobals' );
 716                 }
 717                 $this->databaseSetupDone = true;
 718                 $this->oldTablePrefix = $wgDBprefix;
 719
 720                 # CREATE TEMPORARY TABLE breaks if there is more than one server
 721                 # FIXME: r40209 makes temporary tables break even with just one server
 722                 # FIXME: (bug 15892); disabling the feature entirely as a temporary fix
 723                 if ( true || wfGetLB()->getServerCount() != 1 ) {
 724                         $this->useTemporaryTables = false;
 725                 }
 726
 727                 $temporary = $this->useTemporaryTables ? 'TEMPORARY' : '';
 728
 729                 $db = wfGetDB( DB_MASTER );
 730                 $tables = $this->listTables();
 731
 732                 if ( !( $wgDBtype == 'mysql' && strcmp( $db->getServerVersion(), '4.1' ) < 0 ) ) {
 733                         # Database that supports CREATE TABLE ... LIKE
 734
 735                         if( $wgDBtype == 'postgres' ) {
 736                                 $def = 'INCLUDING DEFAULTS';
 737                                 $temporary = 'TEMPORARY';
 738                         } else {
 739                                 $def = '';
 740                         }
 741                         foreach ( $tables as $tbl ) {
 742                                 # Clean up from previous aborted run.  So that table escaping
 743                                 # works correctly across DB engines, we need to change the pre-
 744                                 # fix back and forth so tableName() works right.
 745                                 $this->changePrefix( $this->oldTablePrefix );
 746                                 $oldTableName = $db->tableName( $tbl );
 747                                 $this->changePrefix( 'parsertest_' );
 748                                 $newTableName = $db->tableName( $tbl );
 749
 750                                 if ( $db->tableExists( $tbl ) && $wgDBtype != 'postgres' ) {
 751                                         $db->query( "DROP TABLE $newTableName" );
 752                                 }
 753                                 # Create new table
 754                                 $db->query( "CREATE $temporary TABLE $newTableName (LIKE $oldTableName $def)" );
 755                         }
 756                 } else {
 757                         # Hack for MySQL versions < 4.1, which don't support
 758                         # "CREATE TABLE ... LIKE". Note that
 759                         # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
 760                         # would not create the indexes we need....
 761                         #
 762                         # Note that we don't bother changing around the prefixes here be-
 763                         # cause we know we're using MySQL anyway.
 764                         foreach ($tables as $tbl) {
 765                                 $oldTableName = $db->tableName( $tbl );
 766                                 $res = $db->query("SHOW CREATE TABLE $oldTableName");
 767                                 $row = $db->fetchRow($res);
 768                                 $create = $row[1];
 769                                 $create_tmp = preg_replace('/CREATE TABLE `(.*?)`/',
 770                                         "CREATE $temporary TABLE `parsertest_$tbl`", $create);
 771                                 if ($create === $create_tmp) {
 772                                         # Couldn't do replacement
 773                                         wfDie("could not create temporary table $tbl");
 774                                 }
 775                                 $db->query($create_tmp);
 776                         }
 777                 }
 778
 779                 $this->changePrefix( 'parsertest_' );
 780
 781                 # Hack: insert a few Wikipedia in-project interwiki prefixes,
 782                 # for testing inter-language links
 783                 $db->insert( 'interwiki', array(
 784                         array( 'iw_prefix' => 'wikipedia',
 785                                    'iw_url'    => 'http://en.wikipedia.org/wiki/$1',
 786                                    'iw_local'  => 0 ),
 787                         array( 'iw_prefix' => 'meatball',
 788                                    'iw_url'    => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
 789                                    'iw_local'  => 0 ),
 790                         array( 'iw_prefix' => 'zh',
 791                                    'iw_url'    => 'http://zh.wikipedia.org/wiki/$1',
 792                                    'iw_local'  => 1 ),
 793                         array( 'iw_prefix' => 'es',
 794                                    'iw_url'    => 'http://es.wikipedia.org/wiki/$1',
 795                                    'iw_local'  => 1 ),
 796                         array( 'iw_prefix' => 'fr',
 797                                    'iw_url'    => 'http://fr.wikipedia.org/wiki/$1',
 798                                    'iw_local'  => 1 ),
 799                         array( 'iw_prefix' => 'ru',
 800                                    'iw_url'    => 'http://ru.wikipedia.org/wiki/$1',
 801                                    'iw_local'  => 1 ),
 802                         ) );
 803
 804                 # Hack: Insert an image to work with
 805                 $db->insert( 'image', array(
 806                         'img_name'        => 'Foobar.jpg',
 807                         'img_size'        => 12345,
 808                         'img_description' => 'Some lame file',
 809                         'img_user'        => 1,
 810                         'img_user_text'   => 'WikiSysop',
 811                         'img_timestamp'   => $db->timestamp( '20010115123500' ),
 812                         'img_width'       => 1941,
 813                         'img_height'      => 220,
 814                         'img_bits'        => 24,
 815                         'img_media_type'  => MEDIATYPE_BITMAP,
 816                         'img_major_mime'  => "image",
 817                         'img_minor_mime'  => "jpeg",
 818                         'img_metadata'    => serialize( array() ),
 819                         ) );
 820
 821                 # Update certain things in site_stats
 822                 $db->insert( 'site_stats', array( 'ss_row_id' => 1, 'ss_images' => 1, 'ss_good_articles' => 1 ) );
 823
 824                 # Reinitialise the LocalisationCache to match the database state
 825                 Language::getLocalisationCache()->unloadAll();
 826         }
 827
 828         /**
 829          * Change the table prefix on all open DB connections/
 830          */
 831         protected function changePrefix( $prefix ) {
 832                 global $wgDBprefix;
 833                 wfGetLBFactory()->forEachLB( array( $this, 'changeLBPrefix' ), array( $prefix ) );
 834                 $wgDBprefix = $prefix;
 835         }
 836
 837         public function changeLBPrefix( $lb, $prefix ) {
 838                 $lb->forEachOpenConnection( array( $this, 'changeDBPrefix' ), array( $prefix ) );
 839         }
 840
 841         public function changeDBPrefix( $db, $prefix ) {
 842                 $db->tablePrefix( $prefix );
 843         }
 844
 845         private function teardownDatabase() {
 846                 global $wgDBprefix;
 847                 if ( !$this->databaseSetupDone ) {
 848                         return;
 849                 }
 850                 $this->changePrefix( $this->oldTablePrefix );
 851                 $this->databaseSetupDone = false;
 852                 if ( $this->useTemporaryTables ) {
 853                         # Don't need to do anything
 854                         return;
 855                 }
 856
 857                 /*
 858                 $tables = $this->listTables();
 859                 $db = wfGetDB( DB_MASTER );
 860                 foreach ( $tables as $table ) {
 861                         $db->query( "DROP TABLE `parsertest_$table`" );
 862                 }*/
 863         }
 864
 865         /**
 866          * Create a dummy uploads directory which will contain a couple
 867          * of files in order to pass existence tests.
 868          * @return string The directory
 869          */
 870         private function setupUploadDir() {
 871                 global $IP;
 872                 if ( $this->keepUploads ) {
 873                         $dir = wfTempDir() . '/mwParser-images';
 874                         if ( is_dir( $dir ) ) {
 875                                 return $dir;
 876                         }
 877                 } else {
 878                         $dir = wfTempDir() . "/mwParser-" . mt_rand() . "-images";
 879                 }
 880
 881                 wfDebug( "Creating upload directory $dir\n" );
 882                 if ( file_exists( $dir ) ) {
 883                         wfDebug( "Already exists!\n" );
 884                         return $dir;
 885                 }
 886                 wfMkdirParents( $dir . '/3/3a' );
 887                 copy( "$IP/skins/monobook/headbg.jpg", "$dir/3/3a/Foobar.jpg" );
 888                 return $dir;
 889         }
 890
 891         /**
 892          * Restore default values and perform any necessary clean-up
 893          * after each test runs.
 894          */
 895         private function teardownGlobals() {
 896                 RepoGroup::destroySingleton();
 897                 FileCache::destroySingleton();
 898                 LinkCache::singleton()->clear();
 899                 foreach( $this->savedGlobals as $var => $val ) {
 900                         $GLOBALS[$var] = $val;
 901                 }
 902                 if( isset( $this->uploadDir ) ) {
 903                         $this->teardownUploadDir( $this->uploadDir );
 904                         unset( $this->uploadDir );
 905                 }
 906         }
 907
 908         /**
 909          * Remove the dummy uploads directory
 910          */
 911         private function teardownUploadDir( $dir ) {
 912                 if ( $this->keepUploads ) {
 913                         return;
 914                 }
 915
 916                 // delete the files first, then the dirs.
 917                 self::deleteFiles(
 918                         array (
 919                                 "$dir/3/3a/Foobar.jpg",
 920                                 "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg",
 921                                 "$dir/thumb/3/3a/Foobar.jpg/200px-Foobar.jpg",
 922                                 "$dir/thumb/3/3a/Foobar.jpg/640px-Foobar.jpg",
 923                                 "$dir/thumb/3/3a/Foobar.jpg/120px-Foobar.jpg",
 924                         )
 925                 );
 926
 927                 self::deleteDirs(
 928                         array (
 929                                 "$dir/3/3a",
 930                                 "$dir/3",
 931                                 "$dir/thumb/6/65",
 932                                 "$dir/thumb/6",
 933                                 "$dir/thumb/3/3a/Foobar.jpg",
 934                                 "$dir/thumb/3/3a",
 935                                 "$dir/thumb/3",
 936                                 "$dir/thumb",
 937                                 "$dir",
 938                         )
 939                 );
 940         }
 941
 942         /**
 943          * Delete the specified files, if they exist.
 944          * @param array $files full paths to files to delete.
 945          */
 946         private static function deleteFiles( $files ) {
 947                 foreach( $files as $file ) {
 948                         if( file_exists( $file ) ) {
 949                                 unlink( $file );
 950                         }
 951                 }
 952         }
 953
 954         /**
 955          * Delete the specified directories, if they exist. Must be empty.
 956          * @param array $dirs full paths to directories to delete.
 957          */
 958         private static function deleteDirs( $dirs ) {
 959                 foreach( $dirs as $dir ) {
 960                         if( is_dir( $dir ) ) {
 961                                 rmdir( $dir );
 962                         }
 963                 }
 964         }
 965
 966         /**
 967          * "Running test $desc..."
 968          */
 969         protected function showTesting( $desc ) {
 970                 print "Running test $desc... ";
 971         }
 972
 973         /**
 974          * Print a happy success message.
 975          *
 976          * @param string $desc The test name
 977          * @return bool
 978          */
 979         protected function showSuccess( $desc ) {
 980                 if( $this->showProgress ) {
 981                         print $this->term->color( '1;32' ) . 'PASSED' . $this->term->reset() . "\n";
 982                 }
 983                 return true;
 984         }
 985
 986         /**
 987          * Print a failure message and provide some explanatory output
 988          * about what went wrong if so configured.
 989          *
 990          * @param string $desc The test name
 991          * @param string $result Expected HTML output
 992          * @param string $html Actual HTML output
 993          * @return bool
 994          */
 995         protected function showFailure( $desc, $result, $html ) {
 996                 if( $this->showFailure ) {
 997                         if( !$this->showProgress ) {
 998                                 # In quiet mode we didn't show the 'Testing' message before the
 999                                 # test, in case it succeeded. Show it now:
1000                                 $this->showTesting( $desc );
1001                         }
1002                         print $this->term->color( '31' ) . 'FAILED!' . $this->term->reset() . "\n";
1003                         if ( $this->showOutput ) {
1004                                 print "--- Expected ---\n$result\n--- Actual ---\n$html\n";
1005                         }
1006                         if( $this->showDiffs ) {
1007                                 print $this->quickDiff( $result, $html );
1008                                 if( !$this->wellFormed( $html ) ) {
1009                                         print "XML error: $this->mXmlError\n";
1010                                 }
1011                         }
1012                 }
1013                 return false;
1014         }
1015
1016         /**
1017          * Run given strings through a diff and return the (colorized) output.
1018          * Requires writable /tmp directory and a 'diff' command in the PATH.
1019          *
1020          * @param string $input
1021          * @param string $output
1022          * @param string $inFileTail Tailing for the input file name
1023          * @param string $outFileTail Tailing for the output file name
1024          * @return string
1025          */
1026         protected function quickDiff( $input, $output, $inFileTail='expected', $outFileTail='actual' ) {
1027                 $prefix = wfTempDir() . "/mwParser-" . mt_rand();
1028
1029                 $infile = "$prefix-$inFileTail";
1030                 $this->dumpToFile( $input, $infile );
1031
1032                 $outfile = "$prefix-$outFileTail";
1033                 $this->dumpToFile( $output, $outfile );
1034
1035                 $diff = `diff -au $infile $outfile`;
1036                 unlink( $infile );
1037                 unlink( $outfile );
1038
1039                 return $this->colorDiff( $diff );
1040         }
1041
1042         /**
1043          * Write the given string to a file, adding a final newline.
1044          *
1045          * @param string $data
1046          * @param string $filename
1047          */
1048         private function dumpToFile( $data, $filename ) {
1049                 $file = fopen( $filename, "wt" );
1050                 fwrite( $file, $data . "\n" );
1051                 fclose( $file );
1052         }
1053
1054         /**
1055          * Colorize unified diff output if set for ANSI color output.
1056          * Subtractions are colored blue, additions red.
1057          *
1058          * @param string $text
1059          * @return string
1060          */
1061         protected function colorDiff( $text ) {
1062                 return preg_replace(
1063                         array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
1064                         array( $this->term->color( 34 ) . '$1' . $this->term->reset(),
1065                                $this->term->color( 31 ) . '$1' . $this->term->reset() ),
1066                         $text );
1067         }
1068
1069         /**
1070          * Show "Reading tests from ..."
1071          *
1072          * @param String $path
1073          */
1074         protected function showRunFile( $path ){
1075                 print $this->term->color( 1 ) .
1076                         "Reading tests from \"$path\"..." .
1077                         $this->term->reset() .
1078                         "\n";
1079         }
1080
1081         /**
1082          * Insert a temporary test article
1083          * @param string $name the title, including any prefix
1084          * @param string $text the article text
1085          * @param int $line the input line number, for reporting errors
1086          */
1087         private function addArticle($name, $text, $line) {
1088                 $this->setupGlobals();
1089                 $title = Title::newFromText( $name );
1090                 if ( is_null($title) ) {
1091                         wfDie( "invalid title at line $line\n" );
1092                 }
1093
1094                 $aid = $title->getArticleID( GAID_FOR_UPDATE );
1095                 if ($aid != 0) {
1096                         wfDie( "duplicate article at line $line\n" );
1097                 }
1098
1099                 $art = new Article($title);
1100                 $art->insertNewArticle($text, '', false, false );
1101                 $this->teardownGlobals();
1102         }
1103
1104         /**
1105          * Steal a callback function from the primary parser, save it for
1106          * application to our scary parser. If the hook is not installed,
1107          * die a painful dead to warn the others.
1108          * @param string $name
1109          */
1110         private function requireHook( $name ) {
1111                 global $wgParser;
1112                 $wgParser->firstCallInit( ); //make sure hooks are loaded.
1113                 if( isset( $wgParser->mTagHooks[$name] ) ) {
1114                         $this->hooks[$name] = $wgParser->mTagHooks[$name];
1115                 } else {
1116                         wfDie( "This test suite requires the '$name' hook extension.\n" );
1117                 }
1118         }
1119
1120         /**
1121          * Steal a callback function from the primary parser, save it for
1122          * application to our scary parser. If the hook is not installed,
1123          * die a painful dead to warn the others.
1124          * @param string $name
1125          */
1126         private function requireFunctionHook( $name ) {
1127                 global $wgParser;
1128                 $wgParser->firstCallInit( ); //make sure hooks are loaded.
1129                 if( isset( $wgParser->mFunctionHooks[$name] ) ) {
1130                         $this->functionHooks[$name] = $wgParser->mFunctionHooks[$name];
1131                 } else {
1132                         wfDie( "This test suite requires the '$name' function hook extension.\n" );
1133                 }
1134         }
1135
1136         /*
1137          * Run the "tidy" command on text if the $wgUseTidy
1138          * global is true
1139          *
1140          * @param string $text the text to tidy
1141          * @return string
1142          * @static
1143          */
1144         private function tidy( $text ) {
1145                 global $wgUseTidy;
1146                 if ($wgUseTidy) {
1147                         $text = Parser::tidy($text);
1148                 }
1149                 return $text;
1150         }
1151
1152         private function wellFormed( $text ) {
1153                 $html =
1154                         Sanitizer::hackDocType() .
1155                         '<html>' .
1156                         $text .
1157                         '</html>';
1158
1159                 $parser = xml_parser_create( "UTF-8" );
1160
1161                 # case folding violates XML standard, turn it off
1162                 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
1163
1164                 if( !xml_parse( $parser, $html, true ) ) {
1165                         $err = xml_error_string( xml_get_error_code( $parser ) );
1166                         $position = xml_get_current_byte_index( $parser );
1167                         $fragment = $this->extractFragment( $html, $position );
1168                         $this->mXmlError = "$err at byte $position:\n$fragment";
1169                         xml_parser_free( $parser );
1170                         return false;
1171                 }
1172                 xml_parser_free( $parser );
1173                 return true;
1174         }
1175
1176         private function extractFragment( $text, $position ) {
1177                 $start = max( 0, $position - 10 );
1178                 $before = $position - $start;
1179                 $fragment = '...' .
1180                         $this->term->color( 34 ) .
1181                         substr( $text, $start, $before ) .
1182                         $this->term->color( 0 ) .
1183                         $this->term->color( 31 ) .
1184                         $this->term->color( 1 ) .
1185                         substr( $text, $position, 1 ) .
1186                         $this->term->color( 0 ) .
1187                         $this->term->color( 34 ) .
1188                         substr( $text, $position + 1, 9 ) .
1189                         $this->term->color( 0 ) .
1190                         '...';
1191                 $display = str_replace( "\n", ' ', $fragment );
1192                 $caret = '   ' .
1193                         str_repeat( ' ', $before ) .
1194                         $this->term->color( 31 ) .
1195                         '^' .
1196                         $this->term->color( 0 );
1197                 return "$display\n$caret";
1198         }
1199 }
1200
1201 class AnsiTermColorer {
1202         function __construct() {
1203         }
1204
1205         /**
1206          * Return ANSI terminal escape code for changing text attribs/color
1207          *
1208          * @param string $color Semicolon-separated list of attribute/color codes
1209          * @return string
1210          */
1211         public function color( $color ) {
1212                 global $wgCommandLineDarkBg;
1213                 $light = $wgCommandLineDarkBg ? "1;" : "0;";
1214                 return "\x1b[{$light}{$color}m";
1215         }
1216
1217         /**
1218          * Return ANSI terminal escape code for restoring default text attributes
1219          *
1220          * @return string
1221          */
1222         public function reset() {
1223                 return $this->color( 0 );
1224         }
1225 }
1226
1227 /* A colour-less terminal */
1228 class DummyTermColorer {
1229         public function color( $color ) {
1230                 return '';
1231         }
1232
1233         public function reset() {
1234                 return '';
1235         }
1236 }
1237
1238 class TestRecorder {
1239         var $parent;
1240         var $term;
1241
1242         function __construct( $parent ) {
1243                 $this->parent = $parent;
1244                 $this->term = $parent->term;
1245         }
1246
1247         function start() {
1248                 $this->total = 0;
1249                 $this->success = 0;
1250         }
1251
1252         function record( $test, $result ) {
1253                 $this->total++;
1254                 $this->success += ($result ? 1 : 0);
1255         }
1256
1257         function end() {
1258                 // dummy
1259         }
1260
1261         function report() {
1262                 if( $this->total > 0 ) {
1263                         $this->reportPercentage( $this->success, $this->total );
1264                 } else {
1265                         wfDie( "No tests found.\n" );
1266                 }
1267         }
1268
1269         function reportPercentage( $success, $total ) {
1270                 $ratio = wfPercent( 100 * $success / $total );
1271                 print $this->term->color( 1 ) . "Passed $success of $total tests ($ratio)... ";
1272                 if( $success == $total ) {
1273                         print $this->term->color( 32 ) . "ALL TESTS PASSED!";
1274                 } else {
1275                         $failed = $total - $success ;
1276                         print $this->term->color( 31 ) . "$failed tests failed!";
1277                 }
1278                 print $this->term->reset() . "\n";
1279                 return ($success == $total);
1280         }
1281 }
1282
1283 class DbTestPreviewer extends TestRecorder  {
1284         protected $lb;      ///< Database load balancer
1285         protected $db;      ///< Database connection to the main DB
1286         protected $curRun;  ///< run ID number for the current run
1287         protected $prevRun; ///< run ID number for the previous run, if any
1288         protected $results; ///< Result array
1289
1290         /**
1291          * This should be called before the table prefix is changed
1292          */
1293         function __construct( $parent ) {
1294                 parent::__construct( $parent );
1295                 $this->lb = wfGetLBFactory()->newMainLB();
1296                 // This connection will have the wiki's table prefix, not parsertest_
1297                 $this->db = $this->lb->getConnection( DB_MASTER );
1298         }
1299
1300         /**
1301          * Set up result recording; insert a record for the run with the date
1302          * and all that fun stuff
1303          */
1304         function start() {
1305                 global $wgDBtype, $wgDBprefix;
1306                 parent::start();
1307
1308                 if( ! $this->db->tableExists( 'testrun' )
1309                         or ! $this->db->tableExists( 'testitem' ) )
1310                 {
1311                         print "WARNING> `testrun` table not found in database.\n";
1312                         $this->prevRun = false;
1313                 } else {
1314                         // We'll make comparisons against the previous run later...
1315                         $this->prevRun = $this->db->selectField( 'testrun', 'MAX(tr_id)' );
1316                 }
1317                 $this->results = array();
1318         }
1319
1320         function record( $test, $result ) {
1321                 parent::record( $test, $result );
1322                 $this->results[$test] = $result;
1323         }
1324
1325         function report() {
1326                 if( $this->prevRun ) {
1327                         // f = fail, p = pass, n = nonexistent
1328                         // codes show before then after
1329                         $table = array(
1330                                 'fp' => 'previously failing test(s) now PASSING! :)',
1331                                 'pn' => 'previously PASSING test(s) removed o_O',
1332                                 'np' => 'new PASSING test(s) :)',
1333
1334                                 'pf' => 'previously passing test(s) now FAILING! :(',
1335                                 'fn' => 'previously FAILING test(s) removed O_o',
1336                                 'nf' => 'new FAILING test(s) :(',
1337                                 'ff' => 'still FAILING test(s) :(',
1338                         );
1339
1340                         $prevResults = array();
1341
1342                         $res = $this->db->select( 'testitem', array( 'ti_name', 'ti_success' ),
1343                                 array( 'ti_run' => $this->prevRun ), __METHOD__ );
1344                         foreach ( $res as $row ) {
1345                                 if ( !$this->parent->regex
1346                                         || preg_match( "/{$this->parent->regex}/i", $row->ti_name ) )
1347                                 {
1348                                         $prevResults[$row->ti_name] = $row->ti_success;
1349                                 }
1350                         }
1351
1352                         $combined = array_keys( $this->results + $prevResults );
1353
1354                         # Determine breakdown by change type
1355                         $breakdown = array();
1356                         foreach ( $combined as $test ) {
1357                                 if ( !isset( $prevResults[$test] ) ) {
1358                                         $before = 'n';
1359                                 } elseif ( $prevResults[$test] == 1 ) {
1360                                         $before = 'p';
1361                                 } else /* if ( $prevResults[$test] == 0 )*/ {
1362                                         $before = 'f';
1363                                 }
1364                                 if ( !isset( $this->results[$test] ) ) {
1365                                         $after = 'n';
1366                                 } elseif ( $this->results[$test] == 1 ) {
1367                                         $after = 'p';
1368                                 } else /*if ( $this->results[$test] == 0 ) */ {
1369                                         $after = 'f';
1370                                 }
1371                                 $code = $before . $after;
1372                                 if ( isset( $table[$code] ) ) {
1373                                         $breakdown[$code][$test] = $this->getTestStatusInfo( $test, $after );
1374                                 }
1375                         }
1376
1377                         # Write out results
1378                         foreach ( $table as $code => $label ) {
1379                                 if( !empty( $breakdown[$code] ) ) {
1380                                         $count = count($breakdown[$code]);
1381                                         printf( "\n%4d %s\n", $count, $label );
1382                                         foreach ($breakdown[$code] as $differing_test_name => $statusInfo) {
1383                                                 print "      * $differing_test_name  [$statusInfo]\n";
1384                                         }
1385                                 }
1386                         }
1387                 } else {
1388                         print "No previous test runs to compare against.\n";
1389                 }
1390                 print "\n";
1391                 parent::report();
1392         }
1393
1394         /**
1395          ** Returns a string giving information about when a test last had a status change.
1396          ** Could help to track down when regressions were introduced, as distinct from tests
1397          ** which have never passed (which are more change requests than regressions).
1398          */
1399         private function getTestStatusInfo($testname, $after) {
1400
1401                 // If we're looking at a test that has just been removed, then say when it first appeared.
1402                 if ( $after == 'n' ) {
1403                         $changedRun = $this->db->selectField ( 'testitem',
1404                                                                                                    'MIN(ti_run)',
1405                                                                                                    array( 'ti_name' => $testname ),
1406                                                                                                    __METHOD__ );
1407                         $appear = $this->db->selectRow ( 'testrun',
1408                                                                                          array( 'tr_date', 'tr_mw_version' ),
1409                                                                                          array( 'tr_id' => $changedRun ),
1410                                                                                          __METHOD__ );
1411                         return "First recorded appearance: "
1412                                . date( "d-M-Y H:i:s",  strtotime ( $appear->tr_date ) )
1413                                .  ", " . $appear->tr_mw_version;
1414                 }
1415
1416                 // Otherwise, this test has previous recorded results.
1417                 // See when this test last had a different result to what we're seeing now.
1418                 $conds = array(
1419                         'ti_name'    => $testname,
1420                         'ti_success' => ($after == 'f' ? "1" : "0") );
1421                 if ( $this->curRun ) {
1422                         $conds[] = "ti_run != " . $this->db->addQuotes ( $this->curRun );
1423                 }
1424
1425                 $changedRun = $this->db->selectField ( 'testitem', 'MAX(ti_run)', $conds, __METHOD__ );
1426
1427                 // If no record of ever having had a different result.
1428                 if ( is_null ( $changedRun ) ) {
1429                         if ($after == "f") {
1430                                 return "Has never passed";
1431                         } else {
1432                                 return "Has never failed";
1433                         }
1434                 }
1435
1436                 // Otherwise, we're looking at a test whose status has changed.
1437                 // (i.e. it used to work, but now doesn't; or used to fail, but is now fixed.)
1438                 // In this situation, give as much info as we can as to when it changed status.
1439                 $pre  = $this->db->selectRow ( 'testrun',
1440                                                                                 array( 'tr_date', 'tr_mw_version' ),
1441                                                                                 array( 'tr_id' => $changedRun ),
1442                                                                                 __METHOD__ );
1443                 $post = $this->db->selectRow ( 'testrun',
1444                                                                                 array( 'tr_date', 'tr_mw_version' ),
1445                                                                                 array( "tr_id > " . $this->db->addQuotes ( $changedRun) ),
1446                                                                                 __METHOD__,
1447                                                                                 array( "LIMIT" => 1, "ORDER BY" => 'tr_id' )
1448                                                                          );
1449
1450                 if ( $post ) {
1451                         $postDate = date( "d-M-Y H:i:s",  strtotime ( $post->tr_date  ) ) . ", {$post->tr_mw_version}";
1452                 } else {
1453                         $postDate = 'now';
1454                 }
1455                 return ( $after == "f" ? "Introduced" : "Fixed" ) . " between "
1456                                 . date( "d-M-Y H:i:s",  strtotime ( $pre->tr_date ) ) .  ", " . $pre->tr_mw_version
1457                                 . " and $postDate";
1458
1459         }
1460
1461         /**
1462          * Commit transaction and clean up for result recording
1463          */
1464         function end() {
1465                 $this->lb->commitMasterChanges();
1466                 $this->lb->closeAll();
1467                 parent::end();
1468         }
1469
1470 }
1471
1472 class DbTestRecorder extends DbTestPreviewer  {
1473         /**
1474          * Set up result recording; insert a record for the run with the date
1475          * and all that fun stuff
1476          */
1477         function start() {
1478                 global $wgDBtype, $wgDBprefix, $options;
1479                 $this->db->begin();
1480
1481                 if( ! $this->db->tableExists( 'testrun' )
1482                         or ! $this->db->tableExists( 'testitem' ) )
1483                 {
1484                         print "WARNING> `testrun` table not found in database. Trying to create table.\n";
1485                         if ($wgDBtype === 'postgres')
1486                                 $this->db->sourceFile( dirname(__FILE__) . '/testRunner.postgres.sql' );
1487                         else
1488                                 $this->db->sourceFile( dirname(__FILE__) . '/testRunner.sql' );
1489                         echo "OK, resuming.\n";
1490                 }
1491
1492                 parent::start();
1493
1494                 $this->db->insert( 'testrun',
1495                         array(
1496                                 'tr_date'        => $this->db->timestamp(),
1497                                 'tr_mw_version'  => isset( $options['setversion'] ) ?
1498                                         $options['setversion'] : SpecialVersion::getVersion(),
1499                                 'tr_php_version' => phpversion(),
1500                                 'tr_db_version'  => $this->db->getServerVersion(),
1501                                 'tr_uname'       => php_uname()
1502                         ),
1503                         __METHOD__ );
1504                         if ($wgDBtype === 'postgres')
1505                                 $this->curRun = $this->db->currentSequenceValue('testrun_id_seq');
1506                         else
1507                                 $this->curRun = $this->db->insertId();
1508         }
1509
1510         /**
1511          * Record an individual test item's success or failure to the db
1512          * @param string $test
1513          * @param bool $result
1514          */
1515         function record( $test, $result ) {
1516                 parent::record( $test, $result );
1517                 $this->db->insert( 'testitem',
1518                         array(
1519                                 'ti_run'     => $this->curRun,
1520                                 'ti_name'    => $test,
1521                                 'ti_success' => $result ? 1 : 0,
1522                         ),
1523                         __METHOD__ );
1524         }
1525 }
1526
1527 class RemoteTestRecorder extends TestRecorder {
1528         function start() {
1529                 parent::start();
1530                 $this->results = array();
1531                 $this->ping( 'running' );
1532         }
1533
1534         function record( $test, $result ) {
1535                 parent::record( $test, $result );
1536                 $this->results[$test] = (bool)$result;
1537         }
1538
1539         function end() {
1540                 $this->ping( 'complete', $this->results );
1541                 parent::end();
1542         }
1543
1544         /**
1545          * Inform a CodeReview instance that we've started or completed a test run...
1546          * @param $remote array: info on remote target
1547          * @param $status string: "running" - tell it we've started
1548          *                        "complete" - provide test results array
1549          *                        "abort" - something went horribly awry
1550          * @param $data array of test name => true/false
1551          */
1552         function ping( $status, $results=false ) {
1553                 global $wgParserTestRemote, $IP;
1554
1555                 $remote = $wgParserTestRemote;
1556                 $revId = SpecialVersion::getSvnRevision( $IP );
1557                 $jsonResults = json_encode( $results );
1558
1559                 if( !$remote ) {
1560                         print "Can't do remote upload without configuring \$wgParserTestRemote!\n";
1561                         exit( 1 );
1562                 }
1563
1564                 // Generate a hash MAC to validate our credentials
1565                 $message = array(
1566                         $remote['repo'],
1567                         $remote['suite'],
1568                         $revId,
1569                         $status,
1570                 );
1571                 if( $status == "complete" ) {
1572                         $message[] = $jsonResults;
1573                 }
1574                 $hmac = hash_hmac( "sha1", implode( "|", $message ), $remote['secret'] );
1575
1576                 $postData = array(
1577                         'action' => 'codetestupload',
1578                         'format' => 'json',
1579                         'repo'   => $remote['repo'],
1580                         'suite'  => $remote['suite'],
1581                         'rev'    => $revId,
1582                         'status' => $status,
1583                         'hmac'   => $hmac,
1584                 );
1585                 if( $status == "complete" ) {
1586                         $postData['results'] = $jsonResults;
1587                 }
1588                 $response = $this->post( $remote['api-url'], $postData );
1589
1590                 if( $response === false ) {
1591                         print "CodeReview info upload failed to reach server.\n";
1592                         exit( 1 );
1593                 }
1594                 $responseData = json_decode( $response, true );
1595                 if( !is_array( $responseData ) ) {
1596                         print "CodeReview API response not recognized...\n";
1597                         wfDebug( "Unrecognized CodeReview API response: $response\n" );
1598                         exit( 1 );
1599                 }
1600                 if( isset( $responseData['error'] ) ) {
1601                         $code = $responseData['error']['code'];
1602                         $info = $responseData['error']['info'];
1603                         print "CodeReview info upload failed: $code $info\n";
1604                         exit( 1 );
1605                 }
1606         }
1607
1608         function post( $url, $data ) {
1609                 // @fixme: for whatever reason, I get a 417 fail when using CURL's multipart form submit.
1610                 // If we do form URL encoding ourselves, though, it should work.
1611                 return Http::post( $url, array( 'postdata' => wfArrayToCGI( $data ) ) );
1612         }
1613 }