Base TestCase for dumps. More...

Inheritance diagram for MediaWiki\Tests\Maintenance\DumpTestCase:

[legend]

Collaboration diagram for MediaWiki\Tests\Maintenance\DumpTestCase:

[legend]

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

Public Member Functions inherited from MediaWikiTestCase
	__construct ( $name=null, array $data=[], $dataName='')

	__destruct ()

	addDBData ()
	Stub.

	addDBDataOnce ()
	Stub.

	copyTestData (IDatabase $source, IDatabase $target)
	Copy test data from one database connection to another.

	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)

	setGroupPermissions ( $newPerms, $newKey=null, $newValue=null)
	Alters $wgGroupPermissions for the duration of the test.

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

Static Public Member Functions inherited from MediaWikiTestCase
static	getMutableTestUser ( $groups=[])
	Convenience method for getting a mutable test user.

static	getTestPrefixFor (IDatabase $db)

static	getTestSysop ()
	Convenience method for getting an immutable admin test user.

static	getTestUser ( $groups=[])
	Convenience method for getting an immutable test user.

static	installMockMwServices (Config $configOverrides=null)
	Creates a new "mock" MediaWikiServices instance, and installs it.

static	listTables (IMaintainableDatabase $db)

static	prepareServices (Config $bootstrapConfig)

static	resetNonServiceCaches ()
	Resets some non-service singleton instances and other static caches.

static	restoreMwServices ()
	Restores the original, non-mock MediaWikiServices instance.

static	setupTestDB (IMaintainableDatabase $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
	addRevision (WikiPage $page, $text, $summary, $model=CONTENT_MODEL_WIKITEXT)
	Adds a revision to a page, while returning the resuting revision's id.

	assertDumpSchema ( $fname, $schemaFile)
	Checks an XML file against an XSD schema.

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

	getDumpAsserter ( $schemaVersion=null)

	getXmlSchemaPath ( $schemaVersion=null)
	Returns the path to the XML schema file for the given schema version.

	gunzip ( $fname)
	gunzips the given file and stores the result in the original file name

	setUp ()
	Default set up function.

Protected Member Functions inherited from MediaWikiTestCase
	addCoreDBData ()

	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=false, $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, array $options=[], array $join_conds=[])
	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.

	checkDbIsSupported ()

	checkPHPExtension ( $extName)
	Check if $extName is a loaded PHP extension, will skip the test whenever it is not loaded.

	editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
	Edits or creates a page/revision.

	ensureMockDatabaseConnection (IDatabase $db)

	getDefaultWikitextNS ()
	Returns the ID of a namespace that defaults to Wikitext.

	getExistingTestPage ( $title=null)
	Returns a WikiPage representing an existing page.

	getNewTempDirectory ()
	obtains a new temporary directory

	getNewTempFile ()
	Obtains a new temporary file name.

	getNonexistingTestPage ( $title=null)
	Returns a WikiPage representing a non-existing page.

	getSchemaOverrides (IMaintainableDatabase $db)
	Stub.

	insertPage ( $pageName, $text='Sample page for unit test.', $namespace=null, User $user=null)
	Insert a new page.

	isTestInDatabaseGroup ()

	isWikitextNS ( $ns)
	Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels.

	markTestSkippedIfDbType ( $type)
	Skip the test if using the specified database type.

	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.

	revisionDelete ( $rev, array $value=[Revision::DELETED_TEXT=> 1], $comment='')
	Revision-deletes a revision.

	setIniSetting ( $name, $value)
	Set an ini setting for the duration of the test.

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

	truncateTable ( $tableName, IDatabase $db=null)
	Empties the given table and resets any auto-increment counters.

Protected Attributes
Exception null	$exceptionFromAddDBData = null
	exception to be rethrown once in sound PHPUnit surrounding

Protected Attributes inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

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

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

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	setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix=null)
	Setups a database with cloned tables using the given prefix.

static	setupExternalStoreTestDBs ( $testPrefix=null)
	Clones the External Store database(s) for testing.

static	stripStringKeys (&$r)
	Utility function for eliminating all string keys from an array.

Detailed Description

Base TestCase for dumps.

Definition at line 17 of file DumpTestCase.php.

Member Function Documentation

◆ addRevision()

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

protected

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

Parameters

WikiPage	$page	Page to add the revision to
string	$text	Revisions text
string	$summary	Revisions summary
string	$model	The model ID (defaults to wikitext)

Exceptions

MWException

Returns: array

Definition at line 63 of file DumpTestCase.php.

References $value, and and().

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

◆ assertDumpSchema()

MediaWiki\Tests\Maintenance\DumpTestCase::assertDumpSchema	(		$fname,
			$schemaFile )

protected

Checks an XML file against an XSD schema.

Definition at line 211 of file DumpTestCase.php.

References $fname, and and().

Referenced by MediaWiki\Tests\Maintenance\BackupDumperPageTest\testCurrentStubPlain(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testFullStubPlain(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testFullTextPlain(), MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\testPlain(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testXmlDumpsBackupUseCase(), and MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\testXmlDumpsBackupUseCaseLogging().

◆ checkHasGzip()

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

protected

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

Returns: bool

Definition at line 40 of file DumpTestCase.php.

References MediaWiki\Tests\Maintenance\DumpTestCase\$hasGzip, and(), and false.

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

◆ expectETAOutput()

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

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

Definition at line 175 of file DumpTestCase.php.

References $line, $lines, and and().

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

◆ getDumpAsserter()

MediaWiki\Tests\Maintenance\DumpTestCase::getDumpAsserter ( $schemaVersion = null )

protected

Parameters

null | string $schemaVersion

Returns: DumpAsserter

Definition at line 203 of file DumpTestCase.php.

◆ getXmlSchemaPath()

MediaWiki\Tests\Maintenance\DumpTestCase::getXmlSchemaPath ( $schemaVersion = null )

protected

Returns the path to the XML schema file for the given schema version.

Parameters

string | null $schemaVersion

Returns: string

Definition at line 164 of file DumpTestCase.php.

References $IP, and $wgXmlDumpSchemaVersion.

Referenced by MediaWiki\Tests\Maintenance\BackupDumperPageTest\testCurrentStubPlain(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testFullStubPlain(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testFullTextPlain(), MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\testPlain(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testXmlDumpsBackupUseCase(), and MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\testXmlDumpsBackupUseCaseLogging().

◆ gunzip()

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

protected

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

Parameters

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

Definition at line 95 of file DumpTestCase.php.

References $fname, and and().

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\BackupDumperPageTest, and MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest.

Definition at line 145 of file DumpTestCase.php.

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

◆ setUpBeforeClass()

static MediaWiki\Tests\Maintenance\DumpTestCase::setUpBeforeClass ( )

static

Reimplemented from MediaWikiTestCase.

Definition at line 110 of file DumpTestCase.php.

References $context, $file, and and().

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

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

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

tests/phpunit/maintenance/DumpTestCase.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addRevision()

◆ assertDumpSchema()

◆ checkHasGzip()

◆ expectETAOutput()

◆ getDumpAsserter()

◆ getXmlSchemaPath()

◆ gunzip()

◆ setUp()

◆ setUpBeforeClass()

Member Data Documentation

◆ $exceptionFromAddDBData

◆ $hasGzip