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