2 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
3 # http://www.mediawiki.org/
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.
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.
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
21 * @todo Make this more independent of the configuration (and if possible the database)
24 * @subpackage Maintenance
28 $options = array( 'quick', 'color', 'quiet', 'help' );
29 $optionsWithArgs = array( 'regex' );
31 require_once( 'commandLine.inc' );
32 require_once( "$IP/includes/ObjectCache.php" );
33 require_once( "$IP/includes/BagOStuff.php" );
34 require_once( "$IP/languages/LanguageUtf8.php" );
35 require_once( "$IP/includes/Hooks.php" );
36 require_once( "$IP/maintenance/parserTestsParserHook.php" );
37 require_once( "$IP/maintenance/parserTestsStaticParserHook.php" );
38 require_once( "$IP/maintenance/parserTestsParserTime.php" );
42 * @subpackage Maintenance
46 * boolean $color whereas output should be colorized
52 * boolean $lightcolor whereas output should use light colors
58 * Sets terminal colorization and diff/quick modes depending on OS and
59 * command-line options (--color and --quick).
63 function ParserTest() {
66 # Only colorize output if stdout is a terminal.
67 $this->lightcolor = false;
68 $this->color = !wfIsWindows() && posix_isatty(1);
70 if( isset( $options['color'] ) ) {
71 switch( $options['color'] ) {
76 $this->lightcolor = true;
85 $this->showDiffs = !isset( $options['quick'] );
87 $this->quiet = isset( $options['quiet'] );
89 if (isset($options['regex'])) {
90 $this->regex = $options['regex'];
98 * Remove last character if it is a newline
102 if (substr($s, -1) === "\n") {
103 return substr($s, 0, -1);
111 * Run a series of tests listed in the given text file.
112 * Each test consists of a brief description, wikitext input,
113 * and the expected HTML output.
115 * Prints status updates on stdout and counts up the total
116 * number and percentage of passed tests.
118 * @param string $filename
119 * @return bool True if passed all tests, false if any tests failed.
122 function runTestsFromFile( $filename ) {
123 $infile = fopen( $filename, 'rt' );
125 wfDie( "Couldn't open parserTests.txt\n" );
133 while( false !== ($line = fgets( $infile ) ) ) {
135 if( preg_match( '/^!!\s*(\w+)/', $line, $matches ) ) {
136 $section = strtolower( $matches[1] );
137 if( $section == 'endarticle') {
138 if( !isset( $data['text'] ) ) {
139 wfDie( "'endarticle' without 'text' at line $n\n" );
141 if( !isset( $data['article'] ) ) {
142 wfDie( "'endarticle' without 'article' at line $n\n" );
144 $this->addArticle($this->chomp($data['article']), $this->chomp($data['text']), $n);
149 if( $section == 'end' ) {
150 if( !isset( $data['test'] ) ) {
151 wfDie( "'end' without 'test' at line $n\n" );
153 if( !isset( $data['input'] ) ) {
154 wfDie( "'end' without 'input' at line $n\n" );
156 if( !isset( $data['result'] ) ) {
157 wfDie( "'end' without 'result' at line $n\n" );
159 if( !isset( $data['options'] ) ) {
160 $data['options'] = '';
163 $data['options'] = $this->chomp( $data['options'] );
165 if (preg_match('/\\bdisabled\\b/i', $data['options'])
166 || !preg_match("/{$this->regex}/i", $data['test'])) {
173 $this->chomp( $data['test'] ),
174 $this->chomp( $data['input'] ),
175 $this->chomp( $data['result'] ),
176 $this->chomp( $data['options'] ) ) ) {
184 if ( isset ($data[$section] ) ) {
185 wfDie( "duplicate section '$section' at line $n\n" );
187 $data[$section] = '';
191 $data[$section] .= $line;
195 $ratio = wfPercent( 100 * $success / $total );
196 print $this->termColor( 1 ) . "\nPassed $success of $total tests ($ratio) ";
197 if( $success == $total ) {
198 print $this->termColor( 32 ) . "PASSED!";
200 print $this->termColor( 31 ) . "FAILED!";
202 print $this->termReset() . "\n";
203 return ($success == $total);
205 wfDie( "No tests found.\n" );
210 * Run a given wikitext input through a freshly-constructed wiki parser,
211 * and compare the output against the expected results.
212 * Prints status and explanatory messages to stdout.
214 * @param string $input Wikitext to try rendering
215 * @param string $result Result to output
218 function runTest( $desc, $input, $result, $opts ) {
219 if( !$this->quiet ) {
220 $this->showTesting( $desc );
223 $this->setupGlobals($opts);
226 $options = ParserOptions::newFromUser( $user );
228 if (preg_match('/\\bmath\\b/i', $opts)) {
229 # XXX this should probably be done by the ParserOptions
230 require_once('Math.php');
232 $options->setUseTex(true);
235 if (preg_match('/title=\[\[(.*)\]\]/', $opts, $m)) {
239 $titleText = 'Parser test';
242 $noxml = (bool)preg_match( '~\\b noxml \\b~x', $opts );
244 $parser =& new Parser();
245 wfRunHooks( 'ParserTestParser', array( &$parser ) );
247 $title =& Title::makeTitle( NS_MAIN, $titleText );
249 if (preg_match('/\\bpst\\b/i', $opts)) {
250 $out = $parser->preSaveTransform( $input, $title, $user, $options );
251 } elseif (preg_match('/\\bmsg\\b/i', $opts)) {
252 $out = $parser->transformMsg( $input, $options );
254 $output = $parser->parse( $input, $title, $options, true, true, 1337 );
255 $out = $output->getText();
257 if (preg_match('/\\bill\\b/i', $opts)) {
258 $out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
259 } else if (preg_match('/\\bcat\\b/i', $opts)) {
261 $wgOut->addCategoryLinks($output->getCategories());
262 $out = $this->tidy ( implode( ' ', $wgOut->getCategoryLinks() ) );
265 $result = $this->tidy($result);
268 $this->teardownGlobals();
270 if( $result === $out && ( $noxml === true || $this->wellFormed( $out ) ) ) {
271 return $this->showSuccess( $desc );
273 return $this->showFailure( $desc, $result, $out );
278 * Set up the global variables for a consistent environment for each test.
279 * Ideally this should replace the global configuration entirely.
283 function setupGlobals($opts = '') {
284 # Save the prefixed / quoted table names for later use when we make the temporaries.
285 $db =& wfGetDB( DB_READ );
286 $this->oldTableNames = array();
287 foreach( $this->listTables() as $table ) {
288 $this->oldTableNames[$table] = $db->tableName( $table );
290 if( !isset( $this->uploadDir ) ) {
291 $this->uploadDir = $this->setupUploadDir();
295 'wgServer' => 'http://localhost',
296 'wgScript' => '/index.php',
297 'wgScriptPath' => '/',
298 'wgArticlePath' => '/wiki/$1',
299 'wgActionPaths' => array(),
300 'wgUploadPath' => 'http://example.com/images',
301 'wgUploadDirectory' => $this->uploadDir,
302 'wgStyleSheetPath' => '/skins',
303 'wgSitename' => 'MediaWiki',
304 'wgServerName' => 'Britney Spears',
305 'wgLanguageCode' => 'en',
306 'wgContLanguageCode' => 'en',
307 'wgDBprefix' => 'parsertest_',
308 'wgDefaultUserOptions' => array(),
310 'wgLang' => new LanguageUtf8(),
311 'wgContLang' => new LanguageUtf8(),
312 'wgNamespacesWithSubpages' => array( 0 => preg_match('/\\bsubpage\\b/i', $opts)),
313 'wgMaxTocLevel' => 999,
314 'wgCapitalLinks' => true,
315 'wgDefaultUserOptions' => array(),
316 'wgNoFollowLinks' => true,
317 'wgThumbnailScriptPath' => false,
319 'wgLocaltimezone' => 'UTC',
321 $this->savedGlobals = array();
322 foreach( $settings as $var => $val ) {
323 $this->savedGlobals[$var] = $GLOBALS[$var];
324 $GLOBALS[$var] = $val;
326 $GLOBALS['wgLoadBalancer']->loadMasterPos();
327 $GLOBALS['wgMessageCache']->initialise( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
328 $this->setupDatabase();
331 $wgUser = new User();
334 # List of temporary tables to create, without prefix
335 # Some of these probably aren't necessary
336 function listTables() {
337 $tables = array('user', 'page', 'revision', 'text',
338 'pagelinks', 'imagelinks', 'categorylinks', 'templatelinks', 'externallinks',
339 'site_stats', 'hitcounter',
340 'ipblocks', 'image', 'oldimage',
342 'watchlist', 'math', 'searchindex',
343 'interwiki', 'querycache',
347 // FIXME manually adding additional table for the tasks extension
348 // we probably need a better software wide system to register new
350 global $wgExtensionFunctions;
351 if( in_array('wfTasksExtension' , $wgExtensionFunctions ) ) {
359 * Set up a temporary set of wiki tables to work with for the tests.
360 * Currently this will only be done once per run, and any changes to
361 * the db will be visible to later tests in the run.
365 function setupDatabase() {
366 static $setupDB = false;
369 # Make sure we don't mess with the live DB
370 if (!$setupDB && $wgDBprefix === 'parsertest_') {
372 $GLOBALS['wgLoadBalancer'] = LoadBalancer::newFromParams( $GLOBALS['wgDBservers'] );
373 $db =& wfGetDB( DB_MASTER );
375 $tables = $this->listTables();
377 if (!(strcmp($db->getServerVersion(), '4.1') < 0 and stristr($db->getSoftwareLink(), 'MySQL'))) {
378 # Database that supports CREATE TABLE ... LIKE
380 if( $wgDBtype == 'PostgreSQL' ) {
381 $def = 'INCLUDING DEFAULTS';
385 foreach ($tables as $tbl) {
386 $newTableName = $db->tableName( $tbl );
387 $tableName = $this->oldTableNames[$tbl];
388 $db->query("CREATE TEMPORARY TABLE $newTableName (LIKE $tableName $def)");
391 # Hack for MySQL versions < 4.1, which don't support
392 # "CREATE TABLE ... LIKE". Note that
393 # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
394 # would not create the indexes we need....
395 foreach ($tables as $tbl) {
396 $res = $db->query("SHOW CREATE TABLE {$this->oldTableNames[$tbl]}");
397 $row = $db->fetchRow($res);
399 $create_tmp = preg_replace('/CREATE TABLE `(.*?)`/', 'CREATE TEMPORARY TABLE `'
400 . $wgDBprefix . $tbl .'`', $create);
401 if ($create === $create_tmp) {
402 # Couldn't do replacement
403 wfDie("could not create temporary table $tbl");
405 $db->query($create_tmp);
410 # Hack: insert a few Wikipedia in-project interwiki prefixes,
411 # for testing inter-language links
412 $db->insert( 'interwiki', array(
413 array( 'iw_prefix' => 'Wikipedia',
414 'iw_url' => 'http://en.wikipedia.org/wiki/$1',
416 array( 'iw_prefix' => 'MeatBall',
417 'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
419 array( 'iw_prefix' => 'zh',
420 'iw_url' => 'http://zh.wikipedia.org/wiki/$1',
422 array( 'iw_prefix' => 'es',
423 'iw_url' => 'http://es.wikipedia.org/wiki/$1',
425 array( 'iw_prefix' => 'fr',
426 'iw_url' => 'http://fr.wikipedia.org/wiki/$1',
428 array( 'iw_prefix' => 'ru',
429 'iw_url' => 'http://ru.wikipedia.org/wiki/$1',
433 # Hack: Insert an image to work with
434 $db->insert( 'image', array(
435 'img_name' => 'Foobar.jpg',
437 'img_description' => 'Some lame file',
439 'img_user_text' => 'WikiSysop',
440 'img_timestamp' => $db->timestamp( '20010115123500' ),
444 'img_media_type' => MEDIATYPE_BITMAP,
445 'img_major_mime' => "image",
446 'img_minor_mime' => "jpeg",
454 * Create a dummy uploads directory which will contain a couple
455 * of files in order to pass existence tests.
456 * @return string The directory
459 function setupUploadDir() {
462 $dir = wfTempDir() . "/mwParser-" . mt_rand() . "-images";
464 mkdir( $dir . '/3' );
465 mkdir( $dir . '/3/3a' );
467 $img = "$IP/skins/monobook/headbg.jpg";
468 $h = fopen($img, 'r');
469 $c = fread($h, filesize($img));
472 $f = fopen( $dir . '/3/3a/Foobar.jpg', 'wb' );
479 * Restore default values and perform any necessary clean-up
480 * after each test runs.
484 function teardownGlobals() {
485 foreach( $this->savedGlobals as $var => $val ) {
486 $GLOBALS[$var] = $val;
488 if( isset( $this->uploadDir ) ) {
489 $this->teardownUploadDir( $this->uploadDir );
490 unset( $this->uploadDir );
495 * Remove the dummy uploads directory
498 function teardownUploadDir( $dir ) {
499 unlink( "$dir/3/3a/Foobar.jpg" );
500 rmdir( "$dir/3/3a" );
502 @rmdir( "$dir/thumb/6/65" );
503 @rmdir( "$dir/thumb/6" );
505 @unlink( "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg" );
506 @rmdir( "$dir/thumb/3/3a/Foobar.jpg" );
507 @rmdir( "$dir/thumb/3/3a" );
508 @rmdir( "$dir/thumb/3/39" ); # wtf?
509 @rmdir( "$dir/thumb/3" );
510 @rmdir( "$dir/thumb" );
515 * "Running test $desc..."
518 function showTesting( $desc ) {
519 print "Running test $desc... ";
523 * Print a happy success message.
525 * @param string $desc The test name
529 function showSuccess( $desc ) {
530 if( !$this->quiet ) {
531 print $this->termColor( '1;32' ) . 'PASSED' . $this->termReset() . "\n";
537 * Print a failure message and provide some explanatory output
538 * about what went wrong if so configured.
540 * @param string $desc The test name
541 * @param string $result Expected HTML output
542 * @param string $html Actual HTML output
546 function showFailure( $desc, $result, $html ) {
548 # In quiet mode we didn't show the 'Testing' message before the
549 # test, in case it succeeded. Show it now:
550 $this->showTesting( $desc );
552 print $this->termColor( '1;31' ) . 'FAILED!' . $this->termReset() . "\n";
553 if( $this->showDiffs ) {
554 print $this->quickDiff( $result, $html );
555 if( !$this->wellFormed( $html ) ) {
556 print "XML error: $this->mXmlError\n";
563 * Run given strings through a diff and return the (colorized) output.
564 * Requires writable /tmp directory and a 'diff' command in the PATH.
566 * @param string $input
567 * @param string $output
568 * @param string $inFileTail Tailing for the input file name
569 * @param string $outFileTail Tailing for the output file name
573 function quickDiff( $input, $output, $inFileTail='expected', $outFileTail='actual' ) {
574 $prefix = wfTempDir() . "/mwParser-" . mt_rand();
576 $infile = "$prefix-$inFileTail";
577 $this->dumpToFile( $input, $infile );
579 $outfile = "$prefix-$outFileTail";
580 $this->dumpToFile( $output, $outfile );
582 $diff = `diff -au $infile $outfile`;
586 return $this->colorDiff( $diff );
590 * Write the given string to a file, adding a final newline.
592 * @param string $data
593 * @param string $filename
596 function dumpToFile( $data, $filename ) {
597 $file = fopen( $filename, "wt" );
598 fwrite( $file, $data . "\n" );
603 * Return ANSI terminal escape code for changing text attribs/color,
604 * or empty string if color output is disabled.
606 * @param string $color Semicolon-separated list of attribute/color codes
610 function termColor( $color ) {
611 if($this->lightcolor) {
612 return $this->color ? "\x1b[1;{$color}m" : '';
614 return $this->color ? "\x1b[{$color}m" : '';
619 * Return ANSI terminal escape code for restoring default text attributes,
620 * or empty string if color output is disabled.
625 function termReset() {
626 return $this->color ? "\x1b[0m" : '';
630 * Colorize unified diff output if set for ANSI color output.
631 * Subtractions are colored blue, additions red.
633 * @param string $text
637 function colorDiff( $text ) {
639 array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
640 array( $this->termColor( 34 ) . '$1' . $this->termReset(),
641 $this->termColor( 31 ) . '$1' . $this->termReset() ),
646 * Insert a temporary test article
647 * @param string $name the title, including any prefix
648 * @param string $text the article text
649 * @param int $line the input line number, for reporting errors
653 function addArticle($name, $text, $line) {
654 $this->setupGlobals();
655 $title = Title::newFromText( $name );
656 if ( is_null($title) ) {
657 wfDie( "invalid title at line $line\n" );
660 $aid = $title->getArticleID( GAID_FOR_UPDATE );
662 wfDie( "duplicate article at line $line\n" );
665 $art = new Article($title);
666 $art->insertNewArticle($text, '', false, false );
667 $this->teardownGlobals();
671 * Run the "tidy" command on text if the $wgUseTidy
674 * @param string $text the text to tidy
679 function tidy( $text ) {
682 $text = Parser::tidy($text);
687 function wellFormed( $text ) {
689 Sanitizer::hackDocType() .
694 $parser = xml_parser_create( "UTF-8" );
696 # case folding violates XML standard, turn it off
697 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
699 if( !xml_parse( $parser, $html, true ) ) {
700 $err = xml_error_string( xml_get_error_code( $parser ) );
701 $position = xml_get_current_byte_index( $parser );
702 $fragment = $this->extractFragment( $html, $position );
703 $this->mXmlError = "$err at byte $position:\n$fragment";
704 xml_parser_free( $parser );
707 xml_parser_free( $parser );
711 function extractFragment( $text, $position ) {
712 $start = max( 0, $position - 10 );
713 $before = $position - $start;
715 $this->termColor( 34 ) .
716 substr( $text, $start, $before ) .
717 $this->termColor( 0 ) .
718 $this->termColor( 31 ) .
719 $this->termColor( 1 ) .
720 substr( $text, $position, 1 ) .
721 $this->termColor( 0 ) .
722 $this->termColor( 34 ) .
723 substr( $text, $position + 1, 9 ) .
724 $this->termColor( 0 ) .
726 $display = str_replace( "\n", ' ', $fragment );
728 str_repeat( ' ', $before ) .
729 $this->termColor( 31 ) .
731 $this->termColor( 0 );
732 return "$display\n$caret";