3 * Generic backend for the MediaWiki parser test suite, used by both the
4 * standalone parserTests.php and the PHPUnit "parsertests" suite.
6 * Copyright © 2004, 2010 Brion Vibber <brion@pobox.com>
7 * https://www.mediawiki.org/
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
24 * @todo Make this more independent of the configuration (and if possible the database)
28 use Wikimedia\Rdbms\IDatabase
;
29 use MediaWiki\MediaWikiServices
;
30 use Wikimedia\ScopedCallback
;
35 class ParserTestRunner
{
37 * @var bool $useTemporaryTables Use temporary tables for the temporary database
39 private $useTemporaryTables = true;
42 * @var array $setupDone The status of each setup function
44 private $setupDone = [
45 'staticSetup' => false,
46 'perTestSetup' => false,
47 'setupDatabase' => false,
48 'setDatabase' => false,
49 'setupUploads' => false,
53 * Our connection to the database
59 * Database clone helper
72 private $tidyDriver = null;
80 * The upload directory, or null to not set up an upload directory
84 private $uploadDir = null;
87 * The name of the file backend to use, or null to use MockFileBackend.
90 private $fileBackendName;
93 * A complete regex for filtering tests.
99 * A list of normalization functions to apply to the expected and actual
103 private $normalizationFunctions = [];
106 * @param TestRecorder $recorder
107 * @param array $options
109 public function __construct( TestRecorder
$recorder, $options = [] ) {
110 $this->recorder
= $recorder;
112 if ( isset( $options['norm'] ) ) {
113 foreach ( $options['norm'] as $func ) {
114 if ( in_array( $func, [ 'removeTbody', 'trimWhitespace' ] ) ) {
115 $this->normalizationFunctions
[] = $func;
117 $this->recorder
->warning(
118 "Warning: unknown normalization option \"$func\"\n" );
123 if ( isset( $options['regex'] ) && $options['regex'] !== false ) {
124 $this->regex
= $options['regex'];
130 $this->keepUploads
= !empty( $options['keep-uploads'] );
132 $this->fileBackendName
= isset( $options['file-backend'] ) ?
133 $options['file-backend'] : false;
135 $this->runDisabled
= !empty( $options['run-disabled'] );
136 $this->runParsoid
= !empty( $options['run-parsoid'] );
138 $this->tidySupport
= new TidySupport( !empty( $options['use-tidy-config'] ) );
139 if ( !$this->tidySupport
->isEnabled() ) {
140 $this->recorder
->warning(
141 "Warning: tidy is not installed, skipping some tests\n" );
144 if ( isset( $options['upload-dir'] ) ) {
145 $this->uploadDir
= $options['upload-dir'];
149 public function getRecorder() {
150 return $this->recorder
;
154 * Do any setup which can be done once for all tests, independent of test
155 * options, except for database setup.
157 * Public setup functions in this class return a ScopedCallback object. When
158 * this object is destroyed by going out of scope, teardown of the
159 * corresponding test setup is performed.
161 * Teardown objects may be chained by passing a ScopedCallback from a
162 * previous setup stage as the $nextTeardown parameter. This enforces the
163 * convention that teardown actions are taken in reverse order to the
164 * corresponding setup actions. When $nextTeardown is specified, a
165 * ScopedCallback will be returned which first tears down the current
166 * setup stage, and then tears down the previous setup stage which was
167 * specified by $nextTeardown.
169 * @param ScopedCallback|null $nextTeardown
170 * @return ScopedCallback
172 public function staticSetup( $nextTeardown = null ) {
173 // A note on coding style:
175 // The general idea here is to keep setup code together with
176 // corresponding teardown code, in a fine-grained manner. We have two
177 // arrays: $setup and $teardown. The code snippets in the $setup array
178 // are executed at the end of the method, before it returns, and the
179 // code snippets in the $teardown array are executed in reverse order
180 // when the Wikimedia\ScopedCallback object is consumed.
182 // Because it is a common operation to save, set and restore global
183 // variables, we have an additional convention: when the array key of
184 // $setup is a string, the string is taken to be the name of the global
185 // variable, and the element value is taken to be the desired new value.
187 // It's acceptable to just do the setup immediately, instead of adding
188 // a closure to $setup, except when the setup action depends on global
189 // variable initialisation being done first. In this case, you have to
190 // append a closure to $setup after the global variable is appended.
192 // When you add to setup functions in this class, please keep associated
193 // setup and teardown actions together in the source code, and please
194 // add comments explaining why the setup action is necessary.
199 $teardown[] = $this->markSetupDone( 'staticSetup' );
201 // Some settings which influence HTML output
202 $setup['wgSitename'] = 'MediaWiki';
203 $setup['wgServer'] = 'http://example.org';
204 $setup['wgServerName'] = 'example.org';
205 $setup['wgScriptPath'] = '';
206 $setup['wgScript'] = '/index.php';
207 $setup['wgResourceBasePath'] = '';
208 $setup['wgStylePath'] = '/skins';
209 $setup['wgExtensionAssetsPath'] = '/extensions';
210 $setup['wgArticlePath'] = '/wiki/$1';
211 $setup['wgActionPaths'] = [];
212 $setup['wgVariantArticlePath'] = false;
213 $setup['wgUploadNavigationUrl'] = false;
214 $setup['wgCapitalLinks'] = true;
215 $setup['wgNoFollowLinks'] = true;
216 $setup['wgNoFollowDomainExceptions'] = [ 'no-nofollow.org' ];
217 $setup['wgExternalLinkTarget'] = false;
218 $setup['wgExperimentalHtmlIds'] = false;
219 $setup['wgLocaltimezone'] = 'UTC';
220 $setup['wgHtml5'] = true;
221 $setup['wgDisableLangConversion'] = false;
222 $setup['wgDisableTitleConversion'] = false;
224 // "extra language links"
225 // see https://gerrit.wikimedia.org/r/111390
226 $setup['wgExtraInterlanguageLinkPrefixes'] = [ 'mul' ];
228 // All FileRepo changes should be done here by injecting services,
229 // there should be no need to change global variables.
230 RepoGroup
::setSingleton( $this->createRepoGroup() );
231 $teardown[] = function () {
232 RepoGroup
::destroySingleton();
235 // Set up null lock managers
236 $setup['wgLockManagers'] = [ [
237 'name' => 'fsLockManager',
238 'class' => 'NullLockManager',
240 'name' => 'nullLockManager',
241 'class' => 'NullLockManager',
243 $reset = function() {
244 LockManagerGroup
::destroySingletons();
247 $teardown[] = $reset;
249 // This allows article insertion into the prefixed DB
250 $setup['wgDefaultExternalStore'] = false;
252 // This might slightly reduce memory usage
253 $setup['wgAdaptiveMessageCache'] = true;
255 // This is essential and overrides disabling of database messages in TestSetup
256 $setup['wgUseDatabaseMessages'] = true;
257 $reset = function () {
258 MessageCache
::destroyInstance();
261 $teardown[] = $reset;
263 // It's not necessary to actually convert any files
264 $setup['wgSVGConverter'] = 'null';
265 $setup['wgSVGConverters'] = [ 'null' => 'echo "1">$output' ];
267 // Fake constant timestamp
268 Hooks
::register( 'ParserGetVariableValueTs', 'ParserTestRunner::getFakeTimestamp' );
269 $teardown[] = function () {
270 Hooks
::clear( 'ParserGetVariableValueTs' );
273 $this->appendNamespaceSetup( $setup, $teardown );
275 // Set up interwikis and append teardown function
276 $teardown[] = $this->setupInterwikis();
278 // This affects title normalization in links. It invalidates
279 // MediaWikiTitleCodec objects.
280 $setup['wgLocalInterwikis'] = [ 'local', 'mi' ];
281 $reset = function () {
282 $this->resetTitleServices();
285 $teardown[] = $reset;
287 // Set up a mock MediaHandlerFactory
288 MediaWikiServices
::getInstance()->disableService( 'MediaHandlerFactory' );
289 MediaWikiServices
::getInstance()->redefineService(
290 'MediaHandlerFactory',
292 return new MockMediaHandlerFactory();
295 $teardown[] = function () {
296 MediaWikiServices
::getInstance()->resetServiceForTesting( 'MediaHandlerFactory' );
299 // SqlBagOStuff broke when using temporary tables on r40209 (T17892).
300 // It seems to have been fixed since (r55079?), but regressed at some point before r85701.
301 // This works around it for now...
302 global $wgObjectCaches;
303 $setup['wgObjectCaches'] = [ CACHE_DB
=> $wgObjectCaches['hash'] ] +
$wgObjectCaches;
304 if ( isset( ObjectCache
::$instances[CACHE_DB
] ) ) {
305 $savedCache = ObjectCache
::$instances[CACHE_DB
];
306 ObjectCache
::$instances[CACHE_DB
] = new HashBagOStuff
;
307 $teardown[] = function () use ( $savedCache ) {
308 ObjectCache
::$instances[CACHE_DB
] = $savedCache;
312 $teardown[] = $this->executeSetupSnippets( $setup );
314 // Schedule teardown snippets in reverse order
315 return $this->createTeardownObject( $teardown, $nextTeardown );
318 private function appendNamespaceSetup( &$setup, &$teardown ) {
319 // Add a namespace shadowing a interwiki link, to test
320 // proper precedence when resolving links. (T53680)
321 $setup['wgExtraNamespaces'] = [
322 100 => 'MemoryAlpha',
323 101 => 'MemoryAlpha_talk'
325 // Changing wgExtraNamespaces invalidates caches in MWNamespace and
326 // any live Language object, both on setup and teardown
327 $reset = function () {
328 MWNamespace
::getCanonicalNamespaces( true );
329 $GLOBALS['wgContLang']->resetNamespaces();
332 $teardown[] = $reset;
336 * Create a RepoGroup object appropriate for the current configuration
339 protected function createRepoGroup() {
340 if ( $this->uploadDir
) {
341 if ( $this->fileBackendName
) {
342 throw new MWException( 'You cannot specify both use-filebackend and upload-dir' );
344 $backend = new FSFileBackend( [
345 'name' => 'local-backend',
346 'wikiId' => wfWikiID(),
347 'basePath' => $this->uploadDir
,
348 'tmpDirectory' => wfTempDir()
350 } elseif ( $this->fileBackendName
) {
351 global $wgFileBackends;
352 $name = $this->fileBackendName
;
354 foreach ( $wgFileBackends as $conf ) {
355 if ( $conf['name'] === $name ) {
359 if ( $useConfig === false ) {
360 throw new MWException( "Unable to find file backend \"$name\"" );
362 $useConfig['name'] = 'local-backend'; // swap name
363 unset( $useConfig['lockManager'] );
364 unset( $useConfig['fileJournal'] );
365 $class = $useConfig['class'];
366 $backend = new $class( $useConfig );
368 # Replace with a mock. We do not care about generating real
369 # files on the filesystem, just need to expose the file
371 $backend = new MockFileBackend( [
372 'name' => 'local-backend',
373 'wikiId' => wfWikiID()
377 return new RepoGroup(
379 'class' => 'MockLocalRepo',
381 'url' => 'http://example.com/images',
383 'transformVia404' => false,
384 'backend' => $backend
391 * Execute an array in which elements with integer keys are taken to be
392 * callable objects, and other elements are taken to be global variable
393 * set operations, with the key giving the variable name and the value
394 * giving the new global variable value. A closure is returned which, when
395 * executed, sets the global variables back to the values they had before
396 * this function was called.
400 * @param array $setup
403 protected function executeSetupSnippets( $setup ) {
405 foreach ( $setup as $name => $value ) {
406 if ( is_int( $name ) ) {
409 $saved[$name] = isset( $GLOBALS[$name] ) ?
$GLOBALS[$name] : null;
410 $GLOBALS[$name] = $value;
413 return function () use ( $saved ) {
414 $this->executeSetupSnippets( $saved );
419 * Take a setup array in the same format as the one given to
420 * executeSetupSnippets(), and return a ScopedCallback which, when consumed,
421 * executes the snippets in the setup array in reverse order. This is used
422 * to create "teardown objects" for the public API.
426 * @param array $teardown The snippet array
427 * @param ScopedCallback|null A ScopedCallback to consume
428 * @return ScopedCallback
430 protected function createTeardownObject( $teardown, $nextTeardown = null ) {
431 return new ScopedCallback( function() use ( $teardown, $nextTeardown ) {
432 // Schedule teardown snippets in reverse order
433 $teardown = array_reverse( $teardown );
435 $this->executeSetupSnippets( $teardown );
436 if ( $nextTeardown ) {
437 ScopedCallback
::consume( $nextTeardown );
443 * Set a setupDone flag to indicate that setup has been done, and return
444 * the teardown closure. If the flag was already set, throw an exception.
446 * @param string $funcName The setup function name
449 protected function markSetupDone( $funcName ) {
450 if ( $this->setupDone
[$funcName] ) {
451 throw new MWException( "$funcName is already done" );
453 $this->setupDone
[$funcName] = true;
454 return function () use ( $funcName ) {
455 $this->setupDone
[$funcName] = false;
460 * Ensure a given setup stage has been done, throw an exception if it has
463 protected function checkSetupDone( $funcName, $funcName2 = null ) {
464 if ( !$this->setupDone
[$funcName]
465 && ( $funcName === null ||
!$this->setupDone
[$funcName2] )
467 throw new MWException( "$funcName must be called before calling " .
473 * Determine whether a particular setup function has been run
475 * @param string $funcName
478 public function isSetupDone( $funcName ) {
479 return isset( $this->setupDone
[$funcName] ) ?
$this->setupDone
[$funcName] : false;
483 * Insert hardcoded interwiki in the lookup table.
485 * This function insert a set of well known interwikis that are used in
486 * the parser tests. They can be considered has fixtures are injected in
487 * the interwiki cache by using the 'InterwikiLoadPrefix' hook.
488 * Since we are not interested in looking up interwikis in the database,
489 * the hook completely replace the existing mechanism (hook returns false).
491 * @return closure for teardown
493 private function setupInterwikis() {
494 # Hack: insert a few Wikipedia in-project interwiki prefixes,
495 # for testing inter-language links
496 Hooks
::register( 'InterwikiLoadPrefix', function ( $prefix, &$iwData ) {
497 static $testInterwikis = [
499 'iw_url' => 'http://doesnt.matter.org/$1',
504 'iw_url' => 'http://en.wikipedia.org/wiki/$1',
509 'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
514 'iw_url' => 'http://www.memory-alpha.org/en/index.php/$1',
519 'iw_url' => 'http://zh.wikipedia.org/wiki/$1',
524 'iw_url' => 'http://es.wikipedia.org/wiki/$1',
529 'iw_url' => 'http://fr.wikipedia.org/wiki/$1',
534 'iw_url' => 'http://ru.wikipedia.org/wiki/$1',
539 'iw_url' => 'http://mi.wikipedia.org/wiki/$1',
544 'iw_url' => 'http://wikisource.org/wiki/$1',
549 if ( array_key_exists( $prefix, $testInterwikis ) ) {
550 $iwData = $testInterwikis[$prefix];
553 // We only want to rely on the above fixtures
555 } );// hooks::register
559 Hooks
::clear( 'InterwikiLoadPrefix' );
564 * Reset the Title-related services that need resetting
567 private function resetTitleServices() {
568 $services = MediaWikiServices
::getInstance();
569 $services->resetServiceForTesting( 'TitleFormatter' );
570 $services->resetServiceForTesting( 'TitleParser' );
571 $services->resetServiceForTesting( '_MediaWikiTitleCodec' );
572 $services->resetServiceForTesting( 'LinkRenderer' );
573 $services->resetServiceForTesting( 'LinkRendererFactory' );
577 * Remove last character if it is a newline
582 public static function chomp( $s ) {
583 if ( substr( $s, -1 ) === "\n" ) {
584 return substr( $s, 0, -1 );
591 * Run a series of tests listed in the given text files.
592 * Each test consists of a brief description, wikitext input,
593 * and the expected HTML output.
595 * Prints status updates on stdout and counts up the total
596 * number and percentage of passed tests.
598 * Handles all setup and teardown.
600 * @param array $filenames Array of strings
601 * @return bool True if passed all tests, false if any tests failed.
603 public function runTestsFromFiles( $filenames ) {
606 $teardownGuard = $this->staticSetup();
607 $teardownGuard = $this->setupDatabase( $teardownGuard );
608 $teardownGuard = $this->setupUploads( $teardownGuard );
610 $this->recorder
->start();
614 foreach ( $filenames as $filename ) {
615 $testFileInfo = TestFileReader
::read( $filename, [
616 'runDisabled' => $this->runDisabled
,
617 'runParsoid' => $this->runParsoid
,
618 'regex' => $this->regex
] );
620 // Don't start the suite if there are no enabled tests in the file
621 if ( !$testFileInfo['tests'] ) {
625 $this->recorder
->startSuite( $filename );
626 $ok = $this->runTests( $testFileInfo ) && $ok;
627 $this->recorder
->endSuite( $filename );
630 $this->recorder
->report();
631 } catch ( DBError
$e ) {
632 $this->recorder
->warning( $e->getMessage() );
634 $this->recorder
->end();
636 ScopedCallback
::consume( $teardownGuard );
642 * Determine whether the current parser has the hooks registered in it
643 * that are required by a file read by TestFileReader.
645 public function meetsRequirements( $requirements ) {
646 foreach ( $requirements as $requirement ) {
647 switch ( $requirement['type'] ) {
649 $ok = $this->requireHook( $requirement['name'] );
652 $ok = $this->requireFunctionHook( $requirement['name'] );
654 case 'transparentHook':
655 $ok = $this->requireTransparentHook( $requirement['name'] );
666 * Run the tests from a single file. staticSetup() and setupDatabase()
667 * must have been called already.
669 * @param array $testFileInfo Parsed file info returned by TestFileReader
670 * @return bool True if passed all tests, false if any tests failed.
672 public function runTests( $testFileInfo ) {
675 $this->checkSetupDone( 'staticSetup' );
677 // Don't add articles from the file if there are no enabled tests from the file
678 if ( !$testFileInfo['tests'] ) {
682 // If any requirements are not met, mark all tests from the file as skipped
683 if ( !$this->meetsRequirements( $testFileInfo['requirements'] ) ) {
684 foreach ( $testFileInfo['tests'] as $test ) {
685 $this->recorder
->startTest( $test );
686 $this->recorder
->skipped( $test, 'required extension not enabled' );
692 $this->addArticles( $testFileInfo['articles'] );
695 foreach ( $testFileInfo['tests'] as $test ) {
696 $this->recorder
->startTest( $test );
698 $this->runTest( $test );
699 if ( $result !== false ) {
700 $ok = $ok && $result->isSuccess();
701 $this->recorder
->record( $test, $result );
709 * Get a Parser object
711 * @param string $preprocessor
714 function getParser( $preprocessor = null ) {
715 global $wgParserConf;
717 $class = $wgParserConf['class'];
718 $parser = new $class( [ 'preprocessorClass' => $preprocessor ] +
$wgParserConf );
719 ParserTestParserHook
::setup( $parser );
725 * Run a given wikitext input through a freshly-constructed wiki parser,
726 * and compare the output against the expected results.
727 * Prints status and explanatory messages to stdout.
729 * staticSetup() and setupWikiData() must be called before this function
732 * @param array $test The test parameters:
733 * - test: The test name
734 * - desc: The subtest description
735 * - input: Wikitext to try rendering
736 * - options: Array of test options
737 * - config: Overrides for global variables, one per line
739 * @return ParserTestResult or false if skipped
741 public function runTest( $test ) {
742 wfDebug( __METHOD__
.": running {$test['desc']}" );
743 $opts = $this->parseOptions( $test['options'] );
744 $teardownGuard = $this->perTestSetup( $test );
746 $context = RequestContext
::getMain();
747 $user = $context->getUser();
748 $options = ParserOptions
::newFromContext( $context );
750 if ( isset( $opts['tidy'] ) ) {
751 if ( !$this->tidySupport
->isEnabled() ) {
752 $this->recorder
->skipped( $test, 'tidy extension is not installed' );
755 $options->setTidy( true );
759 if ( isset( $opts['title'] ) ) {
760 $titleText = $opts['title'];
762 $titleText = 'Parser test';
765 $local = isset( $opts['local'] );
766 $preprocessor = isset( $opts['preprocessor'] ) ?
$opts['preprocessor'] : null;
767 $parser = $this->getParser( $preprocessor );
768 $title = Title
::newFromText( $titleText );
770 if ( isset( $opts['pst'] ) ) {
771 $out = $parser->preSaveTransform( $test['input'], $title, $user, $options );
772 } elseif ( isset( $opts['msg'] ) ) {
773 $out = $parser->transformMsg( $test['input'], $options, $title );
774 } elseif ( isset( $opts['section'] ) ) {
775 $section = $opts['section'];
776 $out = $parser->getSection( $test['input'], $section );
777 } elseif ( isset( $opts['replace'] ) ) {
778 $section = $opts['replace'][0];
779 $replace = $opts['replace'][1];
780 $out = $parser->replaceSection( $test['input'], $section, $replace );
781 } elseif ( isset( $opts['comment'] ) ) {
782 $out = Linker
::formatComment( $test['input'], $title, $local );
783 } elseif ( isset( $opts['preload'] ) ) {
784 $out = $parser->getPreloadText( $test['input'], $title, $options );
786 $output = $parser->parse( $test['input'], $title, $options, true, true, 1337 );
787 $output->setTOCEnabled( !isset( $opts['notoc'] ) );
788 $out = $output->getText();
789 if ( isset( $opts['tidy'] ) ) {
790 $out = preg_replace( '/\s+$/', '', $out );
793 if ( isset( $opts['showtitle'] ) ) {
794 if ( $output->getTitleText() ) {
795 $title = $output->getTitleText();
798 $out = "$title\n$out";
801 if ( isset( $opts['showindicators'] ) ) {
803 foreach ( $output->getIndicators() as $id => $content ) {
804 $indicators .= "$id=$content\n";
806 $out = $indicators . $out;
809 if ( isset( $opts['ill'] ) ) {
810 $out = implode( ' ', $output->getLanguageLinks() );
811 } elseif ( isset( $opts['cat'] ) ) {
813 foreach ( $output->getCategories() as $name => $sortkey ) {
817 $out .= "cat=$name sort=$sortkey";
822 ScopedCallback
::consume( $teardownGuard );
824 $expected = $test['result'];
825 if ( count( $this->normalizationFunctions
) ) {
826 $expected = ParserTestResultNormalizer
::normalize(
827 $test['expected'], $this->normalizationFunctions
);
828 $out = ParserTestResultNormalizer
::normalize( $out, $this->normalizationFunctions
);
831 $testResult = new ParserTestResult( $test, $expected, $out );
836 * Use a regex to find out the value of an option
837 * @param string $key Name of option val to retrieve
838 * @param array $opts Options array to look in
839 * @param mixed $default Default value returned if not found
842 private static function getOptionValue( $key, $opts, $default ) {
843 $key = strtolower( $key );
845 if ( isset( $opts[$key] ) ) {
853 * Given the options string, return an associative array of options.
854 * @todo Move this to TestFileReader
856 * @param string $instring
859 private function parseOptions( $instring ) {
865 // foo=bar,"baz quux"
868 (?<qstr> # Quoted string
870 (?:[^\\\\"] | \\\\.)*
876 [^"{}] | # Not a quoted string or object, or
877 (?&qstr) | # A quoted string, or
878 (?&json) # A json object (recursively)
884 (?&qstr) # Quoted val
892 (?&json) # JSON object
896 $regex = '/' . $defs . '\b
912 $valueregex = '/' . $defs . '(?&value)/x';
914 if ( preg_match_all( $regex, $instring, $matches, PREG_SET_ORDER
) ) {
915 foreach ( $matches as $bits ) {
916 $key = strtolower( $bits['k'] );
917 if ( !isset( $bits['v'] ) ) {
920 preg_match_all( $valueregex, $bits['v'], $vmatches );
921 $opts[$key] = array_map( [ $this, 'cleanupOption' ], $vmatches[0] );
922 if ( count( $opts[$key] ) == 1 ) {
923 $opts[$key] = $opts[$key][0];
931 private function cleanupOption( $opt ) {
932 if ( substr( $opt, 0, 1 ) == '"' ) {
933 return stripcslashes( substr( $opt, 1, -1 ) );
936 if ( substr( $opt, 0, 2 ) == '[[' ) {
937 return substr( $opt, 2, -2 );
940 if ( substr( $opt, 0, 1 ) == '{' ) {
941 return FormatJson
::decode( $opt, true );
947 * Do any required setup which is dependent on test options.
949 * @see staticSetup() for more information about setup/teardown
951 * @param array $test Test info supplied by TestFileReader
952 * @param callable|null $nextTeardown
953 * @return ScopedCallback
955 public function perTestSetup( $test, $nextTeardown = null ) {
958 $this->checkSetupDone( 'setupDatabase', 'setDatabase' );
959 $teardown[] = $this->markSetupDone( 'perTestSetup' );
961 $opts = $this->parseOptions( $test['options'] );
962 $config = $test['config'];
964 // Find out values for some special options.
966 self
::getOptionValue( 'language', $opts, 'en' );
968 self
::getOptionValue( 'variant', $opts, false );
970 self
::getOptionValue( 'wgMaxTocLevel', $opts, 999 );
971 $linkHolderBatchSize =
972 self
::getOptionValue( 'wgLinkHolderBatchSize', $opts, 1000 );
975 'wgEnableUploads' => self
::getOptionValue( 'wgEnableUploads', $opts, true ),
976 'wgLanguageCode' => $langCode,
977 'wgRawHtml' => self
::getOptionValue( 'wgRawHtml', $opts, false ),
978 'wgNamespacesWithSubpages' => array_fill_keys(
979 MWNamespace
::getValidNamespaces(), isset( $opts['subpage'] )
981 'wgMaxTocLevel' => $maxtoclevel,
982 'wgAllowExternalImages' => self
::getOptionValue( 'wgAllowExternalImages', $opts, true ),
983 'wgThumbLimits' => [ self
::getOptionValue( 'thumbsize', $opts, 180 ) ],
984 'wgDefaultLanguageVariant' => $variant,
985 'wgLinkHolderBatchSize' => $linkHolderBatchSize,
986 // Set as a JSON object like:
987 // wgEnableMagicLinks={"ISBN":false, "PMID":false, "RFC":false}
988 'wgEnableMagicLinks' => self
::getOptionValue( 'wgEnableMagicLinks', $opts, [] )
989 +
[ 'ISBN' => true, 'PMID' => true, 'RFC' => true ],
993 $configLines = explode( "\n", $config );
995 foreach ( $configLines as $line ) {
996 list( $var, $value ) = explode( '=', $line, 2 );
997 $setup[$var] = eval( "return $value;" );
1002 Hooks
::run( 'ParserTestGlobals', [ &$setup ] );
1004 // Create tidy driver
1005 if ( isset( $opts['tidy'] ) ) {
1006 // Cache a driver instance
1007 if ( $this->tidyDriver
=== null ) {
1008 $this->tidyDriver
= MWTidy
::factory( $this->tidySupport
->getConfig() );
1010 $tidy = $this->tidyDriver
;
1014 MWTidy
::setInstance( $tidy );
1015 $teardown[] = function () {
1016 MWTidy
::destroySingleton();
1019 // Set content language. This invalidates the magic word cache and title services
1020 $lang = Language
::factory( $langCode );
1021 $setup['wgContLang'] = $lang;
1022 $reset = function () {
1023 MagicWord
::clearCache();
1024 $this->resetTitleServices();
1027 $teardown[] = $reset;
1029 // Make a user object with the same language
1031 $user->setOption( 'language', $langCode );
1032 $setup['wgLang'] = $lang;
1034 // We (re)set $wgThumbLimits to a single-element array above.
1035 $user->setOption( 'thumbsize', 0 );
1037 $setup['wgUser'] = $user;
1039 // And put both user and language into the context
1040 $context = RequestContext
::getMain();
1041 $context->setUser( $user );
1042 $context->setLanguage( $lang );
1043 $teardown[] = function () use ( $context ) {
1044 // Reset context to the restored globals
1045 $context->setUser( $GLOBALS['wgUser'] );
1046 $context->setLanguage( $GLOBALS['wgContLang'] );
1049 $teardown[] = $this->executeSetupSnippets( $setup );
1051 return $this->createTeardownObject( $teardown, $nextTeardown );
1055 * List of temporary tables to create, without prefix.
1056 * Some of these probably aren't necessary.
1059 private function listTables() {
1060 $tables = [ 'user', 'user_properties', 'user_former_groups', 'page', 'page_restrictions',
1061 'protected_titles', 'revision', 'text', 'pagelinks', 'imagelinks',
1062 'categorylinks', 'templatelinks', 'externallinks', 'langlinks', 'iwlinks',
1063 'site_stats', 'ipblocks', 'image', 'oldimage',
1064 'recentchanges', 'watchlist', 'interwiki', 'logging', 'log_search',
1065 'querycache', 'objectcache', 'job', 'l10n_cache', 'redirect', 'querycachetwo',
1066 'archive', 'user_groups', 'page_props', 'category'
1069 if ( in_array( $this->db
->getType(), [ 'mysql', 'sqlite', 'oracle' ] ) ) {
1070 array_push( $tables, 'searchindex' );
1073 // Allow extensions to add to the list of tables to duplicate;
1074 // may be necessary if they hook into page save or other code
1075 // which will require them while running tests.
1076 Hooks
::run( 'ParserTestTables', [ &$tables ] );
1081 public function setDatabase( IDatabase
$db ) {
1083 $this->setupDone
['setDatabase'] = true;
1087 * Set up temporary DB tables.
1089 * For best performance, call this once only for all tests. However, it can
1090 * be called at the start of each test if more isolation is desired.
1092 * @todo: This is basically an unrefactored copy of
1093 * MediaWikiTestCase::setupAllTestDBs. They should be factored out somehow.
1095 * Do not call this function from a MediaWikiTestCase subclass, since
1096 * MediaWikiTestCase does its own DB setup. Instead use setDatabase().
1098 * @see staticSetup() for more information about setup/teardown
1100 * @param ScopedCallback|null $nextTeardown The next teardown object
1101 * @return ScopedCallback The teardown object
1103 public function setupDatabase( $nextTeardown = null ) {
1106 $this->db
= wfGetDB( DB_MASTER
);
1107 $dbType = $this->db
->getType();
1109 if ( $dbType == 'oracle' ) {
1110 $suspiciousPrefixes = [ 'pt_', MediaWikiTestCase
::ORA_DB_PREFIX
];
1112 $suspiciousPrefixes = [ 'parsertest_', MediaWikiTestCase
::DB_PREFIX
];
1114 if ( in_array( $wgDBprefix, $suspiciousPrefixes ) ) {
1115 throw new MWException( "\$wgDBprefix=$wgDBprefix suggests DB setup is already done" );
1120 $teardown[] = $this->markSetupDone( 'setupDatabase' );
1122 # CREATE TEMPORARY TABLE breaks if there is more than one server
1123 if ( wfGetLB()->getServerCount() != 1 ) {
1124 $this->useTemporaryTables
= false;
1127 $temporary = $this->useTemporaryTables ||
$dbType == 'postgres';
1128 $prefix = $dbType != 'oracle' ?
'parsertest_' : 'pt_';
1130 $this->dbClone
= new CloneDatabase( $this->db
, $this->listTables(), $prefix );
1131 $this->dbClone
->useTemporaryTables( $temporary );
1132 $this->dbClone
->cloneTableStructure();
1134 if ( $dbType == 'oracle' ) {
1135 $this->db
->query( 'BEGIN FILL_WIKI_INFO; END;' );
1136 # Insert 0 user to prevent FK violations
1139 $this->db
->insert( 'user', [
1141 'user_name' => 'Anonymous' ] );
1144 $teardown[] = function () {
1145 $this->teardownDatabase();
1148 // Wipe some DB query result caches on setup and teardown
1149 $reset = function () {
1150 LinkCache
::singleton()->clear();
1152 // Clear the message cache
1153 MessageCache
::singleton()->clear();
1156 $teardown[] = $reset;
1157 return $this->createTeardownObject( $teardown, $nextTeardown );
1161 * Add data about uploads to the new test DB, and set up the upload
1162 * directory. This should be called after either setDatabase() or
1165 * @param ScopedCallback|null $nextTeardown The next teardown object
1166 * @return ScopedCallback The teardown object
1168 public function setupUploads( $nextTeardown = null ) {
1171 $this->checkSetupDone( 'setupDatabase', 'setDatabase' );
1172 $teardown[] = $this->markSetupDone( 'setupUploads' );
1174 // Create the files in the upload directory (or pretend to create them
1175 // in a MockFileBackend). Append teardown callback.
1176 $teardown[] = $this->setupUploadBackend();
1179 $user = User
::createNew( 'WikiSysop' );
1181 // Register the uploads in the database
1183 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'Foobar.jpg' ) );
1184 # note that the size/width/height/bits/etc of the file
1185 # are actually set by inspecting the file itself; the arguments
1186 # to recordUpload2 have no effect. That said, we try to make things
1187 # match up so it is less confusing to readers of the code & tests.
1188 $image->recordUpload2( '', 'Upload of some lame file', 'Some lame file', [
1193 'media_type' => MEDIATYPE_BITMAP
,
1194 'mime' => 'image/jpeg',
1195 'metadata' => serialize( [] ),
1196 'sha1' => Wikimedia\base_convert
( '1', 16, 36, 31 ),
1197 'fileExists' => true
1198 ], $this->db
->timestamp( '20010115123500' ), $user );
1200 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'Thumb.png' ) );
1201 # again, note that size/width/height below are ignored; see above.
1202 $image->recordUpload2( '', 'Upload of some lame thumbnail', 'Some lame thumbnail', [
1207 'media_type' => MEDIATYPE_BITMAP
,
1208 'mime' => 'image/png',
1209 'metadata' => serialize( [] ),
1210 'sha1' => Wikimedia\base_convert
( '2', 16, 36, 31 ),
1211 'fileExists' => true
1212 ], $this->db
->timestamp( '20130225203040' ), $user );
1214 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'Foobar.svg' ) );
1215 $image->recordUpload2( '', 'Upload of some lame SVG', 'Some lame SVG', [
1220 'media_type' => MEDIATYPE_DRAWING
,
1221 'mime' => 'image/svg+xml',
1222 'metadata' => serialize( [] ),
1223 'sha1' => Wikimedia\base_convert
( '', 16, 36, 31 ),
1224 'fileExists' => true
1225 ], $this->db
->timestamp( '20010115123500' ), $user );
1227 # This image will be blacklisted in [[MediaWiki:Bad image list]]
1228 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'Bad.jpg' ) );
1229 $image->recordUpload2( '', 'zomgnotcensored', 'Borderline image', [
1234 'media_type' => MEDIATYPE_BITMAP
,
1235 'mime' => 'image/jpeg',
1236 'metadata' => serialize( [] ),
1237 'sha1' => Wikimedia\base_convert
( '3', 16, 36, 31 ),
1238 'fileExists' => true
1239 ], $this->db
->timestamp( '20010115123500' ), $user );
1241 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'Video.ogv' ) );
1242 $image->recordUpload2( '', 'A pretty movie', 'Will it play', [
1247 'media_type' => MEDIATYPE_VIDEO
,
1248 'mime' => 'application/ogg',
1249 'metadata' => serialize( [] ),
1250 'sha1' => Wikimedia\base_convert
( '', 16, 36, 31 ),
1251 'fileExists' => true
1252 ], $this->db
->timestamp( '20010115123500' ), $user );
1254 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'Audio.oga' ) );
1255 $image->recordUpload2( '', 'An awesome hitsong', 'Will it play', [
1260 'media_type' => MEDIATYPE_AUDIO
,
1261 'mime' => 'application/ogg',
1262 'metadata' => serialize( [] ),
1263 'sha1' => Wikimedia\base_convert
( '', 16, 36, 31 ),
1264 'fileExists' => true
1265 ], $this->db
->timestamp( '20010115123500' ), $user );
1268 $image = wfLocalFile( Title
::makeTitle( NS_FILE
, 'LoremIpsum.djvu' ) );
1269 $image->recordUpload2( '', 'Upload a DjVu', 'A DjVu', [
1274 'media_type' => MEDIATYPE_BITMAP
,
1275 'mime' => 'image/vnd.djvu',
1276 'metadata' => '<?xml version="1.0" ?>
1277 <!DOCTYPE DjVuXML PUBLIC "-//W3C//DTD DjVuXML 1.1//EN" "pubtext/DjVuXML-s.dtd">
1280 <BODY><OBJECT height="3508" width="2480">
1281 <PARAM name="DPI" value="300" />
1282 <PARAM name="GAMMA" value="2.2" />
1284 <OBJECT height="3508" width="2480">
1285 <PARAM name="DPI" value="300" />
1286 <PARAM name="GAMMA" value="2.2" />
1288 <OBJECT height="3508" width="2480">
1289 <PARAM name="DPI" value="300" />
1290 <PARAM name="GAMMA" value="2.2" />
1292 <OBJECT height="3508" width="2480">
1293 <PARAM name="DPI" value="300" />
1294 <PARAM name="GAMMA" value="2.2" />
1296 <OBJECT height="3508" width="2480">
1297 <PARAM name="DPI" value="300" />
1298 <PARAM name="GAMMA" value="2.2" />
1302 'sha1' => Wikimedia\base_convert
( '', 16, 36, 31 ),
1303 'fileExists' => true
1304 ], $this->db
->timestamp( '20010115123600' ), $user );
1306 return $this->createTeardownObject( $teardown, $nextTeardown );
1310 * Helper for database teardown, called from the teardown closure. Destroy
1311 * the database clone and fix up some things that CloneDatabase doesn't fix.
1313 * @todo Move most things here to CloneDatabase
1315 private function teardownDatabase() {
1316 $this->checkSetupDone( 'setupDatabase' );
1318 $this->dbClone
->destroy();
1319 $this->databaseSetupDone
= false;
1321 if ( $this->useTemporaryTables
) {
1322 if ( $this->db
->getType() == 'sqlite' ) {
1323 # Under SQLite the searchindex table is virtual and need
1324 # to be explicitly destroyed. See T31912
1325 # See also MediaWikiTestCase::destroyDB()
1326 wfDebug( __METHOD__
. " explicitly destroying sqlite virtual table parsertest_searchindex\n" );
1327 $this->db
->query( "DROP TABLE `parsertest_searchindex`" );
1329 # Don't need to do anything
1333 $tables = $this->listTables();
1335 foreach ( $tables as $table ) {
1336 if ( $this->db
->getType() == 'oracle' ) {
1337 $this->db
->query( "DROP TABLE pt_$table DROP CONSTRAINTS" );
1339 $this->db
->query( "DROP TABLE `parsertest_$table`" );
1343 if ( $this->db
->getType() == 'oracle' ) {
1344 $this->db
->query( 'BEGIN FILL_WIKI_INFO; END;' );
1349 * Upload test files to the backend created by createRepoGroup().
1351 * @return callable The teardown callback
1353 private function setupUploadBackend() {
1356 $repo = RepoGroup
::singleton()->getLocalRepo();
1357 $base = $repo->getZonePath( 'public' );
1358 $backend = $repo->getBackend();
1359 $backend->prepare( [ 'dir' => "$base/3/3a" ] );
1361 'src' => "$IP/tests/phpunit/data/parser/headbg.jpg",
1362 'dst' => "$base/3/3a/Foobar.jpg"
1364 $backend->prepare( [ 'dir' => "$base/e/ea" ] );
1366 'src' => "$IP/tests/phpunit/data/parser/wiki.png",
1367 'dst' => "$base/e/ea/Thumb.png"
1369 $backend->prepare( [ 'dir' => "$base/0/09" ] );
1371 'src' => "$IP/tests/phpunit/data/parser/headbg.jpg",
1372 'dst' => "$base/0/09/Bad.jpg"
1374 $backend->prepare( [ 'dir' => "$base/5/5f" ] );
1376 'src' => "$IP/tests/phpunit/data/parser/LoremIpsum.djvu",
1377 'dst' => "$base/5/5f/LoremIpsum.djvu"
1380 // No helpful SVG file to copy, so make one ourselves
1381 $data = '<?xml version="1.0" encoding="utf-8"?>' .
1382 '<svg xmlns="http://www.w3.org/2000/svg"' .
1383 ' version="1.1" width="240" height="180"/>';
1385 $backend->prepare( [ 'dir' => "$base/f/ff" ] );
1386 $backend->quickCreate( [
1387 'content' => $data, 'dst' => "$base/f/ff/Foobar.svg"
1390 return function () use ( $backend ) {
1391 if ( $backend instanceof MockFileBackend
) {
1392 // In memory backend, so dont bother cleaning them up.
1395 $this->teardownUploadBackend();
1400 * Remove the dummy uploads directory
1402 private function teardownUploadBackend() {
1403 if ( $this->keepUploads
) {
1407 $repo = RepoGroup
::singleton()->getLocalRepo();
1408 $public = $repo->getZonePath( 'public' );
1412 "$public/3/3a/Foobar.jpg",
1413 "$public/e/ea/Thumb.png",
1414 "$public/0/09/Bad.jpg",
1415 "$public/5/5f/LoremIpsum.djvu",
1416 "$public/f/ff/Foobar.svg",
1417 "$public/0/00/Video.ogv",
1418 "$public/4/41/Audio.oga",
1424 * Delete the specified files and their parent directories
1425 * @param array $files File backend URIs mwstore://...
1427 private function deleteFiles( $files ) {
1429 $backend = RepoGroup
::singleton()->getLocalRepo()->getBackend();
1430 foreach ( $files as $file ) {
1431 $backend->delete( [ 'src' => $file ], [ 'force' => 1 ] );
1434 // Delete the parent directories
1435 foreach ( $files as $file ) {
1436 $tmp = FileBackend
::parentStoragePath( $file );
1438 if ( !$backend->clean( [ 'dir' => $tmp ] )->isOK() ) {
1441 $tmp = FileBackend
::parentStoragePath( $tmp );
1447 * Add articles to the test DB.
1449 * @param $articles Article info array from TestFileReader
1451 public function addArticles( $articles ) {
1456 // Be sure ParserTestRunner::addArticle has correct language set,
1457 // so that system messages get into the right language cache
1458 if ( $wgContLang->getCode() !== 'en' ) {
1459 $setup['wgLanguageCode'] = 'en';
1460 $setup['wgContLang'] = Language
::factory( 'en' );
1463 // Add special namespaces, in case that hasn't been done by staticSetup() yet
1464 $this->appendNamespaceSetup( $setup, $teardown );
1466 // wgCapitalLinks obviously needs initialisation
1467 $setup['wgCapitalLinks'] = true;
1469 $teardown[] = $this->executeSetupSnippets( $setup );
1471 foreach ( $articles as $info ) {
1472 $this->addArticle( $info['name'], $info['text'], $info['file'], $info['line'] );
1475 // Wipe WANObjectCache process cache, which is invalidated by article insertion
1477 ObjectCache
::getMainWANInstance()->clearProcessCache();
1479 $this->executeSetupSnippets( $teardown );
1483 * Insert a temporary test article
1484 * @param string $name The title, including any prefix
1485 * @param string $text The article text
1486 * @param string $file The input file name
1487 * @param int|string $line The input line number, for reporting errors
1489 * @throws MWException
1491 private function addArticle( $name, $text, $file, $line ) {
1492 $text = self
::chomp( $text );
1493 $name = self
::chomp( $name );
1495 $title = Title
::newFromText( $name );
1496 wfDebug( __METHOD__
. ": adding $name" );
1498 if ( is_null( $title ) ) {
1499 throw new MWException( "invalid title '$name' at $file:$line\n" );
1502 $page = WikiPage
::factory( $title );
1503 $page->loadPageData( 'fromdbmaster' );
1505 if ( $page->exists() ) {
1506 throw new MWException( "duplicate article '$name' at $file:$line\n" );
1509 // Use mock parser, to make debugging of actual parser tests simpler.
1510 // But initialise the MessageCache clone first, don't let MessageCache
1511 // get a reference to the mock object.
1512 MessageCache
::singleton()->getParser();
1513 $restore = $this->executeSetupSnippets( [ 'wgParser' => new ParserTestMockParser
] );
1514 $status = $page->doEditContent(
1515 ContentHandler
::makeContent( $text, $title ),
1517 EDIT_NEW | EDIT_INTERNAL
1521 if ( !$status->isOK() ) {
1522 throw new MWException( $status->getWikiText( false, false, 'en' ) );
1525 // The RepoGroup cache is invalidated by the creation of file redirects
1526 if ( $title->inNamespace( NS_FILE
) ) {
1527 RepoGroup
::singleton()->clearCache( $title );
1532 * Check if a hook is installed
1534 * @param string $name
1535 * @return bool True if tag hook is present
1537 public function requireHook( $name ) {
1540 $wgParser->firstCallInit(); // make sure hooks are loaded.
1541 if ( isset( $wgParser->mTagHooks
[$name] ) ) {
1544 $this->recorder
->warning( " This test suite requires the '$name' hook " .
1545 "extension, skipping." );
1551 * Check if a function hook is installed
1553 * @param string $name
1554 * @return bool True if function hook is present
1556 public function requireFunctionHook( $name ) {
1559 $wgParser->firstCallInit(); // make sure hooks are loaded.
1561 if ( isset( $wgParser->mFunctionHooks
[$name] ) ) {
1564 $this->recorder
->warning( " This test suite requires the '$name' function " .
1565 "hook extension, skipping." );
1571 * Check if a transparent tag hook is installed
1573 * @param string $name
1574 * @return bool True if function hook is present
1576 public function requireTransparentHook( $name ) {
1579 $wgParser->firstCallInit(); // make sure hooks are loaded.
1581 if ( isset( $wgParser->mTransparentTagHooks
[$name] ) ) {
1584 $this->recorder
->warning( " This test suite requires the '$name' transparent " .
1585 "hook extension, skipping.\n" );
1591 * The ParserGetVariableValueTs hook, used to make sure time-related parser
1592 * functions give a persistent value.
1594 static function getFakeTimestamp( &$parser, &$ts ) {
1595 $ts = 123; // parsed as '1970-01-01T00:02:03Z'