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 $parser =& new Parser();
241 wfRunHooks( 'ParserTestParser', array( &$parser ) );
242 $title =& Title::makeTitle( NS_MAIN, $titleText );
244 if (preg_match('/\\bpst\\b/i', $opts)) {
245 $out = $parser->preSaveTransform( $input, $title, $user, $options );
246 } elseif (preg_match('/\\bmsg\\b/i', $opts)) {
247 $out = $parser->transformMsg( $input, $options );
249 $output = $parser->parse( $input, $title, $options );
250 $out = $output->getText();
252 if (preg_match('/\\bill\\b/i', $opts)) {
253 $out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
254 } else if (preg_match('/\\bcat\\b/i', $opts)) {
255 $out = $this->tidy ( implode( ' ', $output->getCategoryLinks() ) );
258 $result = $this->tidy($result);
261 $this->teardownGlobals();
263 if( $result === $out && $this->wellFormed( $out ) ) {
264 return $this->showSuccess( $desc );
266 return $this->showFailure( $desc, $result, $out );
271 * Set up the global variables for a consistent environment for each test.
272 * Ideally this should replace the global configuration entirely.
276 function setupGlobals($opts = '') {
277 # Save the prefixed / quoted table names for later use when we make the temporaries.
278 $db =& wfGetDB( DB_READ );
279 $this->oldTableNames = array();
280 foreach( $this->listTables() as $table ) {
281 $this->oldTableNames[$table] = $db->tableName( $table );
283 if( !isset( $this->uploadDir ) ) {
284 $this->uploadDir = $this->setupUploadDir();
288 'wgServer' => 'http://localhost',
289 'wgScript' => '/index.php',
290 'wgScriptPath' => '/',
291 'wgArticlePath' => '/wiki/$1',
292 'wgUploadPath' => 'http://example.com/images',
293 'wgUploadDirectory' => $this->uploadDir,
294 'wgStyleSheetPath' => '/skins',
295 'wgSitename' => 'MediaWiki',
296 'wgLanguageCode' => 'en',
297 'wgContLanguageCode' => 'en',
298 'wgDBprefix' => 'parsertest',
299 'wgDefaultUserOptions' => array(),
301 'wgLang' => new LanguageUtf8(),
302 'wgContLang' => new LanguageUtf8(),
303 'wgNamespacesWithSubpages' => array( 0 => preg_match('/\\bsubpage\\b/i', $opts)),
304 'wgMaxTocLevel' => 999,
305 'wgCapitalLinks' => true,
306 'wgDefaultUserOptions' => array(),
307 'wgNoFollowLinks' => true,
308 'wgThumbnailScriptPath' => false,
311 $this->savedGlobals = array();
312 foreach( $settings as $var => $val ) {
313 $this->savedGlobals[$var] = $GLOBALS[$var];
314 $GLOBALS[$var] = $val;
316 $GLOBALS['wgLoadBalancer']->loadMasterPos();
317 $GLOBALS['wgMessageCache']->initialise( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
318 $this->setupDatabase();
321 $wgUser = new User();
324 # List of temporary tables to create, without prefix
325 # Some of these probably aren't necessary
326 function listTables() {
327 return array('user', 'page', 'revision', 'text',
328 'pagelinks', 'imagelinks', 'categorylinks',
329 'site_stats', 'hitcounter',
330 'ipblocks', 'image', 'oldimage',
332 'watchlist', 'math', 'searchindex',
333 'interwiki', 'querycache',
339 * Set up a temporary set of wiki tables to work with for the tests.
340 * Currently this will only be done once per run, and any changes to
341 * the db will be visible to later tests in the run.
345 function setupDatabase() {
346 static $setupDB = false;
349 # Make sure we don't mess with the live DB
350 if (!$setupDB && $wgDBprefix === 'parsertest') {
352 $GLOBALS['wgLoadBalancer'] = LoadBalancer::newFromParams( $GLOBALS['wgDBservers'] );
353 $db =& wfGetDB( DB_MASTER );
355 $tables = $this->listTables();
357 if (!(strcmp($db->getServerVersion(), '4.1') < 0 and stristr($db->getSoftwareLink(), 'MySQL'))) {
358 # Database that supports CREATE TABLE ... LIKE
360 if( $wgDBtype == 'PostgreSQL' ) {
361 $def = 'INCLUDING DEFAULTS';
365 foreach ($tables as $tbl) {
366 $newTableName = $db->tableName( $tbl );
367 $tableName = $this->oldTableNames[$tbl];
368 $db->query("CREATE TEMPORARY TABLE $newTableName (LIKE $tableName $def)");
371 # Hack for MySQL versions < 4.1, which don't support
372 # "CREATE TABLE ... LIKE". Note that
373 # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
374 # would not create the indexes we need....
375 foreach ($tables as $tbl) {
376 $res = $db->query("SHOW CREATE TABLE {$this->oldTableNames[$tbl]}");
377 $row = $db->fetchRow($res);
379 $create_tmp = preg_replace('/CREATE TABLE `(.*?)`/', 'CREATE TEMPORARY TABLE `'
380 . $wgDBprefix . $tbl .'`', $create);
381 if ($create === $create_tmp) {
382 # Couldn't do replacement
383 die("could not create temporary table $tbl");
385 $db->query($create_tmp);
390 # Hack: insert a few Wikipedia in-project interwiki prefixes,
391 # for testing inter-language links
392 $db->insert( 'interwiki', array(
393 array( 'iw_prefix' => 'Wikipedia',
394 'iw_url' => 'http://en.wikipedia.org/wiki/$1',
396 array( 'iw_prefix' => 'MeatBall',
397 'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
399 array( 'iw_prefix' => 'zh',
400 'iw_url' => 'http://zh.wikipedia.org/wiki/$1',
402 array( 'iw_prefix' => 'es',
403 'iw_url' => 'http://es.wikipedia.org/wiki/$1',
405 array( 'iw_prefix' => 'fr',
406 'iw_url' => 'http://fr.wikipedia.org/wiki/$1',
408 array( 'iw_prefix' => 'ru',
409 'iw_url' => 'http://ru.wikipedia.org/wiki/$1',
413 # Hack: Insert an image to work with
414 $db->insert( 'image', array(
415 'img_name' => 'Foobar.jpg',
417 'img_description' => 'Some lame file',
419 'img_user_text' => 'WikiSysop',
420 'img_timestamp' => $db->timestamp( '20010115123500' ),
424 'img_media_type' => MEDIATYPE_BITMAP,
425 'img_major_mime' => "image",
426 'img_minor_mime' => "jpeg",
434 * Create a dummy uploads directory which will contain a couple
435 * of files in order to pass existence tests.
436 * @return string The directory
439 function setupUploadDir() {
442 $dir = wfTempDir() . "/mwParser-" . mt_rand() . "-images";
444 mkdir( $dir . '/3' );
445 mkdir( $dir . '/3/3a' );
447 $img = "$IP/skins/monobook/headbg.jpg";
448 $h = fopen($img, 'r');
449 $c = fread($h, filesize($img));
452 $f = fopen( $dir . '/3/3a/Foobar.jpg', 'wb' );
459 * Restore default values and perform any necessary clean-up
460 * after each test runs.
464 function teardownGlobals() {
465 foreach( $this->savedGlobals as $var => $val ) {
466 $GLOBALS[$var] = $val;
468 if( isset( $this->uploadDir ) ) {
469 $this->teardownUploadDir( $this->uploadDir );
470 unset( $this->uploadDir );
475 * Remove the dummy uploads directory
478 function teardownUploadDir( $dir ) {
479 unlink( "$dir/3/3a/Foobar.jpg" );
480 rmdir( "$dir/3/3a" );
483 @unlink( "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg" );
484 @rmdir( "$dir/thumb/3/3a/Foobar.jpg" );
485 @rmdir( "$dir/thumb/3/3a" );
486 @rmdir( "$dir/thumb/3/39" ); # wtf?
487 @rmdir( "$dir/thumb/3" );
488 @rmdir( "$dir/thumb" );
493 * "Running test $desc..."
496 function showTesting( $desc ) {
497 print "Running test $desc... ";
501 * Print a happy success message.
503 * @param string $desc The test name
507 function showSuccess( $desc ) {
508 if( !$this->quiet ) {
509 print $this->termColor( '1;32' ) . 'PASSED' . $this->termReset() . "\n";
515 * Print a failure message and provide some explanatory output
516 * about what went wrong if so configured.
518 * @param string $desc The test name
519 * @param string $result Expected HTML output
520 * @param string $html Actual HTML output
524 function showFailure( $desc, $result, $html ) {
526 # In quiet mode we didn't show the 'Testing' message before the
527 # test, in case it succeeded. Show it now:
528 $this->showTesting( $desc );
530 print $this->termColor( '1;31' ) . 'FAILED!' . $this->termReset() . "\n";
531 if( $this->showDiffs ) {
532 print $this->quickDiff( $result, $html );
534 if( !$this->wellFormed( $html ) ) {
535 print "XML error: $this->mXmlError\n";
541 * Run given strings through a diff and return the (colorized) output.
542 * Requires writable /tmp directory and a 'diff' command in the PATH.
544 * @param string $input
545 * @param string $output
546 * @param string $inFileTail Tailing for the input file name
547 * @param string $outFileTail Tailing for the output file name
551 function quickDiff( $input, $output, $inFileTail='expected', $outFileTail='actual' ) {
552 $prefix = wfTempDir() . "/mwParser-" . mt_rand();
554 $infile = "$prefix-$inFileTail";
555 $this->dumpToFile( $input, $infile );
557 $outfile = "$prefix-$outFileTail";
558 $this->dumpToFile( $output, $outfile );
560 $diff = `diff -au $infile $outfile`;
564 return $this->colorDiff( $diff );
568 * Write the given string to a file, adding a final newline.
570 * @param string $data
571 * @param string $filename
574 function dumpToFile( $data, $filename ) {
575 $file = fopen( $filename, "wt" );
576 fwrite( $file, $data . "\n" );
581 * Return ANSI terminal escape code for changing text attribs/color,
582 * or empty string if color output is disabled.
584 * @param string $color Semicolon-separated list of attribute/color codes
588 function termColor( $color ) {
589 if($this->lightcolor) {
590 return $this->color ? "\x1b[1;{$color}m" : '';
592 return $this->color ? "\x1b[{$color}m" : '';
597 * Return ANSI terminal escape code for restoring default text attributes,
598 * or empty string if color output is disabled.
603 function termReset() {
604 return $this->color ? "\x1b[0m" : '';
608 * Colorize unified diff output if set for ANSI color output.
609 * Subtractions are colored blue, additions red.
611 * @param string $text
615 function colorDiff( $text ) {
617 array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
618 array( $this->termColor( 34 ) . '$1' . $this->termReset(),
619 $this->termColor( 31 ) . '$1' . $this->termReset() ),
624 * Insert a temporary test article
625 * @param string $name the title, including any prefix
626 * @param string $text the article text
627 * @param int $line the input line number, for reporting errors
631 function addArticle($name, $text, $line) {
632 $this->setupGlobals();
633 $title = Title::newFromText( $name );
634 if ( is_null($title) ) {
635 die( "invalid title at line $line\n" );
638 $aid = $title->getArticleID( GAID_FOR_UPDATE );
640 die( "duplicate article at line $line\n" );
643 $art = new Article($title);
644 $art->insertNewArticle($text, '', false, false );
645 $this->teardownGlobals();
649 * Run the "tidy" command on text if the $wgUseTidy
652 * @param string $text the text to tidy
657 function tidy( $text ) {
660 $text = Parser::tidy($text);
665 function wellFormed( $text ) {
667 '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" ' .
668 '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">' .
673 $parser = xml_parser_create( "UTF-8" );
675 # case folding violates XML standard, turn it off
676 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
678 if( !xml_parse( $parser, $html, true ) ) {
679 $err = xml_error_string( xml_get_error_code( $parser ) );
680 $position = xml_get_current_byte_index( $parser );
681 $fragment = $this->extractFragment( $html, $position );
682 $this->mXmlError = "$err at byte $position:\n$fragment";
683 xml_parser_free( $parser );
686 xml_parser_free( $parser );
690 function extractFragment( $text, $position ) {
691 $start = max( 0, $position - 10 );
692 $before = $position - $start;
694 $this->termColor( 34 ) .
695 substr( $text, $start, $before ) .
696 $this->termColor( 0 ) .
697 $this->termColor( 31 ) .
698 $this->termColor( 1 ) .
699 substr( $text, $position, 1 ) .
700 $this->termColor( 0 ) .
701 $this->termColor( 34 ) .
702 substr( $text, $position + 1, 9 ) .
703 $this->termColor( 0 ) .
705 $display = str_replace( "\n", ' ', $fragment );
707 str_repeat( ' ', $before ) .
708 $this->termColor( 31 ) .
710 $this->termColor( 0 );
711 return "$display\n$caret";