MediaWiki REL1_29
|
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=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. | |
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 | |
Definition at line 35 of file ParserTestRunner.php.
ParserTestRunner::__construct | ( | TestRecorder | $recorder, |
$options = [] |
|||
) |
TestRecorder | $recorder | |
array | $options |
Definition at line 109 of file ParserTestRunner.php.
References $options, $recorder, as, and TestRecorder\warning().
|
private |
Insert a temporary test article.
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 |
Exception | |
MWException |
Definition at line 1491 of file ParserTestRunner.php.
References $name, $page, $status, $title, chomp(), EDIT_INTERNAL, EDIT_NEW, executeSetupSnippets(), WikiPage\factory(), ContentHandler\makeContent(), NS_FILE, MessageCache\singleton(), RepoGroup\singleton(), and wfDebug().
Referenced by addArticles().
ParserTestRunner::addArticles | ( | $articles | ) |
Add articles to the test DB.
$articles | Article info array from TestFileReader |
Definition at line 1451 of file ParserTestRunner.php.
References $wgContLang, addArticle(), appendNamespaceSetup(), as, executeSetupSnippets(), and global.
Referenced by runTests().
|
private |
Definition at line 318 of file ParserTestRunner.php.
References $GLOBALS.
Referenced by addArticles(), and staticSetup().
|
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 |
Remove last character if it is a newline utility.
string | $s |
Definition at line 582 of file ParserTestRunner.php.
References $s.
Referenced by addArticle(), and TestFileReader\execute().
|
private |
Definition at line 931 of file ParserTestRunner.php.
References $opt.
|
protected |
Create a RepoGroup object appropriate for the current configuration.
Definition at line 339 of file ParserTestRunner.php.
References $fileBackendName, $name, $wgFileBackends, as, global, wfTempDir(), and wfWikiID().
Referenced by staticSetup().
|
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.
array | $teardown | The snippet array |
ScopedCallback|null | A ScopedCallback to consume |
Definition at line 430 of file ParserTestRunner.php.
References executeSetupSnippets(), and use.
Referenced by perTestSetup(), setupDatabase(), setupUploads(), and staticSetup().
|
private |
Delete the specified files and their parent directories.
array | $files | File backend URIs mwstore://... |
Definition at line 1427 of file ParserTestRunner.php.
References as, FileBackend\parentStoragePath(), and RepoGroup\singleton().
Referenced by teardownUploadBackend().
|
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.
array | $setup |
Definition at line 403 of file ParserTestRunner.php.
References $GLOBALS, $name, $value, as, executeSetupSnippets(), and use.
Referenced by addArticle(), addArticles(), createTeardownObject(), executeSetupSnippets(), perTestSetup(), and staticSetup().
|
static |
The ParserGetVariableValueTs hook, used to make sure time-related parser functions give a persistent value.
Definition at line 1594 of file ParserTestRunner.php.
|
staticprivate |
Use a regex to find out the value of an option.
string | $key | Name of option val to retrieve |
array | $opts | Options array to look in |
mixed | $default | Default value returned if not found |
Definition at line 842 of file ParserTestRunner.php.
Referenced by perTestSetup().
ParserTestRunner::getParser | ( | $preprocessor = null | ) |
Get a Parser object.
string | $preprocessor |
Definition at line 714 of file ParserTestRunner.php.
References $parser, $wgParserConf, 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.
string | $funcName |
Definition at line 478 of file ParserTestRunner.php.
|
private |
List of temporary tables to create, without prefix.
Some of these probably aren't necessary.
Definition at line 1059 of file ParserTestRunner.php.
References $tables.
Referenced by setupDatabase(), and teardownDatabase().
|
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.
string | $funcName | The setup function name |
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().
|
private |
Given the options string, return an associative array of options.
string | $instring |
Definition at line 859 of file ParserTestRunner.php.
References $matches, $regex, and as.
Referenced by perTestSetup(), and runTest().
ParserTestRunner::perTestSetup | ( | $test, | |
$nextTeardown = null |
|||
) |
Do any required setup which is dependent on test options.
array | $test | Test info supplied by TestFileReader |
callable | null | $nextTeardown |
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(), RequestContext\getMain(), getOptionValue(), list, markSetupDone(), parseOptions(), resetTitleServices(), MWTidy\setInstance(), true, and use.
Referenced by runTest().
ParserTestRunner::requireFunctionHook | ( | $name | ) |
Check if a function hook is installed.
string | $name |
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.
string | $name |
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.
string | $name |
Definition at line 1576 of file ParserTestRunner.php.
References $name, $wgParser, and global.
Referenced by meetsRequirements().
|
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.
array | $test | The test parameters:
|
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(), 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.
array | $testFileInfo | Parsed file info returned by TestFileReader |
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.
array | $filenames | Array of strings |
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.
Do not call this function from a MediaWikiTestCase subclass, since MediaWikiTestCase does its own DB setup. Instead use setDatabase().
ScopedCallback | null | $nextTeardown | The next teardown object |
Definition at line 1103 of file ParserTestRunner.php.
References $wgDBprefix, createTeardownObject(), DB_MASTER, global, listTables(), markSetupDone(), MessageCache\singleton(), teardownDatabase(), wfGetDB(), and wfGetLB().
Referenced by runTestsFromFiles().
|
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).
Definition at line 493 of file ParserTestRunner.php.
Referenced by staticSetup().
|
private |
Upload test files to the backend created by createRepoGroup().
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().
ScopedCallback | null | $nextTeardown | The next teardown object |
Definition at line 1168 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().
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.
ScopedCallback | null | $nextTeardown |
Definition at line 172 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().
|
private |
Helper for database teardown, called from the teardown closure.
Destroy the database clone and fix up some things that CloneDatabase doesn't fix.
Definition at line 1315 of file ParserTestRunner.php.
References $tables, as, checkSetupDone(), listTables(), and wfDebug().
Referenced by setupDatabase().
|
private |
Remove the dummy uploads directory.
Definition at line 1402 of file ParserTestRunner.php.
References deleteFiles(), and RepoGroup\singleton().
Referenced by setupUploadBackend().
|
private |
Our connection to the database.
Definition at line 56 of file ParserTestRunner.php.
Referenced by setDatabase().
|
private |
Database clone helper.
Definition at line 62 of file ParserTestRunner.php.
|
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().
|
private |
A list of normalization functions to apply to the expected and actual output.
Definition at line 103 of file ParserTestRunner.php.
|
private |
Definition at line 77 of file ParserTestRunner.php.
Referenced by __construct(), and getRecorder().
|
private |
A complete regex for filtering tests.
Definition at line 96 of file ParserTestRunner.php.
Referenced by parseOptions().
|
private |
Definition at line 44 of file ParserTestRunner.php.
|
private |
Definition at line 72 of file ParserTestRunner.php.
Referenced by perTestSetup().
|
private |
Definition at line 67 of file ParserTestRunner.php.
|
private |
The upload directory, or null to not set up an upload directory.
Definition at line 84 of file ParserTestRunner.php.
|
private |
Definition at line 39 of file ParserTestRunner.php.