<?php
-# Copyright (C) 2004 Brion Vibber <brion@pobox.com>
+# Copyright (C) 2004, 2010 Brion Vibber <brion@pobox.com>
# http://www.mediawiki.org/
#
# This program is free software; you can redistribute it and/or modify
*/
/** */
-$options = array( 'quick', 'color', 'quiet', 'help', 'show-output', 'record'. 'run-disabled' );
+$options = array( 'quick', 'color', 'quiet', 'help', 'show-output', 'record', 'run-disabled' );
$optionsWithArgs = array( 'regex', 'seed', 'setversion' );
if ( !defined( "NO_COMMAND_LINE" ) ) {
$this->recorder = new DbTestPreviewer( $this );
} elseif( isset( $options['upload'] ) ) {
$this->recorder = new RemoteTestRecorder( $this );
+ } elseif( class_exists( 'PHPUnitTestRecorder' ) ) {
+ $this->recorder = new PHPUnitTestRecorder( $this );
} else {
$this->recorder = new TestRecorder( $this );
}
/**
* Remove last character if it is a newline
*/
- private function chomp($s) {
+ public function chomp($s) {
if (substr($s, -1) === "\n") {
return substr($s, 0, -1);
}
* Prints status updates on stdout and counts up the total
* number and percentage of passed tests.
*
- * @param array of strings $filenames
- * @return bool True if passed all tests, false if any tests failed.
+ * @param $filenames Array of strings
+ * @return Boolean: true if passed all tests, false if any tests failed.
*/
public function runTestsFromFiles( $filenames ) {
$this->recorder->start();
$this->setupDatabase();
$ok = true;
foreach( $filenames as $filename ) {
- $ok = $this->runFile( $filename ) && $ok;
+ $tests = new TestFileIterator( $filename, $this );
+ $ok = $this->runTests( $tests ) && $ok;
}
$this->teardownDatabase();
$this->recorder->report();
return $ok;
}
- private function runFile( $filename ) {
- $infile = fopen( $filename, 'rt' );
- if( !$infile ) {
- wfDie( "Couldn't open file '$filename'\n" );
- } else {
- global $IP;
- $relative = wfRelativePath( $filename, $IP );
- $this->showRunFile( $relative );
- }
-
- $data = array();
- $section = null;
- $n = 0;
+ function runTests($tests) {
$ok = true;
- while( false !== ($line = fgets( $infile ) ) ) {
- $n++;
- $matches = array();
- if( preg_match( '/^!!\s*(\w+)/', $line, $matches ) ) {
- $section = strtolower( $matches[1] );
- if( $section == 'endarticle') {
- if( !isset( $data['text'] ) ) {
- wfDie( "'endarticle' without 'text' at line $n of $filename\n" );
- }
- if( !isset( $data['article'] ) ) {
- wfDie( "'endarticle' without 'article' at line $n of $filename\n" );
- }
- $this->addArticle($this->chomp($data['article']), $this->chomp($data['text']), $n);
- $data = array();
- $section = null;
- continue;
- }
- if( $section == 'endhooks' ) {
- if( !isset( $data['hooks'] ) ) {
- wfDie( "'endhooks' without 'hooks' at line $n of $filename\n" );
- }
- foreach( explode( "\n", $data['hooks'] ) as $line ) {
- $line = trim( $line );
- if( $line ) {
- $this->requireHook( $line );
- }
- }
- $data = array();
- $section = null;
- continue;
- }
- if( $section == 'endfunctionhooks' ) {
- if( !isset( $data['functionhooks'] ) ) {
- wfDie( "'endfunctionhooks' without 'functionhooks' at line $n of $filename\n" );
- }
- foreach( explode( "\n", $data['functionhooks'] ) as $line ) {
- $line = trim( $line );
- if( $line ) {
- $this->requireFunctionHook( $line );
- }
- }
- $data = array();
- $section = null;
- continue;
- }
- if( $section == 'end' ) {
- if( !isset( $data['test'] ) ) {
- wfDie( "'end' without 'test' at line $n of $filename\n" );
- }
- if( !isset( $data['input'] ) ) {
- wfDie( "'end' without 'input' at line $n of $filename\n" );
- }
- if( !isset( $data['result'] ) ) {
- wfDie( "'end' without 'result' at line $n of $filename\n" );
- }
- if( !isset( $data['options'] ) ) {
- $data['options'] = '';
- }
- else {
- $data['options'] = $this->chomp( $data['options'] );
- }
- if (!isset( $data['config'] ) )
- $data['config'] = '';
-
- if ( (preg_match('/\\bdisabled\\b/i', $data['options'])
- || !preg_match("/{$this->regex}/i", $data['test'])) && !$this->runDisabled ) {
- # disabled test
- $data = array();
- $section = null;
- continue;
- }
- if ( preg_match('/\\bmath\\b/i', $data['options']) && !$this->savedGlobals['wgUseTeX'] ) {
- # don't run math tests if $wgUseTeX is set to false in LocalSettings
- $data = array();
- $section = null;
- continue;
- }
- $result = $this->runTest(
- $this->chomp( $data['test'] ),
- $this->chomp( $data['input'] ),
- $this->chomp( $data['result'] ),
- $this->chomp( $data['options'] ),
- $this->chomp( $data['config'] )
- );
- $ok = $ok && $result;
- $this->recorder->record( $this->chomp( $data['test'] ), $result );
- $data = array();
- $section = null;
- continue;
- }
- if ( isset ($data[$section] ) ) {
- wfDie( "duplicate section '$section' at line $n of $filename\n" );
- }
- $data[$section] = '';
- continue;
- }
- if( $section ) {
- $data[$section] .= $line;
- }
+ foreach($tests as $i => $t) {
+ $result =
+ $this->runTest($t['test'], $t['input'], $t['result'], $t['options'], $t['config']);
+ $ok = $ok && $result;
+ $this->recorder->record( $t['test'], $result );
}
if ( $this->showProgress ) {
print "\n";
}
- return $ok;
+ return $ok;
}
/**
* 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
+ * @param $desc String: test's description
+ * @param $input String: wikitext to try rendering
+ * @param $result String: result to output
+ * @param $opts Array: test's options
+ * @param $config String: overrides for global variables, one per line
+ * @return Boolean
*/
- private function runTest( $desc, $input, $result, $opts, $config ) {
+ public function runTest( $desc, $input, $result, $opts, $config ) {
if( $this->showProgress ) {
$this->showTesting( $desc );
}
$user = new User();
$options = ParserOptions::newFromUser( $user );
- if ( isset( $opts['math'] ) ) {
- # XXX this should probably be done by the ParserOptions
- $options->setUseTex(true);
- }
-
$m = array();
if (isset( $opts['title'] ) ) {
$titleText = $opts['title'];
} elseif( isset( $opts['comment'] ) ) {
$linker = $user->getSkin();
$out = $linker->formatComment( $input, $title, $local );
+ } elseif( isset( $opts['preload'] ) ) {
+ $out = $parser->getpreloadText( $input, $title, $options );
} else {
$output = $parser->parse( $input, $title, $options, true, true, 1337 );
$out = $output->getText();
if ( isset( $opts['showtitle'] ) ) {
- $out = $output->getTitleText() . "\n$out";
+ if($output->getTitleText()) $title = $output->getTitleText();
+ $out = "$title\n$out";
}
if (isset( $opts['ill'] ) ) {
$out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
/**
* Use a regex to find out the value of an option
- * @param $key name of option val to retrieve
+ * @param $key String: name of option val to retrieve
* @param $opts Options array to look in
- * @param $defaults Default value returned if not found
+ * @param $default Mixed: default value returned if not found
*/
private static function getOptionValue( $key, $opts, $default ) {
$key = strtolower( $key );
'wgNoFollowDomainExceptions' => array(),
'wgThumbnailScriptPath' => false,
'wgUseImageResize' => false,
- 'wgUseTeX' => false,
+ 'wgUseTeX' => isset( $opts['math'] ),
+ 'wgMathDirectory' => $this->uploadDir . '/math',
'wgLocaltimezone' => 'UTC',
'wgAllowExternalImages' => true,
'wgUseTidy' => false,
$GLOBALS['wgMemc'] = new FakeMemCachedClient;
$GLOBALS['wgOut'] = new OutputPage;
- //$GLOBALS['wgMessageCache'] = new MessageCache( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
-
MagicWord::clearCache();
global $wgUser;
global $wgDBtype;
$tables = array('user', 'page', 'page_restrictions',
'protected_titles', 'revision', 'text', 'pagelinks', 'imagelinks',
- 'categorylinks', 'templatelinks', 'externallinks', 'langlinks',
+ 'categorylinks', 'templatelinks', 'externallinks', 'langlinks', 'iwlinks',
'site_stats', 'hitcounter', 'ipblocks', 'image', 'oldimage',
'recentchanges', 'watchlist', 'math', 'interwiki',
'querycache', 'objectcache', 'job', 'l10n_cache', 'redirect', 'querycachetwo',
* Currently this will only be done once per run, and any changes to
* the db will be visible to later tests in the run.
*/
- private function setupDatabase() {
+ function setupDatabase() {
global $wgDBprefix, $wgDBtype;
if ( $this->databaseSetupDone ) {
return;
# Reinitialise the LocalisationCache to match the database state
Language::getLocalisationCache()->unloadAll();
+
+ # Make a new message cache
+ global $wgMessageCache, $wgMemc;
+ $wgMessageCache = new MessageCache( $wgMemc, true, 3600, '' );
}
/**
}
private function teardownDatabase() {
- global $wgDBprefix, $wgDBtype;
+ global $wgDBtype;
if ( !$this->databaseSetupDone ) {
return;
}
/**
* Create a dummy uploads directory which will contain a couple
* of files in order to pass existence tests.
- * @return string The directory
+ *
+ * @return String: the directory
*/
private function setupUploadDir() {
global $IP;
"$dir/thumb/3/3a/Foobar.jpg/120px-Foobar.jpg",
"$dir/0/09/Bad.jpg",
+
+ "$dir/math/f/a/5/fa50b8b616463173474302ca3e63586b.png",
)
);
"$dir/0/09/",
"$dir/0/",
-
"$dir/thumb",
+ "$dir/math/f/a/5",
+ "$dir/math/f/a",
+ "$dir/math/f",
+ "$dir/math",
"$dir",
)
);
/**
* Delete the specified files, if they exist.
- * @param array $files full paths to files to delete.
+ * @param $files Array: full paths to files to delete.
*/
private static function deleteFiles( $files ) {
foreach( $files as $file ) {
/**
* Delete the specified directories, if they exist. Must be empty.
- * @param array $dirs full paths to directories to delete.
+ * @param $dirs Array: full paths to directories to delete.
*/
private static function deleteDirs( $dirs ) {
foreach( $dirs as $dir ) {
/**
* Print a happy success message.
*
- * @param string $desc The test name
- * @return bool
+ * @param $desc String: the test name
+ * @return Boolean
*/
protected function showSuccess( $desc ) {
if( $this->showProgress ) {
* 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
+ * @param $desc String: the test name
+ * @param $result String: expected HTML output
+ * @param $html String: actual HTML output
+ * @return Boolean
*/
protected function showFailure( $desc, $result, $html ) {
if( $this->showFailure ) {
* 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
- * @param string $inFileTail Tailing for the input file name
- * @param string $outFileTail Tailing for the output file name
- * @return string
+ * @param $input String
+ * @param $output String
+ * @param $inFileTail String: tailing for the input file name
+ * @param $outFileTail String: tailing for the output file name
+ * @return String
*/
protected function quickDiff( $input, $output, $inFileTail='expected', $outFileTail='actual' ) {
$prefix = wfTempDir() . "/mwParser-" . mt_rand();
/**
* Write the given string to a file, adding a final newline.
*
- * @param string $data
- * @param string $filename
+ * @param $data String
+ * @param $filename String
*/
private function dumpToFile( $data, $filename ) {
$file = fopen( $filename, "wt" );
* Colorize unified diff output if set for ANSI color output.
* Subtractions are colored blue, additions red.
*
- * @param string $text
- * @return string
+ * @param $text String
+ * @return String
*/
protected function colorDiff( $text ) {
return preg_replace(
/**
* Show "Reading tests from ..."
*
- * @param String $path
+ * @param $path String
*/
- protected function showRunFile( $path ){
+ public function showRunFile( $path ){
print $this->term->color( 1 ) .
"Reading tests from \"$path\"..." .
$this->term->reset() .
/**
* 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
+ * @param $name String: the title, including any prefix
+ * @param $text String: the article text
+ * @param $line Integer: the input line number, for reporting errors
*/
- private function addArticle($name, $text, $line) {
- global $wgMessageCache;
+ public function addArticle($name, $text, $line) {
$this->setupGlobals();
$title = Title::newFromText( $name );
if ( is_null($title) ) {
$aid = $title->getArticleID( GAID_FOR_UPDATE );
if ($aid != 0) {
- wfDie( "duplicate article at line $line\n" );
+ wfDie( "duplicate article '$name' at line $line\n" );
}
$art = new Article($title);
* Steal a callback function from the primary parser, save it for
* application to our scary parser. If the hook is not installed,
* die a painful dead to warn the others.
- * @param string $name
+ *
+ * @param $name String
*/
- private function requireHook( $name ) {
+ public function requireHook( $name ) {
global $wgParser;
$wgParser->firstCallInit( ); //make sure hooks are loaded.
if( isset( $wgParser->mTagHooks[$name] ) ) {
* Steal a callback function from the primary parser, save it for
* application to our scary parser. If the hook is not installed,
* die a painful dead to warn the others.
- * @param string $name
+ *
+ * @param $name String
*/
- private function requireFunctionHook( $name ) {
+ public function requireFunctionHook( $name ) {
global $wgParser;
$wgParser->firstCallInit( ); //make sure hooks are loaded.
if( isset( $wgParser->mFunctionHooks[$name] ) ) {
* Run the "tidy" command on text if the $wgUseTidy
* global is true
*
- * @param string $text the text to tidy
- * @return string
+ * @param $text String: the text to tidy
+ * @return String
* @static
*/
private function tidy( $text ) {
/**
* Return ANSI terminal escape code for changing text attribs/color
*
- * @param string $color Semicolon-separated list of attribute/color codes
- * @return string
+ * @param $color String: semicolon-separated list of attribute/color codes
+ * @return String
*/
public function color( $color ) {
global $wgCommandLineDarkBg;
/**
* Return ANSI terminal escape code for restoring default text attributes
*
- * @return string
+ * @return String
*/
public function reset() {
return $this->color( 0 );
* and all that fun stuff
*/
function start() {
- global $wgDBtype, $wgDBprefix;
+ global $wgDBtype;
parent::start();
if( ! $this->db->tableExists( 'testrun' )
* and all that fun stuff
*/
function start() {
- global $wgDBtype, $wgDBprefix, $options;
+ global $wgDBtype, $options;
$this->db->begin();
if( ! $this->db->tableExists( 'testrun' )
/**
* Record an individual test item's success or failure to the db
- * @param string $test
- * @param bool $result
+ *
+ * @param $test String
+ * @param $result Boolean
*/
function record( $test, $result ) {
parent::record( $test, $result );
/**
* Inform a CodeReview instance that we've started or completed a test run...
- * @param $remote array: info on remote target
+ *
* @param $status string: "running" - tell it we've started
* "complete" - provide test results array
* "abort" - something went horribly awry
- * @param $data array of test name => true/false
+ * @param $results array of test name => true/false
*/
function ping( $status, $results=false ) {
global $wgParserTestRemote, $IP;
return Http::post( $url, array( 'postData' => $data) );
}
}
+
+class TestFileIterator implements Iterator {
+ private $file;
+ private $fh;
+ private $parser;
+ private $index = 0;
+ private $test;
+ private $lineNum;
+ private $eof;
+
+ function __construct( $file, $parser = null ) {
+ global $IP;
+
+ $this->file = $file;
+ $this->fh = fopen($this->file, "rt");
+ if( !$this->fh ) {
+ wfDie( "Couldn't open file '$file'\n" );
+ }
+
+ $this->parser = $parser;
+
+ if( $this->parser ) $this->parser->showRunFile( wfRelativePath( $this->file, $IP ) );
+ $this->lineNum = $this->index = 0;
+ }
+
+ function setParser( ParserTest $parser ) {
+ $this->parser = $parser;
+ }
+
+ function rewind() {
+ if(fseek($this->fh, 0)) {
+ wfDie( "Couldn't fseek to the start of '$filename'\n" );
+ }
+ $this->index = 0;
+ $this->lineNum = 0;
+ $this->eof = false;
+ $this->readNextTest();
+
+ return true;
+ }
+
+ function current() {
+ return $this->test;
+ }
+
+ function key() {
+ return $this->index;
+ }
+
+ function next() {
+ if($this->readNextTest()) {
+ $this->index++;
+ return true;
+ } else {
+ $this->eof = true;
+ }
+ }
+
+ function valid() {
+ return $this->eof != true;
+ }
+
+ function readNextTest() {
+ $data = array();
+ $section = null;
+
+ while( false !== ($line = fgets( $this->fh ) ) ) {
+ $this->lineNum++;
+ $matches = array();
+ if( preg_match( '/^!!\s*(\w+)/', $line, $matches ) ) {
+ $section = strtolower( $matches[1] );
+ if( $section == 'endarticle') {
+ if( !isset( $data['text'] ) ) {
+ wfDie( "'endarticle' without 'text' at line {$this->lineNum} of $filename\n" );
+ }
+ if( !isset( $data['article'] ) ) {
+ wfDie( "'endarticle' without 'article' at line {$this->lineNum} of $filename\n" );
+ }
+ if( $this->parser ) $this->parser->addArticle($this->parser->chomp($data['article']), $this->parser->chomp($data['text']),
+ $this->lineNum);
+ $data = array();
+ $section = null;
+ continue;
+ }
+ if( $section == 'endhooks' ) {
+ if( !isset( $data['hooks'] ) ) {
+ wfDie( "'endhooks' without 'hooks' at line {$this->lineNum} of $filename\n" );
+ }
+ foreach( explode( "\n", $data['hooks'] ) as $line ) {
+ $line = trim( $line );
+ if( $line ) {
+ if( $this->parser ) $this->parser->requireHook( $line );
+ }
+ }
+ $data = array();
+ $section = null;
+ continue;
+ }
+ if( $section == 'endfunctionhooks' ) {
+ if( !isset( $data['functionhooks'] ) ) {
+ wfDie( "'endfunctionhooks' without 'functionhooks' at line {$this->lineNum} of $filename\n" );
+ }
+ foreach( explode( "\n", $data['functionhooks'] ) as $line ) {
+ $line = trim( $line );
+ if( $line ) {
+ if( $this->parser ) $this->parser->requireFunctionHook( $line );
+ }
+ }
+ $data = array();
+ $section = null;
+ continue;
+ }
+ if( $section == 'end' ) {
+ if( !isset( $data['test'] ) ) {
+ wfDie( "'end' without 'test' at line {$this->lineNum} of $filename\n" );
+ }
+ if( !isset( $data['input'] ) ) {
+ wfDie( "'end' without 'input' at line {$this->lineNum} of $filename\n" );
+ }
+ if( !isset( $data['result'] ) ) {
+ wfDie( "'end' without 'result' at line {$this->lineNum} of $filename\n" );
+ }
+ if( !isset( $data['options'] ) ) {
+ $data['options'] = '';
+ }
+ if (!isset( $data['config'] ) )
+ $data['config'] = '';
+
+ if ( $this->parser && (preg_match('/\\bdisabled\\b/i', $data['options'])
+ || !preg_match("/{$this->parser->regex}/i", $data['test'])) && !$this->parser->runDisabled ) {
+ # disabled test
+ $data = array();
+ $section = null;
+ continue;
+ }
+ if ( $this->parser &&
+ preg_match('/\\bmath\\b/i', $data['options']) && !$this->parser->savedGlobals['wgUseTeX'] ) {
+ # don't run math tests if $wgUseTeX is set to false in LocalSettings
+ $data = array();
+ $section = null;
+ continue;
+ }
+
+ if( $this->parser ) {
+ $this->test = array(
+ 'test' => $this->parser->chomp( $data['test'] ),
+ 'input' => $this->parser->chomp( $data['input'] ),
+ 'result' => $this->parser->chomp( $data['result'] ),
+ 'options' => $this->parser->chomp( $data['options'] ),
+ 'config' => $this->parser->chomp( $data['config'] ) );
+ } else {
+ $this->test['test'] = $data['test'];
+ }
+ return true;
+ }
+ if ( isset ($data[$section] ) ) {
+ wfDie( "duplicate section '$section' at line {$this->lineNum} of $filename\n" );
+ }
+ $data[$section] = '';
+ continue;
+ }
+ if( $section ) {
+ $data[$section] .= $line;
+ }
+ }
+ return false;
+ }
+}