Base TestCase for dumps. More...

Inheritance diagram for DumpTestCase:

Collaboration diagram for DumpTestCase:

Public Member Functions
	expectETAOutput ()
	Checks for test output consisting only of lines containing ETA announcements.
	setUp ()
	Default set up function.
Protected Member Functions
	addRevision (Page $page, $text, $summary)
	Adds a revision to a page, while returning the resuting revision's id.
	assertDumpEnd ($name="mediawiki")
	Asserts that the xml reader is at the final closing tag of an xml file and closes the reader.
	assertDumpStart ($fname, $skip_siteinfo=true)
	Opens an XML file to analyze and optionally skips past siteinfo.
	assertNodeEnd ($name, $skip=true)
	Asserts that the xml reader is at an closing element of given name, and optionally skips past it.
	assertNodeStart ($name, $skip=true)
	Asserts that the xml reader is at an element of given name, and optionally skips past it.
	assertPageEnd ()
	Asserts that the xml reader is at the page's closing element and skips to the next element.
	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.
	assertRevision ($id, $summary, $text_id, $text_bytes, $text_sha1, $text=false, $parentid=false)
	Asserts that the xml reader is at a revision and checks its representation before skipping over it.
	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.
	gunzip ($fname)
	gunzips the given file and stores the result in the original file name
	skipPastNodeEnd ($name)
	Step the current XML reader to the first element start after the node end of a given name.
	skipToNodeEnd ($name)
	Step the current XML reader until node end of given name is found.
	skipWhitespace ()
	Steps the xml reader over white space.
Protected Attributes
Exception null	$exceptionFromAddDBData = null
	exception to be rethrown once in sound PHPUnit surrounding
XMLReader null	$xml = null
	Holds the xmlreader used for analyzing an xml dump.

Detailed Description

Base TestCase for dumps.

Definition at line 6 of file DumpTestCase.php.

Member Function Documentation

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.

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

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 174 of file DumpTestCase.php.

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

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 157 of file DumpTestCase.php.

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

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 219 of file DumpTestCase.php.

Referenced by BackupDumperLoggerTest\assertLogItem().

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 203 of file DumpTestCase.php.

Referenced by BackupDumperLoggerTest\assertLogItem().

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.

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

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 265 of file DumpTestCase.php.

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

DumpTestCase::assertRevision	(	$	id,
		$	summary,
		$	text_id,
		$	text_bytes,
		$	text_sha1,
		$	text = `false`,
		$	parentid = `false`
	)		`[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
$parentid	int\|false: (optional) id of the parent revision

Definition at line 298 of file DumpTestCase.php.

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

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 239 of file DumpTestCase.php.

Referenced by BackupDumperLoggerTest\assertLogItem().

DumpTestCase::expectETAOutput ( )

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

Definition at line 90 of file DumpTestCase.php.

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

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 56 of file DumpTestCase.php.

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

DumpTestCase::setUp ( )

Default set up function.

Clears $wgUser, and reports errors from addDBData to PHPUnit

Reimplemented from MediaWikiLangTestCase.

Reimplemented in TextPassDumperTest, and BackupDumperPageTest.

Definition at line 73 of file DumpTestCase.php.

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 139 of file DumpTestCase.php.

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 iff the end node could be found. false otherwise.

Definition at line 119 of file DumpTestCase.php.

DumpTestCase::skipWhitespace ( ) [protected]

Steps the xml reader over white space.

Definition at line 187 of file DumpTestCase.php.

Referenced by BackupDumperLoggerTest\assertLogItem().

Member Data Documentation

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.

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

Detailed Description

Member Function Documentation

Member Data Documentation