maintenance/parserTests.inc

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