Tests for page dumps of BackupDumper. More...

Inheritance diagram for BackupDumperPageTest:

[legend]

Collaboration diagram for BackupDumperPageTest:

[legend]

Public Member Functions
	addDBData ()
	Stub.

	testCurrentStubGzip ()

	testCurrentStubPlain ()

	testFullStubPlain ()

	testFullTextPlain ()

	testXmlDumpsBackupUseCase ()
	xmldumps-backup typically performs a single dump that that writes out three files

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

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

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

	__destruct ()

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

Protected Member Functions
	setUp ()
	Default set up function.

Protected Member Functions inherited from DumpTestCase
	addRevision (Page $page, $text, $summary, $model=CONTENT_MODEL_WIKITEXT)
	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, $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.

	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.

	checkHasGzip ()
	Skip the test if 'gzip' is not in $PATH.

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

Private Attributes
	$namespace

	$pageId1

	$pageId2

	$pageId3

	$pageId4

	$pageId5

	$pageTitle1

	$pageTitle2

	$pageTitle3

	$pageTitle4

	$pageTitle5

	$revId1_1

	$revId2_1

	$revId2_2

	$revId2_3

	$revId2_4

	$revId3_1

	$revId3_2

	$revId4_1

	$talk_namespace

	$textId1_1

	$textId2_1

	$textId2_2

	$textId2_3

	$textId2_4

	$textId3_1

	$textId3_2

	$textId4_1

Additional Inherited Members
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.

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

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 inherited from DumpTestCase
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.

Protected Attributes inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

Static Protected Attributes inherited from DumpTestCase
static bool null	$hasGzip = null
	Whether the 'gzip' utility is available.

Detailed Description

Tests for page dumps of BackupDumper.

Database Dump BackupDumper

Definition at line 10 of file backup_PageTest.php.

Member Function Documentation

◆ addDBData()

BackupDumperPageTest::addDBData ( )

Stub.

Subclasses may override this to prepare the database. Called before every test run (test function or data set).

See also: addDBDataOnce(); resetDB()

Since: 1.18

Reimplemented from MediaWikiTestCase.

Definition at line 23 of file backup_PageTest.php.

References $e, DumpTestCase\addRevision(), WikiPage\factory(), MediaWikiTestCase\getDefaultWikitextNS(), list, NS_TALK, and MediaWikiTestCase\setMwGlobals().

◆ setUp()

BackupDumperPageTest::setUp ( )

protected

Default set up function.

Clears $wgUser, and reports errors from addDBData to PHPUnit

Reimplemented from DumpTestCase.

Definition at line 87 of file backup_PageTest.php.

◆ testCurrentStubGzip()

BackupDumperPageTest::testCurrentStubGzip ( )

Definition at line 250 of file backup_PageTest.php.

References $fname, $pageId1, DumpTestCase\assertDumpEnd(), DumpTestCase\assertDumpStart(), DumpTestCase\assertPageEnd(), DumpTestCase\assertPageStart(), DumpTestCase\assertRevision(), DumpTestCase\checkHasGzip(), WikiExporter\CURRENT, MediaWikiTestCase\getNewTempFile(), DumpTestCase\gunzip(), and WikiExporter\STUB.

◆ testCurrentStubPlain()

BackupDumperPageTest::testCurrentStubPlain ( )

Definition at line 206 of file backup_PageTest.php.

References $fname, $pageId1, DumpTestCase\assertDumpEnd(), DumpTestCase\assertDumpStart(), DumpTestCase\assertPageEnd(), DumpTestCase\assertPageStart(), DumpTestCase\assertRevision(), WikiExporter\CURRENT, MediaWikiTestCase\getNewTempFile(), and WikiExporter\STUB.

◆ testFullStubPlain()

BackupDumperPageTest::testFullStubPlain ( )

Definition at line 156 of file backup_PageTest.php.

References $fname, $pageId1, DumpTestCase\assertDumpEnd(), DumpTestCase\assertDumpStart(), DumpTestCase\assertPageEnd(), DumpTestCase\assertPageStart(), DumpTestCase\assertRevision(), and MediaWikiTestCase\getNewTempFile().

◆ testFullTextPlain()

BackupDumperPageTest::testFullTextPlain ( )

Definition at line 100 of file backup_PageTest.php.

References $fname, $pageId1, DumpTestCase\assertDumpEnd(), DumpTestCase\assertDumpStart(), DumpTestCase\assertPageEnd(), DumpTestCase\assertPageStart(), DumpTestCase\assertRevision(), and MediaWikiTestCase\getNewTempFile().

◆ testXmlDumpsBackupUseCase()

BackupDumperPageTest::testXmlDumpsBackupUseCase ( )

xmldumps-backup typically performs a single dump that that writes out three files

gzipped stubs of everything (meta-history)
gzipped stubs of latest revisions of all pages (meta-current)
gzipped stubs of latest revisions of all pages of namespage 0 (articles)

We reproduce such a setup with our mini fixture, although we omit chunks, and all the other gimmicks of xmldumps-backup.

Definition at line 308 of file backup_PageTest.php.

References $pageId1, DumpTestCase\assertDumpEnd(), DumpTestCase\assertDumpStart(), DumpTestCase\assertPageEnd(), DumpTestCase\assertPageStart(), DumpTestCase\assertRevision(), DumpTestCase\checkHasGzip(), DumpTestCase\expectETAOutput(), WikiExporter\FULL, MediaWikiTestCase\getNewTempFile(), DumpTestCase\gunzip(), and WikiExporter\STUB.

Member Data Documentation

◆ $namespace

BackupDumperPageTest::$namespace

private

Definition at line 21 of file backup_PageTest.php.

◆ $pageId1

BackupDumperPageTest::$pageId1

private

Definition at line 14 of file backup_PageTest.php.

Referenced by testCurrentStubGzip(), testCurrentStubPlain(), testFullStubPlain(), testFullTextPlain(), and testXmlDumpsBackupUseCase().

◆ $pageId2

BackupDumperPageTest::$pageId2

private

Definition at line 14 of file backup_PageTest.php.

◆ $pageId3

BackupDumperPageTest::$pageId3

private

Definition at line 14 of file backup_PageTest.php.

◆ $pageId4

BackupDumperPageTest::$pageId4

private

Definition at line 14 of file backup_PageTest.php.

◆ $pageId5

BackupDumperPageTest::$pageId5

private

Definition at line 14 of file backup_PageTest.php.

◆ $pageTitle1

BackupDumperPageTest::$pageTitle1

private

Definition at line 15 of file backup_PageTest.php.

◆ $pageTitle2

BackupDumperPageTest::$pageTitle2

private

Definition at line 15 of file backup_PageTest.php.

◆ $pageTitle3

BackupDumperPageTest::$pageTitle3

private

Definition at line 15 of file backup_PageTest.php.

◆ $pageTitle4

BackupDumperPageTest::$pageTitle4

private

Definition at line 15 of file backup_PageTest.php.

◆ $pageTitle5

BackupDumperPageTest::$pageTitle5

private

Definition at line 15 of file backup_PageTest.php.

◆ $revId1_1

BackupDumperPageTest::$revId1_1

private

Definition at line 16 of file backup_PageTest.php.

◆ $revId2_1

BackupDumperPageTest::$revId2_1

private

Definition at line 17 of file backup_PageTest.php.

◆ $revId2_2

BackupDumperPageTest::$revId2_2

private

Definition at line 17 of file backup_PageTest.php.

◆ $revId2_3

BackupDumperPageTest::$revId2_3

private

Definition at line 18 of file backup_PageTest.php.

◆ $revId2_4

BackupDumperPageTest::$revId2_4

private

Definition at line 18 of file backup_PageTest.php.

◆ $revId3_1

BackupDumperPageTest::$revId3_1

private

Definition at line 19 of file backup_PageTest.php.

◆ $revId3_2

BackupDumperPageTest::$revId3_2

private

Definition at line 19 of file backup_PageTest.php.

◆ $revId4_1

BackupDumperPageTest::$revId4_1

private

Definition at line 20 of file backup_PageTest.php.

◆ $talk_namespace

BackupDumperPageTest::$talk_namespace

private

Definition at line 21 of file backup_PageTest.php.

◆ $textId1_1

BackupDumperPageTest::$textId1_1

private

Definition at line 16 of file backup_PageTest.php.

◆ $textId2_1

BackupDumperPageTest::$textId2_1

private

Definition at line 17 of file backup_PageTest.php.

◆ $textId2_2

BackupDumperPageTest::$textId2_2

private

Definition at line 17 of file backup_PageTest.php.

◆ $textId2_3

BackupDumperPageTest::$textId2_3

private

Definition at line 18 of file backup_PageTest.php.

◆ $textId2_4

BackupDumperPageTest::$textId2_4

private

Definition at line 18 of file backup_PageTest.php.

◆ $textId3_1

BackupDumperPageTest::$textId3_1

private

Definition at line 19 of file backup_PageTest.php.

◆ $textId3_2

BackupDumperPageTest::$textId3_2

private

Definition at line 19 of file backup_PageTest.php.

◆ $textId4_1

BackupDumperPageTest::$textId4_1

private

Definition at line 20 of file backup_PageTest.php.

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

tests/phpunit/maintenance/backup_PageTest.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addDBData()

◆ setUp()

◆ testCurrentStubGzip()

◆ testCurrentStubPlain()

◆ testFullStubPlain()

◆ testFullTextPlain()

◆ testXmlDumpsBackupUseCase()

Member Data Documentation

◆ $namespace

◆ $pageId1

◆ $pageId2

◆ $pageId3

◆ $pageId4

◆ $pageId5

◆ $pageTitle1

◆ $pageTitle2

◆ $pageTitle3

◆ $pageTitle4

◆ $pageTitle5

◆ $revId1_1

◆ $revId2_1

◆ $revId2_2

◆ $revId2_3

◆ $revId2_4

◆ $revId3_1

◆ $revId3_2

◆ $revId4_1

◆ $talk_namespace

◆ $textId1_1

◆ $textId2_1

◆ $textId2_2

◆ $textId2_3

◆ $textId2_4

◆ $textId3_1

◆ $textId3_2

◆ $textId4_1