Base TestCase for dumps. More...

Inheritance diagram for DumpTestCase:

[legend]

Collaboration diagram for DumpTestCase:

[legend]

Public Member Functions
	expectETAOutput ()
	Checks for test output consisting only of lines containing ETA announcements. More...

Public Member Functions inherited from MediaWikiTestCase
	__call ( $func, $args)

	__construct ( $name=null, array $data=array(), $dataName='')

	addDBData ()
	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)

	testMediaWikiTestCaseParentSetupCalled ()
	Make sure MediaWikiTestCase extending classes have called their parent setUp method. More...

	usesTemporaryTables ()

Protected Member Functions
	addRevision (Page $page, $text, $summary)
	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...

	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
	arrayWrap (array $elements)
	Utility method taking an array of elements and wrapping each element in it's own array. More...

	assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
	Assert that two arrays are equal. More...

	assertException ( $code, $expected='Exception', $message='')
	Asserts that an exception of the specified type occurs when running the provided code. 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)
	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...

	assertValidHtmlDocument ( $html)
	Asserts that the given string is valid HTML document. More...

	assertValidHtmlSnippet ( $html)
	Asserts that the given string is a valid HTML snippet. More...

	checkDbIsSupported ()

	checkHasDiff3 ()
	Check, if $wgDiff3 is set and ready to merge Will mark the calling test as skipped, if not ready. More...

	checkHasGzip ()
	Check whether we have the 'gzip' commandline utility, will skip the test whenever "gzip -V" fails. More...

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

	isWikitextNS ( $ns)
	Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels. 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...

	setMwGlobals ( $pairs, $value=null)

	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
DatabaseBase	$db

array	$supportedDBs

array	$tablesUsed = array()

Additional Inherited Members
Static Public Member Functions inherited from MediaWikiTestCase
static	listTables ( $db)

static	setupTestDB (DatabaseBase $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...

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	$users

Static Protected Member Functions inherited from MediaWikiTestCase
static	stripStringKeys (&$r)
	Utility function for eliminating all string keys from an array. More...

Detailed Description

Base TestCase for dumps.

Definition at line 6 of file DumpTestCase.php.

Member Function Documentation

◆ addRevision()

DumpTestCase::addRevision	(	Page	$page,
			$text,
			$summary
	)

protected

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

Parameters

$page	WikiPage: page to add the revision to
$text	string: revisions text
$text	string: revisions summare

Exceptions

MWExcepion

Definition at line 35 of file DumpTestCase.php.

References $summary, $value, array(), and ContentHandler\makeContent().

Referenced by BackupDumperPageTest\addDBData(), and TextPassDumperTest\addDBData().

◆ assertDumpEnd()

DumpTestCase::assertDumpEnd ( $name = "mediawiki" )

protected

Asserts that the xml reader is at the final closing tag of an xml file and closes the reader.

Parameters

$tag	string: (optional) the name of the final tag (e.g.: "mediawiki" for </mediawiki>)

Definition at line 176 of file DumpTestCase.php.

References $name, assertNodeEnd(), and skipWhitespace().

Referenced by TextPassDumperTest\checkpointHelper(), BackupDumperPageTest\testCurrentStubGzip(), BackupDumperPageTest\testCurrentStubPlain(), BackupDumperPageTest\testFullStubPlain(), BackupDumperPageTest\testFullTextPlain(), TextPassDumperTest\testPlain(), BackupDumperLoggerTest\testPlain(), TextPassDumperTest\testPrefetchPlain(), BackupDumperPageTest\testXmlDumpsBackupUseCase(), and BackupDumperLoggerTest\testXmlDumpsBackupUseCaseLogging().

◆ assertDumpStart()

DumpTestCase::assertDumpStart	(	$fname,
		$skip_siteinfo = `true`
	)

protected

Opens an XML file to analyze and optionally skips past siteinfo.

Parameters

$fname	string: name of file to analyze
$skip_siteinfo	bool: (optional) If true, step the xml reader to the first element after </siteinfo>

Definition at line 159 of file DumpTestCase.php.

References $fname, and skipPastNodeEnd().

Referenced by TextPassDumperTest\checkpointHelper(), BackupDumperPageTest\testCurrentStubGzip(), BackupDumperPageTest\testCurrentStubPlain(), BackupDumperPageTest\testFullStubPlain(), BackupDumperPageTest\testFullTextPlain(), TextPassDumperTest\testPlain(), BackupDumperLoggerTest\testPlain(), TextPassDumperTest\testPrefetchPlain(), BackupDumperPageTest\testXmlDumpsBackupUseCase(), and BackupDumperLoggerTest\testXmlDumpsBackupUseCaseLogging().

◆ assertNodeEnd()

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

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

Definition at line 221 of file DumpTestCase.php.

References $name.

Referenced by assertDumpEnd(), BackupDumperLoggerTest\assertLogItem(), assertPageEnd(), assertRevision(), assertText(), and assertTextNode().

◆ assertNodeStart()

DumpTestCase::assertNodeStart	(	$name,
		$skip = `true`
	)

protected

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

Parameters

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

Definition at line 205 of file DumpTestCase.php.

References $name.

Referenced by BackupDumperLoggerTest\assertLogItem(), assertPageStart(), assertRevision(), assertText(), and assertTextNode().

◆ assertPageEnd()

DumpTestCase::assertPageEnd ( )

protected

Asserts that the xml reader is at the page's closing element and skips to the next element.

Definition at line 280 of file DumpTestCase.php.

References assertNodeEnd(), and skipWhitespace().

Referenced by TextPassDumperTest\checkpointHelper(), BackupDumperPageTest\testCurrentStubGzip(), BackupDumperPageTest\testCurrentStubPlain(), BackupDumperPageTest\testFullStubPlain(), BackupDumperPageTest\testFullTextPlain(), TextPassDumperTest\testPlain(), TextPassDumperTest\testPrefetchPlain(), and BackupDumperPageTest\testXmlDumpsBackupUseCase().

◆ assertPageStart()

DumpTestCase::assertPageStart	(	$id,
		$ns,
		$name
	)

protected

Asserts that the xml reader is at the start of a page element and skips over the first tags, after checking them.

Besides the opening page element, this function also checks for and skips over the title, ns, and id tags. Hence after this function, the xml reader is at the first revision of the current page.

Parameters

$id	int: id of the page to assert
$ns	int: number of namespage to assert
$name	string: title of the current page

Definition at line 266 of file DumpTestCase.php.

References $name, assertNodeStart(), assertTextNode(), and skipWhitespace().

Referenced by TextPassDumperTest\checkpointHelper(), BackupDumperPageTest\testCurrentStubGzip(), BackupDumperPageTest\testCurrentStubPlain(), BackupDumperPageTest\testFullStubPlain(), BackupDumperPageTest\testFullTextPlain(), TextPassDumperTest\testPlain(), TextPassDumperTest\testPrefetchPlain(), and BackupDumperPageTest\testXmlDumpsBackupUseCase().

◆ assertRevision()

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

$id	int: id of the revision
$summary	string: summary of the revision
$text_id	int: id of the revision's text
$text_bytes	int: # of bytes in the revision's text
$text_sha1	string: the base36 SHA-1 of the revision's text
$text	string\|false: (optional) The revision's string, or false to check for a revision stub
$model	String: the expected content model id (default: CONTENT_MODEL_WIKITEXT)
$format	String: the expected format model id (default: CONTENT_FORMAT_WIKITEXT)
$parentid	int\|false: (optional) id of the parent revision

Definition at line 300 of file DumpTestCase.php.

References $summary, assertNodeEnd(), assertNodeStart(), assertText(), assertTextNode(), and skipWhitespace().

Referenced by TextPassDumperTest\checkpointHelper(), BackupDumperPageTest\testCurrentStubGzip(), BackupDumperPageTest\testCurrentStubPlain(), BackupDumperPageTest\testFullStubPlain(), BackupDumperPageTest\testFullTextPlain(), TextPassDumperTest\testPlain(), TextPassDumperTest\testPrefetchPlain(), and BackupDumperPageTest\testXmlDumpsBackupUseCase().

◆ assertText()

DumpTestCase::assertText	(	$id,
		$text_id,
		$text_bytes,
		$text
	)

protected

Definition at line 345 of file DumpTestCase.php.

References assertNodeEnd(), assertNodeStart(), and skipWhitespace().

Referenced by assertRevision().

◆ assertTextNode()

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

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

Definition at line 240 of file DumpTestCase.php.

References $name, assertNodeEnd(), assertNodeStart(), and skipWhitespace().

Referenced by BackupDumperLoggerTest\assertLogItem(), assertPageStart(), and assertRevision().

◆ expectETAOutput()

DumpTestCase::expectETAOutput ( )

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

Definition at line 90 of file DumpTestCase.php.

References $line, $lines, and as.

Referenced by TextPassDumperTest\checkpointHelper(), and BackupDumperPageTest\testXmlDumpsBackupUseCase().

◆ gunzip()

DumpTestCase::gunzip ( $fname )

protected

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

Parameters

$fname string: filename to read the gzipped data from and stored the gunzipped data into

Definition at line 55 of file DumpTestCase.php.

References $fname, and fail.

Referenced by TextPassDumperTest\checkpointHelper(), BackupDumperPageTest\testCurrentStubGzip(), BackupDumperPageTest\testXmlDumpsBackupUseCase(), and BackupDumperLoggerTest\testXmlDumpsBackupUseCaseLogging().

◆ setUp()

DumpTestCase::setUp ( )

protected

Default set up function.

Clears $wgUser, and reports errors from addDBData to PHPUnit

Reimplemented from MediaWikiLangTestCase.

Reimplemented in TextPassDumperTest, and BackupDumperPageTest.

Definition at line 75 of file DumpTestCase.php.

References $exceptionFromAddDBData, MediaWikiTestCase\setMwGlobals(), and User.

◆ skipPastNodeEnd()

DumpTestCase::skipPastNodeEnd ( $name )

protected

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

Parameters

$name string: name of the closing element to look for (e.g.: "mediawiki" when looking for </mediawiki>)

Returns: bool: true iff new element after the closing of $name could be found. false otherwise.

Definition at line 140 of file DumpTestCase.php.

References $name, and skipToNodeEnd().

Referenced by assertDumpStart().

◆ skipToNodeEnd()

DumpTestCase::skipToNodeEnd ( $name )

protected

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

Parameters

$name string: name 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 118 of file DumpTestCase.php.

References $name.

Referenced by skipPastNodeEnd().

◆ skipWhitespace()

DumpTestCase::skipWhitespace ( )

protected

Steps the xml reader over white space.

Definition at line 189 of file DumpTestCase.php.

References csslex\WHITESPACE.

Referenced by assertDumpEnd(), BackupDumperLoggerTest\assertLogItem(), assertPageEnd(), assertPageStart(), assertRevision(), assertText(), and assertTextNode().

Member Data Documentation

◆ $exceptionFromAddDBData

Exception null 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 18 of file DumpTestCase.php.

Referenced by setUp().

◆ $xml

XMLReader null DumpTestCase::$xml = null

protected

Holds the xmlreader used for analyzing an xml dump.

Definition at line 24 of file DumpTestCase.php.

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

tests/phpunit/maintenance/DumpTestCase.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addRevision()

◆ assertDumpEnd()

◆ assertDumpStart()

◆ assertNodeEnd()

◆ assertNodeStart()

◆ assertPageEnd()

◆ assertPageStart()

◆ assertRevision()

◆ assertText()

◆ assertTextNode()

◆ expectETAOutput()

◆ gunzip()

◆ setUp()

◆ skipPastNodeEnd()

◆ skipToNodeEnd()

◆ skipWhitespace()

Member Data Documentation

◆ $exceptionFromAddDBData

◆ $xml