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