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