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'];
96 $this->hooks = array();
100 * Remove last character if it is a newline
104 if (substr($s, -1) === "\n") {
105 return substr($s, 0, -1);
113 * Run a series of tests listed in the given text file.
114 * Each test consists of a brief description, wikitext input,
115 * and the expected HTML output.
117 * Prints status updates on stdout and counts up the total
118 * number and percentage of passed tests.
120 * @param string $filename
121 * @return bool True if passed all tests, false if any tests failed.
124 function runTestsFromFile( $filename ) {
125 $infile = fopen( $filename, 'rt' );
127 wfDie( "Couldn't open $filename\n" );
135 while( false !== ($line = fgets( $infile ) ) ) {
137 if( preg_match( '/^!!\s*(\w+)/', $line, $matches ) ) {
138 $section = strtolower( $matches[1] );
139 if( $section == 'endarticle') {
140 if( !isset( $data['text'] ) ) {
141 wfDie( "'endarticle' without 'text' at line $n\n" );
143 if( !isset( $data['article'] ) ) {
144 wfDie( "'endarticle' without 'article' at line $n\n" );
146 $this->addArticle($this->chomp($data['article']), $this->chomp($data['text']), $n);
151 if( $section == 'endhooks' ) {
152 if( !isset( $data['hooks'] ) ) {
153 wfDie( "'endhooks' without 'hooks' at line $n\n" );
155 foreach( explode( "\n", $data['hooks'] ) as $line ) {
156 $line = trim( $line );
158 $this->requireHook( $line );
165 if( $section == 'end' ) {
166 if( !isset( $data['test'] ) ) {
167 wfDie( "'end' without 'test' at line $n\n" );
169 if( !isset( $data['input'] ) ) {
170 wfDie( "'end' without 'input' at line $n\n" );
172 if( !isset( $data['result'] ) ) {
173 wfDie( "'end' without 'result' at line $n\n" );
175 if( !isset( $data['options'] ) ) {
176 $data['options'] = '';
179 $data['options'] = $this->chomp( $data['options'] );
181 if (preg_match('/\\bdisabled\\b/i', $data['options'])
182 || !preg_match("/{$this->regex}/i", $data['test'])) {
189 $this->chomp( $data['test'] ),
190 $this->chomp( $data['input'] ),
191 $this->chomp( $data['result'] ),
192 $this->chomp( $data['options'] ) ) ) {
200 if ( isset ($data[$section] ) ) {
201 wfDie( "duplicate section '$section' at line $n\n" );
203 $data[$section] = '';
207 $data[$section] .= $line;
211 $ratio = wfPercent( 100 * $success / $total );
212 print $this->termColor( 1 ) . "\nPassed $success of $total tests ($ratio) ";
213 if( $success == $total ) {
214 print $this->termColor( 32 ) . "PASSED!";
216 print $this->termColor( 31 ) . "FAILED!";
218 print $this->termReset() . "\n";
219 return ($success == $total);
221 wfDie( "No tests found.\n" );
226 * Run a given wikitext input through a freshly-constructed wiki parser,
227 * and compare the output against the expected results.
228 * Prints status and explanatory messages to stdout.
230 * @param string $input Wikitext to try rendering
231 * @param string $result Result to output
234 function runTest( $desc, $input, $result, $opts ) {
235 if( !$this->quiet ) {
236 $this->showTesting( $desc );
239 $this->setupGlobals($opts);
242 $options = ParserOptions::newFromUser( $user );
244 if (preg_match('/\\bmath\\b/i', $opts)) {
245 # XXX this should probably be done by the ParserOptions
246 $options->setUseTex(true);
249 if (preg_match('/title=\[\[(.*)\]\]/', $opts, $m)) {
253 $titleText = 'Parser test';
256 $noxml = (bool)preg_match( '~\\b noxml \\b~x', $opts );
258 $parser =& new Parser();
259 foreach( $this->hooks as $tag => $callback ) {
260 $parser->setHook( $tag, $callback );
262 wfRunHooks( 'ParserTestParser', array( &$parser ) );
264 $title =& Title::makeTitle( NS_MAIN, $titleText );
266 if (preg_match('/\\bpst\\b/i', $opts)) {
267 $out = $parser->preSaveTransform( $input, $title, $user, $options );
268 } elseif (preg_match('/\\bmsg\\b/i', $opts)) {
269 $out = $parser->transformMsg( $input, $options );
270 } elseif( preg_match( '/\\bsection=(\d+)\b/i', $opts, $matches ) ) {
271 $section = intval( $matches[1] );
272 $out = $parser->getSection( $input, $section );
273 } elseif( preg_match( '/\\breplace=(\d+),"(.*?)"/i', $opts, $matches ) ) {
274 $section = intval( $matches[1] );
275 $replace = $matches[2];
276 $out = $parser->replaceSection( $input, $section, $replace );
278 $output = $parser->parse( $input, $title, $options, true, true, 1337 );
279 $out = $output->getText();
281 if (preg_match('/\\bill\\b/i', $opts)) {
282 $out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
283 } else if (preg_match('/\\bcat\\b/i', $opts)) {
285 $wgOut->addCategoryLinks($output->getCategories());
286 $out = $this->tidy ( implode( ' ', $wgOut->getCategoryLinks() ) );
289 $result = $this->tidy($result);
292 $this->teardownGlobals();
294 if( $result === $out && ( $noxml === true || $this->wellFormed( $out ) ) ) {
295 return $this->showSuccess( $desc );
297 return $this->showFailure( $desc, $result, $out );
302 * Set up the global variables for a consistent environment for each test.
303 * Ideally this should replace the global configuration entirely.
307 function setupGlobals($opts = '') {
308 # Save the prefixed / quoted table names for later use when we make the temporaries.
309 $db =& wfGetDB( DB_READ );
310 $this->oldTableNames = array();
311 foreach( $this->listTables() as $table ) {
312 $this->oldTableNames[$table] = $db->tableName( $table );
314 if( !isset( $this->uploadDir ) ) {
315 $this->uploadDir = $this->setupUploadDir();
318 if( preg_match( '/language=([a-z]+(?:_[a-z]+)?)/', $opts, $m ) ) {
325 'wgServer' => 'http://localhost',
326 'wgScript' => '/index.php',
327 'wgScriptPath' => '/',
328 'wgArticlePath' => '/wiki/$1',
329 'wgActionPaths' => array(),
330 'wgUploadPath' => 'http://example.com/images',
331 'wgUploadDirectory' => $this->uploadDir,
332 'wgStyleSheetPath' => '/skins',
333 'wgSitename' => 'MediaWiki',
334 'wgServerName' => 'Britney Spears',
335 'wgLanguageCode' => $lang,
336 'wgContLanguageCode' => $lang,
337 'wgDBprefix' => 'parsertest_',
338 'wgDefaultUserOptions' => array(),
341 'wgContLang' => null,
342 'wgNamespacesWithSubpages' => array( 0 => preg_match('/\\bsubpage\\b/i', $opts)),
343 'wgMaxTocLevel' => 999,
344 'wgCapitalLinks' => true,
345 'wgDefaultUserOptions' => array(),
346 'wgNoFollowLinks' => true,
347 'wgThumbnailScriptPath' => false,
349 'wgLocaltimezone' => 'UTC',
351 $this->savedGlobals = array();
352 foreach( $settings as $var => $val ) {
353 $this->savedGlobals[$var] = $GLOBALS[$var];
354 $GLOBALS[$var] = $val;
356 $langClass = 'Language' . str_replace( '-', '_', ucfirst( $lang ) );
357 $langObj = setupLangObj( $langClass );
358 $GLOBALS['wgLang'] = $langObj;
359 $GLOBALS['wgContLang'] = $langObj;
361 $GLOBALS['wgLoadBalancer']->loadMasterPos();
362 $GLOBALS['wgMessageCache']->initialise( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
363 $this->setupDatabase();
366 $wgUser = new User();
369 # List of temporary tables to create, without prefix
370 # Some of these probably aren't necessary
371 function listTables() {
372 $tables = array('user', 'page', 'revision', 'text',
373 'pagelinks', 'imagelinks', 'categorylinks',
374 'templatelinks', 'externallinks', 'langlinks',
375 'site_stats', 'hitcounter',
376 'ipblocks', 'image', 'oldimage',
378 'watchlist', 'math', 'searchindex',
379 'interwiki', 'querycache',
383 // FIXME manually adding additional table for the tasks extension
384 // we probably need a better software wide system to register new
386 global $wgExtensionFunctions;
387 if( in_array('wfTasksExtension' , $wgExtensionFunctions ) ) {
395 * Set up a temporary set of wiki tables to work with for the tests.
396 * Currently this will only be done once per run, and any changes to
397 * the db will be visible to later tests in the run.
401 function setupDatabase() {
402 static $setupDB = false;
405 # Make sure we don't mess with the live DB
406 if (!$setupDB && $wgDBprefix === 'parsertest_') {
408 $GLOBALS['wgLoadBalancer'] = LoadBalancer::newFromParams( $GLOBALS['wgDBservers'] );
409 $db =& wfGetDB( DB_MASTER );
411 $tables = $this->listTables();
413 if (!(strcmp($db->getServerVersion(), '4.1') < 0 and stristr($db->getSoftwareLink(), 'MySQL'))) {
414 # Database that supports CREATE TABLE ... LIKE
416 if( $wgDBtype == 'PostgreSQL' ) {
417 $def = 'INCLUDING DEFAULTS';
421 foreach ($tables as $tbl) {
422 $newTableName = $db->tableName( $tbl );
423 $tableName = $this->oldTableNames[$tbl];
424 $db->query("CREATE TEMPORARY TABLE $newTableName (LIKE $tableName $def)");
427 # Hack for MySQL versions < 4.1, which don't support
428 # "CREATE TABLE ... LIKE". Note that
429 # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
430 # would not create the indexes we need....
431 foreach ($tables as $tbl) {
432 $res = $db->query("SHOW CREATE TABLE {$this->oldTableNames[$tbl]}");
433 $row = $db->fetchRow($res);
435 $create_tmp = preg_replace('/CREATE TABLE `(.*?)`/', 'CREATE TEMPORARY TABLE `'
436 . $wgDBprefix . $tbl .'`', $create);
437 if ($create === $create_tmp) {
438 # Couldn't do replacement
439 wfDie("could not create temporary table $tbl");
441 $db->query($create_tmp);
446 # Hack: insert a few Wikipedia in-project interwiki prefixes,
447 # for testing inter-language links
448 $db->insert( 'interwiki', array(
449 array( 'iw_prefix' => 'Wikipedia',
450 'iw_url' => 'http://en.wikipedia.org/wiki/$1',
452 array( 'iw_prefix' => 'MeatBall',
453 'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
455 array( 'iw_prefix' => 'zh',
456 'iw_url' => 'http://zh.wikipedia.org/wiki/$1',
458 array( 'iw_prefix' => 'es',
459 'iw_url' => 'http://es.wikipedia.org/wiki/$1',
461 array( 'iw_prefix' => 'fr',
462 'iw_url' => 'http://fr.wikipedia.org/wiki/$1',
464 array( 'iw_prefix' => 'ru',
465 'iw_url' => 'http://ru.wikipedia.org/wiki/$1',
469 # Hack: Insert an image to work with
470 $db->insert( 'image', array(
471 'img_name' => 'Foobar.jpg',
473 'img_description' => 'Some lame file',
475 'img_user_text' => 'WikiSysop',
476 'img_timestamp' => $db->timestamp( '20010115123500' ),
480 'img_media_type' => MEDIATYPE_BITMAP,
481 'img_major_mime' => "image",
482 'img_minor_mime' => "jpeg",
485 # Update certain things in site_stats
486 $db->insert( 'site_stats', array( 'ss_row_id' => 1, 'ss_images' => 1, 'ss_good_articles' => 1 ) );
493 * Create a dummy uploads directory which will contain a couple
494 * of files in order to pass existence tests.
495 * @return string The directory
498 function setupUploadDir() {
501 $dir = wfTempDir() . "/mwParser-" . mt_rand() . "-images";
503 mkdir( $dir . '/3' );
504 mkdir( $dir . '/3/3a' );
506 $img = "$IP/skins/monobook/headbg.jpg";
507 $h = fopen($img, 'r');
508 $c = fread($h, filesize($img));
511 $f = fopen( $dir . '/3/3a/Foobar.jpg', 'wb' );
518 * Restore default values and perform any necessary clean-up
519 * after each test runs.
523 function teardownGlobals() {
524 foreach( $this->savedGlobals as $var => $val ) {
525 $GLOBALS[$var] = $val;
527 if( isset( $this->uploadDir ) ) {
528 $this->teardownUploadDir( $this->uploadDir );
529 unset( $this->uploadDir );
534 * Remove the dummy uploads directory
537 function teardownUploadDir( $dir ) {
538 unlink( "$dir/3/3a/Foobar.jpg" );
539 rmdir( "$dir/3/3a" );
541 @rmdir( "$dir/thumb/6/65" );
542 @rmdir( "$dir/thumb/6" );
544 @unlink( "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg" );
545 @rmdir( "$dir/thumb/3/3a/Foobar.jpg" );
546 @rmdir( "$dir/thumb/3/3a" );
547 @rmdir( "$dir/thumb/3/39" ); # wtf?
548 @rmdir( "$dir/thumb/3" );
549 @rmdir( "$dir/thumb" );
554 * "Running test $desc..."
557 function showTesting( $desc ) {
558 print "Running test $desc... ";
562 * Print a happy success message.
564 * @param string $desc The test name
568 function showSuccess( $desc ) {
569 if( !$this->quiet ) {
570 print $this->termColor( '1;32' ) . 'PASSED' . $this->termReset() . "\n";
576 * Print a failure message and provide some explanatory output
577 * about what went wrong if so configured.
579 * @param string $desc The test name
580 * @param string $result Expected HTML output
581 * @param string $html Actual HTML output
585 function showFailure( $desc, $result, $html ) {
587 # In quiet mode we didn't show the 'Testing' message before the
588 # test, in case it succeeded. Show it now:
589 $this->showTesting( $desc );
591 print $this->termColor( '1;31' ) . 'FAILED!' . $this->termReset() . "\n";
592 if( $this->showDiffs ) {
593 print $this->quickDiff( $result, $html );
594 if( !$this->wellFormed( $html ) ) {
595 print "XML error: $this->mXmlError\n";
602 * Run given strings through a diff and return the (colorized) output.
603 * Requires writable /tmp directory and a 'diff' command in the PATH.
605 * @param string $input
606 * @param string $output
607 * @param string $inFileTail Tailing for the input file name
608 * @param string $outFileTail Tailing for the output file name
612 function quickDiff( $input, $output, $inFileTail='expected', $outFileTail='actual' ) {
613 $prefix = wfTempDir() . "/mwParser-" . mt_rand();
615 $infile = "$prefix-$inFileTail";
616 $this->dumpToFile( $input, $infile );
618 $outfile = "$prefix-$outFileTail";
619 $this->dumpToFile( $output, $outfile );
621 $diff = `diff -au $infile $outfile`;
625 return $this->colorDiff( $diff );
629 * Write the given string to a file, adding a final newline.
631 * @param string $data
632 * @param string $filename
635 function dumpToFile( $data, $filename ) {
636 $file = fopen( $filename, "wt" );
637 fwrite( $file, $data . "\n" );
642 * Return ANSI terminal escape code for changing text attribs/color,
643 * or empty string if color output is disabled.
645 * @param string $color Semicolon-separated list of attribute/color codes
649 function termColor( $color ) {
650 if($this->lightcolor) {
651 return $this->color ? "\x1b[1;{$color}m" : '';
653 return $this->color ? "\x1b[{$color}m" : '';
658 * Return ANSI terminal escape code for restoring default text attributes,
659 * or empty string if color output is disabled.
664 function termReset() {
665 return $this->color ? "\x1b[0m" : '';
669 * Colorize unified diff output if set for ANSI color output.
670 * Subtractions are colored blue, additions red.
672 * @param string $text
676 function colorDiff( $text ) {
678 array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
679 array( $this->termColor( 34 ) . '$1' . $this->termReset(),
680 $this->termColor( 31 ) . '$1' . $this->termReset() ),
685 * Insert a temporary test article
686 * @param string $name the title, including any prefix
687 * @param string $text the article text
688 * @param int $line the input line number, for reporting errors
691 function addArticle($name, $text, $line) {
692 $this->setupGlobals();
693 $title = Title::newFromText( $name );
694 if ( is_null($title) ) {
695 wfDie( "invalid title at line $line\n" );
698 $aid = $title->getArticleID( GAID_FOR_UPDATE );
700 wfDie( "duplicate article at line $line\n" );
703 $art = new Article($title);
704 $art->insertNewArticle($text, '', false, false );
705 $this->teardownGlobals();
709 * Steal a callback function from the primary parser, save it for
710 * application to our scary parser. If the hook is not installed,
711 * die a painful dead to warn the others.
712 * @param string $name
714 private function requireHook( $name ) {
716 if( isset( $wgParser->mTagHooks[$name] ) ) {
717 $this->hooks[$name] = $wgParser->mTagHooks[$name];
719 wfDie( "This test suite requires the '$name' hook extension.\n" );
724 * Run the "tidy" command on text if the $wgUseTidy
727 * @param string $text the text to tidy
732 function tidy( $text ) {
735 $text = Parser::tidy($text);
740 function wellFormed( $text ) {
742 Sanitizer::hackDocType() .
747 $parser = xml_parser_create( "UTF-8" );
749 # case folding violates XML standard, turn it off
750 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
752 if( !xml_parse( $parser, $html, true ) ) {
753 $err = xml_error_string( xml_get_error_code( $parser ) );
754 $position = xml_get_current_byte_index( $parser );
755 $fragment = $this->extractFragment( $html, $position );
756 $this->mXmlError = "$err at byte $position:\n$fragment";
757 xml_parser_free( $parser );
760 xml_parser_free( $parser );
764 function extractFragment( $text, $position ) {
765 $start = max( 0, $position - 10 );
766 $before = $position - $start;
768 $this->termColor( 34 ) .
769 substr( $text, $start, $before ) .
770 $this->termColor( 0 ) .
771 $this->termColor( 31 ) .
772 $this->termColor( 1 ) .
773 substr( $text, $position, 1 ) .
774 $this->termColor( 0 ) .
775 $this->termColor( 34 ) .
776 substr( $text, $position + 1, 9 ) .
777 $this->termColor( 0 ) .
779 $display = str_replace( "\n", ' ', $fragment );
781 str_repeat( ' ', $before ) .
782 $this->termColor( 31 ) .
784 $this->termColor( 0 );
785 return "$display\n$caret";