maintenance/parserTests.inc

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