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 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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" );
40 * @subpackage Maintenance
44 * boolean $color whereas output should be colorized
50 * boolean $lightcolor whereas output should use light colors
56 * Sets terminal colorization and diff/quick modes depending on OS and
57 * command-line options (--color and --quick).
61 function ParserTest() {
64 # Only colorize output if stdout is a terminal.
65 $this->lightcolor = false;
66 $this->color = !wfIsWindows() && posix_isatty(1);
68 if( isset( $options['color'] ) ) {
69 switch( $options['color'] ) {
74 $this->lightcolor = true;
83 $this->showDiffs = !isset( $options['quick'] );
85 $this->quiet = isset( $options['quiet'] );
87 if (isset($options['regex'])) {
88 $this->regex = $options['regex'];
96 * Remove last character if it is a newline
100 if (substr($s, -1) === "\n") {
101 return substr($s, 0, -1);
109 * Run a series of tests listed in the given text file.
110 * Each test consists of a brief description, wikitext input,
111 * and the expected HTML output.
113 * Prints status updates on stdout and counts up the total
114 * number and percentage of passed tests.
116 * @param string $filename
117 * @return bool True if passed all tests, false if any tests failed.
120 function runTestsFromFile( $filename ) {
121 $infile = fopen( $filename, 'rt' );
123 die( "Couldn't open parserTests.txt\n" );
131 while( false !== ($line = fgets( $infile ) ) ) {
133 if( preg_match( '/^!!\s*(\w+)/', $line, $matches ) ) {
134 $section = strtolower( $matches[1] );
135 if( $section == 'endarticle') {
136 if( !isset( $data['text'] ) ) {
137 die( "'endarticle' without 'text' at line $n\n" );
139 if( !isset( $data['article'] ) ) {
140 die( "'endarticle' without 'article' at line $n\n" );
142 $this->addArticle($this->chomp($data['article']), $this->chomp($data['text']), $n);
147 if( $section == 'end' ) {
148 if( !isset( $data['test'] ) ) {
149 die( "'end' without 'test' at line $n\n" );
151 if( !isset( $data['input'] ) ) {
152 die( "'end' without 'input' at line $n\n" );
154 if( !isset( $data['result'] ) ) {
155 die( "'end' without 'result' at line $n\n" );
157 if( !isset( $data['options'] ) ) {
158 $data['options'] = '';
161 $data['options'] = $this->chomp( $data['options'] );
163 if (preg_match('/\\bdisabled\\b/i', $data['options'])
164 || !preg_match("/{$this->regex}/i", $data['test'])) {
171 $this->chomp( $data['test'] ),
172 $this->chomp( $data['input'] ),
173 $this->chomp( $data['result'] ),
174 $this->chomp( $data['options'] ) ) ) {
182 if ( isset ($data[$section] ) ) {
183 die ( "duplicate section '$section' at line $n\n" );
185 $data[$section] = '';
189 $data[$section] .= $line;
193 $ratio = wfPercent( 100 * $success / $total );
194 print $this->termColor( 1 ) . "\nPassed $success of $total tests ($ratio) ";
195 if( $success == $total ) {
196 print $this->termColor( 32 ) . "PASSED!";
198 print $this->termColor( 31 ) . "FAILED!";
200 print $this->termReset() . "\n";
201 return ($success == $total);
203 die( "No tests found.\n" );
208 * Run a given wikitext input through a freshly-constructed wiki parser,
209 * and compare the output against the expected results.
210 * Prints status and explanatory messages to stdout.
212 * @param string $input Wikitext to try rendering
213 * @param string $result Result to output
216 function runTest( $desc, $input, $result, $opts ) {
217 if( !$this->quiet ) {
218 $this->showTesting( $desc );
221 $this->setupGlobals($opts);
224 $options = ParserOptions::newFromUser( $user );
226 if (preg_match('/\\bmath\\b/i', $opts)) {
227 # XXX this should probably be done by the ParserOptions
228 require_once('Math.php');
230 $options->setUseTex(true);
233 if (preg_match('/title=\[\[(.*)\]\]/', $opts, $m)) {
237 $titleText = 'Parser test';
240 $noxml = (bool)preg_match( '~\\b noxml \\b~x', $opts );
242 $parser =& new Parser();
243 wfRunHooks( 'ParserTestParser', array( &$parser ) );
244 $title =& Title::makeTitle( NS_MAIN, $titleText );
246 if (preg_match('/\\bpst\\b/i', $opts)) {
247 $out = $parser->preSaveTransform( $input, $title, $user, $options );
248 } elseif (preg_match('/\\bmsg\\b/i', $opts)) {
249 $out = $parser->transformMsg( $input, $options );
251 $output = $parser->parse( $input, $title, $options );
252 $out = $output->getText();
254 if (preg_match('/\\bill\\b/i', $opts)) {
255 $out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
256 } else if (preg_match('/\\bcat\\b/i', $opts)) {
257 $out = $this->tidy ( implode( ' ', $output->getCategoryLinks() ) );
260 $result = $this->tidy($result);
263 $this->teardownGlobals();
265 if( $result === $out && ( $noxml === true || $this->wellFormed( $out ) ) ) {
266 return $this->showSuccess( $desc );
268 return $this->showFailure( $desc, $result, $out );
273 * Set up the global variables for a consistent environment for each test.
274 * Ideally this should replace the global configuration entirely.
278 function setupGlobals($opts = '') {
279 # Save the prefixed / quoted table names for later use when we make the temporaries.
280 $db =& wfGetDB( DB_READ );
281 $this->oldTableNames = array();
282 foreach( $this->listTables() as $table ) {
283 $this->oldTableNames[$table] = $db->tableName( $table );
285 if( !isset( $this->uploadDir ) ) {
286 $this->uploadDir = $this->setupUploadDir();
290 'wgServer' => 'http://localhost',
291 'wgScript' => '/index.php',
292 'wgScriptPath' => '/',
293 'wgArticlePath' => '/wiki/$1',
294 'wgUploadPath' => 'http://example.com/images',
295 'wgUploadDirectory' => $this->uploadDir,
296 'wgStyleSheetPath' => '/skins',
297 'wgSitename' => 'MediaWiki',
298 'wgLanguageCode' => 'en',
299 'wgContLanguageCode' => 'en',
300 'wgDBprefix' => 'parsertest',
301 'wgDefaultUserOptions' => array(),
303 'wgLang' => new LanguageUtf8(),
304 'wgContLang' => new LanguageUtf8(),
305 'wgNamespacesWithSubpages' => array( 0 => preg_match('/\\bsubpage\\b/i', $opts)),
306 'wgMaxTocLevel' => 999,
307 'wgCapitalLinks' => true,
308 'wgDefaultUserOptions' => array(),
309 'wgNoFollowLinks' => true,
310 'wgThumbnailScriptPath' => false,
313 $this->savedGlobals = array();
314 foreach( $settings as $var => $val ) {
315 $this->savedGlobals[$var] = $GLOBALS[$var];
316 $GLOBALS[$var] = $val;
318 $GLOBALS['wgLoadBalancer']->loadMasterPos();
319 $GLOBALS['wgMessageCache']->initialise( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
320 $this->setupDatabase();
323 $wgUser = new User();
326 # List of temporary tables to create, without prefix
327 # Some of these probably aren't necessary
328 function listTables() {
329 return array('user', 'page', 'revision', 'text',
330 'pagelinks', 'imagelinks', 'categorylinks', 'templatelinks',
331 'site_stats', 'hitcounter',
332 'ipblocks', 'image', 'oldimage',
334 'watchlist', 'math', 'searchindex',
335 'interwiki', 'querycache',
341 * Set up a temporary set of wiki tables to work with for the tests.
342 * Currently this will only be done once per run, and any changes to
343 * the db will be visible to later tests in the run.
347 function setupDatabase() {
348 static $setupDB = false;
351 # Make sure we don't mess with the live DB
352 if (!$setupDB && $wgDBprefix === 'parsertest') {
354 $GLOBALS['wgLoadBalancer'] = LoadBalancer::newFromParams( $GLOBALS['wgDBservers'] );
355 $db =& wfGetDB( DB_MASTER );
357 $tables = $this->listTables();
359 if (!(strcmp($db->getServerVersion(), '4.1') < 0 and stristr($db->getSoftwareLink(), 'MySQL'))) {
360 # Database that supports CREATE TABLE ... LIKE
362 if( $wgDBtype == 'PostgreSQL' ) {
363 $def = 'INCLUDING DEFAULTS';
367 foreach ($tables as $tbl) {
368 $newTableName = $db->tableName( $tbl );
369 $tableName = $this->oldTableNames[$tbl];
370 $db->query("CREATE TEMPORARY TABLE $newTableName (LIKE $tableName $def)");
373 # Hack for MySQL versions < 4.1, which don't support
374 # "CREATE TABLE ... LIKE". Note that
375 # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
376 # would not create the indexes we need....
377 foreach ($tables as $tbl) {
378 $res = $db->query("SHOW CREATE TABLE {$this->oldTableNames[$tbl]}");
379 $row = $db->fetchRow($res);
381 $create_tmp = preg_replace('/CREATE TABLE `(.*?)`/', 'CREATE TEMPORARY TABLE `'
382 . $wgDBprefix . $tbl .'`', $create);
383 if ($create === $create_tmp) {
384 # Couldn't do replacement
385 die("could not create temporary table $tbl");
387 $db->query($create_tmp);
392 # Hack: insert a few Wikipedia in-project interwiki prefixes,
393 # for testing inter-language links
394 $db->insert( 'interwiki', array(
395 array( 'iw_prefix' => 'Wikipedia',
396 'iw_url' => 'http://en.wikipedia.org/wiki/$1',
398 array( 'iw_prefix' => 'MeatBall',
399 'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
401 array( 'iw_prefix' => 'zh',
402 'iw_url' => 'http://zh.wikipedia.org/wiki/$1',
404 array( 'iw_prefix' => 'es',
405 'iw_url' => 'http://es.wikipedia.org/wiki/$1',
407 array( 'iw_prefix' => 'fr',
408 'iw_url' => 'http://fr.wikipedia.org/wiki/$1',
410 array( 'iw_prefix' => 'ru',
411 'iw_url' => 'http://ru.wikipedia.org/wiki/$1',
415 # Hack: Insert an image to work with
416 $db->insert( 'image', array(
417 'img_name' => 'Foobar.jpg',
419 'img_description' => 'Some lame file',
421 'img_user_text' => 'WikiSysop',
422 'img_timestamp' => $db->timestamp( '20010115123500' ),
426 'img_media_type' => MEDIATYPE_BITMAP,
427 'img_major_mime' => "image",
428 'img_minor_mime' => "jpeg",
436 * Create a dummy uploads directory which will contain a couple
437 * of files in order to pass existence tests.
438 * @return string The directory
441 function setupUploadDir() {
444 $dir = wfTempDir() . "/mwParser-" . mt_rand() . "-images";
446 mkdir( $dir . '/3' );
447 mkdir( $dir . '/3/3a' );
449 $img = "$IP/skins/monobook/headbg.jpg";
450 $h = fopen($img, 'r');
451 $c = fread($h, filesize($img));
454 $f = fopen( $dir . '/3/3a/Foobar.jpg', 'wb' );
461 * Restore default values and perform any necessary clean-up
462 * after each test runs.
466 function teardownGlobals() {
467 foreach( $this->savedGlobals as $var => $val ) {
468 $GLOBALS[$var] = $val;
470 if( isset( $this->uploadDir ) ) {
471 $this->teardownUploadDir( $this->uploadDir );
472 unset( $this->uploadDir );
477 * Remove the dummy uploads directory
480 function teardownUploadDir( $dir ) {
481 unlink( "$dir/3/3a/Foobar.jpg" );
482 rmdir( "$dir/3/3a" );
485 @unlink( "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg" );
486 @rmdir( "$dir/thumb/3/3a/Foobar.jpg" );
487 @rmdir( "$dir/thumb/3/3a" );
488 @rmdir( "$dir/thumb/3/39" ); # wtf?
489 @rmdir( "$dir/thumb/3" );
490 @rmdir( "$dir/thumb" );
495 * "Running test $desc..."
498 function showTesting( $desc ) {
499 print "Running test $desc... ";
503 * Print a happy success message.
505 * @param string $desc The test name
509 function showSuccess( $desc ) {
510 if( !$this->quiet ) {
511 print $this->termColor( '1;32' ) . 'PASSED' . $this->termReset() . "\n";
517 * Print a failure message and provide some explanatory output
518 * about what went wrong if so configured.
520 * @param string $desc The test name
521 * @param string $result Expected HTML output
522 * @param string $html Actual HTML output
526 function showFailure( $desc, $result, $html ) {
528 # In quiet mode we didn't show the 'Testing' message before the
529 # test, in case it succeeded. Show it now:
530 $this->showTesting( $desc );
532 print $this->termColor( '1;31' ) . 'FAILED!' . $this->termReset() . "\n";
533 if( $this->showDiffs ) {
534 print $this->quickDiff( $result, $html );
536 if( !$this->wellFormed( $html ) ) {
537 print "XML error: $this->mXmlError\n";
543 * Run given strings through a diff and return the (colorized) output.
544 * Requires writable /tmp directory and a 'diff' command in the PATH.
546 * @param string $input
547 * @param string $output
548 * @param string $inFileTail Tailing for the input file name
549 * @param string $outFileTail Tailing for the output file name
553 function quickDiff( $input, $output, $inFileTail='expected', $outFileTail='actual' ) {
554 $prefix = wfTempDir() . "/mwParser-" . mt_rand();
556 $infile = "$prefix-$inFileTail";
557 $this->dumpToFile( $input, $infile );
559 $outfile = "$prefix-$outFileTail";
560 $this->dumpToFile( $output, $outfile );
562 $diff = `diff -au $infile $outfile`;
566 return $this->colorDiff( $diff );
570 * Write the given string to a file, adding a final newline.
572 * @param string $data
573 * @param string $filename
576 function dumpToFile( $data, $filename ) {
577 $file = fopen( $filename, "wt" );
578 fwrite( $file, $data . "\n" );
583 * Return ANSI terminal escape code for changing text attribs/color,
584 * or empty string if color output is disabled.
586 * @param string $color Semicolon-separated list of attribute/color codes
590 function termColor( $color ) {
591 if($this->lightcolor) {
592 return $this->color ? "\x1b[1;{$color}m" : '';
594 return $this->color ? "\x1b[{$color}m" : '';
599 * Return ANSI terminal escape code for restoring default text attributes,
600 * or empty string if color output is disabled.
605 function termReset() {
606 return $this->color ? "\x1b[0m" : '';
610 * Colorize unified diff output if set for ANSI color output.
611 * Subtractions are colored blue, additions red.
613 * @param string $text
617 function colorDiff( $text ) {
619 array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
620 array( $this->termColor( 34 ) . '$1' . $this->termReset(),
621 $this->termColor( 31 ) . '$1' . $this->termReset() ),
626 * Insert a temporary test article
627 * @param string $name the title, including any prefix
628 * @param string $text the article text
629 * @param int $line the input line number, for reporting errors
633 function addArticle($name, $text, $line) {
634 $this->setupGlobals();
635 $title = Title::newFromText( $name );
636 if ( is_null($title) ) {
637 die( "invalid title at line $line\n" );
640 $aid = $title->getArticleID( GAID_FOR_UPDATE );
642 die( "duplicate article at line $line\n" );
645 $art = new Article($title);
646 $art->insertNewArticle($text, '', false, false );
647 $this->teardownGlobals();
651 * Run the "tidy" command on text if the $wgUseTidy
654 * @param string $text the text to tidy
659 function tidy( $text ) {
662 $text = Parser::tidy($text);
668 * Hack up a private DOCTYPE with HTML's standard entity declarations.
669 * PHP 4 seemed to know these if you gave it an HTML doctype, but
674 function hackDocType() {
675 global $wgHtmlEntities;
676 $out = "<!DOCTYPE html [\n";
677 foreach( $wgHtmlEntities as $entity => $codepoint ) {
678 $out .= "<!ENTITY $entity \"&#$codepoint;\">";
684 function wellFormed( $text ) {
686 $this->hackDocType() .
691 $parser = xml_parser_create( "UTF-8" );
693 # case folding violates XML standard, turn it off
694 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
696 if( !xml_parse( $parser, $html, true ) ) {
697 $err = xml_error_string( xml_get_error_code( $parser ) );
698 $position = xml_get_current_byte_index( $parser );
699 $fragment = $this->extractFragment( $html, $position );
700 $this->mXmlError = "$err at byte $position:\n$fragment";
701 xml_parser_free( $parser );
704 xml_parser_free( $parser );
708 function extractFragment( $text, $position ) {
709 $start = max( 0, $position - 10 );
710 $before = $position - $start;
712 $this->termColor( 34 ) .
713 substr( $text, $start, $before ) .
714 $this->termColor( 0 ) .
715 $this->termColor( 31 ) .
716 $this->termColor( 1 ) .
717 substr( $text, $position, 1 ) .
718 $this->termColor( 0 ) .
719 $this->termColor( 34 ) .
720 substr( $text, $position + 1, 9 ) .
721 $this->termColor( 0 ) .
723 $display = str_replace( "\n", ' ', $fragment );
725 str_repeat( ' ', $before ) .
726 $this->termColor( 31 ) .
728 $this->termColor( 0 );
729 return "$display\n$caret";