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                                         if ( preg_match('/\\bmath\\b/i', $data['options']) && !$this->savedGlobals['wgUseTeX'] ) {
 371                                                 # don't run math tests if $wgUseTeX is set to false in LocalSettings
 372                                                 $data = array();
 373                                                 $section = null;
 374                                                 continue;
 375                                         }
 376                                         $result = $this->runTest(
 377                                                 $this->chomp( $data['test'] ),
 378                                                 $this->chomp( $data['input'] ),
 379                                                 $this->chomp( $data['result'] ),
 380                                                 $this->chomp( $data['options'] ),
 381                                                 $this->chomp( $data['config']   )
 382                                                 );
 383                                         $ok = $ok && $result;
 384                                         $this->recorder->record( $this->chomp( $data['test'] ), $result );
 385                                         $data = array();
 386                                         $section = null;
 387                                         continue;
 388                                 }
 389                                 if ( isset ($data[$section] ) ) {
 390                                         wfDie( "duplicate section '$section' at line $n of $filename\n" );
 391                                 }
 392                                 $data[$section] = '';
 393                                 continue;
 394                         }
 395                         if( $section ) {
 396                                 $data[$section] .= $line;
 397                         }
 398                 }
 399                 if ( $this->showProgress ) {
 400                         print "\n";
 401                 }
 402                 return $ok;
 403         }
 404
 405         /**
 406          * Get a Parser object
 407          */
 408         function getParser() {
 409                 global $wgParserConf;
 410                 $class = $wgParserConf['class'];
 411                 $parser = new $class( $wgParserConf );
 412                 foreach( $this->hooks as $tag => $callback ) {
 413                         $parser->setHook( $tag, $callback );
 414                 }
 415                 foreach( $this->functionHooks as $tag => $bits ) {
 416                         list( $callback, $flags ) = $bits;
 417                         $parser->setFunctionHook( $tag, $callback, $flags );
 418                 }
 419                 wfRunHooks( 'ParserTestParser', array( &$parser ) );
 420                 return $parser;
 421         }
 422
 423         /**
 424          * Run a given wikitext input through a freshly-constructed wiki parser,
 425          * and compare the output against the expected results.
 426          * Prints status and explanatory messages to stdout.
 427          *
 428          * @param string $input Wikitext to try rendering
 429          * @param string $result Result to output
 430          * @return bool
 431          */
 432         private function runTest( $desc, $input, $result, $opts, $config ) {
 433                 if( $this->showProgress ) {
 434                         $this->showTesting( $desc );
 435                 }
 436
 437                 $opts = $this->parseOptions( $opts );
 438                 $this->setupGlobals($opts, $config);
 439
 440                 $user = new User();
 441                 $options = ParserOptions::newFromUser( $user );
 442
 443                 if ( isset( $opts['math'] ) ) {
 444                         # XXX this should probably be done by the ParserOptions
 445                         $options->setUseTex(true);
 446                 }
 447
 448                 $m = array();
 449                 if (isset( $opts['title'] ) ) {
 450                         $titleText = $opts['title'];
 451                 }
 452                 else {
 453                         $titleText = 'Parser test';
 454                 }
 455
 456                 $noxml = isset( $opts['noxml'] );
 457                 $local = isset( $opts['local'] );
 458                 $parser = $this->getParser();
 459                 $title = Title::newFromText( $titleText );
 460
 461                 $matches = array();
 462                 if( isset( $opts['pst'] ) ) {
 463                         $out = $parser->preSaveTransform( $input, $title, $user, $options );
 464                 } elseif( isset( $opts['msg'] ) ) {
 465                         $out = $parser->transformMsg( $input, $options );
 466                 } elseif( isset( $opts['section'] ) ) {
 467                         $section = $opts['section'];
 468                         $out = $parser->getSection( $input, $section );
 469                 } elseif( isset( $opts['replace'] ) ) {
 470                         $section = $opts['replace'][0];
 471                         $replace = $opts['replace'][1];
 472                         $out = $parser->replaceSection( $input, $section, $replace );
 473                 } elseif( isset( $opts['comment'] ) ) {
 474                         $linker = $user->getSkin();
 475                         $out = $linker->formatComment( $input, $title, $local );
 476                 } else {
 477                         $output = $parser->parse( $input, $title, $options, true, true, 1337 );
 478                         $out = $output->getText();
 479
 480                         if (isset( $opts['ill'] ) ) {
 481                                 $out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
 482                         } elseif( isset( $opts['cat'] ) ) {
 483                                 global $wgOut;
 484                                 $wgOut->addCategoryLinks($output->getCategories());
 485                                 $cats = $wgOut->getCategoryLinks();
 486                                 if ( isset( $cats['normal'] ) ) {
 487                                         $out = $this->tidy( implode( ' ', $cats['normal'] ) );
 488                                 } else {
 489                                         $out = '';
 490                                 }
 491                         }
 492
 493                         $result = $this->tidy($result);
 494                 }
 495
 496                 $this->teardownGlobals();
 497
 498                 if( $result === $out && ( $noxml === true || $this->wellFormed( $out ) ) ) {
 499                         return $this->showSuccess( $desc );
 500                 } else {
 501                         return $this->showFailure( $desc, $result, $out );
 502                 }
 503         }
 504
 505
 506         /**
 507          * Use a regex to find out the value of an option
 508          * @param $key name of option val to retrieve
 509          * @param $opts Options array to look in
 510          * @param $defaults Default value returned if not found
 511          */
 512         private static function getOptionValue( $key, $opts, $default ) {
 513                 $key = strtolower( $key );
 514                 if( isset( $opts[$key] ) ) {
 515                         return $opts[$key];
 516                 } else {
 517                         return $default;
 518                 }
 519         }
 520
 521         private function parseOptions( $instring ) {
 522                 $opts = array();
 523                 $lines = explode( "\n", $instring );
 524                 // foo
 525                 // foo=bar
 526                 // foo="bar baz"
 527                 // foo=[[bar baz]]
 528                 // foo=bar,"baz quux"
 529                 $regex = '/\b
 530                         ([\w-]+)                                                # Key
 531                         \b
 532                         (?:\s*
 533                                 =                                               # First sub-value
 534                                 \s*
 535                                 (
 536                                         "
 537                                                 [^"]*                   # Quoted val
 538                                         "
 539                                 |
 540                                         \[\[
 541                                                 [^]]*                   # Link target
 542                                         \]\]
 543                                 |
 544                                         [\w-]+                          # Plain word
 545                                 )
 546                                 (?:\s*
 547                                         ,                                       # Sub-vals 1..N
 548                                         \s*
 549                                         (
 550                                                 "[^"]*"                 # Quoted val
 551                                         |
 552                                                 \[\[[^]]*\]\]   # Link target
 553                                         |
 554                                                 [\w-]+                  # Plain word
 555                                         )
 556                                 )*
 557                         )?
 558                         /x';
 559
 560                 if( preg_match_all( $regex, $instring, $matches, PREG_SET_ORDER ) ) {
 561                         foreach( $matches as $bits ) {
 562                                 $match = array_shift( $bits );
 563                                 $key = strtolower( array_shift( $bits ) );
 564                                 if( count( $bits ) == 0 ) {
 565                                         $opts[$key] = true;
 566                                 } elseif( count( $bits ) == 1 ) {
 567                                         $opts[$key] = $this->cleanupOption( array_shift( $bits ) );
 568                                 } else {
 569                                         // Array!
 570                                         $opts[$key] = array_map( array( $this, 'cleanupOption' ), $bits );
 571                                 }
 572                         }
 573                 }
 574                 return $opts;
 575         }
 576
 577         private function cleanupOption( $opt ) {
 578                 if( substr( $opt, 0, 1 ) == '"' ) {
 579                         return substr( $opt, 1, -1 );
 580                 }
 581                 if( substr( $opt, 0, 2 ) == '[[' ) {
 582                         return substr( $opt, 2, -2 );
 583                 }
 584                 return $opt;
 585         }
 586
 587         /**
 588          * Set up the global variables for a consistent environment for each test.
 589          * Ideally this should replace the global configuration entirely.
 590          */
 591         private function setupGlobals($opts = '', $config = '') {
 592                 if( !isset( $this->uploadDir ) ) {
 593                         $this->uploadDir = $this->setupUploadDir();
 594                 }
 595
 596                 # Find out values for some special options.
 597                 $lang =
 598                         self::getOptionValue( 'language', $opts, 'en' );
 599                 $variant =
 600                         self::getOptionValue( 'variant', $opts, false );
 601                 $maxtoclevel =
 602                         self::getOptionValue( 'wgMaxTocLevel', $opts, 999 );
 603                 $linkHolderBatchSize =
 604                         self::getOptionValue( 'wgLinkHolderBatchSize', $opts, 1000 );
 605
 606                 $settings = array(
 607                         'wgServer' => 'http://localhost',
 608                         'wgScript' => '/index.php',
 609                         'wgScriptPath' => '/',
 610                         'wgArticlePath' => '/wiki/$1',
 611                         'wgActionPaths' => array(),
 612                         'wgLocalFileRepo' => array(
 613                                 'class' => 'LocalRepo',
 614                                 'name' => 'local',
 615                                 'directory' => $this->uploadDir,
 616                                 'url' => 'http://example.com/images',
 617                                 'hashLevels' => 2,
 618                                 'transformVia404' => false,
 619                         ),
 620                         'wgEnableUploads' => true,
 621                         'wgStyleSheetPath' => '/skins',
 622                         'wgSitename' => 'MediaWiki',
 623                         'wgServerName' => 'Britney-Spears',
 624                         'wgLanguageCode' => $lang,
 625                         'wgContLanguageCode' => $lang,
 626                         'wgDBprefix' => 'parsertest_',
 627                         'wgRawHtml' => isset( $opts['rawhtml'] ),
 628                         'wgLang' => null,
 629                         'wgContLang' => null,
 630                         'wgNamespacesWithSubpages' => array( 0 => isset( $opts['subpage'] ) ),
 631                         'wgMaxTocLevel' => $maxtoclevel,
 632                         'wgCapitalLinks' => true,
 633                         'wgNoFollowLinks' => true,
 634                         'wgNoFollowDomainExceptions' => array(),
 635                         'wgThumbnailScriptPath' => false,
 636                         'wgUseTeX' => false,
 637                         'wgLocaltimezone' => 'UTC',
 638                         'wgAllowExternalImages' => true,
 639                         'wgUseTidy' => false,
 640                         'wgDefaultLanguageVariant' => $variant,
 641                         'wgVariantArticlePath' => false,
 642                         'wgGroupPermissions' => array( '*' => array(
 643                                 'createaccount' => true,
 644                                 'read'          => true,
 645                                 'edit'          => true,
 646                                 'createpage'    => true,
 647                                 'createtalk'    => true,
 648                         ) ),
 649                         'wgNamespaceProtection' => array( NS_MEDIAWIKI => 'editinterface' ),
 650                         'wgDefaultExternalStore' => array(),
 651                         'wgForeignFileRepos' => array(),
 652                         'wgLinkHolderBatchSize' => $linkHolderBatchSize,
 653                         'wgEnforceHtmlIds' => true,
 654                         'wgExternalLinkTarget' => false,
 655                         'wgAlwaysUseTidy' => false,
 656                         'wgHtml5' => true,
 657                         'wgWellFormedXml' => true,
 658                         );
 659
 660                 if ($config) {
 661                         $configLines = explode( "\n", $config );
 662
 663                         foreach( $configLines as $line ) {
 664                                 list( $var, $value ) = explode( '=', $line, 2 );
 665
 666                                 $settings[$var] = eval("return $value;" );
 667                         }
 668                 }
 669
 670                 $this->savedGlobals = array();
 671                 foreach( $settings as $var => $val ) {
 672                         $this->savedGlobals[$var] = $GLOBALS[$var];
 673                         $GLOBALS[$var] = $val;
 674                 }
 675                 $langObj = Language::factory( $lang );
 676                 $GLOBALS['wgLang'] = $langObj;
 677                 $GLOBALS['wgContLang'] = $langObj;
 678                 $GLOBALS['wgMemc'] = new FakeMemCachedClient;
 679                 $GLOBALS['wgOut'] = new OutputPage;
 680
 681                 //$GLOBALS['wgMessageCache'] = new MessageCache( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
 682
 683                 MagicWord::clearCache();
 684
 685                 global $wgUser;
 686                 $wgUser = new User();
 687         }
 688
 689         /**
 690          * List of temporary tables to create, without prefix.
 691          * Some of these probably aren't necessary.
 692          */
 693         private function listTables() {
 694                 global $wgDBtype;
 695                 $tables = array('user', 'page', 'page_restrictions',
 696                         'protected_titles', 'revision', 'text', 'pagelinks', 'imagelinks',
 697                         'categorylinks', 'templatelinks', 'externallinks', 'langlinks',
 698                         'site_stats', 'hitcounter',     'ipblocks', 'image', 'oldimage',
 699                         'recentchanges', 'watchlist', 'math', 'interwiki',
 700                         'querycache', 'objectcache', 'job', 'l10n_cache', 'redirect', 'querycachetwo',
 701                         'archive', 'user_groups', 'page_props', 'category'
 702                 );
 703
 704                 if ($wgDBtype === 'mysql')
 705                         array_push( $tables, 'searchindex' );
 706
 707                 // Allow extensions to add to the list of tables to duplicate;
 708                 // may be necessary if they hook into page save or other code
 709                 // which will require them while running tests.
 710                 wfRunHooks( 'ParserTestTables', array( &$tables ) );
 711
 712                 return $tables;
 713         }
 714
 715         /**
 716          * Set up a temporary set of wiki tables to work with for the tests.
 717          * Currently this will only be done once per run, and any changes to
 718          * the db will be visible to later tests in the run.
 719          */
 720         private function setupDatabase() {
 721                 global $wgDBprefix, $wgDBtype;
 722                 if ( $this->databaseSetupDone ) {
 723                         return;
 724                 }
 725                 if ( $wgDBprefix === 'parsertest_' ) {
 726                         throw new MWException( 'setupDatabase should be called before setupGlobals' );
 727                 }
 728                 $this->databaseSetupDone = true;
 729                 $this->oldTablePrefix = $wgDBprefix;
 730
 731                 # CREATE TEMPORARY TABLE breaks if there is more than one server
 732                 # FIXME: r40209 makes temporary tables break even with just one server
 733                 # FIXME: (bug 15892); disabling the feature entirely as a temporary fix
 734                 if ( true || wfGetLB()->getServerCount() != 1 ) {
 735                         $this->useTemporaryTables = false;
 736                 }
 737
 738                 $temporary = $this->useTemporaryTables || $wgDBtype == 'postgres';
 739
 740                 $db = wfGetDB( DB_MASTER );
 741                 $tables = $this->listTables();
 742
 743                 foreach ( $tables as $tbl ) {
 744                         # Clean up from previous aborted run.  So that table escaping
 745                         # works correctly across DB engines, we need to change the pre-
 746                         # fix back and forth so tableName() works right.
 747                         $this->changePrefix( $this->oldTablePrefix );
 748                         $oldTableName = $db->tableName( $tbl );
 749                         $this->changePrefix( 'parsertest_' );
 750                         $newTableName = $db->tableName( $tbl );
 751
 752                         if ( $db->tableExists( $tbl ) && $wgDBtype != 'postgres' ) {
 753                                 $db->query( "DROP TABLE $newTableName" );
 754                         }
 755                         # Create new table
 756                         $db->duplicateTableStructure( $oldTableName, $newTableName, $temporary );
 757                 }
 758
 759                 $this->changePrefix( 'parsertest_' );
 760
 761                 # Hack: insert a few Wikipedia in-project interwiki prefixes,
 762                 # for testing inter-language links
 763                 $db->insert( 'interwiki', array(
 764                         array( 'iw_prefix' => 'wikipedia',
 765                                    'iw_url'    => 'http://en.wikipedia.org/wiki/$1',
 766                                    'iw_local'  => 0 ),
 767                         array( 'iw_prefix' => 'meatball',
 768                                    'iw_url'    => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
 769                                    'iw_local'  => 0 ),
 770                         array( 'iw_prefix' => 'zh',
 771                                    'iw_url'    => 'http://zh.wikipedia.org/wiki/$1',
 772                                    'iw_local'  => 1 ),
 773                         array( 'iw_prefix' => 'es',
 774                                    'iw_url'    => 'http://es.wikipedia.org/wiki/$1',
 775                                    'iw_local'  => 1 ),
 776                         array( 'iw_prefix' => 'fr',
 777                                    'iw_url'    => 'http://fr.wikipedia.org/wiki/$1',
 778                                    'iw_local'  => 1 ),
 779                         array( 'iw_prefix' => 'ru',
 780                                    'iw_url'    => 'http://ru.wikipedia.org/wiki/$1',
 781                                    'iw_local'  => 1 ),
 782                         ) );
 783
 784                 # Hack: Insert an image to work with
 785                 $db->insert( 'image', array(
 786                         'img_name'        => 'Foobar.jpg',
 787                         'img_size'        => 12345,
 788                         'img_description' => 'Some lame file',
 789                         'img_user'        => 1,
 790                         'img_user_text'   => 'WikiSysop',
 791                         'img_timestamp'   => $db->timestamp( '20010115123500' ),
 792                         'img_width'       => 1941,
 793                         'img_height'      => 220,
 794                         'img_bits'        => 24,
 795                         'img_media_type'  => MEDIATYPE_BITMAP,
 796                         'img_major_mime'  => "image",
 797                         'img_minor_mime'  => "jpeg",
 798                         'img_metadata'    => serialize( array() ),
 799                         ) );
 800
 801                 # Update certain things in site_stats
 802                 $db->insert( 'site_stats', array( 'ss_row_id' => 1, 'ss_images' => 1, 'ss_good_articles' => 1 ) );
 803
 804                 # Reinitialise the LocalisationCache to match the database state
 805                 Language::getLocalisationCache()->unloadAll();
 806         }
 807
 808         /**
 809          * Change the table prefix on all open DB connections/
 810          */
 811         protected function changePrefix( $prefix ) {
 812                 global $wgDBprefix;
 813                 wfGetLBFactory()->forEachLB( array( $this, 'changeLBPrefix' ), array( $prefix ) );
 814                 $wgDBprefix = $prefix;
 815         }
 816
 817         public function changeLBPrefix( $lb, $prefix ) {
 818                 $lb->forEachOpenConnection( array( $this, 'changeDBPrefix' ), array( $prefix ) );
 819         }
 820
 821         public function changeDBPrefix( $db, $prefix ) {
 822                 $db->tablePrefix( $prefix );
 823         }
 824
 825         private function teardownDatabase() {
 826                 global $wgDBprefix;
 827                 if ( !$this->databaseSetupDone ) {
 828                         return;
 829                 }
 830                 $this->changePrefix( $this->oldTablePrefix );
 831                 $this->databaseSetupDone = false;
 832                 if ( $this->useTemporaryTables ) {
 833                         # Don't need to do anything
 834                         return;
 835                 }
 836
 837                 /*
 838                 $tables = $this->listTables();
 839                 $db = wfGetDB( DB_MASTER );
 840                 foreach ( $tables as $table ) {
 841                         $db->query( "DROP TABLE `parsertest_$table`" );
 842                 }*/
 843         }
 844
 845         /**
 846          * Create a dummy uploads directory which will contain a couple
 847          * of files in order to pass existence tests.
 848          * @return string The directory
 849          */
 850         private function setupUploadDir() {
 851                 global $IP;
 852                 if ( $this->keepUploads ) {
 853                         $dir = wfTempDir() . '/mwParser-images';
 854                         if ( is_dir( $dir ) ) {
 855                                 return $dir;
 856                         }
 857                 } else {
 858                         $dir = wfTempDir() . "/mwParser-" . mt_rand() . "-images";
 859                 }
 860
 861                 wfDebug( "Creating upload directory $dir\n" );
 862                 if ( file_exists( $dir ) ) {
 863                         wfDebug( "Already exists!\n" );
 864                         return $dir;
 865                 }
 866                 wfMkdirParents( $dir . '/3/3a' );
 867                 copy( "$IP/skins/monobook/headbg.jpg", "$dir/3/3a/Foobar.jpg" );
 868                 return $dir;
 869         }
 870
 871         /**
 872          * Restore default values and perform any necessary clean-up
 873          * after each test runs.
 874          */
 875         private function teardownGlobals() {
 876                 RepoGroup::destroySingleton();
 877                 LinkCache::singleton()->clear();
 878                 foreach( $this->savedGlobals as $var => $val ) {
 879                         $GLOBALS[$var] = $val;
 880                 }
 881                 if( isset( $this->uploadDir ) ) {
 882                         $this->teardownUploadDir( $this->uploadDir );
 883                         unset( $this->uploadDir );
 884                 }
 885         }
 886
 887         /**
 888          * Remove the dummy uploads directory
 889          */
 890         private function teardownUploadDir( $dir ) {
 891                 if ( $this->keepUploads ) {
 892                         return;
 893                 }
 894
 895                 // delete the files first, then the dirs.
 896                 self::deleteFiles(
 897                         array (
 898                                 "$dir/3/3a/Foobar.jpg",
 899                                 "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg",
 900                                 "$dir/thumb/3/3a/Foobar.jpg/200px-Foobar.jpg",
 901                                 "$dir/thumb/3/3a/Foobar.jpg/640px-Foobar.jpg",
 902                                 "$dir/thumb/3/3a/Foobar.jpg/120px-Foobar.jpg",
 903                         )
 904                 );
 905
 906                 self::deleteDirs(
 907                         array (
 908                                 "$dir/3/3a",
 909                                 "$dir/3",
 910                                 "$dir/thumb/6/65",
 911                                 "$dir/thumb/6",
 912                                 "$dir/thumb/3/3a/Foobar.jpg",
 913                                 "$dir/thumb/3/3a",
 914                                 "$dir/thumb/3",
 915                                 "$dir/thumb",
 916                                 "$dir",
 917                         )
 918                 );
 919         }
 920
 921         /**
 922          * Delete the specified files, if they exist.
 923          * @param array $files full paths to files to delete.
 924          */
 925         private static function deleteFiles( $files ) {
 926                 foreach( $files as $file ) {
 927                         if( file_exists( $file ) ) {
 928                                 unlink( $file );
 929                         }
 930                 }
 931         }
 932
 933         /**
 934          * Delete the specified directories, if they exist. Must be empty.
 935          * @param array $dirs full paths to directories to delete.
 936          */
 937         private static function deleteDirs( $dirs ) {
 938                 foreach( $dirs as $dir ) {
 939                         if( is_dir( $dir ) ) {
 940                                 rmdir( $dir );
 941                         }
 942                 }
 943         }
 944
 945         /**
 946          * "Running test $desc..."
 947          */
 948         protected function showTesting( $desc ) {
 949                 print "Running test $desc... ";
 950         }
 951
 952         /**
 953          * Print a happy success message.
 954          *
 955          * @param string $desc The test name
 956          * @return bool
 957          */
 958         protected function showSuccess( $desc ) {
 959                 if( $this->showProgress ) {
 960                         print $this->term->color( '1;32' ) . 'PASSED' . $this->term->reset() . "\n";
 961                 }
 962                 return true;
 963         }
 964
 965         /**
 966          * Print a failure message and provide some explanatory output
 967          * about what went wrong if so configured.
 968          *
 969          * @param string $desc The test name
 970          * @param string $result Expected HTML output
 971          * @param string $html Actual HTML output
 972          * @return bool
 973          */
 974         protected function showFailure( $desc, $result, $html ) {
 975                 if( $this->showFailure ) {
 976                         if( !$this->showProgress ) {
 977                                 # In quiet mode we didn't show the 'Testing' message before the
 978                                 # test, in case it succeeded. Show it now:
 979                                 $this->showTesting( $desc );
 980                         }
 981                         print $this->term->color( '31' ) . 'FAILED!' . $this->term->reset() . "\n";
 982                         if ( $this->showOutput ) {
 983                                 print "--- Expected ---\n$result\n--- Actual ---\n$html\n";
 984                         }
 985                         if( $this->showDiffs ) {
 986                                 print $this->quickDiff( $result, $html );
 987                                 if( !$this->wellFormed( $html ) ) {
 988                                         print "XML error: $this->mXmlError\n";
 989                                 }
 990                         }
 991                 }
 992                 return false;
 993         }
 994
 995         /**
 996          * Run given strings through a diff and return the (colorized) output.
 997          * Requires writable /tmp directory and a 'diff' command in the PATH.
 998          *
 999          * @param string $input
1000          * @param string $output
1001          * @param string $inFileTail Tailing for the input file name
1002          * @param string $outFileTail Tailing for the output file name
1003          * @return string
1004          */
1005         protected function quickDiff( $input, $output, $inFileTail='expected', $outFileTail='actual' ) {
1006                 $prefix = wfTempDir() . "/mwParser-" . mt_rand();
1007
1008                 $infile = "$prefix-$inFileTail";
1009                 $this->dumpToFile( $input, $infile );
1010
1011                 $outfile = "$prefix-$outFileTail";
1012                 $this->dumpToFile( $output, $outfile );
1013
1014                 $diff = `diff -au $infile $outfile`;
1015                 unlink( $infile );
1016                 unlink( $outfile );
1017
1018                 return $this->colorDiff( $diff );
1019         }
1020
1021         /**
1022          * Write the given string to a file, adding a final newline.
1023          *
1024          * @param string $data
1025          * @param string $filename
1026          */
1027         private function dumpToFile( $data, $filename ) {
1028                 $file = fopen( $filename, "wt" );
1029                 fwrite( $file, $data . "\n" );
1030                 fclose( $file );
1031         }
1032
1033         /**
1034          * Colorize unified diff output if set for ANSI color output.
1035          * Subtractions are colored blue, additions red.
1036          *
1037          * @param string $text
1038          * @return string
1039          */
1040         protected function colorDiff( $text ) {
1041                 return preg_replace(
1042                         array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
1043                         array( $this->term->color( 34 ) . '$1' . $this->term->reset(),
1044                                $this->term->color( 31 ) . '$1' . $this->term->reset() ),
1045                         $text );
1046         }
1047
1048         /**
1049          * Show "Reading tests from ..."
1050          *
1051          * @param String $path
1052          */
1053         protected function showRunFile( $path ){
1054                 print $this->term->color( 1 ) .
1055                         "Reading tests from \"$path\"..." .
1056                         $this->term->reset() .
1057                         "\n";
1058         }
1059
1060         /**
1061          * Insert a temporary test article
1062          * @param string $name the title, including any prefix
1063          * @param string $text the article text
1064          * @param int $line the input line number, for reporting errors
1065          */
1066         private function addArticle($name, $text, $line) {
1067                 $this->setupGlobals();
1068                 $title = Title::newFromText( $name );
1069                 if ( is_null($title) ) {
1070                         wfDie( "invalid title at line $line\n" );
1071                 }
1072
1073                 $aid = $title->getArticleID( GAID_FOR_UPDATE );
1074                 if ($aid != 0) {
1075                         wfDie( "duplicate article at line $line\n" );
1076                 }
1077
1078                 $art = new Article($title);
1079                 $art->insertNewArticle($text, '', false, false );
1080                 $this->teardownGlobals();
1081         }
1082
1083         /**
1084          * Steal a callback function from the primary parser, save it for
1085          * application to our scary parser. If the hook is not installed,
1086          * die a painful dead to warn the others.
1087          * @param string $name
1088          */
1089         private function requireHook( $name ) {
1090                 global $wgParser;
1091                 $wgParser->firstCallInit( ); //make sure hooks are loaded.
1092                 if( isset( $wgParser->mTagHooks[$name] ) ) {
1093                         $this->hooks[$name] = $wgParser->mTagHooks[$name];
1094                 } else {
1095                         wfDie( "This test suite requires the '$name' hook extension.\n" );
1096                 }
1097         }
1098
1099         /**
1100          * Steal a callback function from the primary parser, save it for
1101          * application to our scary parser. If the hook is not installed,
1102          * die a painful dead to warn the others.
1103          * @param string $name
1104          */
1105         private function requireFunctionHook( $name ) {
1106                 global $wgParser;
1107                 $wgParser->firstCallInit( ); //make sure hooks are loaded.
1108                 if( isset( $wgParser->mFunctionHooks[$name] ) ) {
1109                         $this->functionHooks[$name] = $wgParser->mFunctionHooks[$name];
1110                 } else {
1111                         wfDie( "This test suite requires the '$name' function hook extension.\n" );
1112                 }
1113         }
1114
1115         /*
1116          * Run the "tidy" command on text if the $wgUseTidy
1117          * global is true
1118          *
1119          * @param string $text the text to tidy
1120          * @return string
1121          * @static
1122          */
1123         private function tidy( $text ) {
1124                 global $wgUseTidy;
1125                 if ($wgUseTidy) {
1126                         $text = Parser::tidy($text);
1127                 }
1128                 return $text;
1129         }
1130
1131         private function wellFormed( $text ) {
1132                 $html =
1133                         Sanitizer::hackDocType() .
1134                         '<html>' .
1135                         $text .
1136                         '</html>';
1137
1138                 $parser = xml_parser_create( "UTF-8" );
1139
1140                 # case folding violates XML standard, turn it off
1141                 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
1142
1143                 if( !xml_parse( $parser, $html, true ) ) {
1144                         $err = xml_error_string( xml_get_error_code( $parser ) );
1145                         $position = xml_get_current_byte_index( $parser );
1146                         $fragment = $this->extractFragment( $html, $position );
1147                         $this->mXmlError = "$err at byte $position:\n$fragment";
1148                         xml_parser_free( $parser );
1149                         return false;
1150                 }
1151                 xml_parser_free( $parser );
1152                 return true;
1153         }
1154
1155         private function extractFragment( $text, $position ) {
1156                 $start = max( 0, $position - 10 );
1157                 $before = $position - $start;
1158                 $fragment = '...' .
1159                         $this->term->color( 34 ) .
1160                         substr( $text, $start, $before ) .
1161                         $this->term->color( 0 ) .
1162                         $this->term->color( 31 ) .
1163                         $this->term->color( 1 ) .
1164                         substr( $text, $position, 1 ) .
1165                         $this->term->color( 0 ) .
1166                         $this->term->color( 34 ) .
1167                         substr( $text, $position + 1, 9 ) .
1168                         $this->term->color( 0 ) .
1169                         '...';
1170                 $display = str_replace( "\n", ' ', $fragment );
1171                 $caret = '   ' .
1172                         str_repeat( ' ', $before ) .
1173                         $this->term->color( 31 ) .
1174                         '^' .
1175                         $this->term->color( 0 );
1176                 return "$display\n$caret";
1177         }
1178 }
1179
1180 class AnsiTermColorer {
1181         function __construct() {
1182         }
1183
1184         /**
1185          * Return ANSI terminal escape code for changing text attribs/color
1186          *
1187          * @param string $color Semicolon-separated list of attribute/color codes
1188          * @return string
1189          */
1190         public function color( $color ) {
1191                 global $wgCommandLineDarkBg;
1192                 $light = $wgCommandLineDarkBg ? "1;" : "0;";
1193                 return "\x1b[{$light}{$color}m";
1194         }
1195
1196         /**
1197          * Return ANSI terminal escape code for restoring default text attributes
1198          *
1199          * @return string
1200          */
1201         public function reset() {
1202                 return $this->color( 0 );
1203         }
1204 }
1205
1206 /* A colour-less terminal */
1207 class DummyTermColorer {
1208         public function color( $color ) {
1209                 return '';
1210         }
1211
1212         public function reset() {
1213                 return '';
1214         }
1215 }
1216
1217 class TestRecorder {
1218         var $parent;
1219         var $term;
1220
1221         function __construct( $parent ) {
1222                 $this->parent = $parent;
1223                 $this->term = $parent->term;
1224         }
1225
1226         function start() {
1227                 $this->total = 0;
1228                 $this->success = 0;
1229         }
1230
1231         function record( $test, $result ) {
1232                 $this->total++;
1233                 $this->success += ($result ? 1 : 0);
1234         }
1235
1236         function end() {
1237                 // dummy
1238         }
1239
1240         function report() {
1241                 if( $this->total > 0 ) {
1242                         $this->reportPercentage( $this->success, $this->total );
1243                 } else {
1244                         wfDie( "No tests found.\n" );
1245                 }
1246         }
1247
1248         function reportPercentage( $success, $total ) {
1249                 $ratio = wfPercent( 100 * $success / $total );
1250                 print $this->term->color( 1 ) . "Passed $success of $total tests ($ratio)... ";
1251                 if( $success == $total ) {
1252                         print $this->term->color( 32 ) . "ALL TESTS PASSED!";
1253                 } else {
1254                         $failed = $total - $success ;
1255                         print $this->term->color( 31 ) . "$failed tests failed!";
1256                 }
1257                 print $this->term->reset() . "\n";
1258                 return ($success == $total);
1259         }
1260 }
1261
1262 class DbTestPreviewer extends TestRecorder  {
1263         protected $lb;      ///< Database load balancer
1264         protected $db;      ///< Database connection to the main DB
1265         protected $curRun;  ///< run ID number for the current run
1266         protected $prevRun; ///< run ID number for the previous run, if any
1267         protected $results; ///< Result array
1268
1269         /**
1270          * This should be called before the table prefix is changed
1271          */
1272         function __construct( $parent ) {
1273                 parent::__construct( $parent );
1274                 $this->lb = wfGetLBFactory()->newMainLB();
1275                 // This connection will have the wiki's table prefix, not parsertest_
1276                 $this->db = $this->lb->getConnection( DB_MASTER );
1277         }
1278
1279         /**
1280          * Set up result recording; insert a record for the run with the date
1281          * and all that fun stuff
1282          */
1283         function start() {
1284                 global $wgDBtype, $wgDBprefix;
1285                 parent::start();
1286
1287                 if( ! $this->db->tableExists( 'testrun' )
1288                         or ! $this->db->tableExists( 'testitem' ) )
1289                 {
1290                         print "WARNING> `testrun` table not found in database.\n";
1291                         $this->prevRun = false;
1292                 } else {
1293                         // We'll make comparisons against the previous run later...
1294                         $this->prevRun = $this->db->selectField( 'testrun', 'MAX(tr_id)' );
1295                 }
1296                 $this->results = array();
1297         }
1298
1299         function record( $test, $result ) {
1300                 parent::record( $test, $result );
1301                 $this->results[$test] = $result;
1302         }
1303
1304         function report() {
1305                 if( $this->prevRun ) {
1306                         // f = fail, p = pass, n = nonexistent
1307                         // codes show before then after
1308                         $table = array(
1309                                 'fp' => 'previously failing test(s) now PASSING! :)',
1310                                 'pn' => 'previously PASSING test(s) removed o_O',
1311                                 'np' => 'new PASSING test(s) :)',
1312
1313                                 'pf' => 'previously passing test(s) now FAILING! :(',
1314                                 'fn' => 'previously FAILING test(s) removed O_o',
1315                                 'nf' => 'new FAILING test(s) :(',
1316                                 'ff' => 'still FAILING test(s) :(',
1317                         );
1318
1319                         $prevResults = array();
1320
1321                         $res = $this->db->select( 'testitem', array( 'ti_name', 'ti_success' ),
1322                                 array( 'ti_run' => $this->prevRun ), __METHOD__ );
1323                         foreach ( $res as $row ) {
1324                                 if ( !$this->parent->regex
1325                                         || preg_match( "/{$this->parent->regex}/i", $row->ti_name ) )
1326                                 {
1327                                         $prevResults[$row->ti_name] = $row->ti_success;
1328                                 }
1329                         }
1330
1331                         $combined = array_keys( $this->results + $prevResults );
1332
1333                         # Determine breakdown by change type
1334                         $breakdown = array();
1335                         foreach ( $combined as $test ) {
1336                                 if ( !isset( $prevResults[$test] ) ) {
1337                                         $before = 'n';
1338                                 } elseif ( $prevResults[$test] == 1 ) {
1339                                         $before = 'p';
1340                                 } else /* if ( $prevResults[$test] == 0 )*/ {
1341                                         $before = 'f';
1342                                 }
1343                                 if ( !isset( $this->results[$test] ) ) {
1344                                         $after = 'n';
1345                                 } elseif ( $this->results[$test] == 1 ) {
1346                                         $after = 'p';
1347                                 } else /*if ( $this->results[$test] == 0 ) */ {
1348                                         $after = 'f';
1349                                 }
1350                                 $code = $before . $after;
1351                                 if ( isset( $table[$code] ) ) {
1352                                         $breakdown[$code][$test] = $this->getTestStatusInfo( $test, $after );
1353                                 }
1354                         }
1355
1356                         # Write out results
1357                         foreach ( $table as $code => $label ) {
1358                                 if( !empty( $breakdown[$code] ) ) {
1359                                         $count = count($breakdown[$code]);
1360                                         printf( "\n%4d %s\n", $count, $label );
1361                                         foreach ($breakdown[$code] as $differing_test_name => $statusInfo) {
1362                                                 print "      * $differing_test_name  [$statusInfo]\n";
1363                                         }
1364                                 }
1365                         }
1366                 } else {
1367                         print "No previous test runs to compare against.\n";
1368                 }
1369                 print "\n";
1370                 parent::report();
1371         }
1372
1373         /**
1374          ** Returns a string giving information about when a test last had a status change.
1375          ** Could help to track down when regressions were introduced, as distinct from tests
1376          ** which have never passed (which are more change requests than regressions).
1377          */
1378         private function getTestStatusInfo($testname, $after) {
1379
1380                 // If we're looking at a test that has just been removed, then say when it first appeared.
1381                 if ( $after == 'n' ) {
1382                         $changedRun = $this->db->selectField ( 'testitem',
1383                                                                                                    'MIN(ti_run)',
1384                                                                                                    array( 'ti_name' => $testname ),
1385                                                                                                    __METHOD__ );
1386                         $appear = $this->db->selectRow ( 'testrun',
1387                                                                                          array( 'tr_date', 'tr_mw_version' ),
1388                                                                                          array( 'tr_id' => $changedRun ),
1389                                                                                          __METHOD__ );
1390                         return "First recorded appearance: "
1391                                . date( "d-M-Y H:i:s",  strtotime ( $appear->tr_date ) )
1392                                .  ", " . $appear->tr_mw_version;
1393                 }
1394
1395                 // Otherwise, this test has previous recorded results.
1396                 // See when this test last had a different result to what we're seeing now.
1397                 $conds = array(
1398                         'ti_name'    => $testname,
1399                         'ti_success' => ($after == 'f' ? "1" : "0") );
1400                 if ( $this->curRun ) {
1401                         $conds[] = "ti_run != " . $this->db->addQuotes ( $this->curRun );
1402                 }
1403
1404                 $changedRun = $this->db->selectField ( 'testitem', 'MAX(ti_run)', $conds, __METHOD__ );
1405
1406                 // If no record of ever having had a different result.
1407                 if ( is_null ( $changedRun ) ) {
1408                         if ($after == "f") {
1409                                 return "Has never passed";
1410                         } else {
1411                                 return "Has never failed";
1412                         }
1413                 }
1414
1415                 // Otherwise, we're looking at a test whose status has changed.
1416                 // (i.e. it used to work, but now doesn't; or used to fail, but is now fixed.)
1417                 // In this situation, give as much info as we can as to when it changed status.
1418                 $pre  = $this->db->selectRow ( 'testrun',
1419                                                                                 array( 'tr_date', 'tr_mw_version' ),
1420                                                                                 array( 'tr_id' => $changedRun ),
1421                                                                                 __METHOD__ );
1422                 $post = $this->db->selectRow ( 'testrun',
1423                                                                                 array( 'tr_date', 'tr_mw_version' ),
1424                                                                                 array( "tr_id > " . $this->db->addQuotes ( $changedRun) ),
1425                                                                                 __METHOD__,
1426                                                                                 array( "LIMIT" => 1, "ORDER BY" => 'tr_id' )
1427                                                                          );
1428
1429                 if ( $post ) {
1430                         $postDate = date( "d-M-Y H:i:s",  strtotime ( $post->tr_date  ) ) . ", {$post->tr_mw_version}";
1431                 } else {
1432                         $postDate = 'now';
1433                 }
1434                 return ( $after == "f" ? "Introduced" : "Fixed" ) . " between "
1435                                 . date( "d-M-Y H:i:s",  strtotime ( $pre->tr_date ) ) .  ", " . $pre->tr_mw_version
1436                                 . " and $postDate";
1437
1438         }
1439
1440         /**
1441          * Commit transaction and clean up for result recording
1442          */
1443         function end() {
1444                 $this->lb->commitMasterChanges();
1445                 $this->lb->closeAll();
1446                 parent::end();
1447         }
1448
1449 }
1450
1451 class DbTestRecorder extends DbTestPreviewer  {
1452         /**
1453          * Set up result recording; insert a record for the run with the date
1454          * and all that fun stuff
1455          */
1456         function start() {
1457                 global $wgDBtype, $wgDBprefix, $options;
1458                 $this->db->begin();
1459
1460                 if( ! $this->db->tableExists( 'testrun' )
1461                         or ! $this->db->tableExists( 'testitem' ) )
1462                 {
1463                         print "WARNING> `testrun` table not found in database. Trying to create table.\n";
1464                         if ($wgDBtype === 'postgres')
1465                                 $this->db->sourceFile( dirname(__FILE__) . '/testRunner.postgres.sql' );
1466                         else
1467                                 $this->db->sourceFile( dirname(__FILE__) . '/testRunner.sql' );
1468                         echo "OK, resuming.\n";
1469                 }
1470
1471                 parent::start();
1472
1473                 $this->db->insert( 'testrun',
1474                         array(
1475                                 'tr_date'        => $this->db->timestamp(),
1476                                 'tr_mw_version'  => isset( $options['setversion'] ) ?
1477                                         $options['setversion'] : SpecialVersion::getVersion(),
1478                                 'tr_php_version' => phpversion(),
1479                                 'tr_db_version'  => $this->db->getServerVersion(),
1480                                 'tr_uname'       => php_uname()
1481                         ),
1482                         __METHOD__ );
1483                         if ($wgDBtype === 'postgres')
1484                                 $this->curRun = $this->db->currentSequenceValue('testrun_id_seq');
1485                         else
1486                                 $this->curRun = $this->db->insertId();
1487         }
1488
1489         /**
1490          * Record an individual test item's success or failure to the db
1491          * @param string $test
1492          * @param bool $result
1493          */
1494         function record( $test, $result ) {
1495                 parent::record( $test, $result );
1496                 $this->db->insert( 'testitem',
1497                         array(
1498                                 'ti_run'     => $this->curRun,
1499                                 'ti_name'    => $test,
1500                                 'ti_success' => $result ? 1 : 0,
1501                         ),
1502                         __METHOD__ );
1503         }
1504 }
1505
1506 class RemoteTestRecorder extends TestRecorder {
1507         function start() {
1508                 parent::start();
1509                 $this->results = array();
1510                 $this->ping( 'running' );
1511         }
1512
1513         function record( $test, $result ) {
1514                 parent::record( $test, $result );
1515                 $this->results[$test] = (bool)$result;
1516         }
1517
1518         function end() {
1519                 $this->ping( 'complete', $this->results );
1520                 parent::end();
1521         }
1522
1523         /**
1524          * Inform a CodeReview instance that we've started or completed a test run...
1525          * @param $remote array: info on remote target
1526          * @param $status string: "running" - tell it we've started
1527          *                        "complete" - provide test results array
1528          *                        "abort" - something went horribly awry
1529          * @param $data array of test name => true/false
1530          */
1531         function ping( $status, $results=false ) {
1532                 global $wgParserTestRemote, $IP;
1533
1534                 $remote = $wgParserTestRemote;
1535                 $revId = SpecialVersion::getSvnRevision( $IP );
1536                 $jsonResults = json_encode( $results );
1537
1538                 if( !$remote ) {
1539                         print "Can't do remote upload without configuring \$wgParserTestRemote!\n";
1540                         exit( 1 );
1541                 }
1542
1543                 // Generate a hash MAC to validate our credentials
1544                 $message = array(
1545                         $remote['repo'],
1546                         $remote['suite'],
1547                         $revId,
1548                         $status,
1549                 );
1550                 if( $status == "complete" ) {
1551                         $message[] = $jsonResults;
1552                 }
1553                 $hmac = hash_hmac( "sha1", implode( "|", $message ), $remote['secret'] );
1554
1555                 $postData = array(
1556                         'action' => 'codetestupload',
1557                         'format' => 'json',
1558                         'repo'   => $remote['repo'],
1559                         'suite'  => $remote['suite'],
1560                         'rev'    => $revId,
1561                         'status' => $status,
1562                         'hmac'   => $hmac,
1563                 );
1564                 if( $status == "complete" ) {
1565                         $postData['results'] = $jsonResults;
1566                 }
1567                 $response = $this->post( $remote['api-url'], $postData );
1568
1569                 if( $response === false ) {
1570                         print "CodeReview info upload failed to reach server.\n";
1571                         exit( 1 );
1572                 }
1573                 $responseData = json_decode( $response, true );
1574                 if( !is_array( $responseData ) ) {
1575                         print "CodeReview API response not recognized...\n";
1576                         wfDebug( "Unrecognized CodeReview API response: $response\n" );
1577                         exit( 1 );
1578                 }
1579                 if( isset( $responseData['error'] ) ) {
1580                         $code = $responseData['error']['code'];
1581                         $info = $responseData['error']['info'];
1582                         print "CodeReview info upload failed: $code $info\n";
1583                         exit( 1 );
1584                 }
1585         }
1586
1587         function post( $url, $data ) {
1588                 // @fixme: for whatever reason, I get a 417 fail when using CURL's multipart form submit.
1589                 // If we do form URL encoding ourselves, though, it should work.
1590                 return Http::post( $url, array( 'postdata' => wfArrayToCGI( $data ) ) );
1591         }
1592 }