*/
/** */
-require_once( 'commandLine.inc' );
-include_once( 'InitialiseMessages.inc' );
+$options = array( 'quick', 'color', 'quiet', 'help' );
+$optionsWithArgs = array( 'regex' );
-$wgTitle = Title::newFromText( 'Parser test script' );
+require_once( 'commandLine.inc' );
+require_once( "$IP/includes/ObjectCache.php" );
+require_once( "$IP/languages/LanguageUtf8.php" );
+/**
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
class ParserTest {
+ /**
+ * boolean $color whereas output should be colorized
+ * @access private
+ */
+ var $color;
+
+ /**
+ * boolean $lightcolor whereas output should use light colors
+ * @access private
+ */
+ var $lightcolor;
+
+ /**
+ * Sets terminal colorization and diff/quick modes depending on OS and
+ * command-line options (--color and --quick).
+ *
+ * @access public
+ */
function ParserTest() {
- if( isset( $_SERVER['argv'] ) && in_array( '--color', $_SERVER['argv'] ) ) {
- $this->color = true;
- } elseif( isset( $_SERVER['argv'] ) && in_array( '--color=yes', $_SERVER['argv'] ) ) {
- $this->color = true;
- } elseif( isset( $_SERVER['argv'] ) && in_array( '--color=no', $_SERVER['argv'] ) ) {
- $this->color = false;
- } elseif( wfIsWindows() ) {
- $this->color = false;
- } else {
- $this->color = true;
+ global $options;
+
+ # Only colorize output if stdout is a terminal.
+ $this->lightcolor = false;
+ $this->color = !wfIsWindows() && posix_isatty(1);
+
+ if( isset( $options['color'] ) ) {
+ switch( $options['color'] ) {
+ case 'no':
+ $this->color = false;
+ break;
+ case 'light':
+ $this->lightcolor = true;
+ # Fall through
+ case 'yes':
+ default:
+ $this->color = true;
+ break;
+ }
}
- if( isset( $_SERVER['argv'] ) && in_array( '--quick', $_SERVER['argv'] ) ) {
- $this->showDiffs = false;
+ $this->showDiffs = !isset( $options['quick'] );
+
+ $this->quiet = isset( $options['quiet'] );
+
+ if (isset($options['regex'])) {
+ $this->regex = $options['regex'];
} else {
- $this->showDiffs = true;
+ # Matches anything
+ $this->regex = '';
+ }
+ }
+
+ /**
+ * Remove last character if it is a newline
+ * @access private
+ */
+ function chomp($s) {
+ if (substr($s, -1) === "\n") {
+ return substr($s, 0, -1);
+ }
+ else {
+ return $s;
}
}
+ /**
+ * Run a series of tests listed in the given text file.
+ * Each test consists of a brief description, wikitext input,
+ * and the expected HTML output.
+ *
+ * Prints status updates on stdout and counts up the total
+ * number and percentage of passed tests.
+ *
+ * @param string $filename
+ * @return bool True if passed all tests, false if any tests failed.
+ * @access public
+ */
function runTestsFromFile( $filename ) {
$infile = fopen( $filename, 'rt' );
if( !$infile ) {
$n++;
if( preg_match( '/^!!\s*(\w+)/', $line, $matches ) ) {
$section = strtolower( $matches[1] );
- if( $section == 'end' ) {
- if (isset ($data['disabled'])) {
- # disabled test
- $data = array();
- $section = null;
- continue;
+ if( $section == 'endarticle') {
+ if( !isset( $data['text'] ) ) {
+ die( "'endarticle' without 'text' at line $n\n" );
}
+ if( !isset( $data['article'] ) ) {
+ die( "'endarticle' without 'article' at line $n\n" );
+ }
+ $this->addArticle($this->chomp($data['article']), $this->chomp($data['text']), $n);
+ $data = array();
+ $section = null;
+ continue;
+ }
+ if( $section == 'end' ) {
if( !isset( $data['test'] ) ) {
die( "'end' without 'test' at line $n\n" );
}
if( !isset( $data['result'] ) ) {
die( "'end' without 'result' at line $n\n" );
}
+ if( !isset( $data['options'] ) ) {
+ $data['options'] = '';
+ }
+ else {
+ $data['options'] = $this->chomp( $data['options'] );
+ }
+ if (preg_match('/\\bdisabled\\b/i', $data['options'])
+ || !preg_match("/{$this->regex}/i", $data['test'])) {
+ # disabled test
+ $data = array();
+ $section = null;
+ continue;
+ }
if( $this->runTest(
- rtrim( $data['test'] ),
- rtrim( $data['input'] ),
- rtrim( $data['result'] ) ) ) {
+ $this->chomp( $data['test'] ),
+ $this->chomp( $data['input'] ),
+ $this->chomp( $data['result'] ),
+ $this->chomp( $data['options'] ) ) ) {
$success++;
}
$total++;
$section = null;
continue;
}
+ if ( isset ($data[$section] ) ) {
+ die ( "duplicate section '$section' at line $n\n" );
+ }
$data[$section] = '';
continue;
}
}
}
if( $total > 0 ) {
- $ratio = IntVal( 100.0 * $success / $total );
- print "\nPassed $success of $total tests ($ratio%)\n";
+ $ratio = sprintf( "%.2f", 100 * $success / $total );
+ print $this->termColor( 1 ) . "\nPassed $success of $total tests ($ratio%) ";
+ if( $success == $total ) {
+ print $this->termColor( 32 ) . "PASSED!";
+ } else {
+ print $this->termColor( 31 ) . "FAILED!";
+ }
+ print $this->termReset() . "\n";
return ($success == $total);
} else {
die( "No tests found.\n" );
}
/**
+ * Run a given wikitext input through a freshly-constructed wiki parser,
+ * and compare the output against the expected results.
+ * Prints status and explanatory messages to stdout.
+ *
* @param string $input Wikitext to try rendering
* @param string $result Result to output
* @return bool
*/
- function runTest( $desc, $input, $result ) {
- print "Running test $desc... ";
+ function runTest( $desc, $input, $result, $opts ) {
+ if( !$this->quiet ) {
+ $this->showTesting( $desc );
+ }
+
+ $this->setupGlobals($opts);
- $this->setupGlobals();
-
$user =& new User();
$options =& ParserOptions::newFromUser( $user );
+
+ if (preg_match('/\\bmath\\b/i', $opts)) {
+ # XXX this should probably be done by the ParserOptions
+ require_once('Math.php');
+
+ $options->setUseTex(true);
+ }
+
+ if (preg_match('/title=\[\[(.*)\]\]/', $opts, $m)) {
+ $titleText = $m[1];
+ }
+ else {
+ $titleText = 'Parser test';
+ }
+
$parser =& new Parser();
- $title =& Title::makeTitle( NS_MAIN, 'Parser_test' );
+ $title =& Title::makeTitle( NS_MAIN, $titleText );
- $output =& $parser->parse( $input, $title, $options );
-
- $html = $output->getText();
- # $languageLinks = $output->getLanguageLinks();
- # $categoryLinks = $output->getCategoryLinks();
+ if (preg_match('/\\bpst\\b/i', $opts)) {
+ $out = $parser->preSaveTransform( $input, $title, $user, $options );
+ } elseif (preg_match('/\\bmsg\\b/i', $opts)) {
+ $out = $parser->transformMsg( $input, $options );
+ } else {
+ $output =& $parser->parse( $input, $title, $options );
+ $out = $output->getText();
- $op = new OutputPage();
- $op->replaceLinkHolders($html);
+ if (preg_match('/\\bill\\b/i', $opts)) {
+ $out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
+ } else if (preg_match('/\\bcat\\b/i', $opts)) {
+ $out = $this->tidy ( implode( ' ', $output->getCategoryLinks() ) );
+ }
- global $wgUseTidy;
- if ($wgUseTidy) {
- # Using Parser here is probably theoretically
- # wrong, because we shouldn't use Parser to
- # validate itself, but this should be safe
- # in practice.
- $result = Parser::tidy($result);
+ $result = $this->tidy($result);
}
$this->teardownGlobals();
- if( rtrim($result) === rtrim($html) ) {
+ if( $result === $out && $this->wellFormed( $out ) ) {
return $this->showSuccess( $desc );
} else {
- return $this->showFailure( $desc, $result, $html );
+ return $this->showFailure( $desc, $result, $out );
}
}
- function setupGlobals() {
- static $settings = array(
+ /**
+ * Set up the global variables for a consistent environment for each test.
+ * Ideally this should replace the global configuration entirely.
+ *
+ * @access private
+ */
+ function setupGlobals($opts = '') {
+ # Save the prefixed / quoted table names for later use when we make the temporaries.
+ $db =& wfGetDB( DB_READ );
+ $this->oldTableNames = array();
+ foreach( $this->listTables() as $table ) {
+ $this->oldTableNames[$table] = $db->tableName( $table );
+ }
+ if( !isset( $this->uploadDir ) ) {
+ $this->uploadDir = $this->setupUploadDir();
+ }
+
+ $settings = array(
'wgServer' => 'http://localhost',
'wgScript' => '/index.php',
'wgScriptPath' => '/',
'wgArticlePath' => '/wiki/$1',
+ 'wgUploadPath' => '/images',
+ 'wgUploadDirectory' => $this->uploadDir,
+ 'wgStyleSheetPath' => '/skins',
+ 'wgSitename' => 'MediaWiki',
+ 'wgLanguageCode' => 'en',
+ 'wgContLanguageCode' => 'en',
+ 'wgDBprefix' => 'parsertest',
+ 'wgDefaultUserOptions' => array(),
+
+ 'wgLoadBalancer' => LoadBalancer::newFromParams( $GLOBALS['wgDBservers'] ),
+ 'wgLang' => new LanguageUtf8(),
+ 'wgContLang' => new LanguageUtf8(),
+ 'wgNamespacesWithSubpages' => array( 0 => preg_match('/\\bsubpage\\b/i', $opts)),
+ 'wgMaxTocLevel' => 999,
+ 'wgCapitalLinks' => true,
+ 'wgDefaultUserOptions' => array(),
+ 'wgNoFollowLinks' => true,
+ 'wgThumbnailScriptPath' => false,
);
$this->savedGlobals = array();
foreach( $settings as $var => $val ) {
$this->savedGlobals[$var] = $GLOBALS[$var];
$GLOBALS[$var] = $val;
}
+ $GLOBALS['wgLoadBalancer']->loadMasterPos();
+ $GLOBALS['wgMessageCache']->initialise( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
+ $this->setupDatabase();
+
+ global $wgUser;
+ $wgUser = new User();
+ }
+
+ # List of temporary tables to create, without prefix
+ # Some of these probably aren't necessary
+ function listTables() {
+ return array('user', 'page', 'revision', 'text', 'links',
+ 'brokenlinks', 'imagelinks', 'categorylinks',
+ 'linkscc', 'site_stats', 'hitcounter',
+ 'ipblocks', 'image', 'oldimage',
+ 'recentchanges',
+ 'watchlist', 'math', 'searchindex',
+ 'interwiki', 'querycache',
+ 'objectcache', 'group'
+ );
+ }
+
+ /**
+ * Set up a temporary set of wiki tables to work with for the tests.
+ * Currently this will only be done once per run, and any changes to
+ * the db will be visible to later tests in the run.
+ *
+ * @access private
+ */
+ function setupDatabase() {
+ static $setupDB = false;
+ global $wgDBprefix;
+
+ # Make sure we don't mess with the live DB
+ if (!$setupDB && $wgDBprefix === 'parsertest') {
+ $db =& wfGetDB( DB_MASTER );
+
+ $tables = $this->listTables();
+
+ if (!(strcmp($db->getServerVersion(), '4.1') < 0 and stristr($db->getSoftwareLink(), 'MySQL'))) {
+ # Database that supports CREATE TABLE ... LIKE
+ global $wgDBtype;
+ if( $wgDBtype == 'PostgreSQL' ) {
+ $def = 'INCLUDING DEFAULTS';
+ } else {
+ $def = '';
+ }
+ foreach ($tables as $tbl) {
+ $newTableName = $db->tableName( $tbl );
+ $tableName = $this->oldTableNames[$tbl];
+ $db->query("CREATE TEMPORARY TABLE $newTableName (LIKE $tableName $def)");
+ }
+ } else {
+ # Hack for MySQL versions < 4.1, which don't support
+ # "CREATE TABLE ... LIKE". Note that
+ # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
+ # would not create the indexes we need....
+ foreach ($tables as $tbl) {
+ $res = $db->query("SHOW CREATE TABLE {$this->oldTableNames[$tbl]}");
+ $row = $db->fetchRow($res);
+ $create = $row[1];
+ $create_tmp = preg_replace('/CREATE TABLE `(.*?)`/', 'CREATE TEMPORARY TABLE `'
+ . $wgDBprefix . $tbl .'`', $create);
+ if ($create === $create_tmp) {
+ # Couldn't do replacement
+ die("could not create temporary table $tbl");
+ }
+ $db->query($create_tmp);
+ }
+
+ }
+
+ # Hack: insert a few Wikipedia in-project interwiki prefixes,
+ # for testing inter-language links
+ $db->insert( 'interwiki', array(
+ array( 'iw_prefix' => 'Wikipedia',
+ 'iw_url' => 'http://en.wikipedia.org/wiki/$1',
+ 'iw_local' => 0 ),
+ array( 'iw_prefix' => 'MeatBall',
+ 'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
+ 'iw_local' => 0 ),
+ array( 'iw_prefix' => 'zh',
+ 'iw_url' => 'http://zh.wikipedia.org/wiki/$1',
+ 'iw_local' => 1 ),
+ array( 'iw_prefix' => 'es',
+ 'iw_url' => 'http://es.wikipedia.org/wiki/$1',
+ 'iw_local' => 1 ),
+ array( 'iw_prefix' => 'fr',
+ 'iw_url' => 'http://fr.wikipedia.org/wiki/$1',
+ 'iw_local' => 1 ),
+ array( 'iw_prefix' => 'ru',
+ 'iw_url' => 'http://ru.wikipedia.org/wiki/$1',
+ 'iw_local' => 1 ),
+ ) );
+
+ # Hack: initialize a group
+ $db->insert( 'group', array(
+ 'group_id' => 1,
+ 'group_name' => 'Anonymous',
+ 'group_description' => 'Anonymous users',
+ 'group_rights' => 'read' ) );
+
+ # Hack: Insert an image to work with
+ $db->insert( 'image', array(
+ 'img_name' => 'Foobar.jpg',
+ 'img_size' => 12345,
+ 'img_description' => 'Some lame file',
+ 'img_user' => 1,
+ 'img_user_text' => 'WikiSysop',
+ 'img_timestamp' => $db->timestamp( '20010115123500' ),
+ 'img_width' => 1941,
+ 'img_height' => 220,
+ 'img_bits' => 24,
+ 'img_type' => 2, // 2 == JPEG
+ ) );
+
+ $setupDB = true;
+ }
+ }
+
+ /**
+ * Create a dummy uploads directory which will contain a couple
+ * of files in order to pass existence tests.
+ * @return string The directory
+ * @access private
+ */
+ function setupUploadDir() {
+ global $IP;
+
+ $dir = "/tmp/mwParser-" . mt_rand() . "-images";
+ mkdir( $dir );
+ mkdir( $dir . '/3' );
+ mkdir( $dir . '/3/3a' );
+
+ $img = "$IP/skins/monobook/headbg.jpg";
+ $h = fopen($img, 'r');
+ $c = fread($h, filesize($img));
+ fclose($h);
+
+ $f = fopen( $dir . '/3/3a/Foobar.jpg', 'wb' );
+ fwrite( $f, $c );
+ fclose( $f );
+ return $dir;
}
+ /**
+ * Restore default values and perform any necessary clean-up
+ * after each test runs.
+ *
+ * @access private
+ */
function teardownGlobals() {
foreach( $this->savedGlobals as $var => $val ) {
$GLOBALS[$var] = $val;
}
+ if( isset( $this->uploadDir ) ) {
+ $this->teardownUploadDir( $this->uploadDir );
+ unset( $this->uploadDir );
+ }
+ }
+
+ /**
+ * Remove the dummy uploads directory
+ * @access private
+ */
+ function teardownUploadDir( $dir ) {
+ unlink( "$dir/3/3a/Foobar.jpg" );
+ rmdir( "$dir/3/3a" );
+ rmdir( "$dir/3" );
+
+ @unlink( "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg" );
+ @rmdir( "$dir/thumb/3/3a/Foobar.jpg" );
+ @rmdir( "$dir/thumb/3/3a" );
+ @rmdir( "$dir/thumb/3/39" ); # wtf?
+ @rmdir( "$dir/thumb/3" );
+ @rmdir( "$dir/thumb" );
+ rmdir( "$dir" );
+ }
+
+ /**
+ * "Running test $desc..."
+ * @access private
+ */
+ function showTesting( $desc ) {
+ print "Running test $desc... ";
}
+ /**
+ * Print a happy success message.
+ *
+ * @param string $desc The test name
+ * @return bool
+ * @access private
+ */
function showSuccess( $desc ) {
- print $this->termColor( '1;32' ) . 'PASSED' . $this->termReset() . "\n";
+ if( !$this->quiet ) {
+ print $this->termColor( '1;32' ) . 'PASSED' . $this->termReset() . "\n";
+ }
return true;
}
+ /**
+ * Print a failure message and provide some explanatory output
+ * about what went wrong if so configured.
+ *
+ * @param string $desc The test name
+ * @param string $result Expected HTML output
+ * @param string $html Actual HTML output
+ * @return bool
+ * @access private
+ */
function showFailure( $desc, $result, $html ) {
+ if( $this->quiet ) {
+ # In quiet mode we didn't show the 'Testing' message before the
+ # test, in case it succeeded. Show it now:
+ $this->showTesting( $desc );
+ }
print $this->termColor( '1;31' ) . 'FAILED!' . $this->termReset() . "\n";
if( $this->showDiffs ) {
print $this->quickDiff( $result, $html );
}
+ if( !$this->wellFormed( $html ) ) {
+ print "XML error: $this->mXmlError\n";
+ }
return false;
}
+ /**
+ * Run given strings through a diff and return the (colorized) output.
+ * Requires writable /tmp directory and a 'diff' command in the PATH.
+ *
+ * @param string $input
+ * @param string $output
+ * @return string
+ * @access private
+ */
function quickDiff( $input, $output ) {
$prefix = "/tmp/mwParser-" . mt_rand();
- $infile = "$prefix-in";
+ $infile = "$prefix-expected";
$this->dumpToFile( $input, $infile );
- $outfile = "$prefix-out";
+ $outfile = "$prefix-actual";
$this->dumpToFile( $output, $outfile );
- $diff = `diff -u $infile $outfile`;
+ $diff = `diff -au $infile $outfile`;
unlink( $infile );
unlink( $outfile );
return $this->colorDiff( $diff );
}
+ /**
+ * Write the given string to a file, adding a final newline.
+ *
+ * @param string $data
+ * @param string $filename
+ * @access private
+ */
function dumpToFile( $data, $filename ) {
$file = fopen( $filename, "wt" );
- fwrite( $file, rtrim( $data ) . "\n" );
+ fwrite( $file, $data . "\n" );
fclose( $file );
}
+ /**
+ * Return ANSI terminal escape code for changing text attribs/color,
+ * or empty string if color output is disabled.
+ *
+ * @param string $color Semicolon-separated list of attribute/color codes
+ * @return string
+ * @access private
+ */
function termColor( $color ) {
- return $this->color ? "\x1b[{$color}m" : '';
+ if($this->lightcolor) {
+ return $this->color ? "\x1b[1;{$color}m" : '';
+ } else {
+ return $this->color ? "\x1b[{$color}m" : '';
+ }
}
+ /**
+ * Return ANSI terminal escape code for restoring default text attributes,
+ * or empty string if color output is disabled.
+ *
+ * @return string
+ * @access private
+ */
function termReset() {
return $this->color ? "\x1b[0m" : '';
}
+ /**
+ * Colorize unified diff output if set for ANSI color output.
+ * Subtractions are colored blue, additions red.
+ *
+ * @param string $text
+ * @return string
+ * @access private
+ */
function colorDiff( $text ) {
return preg_replace(
array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
$this->termColor( 31 ) . '$1' . $this->termReset() ),
$text );
}
+
+ /**
+ * Insert a temporary test article
+ * @param string $name the title, including any prefix
+ * @param string $text the article text
+ * @param int $line the input line number, for reporting errors
+ * @static
+ * @access private
+ */
+ function addArticle($name, $text, $line) {
+ $this->setupGlobals();
+ $title = Title::newFromText( $name );
+ if ( is_null($title) ) {
+ die( "invalid title at line $line\n" );
+ }
+
+ $aid = $title->getArticleID( GAID_FOR_UPDATE );
+ if ($aid != 0) {
+ die( "duplicate article at line $line\n" );
+ }
+
+ $art = new Article($title);
+ $art->insertNewArticle($text, '', false, false );
+ $this->teardownGlobals();
+ }
+
+ /*
+ * Run the "tidy" command on text if the $wgUseTidy
+ * global is true
+ *
+ * @param string $text the text to tidy
+ * @return string
+ * @static
+ * @access private
+ */
+ function tidy( $text ) {
+ global $wgUseTidy;
+ if ($wgUseTidy) {
+ $text = Parser::tidy($text);
+ }
+ return $text;
+ }
+
+ function wellFormed( $text ) {
+ $html =
+ '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" ' .
+ '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">' .
+ '<html>' .
+ $text .
+ '</html>';
+
+ $parser = xml_parser_create( "UTF-8" );
+
+ # case folding violates XML standard, turn it off
+ xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
+
+ if( !xml_parse( $parser, $html, true ) ) {
+ $err = xml_error_string( xml_get_error_code( $parser ) );
+ $position = xml_get_current_byte_index( $parser );
+ $fragment = $this->extractFragment( $html, $position );
+ $this->mXmlError = "$err at byte $position:\n$fragment";
+ xml_parser_free( $parser );
+ return false;
+ }
+ xml_parser_free( $parser );
+ return true;
+ }
+
+ function extractFragment( $text, $position ) {
+ $start = max( 0, $position - 10 );
+ $before = $position - $start;
+ $fragment = '...' .
+ $this->termColor( 34 ) .
+ substr( $text, $start, $before ) .
+ $this->termColor( 0 ) .
+ $this->termColor( 31 ) .
+ $this->termColor( 1 ) .
+ substr( $text, $position, 1 ) .
+ $this->termColor( 0 ) .
+ $this->termColor( 34 ) .
+ substr( $text, $position + 1, 9 ) .
+ $this->termColor( 0 ) .
+ '...';
+ $display = str_replace( "\n", ' ', $fragment );
+ $caret = ' ' .
+ str_repeat( ' ', $before ) .
+ $this->termColor( 31 ) .
+ '^' .
+ $this->termColor( 0 );
+ return "$display\n$caret";
+ }
+
+}
+
+if( isset( $options['help'] ) ) {
+ echo <<<END
+MediaWiki $wgVersion parser test suite
+Usage: php parserTests.php [--quick] [--quiet] [--color[=(yes|no|light)]]
+ [--regex <expression>] [--help]
+Options:
+ --quick Suppress diff output of failed tests
+ --quiet Suppress notification of passed tests (shows only failed tests)
+ --color Override terminal detection and force color output on or off
+ 'light' option is similar to 'yes' but with color for dark backgrounds
+ --regex Only run tests whose descriptions which match given regex
+ --help Show this help message
+
+
+END;
+ exit( 0 );
}
+# There is a convention that the parser should never
+# refer to $wgTitle directly, but instead use the title
+# passed to it.
+$wgTitle = Title::newFromText( 'Parser test script do not use' );
$tester =& new ParserTest();
# Note: the command line setup changes the current working directory
dépôts / lhc / web / wiklou.git / blobdiff