maintenance/parserTests.inc

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