MediaWiki  REL1_31
MediaWiki\Tests\Maintenance\DumpTestCase Class Reference

Base TestCase for dumps. More...

Inheritance diagram for MediaWiki\Tests\Maintenance\DumpTestCase:
Collaboration diagram for MediaWiki\Tests\Maintenance\DumpTestCase:

Public Member Functions

 expectETAOutput ()
 Checks for test output consisting only of lines containing ETA announcements. More...
 
- Public Member Functions inherited from MediaWikiTestCase
 __construct ( $name=null, array $data=[], $dataName='')
 
 __destruct ()
 
 addDBData ()
 Stub. More...
 
 addDBDataOnce ()
 Stub. More...
 
 dbPrefix ()
 
 getCliArg ( $offset)
 
 hideDeprecated ( $function)
 Don't throw a warning if $function is deprecated and called later. More...
 
 needsDB ()
 
 run (PHPUnit_Framework_TestResult $result=null)
 
 setCliArg ( $offset, $value)
 
 setContentLang ( $lang)
 
 setGroupPermissions ( $newPerms, $newKey=null, $newValue=null)
 Alters $wgGroupPermissions for the duration of the test. More...
 
 setupAllTestDBs ()
 Set up all test DBs. More...
 
 setUserLang ( $lang)
 
 testMediaWikiTestCaseParentSetupCalled ()
 Make sure MediaWikiTestCase extending classes have called their parent setUp method. More...
 
 usesTemporaryTables ()
 

Protected Member Functions

 addRevision (Page $page, $text, $summary, $model=CONTENT_MODEL_WIKITEXT)
 Adds a revision to a page, while returning the resuting revision's id. More...
 
 assertDumpEnd ( $name="mediawiki")
 Asserts that the xml reader is at the final closing tag of an xml file and closes the reader. More...
 
 assertDumpStart ( $fname, $skip_siteinfo=true)
 Opens an XML file to analyze and optionally skips past siteinfo. More...
 
 assertNodeEnd ( $name, $skip=true)
 Asserts that the xml reader is at an closing element of given name, and optionally skips past it. More...
 
 assertNodeStart ( $name, $skip=true)
 Asserts that the xml reader is at an element of given name, and optionally skips past it. More...
 
 assertPageEnd ()
 Asserts that the xml reader is at the page's closing element and skips to the next element. More...
 
 assertPageStart ( $id, $ns, $name)
 Asserts that the xml reader is at the start of a page element and skips over the first tags, after checking them. More...
 
 assertRevision ( $id, $summary, $text_id, $text_bytes, $text_sha1, $text=false, $parentid=false, $model=CONTENT_MODEL_WIKITEXT, $format=CONTENT_FORMAT_WIKITEXT)
 Asserts that the xml reader is at a revision and checks its representation before skipping over it. More...
 
 assertText ( $id, $text_id, $text_bytes, $text)
 
 assertTextNode ( $name, $text, $skip_ws=true)
 Asserts that the xml reader is at an element of given tag that contains a given text, and skips over the element. More...
 
 checkHasGzip ()
 Skip the test if 'gzip' is not in $PATH. More...
 
 gunzip ( $fname)
 gunzips the given file and stores the result in the original file name More...
 
 setUp ()
 Default set up function. More...
 
 skipPastNodeEnd ( $name)
 Step the current XML reader to the first element start after the node end of a given name. More...
 
 skipToNodeEnd ( $name)
 Step the current XML reader until node end of given name is found. More...
 
 skipWhitespace ()
 Steps the xml reader over white space. More...
 
- 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. More...
 
 assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
 Assert that two arrays are equal. More...
 
 assertFileContains ( $fileName, $actualData, $createIfMissing=true, $msg='')
 Check whether file contains given data. More...
 
 assertHTMLEquals ( $expected, $actual, $msg='')
 Put each HTML element on its own line and then equals() the results. More...
 
 assertSelect ( $table, $fields, $condition, array $expectedRows, array $options=[], array $join_conds=[])
 Asserts that the given database query yields the rows given by $expectedRows. More...
 
 assertType ( $type, $actual, $message='')
 Asserts the type of the provided value. More...
 
 assertTypeOrValue ( $type, $actual, $value=false, $message='')
 Asserts that the provided variable is of the specified internal type or equals the $value argument. More...
 
 checkDbIsSupported ()
 
 checkPHPExtension ( $extName)
 Check if $extName is a loaded PHP extension, will skip the test whenever it is not loaded. More...
 
 getDefaultWikitextNS ()
 Returns the ID of a namespace that defaults to Wikitext. More...
 
 getNewTempDirectory ()
 obtains a new temporary directory More...
 
 getNewTempFile ()
 Obtains a new temporary file name. More...
 
 getSchemaOverrides (IMaintainableDatabase $db)
 Stub. More...
 
 insertPage ( $pageName, $text='Sample page for unit test.', $namespace=null)
 Insert a new page. More...
 
 isWikitextNS ( $ns)
 Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels. More...
 
 markTestSkippedIfNoDiff3 ()
 Check, if $wgDiff3 is set and ready to merge Will mark the calling test as skipped, if not ready. More...
 
 mergeMwGlobalArrayValue ( $name, $values)
 Merges the given values into a MW global array variable. More...
 
 objectAssociativeSort (array &$array)
 Does an associative sort that works for objects. More...
 
 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. More...
 
 setLogger ( $channel, LoggerInterface $logger)
 Sets the logger for a specified channel, for the duration of the test. More...
 
 setMwGlobals ( $pairs, $value=null)
 Sets a global, maintaining a stashed version of the previous global to be restored in tearDown. More...
 
 setService ( $name, $object)
 Sets a service, maintaining a stashed version of the previous service to be restored in tearDown. More...
 
 setTemporaryHook ( $hookName, $handler)
 Create a temporary hook handler which will be reset by tearDown. More...
 
 stashMwGlobals ( $globalKeys)
 Stashes the global, will be restored in tearDown() More...
 
 tearDown ()
 

Protected Attributes

Exception null $exceptionFromAddDBData = null
 exception to be rethrown once in sound PHPUnit surrounding More...
 
XMLReader null $xml = null
 Holds the XMLReader used for analyzing an XML dump. More...
 
- Protected Attributes inherited from MediaWikiTestCase
Database $db
 Primary database. More...
 
array $supportedDBs
 
array $tablesUsed = []
 

Static Protected Attributes

static bool null $hasGzip = null
 Whether the 'gzip' utility is available. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaWikiTestCase
static getMutableTestUser ( $groups=[])
 Convenience method for getting a mutable test user. More...
 
static getTestSysop ()
 Convenience method for getting an immutable admin test user. More...
 
static getTestUser ( $groups=[])
 Convenience method for getting an immutable test user. More...
 
static listTables (IMaintainableDatabase $db)
 
static prepareServices (Config $bootstrapConfig)
 Prepare service configuration for unit testing. More...
 
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. More...
 
static teardownTestDB ()
 Restores MediaWiki to using the table set (table prefix) it was using before setupTestDB() was called. More...
 
static wfResetOutputBuffersBarrier ( $buffer)
 Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit. More...
 
- Public Attributes inherited from MediaWikiTestCase
const DB_PREFIX = 'unittest_'
 Table name prefixes. More...
 
const ORA_DB_PREFIX = 'ut_'
 
- Static Public Attributes inherited from MediaWikiTestCase
static TestUser[] $users
 
- Static Protected Member Functions inherited from MediaWikiTestCase
static getExternalStoreDatabaseConnections ()
 Gets master database connections for all of the ExternalStoreDB stores configured in $wgDefaultExternalStore. More...
 
static isUsingExternalStoreDB ()
 Check whether ExternalStoreDB is being used. More...
 
static resetGlobalServices (Config $bootstrapConfig=null)
 Reset global services, and install testing environment. More...
 
static setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix)
 Setups a database with the given prefix. More...
 
static setupExternalStoreTestDBs ( $testPrefix)
 Clones the External Store database(s) for testing. More...
 
static stripStringKeys (&$r)
 Utility function for eliminating all string keys from an array. More...
 

Detailed Description

Base TestCase for dumps.

Definition at line 16 of file DumpTestCase.php.

Member Function Documentation

◆ addRevision()

MediaWiki\Tests\Maintenance\DumpTestCase::addRevision ( Page  $page,
  $text,
  $summary,
  $model = CONTENT_MODEL_WIKITEXT 
)
protected

Adds a revision to a page, while returning the resuting revision's id.

Parameters
Page$pagePage to add the revision to
string$textRevisions text
string$summaryRevisions summary
string$modelThe model ID (defaults to wikitext)
Exceptions
MWException
Returns
array

Definition at line 69 of file DumpTestCase.php.

References $value, and ContentHandler\makeContent().

Referenced by MediaWiki\Tests\Maintenance\BackupDumperPageTest\addDBData(), and MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\addDBData().

◆ assertDumpEnd()

◆ assertDumpStart()

◆ assertNodeEnd()

MediaWiki\Tests\Maintenance\DumpTestCase::assertNodeEnd (   $name,
  $skip = true 
)
protected

Asserts that the xml reader is at an closing element of given name, and optionally skips past it.

Parameters
string$nameThe name of the closing element to check for (e.g.: "mediawiki" for </mediawiki>)
bool$skip(optional) if true, skip past the found element

Definition at line 265 of file DumpTestCase.php.

References $name.

Referenced by MediaWiki\Tests\Maintenance\DumpTestCase\assertDumpEnd(), MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\assertLogItem(), MediaWiki\Tests\Maintenance\DumpTestCase\assertPageEnd(), MediaWiki\Tests\Maintenance\DumpTestCase\assertRevision(), MediaWiki\Tests\Maintenance\DumpTestCase\assertText(), and MediaWiki\Tests\Maintenance\DumpTestCase\assertTextNode().

◆ assertNodeStart()

MediaWiki\Tests\Maintenance\DumpTestCase::assertNodeStart (   $name,
  $skip = true 
)
protected

Asserts that the xml reader is at an element of given name, and optionally skips past it.

Parameters
string$nameThe name of the element to check for (e.g.: "mediawiki" for <mediawiki>)
bool$skip(optional) if true, skip past the found element

Definition at line 249 of file DumpTestCase.php.

References $name.

Referenced by MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\assertLogItem(), MediaWiki\Tests\Maintenance\DumpTestCase\assertPageStart(), MediaWiki\Tests\Maintenance\DumpTestCase\assertRevision(), MediaWiki\Tests\Maintenance\DumpTestCase\assertText(), and MediaWiki\Tests\Maintenance\DumpTestCase\assertTextNode().

◆ assertPageEnd()

◆ assertPageStart()

MediaWiki\Tests\Maintenance\DumpTestCase::assertPageStart (   $id,
  $ns,
  $name 
)
protected

◆ assertRevision()

MediaWiki\Tests\Maintenance\DumpTestCase::assertRevision (   $id,
  $summary,
  $text_id,
  $text_bytes,
  $text_sha1,
  $text = false,
  $parentid = false,
  $model = CONTENT_MODEL_WIKITEXT,
  $format = CONTENT_FORMAT_WIKITEXT 
)
protected

Asserts that the xml reader is at a revision and checks its representation before skipping over it.

Parameters
int$idId of the revision
string$summarySummary of the revision
int$text_idId of the revision's text
int$text_bytesNumber of bytes in the revision's text
string$text_sha1The base36 SHA-1 of the revision's text
string | bool$text(optional) The revision's string, or false to check for a revision stub
int | bool$parentid(optional) id of the parent revision
string$modelThe expected content model id (default: CONTENT_MODEL_WIKITEXT)
string$formatThe expected format model id (default: CONTENT_FORMAT_WIKITEXT)

Definition at line 343 of file DumpTestCase.php.

References MediaWiki\Tests\Maintenance\DumpTestCase\assertNodeEnd(), MediaWiki\Tests\Maintenance\DumpTestCase\assertNodeStart(), MediaWiki\Tests\Maintenance\DumpTestCase\assertText(), MediaWiki\Tests\Maintenance\DumpTestCase\assertTextNode(), and MediaWiki\Tests\Maintenance\DumpTestCase\skipWhitespace().

Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\checkpointHelper(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testCurrentStubGzip(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testCurrentStubPlain(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testFullStubPlain(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testFullTextPlain(), MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\testPlain(), MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\testPrefetchPlain(), and MediaWiki\Tests\Maintenance\BackupDumperPageTest\testXmlDumpsBackupUseCase().

◆ assertText()

MediaWiki\Tests\Maintenance\DumpTestCase::assertText (   $id,
  $text_id,
  $text_bytes,
  $text 
)
protected

◆ assertTextNode()

MediaWiki\Tests\Maintenance\DumpTestCase::assertTextNode (   $name,
  $text,
  $skip_ws = true 
)
protected

Asserts that the xml reader is at an element of given tag that contains a given text, and skips over the element.

Parameters
string$nameThe name of the element to check for (e.g.: "mediawiki" for <mediawiki>...</mediawiki>)
string | bool$textIf string, check if it equals the elements text. If false, ignore the element's text
bool$skip_ws(optional) if true, skip past white spaces that trail the closing element.

Definition at line 284 of file DumpTestCase.php.

References $name, MediaWiki\Tests\Maintenance\DumpTestCase\assertNodeEnd(), MediaWiki\Tests\Maintenance\DumpTestCase\assertNodeStart(), and MediaWiki\Tests\Maintenance\DumpTestCase\skipWhitespace().

Referenced by MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\assertLogItem(), MediaWiki\Tests\Maintenance\DumpTestCase\assertPageStart(), and MediaWiki\Tests\Maintenance\DumpTestCase\assertRevision().

◆ checkHasGzip()

◆ expectETAOutput()

MediaWiki\Tests\Maintenance\DumpTestCase::expectETAOutput ( )

Checks for test output consisting only of lines containing ETA announcements.

Definition at line 131 of file DumpTestCase.php.

References $line, $lines, and as.

Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\checkpointHelper(), and MediaWiki\Tests\Maintenance\BackupDumperPageTest\testXmlDumpsBackupUseCase().

◆ gunzip()

MediaWiki\Tests\Maintenance\DumpTestCase::gunzip (   $fname)
protected

gunzips the given file and stores the result in the original file name

Parameters
string$fnameFilename to read the gzipped data from and stored the gunzipped data into

Definition at line 96 of file DumpTestCase.php.

References $fname.

Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\checkpointHelper(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testCurrentStubGzip(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testXmlDumpsBackupUseCase(), and MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\testXmlDumpsBackupUseCaseLogging().

◆ setUp()

MediaWiki\Tests\Maintenance\DumpTestCase::setUp ( )
protected

Default set up function.

Clears $wgUser, and reports errors from addDBData to PHPUnit

Reimplemented from MediaWikiLangTestCase.

Reimplemented in MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest, and MediaWiki\Tests\Maintenance\BackupDumperPageTest.

Definition at line 116 of file DumpTestCase.php.

References MediaWiki\Tests\Maintenance\DumpTestCase\$exceptionFromAddDBData, MediaWikiTestCase\setMwGlobals(), and User.

◆ skipPastNodeEnd()

MediaWiki\Tests\Maintenance\DumpTestCase::skipPastNodeEnd (   $name)
protected

Step the current XML reader to the first element start after the node end of a given name.

Parameters
string$nameName of the closing element to look for (e.g.: "mediawiki" when looking for </mediawiki>)
Returns
bool True if new element after the closing of $name could be found. false otherwise.

Definition at line 184 of file DumpTestCase.php.

References $name, and MediaWiki\Tests\Maintenance\DumpTestCase\skipToNodeEnd().

Referenced by MediaWiki\Tests\Maintenance\DumpTestCase\assertDumpStart().

◆ skipToNodeEnd()

MediaWiki\Tests\Maintenance\DumpTestCase::skipToNodeEnd (   $name)
protected

Step the current XML reader until node end of given name is found.

Parameters
string$nameName of the closing element to look for (e.g.: "mediawiki" when looking for </mediawiki>)
Returns
bool True if the end node could be found. false otherwise.

Definition at line 162 of file DumpTestCase.php.

References $name.

Referenced by MediaWiki\Tests\Maintenance\DumpTestCase\skipPastNodeEnd().

◆ skipWhitespace()

Member Data Documentation

◆ $exceptionFromAddDBData

Exception null MediaWiki\Tests\Maintenance\DumpTestCase::$exceptionFromAddDBData = null
protected

exception to be rethrown once in sound PHPUnit surrounding

As the current MediaWikiTestCase::run is not robust enough to recover from thrown exceptions directly, we cannot throw frow within self::addDBData, although it would be appropriate. Hence, we catch the exception and store it until we are in setUp and may finally rethrow the exception without crashing the test suite.

Definition at line 29 of file DumpTestCase.php.

Referenced by MediaWiki\Tests\Maintenance\DumpTestCase\setUp().

◆ $hasGzip

bool null MediaWiki\Tests\Maintenance\DumpTestCase::$hasGzip = null
staticprotected

Whether the 'gzip' utility is available.

Definition at line 39 of file DumpTestCase.php.

Referenced by MediaWiki\Tests\Maintenance\DumpTestCase\checkHasGzip().

◆ $xml

XMLReader null MediaWiki\Tests\Maintenance\DumpTestCase::$xml = null
protected

Holds the XMLReader used for analyzing an XML dump.

Definition at line 36 of file DumpTestCase.php.


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