From: Tim Starling Date: Mon, 29 Aug 2016 22:27:54 +0000 (+1000) Subject: Split up testHelpers.inc, break off fuzz testing X-Git-Tag: 1.31.0-rc.0~5683^2 X-Git-Url: https://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/comptes/journal.php?a=commitdiff_plain;h=a387fee3970b04a2fe955d5a443fa459deddcc19;p=lhc%2Fweb%2Fwiklou.git Split up testHelpers.inc, break off fuzz testing * Split up testHelpers.inc into one class per file, with the file named after the class per the usual convention. Put them in tests/parser since they are all parser-related, even though a couple are reused by other unit tests. * Also rename parserTest.inc and parserTestsParserHook.php to follow the usual convention, and split off ParserTestResultNormalizer * Move fuzz testing out to its own maintenance script. It's really not helpful to have fuzz testing, which is designed to run forever, exposed as a PHPUnit test. * Increased fuzz test memory limit, and increased the memory headroom for getMemoryBreakdown(), since HHVM's ReflectionClass has an internal cache which uses quite a lot of memory. * Temporarily switched a couple of ParserTest methods from private to public to support fuzz testing from a separate class -- I plan on replacing this interface in a subsequent commit. Change-Id: Ib1a07e109ec1005bff2751b78eb4de35f2dfc472 --- diff --git a/tests/TestsAutoLoader.php b/tests/TestsAutoLoader.php index 54882802cb..4858703b92 100644 --- a/tests/TestsAutoLoader.php +++ b/tests/TestsAutoLoader.php @@ -26,18 +26,6 @@ $testDir = __DIR__; $wgAutoloadClasses += [ - # tests - 'DbTestPreviewer' => "$testDir/testHelpers.inc", - 'DbTestRecorder' => "$testDir/testHelpers.inc", - 'DelayedParserTest' => "$testDir/testHelpers.inc", - 'ParserTestResult' => "$testDir/parser/ParserTestResult.php", - 'TestFileIterator' => "$testDir/testHelpers.inc", - 'TestFileDataProvider' => "$testDir/testHelpers.inc", - 'TestRecorder' => "$testDir/testHelpers.inc", - 'ITestRecorder' => "$testDir/testHelpers.inc", - 'DjVuSupport' => "$testDir/testHelpers.inc", - 'TidySupport' => "$testDir/testHelpers.inc", - # tests/phpunit 'MediaWikiTestCase' => "$testDir/phpunit/MediaWikiTestCase.php", 'MediaWikiPHPUnitTestListener' => "$testDir/phpunit/MediaWikiPHPUnitTestListener.php", @@ -142,11 +130,21 @@ $wgAutoloadClasses += [ 'DummySessionProvider' => "$testDir/phpunit/mocks/session/DummySessionProvider.php", # tests/parser - 'NewParserTest' => "$testDir/phpunit/includes/parser/NewParserTest.php", + 'DbTestPreviewer' => "$testDir/parser/DbTestPreviewer.php", + 'DbTestRecorder' => "$testDir/parser/DbTestRecorder.php", + 'DelayedParserTest' => "$testDir/parser/DelayedParserTest.php", + 'DjVuSupport' => "$testDir/parser/DjVuSupport.php", + 'ITestRecorder' => "$testDir/parser/ITestRecorder.php", 'MediaWikiParserTest' => "$testDir/phpunit/includes/parser/MediaWikiParserTest.php", - 'ParserTest' => "$testDir/parser/parserTest.inc", - 'ParserTestResultNormalizer' => "$testDir/parser/parserTest.inc", - 'ParserTestParserHook' => "$testDir/parser/parserTestsParserHook.php", + 'NewParserTest' => "$testDir/phpunit/includes/parser/NewParserTest.php", + 'ParserTest' => "$testDir/parser/ParserTest.php", + 'ParserTestParserHook' => "$testDir/parser/ParserTestParserHook.php", + 'ParserTestResult' => "$testDir/parser/ParserTestResult.php", + 'ParserTestResultNormalizer' => "$testDir/parser/ParserTestResultNormalizer.php", + 'TestFileDataProvider' => "$testDir/parser/TestFileDataProvider.php", + 'TestFileIterator' => "$testDir/parser/TestFileIterator.php", + 'TestRecorder' => "$testDir/parser/TestRecorder.php", + 'TidySupport' => "$testDir/parser/TidySupport.php", # tests/phpunit/includes/site 'SiteTest' => "$testDir/phpunit/includes/site/SiteTest.php", diff --git a/tests/parser/DbTestPreviewer.php b/tests/parser/DbTestPreviewer.php new file mode 100644 index 0000000000..2412254973 --- /dev/null +++ b/tests/parser/DbTestPreviewer.php @@ -0,0 +1,228 @@ +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(); + } +} + diff --git a/tests/parser/DbTestRecorder.php b/tests/parser/DbTestRecorder.php new file mode 100644 index 0000000000..26aef975e6 --- /dev/null +++ b/tests/parser/DbTestRecorder.php @@ -0,0 +1,84 @@ +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(); + } +} + diff --git a/tests/parser/DelayedParserTest.php b/tests/parser/DelayedParserTest.php new file mode 100644 index 0000000000..1c5c36bf0e --- /dev/null +++ b/tests/parser/DelayedParserTest.php @@ -0,0 +1,116 @@ +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; + } + +} + diff --git a/tests/parser/DjVuSupport.php b/tests/parser/DjVuSupport.php new file mode 100644 index 0000000000..4739be4e1a --- /dev/null +++ b/tests/parser/DjVuSupport.php @@ -0,0 +1,58 @@ + + * https://www.mediawiki.org/ + * + * 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 + * + * @todo Make this more independent of the configuration (and if possible the database) + * @todo document + * @file + * @ingroup Testing + */ +use MediaWiki\MediaWikiServices; + +/** + * @ingroup Testing + */ +class ParserTest { + /** + * @var bool $color whereas output should be colorized + */ + private $color; + + /** + * @var bool $showOutput Show test output + */ + private $showOutput; + + /** + * @var bool $useTemporaryTables Use temporary tables for the temporary database + */ + private $useTemporaryTables = true; + + /** + * @var bool $databaseSetupDone True if the database has been set up + */ + private $databaseSetupDone = false; + + /** + * Our connection to the database + * @var DatabaseBase + */ + private $db; + + /** + * Database clone helper + * @var CloneDatabase + */ + private $dbClone; + + /** + * @var DjVuSupport + */ + private $djVuSupport; + + /** + * @var TidySupport + */ + private $tidySupport; + + /** + * @var ITestRecorder + */ + private $recorder; + + private $uploadDir = null; + + public $regex = ""; + private $savedGlobals = []; + private $useDwdiff = false; + private $markWhitespace = false; + private $normalizationFunctions = []; + + /** + * Sets terminal colorization and diff/quick modes depending on OS and + * command-line options (--color and --quick). + * @param array $options + */ + public function __construct( $options = [] ) { + # Only colorize output if stdout is a terminal. + $this->color = !wfIsWindows() && Maintenance::posix_isatty( 1 ); + + if ( isset( $options['color'] ) ) { + switch ( $options['color'] ) { + case 'no': + $this->color = false; + break; + case 'yes': + default: + $this->color = true; + break; + } + } + + $this->term = $this->color + ? new AnsiTermColorer() + : new DummyTermColorer(); + + $this->showDiffs = !isset( $options['quick'] ); + $this->showProgress = !isset( $options['quiet'] ); + $this->showFailure = !( + isset( $options['quiet'] ) + && ( isset( $options['record'] ) + || isset( $options['compare'] ) ) ); // redundant output + + $this->showOutput = isset( $options['show-output'] ); + $this->useDwdiff = isset( $options['dwdiff'] ); + $this->markWhitespace = isset( $options['mark-ws'] ); + + if ( isset( $options['norm'] ) ) { + foreach ( explode( ',', $options['norm'] ) as $func ) { + if ( in_array( $func, [ 'removeTbody', 'trimWhitespace' ] ) ) { + $this->normalizationFunctions[] = $func; + } else { + echo "Warning: unknown normalization option \"$func\"\n"; + } + } + } + + if ( isset( $options['filter'] ) ) { + $options['regex'] = $options['filter']; + } + + if ( isset( $options['regex'] ) ) { + if ( isset( $options['record'] ) ) { + echo "Warning: --record cannot be used with --regex, disabling --record\n"; + unset( $options['record'] ); + } + $this->regex = $options['regex']; + } else { + # Matches anything + $this->regex = ''; + } + + $this->setupRecorder( $options ); + $this->keepUploads = isset( $options['keep-uploads'] ); + + if ( $this->keepUploads ) { + $this->uploadDir = wfTempDir() . '/mwParser-images'; + } else { + $this->uploadDir = wfTempDir() . "/mwParser-" . mt_rand() . "-images"; + } + + $this->runDisabled = isset( $options['run-disabled'] ); + $this->runParsoid = isset( $options['run-parsoid'] ); + + $this->djVuSupport = new DjVuSupport(); + $this->tidySupport = new TidySupport( isset( $options['use-tidy-config'] ) ); + if ( !$this->tidySupport->isEnabled() ) { + echo "Warning: tidy is not installed, skipping some tests\n"; + } + + $this->hooks = []; + $this->functionHooks = []; + $this->transparentHooks = []; + $this->setUp(); + } + + function setUp() { + global $wgParser, $wgParserConf, $IP, $messageMemc, $wgMemc, + $wgUser, $wgLang, $wgOut, $wgRequest, $wgStyleDirectory, + $wgExtraNamespaces, $wgNamespaceAliases, $wgNamespaceProtection, $wgLocalFileRepo, + $wgExtraInterlanguageLinkPrefixes, $wgLocalInterwikis, + $parserMemc, $wgThumbnailScriptPath, $wgScriptPath, $wgResourceBasePath, + $wgArticlePath, $wgScript, $wgStylePath, $wgExtensionAssetsPath, + $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType, $wgLockManagers; + + $wgScriptPath = ''; + $wgScript = '/index.php'; + $wgStylePath = '/skins'; + $wgResourceBasePath = ''; + $wgExtensionAssetsPath = '/extensions'; + $wgArticlePath = '/wiki/$1'; + $wgThumbnailScriptPath = false; + $wgLockManagers = [ [ + 'name' => 'fsLockManager', + 'class' => 'FSLockManager', + 'lockDirectory' => $this->uploadDir . '/lockdir', + ], [ + 'name' => 'nullLockManager', + 'class' => 'NullLockManager', + ] ]; + $wgLocalFileRepo = [ + 'class' => 'LocalRepo', + 'name' => 'local', + 'url' => 'http://example.com/images', + 'hashLevels' => 2, + 'transformVia404' => false, + 'backend' => new FSFileBackend( [ + 'name' => 'local-backend', + 'wikiId' => wfWikiID(), + 'containerPaths' => [ + 'local-public' => $this->uploadDir . '/public', + 'local-thumb' => $this->uploadDir . '/thumb', + 'local-temp' => $this->uploadDir . '/temp', + 'local-deleted' => $this->uploadDir . '/deleted', + ] + ] ) + ]; + $wgNamespaceProtection[NS_MEDIAWIKI] = 'editinterface'; + $wgNamespaceAliases['Image'] = NS_FILE; + $wgNamespaceAliases['Image_talk'] = NS_FILE_TALK; + # add a namespace shadowing a interwiki link, to test + # proper precedence when resolving links. (bug 51680) + $wgExtraNamespaces[100] = 'MemoryAlpha'; + $wgExtraNamespaces[101] = 'MemoryAlpha talk'; + + // XXX: tests won't run without this (for CACHE_DB) + if ( $wgMainCacheType === CACHE_DB ) { + $wgMainCacheType = CACHE_NONE; + } + if ( $wgMessageCacheType === CACHE_DB ) { + $wgMessageCacheType = CACHE_NONE; + } + if ( $wgParserCacheType === CACHE_DB ) { + $wgParserCacheType = CACHE_NONE; + } + + DeferredUpdates::clearPendingUpdates(); + $wgMemc = wfGetMainCache(); // checks $wgMainCacheType + $messageMemc = wfGetMessageCacheStorage(); + $parserMemc = wfGetParserCacheStorage(); + + RequestContext::resetMain(); + $context = new RequestContext; + $wgUser = new User; + $wgLang = $context->getLanguage(); + $wgOut = $context->getOutput(); + $wgRequest = $context->getRequest(); + $wgParser = new StubObject( 'wgParser', $wgParserConf['class'], [ $wgParserConf ] ); + + if ( $wgStyleDirectory === false ) { + $wgStyleDirectory = "$IP/skins"; + } + + self::setupInterwikis(); + $wgLocalInterwikis = [ 'local', 'mi' ]; + // "extra language links" + // see https://gerrit.wikimedia.org/r/111390 + array_push( $wgExtraInterlanguageLinkPrefixes, 'mul' ); + + // Reset namespace cache + MWNamespace::getCanonicalNamespaces( true ); + Language::factory( 'en' )->resetNamespaces(); + } + + /** + * Insert hardcoded interwiki in the lookup table. + * + * This function insert a set of well known interwikis that are used in + * the parser tests. They can be considered has fixtures are injected in + * the interwiki cache by using the 'InterwikiLoadPrefix' hook. + * Since we are not interested in looking up interwikis in the database, + * the hook completely replace the existing mechanism (hook returns false). + */ + public static function setupInterwikis() { + # Hack: insert a few Wikipedia in-project interwiki prefixes, + # for testing inter-language links + Hooks::register( 'InterwikiLoadPrefix', function ( $prefix, &$iwData ) { + static $testInterwikis = [ + 'local' => [ + 'iw_url' => 'http://doesnt.matter.org/$1', + 'iw_api' => '', + 'iw_wikiid' => '', + 'iw_local' => 0 ], + 'wikipedia' => [ + 'iw_url' => 'http://en.wikipedia.org/wiki/$1', + 'iw_api' => '', + 'iw_wikiid' => '', + 'iw_local' => 0 ], + 'meatball' => [ + 'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1', + 'iw_api' => '', + 'iw_wikiid' => '', + 'iw_local' => 0 ], + 'memoryalpha' => [ + 'iw_url' => 'http://www.memory-alpha.org/en/index.php/$1', + 'iw_api' => '', + 'iw_wikiid' => '', + 'iw_local' => 0 ], + 'zh' => [ + 'iw_url' => 'http://zh.wikipedia.org/wiki/$1', + 'iw_api' => '', + 'iw_wikiid' => '', + 'iw_local' => 1 ], + 'es' => [ + 'iw_url' => 'http://es.wikipedia.org/wiki/$1', + 'iw_api' => '', + 'iw_wikiid' => '', + 'iw_local' => 1 ], + 'fr' => [ + 'iw_url' => 'http://fr.wikipedia.org/wiki/$1', + 'iw_api' => '', + 'iw_wikiid' => '', + 'iw_local' => 1 ], + 'ru' => [ + 'iw_url' => 'http://ru.wikipedia.org/wiki/$1', + 'iw_api' => '', + 'iw_wikiid' => '', + 'iw_local' => 1 ], + 'mi' => [ + 'iw_url' => 'http://mi.wikipedia.org/wiki/$1', + 'iw_api' => '', + 'iw_wikiid' => '', + 'iw_local' => 1 ], + 'mul' => [ + 'iw_url' => 'http://wikisource.org/wiki/$1', + 'iw_api' => '', + 'iw_wikiid' => '', + 'iw_local' => 1 ], + ]; + if ( array_key_exists( $prefix, $testInterwikis ) ) { + $iwData = $testInterwikis[$prefix]; + } + + // We only want to rely on the above fixtures + return false; + } );// hooks::register + } + + /** + * Remove the hardcoded interwiki lookup table. + */ + public static function tearDownInterwikis() { + Hooks::clear( 'InterwikiLoadPrefix' ); + } + + /** + * Reset the Title-related services that need resetting + * for each test + */ + public static function resetTitleServices() { + $services = MediaWikiServices::getInstance(); + $services->resetServiceForTesting( 'TitleFormatter' ); + $services->resetServiceForTesting( 'TitleParser' ); + $services->resetServiceForTesting( '_MediaWikiTitleCodec' ); + $services->resetServiceForTesting( 'LinkRenderer' ); + $services->resetServiceForTesting( 'LinkRendererFactory' ); + } + + public function setupRecorder( $options ) { + if ( isset( $options['record'] ) ) { + $this->recorder = new DbTestRecorder( $this ); + $this->recorder->version = isset( $options['setversion'] ) ? + $options['setversion'] : SpecialVersion::getVersion(); + } elseif ( isset( $options['compare'] ) ) { + $this->recorder = new DbTestPreviewer( $this ); + } else { + $this->recorder = new TestRecorder( $this ); + } + } + + /** + * Remove last character if it is a newline + * @group utility + * @param string $s + * @return string + */ + public static 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 files. + * 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 array $filenames Array of strings + * @return bool True if passed all tests, false if any tests failed. + */ + public function runTestsFromFiles( $filenames ) { + $ok = false; + + // be sure, ParserTest::addArticle has correct language set, + // so that system messages gets into the right language cache + $GLOBALS['wgLanguageCode'] = 'en'; + $GLOBALS['wgContLang'] = Language::factory( 'en' ); + + $this->recorder->start(); + try { + $this->setupDatabase(); + $ok = true; + + foreach ( $filenames as $filename ) { + echo "Running parser tests from: $filename\n"; + $tests = new TestFileIterator( $filename, $this ); + $ok = $this->runTests( $tests ) && $ok; + } + + $this->teardownDatabase(); + $this->recorder->report(); + } catch ( DBError $e ) { + echo $e->getMessage(); + } + $this->recorder->end(); + + return $ok; + } + + function runTests( $tests ) { + $ok = true; + + foreach ( $tests as $t ) { + $result = + $this->runTest( $t['test'], $t['input'], $t['result'], $t['options'], $t['config'] ); + $ok = $ok && $result; + $this->recorder->record( $t['test'], $t['subtest'], $result ); + } + + if ( $this->showProgress ) { + print "\n"; + } + + return $ok; + } + + /** + * Get a Parser object + * + * @param string $preprocessor + * @return Parser + */ + function getParser( $preprocessor = null ) { + global $wgParserConf; + + $class = $wgParserConf['class']; + $parser = new $class( [ 'preprocessorClass' => $preprocessor ] + $wgParserConf ); + + foreach ( $this->hooks as $tag => $callback ) { + $parser->setHook( $tag, $callback ); + } + + foreach ( $this->functionHooks as $tag => $bits ) { + list( $callback, $flags ) = $bits; + $parser->setFunctionHook( $tag, $callback, $flags ); + } + + foreach ( $this->transparentHooks as $tag => $callback ) { + $parser->setTransparentTagHook( $tag, $callback ); + } + + Hooks::run( 'ParserTestParser', [ &$parser ] ); + + return $parser; + } + + /** + * 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 $desc Test's description + * @param string $input Wikitext to try rendering + * @param string $result Result to output + * @param array $opts Test's options + * @param string $config Overrides for global variables, one per line + * @return bool + */ + public function runTest( $desc, $input, $result, $opts, $config ) { + if ( $this->showProgress ) { + $this->showTesting( $desc ); + } + + $opts = $this->parseOptions( $opts ); + $context = $this->setupGlobals( $opts, $config ); + + $user = $context->getUser(); + $options = ParserOptions::newFromContext( $context ); + + if ( isset( $opts['djvu'] ) ) { + if ( !$this->djVuSupport->isEnabled() ) { + return $this->showSkipped(); + } + } + + if ( isset( $opts['tidy'] ) ) { + if ( !$this->tidySupport->isEnabled() ) { + return $this->showSkipped(); + } else { + $options->setTidy( true ); + } + } + + if ( isset( $opts['title'] ) ) { + $titleText = $opts['title']; + } else { + $titleText = 'Parser test'; + } + + ObjectCache::getMainWANInstance()->clearProcessCache(); + $local = isset( $opts['local'] ); + $preprocessor = isset( $opts['preprocessor'] ) ? $opts['preprocessor'] : null; + $parser = $this->getParser( $preprocessor ); + $title = Title::newFromText( $titleText ); + + if ( isset( $opts['pst'] ) ) { + $out = $parser->preSaveTransform( $input, $title, $user, $options ); + } elseif ( isset( $opts['msg'] ) ) { + $out = $parser->transformMsg( $input, $options, $title ); + } elseif ( isset( $opts['section'] ) ) { + $section = $opts['section']; + $out = $parser->getSection( $input, $section ); + } elseif ( isset( $opts['replace'] ) ) { + $section = $opts['replace'][0]; + $replace = $opts['replace'][1]; + $out = $parser->replaceSection( $input, $section, $replace ); + } elseif ( isset( $opts['comment'] ) ) { + $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 ); + $output->setTOCEnabled( !isset( $opts['notoc'] ) ); + $out = $output->getText(); + if ( isset( $opts['tidy'] ) ) { + $out = preg_replace( '/\s+$/', '', $out ); + } + + if ( isset( $opts['showtitle'] ) ) { + if ( $output->getTitleText() ) { + $title = $output->getTitleText(); + } + + $out = "$title\n$out"; + } + + if ( isset( $opts['showindicators'] ) ) { + $indicators = ''; + foreach ( $output->getIndicators() as $id => $content ) { + $indicators .= "$id=$content\n"; + } + $out = $indicators . $out; + } + + if ( isset( $opts['ill'] ) ) { + $out = implode( ' ', $output->getLanguageLinks() ); + } elseif ( isset( $opts['cat'] ) ) { + $outputPage = $context->getOutput(); + $outputPage->addCategoryLinks( $output->getCategories() ); + $cats = $outputPage->getCategoryLinks(); + + if ( isset( $cats['normal'] ) ) { + $out = implode( ' ', $cats['normal'] ); + } else { + $out = ''; + } + } + } + + $this->teardownGlobals(); + + if ( count( $this->normalizationFunctions ) ) { + $result = ParserTestResultNormalizer::normalize( $result, $this->normalizationFunctions ); + $out = ParserTestResultNormalizer::normalize( $out, $this->normalizationFunctions ); + } + + $testResult = new ParserTestResult( $desc ); + $testResult->expected = $result; + $testResult->actual = $out; + + return $this->showTestResult( $testResult ); + } + + /** + * Refactored in 1.22 to use ParserTestResult + * @param ParserTestResult $testResult + * @return bool + */ + function showTestResult( ParserTestResult $testResult ) { + if ( $testResult->isSuccess() ) { + $this->showSuccess( $testResult ); + return true; + } else { + $this->showFailure( $testResult ); + return false; + } + } + + /** + * Use a regex to find out the value of an option + * @param string $key Name of option val to retrieve + * @param array $opts Options array to look in + * @param mixed $default Default value returned if not found + * @return mixed + */ + private static function getOptionValue( $key, $opts, $default ) { + $key = strtolower( $key ); + + if ( isset( $opts[$key] ) ) { + return $opts[$key]; + } else { + return $default; + } + } + + private function parseOptions( $instring ) { + $opts = []; + // foo + // foo=bar + // foo="bar baz" + // foo=[[bar baz]] + // foo=bar,"baz quux" + // foo={...json...} + $defs = '(?(DEFINE) + (? # Quoted string + " + (?:[^\\\\"] | \\\\.)* + " + ) + (? + \{ # Open bracket + (?: + [^"{}] | # Not a quoted string or object, or + (?&qstr) | # A quoted string, or + (?&json) # A json object (recursively) + )* + \} # Close bracket + ) + (? + (?: + (?&qstr) # Quoted val + | + \[\[ + [^]]* # Link target + \]\] + | + [\w-]+ # Plain word + | + (?&json) # JSON object + ) + ) + )'; + $regex = '/' . $defs . '\b + (?[\w-]+) # Key + \b + (?:\s* + = # First sub-value + \s* + (? + (?&value) + (?:\s* + , # Sub-vals 1..N + \s* + (?&value) + )* + ) + )? + /x'; + $valueregex = '/' . $defs . '(?&value)/x'; + + if ( preg_match_all( $regex, $instring, $matches, PREG_SET_ORDER ) ) { + foreach ( $matches as $bits ) { + $key = strtolower( $bits['k'] ); + if ( !isset( $bits['v'] ) ) { + $opts[$key] = true; + } else { + preg_match_all( $valueregex, $bits['v'], $vmatches ); + $opts[$key] = array_map( [ $this, 'cleanupOption' ], $vmatches[0] ); + if ( count( $opts[$key] ) == 1 ) { + $opts[$key] = $opts[$key][0]; + } + } + } + } + return $opts; + } + + private function cleanupOption( $opt ) { + if ( substr( $opt, 0, 1 ) == '"' ) { + return stripcslashes( substr( $opt, 1, -1 ) ); + } + + if ( substr( $opt, 0, 2 ) == '[[' ) { + return substr( $opt, 2, -2 ); + } + + if ( substr( $opt, 0, 1 ) == '{' ) { + return FormatJson::decode( $opt, true ); + } + return $opt; + } + + /** + * Set up the global variables for a consistent environment for each test. + * Ideally this should replace the global configuration entirely. + * @param string $opts + * @param string $config + * @return RequestContext + */ + public function setupGlobals( $opts = '', $config = '' ) { + # Find out values for some special options. + $lang = + self::getOptionValue( 'language', $opts, 'en' ); + $variant = + self::getOptionValue( 'variant', $opts, false ); + $maxtoclevel = + self::getOptionValue( 'wgMaxTocLevel', $opts, 999 ); + $linkHolderBatchSize = + self::getOptionValue( 'wgLinkHolderBatchSize', $opts, 1000 ); + + $settings = [ + 'wgServer' => 'http://example.org', + 'wgServerName' => 'example.org', + 'wgScript' => '/index.php', + 'wgScriptPath' => '', + 'wgArticlePath' => '/wiki/$1', + 'wgActionPaths' => [], + 'wgLockManagers' => [ [ + 'name' => 'fsLockManager', + 'class' => 'FSLockManager', + 'lockDirectory' => $this->uploadDir . '/lockdir', + ], [ + 'name' => 'nullLockManager', + 'class' => 'NullLockManager', + ] ], + 'wgLocalFileRepo' => [ + 'class' => 'LocalRepo', + 'name' => 'local', + 'url' => 'http://example.com/images', + 'hashLevels' => 2, + 'transformVia404' => false, + 'backend' => new FSFileBackend( [ + 'name' => 'local-backend', + 'wikiId' => wfWikiID(), + 'containerPaths' => [ + 'local-public' => $this->uploadDir, + 'local-thumb' => $this->uploadDir . '/thumb', + 'local-temp' => $this->uploadDir . '/temp', + 'local-deleted' => $this->uploadDir . '/delete', + ] + ] ) + ], + 'wgEnableUploads' => self::getOptionValue( 'wgEnableUploads', $opts, true ), + 'wgUploadNavigationUrl' => false, + 'wgStylePath' => '/skins', + 'wgSitename' => 'MediaWiki', + 'wgLanguageCode' => $lang, + 'wgDBprefix' => $this->db->getType() != 'oracle' ? 'parsertest_' : 'pt_', + 'wgRawHtml' => self::getOptionValue( 'wgRawHtml', $opts, false ), + 'wgLang' => null, + 'wgContLang' => null, + 'wgNamespacesWithSubpages' => [ 0 => isset( $opts['subpage'] ) ], + 'wgMaxTocLevel' => $maxtoclevel, + 'wgCapitalLinks' => true, + 'wgNoFollowLinks' => true, + 'wgNoFollowDomainExceptions' => [ 'no-nofollow.org' ], + 'wgThumbnailScriptPath' => false, + 'wgUseImageResize' => true, + 'wgSVGConverter' => 'null', + 'wgSVGConverters' => [ 'null' => 'echo "1">$output' ], + 'wgLocaltimezone' => 'UTC', + 'wgAllowExternalImages' => self::getOptionValue( 'wgAllowExternalImages', $opts, true ), + 'wgThumbLimits' => [ self::getOptionValue( 'thumbsize', $opts, 180 ) ], + 'wgDefaultLanguageVariant' => $variant, + 'wgVariantArticlePath' => false, + 'wgGroupPermissions' => [ '*' => [ + 'createaccount' => true, + 'read' => true, + 'edit' => true, + 'createpage' => true, + 'createtalk' => true, + ] ], + 'wgNamespaceProtection' => [ NS_MEDIAWIKI => 'editinterface' ], + 'wgDefaultExternalStore' => [], + 'wgForeignFileRepos' => [], + 'wgLinkHolderBatchSize' => $linkHolderBatchSize, + 'wgExperimentalHtmlIds' => false, + 'wgExternalLinkTarget' => false, + 'wgHtml5' => true, + 'wgAdaptiveMessageCache' => true, + 'wgDisableLangConversion' => false, + 'wgDisableTitleConversion' => false, + // Tidy options. + 'wgUseTidy' => false, + 'wgTidyConfig' => isset( $opts['tidy'] ) ? $this->tidySupport->getConfig() : null + ]; + + if ( $config ) { + $configLines = explode( "\n", $config ); + + foreach ( $configLines as $line ) { + list( $var, $value ) = explode( '=', $line, 2 ); + + $settings[$var] = eval( "return $value;" ); + } + } + + $this->savedGlobals = []; + + /** @since 1.20 */ + Hooks::run( 'ParserTestGlobals', [ &$settings ] ); + + foreach ( $settings as $var => $val ) { + if ( array_key_exists( $var, $GLOBALS ) ) { + $this->savedGlobals[$var] = $GLOBALS[$var]; + } + + $GLOBALS[$var] = $val; + } + + // Must be set before $context as user language defaults to $wgContLang + $GLOBALS['wgContLang'] = Language::factory( $lang ); + $GLOBALS['wgMemc'] = new EmptyBagOStuff; + + RequestContext::resetMain(); + $context = RequestContext::getMain(); + $GLOBALS['wgLang'] = $context->getLanguage(); + $GLOBALS['wgOut'] = $context->getOutput(); + $GLOBALS['wgUser'] = $context->getUser(); + + // We (re)set $wgThumbLimits to a single-element array above. + $context->getUser()->setOption( 'thumbsize', 0 ); + + global $wgHooks; + + $wgHooks['ParserTestParser'][] = 'ParserTestParserHook::setup'; + $wgHooks['ParserGetVariableValueTs'][] = 'ParserTest::getFakeTimestamp'; + + MagicWord::clearCache(); + MWTidy::destroySingleton(); + RepoGroup::destroySingleton(); + + self::resetTitleServices(); + + return $context; + } + + /** + * List of temporary tables to create, without prefix. + * Some of these probably aren't necessary. + * @return array + */ + private function listTables() { + $tables = [ 'user', 'user_properties', 'user_former_groups', 'page', 'page_restrictions', + 'protected_titles', 'revision', 'text', 'pagelinks', 'imagelinks', + 'categorylinks', 'templatelinks', 'externallinks', 'langlinks', 'iwlinks', + 'site_stats', 'ipblocks', 'image', 'oldimage', + 'recentchanges', 'watchlist', 'interwiki', 'logging', 'log_search', + 'querycache', 'objectcache', 'job', 'l10n_cache', 'redirect', 'querycachetwo', + 'archive', 'user_groups', 'page_props', 'category' + ]; + + if ( in_array( $this->db->getType(), [ 'mysql', 'sqlite', 'oracle' ] ) ) { + array_push( $tables, 'searchindex' ); + } + + // Allow extensions to add to the list of tables to duplicate; + // may be necessary if they hook into page save or other code + // which will require them while running tests. + Hooks::run( 'ParserTestTables', [ &$tables ] ); + + return $tables; + } + + /** + * 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. + */ + public function setupDatabase() { + global $wgDBprefix; + + if ( $this->databaseSetupDone ) { + return; + } + + $this->db = wfGetDB( DB_MASTER ); + $dbType = $this->db->getType(); + + if ( $wgDBprefix === 'parsertest_' || ( $dbType == 'oracle' && $wgDBprefix === 'pt_' ) ) { + throw new MWException( 'setupDatabase should be called before setupGlobals' ); + } + + $this->databaseSetupDone = true; + + # SqlBagOStuff broke when using temporary tables on r40209 (bug 15892). + # It seems to have been fixed since (r55079?), but regressed at some point before r85701. + # This works around it for now... + ObjectCache::$instances[CACHE_DB] = new HashBagOStuff; + + # CREATE TEMPORARY TABLE breaks if there is more than one server + if ( wfGetLB()->getServerCount() != 1 ) { + $this->useTemporaryTables = false; + } + + $temporary = $this->useTemporaryTables || $dbType == 'postgres'; + $prefix = $dbType != 'oracle' ? 'parsertest_' : 'pt_'; + + $this->dbClone = new CloneDatabase( $this->db, $this->listTables(), $prefix ); + $this->dbClone->useTemporaryTables( $temporary ); + $this->dbClone->cloneTableStructure(); + + if ( $dbType == 'oracle' ) { + $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' ); + # Insert 0 user to prevent FK violations + + # Anonymous user + $this->db->insert( 'user', [ + 'user_id' => 0, + 'user_name' => 'Anonymous' ] ); + } + + # Update certain things in site_stats + $this->db->insert( 'site_stats', + [ 'ss_row_id' => 1, 'ss_images' => 2, 'ss_good_articles' => 1 ] ); + + # Reinitialise the LocalisationCache to match the database state + Language::getLocalisationCache()->unloadAll(); + + # Clear the message cache + MessageCache::singleton()->clear(); + + // Remember to update newParserTests.php after changing the below + // (and it uses a slightly different syntax just for teh lulz) + $this->setupUploadDir(); + $user = User::createNew( 'WikiSysop' ); + $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Foobar.jpg' ) ); + # note that the size/width/height/bits/etc of the file + # are actually set by inspecting the file itself; the arguments + # to recordUpload2 have no effect. That said, we try to make things + # match up so it is less confusing to readers of the code & tests. + $image->recordUpload2( '', 'Upload of some lame file', 'Some lame file', [ + 'size' => 7881, + 'width' => 1941, + 'height' => 220, + 'bits' => 8, + 'media_type' => MEDIATYPE_BITMAP, + 'mime' => 'image/jpeg', + 'metadata' => serialize( [] ), + 'sha1' => Wikimedia\base_convert( '1', 16, 36, 31 ), + 'fileExists' => true + ], $this->db->timestamp( '20010115123500' ), $user ); + + $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Thumb.png' ) ); + # again, note that size/width/height below are ignored; see above. + $image->recordUpload2( '', 'Upload of some lame thumbnail', 'Some lame thumbnail', [ + 'size' => 22589, + 'width' => 135, + 'height' => 135, + 'bits' => 8, + 'media_type' => MEDIATYPE_BITMAP, + 'mime' => 'image/png', + 'metadata' => serialize( [] ), + 'sha1' => Wikimedia\base_convert( '2', 16, 36, 31 ), + 'fileExists' => true + ], $this->db->timestamp( '20130225203040' ), $user ); + + $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Foobar.svg' ) ); + $image->recordUpload2( '', 'Upload of some lame SVG', 'Some lame SVG', [ + 'size' => 12345, + 'width' => 240, + 'height' => 180, + 'bits' => 0, + 'media_type' => MEDIATYPE_DRAWING, + 'mime' => 'image/svg+xml', + 'metadata' => serialize( [] ), + 'sha1' => Wikimedia\base_convert( '', 16, 36, 31 ), + 'fileExists' => true + ], $this->db->timestamp( '20010115123500' ), $user ); + + # This image will be blacklisted in [[MediaWiki:Bad image list]] + $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Bad.jpg' ) ); + $image->recordUpload2( '', 'zomgnotcensored', 'Borderline image', [ + 'size' => 12345, + 'width' => 320, + 'height' => 240, + 'bits' => 24, + 'media_type' => MEDIATYPE_BITMAP, + 'mime' => 'image/jpeg', + 'metadata' => serialize( [] ), + 'sha1' => Wikimedia\base_convert( '3', 16, 36, 31 ), + 'fileExists' => true + ], $this->db->timestamp( '20010115123500' ), $user ); + + $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Video.ogv' ) ); + $image->recordUpload2( '', 'A pretty movie', 'Will it play', [ + 'size' => 12345, + 'width' => 320, + 'height' => 240, + 'bits' => 0, + 'media_type' => MEDIATYPE_VIDEO, + 'mime' => 'application/ogg', + 'metadata' => serialize( [] ), + 'sha1' => Wikimedia\base_convert( '', 16, 36, 31 ), + 'fileExists' => true + ], $this->db->timestamp( '20010115123500' ), $user ); + + $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Audio.oga' ) ); + $image->recordUpload2( '', 'An awesome hitsong', 'Will it play', [ + 'size' => 12345, + 'width' => 0, + 'height' => 0, + 'bits' => 0, + 'media_type' => MEDIATYPE_AUDIO, + 'mime' => 'application/ogg', + 'metadata' => serialize( [] ), + 'sha1' => Wikimedia\base_convert( '', 16, 36, 31 ), + 'fileExists' => true + ], $this->db->timestamp( '20010115123500' ), $user ); + + # A DjVu file + $image = wfLocalFile( Title::makeTitle( NS_FILE, 'LoremIpsum.djvu' ) ); + $image->recordUpload2( '', 'Upload a DjVu', 'A DjVu', [ + 'size' => 3249, + 'width' => 2480, + 'height' => 3508, + 'bits' => 0, + 'media_type' => MEDIATYPE_BITMAP, + 'mime' => 'image/vnd.djvu', + 'metadata' => ' + + + + + + + + + + + + + + + + + + + + + + + + +', + 'sha1' => Wikimedia\base_convert( '', 16, 36, 31 ), + 'fileExists' => true + ], $this->db->timestamp( '20010115123600' ), $user ); + } + + public function teardownDatabase() { + if ( !$this->databaseSetupDone ) { + $this->teardownGlobals(); + return; + } + $this->teardownUploadDir( $this->uploadDir ); + + $this->dbClone->destroy(); + $this->databaseSetupDone = false; + + if ( $this->useTemporaryTables ) { + if ( $this->db->getType() == 'sqlite' ) { + # Under SQLite the searchindex table is virtual and need + # to be explicitly destroyed. See bug 29912 + # See also MediaWikiTestCase::destroyDB() + wfDebug( __METHOD__ . " explicitly destroying sqlite virtual table parsertest_searchindex\n" ); + $this->db->query( "DROP TABLE `parsertest_searchindex`" ); + } + # Don't need to do anything + $this->teardownGlobals(); + return; + } + + $tables = $this->listTables(); + + foreach ( $tables as $table ) { + if ( $this->db->getType() == 'oracle' ) { + $this->db->query( "DROP TABLE pt_$table DROP CONSTRAINTS" ); + } else { + $this->db->query( "DROP TABLE `parsertest_$table`" ); + } + } + + if ( $this->db->getType() == 'oracle' ) { + $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' ); + } + + $this->teardownGlobals(); + } + + /** + * Create a dummy uploads directory which will contain a couple + * of files in order to pass existence tests. + * + * @return string The directory + */ + private function setupUploadDir() { + global $IP; + + $dir = $this->uploadDir; + if ( $this->keepUploads && is_dir( $dir ) ) { + return; + } + + // wfDebug( "Creating upload directory $dir\n" ); + if ( file_exists( $dir ) ) { + wfDebug( "Already exists!\n" ); + return; + } + + wfMkdirParents( $dir . '/3/3a', null, __METHOD__ ); + copy( "$IP/tests/phpunit/data/parser/headbg.jpg", "$dir/3/3a/Foobar.jpg" ); + wfMkdirParents( $dir . '/e/ea', null, __METHOD__ ); + copy( "$IP/tests/phpunit/data/parser/wiki.png", "$dir/e/ea/Thumb.png" ); + wfMkdirParents( $dir . '/0/09', null, __METHOD__ ); + copy( "$IP/tests/phpunit/data/parser/headbg.jpg", "$dir/0/09/Bad.jpg" ); + wfMkdirParents( $dir . '/f/ff', null, __METHOD__ ); + file_put_contents( "$dir/f/ff/Foobar.svg", + '' . + '' ); + wfMkdirParents( $dir . '/5/5f', null, __METHOD__ ); + copy( "$IP/tests/phpunit/data/parser/LoremIpsum.djvu", "$dir/5/5f/LoremIpsum.djvu" ); + wfMkdirParents( $dir . '/0/00', null, __METHOD__ ); + copy( "$IP/tests/phpunit/data/parser/320x240.ogv", "$dir/0/00/Video.ogv" ); + wfMkdirParents( $dir . '/4/41', null, __METHOD__ ); + copy( "$IP/tests/phpunit/data/media/say-test.ogg", "$dir/4/41/Audio.oga" ); + + return; + } + + /** + * Restore default values and perform any necessary clean-up + * after each test runs. + */ + public function teardownGlobals() { + RepoGroup::destroySingleton(); + FileBackendGroup::destroySingleton(); + LockManagerGroup::destroySingletons(); + LinkCache::singleton()->clear(); + MWTidy::destroySingleton(); + + foreach ( $this->savedGlobals as $var => $val ) { + $GLOBALS[$var] = $val; + } + } + + /** + * Remove the dummy uploads directory + * @param string $dir + */ + private function teardownUploadDir( $dir ) { + if ( $this->keepUploads ) { + return; + } + + // delete the files first, then the dirs. + self::deleteFiles( + [ + "$dir/3/3a/Foobar.jpg", + "$dir/thumb/3/3a/Foobar.jpg/*.jpg", + "$dir/e/ea/Thumb.png", + "$dir/0/09/Bad.jpg", + "$dir/5/5f/LoremIpsum.djvu", + "$dir/thumb/5/5f/LoremIpsum.djvu/*-LoremIpsum.djvu.jpg", + "$dir/f/ff/Foobar.svg", + "$dir/thumb/f/ff/Foobar.svg/*-Foobar.svg.png", + "$dir/math/f/a/5/fa50b8b616463173474302ca3e63586b.png", + "$dir/0/00/Video.ogv", + "$dir/thumb/0/00/Video.ogv/120px--Video.ogv.jpg", + "$dir/thumb/0/00/Video.ogv/180px--Video.ogv.jpg", + "$dir/thumb/0/00/Video.ogv/240px--Video.ogv.jpg", + "$dir/thumb/0/00/Video.ogv/320px--Video.ogv.jpg", + "$dir/thumb/0/00/Video.ogv/270px--Video.ogv.jpg", + "$dir/thumb/0/00/Video.ogv/320px-seek=2-Video.ogv.jpg", + "$dir/thumb/0/00/Video.ogv/320px-seek=3.3666666666667-Video.ogv.jpg", + "$dir/4/41/Audio.oga", + ] + ); + + self::deleteDirs( + [ + "$dir/3/3a", + "$dir/3", + "$dir/thumb/3/3a/Foobar.jpg", + "$dir/thumb/3/3a", + "$dir/thumb/3", + "$dir/e/ea", + "$dir/e", + "$dir/f/ff/", + "$dir/f/", + "$dir/thumb/f/ff/Foobar.svg", + "$dir/thumb/f/ff/", + "$dir/thumb/f/", + "$dir/0/00/", + "$dir/0/09/", + "$dir/0/", + "$dir/5/5f", + "$dir/5", + "$dir/thumb/0/00/Video.ogv", + "$dir/thumb/0/00", + "$dir/thumb/0", + "$dir/thumb/5/5f/LoremIpsum.djvu", + "$dir/thumb/5/5f", + "$dir/thumb/5", + "$dir/thumb", + "$dir/4/41", + "$dir/4", + "$dir/math/f/a/5", + "$dir/math/f/a", + "$dir/math/f", + "$dir/math", + "$dir/lockdir", + "$dir", + ] + ); + } + + /** + * Delete the specified files, if they exist. + * @param array $files Full paths to files to delete. + */ + private static function deleteFiles( $files ) { + foreach ( $files as $pattern ) { + foreach ( glob( $pattern ) as $file ) { + if ( file_exists( $file ) ) { + unlink( $file ); + } + } + } + } + + /** + * Delete the specified directories, if they exist. Must be empty. + * @param array $dirs Full paths to directories to delete. + */ + private static function deleteDirs( $dirs ) { + foreach ( $dirs as $dir ) { + if ( is_dir( $dir ) ) { + rmdir( $dir ); + } + } + } + + /** + * "Running test $desc..." + * @param string $desc + */ + protected function showTesting( $desc ) { + print "Running test $desc... "; + } + + /** + * Print a happy success message. + * + * Refactored in 1.22 to use ParserTestResult + * + * @param ParserTestResult $testResult + * @return bool + */ + protected function showSuccess( ParserTestResult $testResult ) { + if ( $this->showProgress ) { + print $this->term->color( '1;32' ) . 'PASSED' . $this->term->reset() . "\n"; + } + + return true; + } + + /** + * Print a failure message and provide some explanatory output + * about what went wrong if so configured. + * + * Refactored in 1.22 to use ParserTestResult + * + * @param ParserTestResult $testResult + * @return bool + */ + protected function showFailure( ParserTestResult $testResult ) { + if ( $this->showFailure ) { + if ( !$this->showProgress ) { + # In quiet mode we didn't show the 'Testing' message before the + # test, in case it succeeded. Show it now: + $this->showTesting( $testResult->description ); + } + + print $this->term->color( '31' ) . 'FAILED!' . $this->term->reset() . "\n"; + + if ( $this->showOutput ) { + print "--- Expected ---\n{$testResult->expected}\n"; + print "--- Actual ---\n{$testResult->actual}\n"; + } + + if ( $this->showDiffs ) { + print $this->quickDiff( $testResult->expected, $testResult->actual ); + if ( !$this->wellFormed( $testResult->actual ) ) { + print "XML error: $this->mXmlError\n"; + } + } + } + + return false; + } + + /** + * Print a skipped message. + * + * @return bool + */ + protected function showSkipped() { + if ( $this->showProgress ) { + print $this->term->color( '1;33' ) . 'SKIPPED' . $this->term->reset() . "\n"; + } + + return true; + } + + /** + * 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 + */ + protected function quickDiff( $input, $output, + $inFileTail = 'expected', $outFileTail = 'actual' + ) { + if ( $this->markWhitespace ) { + $pairs = [ + "\n" => '¶', + ' ' => '·', + "\t" => '→' + ]; + $input = strtr( $input, $pairs ); + $output = strtr( $output, $pairs ); + } + + # Windows, or at least the fc utility, is retarded + $slash = wfIsWindows() ? '\\' : '/'; + $prefix = wfTempDir() . "{$slash}mwParser-" . mt_rand(); + + $infile = "$prefix-$inFileTail"; + $this->dumpToFile( $input, $infile ); + + $outfile = "$prefix-$outFileTail"; + $this->dumpToFile( $output, $outfile ); + + $shellInfile = wfEscapeShellArg( $infile ); + $shellOutfile = wfEscapeShellArg( $outfile ); + + global $wgDiff3; + // we assume that people with diff3 also have usual diff + if ( $this->useDwdiff ) { + $shellCommand = 'dwdiff -Pc'; + } else { + $shellCommand = ( wfIsWindows() && !$wgDiff3 ) ? 'fc' : 'diff -au'; + } + + $diff = wfShellExec( "$shellCommand $shellInfile $shellOutfile" ); + + unlink( $infile ); + unlink( $outfile ); + + if ( $this->useDwdiff ) { + return $diff; + } else { + return $this->colorDiff( $diff ); + } + } + + /** + * Write the given string to a file, adding a final newline. + * + * @param string $data + * @param string $filename + */ + private function dumpToFile( $data, $filename ) { + $file = fopen( $filename, "wt" ); + fwrite( $file, $data . "\n" ); + fclose( $file ); + } + + /** + * Colorize unified diff output if set for ANSI color output. + * Subtractions are colored blue, additions red. + * + * @param string $text + * @return string + */ + protected function colorDiff( $text ) { + return preg_replace( + [ '/^(-.*)$/m', '/^(\+.*)$/m' ], + [ $this->term->color( 34 ) . '$1' . $this->term->reset(), + $this->term->color( 31 ) . '$1' . $this->term->reset() ], + $text ); + } + + /** + * Show "Reading tests from ..." + * + * @param string $path + */ + public function showRunFile( $path ) { + print $this->term->color( 1 ) . + "Reading tests from \"$path\"..." . + $this->term->reset() . + "\n"; + } + + /** + * Insert a temporary test article + * @param string $name The title, including any prefix + * @param string $text The article text + * @param int|string $line The input line number, for reporting errors + * @param bool|string $ignoreDuplicate Whether to silently ignore duplicate pages + * @throws Exception + * @throws MWException + */ + public static function addArticle( $name, $text, $line = 'unknown', $ignoreDuplicate = '' ) { + global $wgCapitalLinks; + + $oldCapitalLinks = $wgCapitalLinks; + $wgCapitalLinks = true; // We only need this from SetupGlobals() See r70917#c8637 + + $text = self::chomp( $text ); + $name = self::chomp( $name ); + + $title = Title::newFromText( $name ); + + if ( is_null( $title ) ) { + throw new MWException( "invalid title '$name' at line $line\n" ); + } + + $page = WikiPage::factory( $title ); + $page->loadPageData( 'fromdbmaster' ); + + if ( $page->exists() ) { + if ( $ignoreDuplicate == 'ignoreduplicate' ) { + return; + } else { + throw new MWException( "duplicate article '$name' at line $line\n" ); + } + } + + $page->doEditContent( ContentHandler::makeContent( $text, $title ), '', EDIT_NEW ); + + $wgCapitalLinks = $oldCapitalLinks; + } + + /** + * Steal a callback function from the primary parser, save it for + * application to our scary parser. If the hook is not installed, + * abort processing of this file. + * + * @param string $name + * @return bool True if tag hook is present + */ + public function requireHook( $name ) { + global $wgParser; + + $wgParser->firstCallInit(); // make sure hooks are loaded. + + if ( isset( $wgParser->mTagHooks[$name] ) ) { + $this->hooks[$name] = $wgParser->mTagHooks[$name]; + } else { + echo " This test suite requires the '$name' hook extension, skipping.\n"; + return false; + } + + return true; + } + + /** + * Steal a callback function from the primary parser, save it for + * application to our scary parser. If the hook is not installed, + * abort processing of this file. + * + * @param string $name + * @return bool True if function hook is present + */ + public function requireFunctionHook( $name ) { + global $wgParser; + + $wgParser->firstCallInit(); // make sure hooks are loaded. + + if ( isset( $wgParser->mFunctionHooks[$name] ) ) { + $this->functionHooks[$name] = $wgParser->mFunctionHooks[$name]; + } else { + echo " This test suite requires the '$name' function hook extension, skipping.\n"; + return false; + } + + return true; + } + + /** + * Steal a callback function from the primary parser, save it for + * application to our scary parser. If the hook is not installed, + * abort processing of this file. + * + * @param string $name + * @return bool True if function hook is present + */ + public function requireTransparentHook( $name ) { + global $wgParser; + + $wgParser->firstCallInit(); // make sure hooks are loaded. + + if ( isset( $wgParser->mTransparentTagHooks[$name] ) ) { + $this->transparentHooks[$name] = $wgParser->mTransparentTagHooks[$name]; + } else { + echo " This test suite requires the '$name' transparent hook extension, skipping.\n"; + return false; + } + + return true; + } + + private function wellFormed( $text ) { + $html = + Sanitizer::hackDocType() . + '' . + $text . + ''; + + $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; + } + + private function extractFragment( $text, $position ) { + $start = max( 0, $position - 10 ); + $before = $position - $start; + $fragment = '...' . + $this->term->color( 34 ) . + substr( $text, $start, $before ) . + $this->term->color( 0 ) . + $this->term->color( 31 ) . + $this->term->color( 1 ) . + substr( $text, $position, 1 ) . + $this->term->color( 0 ) . + $this->term->color( 34 ) . + substr( $text, $position + 1, 9 ) . + $this->term->color( 0 ) . + '...'; + $display = str_replace( "\n", ' ', $fragment ); + $caret = ' ' . + str_repeat( ' ', $before ) . + $this->term->color( 31 ) . + '^' . + $this->term->color( 0 ); + + return "$display\n$caret"; + } + + static function getFakeTimestamp( &$parser, &$ts ) { + $ts = 123; // parsed as '1970-01-01T00:02:03Z' + return true; + } +} diff --git a/tests/parser/ParserTestParserHook.php b/tests/parser/ParserTestParserHook.php new file mode 100644 index 0000000000..5bf50ead6d --- /dev/null +++ b/tests/parser/ParserTestParserHook.php @@ -0,0 +1,67 @@ + + */ + +class ParserTestParserHook { + + static function setup( &$parser ) { + $parser->setHook( 'tag', [ __CLASS__, 'dumpHook' ] ); + $parser->setHook( 'tåg', [ __CLASS__, 'dumpHook' ] ); + $parser->setHook( 'statictag', [ __CLASS__, 'staticTagHook' ] ); + return true; + } + + static function dumpHook( $in, $argv ) { + return "
\n" .
+			var_export( $in, true ) . "\n" .
+			var_export( $argv, true ) . "\n" .
+			"
"; + } + + static function staticTagHook( $in, $argv, $parser ) { + if ( !count( $argv ) ) { + $parser->static_tag_buf = $in; + return ''; + } elseif ( count( $argv ) === 1 && isset( $argv['action'] ) + && $argv['action'] === 'flush' && $in === null + ) { + // Clear the buffer, we probably don't need to + if ( isset( $parser->static_tag_buf ) ) { + $tmp = $parser->static_tag_buf; + } else { + $tmp = ''; + } + $parser->static_tag_buf = null; + return $tmp; + } else { // wtf? + return + "\nCall this extension as string or as" . + " , not in any other way.\n" . + "text: " . var_export( $in, true ) . "\n" . + "argv: " . var_export( $argv, true ) . "\n"; + } + } +} diff --git a/tests/parser/ParserTestResultNormalizer.php b/tests/parser/ParserTestResultNormalizer.php new file mode 100644 index 0000000000..a15d09ef5d --- /dev/null +++ b/tests/parser/ParserTestResultNormalizer.php @@ -0,0 +1,87 @@ +invalid ) { + return $text; + } + foreach ( $funcs as $func ) { + $norm->$func(); + } + return $norm->serialize(); + } + + protected function __construct( $text ) { + $this->doc = new DOMDocument( '1.0', 'utf-8' ); + + // Note: parsing a supposedly XHTML document with an XML parser is not + // guaranteed to give accurate results. For example, it may introduce + // differences in the number of line breaks in
 tags.
+
+		MediaWiki\suppressWarnings();
+		if ( !$this->doc->loadXML( '' . $text . '' ) ) {
+			$this->invalid = true;
+		}
+		MediaWiki\restoreWarnings();
+		$this->xpath = new DOMXPath( $this->doc );
+		$this->body = $this->xpath->query( '//body' )->item( 0 );
+	}
+
+	protected function removeTbody() {
+		foreach ( $this->xpath->query( '//tbody' ) as $tbody ) {
+			while ( $tbody->firstChild ) {
+				$child = $tbody->firstChild;
+				$tbody->removeChild( $child );
+				$tbody->parentNode->insertBefore( $child, $tbody );
+			}
+			$tbody->parentNode->removeChild( $tbody );
+		}
+	}
+
+	/**
+	 * The point of this function is to produce a normalized DOM in which
+	 * Tidy's output matches the output of html5depurate. Tidy both trims
+	 * and pretty-prints, so this requires fairly aggressive treatment.
+	 *
+	 * In particular, note that Tidy converts 
x
to
\nx\n
, + * which theoretically affects display since the second line break is not + * ignored by compliant HTML parsers. + * + * This function also removes empty elements, as does Tidy. + */ + protected function trimWhitespace() { + foreach ( $this->xpath->query( '//text()' ) as $child ) { + if ( strtolower( $child->parentNode->nodeName ) === 'pre' ) { + // Just trim one line break from the start and end + if ( substr_compare( $child->data, "\n", 0 ) === 0 ) { + $child->data = substr( $child->data, 1 ); + } + if ( substr_compare( $child->data, "\n", -1 ) === 0 ) { + $child->data = substr( $child->data, 0, -1 ); + } + } else { + // Trim all whitespace + $child->data = trim( $child->data ); + } + if ( $child->data === '' ) { + $child->parentNode->removeChild( $child ); + } + } + } + + /** + * Serialize the XML DOM for comparison purposes. This does not generate HTML. + */ + protected function serialize() { + return strtr( $this->doc->saveXML( $this->body ), + [ '' => '', '' => '' ] ); + } +} + diff --git a/tests/parser/TestFileDataProvider.php b/tests/parser/TestFileDataProvider.php new file mode 100644 index 0000000000..00b1f3f01c --- /dev/null +++ b/tests/parser/TestFileDataProvider.php @@ -0,0 +1,42 @@ +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]; + } +} + diff --git a/tests/parser/TestRecorder.php b/tests/parser/TestRecorder.php new file mode 100644 index 0000000000..2608420b06 --- /dev/null +++ b/tests/parser/TestRecorder.php @@ -0,0 +1,69 @@ +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 ); + } +} + diff --git a/tests/parser/TidySupport.php b/tests/parser/TidySupport.php new file mode 100644 index 0000000000..6b5fb4847f --- /dev/null +++ b/tests/parser/TidySupport.php @@ -0,0 +1,95 @@ +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; + } +} diff --git a/tests/parser/fuzzTest.php b/tests/parser/fuzzTest.php new file mode 100644 index 0000000000..045a7700cf --- /dev/null +++ b/tests/parser/fuzzTest.php @@ -0,0 +1,186 @@ +addDescription( 'Run a fuzz test on the parser, until it segfaults ' . + 'or throws an exception' ); + $this->addOption( 'file', 'Use the specified file as a dictionary, ' . + ' or leave blank to use parserTests.txt', false, true, true ); + + $this->addOption( 'seed', 'Start the fuzz test from the specified seed', false, true ); + } + + function finalSetup() { + require_once __DIR__ . '/../TestsAutoLoader.php'; + } + + function execute() { + $files = $this->getOption( 'file', [ __DIR__ . '/parserTests.txt' ] ); + $this->seed = intval( $this->getOption( 'seed', 1 ) ) - 1; + $this->parserTest = new ParserTest; + $this->fuzzTest( $files ); + } + + /** + * Run a fuzz test series + * Draw input from a set of test files + * @param array $filenames + */ + function fuzzTest( $filenames ) { + $GLOBALS['wgContLang'] = Language::factory( 'en' ); + $dict = $this->getFuzzInput( $filenames ); + $dictSize = strlen( $dict ); + $logMaxLength = log( $this->maxFuzzTestLength ); + $this->parserTest->setupDatabase(); + ini_set( 'memory_limit', $this->memoryLimit * 1048576 * 2 ); + + $numTotal = 0; + $numSuccess = 0; + $user = new User; + $opts = ParserOptions::newFromUser( $user ); + $title = Title::makeTitle( NS_MAIN, 'Parser_test' ); + + while ( true ) { + // Generate test input + mt_srand( ++$this->seed ); + $totalLength = mt_rand( 1, $this->maxFuzzTestLength ); + $input = ''; + + while ( strlen( $input ) < $totalLength ) { + $logHairLength = mt_rand( 0, 1000000 ) / 1000000 * $logMaxLength; + $hairLength = min( intval( exp( $logHairLength ) ), $dictSize ); + $offset = mt_rand( 0, $dictSize - $hairLength ); + $input .= substr( $dict, $offset, $hairLength ); + } + + $this->parserTest->setupGlobals(); + $parser = $this->parserTest->getParser(); + + // Run the test + try { + $parser->parse( $input, $title, $opts ); + $fail = false; + } catch ( Exception $exception ) { + $fail = true; + } + + if ( $fail ) { + echo "Test failed with seed {$this->seed}\n"; + echo "Input:\n"; + printf( "string(%d) \"%s\"\n\n", strlen( $input ), $input ); + echo "$exception\n"; + } else { + $numSuccess++; + } + + $numTotal++; + $this->parserTest->teardownGlobals(); + $parser->__destruct(); + + if ( $numTotal % 100 == 0 ) { + $usage = intval( memory_get_usage( true ) / $this->memoryLimit / 1048576 * 100 ); + echo "{$this->seed}: $numSuccess/$numTotal (mem: $usage%)\n"; + if ( $usage >= 100 ) { + echo "Out of memory:\n"; + $memStats = $this->getMemoryBreakdown(); + + foreach ( $memStats as $name => $usage ) { + echo "$name: $usage\n"; + } + if ( function_exists( 'hphpd_break' ) ) { + hphpd_break(); + } + return; + } + } + } + } + + /** + * Get a memory usage breakdown + * @return array + */ + function getMemoryBreakdown() { + $memStats = []; + + foreach ( $GLOBALS as $name => $value ) { + $memStats['$' . $name] = $this->guessVarSize( $value ); + } + + $classes = get_declared_classes(); + + foreach ( $classes as $class ) { + $rc = new ReflectionClass( $class ); + $props = $rc->getStaticProperties(); + $memStats[$class] = $this->guessVarSize( $props ); + $methods = $rc->getMethods(); + + foreach ( $methods as $method ) { + $memStats[$class] += $this->guessVarSize( $method->getStaticVariables() ); + } + } + + $functions = get_defined_functions(); + + foreach ( $functions['user'] as $function ) { + $rf = new ReflectionFunction( $function ); + $memStats["$function()"] = $this->guessVarSize( $rf->getStaticVariables() ); + } + + asort( $memStats ); + + return $memStats; + } + + /** + * Estimate the size of the input variable + */ + function guessVarSize( $var ) { + $length = 0; + try { + MediaWiki\suppressWarnings(); + $length = strlen( serialize( $var ) ); + MediaWiki\restoreWarnings(); + } catch ( Exception $e ) { + } + return $length; + } + + /** + * Get an input dictionary from a set of parser test files + * @param array $filenames + * @return string + */ + function getFuzzInput( $filenames ) { + $dict = ''; + + foreach ( $filenames as $filename ) { + $contents = file_get_contents( $filename ); + preg_match_all( + '/!!\s*(input|wikitext)\n(.*?)\n!!\s*(result|html|html\/\*|html\/php)/s', + $contents, + $matches + ); + + foreach ( $matches[1] as $match ) { + $dict .= $match . "\n"; + } + } + + return $dict; + } +} + +$maintClass = 'ParserFuzzTest'; +require RUN_MAINTENANCE_IF_MAIN; diff --git a/tests/parser/parserTest.inc b/tests/parser/parserTest.inc deleted file mode 100644 index e965e2d537..0000000000 --- a/tests/parser/parserTest.inc +++ /dev/null @@ -1,1815 +0,0 @@ - - * https://www.mediawiki.org/ - * - * 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 - * - * @todo Make this more independent of the configuration (and if possible the database) - * @todo document - * @file - * @ingroup Testing - */ -use MediaWiki\MediaWikiServices; - -/** - * @ingroup Testing - */ -class ParserTest { - /** - * @var bool $color whereas output should be colorized - */ - private $color; - - /** - * @var bool $showOutput Show test output - */ - private $showOutput; - - /** - * @var bool $useTemporaryTables Use temporary tables for the temporary database - */ - private $useTemporaryTables = true; - - /** - * @var bool $databaseSetupDone True if the database has been set up - */ - private $databaseSetupDone = false; - - /** - * Our connection to the database - * @var DatabaseBase - */ - private $db; - - /** - * Database clone helper - * @var CloneDatabase - */ - private $dbClone; - - /** - * @var DjVuSupport - */ - private $djVuSupport; - - /** - * @var TidySupport - */ - private $tidySupport; - - /** - * @var ITestRecorder - */ - private $recorder; - - private $maxFuzzTestLength = 300; - private $fuzzSeed = 0; - private $memoryLimit = 50; - private $uploadDir = null; - - public $regex = ""; - private $savedGlobals = []; - private $useDwdiff = false; - private $markWhitespace = false; - private $normalizationFunctions = []; - - /** - * Sets terminal colorization and diff/quick modes depending on OS and - * command-line options (--color and --quick). - * @param array $options - */ - public function __construct( $options = [] ) { - # Only colorize output if stdout is a terminal. - $this->color = !wfIsWindows() && Maintenance::posix_isatty( 1 ); - - if ( isset( $options['color'] ) ) { - switch ( $options['color'] ) { - case 'no': - $this->color = false; - break; - case 'yes': - default: - $this->color = true; - break; - } - } - - $this->term = $this->color - ? new AnsiTermColorer() - : new DummyTermColorer(); - - $this->showDiffs = !isset( $options['quick'] ); - $this->showProgress = !isset( $options['quiet'] ); - $this->showFailure = !( - isset( $options['quiet'] ) - && ( isset( $options['record'] ) - || isset( $options['compare'] ) ) ); // redundant output - - $this->showOutput = isset( $options['show-output'] ); - $this->useDwdiff = isset( $options['dwdiff'] ); - $this->markWhitespace = isset( $options['mark-ws'] ); - - if ( isset( $options['norm'] ) ) { - foreach ( explode( ',', $options['norm'] ) as $func ) { - if ( in_array( $func, [ 'removeTbody', 'trimWhitespace' ] ) ) { - $this->normalizationFunctions[] = $func; - } else { - echo "Warning: unknown normalization option \"$func\"\n"; - } - } - } - - if ( isset( $options['filter'] ) ) { - $options['regex'] = $options['filter']; - } - - if ( isset( $options['regex'] ) ) { - if ( isset( $options['record'] ) ) { - echo "Warning: --record cannot be used with --regex, disabling --record\n"; - unset( $options['record'] ); - } - $this->regex = $options['regex']; - } else { - # Matches anything - $this->regex = ''; - } - - $this->setupRecorder( $options ); - $this->keepUploads = isset( $options['keep-uploads'] ); - - if ( $this->keepUploads ) { - $this->uploadDir = wfTempDir() . '/mwParser-images'; - } else { - $this->uploadDir = wfTempDir() . "/mwParser-" . mt_rand() . "-images"; - } - - if ( isset( $options['seed'] ) ) { - $this->fuzzSeed = intval( $options['seed'] ) - 1; - } - - $this->runDisabled = isset( $options['run-disabled'] ); - $this->runParsoid = isset( $options['run-parsoid'] ); - - $this->djVuSupport = new DjVuSupport(); - $this->tidySupport = new TidySupport( isset( $options['use-tidy-config'] ) ); - if ( !$this->tidySupport->isEnabled() ) { - echo "Warning: tidy is not installed, skipping some tests\n"; - } - - $this->hooks = []; - $this->functionHooks = []; - $this->transparentHooks = []; - $this->setUp(); - } - - function setUp() { - global $wgParser, $wgParserConf, $IP, $messageMemc, $wgMemc, - $wgUser, $wgLang, $wgOut, $wgRequest, $wgStyleDirectory, - $wgExtraNamespaces, $wgNamespaceAliases, $wgNamespaceProtection, $wgLocalFileRepo, - $wgExtraInterlanguageLinkPrefixes, $wgLocalInterwikis, - $parserMemc, $wgThumbnailScriptPath, $wgScriptPath, $wgResourceBasePath, - $wgArticlePath, $wgScript, $wgStylePath, $wgExtensionAssetsPath, - $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType, $wgLockManagers; - - $wgScriptPath = ''; - $wgScript = '/index.php'; - $wgStylePath = '/skins'; - $wgResourceBasePath = ''; - $wgExtensionAssetsPath = '/extensions'; - $wgArticlePath = '/wiki/$1'; - $wgThumbnailScriptPath = false; - $wgLockManagers = [ [ - 'name' => 'fsLockManager', - 'class' => 'FSLockManager', - 'lockDirectory' => $this->uploadDir . '/lockdir', - ], [ - 'name' => 'nullLockManager', - 'class' => 'NullLockManager', - ] ]; - $wgLocalFileRepo = [ - 'class' => 'LocalRepo', - 'name' => 'local', - 'url' => 'http://example.com/images', - 'hashLevels' => 2, - 'transformVia404' => false, - 'backend' => new FSFileBackend( [ - 'name' => 'local-backend', - 'wikiId' => wfWikiID(), - 'containerPaths' => [ - 'local-public' => $this->uploadDir . '/public', - 'local-thumb' => $this->uploadDir . '/thumb', - 'local-temp' => $this->uploadDir . '/temp', - 'local-deleted' => $this->uploadDir . '/deleted', - ] - ] ) - ]; - $wgNamespaceProtection[NS_MEDIAWIKI] = 'editinterface'; - $wgNamespaceAliases['Image'] = NS_FILE; - $wgNamespaceAliases['Image_talk'] = NS_FILE_TALK; - # add a namespace shadowing a interwiki link, to test - # proper precedence when resolving links. (bug 51680) - $wgExtraNamespaces[100] = 'MemoryAlpha'; - $wgExtraNamespaces[101] = 'MemoryAlpha talk'; - - // XXX: tests won't run without this (for CACHE_DB) - if ( $wgMainCacheType === CACHE_DB ) { - $wgMainCacheType = CACHE_NONE; - } - if ( $wgMessageCacheType === CACHE_DB ) { - $wgMessageCacheType = CACHE_NONE; - } - if ( $wgParserCacheType === CACHE_DB ) { - $wgParserCacheType = CACHE_NONE; - } - - DeferredUpdates::clearPendingUpdates(); - $wgMemc = wfGetMainCache(); // checks $wgMainCacheType - $messageMemc = wfGetMessageCacheStorage(); - $parserMemc = wfGetParserCacheStorage(); - - RequestContext::resetMain(); - $context = new RequestContext; - $wgUser = new User; - $wgLang = $context->getLanguage(); - $wgOut = $context->getOutput(); - $wgRequest = $context->getRequest(); - $wgParser = new StubObject( 'wgParser', $wgParserConf['class'], [ $wgParserConf ] ); - - if ( $wgStyleDirectory === false ) { - $wgStyleDirectory = "$IP/skins"; - } - - self::setupInterwikis(); - $wgLocalInterwikis = [ 'local', 'mi' ]; - // "extra language links" - // see https://gerrit.wikimedia.org/r/111390 - array_push( $wgExtraInterlanguageLinkPrefixes, 'mul' ); - - // Reset namespace cache - MWNamespace::getCanonicalNamespaces( true ); - Language::factory( 'en' )->resetNamespaces(); - } - - /** - * Insert hardcoded interwiki in the lookup table. - * - * This function insert a set of well known interwikis that are used in - * the parser tests. They can be considered has fixtures are injected in - * the interwiki cache by using the 'InterwikiLoadPrefix' hook. - * Since we are not interested in looking up interwikis in the database, - * the hook completely replace the existing mechanism (hook returns false). - */ - public static function setupInterwikis() { - # Hack: insert a few Wikipedia in-project interwiki prefixes, - # for testing inter-language links - Hooks::register( 'InterwikiLoadPrefix', function ( $prefix, &$iwData ) { - static $testInterwikis = [ - 'local' => [ - 'iw_url' => 'http://doesnt.matter.org/$1', - 'iw_api' => '', - 'iw_wikiid' => '', - 'iw_local' => 0 ], - 'wikipedia' => [ - 'iw_url' => 'http://en.wikipedia.org/wiki/$1', - 'iw_api' => '', - 'iw_wikiid' => '', - 'iw_local' => 0 ], - 'meatball' => [ - 'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1', - 'iw_api' => '', - 'iw_wikiid' => '', - 'iw_local' => 0 ], - 'memoryalpha' => [ - 'iw_url' => 'http://www.memory-alpha.org/en/index.php/$1', - 'iw_api' => '', - 'iw_wikiid' => '', - 'iw_local' => 0 ], - 'zh' => [ - 'iw_url' => 'http://zh.wikipedia.org/wiki/$1', - 'iw_api' => '', - 'iw_wikiid' => '', - 'iw_local' => 1 ], - 'es' => [ - 'iw_url' => 'http://es.wikipedia.org/wiki/$1', - 'iw_api' => '', - 'iw_wikiid' => '', - 'iw_local' => 1 ], - 'fr' => [ - 'iw_url' => 'http://fr.wikipedia.org/wiki/$1', - 'iw_api' => '', - 'iw_wikiid' => '', - 'iw_local' => 1 ], - 'ru' => [ - 'iw_url' => 'http://ru.wikipedia.org/wiki/$1', - 'iw_api' => '', - 'iw_wikiid' => '', - 'iw_local' => 1 ], - 'mi' => [ - 'iw_url' => 'http://mi.wikipedia.org/wiki/$1', - 'iw_api' => '', - 'iw_wikiid' => '', - 'iw_local' => 1 ], - 'mul' => [ - 'iw_url' => 'http://wikisource.org/wiki/$1', - 'iw_api' => '', - 'iw_wikiid' => '', - 'iw_local' => 1 ], - ]; - if ( array_key_exists( $prefix, $testInterwikis ) ) { - $iwData = $testInterwikis[$prefix]; - } - - // We only want to rely on the above fixtures - return false; - } );// hooks::register - } - - /** - * Remove the hardcoded interwiki lookup table. - */ - public static function tearDownInterwikis() { - Hooks::clear( 'InterwikiLoadPrefix' ); - } - - /** - * Reset the Title-related services that need resetting - * for each test - */ - public static function resetTitleServices() { - $services = MediaWikiServices::getInstance(); - $services->resetServiceForTesting( 'TitleFormatter' ); - $services->resetServiceForTesting( 'TitleParser' ); - $services->resetServiceForTesting( '_MediaWikiTitleCodec' ); - $services->resetServiceForTesting( 'LinkRenderer' ); - $services->resetServiceForTesting( 'LinkRendererFactory' ); - } - - public function setupRecorder( $options ) { - if ( isset( $options['record'] ) ) { - $this->recorder = new DbTestRecorder( $this ); - $this->recorder->version = isset( $options['setversion'] ) ? - $options['setversion'] : SpecialVersion::getVersion(); - } elseif ( isset( $options['compare'] ) ) { - $this->recorder = new DbTestPreviewer( $this ); - } else { - $this->recorder = new TestRecorder( $this ); - } - } - - /** - * Remove last character if it is a newline - * @group utility - * @param string $s - * @return string - */ - public static function chomp( $s ) { - if ( substr( $s, -1 ) === "\n" ) { - return substr( $s, 0, -1 ); - } else { - return $s; - } - } - - /** - * Run a fuzz test series - * Draw input from a set of test files - * @param array $filenames - */ - function fuzzTest( $filenames ) { - $GLOBALS['wgContLang'] = Language::factory( 'en' ); - $dict = $this->getFuzzInput( $filenames ); - $dictSize = strlen( $dict ); - $logMaxLength = log( $this->maxFuzzTestLength ); - $this->setupDatabase(); - ini_set( 'memory_limit', $this->memoryLimit * 1048576 ); - - $numTotal = 0; - $numSuccess = 0; - $user = new User; - $opts = ParserOptions::newFromUser( $user ); - $title = Title::makeTitle( NS_MAIN, 'Parser_test' ); - - while ( true ) { - // Generate test input - mt_srand( ++$this->fuzzSeed ); - $totalLength = mt_rand( 1, $this->maxFuzzTestLength ); - $input = ''; - - while ( strlen( $input ) < $totalLength ) { - $logHairLength = mt_rand( 0, 1000000 ) / 1000000 * $logMaxLength; - $hairLength = min( intval( exp( $logHairLength ) ), $dictSize ); - $offset = mt_rand( 0, $dictSize - $hairLength ); - $input .= substr( $dict, $offset, $hairLength ); - } - - $this->setupGlobals(); - $parser = $this->getParser(); - - // Run the test - try { - $parser->parse( $input, $title, $opts ); - $fail = false; - } catch ( Exception $exception ) { - $fail = true; - } - - if ( $fail ) { - echo "Test failed with seed {$this->fuzzSeed}\n"; - echo "Input:\n"; - printf( "string(%d) \"%s\"\n\n", strlen( $input ), $input ); - echo "$exception\n"; - } else { - $numSuccess++; - } - - $numTotal++; - $this->teardownGlobals(); - $parser->__destruct(); - - if ( $numTotal % 100 == 0 ) { - $usage = intval( memory_get_usage( true ) / $this->memoryLimit / 1048576 * 100 ); - echo "{$this->fuzzSeed}: $numSuccess/$numTotal (mem: $usage%)\n"; - if ( $usage > 90 ) { - echo "Out of memory:\n"; - $memStats = $this->getMemoryBreakdown(); - - foreach ( $memStats as $name => $usage ) { - echo "$name: $usage\n"; - } - $this->abort(); - } - } - } - } - - /** - * Get an input dictionary from a set of parser test files - * @param array $filenames - * @return string - */ - function getFuzzInput( $filenames ) { - $dict = ''; - - foreach ( $filenames as $filename ) { - $contents = file_get_contents( $filename ); - preg_match_all( - '/!!\s*(input|wikitext)\n(.*?)\n!!\s*(result|html|html\/\*|html\/php)/s', - $contents, - $matches - ); - - foreach ( $matches[1] as $match ) { - $dict .= $match . "\n"; - } - } - - return $dict; - } - - /** - * Get a memory usage breakdown - * @return array - */ - function getMemoryBreakdown() { - $memStats = []; - - foreach ( $GLOBALS as $name => $value ) { - $memStats['$' . $name] = strlen( serialize( $value ) ); - } - - $classes = get_declared_classes(); - - foreach ( $classes as $class ) { - $rc = new ReflectionClass( $class ); - $props = $rc->getStaticProperties(); - $memStats[$class] = strlen( serialize( $props ) ); - $methods = $rc->getMethods(); - - foreach ( $methods as $method ) { - $memStats[$class] += strlen( serialize( $method->getStaticVariables() ) ); - } - } - - $functions = get_defined_functions(); - - foreach ( $functions['user'] as $function ) { - $rf = new ReflectionFunction( $function ); - $memStats["$function()"] = strlen( serialize( $rf->getStaticVariables() ) ); - } - - asort( $memStats ); - - return $memStats; - } - - function abort() { - $this->abort(); - } - - /** - * Run a series of tests listed in the given text files. - * 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 array $filenames Array of strings - * @return bool True if passed all tests, false if any tests failed. - */ - public function runTestsFromFiles( $filenames ) { - $ok = false; - - // be sure, ParserTest::addArticle has correct language set, - // so that system messages gets into the right language cache - $GLOBALS['wgLanguageCode'] = 'en'; - $GLOBALS['wgContLang'] = Language::factory( 'en' ); - - $this->recorder->start(); - try { - $this->setupDatabase(); - $ok = true; - - foreach ( $filenames as $filename ) { - echo "Running parser tests from: $filename\n"; - $tests = new TestFileIterator( $filename, $this ); - $ok = $this->runTests( $tests ) && $ok; - } - - $this->teardownDatabase(); - $this->recorder->report(); - } catch ( DBError $e ) { - echo $e->getMessage(); - } - $this->recorder->end(); - - return $ok; - } - - function runTests( $tests ) { - $ok = true; - - foreach ( $tests as $t ) { - $result = - $this->runTest( $t['test'], $t['input'], $t['result'], $t['options'], $t['config'] ); - $ok = $ok && $result; - $this->recorder->record( $t['test'], $t['subtest'], $result ); - } - - if ( $this->showProgress ) { - print "\n"; - } - - return $ok; - } - - /** - * Get a Parser object - * - * @param string $preprocessor - * @return Parser - */ - function getParser( $preprocessor = null ) { - global $wgParserConf; - - $class = $wgParserConf['class']; - $parser = new $class( [ 'preprocessorClass' => $preprocessor ] + $wgParserConf ); - - foreach ( $this->hooks as $tag => $callback ) { - $parser->setHook( $tag, $callback ); - } - - foreach ( $this->functionHooks as $tag => $bits ) { - list( $callback, $flags ) = $bits; - $parser->setFunctionHook( $tag, $callback, $flags ); - } - - foreach ( $this->transparentHooks as $tag => $callback ) { - $parser->setTransparentTagHook( $tag, $callback ); - } - - Hooks::run( 'ParserTestParser', [ &$parser ] ); - - return $parser; - } - - /** - * 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 $desc Test's description - * @param string $input Wikitext to try rendering - * @param string $result Result to output - * @param array $opts Test's options - * @param string $config Overrides for global variables, one per line - * @return bool - */ - public function runTest( $desc, $input, $result, $opts, $config ) { - if ( $this->showProgress ) { - $this->showTesting( $desc ); - } - - $opts = $this->parseOptions( $opts ); - $context = $this->setupGlobals( $opts, $config ); - - $user = $context->getUser(); - $options = ParserOptions::newFromContext( $context ); - - if ( isset( $opts['djvu'] ) ) { - if ( !$this->djVuSupport->isEnabled() ) { - return $this->showSkipped(); - } - } - - if ( isset( $opts['tidy'] ) ) { - if ( !$this->tidySupport->isEnabled() ) { - return $this->showSkipped(); - } else { - $options->setTidy( true ); - } - } - - if ( isset( $opts['title'] ) ) { - $titleText = $opts['title']; - } else { - $titleText = 'Parser test'; - } - - ObjectCache::getMainWANInstance()->clearProcessCache(); - $local = isset( $opts['local'] ); - $preprocessor = isset( $opts['preprocessor'] ) ? $opts['preprocessor'] : null; - $parser = $this->getParser( $preprocessor ); - $title = Title::newFromText( $titleText ); - - if ( isset( $opts['pst'] ) ) { - $out = $parser->preSaveTransform( $input, $title, $user, $options ); - } elseif ( isset( $opts['msg'] ) ) { - $out = $parser->transformMsg( $input, $options, $title ); - } elseif ( isset( $opts['section'] ) ) { - $section = $opts['section']; - $out = $parser->getSection( $input, $section ); - } elseif ( isset( $opts['replace'] ) ) { - $section = $opts['replace'][0]; - $replace = $opts['replace'][1]; - $out = $parser->replaceSection( $input, $section, $replace ); - } elseif ( isset( $opts['comment'] ) ) { - $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 ); - $output->setTOCEnabled( !isset( $opts['notoc'] ) ); - $out = $output->getText(); - if ( isset( $opts['tidy'] ) ) { - $out = preg_replace( '/\s+$/', '', $out ); - } - - if ( isset( $opts['showtitle'] ) ) { - if ( $output->getTitleText() ) { - $title = $output->getTitleText(); - } - - $out = "$title\n$out"; - } - - if ( isset( $opts['showindicators'] ) ) { - $indicators = ''; - foreach ( $output->getIndicators() as $id => $content ) { - $indicators .= "$id=$content\n"; - } - $out = $indicators . $out; - } - - if ( isset( $opts['ill'] ) ) { - $out = implode( ' ', $output->getLanguageLinks() ); - } elseif ( isset( $opts['cat'] ) ) { - $outputPage = $context->getOutput(); - $outputPage->addCategoryLinks( $output->getCategories() ); - $cats = $outputPage->getCategoryLinks(); - - if ( isset( $cats['normal'] ) ) { - $out = implode( ' ', $cats['normal'] ); - } else { - $out = ''; - } - } - } - - $this->teardownGlobals(); - - if ( count( $this->normalizationFunctions ) ) { - $result = ParserTestResultNormalizer::normalize( $result, $this->normalizationFunctions ); - $out = ParserTestResultNormalizer::normalize( $out, $this->normalizationFunctions ); - } - - $testResult = new ParserTestResult( $desc ); - $testResult->expected = $result; - $testResult->actual = $out; - - return $this->showTestResult( $testResult ); - } - - /** - * Refactored in 1.22 to use ParserTestResult - * @param ParserTestResult $testResult - * @return bool - */ - function showTestResult( ParserTestResult $testResult ) { - if ( $testResult->isSuccess() ) { - $this->showSuccess( $testResult ); - return true; - } else { - $this->showFailure( $testResult ); - return false; - } - } - - /** - * Use a regex to find out the value of an option - * @param string $key Name of option val to retrieve - * @param array $opts Options array to look in - * @param mixed $default Default value returned if not found - * @return mixed - */ - private static function getOptionValue( $key, $opts, $default ) { - $key = strtolower( $key ); - - if ( isset( $opts[$key] ) ) { - return $opts[$key]; - } else { - return $default; - } - } - - private function parseOptions( $instring ) { - $opts = []; - // foo - // foo=bar - // foo="bar baz" - // foo=[[bar baz]] - // foo=bar,"baz quux" - // foo={...json...} - $defs = '(?(DEFINE) - (? # Quoted string - " - (?:[^\\\\"] | \\\\.)* - " - ) - (? - \{ # Open bracket - (?: - [^"{}] | # Not a quoted string or object, or - (?&qstr) | # A quoted string, or - (?&json) # A json object (recursively) - )* - \} # Close bracket - ) - (? - (?: - (?&qstr) # Quoted val - | - \[\[ - [^]]* # Link target - \]\] - | - [\w-]+ # Plain word - | - (?&json) # JSON object - ) - ) - )'; - $regex = '/' . $defs . '\b - (?[\w-]+) # Key - \b - (?:\s* - = # First sub-value - \s* - (? - (?&value) - (?:\s* - , # Sub-vals 1..N - \s* - (?&value) - )* - ) - )? - /x'; - $valueregex = '/' . $defs . '(?&value)/x'; - - if ( preg_match_all( $regex, $instring, $matches, PREG_SET_ORDER ) ) { - foreach ( $matches as $bits ) { - $key = strtolower( $bits['k'] ); - if ( !isset( $bits['v'] ) ) { - $opts[$key] = true; - } else { - preg_match_all( $valueregex, $bits['v'], $vmatches ); - $opts[$key] = array_map( [ $this, 'cleanupOption' ], $vmatches[0] ); - if ( count( $opts[$key] ) == 1 ) { - $opts[$key] = $opts[$key][0]; - } - } - } - } - return $opts; - } - - private function cleanupOption( $opt ) { - if ( substr( $opt, 0, 1 ) == '"' ) { - return stripcslashes( substr( $opt, 1, -1 ) ); - } - - if ( substr( $opt, 0, 2 ) == '[[' ) { - return substr( $opt, 2, -2 ); - } - - if ( substr( $opt, 0, 1 ) == '{' ) { - return FormatJson::decode( $opt, true ); - } - return $opt; - } - - /** - * Set up the global variables for a consistent environment for each test. - * Ideally this should replace the global configuration entirely. - * @param string $opts - * @param string $config - * @return RequestContext - */ - private function setupGlobals( $opts = '', $config = '' ) { - # Find out values for some special options. - $lang = - self::getOptionValue( 'language', $opts, 'en' ); - $variant = - self::getOptionValue( 'variant', $opts, false ); - $maxtoclevel = - self::getOptionValue( 'wgMaxTocLevel', $opts, 999 ); - $linkHolderBatchSize = - self::getOptionValue( 'wgLinkHolderBatchSize', $opts, 1000 ); - - $settings = [ - 'wgServer' => 'http://example.org', - 'wgServerName' => 'example.org', - 'wgScript' => '/index.php', - 'wgScriptPath' => '', - 'wgArticlePath' => '/wiki/$1', - 'wgActionPaths' => [], - 'wgLockManagers' => [ [ - 'name' => 'fsLockManager', - 'class' => 'FSLockManager', - 'lockDirectory' => $this->uploadDir . '/lockdir', - ], [ - 'name' => 'nullLockManager', - 'class' => 'NullLockManager', - ] ], - 'wgLocalFileRepo' => [ - 'class' => 'LocalRepo', - 'name' => 'local', - 'url' => 'http://example.com/images', - 'hashLevels' => 2, - 'transformVia404' => false, - 'backend' => new FSFileBackend( [ - 'name' => 'local-backend', - 'wikiId' => wfWikiID(), - 'containerPaths' => [ - 'local-public' => $this->uploadDir, - 'local-thumb' => $this->uploadDir . '/thumb', - 'local-temp' => $this->uploadDir . '/temp', - 'local-deleted' => $this->uploadDir . '/delete', - ] - ] ) - ], - 'wgEnableUploads' => self::getOptionValue( 'wgEnableUploads', $opts, true ), - 'wgUploadNavigationUrl' => false, - 'wgStylePath' => '/skins', - 'wgSitename' => 'MediaWiki', - 'wgLanguageCode' => $lang, - 'wgDBprefix' => $this->db->getType() != 'oracle' ? 'parsertest_' : 'pt_', - 'wgRawHtml' => self::getOptionValue( 'wgRawHtml', $opts, false ), - 'wgLang' => null, - 'wgContLang' => null, - 'wgNamespacesWithSubpages' => [ 0 => isset( $opts['subpage'] ) ], - 'wgMaxTocLevel' => $maxtoclevel, - 'wgCapitalLinks' => true, - 'wgNoFollowLinks' => true, - 'wgNoFollowDomainExceptions' => [ 'no-nofollow.org' ], - 'wgThumbnailScriptPath' => false, - 'wgUseImageResize' => true, - 'wgSVGConverter' => 'null', - 'wgSVGConverters' => [ 'null' => 'echo "1">$output' ], - 'wgLocaltimezone' => 'UTC', - 'wgAllowExternalImages' => self::getOptionValue( 'wgAllowExternalImages', $opts, true ), - 'wgThumbLimits' => [ self::getOptionValue( 'thumbsize', $opts, 180 ) ], - 'wgDefaultLanguageVariant' => $variant, - 'wgVariantArticlePath' => false, - 'wgGroupPermissions' => [ '*' => [ - 'createaccount' => true, - 'read' => true, - 'edit' => true, - 'createpage' => true, - 'createtalk' => true, - ] ], - 'wgNamespaceProtection' => [ NS_MEDIAWIKI => 'editinterface' ], - 'wgDefaultExternalStore' => [], - 'wgForeignFileRepos' => [], - 'wgLinkHolderBatchSize' => $linkHolderBatchSize, - 'wgExperimentalHtmlIds' => false, - 'wgExternalLinkTarget' => false, - 'wgHtml5' => true, - 'wgAdaptiveMessageCache' => true, - 'wgDisableLangConversion' => false, - 'wgDisableTitleConversion' => false, - // Tidy options. - 'wgUseTidy' => false, - 'wgTidyConfig' => isset( $opts['tidy'] ) ? $this->tidySupport->getConfig() : null - ]; - - if ( $config ) { - $configLines = explode( "\n", $config ); - - foreach ( $configLines as $line ) { - list( $var, $value ) = explode( '=', $line, 2 ); - - $settings[$var] = eval( "return $value;" ); - } - } - - $this->savedGlobals = []; - - /** @since 1.20 */ - Hooks::run( 'ParserTestGlobals', [ &$settings ] ); - - foreach ( $settings as $var => $val ) { - if ( array_key_exists( $var, $GLOBALS ) ) { - $this->savedGlobals[$var] = $GLOBALS[$var]; - } - - $GLOBALS[$var] = $val; - } - - // Must be set before $context as user language defaults to $wgContLang - $GLOBALS['wgContLang'] = Language::factory( $lang ); - $GLOBALS['wgMemc'] = new EmptyBagOStuff; - - RequestContext::resetMain(); - $context = RequestContext::getMain(); - $GLOBALS['wgLang'] = $context->getLanguage(); - $GLOBALS['wgOut'] = $context->getOutput(); - $GLOBALS['wgUser'] = $context->getUser(); - - // We (re)set $wgThumbLimits to a single-element array above. - $context->getUser()->setOption( 'thumbsize', 0 ); - - global $wgHooks; - - $wgHooks['ParserTestParser'][] = 'ParserTestParserHook::setup'; - $wgHooks['ParserGetVariableValueTs'][] = 'ParserTest::getFakeTimestamp'; - - MagicWord::clearCache(); - MWTidy::destroySingleton(); - RepoGroup::destroySingleton(); - - self::resetTitleServices(); - - return $context; - } - - /** - * List of temporary tables to create, without prefix. - * Some of these probably aren't necessary. - * @return array - */ - private function listTables() { - $tables = [ 'user', 'user_properties', 'user_former_groups', 'page', 'page_restrictions', - 'protected_titles', 'revision', 'text', 'pagelinks', 'imagelinks', - 'categorylinks', 'templatelinks', 'externallinks', 'langlinks', 'iwlinks', - 'site_stats', 'ipblocks', 'image', 'oldimage', - 'recentchanges', 'watchlist', 'interwiki', 'logging', 'log_search', - 'querycache', 'objectcache', 'job', 'l10n_cache', 'redirect', 'querycachetwo', - 'archive', 'user_groups', 'page_props', 'category' - ]; - - if ( in_array( $this->db->getType(), [ 'mysql', 'sqlite', 'oracle' ] ) ) { - array_push( $tables, 'searchindex' ); - } - - // Allow extensions to add to the list of tables to duplicate; - // may be necessary if they hook into page save or other code - // which will require them while running tests. - Hooks::run( 'ParserTestTables', [ &$tables ] ); - - return $tables; - } - - /** - * 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. - */ - public function setupDatabase() { - global $wgDBprefix; - - if ( $this->databaseSetupDone ) { - return; - } - - $this->db = wfGetDB( DB_MASTER ); - $dbType = $this->db->getType(); - - if ( $wgDBprefix === 'parsertest_' || ( $dbType == 'oracle' && $wgDBprefix === 'pt_' ) ) { - throw new MWException( 'setupDatabase should be called before setupGlobals' ); - } - - $this->databaseSetupDone = true; - - # SqlBagOStuff broke when using temporary tables on r40209 (bug 15892). - # It seems to have been fixed since (r55079?), but regressed at some point before r85701. - # This works around it for now... - ObjectCache::$instances[CACHE_DB] = new HashBagOStuff; - - # CREATE TEMPORARY TABLE breaks if there is more than one server - if ( wfGetLB()->getServerCount() != 1 ) { - $this->useTemporaryTables = false; - } - - $temporary = $this->useTemporaryTables || $dbType == 'postgres'; - $prefix = $dbType != 'oracle' ? 'parsertest_' : 'pt_'; - - $this->dbClone = new CloneDatabase( $this->db, $this->listTables(), $prefix ); - $this->dbClone->useTemporaryTables( $temporary ); - $this->dbClone->cloneTableStructure(); - - if ( $dbType == 'oracle' ) { - $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' ); - # Insert 0 user to prevent FK violations - - # Anonymous user - $this->db->insert( 'user', [ - 'user_id' => 0, - 'user_name' => 'Anonymous' ] ); - } - - # Update certain things in site_stats - $this->db->insert( 'site_stats', - [ 'ss_row_id' => 1, 'ss_images' => 2, 'ss_good_articles' => 1 ] ); - - # Reinitialise the LocalisationCache to match the database state - Language::getLocalisationCache()->unloadAll(); - - # Clear the message cache - MessageCache::singleton()->clear(); - - // Remember to update newParserTests.php after changing the below - // (and it uses a slightly different syntax just for teh lulz) - $this->setupUploadDir(); - $user = User::createNew( 'WikiSysop' ); - $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Foobar.jpg' ) ); - # note that the size/width/height/bits/etc of the file - # are actually set by inspecting the file itself; the arguments - # to recordUpload2 have no effect. That said, we try to make things - # match up so it is less confusing to readers of the code & tests. - $image->recordUpload2( '', 'Upload of some lame file', 'Some lame file', [ - 'size' => 7881, - 'width' => 1941, - 'height' => 220, - 'bits' => 8, - 'media_type' => MEDIATYPE_BITMAP, - 'mime' => 'image/jpeg', - 'metadata' => serialize( [] ), - 'sha1' => Wikimedia\base_convert( '1', 16, 36, 31 ), - 'fileExists' => true - ], $this->db->timestamp( '20010115123500' ), $user ); - - $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Thumb.png' ) ); - # again, note that size/width/height below are ignored; see above. - $image->recordUpload2( '', 'Upload of some lame thumbnail', 'Some lame thumbnail', [ - 'size' => 22589, - 'width' => 135, - 'height' => 135, - 'bits' => 8, - 'media_type' => MEDIATYPE_BITMAP, - 'mime' => 'image/png', - 'metadata' => serialize( [] ), - 'sha1' => Wikimedia\base_convert( '2', 16, 36, 31 ), - 'fileExists' => true - ], $this->db->timestamp( '20130225203040' ), $user ); - - $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Foobar.svg' ) ); - $image->recordUpload2( '', 'Upload of some lame SVG', 'Some lame SVG', [ - 'size' => 12345, - 'width' => 240, - 'height' => 180, - 'bits' => 0, - 'media_type' => MEDIATYPE_DRAWING, - 'mime' => 'image/svg+xml', - 'metadata' => serialize( [] ), - 'sha1' => Wikimedia\base_convert( '', 16, 36, 31 ), - 'fileExists' => true - ], $this->db->timestamp( '20010115123500' ), $user ); - - # This image will be blacklisted in [[MediaWiki:Bad image list]] - $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Bad.jpg' ) ); - $image->recordUpload2( '', 'zomgnotcensored', 'Borderline image', [ - 'size' => 12345, - 'width' => 320, - 'height' => 240, - 'bits' => 24, - 'media_type' => MEDIATYPE_BITMAP, - 'mime' => 'image/jpeg', - 'metadata' => serialize( [] ), - 'sha1' => Wikimedia\base_convert( '3', 16, 36, 31 ), - 'fileExists' => true - ], $this->db->timestamp( '20010115123500' ), $user ); - - $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Video.ogv' ) ); - $image->recordUpload2( '', 'A pretty movie', 'Will it play', [ - 'size' => 12345, - 'width' => 320, - 'height' => 240, - 'bits' => 0, - 'media_type' => MEDIATYPE_VIDEO, - 'mime' => 'application/ogg', - 'metadata' => serialize( [] ), - 'sha1' => Wikimedia\base_convert( '', 16, 36, 31 ), - 'fileExists' => true - ], $this->db->timestamp( '20010115123500' ), $user ); - - $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Audio.oga' ) ); - $image->recordUpload2( '', 'An awesome hitsong', 'Will it play', [ - 'size' => 12345, - 'width' => 0, - 'height' => 0, - 'bits' => 0, - 'media_type' => MEDIATYPE_AUDIO, - 'mime' => 'application/ogg', - 'metadata' => serialize( [] ), - 'sha1' => Wikimedia\base_convert( '', 16, 36, 31 ), - 'fileExists' => true - ], $this->db->timestamp( '20010115123500' ), $user ); - - # A DjVu file - $image = wfLocalFile( Title::makeTitle( NS_FILE, 'LoremIpsum.djvu' ) ); - $image->recordUpload2( '', 'Upload a DjVu', 'A DjVu', [ - 'size' => 3249, - 'width' => 2480, - 'height' => 3508, - 'bits' => 0, - 'media_type' => MEDIATYPE_BITMAP, - 'mime' => 'image/vnd.djvu', - 'metadata' => ' - - - - - - - - - - - - - - - - - - - - - - - - -', - 'sha1' => Wikimedia\base_convert( '', 16, 36, 31 ), - 'fileExists' => true - ], $this->db->timestamp( '20010115123600' ), $user ); - } - - public function teardownDatabase() { - if ( !$this->databaseSetupDone ) { - $this->teardownGlobals(); - return; - } - $this->teardownUploadDir( $this->uploadDir ); - - $this->dbClone->destroy(); - $this->databaseSetupDone = false; - - if ( $this->useTemporaryTables ) { - if ( $this->db->getType() == 'sqlite' ) { - # Under SQLite the searchindex table is virtual and need - # to be explicitly destroyed. See bug 29912 - # See also MediaWikiTestCase::destroyDB() - wfDebug( __METHOD__ . " explicitly destroying sqlite virtual table parsertest_searchindex\n" ); - $this->db->query( "DROP TABLE `parsertest_searchindex`" ); - } - # Don't need to do anything - $this->teardownGlobals(); - return; - } - - $tables = $this->listTables(); - - foreach ( $tables as $table ) { - if ( $this->db->getType() == 'oracle' ) { - $this->db->query( "DROP TABLE pt_$table DROP CONSTRAINTS" ); - } else { - $this->db->query( "DROP TABLE `parsertest_$table`" ); - } - } - - if ( $this->db->getType() == 'oracle' ) { - $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' ); - } - - $this->teardownGlobals(); - } - - /** - * Create a dummy uploads directory which will contain a couple - * of files in order to pass existence tests. - * - * @return string The directory - */ - private function setupUploadDir() { - global $IP; - - $dir = $this->uploadDir; - if ( $this->keepUploads && is_dir( $dir ) ) { - return; - } - - // wfDebug( "Creating upload directory $dir\n" ); - if ( file_exists( $dir ) ) { - wfDebug( "Already exists!\n" ); - return; - } - - wfMkdirParents( $dir . '/3/3a', null, __METHOD__ ); - copy( "$IP/tests/phpunit/data/parser/headbg.jpg", "$dir/3/3a/Foobar.jpg" ); - wfMkdirParents( $dir . '/e/ea', null, __METHOD__ ); - copy( "$IP/tests/phpunit/data/parser/wiki.png", "$dir/e/ea/Thumb.png" ); - wfMkdirParents( $dir . '/0/09', null, __METHOD__ ); - copy( "$IP/tests/phpunit/data/parser/headbg.jpg", "$dir/0/09/Bad.jpg" ); - wfMkdirParents( $dir . '/f/ff', null, __METHOD__ ); - file_put_contents( "$dir/f/ff/Foobar.svg", - '' . - '' ); - wfMkdirParents( $dir . '/5/5f', null, __METHOD__ ); - copy( "$IP/tests/phpunit/data/parser/LoremIpsum.djvu", "$dir/5/5f/LoremIpsum.djvu" ); - wfMkdirParents( $dir . '/0/00', null, __METHOD__ ); - copy( "$IP/tests/phpunit/data/parser/320x240.ogv", "$dir/0/00/Video.ogv" ); - wfMkdirParents( $dir . '/4/41', null, __METHOD__ ); - copy( "$IP/tests/phpunit/data/media/say-test.ogg", "$dir/4/41/Audio.oga" ); - - return; - } - - /** - * Restore default values and perform any necessary clean-up - * after each test runs. - */ - private function teardownGlobals() { - RepoGroup::destroySingleton(); - FileBackendGroup::destroySingleton(); - LockManagerGroup::destroySingletons(); - LinkCache::singleton()->clear(); - MWTidy::destroySingleton(); - - foreach ( $this->savedGlobals as $var => $val ) { - $GLOBALS[$var] = $val; - } - } - - /** - * Remove the dummy uploads directory - * @param string $dir - */ - private function teardownUploadDir( $dir ) { - if ( $this->keepUploads ) { - return; - } - - // delete the files first, then the dirs. - self::deleteFiles( - [ - "$dir/3/3a/Foobar.jpg", - "$dir/thumb/3/3a/Foobar.jpg/*.jpg", - "$dir/e/ea/Thumb.png", - "$dir/0/09/Bad.jpg", - "$dir/5/5f/LoremIpsum.djvu", - "$dir/thumb/5/5f/LoremIpsum.djvu/*-LoremIpsum.djvu.jpg", - "$dir/f/ff/Foobar.svg", - "$dir/thumb/f/ff/Foobar.svg/*-Foobar.svg.png", - "$dir/math/f/a/5/fa50b8b616463173474302ca3e63586b.png", - "$dir/0/00/Video.ogv", - "$dir/thumb/0/00/Video.ogv/120px--Video.ogv.jpg", - "$dir/thumb/0/00/Video.ogv/180px--Video.ogv.jpg", - "$dir/thumb/0/00/Video.ogv/240px--Video.ogv.jpg", - "$dir/thumb/0/00/Video.ogv/320px--Video.ogv.jpg", - "$dir/thumb/0/00/Video.ogv/270px--Video.ogv.jpg", - "$dir/thumb/0/00/Video.ogv/320px-seek=2-Video.ogv.jpg", - "$dir/thumb/0/00/Video.ogv/320px-seek=3.3666666666667-Video.ogv.jpg", - "$dir/4/41/Audio.oga", - ] - ); - - self::deleteDirs( - [ - "$dir/3/3a", - "$dir/3", - "$dir/thumb/3/3a/Foobar.jpg", - "$dir/thumb/3/3a", - "$dir/thumb/3", - "$dir/e/ea", - "$dir/e", - "$dir/f/ff/", - "$dir/f/", - "$dir/thumb/f/ff/Foobar.svg", - "$dir/thumb/f/ff/", - "$dir/thumb/f/", - "$dir/0/00/", - "$dir/0/09/", - "$dir/0/", - "$dir/5/5f", - "$dir/5", - "$dir/thumb/0/00/Video.ogv", - "$dir/thumb/0/00", - "$dir/thumb/0", - "$dir/thumb/5/5f/LoremIpsum.djvu", - "$dir/thumb/5/5f", - "$dir/thumb/5", - "$dir/thumb", - "$dir/4/41", - "$dir/4", - "$dir/math/f/a/5", - "$dir/math/f/a", - "$dir/math/f", - "$dir/math", - "$dir/lockdir", - "$dir", - ] - ); - } - - /** - * Delete the specified files, if they exist. - * @param array $files Full paths to files to delete. - */ - private static function deleteFiles( $files ) { - foreach ( $files as $pattern ) { - foreach ( glob( $pattern ) as $file ) { - if ( file_exists( $file ) ) { - unlink( $file ); - } - } - } - } - - /** - * Delete the specified directories, if they exist. Must be empty. - * @param array $dirs Full paths to directories to delete. - */ - private static function deleteDirs( $dirs ) { - foreach ( $dirs as $dir ) { - if ( is_dir( $dir ) ) { - rmdir( $dir ); - } - } - } - - /** - * "Running test $desc..." - * @param string $desc - */ - protected function showTesting( $desc ) { - print "Running test $desc... "; - } - - /** - * Print a happy success message. - * - * Refactored in 1.22 to use ParserTestResult - * - * @param ParserTestResult $testResult - * @return bool - */ - protected function showSuccess( ParserTestResult $testResult ) { - if ( $this->showProgress ) { - print $this->term->color( '1;32' ) . 'PASSED' . $this->term->reset() . "\n"; - } - - return true; - } - - /** - * Print a failure message and provide some explanatory output - * about what went wrong if so configured. - * - * Refactored in 1.22 to use ParserTestResult - * - * @param ParserTestResult $testResult - * @return bool - */ - protected function showFailure( ParserTestResult $testResult ) { - if ( $this->showFailure ) { - if ( !$this->showProgress ) { - # In quiet mode we didn't show the 'Testing' message before the - # test, in case it succeeded. Show it now: - $this->showTesting( $testResult->description ); - } - - print $this->term->color( '31' ) . 'FAILED!' . $this->term->reset() . "\n"; - - if ( $this->showOutput ) { - print "--- Expected ---\n{$testResult->expected}\n"; - print "--- Actual ---\n{$testResult->actual}\n"; - } - - if ( $this->showDiffs ) { - print $this->quickDiff( $testResult->expected, $testResult->actual ); - if ( !$this->wellFormed( $testResult->actual ) ) { - print "XML error: $this->mXmlError\n"; - } - } - } - - return false; - } - - /** - * Print a skipped message. - * - * @return bool - */ - protected function showSkipped() { - if ( $this->showProgress ) { - print $this->term->color( '1;33' ) . 'SKIPPED' . $this->term->reset() . "\n"; - } - - return true; - } - - /** - * 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 - */ - protected function quickDiff( $input, $output, - $inFileTail = 'expected', $outFileTail = 'actual' - ) { - if ( $this->markWhitespace ) { - $pairs = [ - "\n" => '¶', - ' ' => '·', - "\t" => '→' - ]; - $input = strtr( $input, $pairs ); - $output = strtr( $output, $pairs ); - } - - # Windows, or at least the fc utility, is retarded - $slash = wfIsWindows() ? '\\' : '/'; - $prefix = wfTempDir() . "{$slash}mwParser-" . mt_rand(); - - $infile = "$prefix-$inFileTail"; - $this->dumpToFile( $input, $infile ); - - $outfile = "$prefix-$outFileTail"; - $this->dumpToFile( $output, $outfile ); - - $shellInfile = wfEscapeShellArg( $infile ); - $shellOutfile = wfEscapeShellArg( $outfile ); - - global $wgDiff3; - // we assume that people with diff3 also have usual diff - if ( $this->useDwdiff ) { - $shellCommand = 'dwdiff -Pc'; - } else { - $shellCommand = ( wfIsWindows() && !$wgDiff3 ) ? 'fc' : 'diff -au'; - } - - $diff = wfShellExec( "$shellCommand $shellInfile $shellOutfile" ); - - unlink( $infile ); - unlink( $outfile ); - - if ( $this->useDwdiff ) { - return $diff; - } else { - return $this->colorDiff( $diff ); - } - } - - /** - * Write the given string to a file, adding a final newline. - * - * @param string $data - * @param string $filename - */ - private function dumpToFile( $data, $filename ) { - $file = fopen( $filename, "wt" ); - fwrite( $file, $data . "\n" ); - fclose( $file ); - } - - /** - * Colorize unified diff output if set for ANSI color output. - * Subtractions are colored blue, additions red. - * - * @param string $text - * @return string - */ - protected function colorDiff( $text ) { - return preg_replace( - [ '/^(-.*)$/m', '/^(\+.*)$/m' ], - [ $this->term->color( 34 ) . '$1' . $this->term->reset(), - $this->term->color( 31 ) . '$1' . $this->term->reset() ], - $text ); - } - - /** - * Show "Reading tests from ..." - * - * @param string $path - */ - public function showRunFile( $path ) { - print $this->term->color( 1 ) . - "Reading tests from \"$path\"..." . - $this->term->reset() . - "\n"; - } - - /** - * Insert a temporary test article - * @param string $name The title, including any prefix - * @param string $text The article text - * @param int|string $line The input line number, for reporting errors - * @param bool|string $ignoreDuplicate Whether to silently ignore duplicate pages - * @throws Exception - * @throws MWException - */ - public static function addArticle( $name, $text, $line = 'unknown', $ignoreDuplicate = '' ) { - global $wgCapitalLinks; - - $oldCapitalLinks = $wgCapitalLinks; - $wgCapitalLinks = true; // We only need this from SetupGlobals() See r70917#c8637 - - $text = self::chomp( $text ); - $name = self::chomp( $name ); - - $title = Title::newFromText( $name ); - - if ( is_null( $title ) ) { - throw new MWException( "invalid title '$name' at line $line\n" ); - } - - $page = WikiPage::factory( $title ); - $page->loadPageData( 'fromdbmaster' ); - - if ( $page->exists() ) { - if ( $ignoreDuplicate == 'ignoreduplicate' ) { - return; - } else { - throw new MWException( "duplicate article '$name' at line $line\n" ); - } - } - - $page->doEditContent( ContentHandler::makeContent( $text, $title ), '', EDIT_NEW ); - - $wgCapitalLinks = $oldCapitalLinks; - } - - /** - * Steal a callback function from the primary parser, save it for - * application to our scary parser. If the hook is not installed, - * abort processing of this file. - * - * @param string $name - * @return bool True if tag hook is present - */ - public function requireHook( $name ) { - global $wgParser; - - $wgParser->firstCallInit(); // make sure hooks are loaded. - - if ( isset( $wgParser->mTagHooks[$name] ) ) { - $this->hooks[$name] = $wgParser->mTagHooks[$name]; - } else { - echo " This test suite requires the '$name' hook extension, skipping.\n"; - return false; - } - - return true; - } - - /** - * Steal a callback function from the primary parser, save it for - * application to our scary parser. If the hook is not installed, - * abort processing of this file. - * - * @param string $name - * @return bool True if function hook is present - */ - public function requireFunctionHook( $name ) { - global $wgParser; - - $wgParser->firstCallInit(); // make sure hooks are loaded. - - if ( isset( $wgParser->mFunctionHooks[$name] ) ) { - $this->functionHooks[$name] = $wgParser->mFunctionHooks[$name]; - } else { - echo " This test suite requires the '$name' function hook extension, skipping.\n"; - return false; - } - - return true; - } - - /** - * Steal a callback function from the primary parser, save it for - * application to our scary parser. If the hook is not installed, - * abort processing of this file. - * - * @param string $name - * @return bool True if function hook is present - */ - public function requireTransparentHook( $name ) { - global $wgParser; - - $wgParser->firstCallInit(); // make sure hooks are loaded. - - if ( isset( $wgParser->mTransparentTagHooks[$name] ) ) { - $this->transparentHooks[$name] = $wgParser->mTransparentTagHooks[$name]; - } else { - echo " This test suite requires the '$name' transparent hook extension, skipping.\n"; - return false; - } - - return true; - } - - private function wellFormed( $text ) { - $html = - Sanitizer::hackDocType() . - '' . - $text . - ''; - - $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; - } - - private function extractFragment( $text, $position ) { - $start = max( 0, $position - 10 ); - $before = $position - $start; - $fragment = '...' . - $this->term->color( 34 ) . - substr( $text, $start, $before ) . - $this->term->color( 0 ) . - $this->term->color( 31 ) . - $this->term->color( 1 ) . - substr( $text, $position, 1 ) . - $this->term->color( 0 ) . - $this->term->color( 34 ) . - substr( $text, $position + 1, 9 ) . - $this->term->color( 0 ) . - '...'; - $display = str_replace( "\n", ' ', $fragment ); - $caret = ' ' . - str_repeat( ' ', $before ) . - $this->term->color( 31 ) . - '^' . - $this->term->color( 0 ); - - return "$display\n$caret"; - } - - static function getFakeTimestamp( &$parser, &$ts ) { - $ts = 123; // parsed as '1970-01-01T00:02:03Z' - return true; - } -} - -class ParserTestResultNormalizer { - protected $doc, $xpath, $invalid; - - public static function normalize( $text, $funcs ) { - $norm = new self( $text ); - if ( $norm->invalid ) { - return $text; - } - foreach ( $funcs as $func ) { - $norm->$func(); - } - return $norm->serialize(); - } - - protected function __construct( $text ) { - $this->doc = new DOMDocument( '1.0', 'utf-8' ); - - // Note: parsing a supposedly XHTML document with an XML parser is not - // guaranteed to give accurate results. For example, it may introduce - // differences in the number of line breaks in
 tags.
-
-		MediaWiki\suppressWarnings();
-		if ( !$this->doc->loadXML( '' . $text . '' ) ) {
-			$this->invalid = true;
-		}
-		MediaWiki\restoreWarnings();
-		$this->xpath = new DOMXPath( $this->doc );
-		$this->body = $this->xpath->query( '//body' )->item( 0 );
-	}
-
-	protected function removeTbody() {
-		foreach ( $this->xpath->query( '//tbody' ) as $tbody ) {
-			while ( $tbody->firstChild ) {
-				$child = $tbody->firstChild;
-				$tbody->removeChild( $child );
-				$tbody->parentNode->insertBefore( $child, $tbody );
-			}
-			$tbody->parentNode->removeChild( $tbody );
-		}
-	}
-
-	/**
-	 * The point of this function is to produce a normalized DOM in which
-	 * Tidy's output matches the output of html5depurate. Tidy both trims
-	 * and pretty-prints, so this requires fairly aggressive treatment.
-	 *
-	 * In particular, note that Tidy converts 
x
to
\nx\n
, - * which theoretically affects display since the second line break is not - * ignored by compliant HTML parsers. - * - * This function also removes empty elements, as does Tidy. - */ - protected function trimWhitespace() { - foreach ( $this->xpath->query( '//text()' ) as $child ) { - if ( strtolower( $child->parentNode->nodeName ) === 'pre' ) { - // Just trim one line break from the start and end - if ( substr_compare( $child->data, "\n", 0 ) === 0 ) { - $child->data = substr( $child->data, 1 ); - } - if ( substr_compare( $child->data, "\n", -1 ) === 0 ) { - $child->data = substr( $child->data, 0, -1 ); - } - } else { - // Trim all whitespace - $child->data = trim( $child->data ); - } - if ( $child->data === '' ) { - $child->parentNode->removeChild( $child ); - } - } - } - - /** - * Serialize the XML DOM for comparison purposes. This does not generate HTML. - */ - protected function serialize() { - return strtr( $this->doc->saveXML( $this->body ), - [ '' => '', '' => '' ] ); - } -} diff --git a/tests/parser/parserTestsParserHook.php b/tests/parser/parserTestsParserHook.php deleted file mode 100644 index 5bf50ead6d..0000000000 --- a/tests/parser/parserTestsParserHook.php +++ /dev/null @@ -1,67 +0,0 @@ - - */ - -class ParserTestParserHook { - - static function setup( &$parser ) { - $parser->setHook( 'tag', [ __CLASS__, 'dumpHook' ] ); - $parser->setHook( 'tåg', [ __CLASS__, 'dumpHook' ] ); - $parser->setHook( 'statictag', [ __CLASS__, 'staticTagHook' ] ); - return true; - } - - static function dumpHook( $in, $argv ) { - return "
\n" .
-			var_export( $in, true ) . "\n" .
-			var_export( $argv, true ) . "\n" .
-			"
"; - } - - static function staticTagHook( $in, $argv, $parser ) { - if ( !count( $argv ) ) { - $parser->static_tag_buf = $in; - return ''; - } elseif ( count( $argv ) === 1 && isset( $argv['action'] ) - && $argv['action'] === 'flush' && $in === null - ) { - // Clear the buffer, we probably don't need to - if ( isset( $parser->static_tag_buf ) ) { - $tmp = $parser->static_tag_buf; - } else { - $tmp = ''; - } - $parser->static_tag_buf = null; - return $tmp; - } else { // wtf? - return - "\nCall this extension as string or as" . - " , not in any other way.\n" . - "text: " . var_export( $in, true ) . "\n" . - "argv: " . var_export( $argv, true ) . "\n"; - } - } -} diff --git a/tests/parserTests.php b/tests/parserTests.php index f961dd44ca..915eac63a7 100644 --- a/tests/parserTests.php +++ b/tests/parserTests.php @@ -52,8 +52,6 @@ Options: --setversion When using --record, set the version string to use (useful with git-svn so that you can get the exact revision) --keep-uploads Re-use the same upload directory for each test, don't delete it - --fuzz Do a fuzz test instead of a normal test - --seed Start the fuzz test from the specified seed --run-disabled run disabled tests --run-parsoid run parsoid tests (normally disabled) --dwdiff Use dwdiff to display diff output @@ -94,9 +92,5 @@ if ( isset( $options['file'] ) ) { $version = SpecialVersion::getVersion( 'nodb' ); echo "This is MediaWiki version {$version}.\n\n"; -if ( isset( $options['fuzz'] ) ) { - $tester->fuzzTest( $files ); -} else { - $ok = $tester->runTestsFromFiles( $files ); - exit( $ok ? 0 : 1 ); -} +$ok = $tester->runTestsFromFiles( $files ); +exit( $ok ? 0 : 1 ); diff --git a/tests/phpunit/includes/parser/NewParserTest.php b/tests/phpunit/includes/parser/NewParserTest.php index ad84c207b2..097e4136c3 100644 --- a/tests/phpunit/includes/parser/NewParserTest.php +++ b/tests/phpunit/includes/parser/NewParserTest.php @@ -29,11 +29,6 @@ class NewParserTest extends MediaWikiTestCase { public $functionHooks = []; public $transparentHooks = []; - // Fuzz test - public $maxFuzzTestLength = 300; - public $fuzzSeed = 0; - public $memoryLimit = 50; - /** * @var DjVuSupport */ @@ -837,144 +832,6 @@ class NewParserTest extends MediaWikiTestCase { $this->assertEquals( $result, $out, $desc ); } - /** - * Run a fuzz test series - * Draw input from a set of test files - * - * @todo fixme Needs some work to not eat memory until the world explodes - * - * @group ParserFuzz - */ - public function testFuzzTests() { - global $wgParserTestFiles; - - $files = $wgParserTestFiles; - - if ( $this->getCliArg( 'file' ) ) { - $files = [ $this->getCliArg( 'file' ) ]; - } - - $dict = $this->getFuzzInput( $files ); - $dictSize = strlen( $dict ); - $logMaxLength = log( $this->maxFuzzTestLength ); - - ini_set( 'memory_limit', $this->memoryLimit * 1048576 ); - - $user = new User; - $opts = ParserOptions::newFromUser( $user ); - $title = Title::makeTitle( NS_MAIN, 'Parser_test' ); - - $id = 1; - - while ( true ) { - - // Generate test input - mt_srand( ++$this->fuzzSeed ); - $totalLength = mt_rand( 1, $this->maxFuzzTestLength ); - $input = ''; - - while ( strlen( $input ) < $totalLength ) { - $logHairLength = mt_rand( 0, 1000000 ) / 1000000 * $logMaxLength; - $hairLength = min( intval( exp( $logHairLength ) ), $dictSize ); - $offset = mt_rand( 0, $dictSize - $hairLength ); - $input .= substr( $dict, $offset, $hairLength ); - } - - $this->setupGlobals(); - $parser = $this->getParser(); - - // Run the test - try { - $parser->parse( $input, $title, $opts ); - $this->assertTrue( true, "Test $id, fuzz seed {$this->fuzzSeed}" ); - } catch ( Exception $exception ) { - $input_dump = sprintf( "string(%d) \"%s\"\n", strlen( $input ), $input ); - - $this->assertTrue( false, "Test $id, fuzz seed {$this->fuzzSeed}. \n\n" . - "Input: $input_dump\n\nError: {$exception->getMessage()}\n\n" . - "Backtrace: {$exception->getTraceAsString()}" ); - } - - $this->teardownGlobals(); - $parser->__destruct(); - - if ( $id % 100 == 0 ) { - $usage = intval( memory_get_usage( true ) / $this->memoryLimit / 1048576 * 100 ); - // echo "{$this->fuzzSeed}: $numSuccess/$numTotal (mem: $usage%)\n"; - if ( $usage > 90 ) { - $ret = "Out of memory:\n"; - $memStats = $this->getMemoryBreakdown(); - - foreach ( $memStats as $name => $usage ) { - $ret .= "$name: $usage\n"; - } - - throw new MWException( $ret ); - } - } - - $id++; - } - } - - // Various getter functions - - /** - * Get an input dictionary from a set of parser test files - * @param array $filenames - * @return string - */ - function getFuzzInput( $filenames ) { - $dict = ''; - - foreach ( $filenames as $filename ) { - $contents = file_get_contents( $filename ); - preg_match_all( '/!!\s*input\n(.*?)\n!!\s*result/s', $contents, $matches ); - - foreach ( $matches[1] as $match ) { - $dict .= $match . "\n"; - } - } - - return $dict; - } - - /** - * Get a memory usage breakdown - * @return array - */ - function getMemoryBreakdown() { - $memStats = []; - - foreach ( $GLOBALS as $name => $value ) { - $memStats['$' . $name] = strlen( serialize( $value ) ); - } - - $classes = get_declared_classes(); - - foreach ( $classes as $class ) { - $rc = new ReflectionClass( $class ); - $props = $rc->getStaticProperties(); - $memStats[$class] = strlen( serialize( $props ) ); - $methods = $rc->getMethods(); - - foreach ( $methods as $method ) { - $memStats[$class] += strlen( serialize( $method->getStaticVariables() ) ); - } - } - - $functions = get_defined_functions(); - - foreach ( $functions['user'] as $function ) { - $rf = new ReflectionFunction( $function ); - $memStats["$function()"] = strlen( serialize( $rf->getStaticVariables() ) ); - } - - asort( $memStats ); - - return $memStats; - } - /** * Get a Parser object * @param Preprocessor $preprocessor diff --git a/tests/testHelpers.inc b/tests/testHelpers.inc deleted file mode 100644 index 13694063c1..0000000000 --- a/tests/testHelpers.inc +++ /dev/null @@ -1,908 +0,0 @@ -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; - } -}