MediaWiki REL1_30
PreprocessorTest Class Reference

Preprocessor. More...

Inheritance diagram for PreprocessorTest:
Collaboration diagram for PreprocessorTest:

Public Member Functions

 getStripList ()
 
 testHeadings ( $className, $wikiText, $expectedXml)
 provideHeadings
 
 testPreprocessorOutput ( $className, $wikiText, $expectedXml)
 provideCases
 
 testPreprocessorOutputFiles ( $className, $filename)
 provideFiles
 
- Public Member Functions inherited from MediaWikiTestCase
 __call ( $func, $args)
 
 __construct ( $name=null, array $data=[], $dataName='')
 
 __destruct ()
 
 addDBData ()
 Stub.
 
 addDBDataOnce ()
 Stub.
 
 dbPrefix ()
 
 getCliArg ( $offset)
 
 hideDeprecated ( $function)
 Don't throw a warning if $function is deprecated and called later.
 
 needsDB ()
 
 run (PHPUnit_Framework_TestResult $result=null)
 
 setCliArg ( $offset, $value)
 
 setContentLang ( $lang)
 
 setupAllTestDBs ()
 Set up all test DBs.
 
 setUserLang ( $lang)
 
 testMediaWikiTestCaseParentSetupCalled ()
 Make sure MediaWikiTestCase extending classes have called their parent setUp method.
 
 usesTemporaryTables ()
 

Static Public Member Functions

static provideCases ()
 
static provideFiles ()
 These are more complex test cases taken out of wiki articles.
 
static provideHeadings ()
 Tests from T30642 · https://phabricator.wikimedia.org/T30642.
 
- Static Public Member Functions inherited from MediaWikiTestCase
static getMutableTestUser ( $groups=[])
 Convenience method for getting a mutable test user.
 
static getTestSysop ()
 Convenience method for getting an immutable admin test user.
 
static getTestUser ( $groups=[])
 Convenience method for getting an immutable test user.
 
static listTables (IMaintainableDatabase $db)
 
static prepareServices (Config $bootstrapConfig)
 Prepare service configuration for unit testing.
 
static setUpBeforeClass ()
 
static setupTestDB (Database $db, $prefix)
 Creates an empty skeleton of the wiki database by cloning its structure to equivalent tables using the given $prefix.
 
static teardownTestDB ()
 Restores MediaWiki to using the table set (table prefix) it was using before setupTestDB() was called.
 
static wfResetOutputBuffersBarrier ( $buffer)
 Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
 

Protected Member Functions

 normalizeXml ( $xml)
 Normalize XML string to the form that a DOMDocument saves out.
 
 preprocessToXml ( $className, $wikiText)
 Get XML preprocessor tree from the preprocessor (which may not be the native XML-based one).
 
 setUp ()
 
- Protected Member Functions inherited from MediaWikiTestCase
 addTmpFiles ( $files)
 
 arrayWrap (array $elements)
 Utility method taking an array of elements and wrapping each element in its own array.
 
 assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
 Assert that two arrays are equal.
 
 assertFileContains ( $fileName, $actualData, $createIfMissing=true, $msg='')
 Check whether file contains given data.
 
 assertHTMLEquals ( $expected, $actual, $msg='')
 Put each HTML element on its own line and then equals() the results.
 
 assertSelect ( $table, $fields, $condition, array $expectedRows)
 Asserts that the given database query yields the rows given by $expectedRows.
 
 assertType ( $type, $actual, $message='')
 Asserts the type of the provided value.
 
 assertTypeOrValue ( $type, $actual, $value=false, $message='')
 Asserts that the provided variable is of the specified internal type or equals the $value argument.
 
 assertValidHtmlDocument ( $html)
 Asserts that the given string is valid HTML document.
 
 assertValidHtmlSnippet ( $html)
 Asserts that the given string is a valid HTML snippet.
 
 checkDbIsSupported ()
 
 checkPHPExtension ( $extName)
 Check if $extName is a loaded PHP extension, will skip the test whenever it is not loaded.
 
 getDefaultWikitextNS ()
 Returns the ID of a namespace that defaults to Wikitext.
 
 getNewTempDirectory ()
 obtains a new temporary directory
 
 getNewTempFile ()
 Obtains a new temporary file name.
 
 insertPage ( $pageName, $text='Sample page for unit test.', $namespace=null)
 Insert a new page.
 
 isWikitextNS ( $ns)
 Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels.
 
 markTestSkippedIfNoDiff3 ()
 Check, if $wgDiff3 is set and ready to merge Will mark the calling test as skipped, if not ready.
 
 mergeMwGlobalArrayValue ( $name, $values)
 Merges the given values into a MW global array variable.
 
 objectAssociativeSort (array &$array)
 Does an associative sort that works for objects.
 
 overrideMwServices (Config $configOverrides=null, array $services=[])
 Stashes the global instance of MediaWikiServices, and installs a new one, allowing test cases to override settings and services.
 
 setLogger ( $channel, LoggerInterface $logger)
 Sets the logger for a specified channel, for the duration of the test.
 
 setMwGlobals ( $pairs, $value=null)
 Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
 
 setService ( $name, $object)
 Sets a service, maintaining a stashed version of the previous service to be restored in tearDown.
 
 setTemporaryHook ( $hookName, $handler)
 Create a temporary hook handler which will be reset by tearDown.
 
 stashMwGlobals ( $globalKeys)
 Stashes the global, will be restored in tearDown()
 
 tearDown ()
 

Static Protected Member Functions

static addClassArg ( $testCases)
 
- Static Protected Member Functions inherited from MediaWikiTestCase
static getExternalStoreDatabaseConnections ()
 Gets master database connections for all of the ExternalStoreDB stores configured in $wgDefaultExternalStore.
 
static isUsingExternalStoreDB ()
 Check whether ExternalStoreDB is being used.
 
static resetGlobalServices (Config $bootstrapConfig=null)
 Reset global services, and install testing environment.
 
static setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix)
 Setups a database with the given prefix.
 
static setupExternalStoreTestDBs ( $testPrefix)
 Clones the External Store database(s) for testing.
 
static stripStringKeys (&$r)
 Utility function for eliminating all string keys from an array.
 

Protected Attributes

ParserOptions $mOptions
 
 $mPPNodeCount = 0
 
array $mPreprocessors
 
 $mTitle = 'Page title'
 
- Protected Attributes inherited from MediaWikiTestCase
Database $db
 Primary database.
 
array $supportedDBs
 
array $tablesUsed = []
 

Static Protected Attributes

static $classNames
 

Additional Inherited Members

- Public Attributes inherited from MediaWikiTestCase
const DB_PREFIX = 'unittest_'
 Table name prefixes.
 
const ORA_DB_PREFIX = 'ut_'
 
- Static Public Attributes inherited from MediaWikiTestCase
static TestUser[] $users
 

Detailed Description

Member Function Documentation

◆ addClassArg()

static PreprocessorTest::addClassArg ( $testCases)
staticprotected

Definition at line 59 of file PreprocessorTest.php.

Referenced by provideCases(), provideFiles(), and provideHeadings().

◆ getStripList()

PreprocessorTest::getStripList ( )

Definition at line 55 of file PreprocessorTest.php.

◆ normalizeXml()

PreprocessorTest::normalizeXml ( $xml)
protected

Normalize XML string to the form that a DOMDocument saves out.

Parameters
string$xml
Returns
string

Definition at line 190 of file PreprocessorTest.php.

Referenced by preprocessToXml(), testHeadings(), testPreprocessorOutput(), and testPreprocessorOutputFiles().

◆ preprocessToXml()

PreprocessorTest::preprocessToXml ( $className,
$wikiText )
protected

Get XML preprocessor tree from the preprocessor (which may not be the native XML-based one).

Parameters
string$className
string$wikiText
Returns
string

Definition at line 170 of file PreprocessorTest.php.

References normalizeXml().

Referenced by testHeadings(), testPreprocessorOutput(), and testPreprocessorOutputFiles().

◆ provideCases()

static PreprocessorTest::provideCases ( )
static

Definition at line 70 of file PreprocessorTest.php.

References addClassArg().

◆ provideFiles()

static PreprocessorTest::provideFiles ( )
static

These are more complex test cases taken out of wiki articles.

Definition at line 210 of file PreprocessorTest.php.

References addClassArg(), and https.

◆ provideHeadings()

static PreprocessorTest::provideHeadings ( )
static

Tests from T30642 · https://phabricator.wikimedia.org/T30642.

Definition at line 244 of file PreprocessorTest.php.

References addClassArg().

◆ setUp()

PreprocessorTest::setUp ( )
protected

Reimplemented from MediaWikiTestCase.

Definition at line 44 of file PreprocessorTest.php.

References $wgContLang.

◆ testHeadings()

PreprocessorTest::testHeadings ( $className,
$wikiText,
$expectedXml )

provideHeadings

Definition at line 290 of file PreprocessorTest.php.

References normalizeXml(), and preprocessToXml().

◆ testPreprocessorOutput()

PreprocessorTest::testPreprocessorOutput ( $className,
$wikiText,
$expectedXml )

provideCases

Definition at line 202 of file PreprocessorTest.php.

References normalizeXml(), and preprocessToXml().

◆ testPreprocessorOutputFiles()

PreprocessorTest::testPreprocessorOutputFiles ( $className,
$filename )

provideFiles

Definition at line 225 of file PreprocessorTest.php.

References $output, normalizeXml(), and preprocessToXml().

Member Data Documentation

◆ $classNames

PreprocessorTest::$classNames
staticprotected
Initial value:
= [
'Preprocessor_DOM',
'Preprocessor_Hash'
]

Definition at line 39 of file PreprocessorTest.php.

◆ $mOptions

ParserOptions PreprocessorTest::$mOptions
protected

Definition at line 33 of file PreprocessorTest.php.

◆ $mPPNodeCount

PreprocessorTest::$mPPNodeCount = 0
protected

Definition at line 29 of file PreprocessorTest.php.

◆ $mPreprocessors

array PreprocessorTest::$mPreprocessors
protected

Definition at line 37 of file PreprocessorTest.php.

◆ $mTitle

PreprocessorTest::$mTitle = 'Page title'
protected

Definition at line 28 of file PreprocessorTest.php.


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