MediaWiki  master
ParserTestRunner Class Reference
Collaboration diagram for ParserTestRunner:

Public Member Functions

 __construct (TestRecorder $recorder, $options=[])
 
 addArticles ($articles)
 Add articles to the test DB. More...
 
 getParser ($preprocessor=null)
 Get a Parser object. More...
 
 getRecorder ()
 
 isSetupDone ($funcName)
 Determine whether a particular setup function has been run. More...
 
 meetsRequirements ($requirements)
 Determine whether the current parser has the hooks registered in it that are required by a file read by TestFileReader. More...
 
 perTestSetup ($test, $nextTeardown=null)
 Do any required setup which is dependent on test options. More...
 
 requireFunctionHook ($name)
 Check if a function hook is installed. More...
 
 requireHook ($name)
 Check if a hook is installed. More...
 
 requireTransparentHook ($name)
 Check if a transparent tag hook is installed. More...
 
 runTest ($test)
 Run a given wikitext input through a freshly-constructed wiki parser, and compare the output against the expected results. More...
 
 runTests ($testFileInfo)
 Run the tests from a single file. More...
 
 runTestsFromFiles ($filenames)
 Run a series of tests listed in the given text files. More...
 
 setDatabase (IDatabase $db)
 
 setupDatabase ($nextTeardown=null)
 Set up temporary DB tables. More...
 
 setupUploads ($nextTeardown=null)
 Add data about uploads to the new test DB, and set up the upload directory. More...
 
 staticSetup ($nextTeardown=null)
 Do any setup which can be done once for all tests, independent of test options, except for database setup. More...
 

Static Public Member Functions

static chomp ($s)
 Remove last character if it is a newline utility. More...
 
static getFakeTimestamp (&$parser, &$ts)
 The ParserGetVariableValueTs hook, used to make sure time-related parser functions give a persistent value. More...
 

Protected Member Functions

 checkSetupDone ($funcName, $funcName2=null)
 Ensure a given setup stage has been done, throw an exception if it has not. More...
 
 createRepoGroup ()
 Create a RepoGroup object appropriate for the current configuration. More...
 
 createTeardownObject ($teardown, $nextTeardown=null)
 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. More...
 
 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. More...
 
 markSetupDone ($funcName)
 Set a setupDone flag to indicate that setup has been done, and return the teardown closure. More...
 

Private Member Functions

 addArticle ($name, $text, $file, $line)
 Insert a temporary test article. More...
 
 appendNamespaceSetup (&$setup, &$teardown)
 
 cleanupOption ($opt)
 
 deleteFiles ($files)
 Delete the specified files and their parent directories. More...
 
 listTables ()
 List of temporary tables to create, without prefix. More...
 
 parseOptions ($instring)
 Given the options string, return an associative array of options. More...
 
 resetTitleServices ()
 Reset the Title-related services that need resetting for each test. More...
 
 setupInterwikis ()
 Insert hardcoded interwiki in the lookup table. More...
 
 setupUploadBackend ()
 Upload test files to the backend created by createRepoGroup(). More...
 
 teardownDatabase ()
 Helper for database teardown, called from the teardown closure. More...
 
 teardownUploadBackend ()
 Remove the dummy uploads directory. More...
 

Static Private Member Functions

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

Private Attributes

Database $db
 Our connection to the database. More...
 
CloneDatabase $dbClone
 Database clone helper. More...
 
string null $fileBackendName
 The name of the file backend to use, or null to use MockFileBackend. More...
 
array $normalizationFunctions = []
 A list of normalization functions to apply to the expected and actual output. More...
 
TestRecorder $recorder
 
string $regex
 A complete regex for filtering tests. More...
 
 $setupDone
 
TidyDriverBase $tidyDriver = null
 
TidySupport $tidySupport
 
string null $uploadDir = null
 The upload directory, or null to not set up an upload directory. More...
 
 $useTemporaryTables = true
 

Detailed Description

Definition at line 35 of file ParserTestRunner.php.

Constructor & Destructor Documentation

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

Definition at line 109 of file ParserTestRunner.php.

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

Member Function Documentation

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

Insert a temporary test article.

Parameters
string$nameThe title, including any prefix
string$textThe article text
string$fileThe input file name
int | string$lineThe input line number, for reporting errors
Exceptions
Exception
MWException

Definition at line 1491 of file ParserTestRunner.php.

References $name, $page, $status, $title, EDIT_INTERNAL, EDIT_NEW, executeSetupSnippets(), WikiPage\factory(), ContentHandler\makeContent(), Title\newFromText(), NS_FILE, RepoGroup\singleton(), MessageCache\singleton(), and wfDebug().

Referenced by addArticles().

ParserTestRunner::addArticles (   $articles)

Add articles to the test DB.

Parameters
$articlesArticle info array from TestFileReader

Definition at line 1451 of file ParserTestRunner.php.

References $wgContLang, addArticle(), appendNamespaceSetup(), as, executeSetupSnippets(), Language\factory(), ObjectCache\getMainWANInstance(), and global.

Referenced by runTests().

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

Definition at line 318 of file ParserTestRunner.php.

References $GLOBALS, and MWNamespace\getCanonicalNamespaces().

Referenced by addArticles(), and staticSetup().

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

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

Definition at line 463 of file ParserTestRunner.php.

References wfGetCaller().

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

static ParserTestRunner::chomp (   $s)
static

Remove last character if it is a newline utility.

Parameters
string$s
Returns
string

Definition at line 582 of file ParserTestRunner.php.

References $s.

Referenced by TestFileReader\execute().

ParserTestRunner::cleanupOption (   $opt)
private

Definition at line 931 of file ParserTestRunner.php.

References $opt, and FormatJson\decode().

ParserTestRunner::createRepoGroup ( )
protected

Create a RepoGroup object appropriate for the current configuration.

Returns
RepoGroup

Definition at line 339 of file ParserTestRunner.php.

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

Referenced by staticSetup().

ParserTestRunner::createTeardownObject (   $teardown,
  $nextTeardown = null 
)
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$teardownThe snippet array
ScopedCallback|nullA ScopedCallback to consume
Returns
ScopedCallback

Definition at line 430 of file ParserTestRunner.php.

References executeSetupSnippets(), and use.

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

ParserTestRunner::deleteFiles (   $files)
private

Delete the specified files and their parent directories.

Parameters
array$filesFile backend URIs mwstore://...

Definition at line 1427 of file ParserTestRunner.php.

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

Referenced by teardownUploadBackend().

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 403 of file ParserTestRunner.php.

References $GLOBALS, $name, $value, as, and use.

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

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

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

Definition at line 1594 of file ParserTestRunner.php.

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

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

Parameters
string$keyName of option val to retrieve
array$optsOptions array to look in
mixed$defaultDefault value returned if not found
Returns
mixed

Definition at line 842 of file ParserTestRunner.php.

References $key.

ParserTestRunner::getParser (   $preprocessor = null)

Get a Parser object.

Parameters
string$preprocessor
Returns
Parser

Definition at line 714 of file ParserTestRunner.php.

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

Referenced by runTest().

ParserTestRunner::getRecorder ( )

Definition at line 149 of file ParserTestRunner.php.

References $recorder.

ParserTestRunner::isSetupDone (   $funcName)

Determine whether a particular setup function has been run.

Parameters
string$funcName
Returns
boolean

Definition at line 478 of file ParserTestRunner.php.

ParserTestRunner::listTables ( )
private

List of temporary tables to create, without prefix.

Some of these probably aren't necessary.

Returns
array

Definition at line 1059 of file ParserTestRunner.php.

References $tables, and Hooks\run().

Referenced by setupDatabase(), and teardownDatabase().

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$funcNameThe setup function name
Returns
closure

Definition at line 449 of file ParserTestRunner.php.

References use.

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

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 645 of file ParserTestRunner.php.

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

Referenced by runTests().

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 859 of file ParserTestRunner.php.

References $key, $matches, and as.

Referenced by perTestSetup(), and runTest().

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$testTest info supplied by TestFileReader
callable | null$nextTeardown
Returns
ScopedCallback

Definition at line 955 of file ParserTestRunner.php.

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

Referenced by runTest().

ParserTestRunner::requireFunctionHook (   $name)

Check if a function hook is installed.

Parameters
string$name
Returns
bool True if function hook is present

Definition at line 1556 of file ParserTestRunner.php.

References $name, $wgParser, and global.

Referenced by meetsRequirements().

ParserTestRunner::requireHook (   $name)

Check if a hook is installed.

Parameters
string$name
Returns
bool True if tag hook is present

Definition at line 1537 of file ParserTestRunner.php.

References $name, $wgParser, and global.

Referenced by meetsRequirements().

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 1576 of file ParserTestRunner.php.

References $name, $wgParser, and global.

Referenced by meetsRequirements().

ParserTestRunner::resetTitleServices ( )
private

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

Definition at line 567 of file ParserTestRunner.php.

References $services.

Referenced by perTestSetup(), and staticSetup().

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$testThe 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 741 of file ParserTestRunner.php.

References $content, $context, $name, $options, $out, $output, $parser, $section, $title, $user, as, Linker\formatComment(), RequestContext\getMain(), getParser(), ContextSource\getUser(), ParserOptions\newFromContext(), Title\newFromText(), ParserTestResultNormalizer\normalize(), parseOptions(), perTestSetup(), and wfDebug().

Referenced by runTests().

ParserTestRunner::runTests (   $testFileInfo)

Run the tests from a single file.

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

Parameters
array$testFileInfoParsed file info returned by TestFileReader
Returns
bool True if passed all tests, false if any tests failed.

Definition at line 672 of file ParserTestRunner.php.

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

Referenced by 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$filenamesArray of strings
Returns
bool True if passed all tests, false if any tests failed.

Definition at line 603 of file ParserTestRunner.php.

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

ParserTestRunner::setDatabase ( IDatabase  $db)

Definition at line 1081 of file ParserTestRunner.php.

References $db.

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$nextTeardownThe next teardown object
Returns
ScopedCallback The teardown object

Definition at line 1103 of file ParserTestRunner.php.

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

Referenced by runTestsFromFiles().

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 493 of file ParserTestRunner.php.

References Hooks\clear(), and Hooks\register().

Referenced by staticSetup().

ParserTestRunner::setupUploadBackend ( )
private

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

Returns
callable The teardown callback

Definition at line 1353 of file ParserTestRunner.php.

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

Referenced by 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$nextTeardownThe next teardown object
Returns
ScopedCallback The teardown object

Definition at line 1168 of file ParserTestRunner.php.

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

Referenced by runTestsFromFiles().

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 172 of file ParserTestRunner.php.

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

Referenced by runTestsFromFiles().

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 1315 of file ParserTestRunner.php.

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

Referenced by setupDatabase().

ParserTestRunner::teardownUploadBackend ( )
private

Remove the dummy uploads directory.

Definition at line 1402 of file ParserTestRunner.php.

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

Referenced by setupUploadBackend().

Member Data Documentation

Database ParserTestRunner::$db
private
Initial value:
=> false,
'setupDatabase' => false,
'setDatabase' => false,
'setupUploads' => false,
]

Our connection to the database.

Definition at line 46 of file ParserTestRunner.php.

Referenced by setDatabase().

CloneDatabase ParserTestRunner::$dbClone
private

Database clone helper.

Definition at line 62 of file ParserTestRunner.php.

string null ParserTestRunner::$fileBackendName
private

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

Definition at line 90 of file ParserTestRunner.php.

Referenced by createRepoGroup().

array ParserTestRunner::$normalizationFunctions = []
private

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

Definition at line 103 of file ParserTestRunner.php.

TestRecorder ParserTestRunner::$recorder
private

Definition at line 77 of file ParserTestRunner.php.

Referenced by __construct(), and getRecorder().

string ParserTestRunner::$regex
private

A complete regex for filtering tests.

Definition at line 96 of file ParserTestRunner.php.

ParserTestRunner::$setupDone
private
Initial value:
= [
'staticSetup' => false

Definition at line 44 of file ParserTestRunner.php.

TidyDriverBase ParserTestRunner::$tidyDriver = null
private

Definition at line 72 of file ParserTestRunner.php.

Referenced by perTestSetup().

TidySupport ParserTestRunner::$tidySupport
private

Definition at line 67 of file ParserTestRunner.php.

string null ParserTestRunner::$uploadDir = null
private

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

Definition at line 84 of file ParserTestRunner.php.

ParserTestRunner::$useTemporaryTables = true
private

Definition at line 39 of file ParserTestRunner.php.


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