Collaboration diagram for ParserTestRunner:

[legend]

Public Member Functions
	__construct (TestRecorder $recorder, $options=[])

	addArticles ( $articles)
	Add articles to the test DB.

	getParser ( $preprocessor=null)
	Get a Parser object.

	getRecorder ()

	isSetupDone ( $funcName)
	Determine whether a particular setup function has been run.

	meetsRequirements ( $requirements)
	Determine whether the current parser has the hooks registered in it that are required by a file read by TestFileReader.

	perTestSetup ( $test, $nextTeardown=null)
	Do any required setup which is dependent on test options.

	requireFunctionHook ( $name)
	Check if a function hook is installed.

	requireHook ( $name)
	Check if a hook is installed.

	requireTransparentHook ( $name)
	Check if a transparent tag hook is installed.

	runTest ( $test)
	Run a given wikitext input through a freshly-constructed wiki parser, and compare the output against the expected results.

	runTests ( $testFileInfo)
	Run the tests from a single file.

	runTestsFromFiles ( $filenames)
	Run a series of tests listed in the given text files.

	setDatabase (IDatabase $db)

	setupDatabase ( $nextTeardown=null)
	Set up temporary DB tables.

	setupUploads ( $nextTeardown=null)
	Add data about uploads to the new test DB, and set up the upload directory.

	staticSetup ( $nextTeardown=null)
	Do any setup which can be done once for all tests, independent of test options, except for database setup.

Static Public Member Functions
static	chomp ( $s)
	Remove last character if it is a newline utility.

static	getFakeTimestamp (&$parser, &$ts)
	The ParserGetVariableValueTs hook, used to make sure time-related parser functions give a persistent value.

Protected Member Functions
	checkSetupDone ( $funcName, $funcName2=null)
	Ensure a given setup stage has been done, throw an exception if it has not.

	createRepoGroup ()
	Create a RepoGroup object appropriate for the current configuration.

	createTeardownObject ( $teardown, $nextTeardown)
	Take a setup array in the same format as the one given to executeSetupSnippets(), and return a ScopedCallback which, when consumed, executes the snippets in the setup array in reverse order.

	executeSetupSnippets ( $setup)
	Execute an array in which elements with integer keys are taken to be callable objects, and other elements are taken to be global variable set operations, with the key giving the variable name and the value giving the new global variable value.

	markSetupDone ( $funcName)
	Set a setupDone flag to indicate that setup has been done, and return the teardown closure.

Private Member Functions
	addArticle ( $name, $text, $file, $line)
	Insert a temporary test article.

	appendNamespaceSetup (&$setup, &$teardown)

	cleanupOption ( $opt)

	deleteFiles ( $files)
	Delete the specified files and their parent directories.

	listTables ()
	List of temporary tables to create, without prefix.

	parseOptions ( $instring)
	Given the options string, return an associative array of options.

	resetTitleServices ()
	Reset the Title-related services that need resetting for each test.

	setupInterwikis ()
	Insert hardcoded interwiki in the lookup table.

	setupUploadBackend ()
	Upload test files to the backend created by createRepoGroup().

	teardownDatabase ()
	Helper for database teardown, called from the teardown closure.

	teardownUploadBackend ()
	Remove the dummy uploads directory.

Static Private Member Functions
static	getOptionValue ( $key, $opts, $default)
	Use a regex to find out the value of an option.

Private Attributes
Database	$db
	Our connection to the database.

CloneDatabase	$dbClone
	Database clone helper.

string null	$fileBackendName
	The name of the file backend to use, or null to use MockFileBackend.

array	$normalizationFunctions = []
	A list of normalization functions to apply to the expected and actual output.

TestRecorder	$recorder

string	$regex
	A complete regex for filtering tests.

	$setupDone

TidyDriverBase	$tidyDriver = null

TidySupport	$tidySupport

string null	$uploadDir = null
	The upload directory, or null to not set up an upload directory.

	$useTemporaryTables = true

Detailed Description

Definition at line 34 of file ParserTestRunner.php.

Constructor & Destructor Documentation

◆ __construct()

ParserTestRunner::__construct	(	TestRecorder	$recorder,
			$options = `[]`
	)

Parameters

TestRecorder	$recorder
array	$options

Definition at line 108 of file ParserTestRunner.php.

References $options, $recorder, as, and TestRecorder\warning().

Member Function Documentation

◆ addArticle()

ParserTestRunner::addArticle	(	$name,
		$text,
		$file,
		$line
	)

private

Insert a temporary test article.

Parameters

string	$name	The title, including any prefix
string	$text	The article text
string	$file	The input file name
int \| string	$line	The input line number, for reporting errors

Exceptions

Exception
MWException

Definition at line 1488 of file ParserTestRunner.php.

References $name, $page, $status, $title, chomp(), EDIT_NEW, WikiPage\factory(), ContentHandler\makeContent(), NS_FILE, RepoGroup\singleton(), and wfDebug().

Referenced by addArticles().

◆ addArticles()

ParserTestRunner::addArticles ( $articles )

Add articles to the test DB.

Parameters

$articles Article info array from TestFileReader

Definition at line 1448 of file ParserTestRunner.php.

References $wgContLang, addArticle(), appendNamespaceSetup(), as, executeSetupSnippets(), and global.

Referenced by runTests().

◆ appendNamespaceSetup()

ParserTestRunner::appendNamespaceSetup	(	&	$setup,
		&	$teardown
	)

private

Definition at line 317 of file ParserTestRunner.php.

References $GLOBALS.

Referenced by addArticles(), and staticSetup().

◆ checkSetupDone()

ParserTestRunner::checkSetupDone	(	$funcName,
		$funcName2 = `null`
	)

protected

Ensure a given setup stage has been done, throw an exception if it has not.

Definition at line 462 of file ParserTestRunner.php.

References wfGetCaller().

Referenced by perTestSetup(), runTests(), setupUploads(), and teardownDatabase().

◆ chomp()

static ParserTestRunner::chomp ( $s )

static

Remove last character if it is a newline utility.

Parameters

string $s

Returns: string

Definition at line 581 of file ParserTestRunner.php.

References $s.

Referenced by addArticle(), and TestFileReader\execute().

◆ cleanupOption()

ParserTestRunner::cleanupOption ( $opt )

private

Definition at line 930 of file ParserTestRunner.php.

◆ createRepoGroup()

ParserTestRunner::createRepoGroup ( )

protected

Create a RepoGroup object appropriate for the current configuration.

Returns: RepoGroup

Definition at line 338 of file ParserTestRunner.php.

References $fileBackendName, $name, $wgFileBackends, as, global, wfTempDir(), and wfWikiID().

Referenced by staticSetup().

◆ createTeardownObject()

ParserTestRunner::createTeardownObject	(	$teardown,
		$nextTeardown
	)

protected

Take a setup array in the same format as the one given to executeSetupSnippets(), and return a ScopedCallback which, when consumed, executes the snippets in the setup array in reverse order.

This is used to create "teardown objects" for the public API.

See also: staticSetup

Parameters

array	$teardown	The snippet array
	ScopedCallback\|null	A ScopedCallback to consume

Returns: ScopedCallback

Definition at line 429 of file ParserTestRunner.php.

References executeSetupSnippets(), and use.

Referenced by perTestSetup(), setupDatabase(), setupUploads(), and staticSetup().

◆ deleteFiles()

ParserTestRunner::deleteFiles ( $files )

private

Delete the specified files and their parent directories.

Parameters

array $files File backend URIs mwstore://...

Definition at line 1424 of file ParserTestRunner.php.

References $files, as, FileBackend\parentStoragePath(), and RepoGroup\singleton().

Referenced by teardownUploadBackend().

◆ executeSetupSnippets()

ParserTestRunner::executeSetupSnippets ( $setup )

protected

Execute an array in which elements with integer keys are taken to be callable objects, and other elements are taken to be global variable set operations, with the key giving the variable name and the value giving the new global variable value.

A closure is returned which, when executed, sets the global variables back to the values they had before this function was called.

See also: staticSetup

Parameters

array $setup

Returns: closure

Definition at line 402 of file ParserTestRunner.php.

References $GLOBALS, $name, $value, as, executeSetupSnippets(), and use.

Referenced by addArticles(), createTeardownObject(), executeSetupSnippets(), perTestSetup(), and staticSetup().

◆ getFakeTimestamp()

static ParserTestRunner::getFakeTimestamp	(	&	$parser,
		&	$ts
	)

static

The ParserGetVariableValueTs hook, used to make sure time-related parser functions give a persistent value.

Definition at line 1580 of file ParserTestRunner.php.

◆ getOptionValue()

static ParserTestRunner::getOptionValue	(	$key,
		$opts,
		$default
	)

staticprivate

Use a regex to find out the value of an option.

Parameters

string	$key	Name of option val to retrieve
array	$opts	Options array to look in
mixed	$default	Default value returned if not found

Returns: mixed

Definition at line 841 of file ParserTestRunner.php.

Referenced by perTestSetup().

◆ getParser()

ParserTestRunner::getParser ( $preprocessor = null )

Get a Parser object.

Parameters

string $preprocessor

Returns: Parser

Definition at line 713 of file ParserTestRunner.php.

References $parser, $wgParserConf, global, and ParserTestParserHook\setup().

Referenced by runTest().

◆ getRecorder()

ParserTestRunner::getRecorder ( )

Definition at line 148 of file ParserTestRunner.php.

References $recorder.

◆ isSetupDone()

ParserTestRunner::isSetupDone ( $funcName )

Determine whether a particular setup function has been run.

Parameters

string $funcName

Returns: boolean

Definition at line 477 of file ParserTestRunner.php.

◆ listTables()

ParserTestRunner::listTables ( )

private

List of temporary tables to create, without prefix.

Some of these probably aren't necessary.

Returns: array

Definition at line 1056 of file ParserTestRunner.php.

References $tables.

Referenced by setupDatabase(), and teardownDatabase().

◆ markSetupDone()

ParserTestRunner::markSetupDone ( $funcName )

protected

Set a setupDone flag to indicate that setup has been done, and return the teardown closure.

If the flag was already set, throw an exception.

Parameters

string $funcName The setup function name

Returns: closure

Definition at line 448 of file ParserTestRunner.php.

References use.

Referenced by perTestSetup(), setupDatabase(), setupUploads(), and staticSetup().

◆ meetsRequirements()

ParserTestRunner::meetsRequirements ( $requirements )

Determine whether the current parser has the hooks registered in it that are required by a file read by TestFileReader.

Definition at line 644 of file ParserTestRunner.php.

References as, requireFunctionHook(), requireHook(), and requireTransparentHook().

Referenced by runTests().

◆ parseOptions()

ParserTestRunner::parseOptions ( $instring )

private

Given the options string, return an associative array of options.

Todo:: Move this to TestFileReader

Parameters

string $instring

Returns: array

Definition at line 858 of file ParserTestRunner.php.

References $matches, $regex, and as.

Referenced by perTestSetup(), and runTest().

◆ perTestSetup()

ParserTestRunner::perTestSetup	(	$test,
		$nextTeardown = `null`
	)

Do any required setup which is dependent on test options.

See also: staticSetup() for more information about setup/teardown

Parameters

array	$test	Test info supplied by TestFileReader
callable \| null	$nextTeardown

Returns: ScopedCallback

Definition at line 954 of file ParserTestRunner.php.

References $context, $GLOBALS, $lang, $line, $tidyDriver, $user, $value, as, checkSetupDone(), MagicWord\clearCache(), createTeardownObject(), MWTidy\destroySingleton(), executeSetupSnippets(), MWTidy\factory(), RequestContext\getMain(), getOptionValue(), list, markSetupDone(), parseOptions(), resetTitleServices(), MWTidy\setInstance(), true, and use.

Referenced by runTest().

◆ requireFunctionHook()

ParserTestRunner::requireFunctionHook ( $name )

Check if a function hook is installed.

Parameters

string $name

Returns: bool True if function hook is present

Definition at line 1542 of file ParserTestRunner.php.

References $name, $wgParser, and global.

Referenced by meetsRequirements().

◆ requireHook()

ParserTestRunner::requireHook ( $name )

Check if a hook is installed.

Parameters

string $name

Returns: bool True if tag hook is present

Definition at line 1523 of file ParserTestRunner.php.

References $name, $wgParser, and global.

Referenced by meetsRequirements().

◆ requireTransparentHook()

ParserTestRunner::requireTransparentHook ( $name )

Check if a transparent tag hook is installed.

Parameters

string $name

Returns: bool True if function hook is present

Definition at line 1562 of file ParserTestRunner.php.

References $name, $wgParser, and global.

Referenced by meetsRequirements().

◆ resetTitleServices()

ParserTestRunner::resetTitleServices ( )

private

Reset the Title-related services that need resetting for each test.

Definition at line 566 of file ParserTestRunner.php.

References $services.

Referenced by perTestSetup(), and staticSetup().

◆ runTest()

ParserTestRunner::runTest ( $test )

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.

staticSetup() and setupWikiData() must be called before this function is entered.

Parameters

array

$test

The test parameters:

test: The test name
desc: The subtest description
input: Wikitext to try rendering
options: Array of test options
config: Overrides for global variables, one per line

Returns: ParserTestResult or false if skipped

Definition at line 740 of file ParserTestRunner.php.

References $content, $context, $name, $options, $out, $output, $parser, $section, $title, $user, as, Linker\formatComment(), ParserOutput\getCategories(), ParserOutput\getIndicators(), ParserOutput\getLanguageLinks(), RequestContext\getMain(), getParser(), ParserOutput\getText(), ParserOutput\getTitleText(), ParserOptions\newFromContext(), ParserTestResultNormalizer\normalize(), parseOptions(), perTestSetup(), ParserOutput\setTOCEnabled(), and wfDebug().

Referenced by runTests().

◆ runTests()

ParserTestRunner::runTests ( $testFileInfo )

Run the tests from a single file.

staticSetup() and setupDatabase() must have been called already.

Parameters

array $testFileInfo Parsed file info returned by TestFileReader

Returns: bool True if passed all tests, false if any tests failed.

Definition at line 671 of file ParserTestRunner.php.

References addArticles(), as, checkSetupDone(), meetsRequirements(), and runTest().

Referenced by runTestsFromFiles().

◆ runTestsFromFiles()

ParserTestRunner::runTestsFromFiles ( $filenames )

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.

Handles all setup and teardown.

Parameters

array $filenames Array of strings

Returns: bool True if passed all tests, false if any tests failed.

Definition at line 602 of file ParserTestRunner.php.

References $e, as, TestFileReader\read(), runTests(), setupDatabase(), setupUploads(), and staticSetup().

◆ setDatabase()

ParserTestRunner::setDatabase ( IDatabase $db )

Definition at line 1078 of file ParserTestRunner.php.

References $db.

◆ setupDatabase()

ParserTestRunner::setupDatabase ( $nextTeardown = null )

Set up temporary DB tables.

For best performance, call this once only for all tests. However, it can be called at the start of each test if more isolation is desired.

Todo:: : This is basically an unrefactored copy of MediaWikiTestCase::setupAllTestDBs. They should be factored out somehow.

Do not call this function from a MediaWikiTestCase subclass, since MediaWikiTestCase does its own DB setup. Instead use setDatabase().

See also: staticSetup() for more information about setup/teardown

Parameters

ScopedCallback | null $nextTeardown The next teardown object

Returns: ScopedCallback The teardown object

Definition at line 1100 of file ParserTestRunner.php.

References $wgDBprefix, createTeardownObject(), DB_MASTER, global, listTables(), markSetupDone(), MessageCache\singleton(), teardownDatabase(), wfGetDB(), and wfGetLB().

Referenced by runTestsFromFiles().

◆ setupInterwikis()

ParserTestRunner::setupInterwikis ( )

private

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).

Returns: closure for teardown

Definition at line 492 of file ParserTestRunner.php.

Referenced by staticSetup().

◆ setupUploadBackend()

ParserTestRunner::setupUploadBackend ( )

private

Upload test files to the backend created by createRepoGroup().

Returns: callable The teardown callback

Definition at line 1350 of file ParserTestRunner.php.

References $base, $IP, global, RepoGroup\singleton(), teardownUploadBackend(), and use.

Referenced by setupUploads().

◆ setupUploads()

ParserTestRunner::setupUploads ( $nextTeardown = null )

Add data about uploads to the new test DB, and set up the upload directory.

This should be called after either setDatabase() or setupDatabase().

Parameters

ScopedCallback | null $nextTeardown The next teardown object

Returns: ScopedCallback The teardown object

Definition at line 1165 of file ParserTestRunner.php.

References $image, $user, checkSetupDone(), createTeardownObject(), markSetupDone(), MEDIATYPE_AUDIO, MEDIATYPE_BITMAP, MEDIATYPE_DRAWING, MEDIATYPE_VIDEO, NS_FILE, serialize(), setupUploadBackend(), and wfLocalFile().

Referenced by runTestsFromFiles().

◆ staticSetup()

ParserTestRunner::staticSetup ( $nextTeardown = null )

Do any setup which can be done once for all tests, independent of test options, except for database setup.

Public setup functions in this class return a ScopedCallback object. When this object is destroyed by going out of scope, teardown of the corresponding test setup is performed.

Teardown objects may be chained by passing a ScopedCallback from a previous setup stage as the $nextTeardown parameter. This enforces the convention that teardown actions are taken in reverse order to the corresponding setup actions. When $nextTeardown is specified, a ScopedCallback will be returned which first tears down the current setup stage, and then tears down the previous setup stage which was specified by $nextTeardown.

Parameters

ScopedCallback | null $nextTeardown

Returns: ScopedCallback

Definition at line 171 of file ParserTestRunner.php.

References $wgObjectCaches, appendNamespaceSetup(), CACHE_DB, createRepoGroup(), createTeardownObject(), MessageCache\destroyInstance(), RepoGroup\destroySingleton(), LockManagerGroup\destroySingletons(), executeSetupSnippets(), global, markSetupDone(), resetTitleServices(), RepoGroup\setSingleton(), setupInterwikis(), and use.

Referenced by runTestsFromFiles().

◆ teardownDatabase()

ParserTestRunner::teardownDatabase ( )

private

Helper for database teardown, called from the teardown closure.

Destroy the database clone and fix up some things that CloneDatabase doesn't fix.

Todo:: Move most things here to CloneDatabase

Definition at line 1312 of file ParserTestRunner.php.

References $tables, as, checkSetupDone(), listTables(), and wfDebug().

Referenced by setupDatabase().

◆ teardownUploadBackend()

ParserTestRunner::teardownUploadBackend ( )

private

Remove the dummy uploads directory.

Definition at line 1399 of file ParserTestRunner.php.

References deleteFiles(), and RepoGroup\singleton().

Referenced by setupUploadBackend().

Member Data Documentation

◆ $db

Database ParserTestRunner::$db

private

Our connection to the database.

Definition at line 55 of file ParserTestRunner.php.

Referenced by setDatabase().

◆ $dbClone

CloneDatabase ParserTestRunner::$dbClone

private

Database clone helper.

Definition at line 61 of file ParserTestRunner.php.

◆ $fileBackendName

string null ParserTestRunner::$fileBackendName

private

The name of the file backend to use, or null to use MockFileBackend.

Definition at line 89 of file ParserTestRunner.php.

Referenced by createRepoGroup().

◆ $normalizationFunctions

array ParserTestRunner::$normalizationFunctions = []

private

A list of normalization functions to apply to the expected and actual output.

Definition at line 102 of file ParserTestRunner.php.

◆ $recorder

TestRecorder ParserTestRunner::$recorder

private

Definition at line 76 of file ParserTestRunner.php.

Referenced by __construct(), and getRecorder().

◆ $regex

string ParserTestRunner::$regex

private

A complete regex for filtering tests.

Definition at line 95 of file ParserTestRunner.php.

Referenced by parseOptions().

◆ $setupDone

ParserTestRunner::$setupDone

private

Initial value:

= [
        'staticSetup' => false,
        'perTestSetup' => false,
        'setupDatabase' => false,
        'setDatabase' => false,
        'setupUploads' => false,
    ]

Definition at line 43 of file ParserTestRunner.php.

◆ $tidyDriver

TidyDriverBase ParserTestRunner::$tidyDriver = null

private

Definition at line 71 of file ParserTestRunner.php.

Referenced by perTestSetup().

◆ $tidySupport

TidySupport ParserTestRunner::$tidySupport

private

Definition at line 66 of file ParserTestRunner.php.

◆ $uploadDir

string null ParserTestRunner::$uploadDir = null

private

The upload directory, or null to not set up an upload directory.

Definition at line 83 of file ParserTestRunner.php.

◆ $useTemporaryTables

ParserTestRunner::$useTemporaryTables = true

private

Definition at line 38 of file ParserTestRunner.php.

The documentation for this class was generated from the following file:

tests/parser/ParserTestRunner.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addArticle()

◆ addArticles()

◆ appendNamespaceSetup()

◆ checkSetupDone()

◆ chomp()

◆ cleanupOption()

◆ createRepoGroup()

◆ createTeardownObject()

◆ deleteFiles()

◆ executeSetupSnippets()

◆ getFakeTimestamp()

◆ getOptionValue()

◆ getParser()

◆ getRecorder()

◆ isSetupDone()

◆ listTables()

◆ markSetupDone()

◆ meetsRequirements()

◆ parseOptions()

◆ perTestSetup()

◆ requireFunctionHook()

◆ requireHook()

◆ requireTransparentHook()

◆ resetTitleServices()

◆ runTest()

◆ runTests()

◆ runTestsFromFiles()

◆ setDatabase()

◆ setupDatabase()

◆ setupInterwikis()

◆ setupUploadBackend()

◆ setupUploads()

◆ staticSetup()

◆ teardownDatabase()

◆ teardownUploadBackend()

Member Data Documentation

◆ $db

◆ $dbClone

◆ $fileBackendName

◆ $normalizationFunctions

◆ $recorder

◆ $regex

◆ $setupDone

◆ $tidyDriver

◆ $tidySupport

◆ $uploadDir

◆ $useTemporaryTables