Inheritance diagram for MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase:

[legend]

Collaboration diagram for MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase:

[legend]

Protected Member Functions
	assertOutputPrePostShutdown ( $preShutdownOutput, $expectNLAppending)
	Asserts the output before and after simulating shutdown.

	createMaintenance ()
	Called by setUp to initialize $this->maintenance.

	getMaintenanceClass ()

	setUp ()

	tearDown ()
	Do a little stream cleanup to prevent output in case the child class hasn't tested the capture buffer.

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

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

	getNewTempDirectory ()
	obtains a new temporary directory

	getNewTempFile ()
	Obtains a new temporary file name.

	getSchemaOverrides (IMaintainableDatabase $db)
	Stub.

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

Protected Attributes
Maintenance	$maintenance
	The main Maintenance instance that is used for testing, wrapped and mockable.

Protected Attributes inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

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

	__destruct ()

	addDBData ()
	Stub.

	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)

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

Detailed Description

Definition at line 9 of file MaintenanceBaseTestCase.php.

Member Function Documentation

◆ assertOutputPrePostShutdown()

MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase::assertOutputPrePostShutdown	(		$preShutdownOutput,
			$expectNLAppending )

protected

Asserts the output before and after simulating shutdown.

This function simulates shutdown of self::maintenance.

Parameters

string	$preShutdownOutput	Expected output before simulating shutdown
bool	$expectNLAppending	Whether or not shutdown simulation is expected to add a newline to the output. If false, $preShutdownOutput is the expected output after shutdown simulation. Otherwise, $preShutdownOutput with an appended newline is the expected output after shutdown simulation.

Definition at line 83 of file MaintenanceBaseTestCase.php.

◆ createMaintenance()

MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase::createMaintenance ( )

protected

Called by setUp to initialize $this->maintenance.

Returns: object The Maintenance instance to test.

Reimplemented in MediaWiki\Tests\Maintenance\MaintenanceTest.

Definition at line 62 of file MaintenanceBaseTestCase.php.

References MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\getMaintenanceClass().

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

◆ getMaintenanceClass()

MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase::getMaintenanceClass ( )

abstractprotected

Returns: string Class name

Subclasses must implement this in order to use the $this->maintenance variable. Normally, it will be set like: return PopulateDatabaseMaintenance::class;

If you need to change the way your maintenance class is constructed, override createMaintenance.

Reimplemented in MediaWiki\Tests\Maintenance\DeleteAutoPatrolLogsTest, and MediaWiki\Tests\Maintenance\MaintenanceTest.

Referenced by MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\createMaintenance().