maintenance/parserTests.php

   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 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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  * @package MediaWiki
  24  * @subpackage Maintenance
  25  */
  26
  27 /** */
  28 $options = array( 'quick', 'color', 'quiet', 'help' );
  29 $optionsWithArgs = array( 'regex' );
  30
  31 require_once( 'commandLine.inc' );
  32 require_once( "$IP/languages/LanguageUtf8.php" );
  33
  34 /** */
  35 class ParserTest {
  36         /**
  37          * boolean $color whereas output should be colorized
  38          * @access private
  39          */
  40         var $color;
  41
  42         /**
  43          * boolean $lightcolor whereas output should use light colors
  44          * @access private
  45          */
  46         var $lightcolor;
  47
  48         /**
  49          * Sets terminal colorization and diff/quick modes depending on OS and
  50          * command-line options (--color and --quick).
  51          *
  52          * @access public
  53          */
  54         function ParserTest() {
  55                 global $options;
  56
  57                 # Only colorize output if stdout is a terminal.
  58                 $this->lightcolor = false;
  59                 $this->color = !wfIsWindows() && posix_isatty(1);
  60
  61                 if( isset( $options['color'] ) ) {
  62                         switch( $options['color'] ) {
  63                         case 'no':
  64                                 $this->color = false;
  65                                 break;
  66                         case 'light':
  67                                 $this->lightcolor = true;
  68                                 # Fall through
  69                         case 'yes':
  70                         default:
  71                                 $this->color = true;
  72                                 break;
  73                         }
  74                 }
  75
  76                 $this->showDiffs = !isset( $options['quick'] );
  77
  78                 $this->quiet = isset( $options['quiet'] );
  79
  80                 if (isset($options['regex'])) {
  81                         $this->regex = $options['regex'];
  82                 } else {
  83                         # Matches anything
  84                         $this->regex = '';
  85                 }
  86         }
  87
  88         /**
  89          * Remove last character if it is a newline
  90          * @access private
  91          */
  92         function chomp($s) {
  93                 if (substr($s, -1) === "\n") {
  94                         return substr($s, 0, -1);
  95                 }
  96                 else {
  97                         return $s;
  98                 }
  99         }
 100
 101         /**
 102          * Run a series of tests listed in the given text file.
 103          * Each test consists of a brief description, wikitext input,
 104          * and the expected HTML output.
 105          *
 106          * Prints status updates on stdout and counts up the total
 107          * number and percentage of passed tests.
 108          *
 109          * @param string $filename
 110          * @return bool True if passed all tests, false if any tests failed.
 111          * @access public
 112          */
 113         function runTestsFromFile( $filename ) {
 114                 $infile = fopen( $filename, 'rt' );
 115                 if( !$infile ) {
 116                         die( "Couldn't open parserTests.txt\n" );
 117                 }
 118
 119                 $data = array();
 120                 $section = null;
 121                 $success = 0;
 122                 $total = 0;
 123                 $n = 0;
 124                 while( false !== ($line = fgets( $infile ) ) ) {
 125                         $n++;
 126                         if( preg_match( '/^!!\s*(\w+)/', $line, $matches ) ) {
 127                                 $section = strtolower( $matches[1] );
 128                                 if( $section == 'endarticle') {
 129                                         if( !isset( $data['text'] ) ) {
 130                                                 die( "'endarticle' without 'text' at line $n\n" );
 131                                         }
 132                                         if( !isset( $data['article'] ) ) {
 133                                                 die( "'endarticle' without 'article' at line $n\n" );
 134                                         }
 135                                         $this->addArticle($this->chomp($data['article']), $this->chomp($data['text']), $n);
 136                                         $data = array();
 137                                         $section = null;
 138                                         continue;
 139                                 }
 140                                 if( $section == 'end' ) {
 141                                         if( !isset( $data['test'] ) ) {
 142                                                 die( "'end' without 'test' at line $n\n" );
 143                                         }
 144                                         if( !isset( $data['input'] ) ) {
 145                                                 die( "'end' without 'input' at line $n\n" );
 146                                         }
 147                                         if( !isset( $data['result'] ) ) {
 148                                                 die( "'end' without 'result' at line $n\n" );
 149                                         }
 150                                         if( !isset( $data['options'] ) ) {
 151                                                 $data['options'] = '';
 152                                         }
 153                                         else {
 154                                                 $data['options'] = $this->chomp( $data['options'] );
 155                                         }
 156                                         if (preg_match('/\\bdisabled\\b/i', $data['options'])
 157                                                 || !preg_match("/{$this->regex}/i", $data['test'])) {
 158                                                 # disabled test
 159                                                 $data = array();
 160                                                 $section = null;
 161                                                 continue;
 162                                         }
 163                                         if( $this->runTest(
 164                                                 $this->chomp( $data['test'] ),
 165                                                 $this->chomp( $data['input'] ),
 166                                                 $this->chomp( $data['result'] ),
 167                                                 $this->chomp( $data['options'] ) ) ) {
 168                                                 $success++;
 169                                         }
 170                                         $total++;
 171                                         $data = array();
 172                                         $section = null;
 173                                         continue;
 174                                 }
 175                                 if ( isset ($data[$section] ) ) {
 176                                         die ( "duplicate section '$section' at line $n\n" );
 177                                 }
 178                                 $data[$section] = '';
 179                                 continue;
 180                         }
 181                         if( $section ) {
 182                                 $data[$section] .= $line;
 183                         }
 184                 }
 185                 if( $total > 0 ) {
 186                         $ratio = IntVal( 100.0 * $success / $total );
 187                         print $this->termColor( 1 ) . "\nPassed $success of $total tests ($ratio%) ";
 188                         if( $success == $total ) {
 189                                 print $this->termColor( 32 ) . "PASSED!";
 190                         } else {
 191                                 print $this->termColor( 31 ) . "FAILED!";
 192                         }
 193                         print $this->termReset() . "\n";
 194                         return ($success == $total);
 195                 } else {
 196                         die( "No tests found.\n" );
 197                 }
 198         }
 199
 200         /**
 201          * Run a given wikitext input through a freshly-constructed wiki parser,
 202          * and compare the output against the expected results.
 203          * Prints status and explanatory messages to stdout.
 204          *
 205          * @param string $input Wikitext to try rendering
 206          * @param string $result Result to output
 207          * @return bool
 208          */
 209         function runTest( $desc, $input, $result, $opts ) {
 210                 if( !$this->quiet ) {
 211                         $this->showTesting( $desc );
 212                 }
 213
 214                 $this->setupGlobals($opts);
 215
 216                 $user =& new User();
 217                 $options =& ParserOptions::newFromUser( $user );
 218
 219                 if (preg_match('/\\bmath\\b/i', $opts)) {
 220                         # XXX this should probably be done by the ParserOptions
 221                         require_once('Math.php');
 222
 223                         $options->setUseTex(true);
 224                 }
 225
 226                 if (preg_match('/title=\[\[(.*)\]\]/', $opts, $m)) {
 227                         $titleText = $m[1];
 228                 }
 229                 else {
 230                         $titleText = 'Parser test';
 231                 }
 232
 233                 $parser =& new Parser();
 234                 $title =& Title::makeTitle( NS_MAIN, $titleText );
 235
 236                 if (preg_match('/\\bpst\\b/i', $opts)) {
 237                         $out = $parser->preSaveTransform( $input, $title, $user, $options );
 238                 } elseif (preg_match('/\\bmsg\\b/i', $opts)) {
 239                         $out = $parser->transformMsg( $input, $options );
 240                 } else {
 241                         $output =& $parser->parse( $input, $title, $options );
 242                         $out = $output->getText();
 243
 244                         if (preg_match('/\\bill\\b/i', $opts)) {
 245                                 $out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
 246                         } else if (preg_match('/\\bcat\\b/i', $opts)) {
 247                                 $out = $this->tidy ( implode( ' ', $output->getCategoryLinks() ) );
 248                         }
 249
 250                         $result = $this->tidy($result);
 251                 }
 252
 253                 $this->teardownGlobals();
 254
 255                 if( $result === $out ) {
 256                         return $this->showSuccess( $desc );
 257                 } else {
 258                         return $this->showFailure( $desc, $result, $out );
 259                 }
 260         }
 261
 262         /**
 263          * Set up the global variables for a consistent environment for each test.
 264          * Ideally this should replace the global configuration entirely.
 265          *
 266          * @access private
 267          */
 268         function setupGlobals($opts = '') {
 269                 # Save the prefixed / quoted table names for later use when we make the temporaries.
 270                 $db =& wfGetDB( DB_READ );
 271                 $this->oldTableNames = array();
 272                 foreach( $this->listTables() as $table ) {
 273                         $this->oldTableNames[$table] = $db->tableName( $table );
 274                 }
 275                 if( !isset( $this->uploadDir ) ) {
 276                         $this->uploadDir = $this->setupUploadDir();
 277                 }
 278
 279                 $settings = array(
 280                         'wgServer' => 'http://localhost',
 281                         'wgScript' => '/index.php',
 282                         'wgScriptPath' => '/',
 283                         'wgArticlePath' => '/wiki/$1',
 284                         'wgUploadPath' => '/images',
 285                         'wgUploadDirectory' => $this->uploadDir,
 286                         'wgStyleSheetPath' => '/skins',
 287                         'wgSitename' => 'MediaWiki',
 288                         'wgLanguageCode' => 'en',
 289                         'wgContLanguageCode' => 'en',
 290                         'wgUseLatin1' => false,
 291                         'wgDBprefix' => 'parsertest',
 292                         'wgDefaultUserOptions' => array(),
 293
 294                         'wgLoadBalancer' => LoadBalancer::newFromParams( $GLOBALS['wgDBservers'] ),
 295                         'wgLang' => new LanguageUtf8(),
 296                         'wgContLang' => new LanguageUtf8(),
 297                         'wgNamespacesWithSubpages' => array( 0 => preg_match('/\\bsubpage\\b/i', $opts)),
 298                         'wgMaxTocLevel' => 999,
 299                         );
 300                 $this->savedGlobals = array();
 301                 foreach( $settings as $var => $val ) {
 302                         $this->savedGlobals[$var] = $GLOBALS[$var];
 303                         $GLOBALS[$var] = $val;
 304                 }
 305                 $GLOBALS['wgLoadBalancer']->loadMasterPos();
 306                 $GLOBALS['wgMessageCache']->initialise( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
 307                 $this->setupDatabase();
 308         }
 309
 310         # List of temporary tables to create, without prefix
 311         # Some of these probably aren't necessary
 312         function listTables() {
 313                 return array('user', 'cur', 'old', 'links',
 314                         'brokenlinks', 'imagelinks', 'categorylinks',
 315                         'linkscc', 'site_stats', 'hitcounter',
 316                         'ipblocks', 'image', 'oldimage',
 317                         'recentchanges',
 318                         'watchlist', 'math', 'searchindex',
 319                         'interwiki', 'querycache',
 320                         'objectcache'
 321                 );
 322         }
 323
 324         /**
 325          * Set up a temporary set of wiki tables to work with for the tests.
 326          * Currently this will only be done once per run, and any changes to
 327          * the db will be visible to later tests in the run.
 328          *
 329          * @access private
 330          */
 331         function setupDatabase() {
 332                 static $setupDB = false;
 333                 global $wgDBprefix;
 334
 335                 # Make sure we don't mess with the live DB
 336                 if (!$setupDB && $wgDBprefix === 'parsertest') {
 337                         $db =& wfGetDB( DB_MASTER );
 338
 339                         $tables = $this->listTables();
 340
 341                         if (!(strcmp($db->getServerVersion(), '4.1') < 0 and stristr($db->getSoftwareLink(), 'MySQL'))) {
 342                                 # Database that supports CREATE TABLE ... LIKE
 343                                 global $wgDBtype;
 344                                 if( $wgDBtype == 'PostgreSQL' ) {
 345                                         $def = 'INCLUDING DEFAULTS';
 346                                 } else {
 347                                         $def = '';
 348                                 }
 349                                 foreach ($tables as $tbl) {
 350                                         $newTableName = $db->tableName( $tbl );
 351                                         $tableName = $this->oldTableNames[$tbl];
 352                                         $db->query("CREATE TEMPORARY TABLE $newTableName (LIKE $tableName $def)");
 353                                 }
 354                         } else {
 355                                 # Hack for MySQL versions < 4.1, which don't support
 356                                 # "CREATE TABLE ... LIKE". Note that
 357                                 # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
 358                                 # would not create the indexes we need....
 359                                 foreach ($tables as $tbl) {
 360                                         $res = $db->query("SHOW CREATE TABLE {$this->oldTableNames[$tbl]}");
 361                                         $row = $db->fetchRow($res);
 362                                         $create = $row[1];
 363                                         $create_tmp = preg_replace('/CREATE TABLE `(.*?)`/', 'CREATE TEMPORARY TABLE `'
 364                                                 . $wgDBprefix . $tbl .'`', $create);
 365                                         if ($create === $create_tmp) {
 366                                                 # Couldn't do replacement
 367                                                 die("could not create temporary table $tbl");
 368                                         }
 369                                         $db->query($create_tmp);
 370                                 }
 371
 372                         }
 373
 374                         # Hack: insert a few Wikipedia in-project interwiki prefixes,
 375                         # for testing inter-language links
 376                         $db->insert( 'interwiki', array(
 377                                 array( 'iw_prefix' => 'Wikipedia',
 378                                        'iw_url'    => 'http://en.wikipedia.org/wiki/$1',
 379                                        'iw_local'  => 0 ),
 380                                 array( 'iw_prefix' => 'MeatBall',
 381                                        'iw_url'    => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
 382                                        'iw_local'  => 0 ),
 383                                 array( 'iw_prefix' => 'zh',
 384                                        'iw_url'    => 'http://zh.wikipedia.org/wiki/$1',
 385                                        'iw_local'  => 1 ),
 386                                 array( 'iw_prefix' => 'es',
 387                                        'iw_url'    => 'http://es.wikipedia.org/wiki/$1',
 388                                        'iw_local'  => 1 ),
 389                                 array( 'iw_prefix' => 'fr',
 390                                        'iw_url'    => 'http://fr.wikipedia.org/wiki/$1',
 391                                        'iw_local'  => 1 ),
 392                                 array( 'iw_prefix' => 'ru',
 393                                        'iw_url'    => 'http://ru.wikipedia.org/wiki/$1',
 394                                        'iw_local'  => 1 ),
 395                                 ) );
 396
 397
 398                         $setupDB = true;
 399                 }
 400         }
 401
 402         /**
 403          * Create a dummy uploads directory which will contain a couple
 404          * of files in order to pass existence tests.
 405          * @return string The directory
 406          * @access private
 407          */
 408         function setupUploadDir() {
 409                 $dir = "/tmp/mwParser-" . mt_rand() . "-images";
 410                 mkdir( $dir );
 411                 mkdir( $dir . '/3' );
 412                 mkdir( $dir . '/3/3a' );
 413                 $f = fopen( $dir . '/3/3a/Foobar.jpg', 'wb' );
 414                 fwrite( $f, 'Dummy file' );
 415                 fclose( $f );
 416                 return $dir;
 417         }
 418
 419         /**
 420          * Restore default values and perform any necessary clean-up
 421          * after each test runs.
 422          *
 423          * @access private
 424          */
 425         function teardownGlobals() {
 426                 foreach( $this->savedGlobals as $var => $val ) {
 427                         $GLOBALS[$var] = $val;
 428                 }
 429                 if( isset( $this->uploadDir ) ) {
 430                         $this->teardownUploadDir( $this->uploadDir );
 431                         unset( $this->uploadDir );
 432                 }
 433         }
 434
 435         /**
 436          * Remove the dummy uploads directory
 437          * @access private
 438          */
 439         function teardownUploadDir( $dir ) {
 440                 unlink( "$dir/3/3a/Foobar.jpg" );
 441                 rmdir( "$dir/3/3a" );
 442                 rmdir( "$dir/3" );
 443                 @rmdir( "$dir/thumb/3/39" );
 444                 @rmdir( "$dir/thumb/3" );
 445                 @rmdir( "$dir/thumb" );
 446                 rmdir( "$dir" );
 447         }
 448
 449         /**
 450          * "Running test $desc..."
 451          * @access private
 452          */
 453         function showTesting( $desc ) {
 454                 print "Running test $desc... ";
 455         }
 456
 457         /**
 458          * Print a happy success message.
 459          *
 460          * @param string $desc The test name
 461          * @return bool
 462          * @access private
 463          */
 464         function showSuccess( $desc ) {
 465                 if( !$this->quiet ) {
 466                         print $this->termColor( '1;32' ) . 'PASSED' . $this->termReset() . "\n";
 467                 }
 468                 return true;
 469         }
 470
 471         /**
 472          * Print a failure message and provide some explanatory output
 473          * about what went wrong if so configured.
 474          *
 475          * @param string $desc The test name
 476          * @param string $result Expected HTML output
 477          * @param string $html Actual HTML output
 478          * @return bool
 479          * @access private
 480          */
 481         function showFailure( $desc, $result, $html ) {
 482                 if( $this->quiet ) {
 483                         # In quiet mode we didn't show the 'Testing' message before the
 484                         # test, in case it succeeded. Show it now:
 485                         $this->showTesting( $desc );
 486                 }
 487                 print $this->termColor( '1;31' ) . 'FAILED!' . $this->termReset() . "\n";
 488                 if( $this->showDiffs ) {
 489                         print $this->quickDiff( $result, $html );
 490                 }
 491                 return false;
 492         }
 493
 494         /**
 495          * Run given strings through a diff and return the (colorized) output.
 496          * Requires writable /tmp directory and a 'diff' command in the PATH.
 497          *
 498          * @param string $input
 499          * @param string $output
 500          * @return string
 501          * @access private
 502          */
 503         function quickDiff( $input, $output ) {
 504                 $prefix = "/tmp/mwParser-" . mt_rand();
 505
 506                 $infile = "$prefix-expected";
 507                 $this->dumpToFile( $input, $infile );
 508
 509                 $outfile = "$prefix-actual";
 510                 $this->dumpToFile( $output, $outfile );
 511
 512                 $diff = `diff -au $infile $outfile`;
 513                 unlink( $infile );
 514                 unlink( $outfile );
 515
 516                 return $this->colorDiff( $diff );
 517         }
 518
 519         /**
 520          * Write the given string to a file, adding a final newline.
 521          *
 522          * @param string $data
 523          * @param string $filename
 524          * @access private
 525          */
 526         function dumpToFile( $data, $filename ) {
 527                 $file = fopen( $filename, "wt" );
 528                 fwrite( $file, $data . "\n" );
 529                 fclose( $file );
 530         }
 531
 532         /**
 533          * Return ANSI terminal escape code for changing text attribs/color,
 534          * or empty string if color output is disabled.
 535          *
 536          * @param string $color Semicolon-separated list of attribute/color codes
 537          * @return string
 538          * @access private
 539          */
 540         function termColor( $color ) {
 541                 if($this->lightcolor) {
 542                         return $this->color ? "\x1b[1;{$color}m" : '';
 543                 } else {
 544                         return $this->color ? "\x1b[{$color}m" : '';
 545                 }
 546         }
 547
 548         /**
 549          * Return ANSI terminal escape code for restoring default text attributes,
 550          * or empty string if color output is disabled.
 551          *
 552          * @return string
 553          * @access private
 554          */
 555         function termReset() {
 556                 return $this->color ? "\x1b[0m" : '';
 557         }
 558
 559         /**
 560          * Colorize unified diff output if set for ANSI color output.
 561          * Subtractions are colored blue, additions red.
 562          *
 563          * @param string $text
 564          * @return string
 565          * @access private
 566          */
 567         function colorDiff( $text ) {
 568                 return preg_replace(
 569                         array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
 570                         array( $this->termColor( 34 ) . '$1' . $this->termReset(),
 571                                $this->termColor( 31 ) . '$1' . $this->termReset() ),
 572                         $text );
 573         }
 574
 575         /**
 576          * Insert a temporary test article
 577          * @param string $name the title, including any prefix
 578          * @param string $text the article text
 579          * @param int $line the input line number, for reporting errors
 580          * @static
 581          * @access private
 582          */
 583         function addArticle($name, $text, $line) {
 584                 $this->setupGlobals();
 585                 $title = Title::newFromText( $name );
 586                 if ( is_null($title) ) {
 587                         die( "invalid title at line $line\n" );
 588                 }
 589
 590                 $aid = $title->getArticleID( GAID_FOR_UPDATE );
 591                 if ($aid != 0) {
 592                         die( "duplicate article at line $line\n" );
 593                 }
 594
 595                 $art = new Article($title);
 596                 $art->insertNewArticle($text, '', false, false );
 597                 $this->teardownGlobals();
 598         }
 599
 600         /*
 601          * Run the "tidy" command on text if the $wgUseTidy
 602          * global is true
 603          *
 604          * @param string $text the text to tidy
 605          * @return string
 606          * @static
 607          * @access private
 608          */
 609         function tidy( $text ) {
 610                 global $wgUseTidy;
 611                 if ($wgUseTidy) {
 612                         $text = Parser::tidy($text);
 613                 }
 614                 return $text;
 615         }
 616 }
 617
 618 if( isset( $options['help'] ) ) {
 619         echo <<<END
 620 MediaWiki $wgVersion parser test suite
 621 Usage: php parserTests.php [--quick] [--quiet] [--color[=(yes|no|light)]]
 622                            [--regex <expression>] [--help]
 623 Options:
 624   --quick  Suppress diff output of failed tests
 625   --quiet  Suppress notification of passed tests (shows only failed tests)
 626   --color  Override terminal detection and force color output on or off
 627            'light' option is similar to 'yes' but with color for dark backgrounds
 628   --regex  Only run tests whose descriptions which match given regex
 629   --help   Show this help message
 630
 631
 632 END;
 633         exit( 0 );
 634 }
 635
 636 # There is a convention that the parser should never
 637 # refer to $wgTitle directly, but instead use the title
 638 # passed to it.
 639 $wgTitle = Title::newFromText( 'Parser test script do not use' );
 640 $tester =& new ParserTest();
 641
 642 # Note: the command line setup changes the current working directory
 643 # to the parent, which is why we have to put the subdir here:
 644 $ok = $tester->runTestsFromFile( 'maintenance/parserTests.txt' );
 645
 646 exit ($ok ? 0 : -1);
 647
 648 ?>