Current File : /www/varak.net/wiki.varak.net/tests/testHelpers.inc
<?php
/**
* Recording for passing/failing tests.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Testing
*/
/**
* Interface to record parser test results.
*
* The ITestRecorder is a very simple interface to record the result of
* MediaWiki parser tests. One should call start() before running the
* full parser tests and end() once all the tests have been finished.
* After each test, you should use record() to keep track of your tests
* results. Finally, report() is used to generate a summary of your
* test run, one could dump it to the console for human consumption or
* register the result in a database for tracking purposes.
*
* @since 1.22
*/
interface ITestRecorder {
/**
* Called at beginning of the parser test run
*/
public function start();
/**
* Called after each test
* @param string $test
* @param integer $subtest
* @param bool $result
*/
public function record( $test, $subtest, $result );
/**
* Called before finishing the test run
*/
public function report();
/**
* Called at the end of the parser test run
*/
public function end();
}
class TestRecorder implements ITestRecorder {
public $parent;
public $term;
function __construct( $parent ) {
$this->parent = $parent;
$this->term = $parent->term;
}
function start() {
$this->total = 0;
$this->success = 0;
}
function record( $test, $subtest, $result ) {
$this->total++;
$this->success += ( $result ? 1 : 0 );
}
function end() {
// dummy
}
function report() {
if ( $this->total > 0 ) {
$this->reportPercentage( $this->success, $this->total );
} else {
throw new MWException( "No tests found.\n" );
}
}
function reportPercentage( $success, $total ) {
$ratio = wfPercent( 100 * $success / $total );
print $this->term->color( 1 ) . "Passed $success of $total tests ($ratio)... ";
if ( $success == $total ) {
print $this->term->color( 32 ) . "ALL TESTS PASSED!";
} else {
$failed = $total - $success;
print $this->term->color( 31 ) . "$failed tests failed!";
}
print $this->term->reset() . "\n";
return ( $success == $total );
}
}
class DbTestPreviewer extends TestRecorder {
protected $lb; // /< Database load balancer
protected $db; // /< Database connection to the main DB
protected $curRun; // /< run ID number for the current run
protected $prevRun; // /< run ID number for the previous run, if any
protected $results; // /< Result array
/**
* This should be called before the table prefix is changed
* @param TestRecorder $parent
*/
function __construct( $parent ) {
parent::__construct( $parent );
$this->lb = wfGetLBFactory()->newMainLB();
// This connection will have the wiki's table prefix, not parsertest_
$this->db = $this->lb->getConnection( DB_MASTER );
}
/**
* Set up result recording; insert a record for the run with the date
* and all that fun stuff
*/
function start() {
parent::start();
if ( !$this->db->tableExists( 'testrun', __METHOD__ )
|| !$this->db->tableExists( 'testitem', __METHOD__ )
) {
print "WARNING> `testrun` table not found in database.\n";
$this->prevRun = false;
} else {
// We'll make comparisons against the previous run later...
$this->prevRun = $this->db->selectField( 'testrun', 'MAX(tr_id)' );
}
$this->results = [];
}
function getName( $test, $subtest ) {
if ( $subtest ) {
return "$test subtest #$subtest";
} else {
return $test;
}
}
function record( $test, $subtest, $result ) {
parent::record( $test, $subtest, $result );
$this->results[ $this->getName( $test, $subtest ) ] = $result;
}
function report() {
if ( $this->prevRun ) {
// f = fail, p = pass, n = nonexistent
// codes show before then after
$table = [
'fp' => 'previously failing test(s) now PASSING! :)',
'pn' => 'previously PASSING test(s) removed o_O',
'np' => 'new PASSING test(s) :)',
'pf' => 'previously passing test(s) now FAILING! :(',
'fn' => 'previously FAILING test(s) removed O_o',
'nf' => 'new FAILING test(s) :(',
'ff' => 'still FAILING test(s) :(',
];
$prevResults = [];
$res = $this->db->select( 'testitem', [ 'ti_name', 'ti_success' ],
[ 'ti_run' => $this->prevRun ], __METHOD__ );
foreach ( $res as $row ) {
if ( !$this->parent->regex
|| preg_match( "/{$this->parent->regex}/i", $row->ti_name )
) {
$prevResults[$row->ti_name] = $row->ti_success;
}
}
$combined = array_keys( $this->results + $prevResults );
# Determine breakdown by change type
$breakdown = [];
foreach ( $combined as $test ) {
if ( !isset( $prevResults[$test] ) ) {
$before = 'n';
} elseif ( $prevResults[$test] == 1 ) {
$before = 'p';
} else /* if ( $prevResults[$test] == 0 )*/ {
$before = 'f';
}
if ( !isset( $this->results[$test] ) ) {
$after = 'n';
} elseif ( $this->results[$test] == 1 ) {
$after = 'p';
} else /*if ( $this->results[$test] == 0 ) */ {
$after = 'f';
}
$code = $before . $after;
if ( isset( $table[$code] ) ) {
$breakdown[$code][$test] = $this->getTestStatusInfo( $test, $after );
}
}
# Write out results
foreach ( $table as $code => $label ) {
if ( !empty( $breakdown[$code] ) ) {
$count = count( $breakdown[$code] );
printf( "\n%4d %s\n", $count, $label );
foreach ( $breakdown[$code] as $differing_test_name => $statusInfo ) {
print " * $differing_test_name [$statusInfo]\n";
}
}
}
} else {
print "No previous test runs to compare against.\n";
}
print "\n";
parent::report();
}
/**
* Returns a string giving information about when a test last had a status change.
* Could help to track down when regressions were introduced, as distinct from tests
* which have never passed (which are more change requests than regressions).
* @param string $testname
* @param string $after
* @return string
*/
private function getTestStatusInfo( $testname, $after ) {
// If we're looking at a test that has just been removed, then say when it first appeared.
if ( $after == 'n' ) {
$changedRun = $this->db->selectField( 'testitem',
'MIN(ti_run)',
[ 'ti_name' => $testname ],
__METHOD__ );
$appear = $this->db->selectRow( 'testrun',
[ 'tr_date', 'tr_mw_version' ],
[ 'tr_id' => $changedRun ],
__METHOD__ );
return "First recorded appearance: "
. date( "d-M-Y H:i:s", strtotime( $appear->tr_date ) )
. ", " . $appear->tr_mw_version;
}
// Otherwise, this test has previous recorded results.
// See when this test last had a different result to what we're seeing now.
$conds = [
'ti_name' => $testname,
'ti_success' => ( $after == 'f' ? "1" : "0" ) ];
if ( $this->curRun ) {
$conds[] = "ti_run != " . $this->db->addQuotes( $this->curRun );
}
$changedRun = $this->db->selectField( 'testitem', 'MAX(ti_run)', $conds, __METHOD__ );
// If no record of ever having had a different result.
if ( is_null( $changedRun ) ) {
if ( $after == "f" ) {
return "Has never passed";
} else {
return "Has never failed";
}
}
// Otherwise, we're looking at a test whose status has changed.
// (i.e. it used to work, but now doesn't; or used to fail, but is now fixed.)
// In this situation, give as much info as we can as to when it changed status.
$pre = $this->db->selectRow( 'testrun',
[ 'tr_date', 'tr_mw_version' ],
[ 'tr_id' => $changedRun ],
__METHOD__ );
$post = $this->db->selectRow( 'testrun',
[ 'tr_date', 'tr_mw_version' ],
[ "tr_id > " . $this->db->addQuotes( $changedRun ) ],
__METHOD__,
[ "LIMIT" => 1, "ORDER BY" => 'tr_id' ]
);
if ( $post ) {
$postDate = date( "d-M-Y H:i:s", strtotime( $post->tr_date ) ) . ", {$post->tr_mw_version}";
} else {
$postDate = 'now';
}
return ( $after == "f" ? "Introduced" : "Fixed" ) . " between "
. date( "d-M-Y H:i:s", strtotime( $pre->tr_date ) ) . ", " . $pre->tr_mw_version
. " and $postDate";
}
/**
* Close the DB connection
*/
function end() {
$this->lb->closeAll();
parent::end();
}
}
class DbTestRecorder extends DbTestPreviewer {
public $version;
/**
* Set up result recording; insert a record for the run with the date
* and all that fun stuff
*/
function start() {
$this->db->begin( __METHOD__ );
if ( !$this->db->tableExists( 'testrun' )
|| !$this->db->tableExists( 'testitem' )
) {
print "WARNING> `testrun` table not found in database. Trying to create table.\n";
$this->db->sourceFile( $this->db->patchPath( 'patch-testrun.sql' ) );
echo "OK, resuming.\n";
}
parent::start();
$this->db->insert( 'testrun',
[
'tr_date' => $this->db->timestamp(),
'tr_mw_version' => $this->version,
'tr_php_version' => PHP_VERSION,
'tr_db_version' => $this->db->getServerVersion(),
'tr_uname' => php_uname()
],
__METHOD__ );
if ( $this->db->getType() === 'postgres' ) {
$this->curRun = $this->db->currentSequenceValue( 'testrun_id_seq' );
} else {
$this->curRun = $this->db->insertId();
}
}
/**
* Record an individual test item's success or failure to the db
*
* @param string $test
* @param bool $result
*/
function record( $test, $subtest, $result ) {
parent::record( $test, $subtest, $result );
$this->db->insert( 'testitem',
[
'ti_run' => $this->curRun,
'ti_name' => $this->getName( $test, $subtest ),
'ti_success' => $result ? 1 : 0,
],
__METHOD__ );
}
/**
* Commit transaction and clean up for result recording
*/
function end() {
$this->db->commit( __METHOD__ );
parent::end();
}
}
class TestFileIterator implements Iterator {
private $file;
private $fh;
/**
* @var ParserTest|MediaWikiParserTest An instance of ParserTest (parserTests.php)
* or MediaWikiParserTest (phpunit)
*/
private $parserTest;
private $index = 0;
private $test;
private $section = null;
/** String|null: current test section being analyzed */
private $sectionData = [];
private $lineNum;
private $eof;
# Create a fake parser tests which never run anything unless
# asked to do so. This will avoid running hooks for a disabled test
private $delayedParserTest;
private $nextSubTest = 0;
function __construct( $file, $parserTest ) {
$this->file = $file;
$this->fh = fopen( $this->file, "rt" );
if ( !$this->fh ) {
throw new MWException( "Couldn't open file '$file'\n" );
}
$this->parserTest = $parserTest;
$this->delayedParserTest = new DelayedParserTest();
$this->lineNum = $this->index = 0;
}
function rewind() {
if ( fseek( $this->fh, 0 ) ) {
throw new MWException( "Couldn't fseek to the start of '$this->file'\n" );
}
$this->index = -1;
$this->lineNum = 0;
$this->eof = false;
$this->next();
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 setupCurrentTest() {
// "input" and "result" are old section names allowed
// for backwards-compatibility.
$input = $this->checkSection( [ 'wikitext', 'input' ], false );
$result = $this->checkSection( [ 'html/php', 'html/*', 'html', 'result' ], false );
// some tests have "with tidy" and "without tidy" variants
$tidy = $this->checkSection( [ 'html/php+tidy', 'html+tidy' ], false );
if ( $tidy != false ) {
if ( $this->nextSubTest == 0 ) {
if ( $result != false ) {
$this->nextSubTest = 1; // rerun non-tidy variant later
}
$result = $tidy;
} else {
$this->nextSubTest = 0; // go on to next test after this
$tidy = false;
}
}
if ( !isset( $this->sectionData['options'] ) ) {
$this->sectionData['options'] = '';
}
if ( !isset( $this->sectionData['config'] ) ) {
$this->sectionData['config'] = '';
}
$isDisabled = preg_match( '/\\bdisabled\\b/i', $this->sectionData['options'] ) &&
!$this->parserTest->runDisabled;
$isParsoidOnly = preg_match( '/\\bparsoid\\b/i', $this->sectionData['options'] ) &&
$result == 'html' &&
!$this->parserTest->runParsoid;
$isFiltered = !preg_match( "/" . $this->parserTest->regex . "/i", $this->sectionData['test'] );
if ( $input == false || $result == false || $isDisabled || $isParsoidOnly || $isFiltered ) {
# disabled test
return false;
}
# We are really going to run the test, run pending hooks and hooks function
wfDebug( __METHOD__ . " unleashing delayed test for: {$this->sectionData['test']}" );
$hooksResult = $this->delayedParserTest->unleash( $this->parserTest );
if ( !$hooksResult ) {
# Some hook reported an issue. Abort.
throw new MWException( "Problem running requested parser hook from the test file" );
}
$this->test = [
'test' => ParserTest::chomp( $this->sectionData['test'] ),
'subtest' => $this->nextSubTest,
'input' => ParserTest::chomp( $this->sectionData[$input] ),
'result' => ParserTest::chomp( $this->sectionData[$result] ),
'options' => ParserTest::chomp( $this->sectionData['options'] ),
'config' => ParserTest::chomp( $this->sectionData['config'] ),
];
if ( $tidy != false ) {
$this->test['options'] .= " tidy";
}
return true;
}
function readNextTest() {
# Run additional subtests of previous test
while ( $this->nextSubTest > 0 ) {
if ( $this->setupCurrentTest() ) {
return true;
}
}
$this->clearSection();
# Reset hooks for the delayed test object
$this->delayedParserTest->reset();
while ( false !== ( $line = fgets( $this->fh ) ) ) {
$this->lineNum++;
$matches = [];
if ( preg_match( '/^!!\s*(\S+)/', $line, $matches ) ) {
$this->section = strtolower( $matches[1] );
if ( $this->section == 'endarticle' ) {
$this->checkSection( 'text' );
$this->checkSection( 'article' );
$this->parserTest->addArticle(
ParserTest::chomp( $this->sectionData['article'] ),
$this->sectionData['text'], $this->lineNum );
$this->clearSection();
continue;
}
if ( $this->section == 'endhooks' ) {
$this->checkSection( 'hooks' );
foreach ( explode( "\n", $this->sectionData['hooks'] ) as $line ) {
$line = trim( $line );
if ( $line ) {
$this->delayedParserTest->requireHook( $line );
}
}
$this->clearSection();
continue;
}
if ( $this->section == 'endfunctionhooks' ) {
$this->checkSection( 'functionhooks' );
foreach ( explode( "\n", $this->sectionData['functionhooks'] ) as $line ) {
$line = trim( $line );
if ( $line ) {
$this->delayedParserTest->requireFunctionHook( $line );
}
}
$this->clearSection();
continue;
}
if ( $this->section == 'endtransparenthooks' ) {
$this->checkSection( 'transparenthooks' );
foreach ( explode( "\n", $this->sectionData['transparenthooks'] ) as $line ) {
$line = trim( $line );
if ( $line ) {
$this->delayedParserTest->requireTransparentHook( $line );
}
}
$this->clearSection();
continue;
}
if ( $this->section == 'end' ) {
$this->checkSection( 'test' );
do {
if ( $this->setupCurrentTest() ) {
return true;
}
} while ( $this->nextSubTest > 0 );
# go on to next test (since this was disabled)
$this->clearSection();
$this->delayedParserTest->reset();
continue;
}
if ( isset( $this->sectionData[$this->section] ) ) {
throw new MWException( "duplicate section '$this->section' "
. "at line {$this->lineNum} of $this->file\n" );
}
$this->sectionData[$this->section] = '';
continue;
}
if ( $this->section ) {
$this->sectionData[$this->section] .= $line;
}
}
return false;
}
/**
* Clear section name and its data
*/
private function clearSection() {
$this->sectionData = [];
$this->section = null;
}
/**
* Verify the current section data has some value for the given token
* name(s) (first parameter).
* Throw an exception if it is not set, referencing current section
* and adding the current file name and line number
*
* @param string|array $tokens Expected token(s) that should have been
* mentioned before closing this section
* @param bool $fatal True iff an exception should be thrown if
* the section is not found.
* @return bool|string
* @throws MWException
*/
private function checkSection( $tokens, $fatal = true ) {
if ( is_null( $this->section ) ) {
throw new MWException( __METHOD__ . " can not verify a null section!\n" );
}
if ( !is_array( $tokens ) ) {
$tokens = [ $tokens ];
}
if ( count( $tokens ) == 0 ) {
throw new MWException( __METHOD__ . " can not verify zero sections!\n" );
}
$data = $this->sectionData;
$tokens = array_filter( $tokens, function ( $token ) use ( $data ) {
return isset( $data[$token] );
} );
if ( count( $tokens ) == 0 ) {
if ( !$fatal ) {
return false;
}
throw new MWException( sprintf(
"'%s' without '%s' at line %s of %s\n",
$this->section,
implode( ',', $tokens ),
$this->lineNum,
$this->file
) );
}
if ( count( $tokens ) > 1 ) {
throw new MWException( sprintf(
"'%s' with unexpected tokens '%s' at line %s of %s\n",
$this->section,
implode( ',', $tokens ),
$this->lineNum,
$this->file
) );
}
return array_values( $tokens )[0];
}
}
/**
* An iterator for use as a phpunit data provider. Provides the test arguments
* in the order expected by NewParserTest::testParserTest().
*/
class TestFileDataProvider extends TestFileIterator {
function current() {
$test = parent::current();
if ( $test ) {
return [
$test['test'],
$test['input'],
$test['result'],
$test['options'],
$test['config'],
];
} else {
return $test;
}
}
}
/**
* A class to delay execution of a parser test hooks.
*/
class DelayedParserTest {
/** Initialized on construction */
private $hooks;
private $fnHooks;
private $transparentHooks;
public function __construct() {
$this->reset();
}
/**
* Init/reset or forgot about the current delayed test.
* Call to this will erase any hooks function that were pending.
*/
public function reset() {
$this->hooks = [];
$this->fnHooks = [];
$this->transparentHooks = [];
}
/**
* Called whenever we actually want to run the hook.
* Should be the case if we found the parserTest is not disabled
* @param ParserTest|NewParserTest $parserTest
* @return bool
* @throws MWException
*/
public function unleash( &$parserTest ) {
if ( !( $parserTest instanceof ParserTest || $parserTest instanceof NewParserTest ) ) {
throw new MWException( __METHOD__ . " must be passed an instance of ParserTest or "
. "NewParserTest classes\n" );
}
# Trigger delayed hooks. Any failure will make us abort
foreach ( $this->hooks as $hook ) {
$ret = $parserTest->requireHook( $hook );
if ( !$ret ) {
return false;
}
}
# Trigger delayed function hooks. Any failure will make us abort
foreach ( $this->fnHooks as $fnHook ) {
$ret = $parserTest->requireFunctionHook( $fnHook );
if ( !$ret ) {
return false;
}
}
# Trigger delayed transparent hooks. Any failure will make us abort
foreach ( $this->transparentHooks as $hook ) {
$ret = $parserTest->requireTransparentHook( $hook );
if ( !$ret ) {
return false;
}
}
# Delayed execution was successful.
return true;
}
/**
* Similar to ParserTest object but does not run anything
* Use unleash() to really execute the hook
* @param string $hook
*/
public function requireHook( $hook ) {
$this->hooks[] = $hook;
}
/**
* Similar to ParserTest object but does not run anything
* Use unleash() to really execute the hook function
* @param string $fnHook
*/
public function requireFunctionHook( $fnHook ) {
$this->fnHooks[] = $fnHook;
}
/**
* Similar to ParserTest object but does not run anything
* Use unleash() to really execute the hook function
* @param string $hook
*/
public function requireTransparentHook( $hook ) {
$this->transparentHooks[] = $hook;
}
}
/**
* Initialize and detect the DjVu files support
*/
class DjVuSupport {
/**
* Initialises DjVu tools global with default values
*/
public function __construct() {
global $wgDjvuRenderer, $wgDjvuDump, $wgDjvuToXML, $wgFileExtensions, $wgDjvuTxt;
$wgDjvuRenderer = $wgDjvuRenderer ? $wgDjvuRenderer : '/usr/bin/ddjvu';
$wgDjvuDump = $wgDjvuDump ? $wgDjvuDump : '/usr/bin/djvudump';
$wgDjvuToXML = $wgDjvuToXML ? $wgDjvuToXML : '/usr/bin/djvutoxml';
$wgDjvuTxt = $wgDjvuTxt ? $wgDjvuTxt : '/usr/bin/djvutxt';
if ( !in_array( 'djvu', $wgFileExtensions ) ) {
$wgFileExtensions[] = 'djvu';
}
}
/**
* Returns true if the DjVu tools are usable
*
* @return bool
*/
public function isEnabled() {
global $wgDjvuRenderer, $wgDjvuDump, $wgDjvuToXML, $wgDjvuTxt;
return is_executable( $wgDjvuRenderer )
&& is_executable( $wgDjvuDump )
&& is_executable( $wgDjvuToXML )
&& is_executable( $wgDjvuTxt );
}
}
/**
* Initialize and detect the tidy support
*/
class TidySupport {
private $enabled;
private $config;
/**
* Determine if there is a usable tidy.
*/
public function __construct( $useConfiguration = false ) {
global $IP, $wgUseTidy, $wgTidyBin, $wgTidyInternal, $wgTidyConfig,
$wgTidyConf, $wgTidyOpts;
$this->enabled = true;
if ( $useConfiguration ) {
if ( $wgTidyConfig !== null ) {
$this->config = $wgTidyConfig;
} elseif ( $wgUseTidy ) {
$this->config = [
'tidyConfigFile' => $wgTidyConf,
'debugComment' => false,
'tidyBin' => $wgTidyBin,
'tidyCommandLine' => $wgTidyOpts
];
if ( $wgTidyInternal ) {
$this->config['driver'] = wfIsHHVM() ? 'RaggettInternalHHVM' : 'RaggettInternalPHP';
} else {
$this->config['driver'] = 'RaggettExternal';
}
} else {
$this->enabled = false;
}
} else {
$this->config = [
'tidyConfigFile' => "$IP/includes/tidy/tidy.conf",
'tidyCommandLine' => '',
];
if ( extension_loaded( 'tidy' ) && class_exists( 'tidy' ) ) {
$this->config['driver'] = wfIsHHVM() ? 'RaggettInternalHHVM' : 'RaggettInternalPHP';
} else {
if ( is_executable( $wgTidyBin ) ) {
$this->config['driver'] = 'RaggettExternal';
$this->config['tidyBin'] = $wgTidyBin;
} else {
$path = Installer::locateExecutableInDefaultPaths( $wgTidyBin );
if ( $path !== false ) {
$this->config['driver'] = 'RaggettExternal';
$this->config['tidyBin'] = $wgTidyBin;
} else {
$this->enabled = false;
}
}
}
}
if ( !$this->enabled ) {
$this->config = [ 'driver' => 'disabled' ];
}
}
/**
* Returns true if tidy is usable
*
* @return bool
*/
public function isEnabled() {
return $this->enabled;
}
public function getConfig() {
return $this->config;
}
}
Mini Shell