Inherits PHPUnit\Framework\TestCase.

Collaboration diagram for MediaWikiTestCase:

[legend]

Public Member Functions
	__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	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	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
const	DB_PREFIX = 'unittest_'
	Table name prefixes.

const	ORA_DB_PREFIX = 'ut_'

Static Public Attributes
static TestUser[]	$users

Protected Member Functions
	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.

	setUp ()

	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.

Static Protected Member Functions
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.

Protected Attributes
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

Private Member Functions
	containsClosure ( $var, $maxDepth=15)

	doSetMwGlobals ( $pairs, $value=null)
	An internal method that allows setService() to set globals that tests are not supposed to touch.

	doStashMwGlobals ( $globalKeys)

	dropMockTables (IMaintainableDatabase $db, array $tables)
	Drops the given mock tables.

	listOriginalTables (IMaintainableDatabase $db, $prefix='prefixed')
	Lists all tables in the live database schema.

	mungeSchemaUpdateQuery ( $cmd)

	oncePerClass ()

	recloneMockTables (IMaintainableDatabase $db, array $tables)
	Re-clones the given mock tables to restore them based on the live database schema.

	resetDB ( $db, $tablesUsed)
	Empty all tables so they can be repopulated for tests.

	resetNamespaces ()
	Must be called whenever namespaces are changed, e.g., $wgExtraNamespaces is altered.

	restoreLoggers ()
	Restores loggers replaced by setLogger().

	setUpSchema (IMaintainableDatabase $db)
	Applies the schema overrides returned by getSchemaOverrides(), after undoing any previously applied schema overrides.

	undoSchemaOverrides (IMaintainableDatabase $db, $oldOverrides)
	Undoes the specified schema overrides.

Static Private Member Functions
static	canShallowCopy ( $value)
	Check if we can back up a value by performing a shallow copy.

static	isNotUnittest ( $table)

static	makeTestConfig (Config $baseConfig=null, Config $customOverrides=null)
	Create a config suitable for testing, based on a base config, default overrides, and custom overrides.

static	makeTestConfigFactoryInstantiator (ConfigFactory $oldFactory, array $configurations)

static	unprefixTable (&$tableName, $ind, $prefix)

Private Attributes
	$called = []
	$called tracks whether the setUp and tearDown method has been called.

array	$cliArgs = []
	The CLI arguments passed through from phpunit.php.

array	$iniSettings = []
	Holds original values of ini settings to be restored in tearDown().

MediaWikiServices	$localServices
	The local service locator, created during setUp().

LoggerInterface[]	$loggers = []
	Holds original loggers which have been replaced by setLogger()

array	$mwGlobals = []
	Holds original values of MediaWiki configuration settings to be restored in tearDown().

array	$mwGlobalsToUnset = []
	Holds list of MediaWiki configuration settings to be unset in tearDown().

string[]	$overriddenServices = []
	Holds a list of services that were overridden with setService().

int	$phpErrorLevel
	Original value of PHP's error_reporting setting.

array	$tmpFiles = []
	Holds the paths of temporary files/directories created through getNewTempFile, and getNewTempDirectory.

Static Private Attributes
static	$dbSetup = false

static	$oldTablePrefix = ''

static MediaWikiServices null	$originalServices
	The original service locator.

static	$reuseDB = false

static	$schemaOverrideDefaults

static	$useTemporaryTables = true

Detailed Description

Since: 1.18

Definition at line 16 of file MediaWikiTestCase.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented in ApiQueryRecentChangesIntegrationTest, ApiQueryWatchlistIntegrationTest, EnhancedChangesListTest, OldChangesListTest, RCCacheEntryFactoryTest, LinksUpdateTest, JobQueueTest, RefreshLinksPartitionTest, PageArchiveTestBase, WikiPageDbTestBase, and RevisionDbTestBase.

Definition at line 147 of file MediaWikiTestCase.php.

References $name.

◆ __destruct()

MediaWikiTestCase::__destruct ( )

Definition at line 154 of file MediaWikiTestCase.php.

Member Function Documentation

◆ addCoreDBData()

MediaWikiTestCase::addCoreDBData ( )

protected

Since: 1.32

Reimplemented in PageArchiveTestBase, WikiPageDbTestBase, MediaWiki\Tests\Revision\RevisionStoreDbTestBase, RevisionDbTestBase, and MediaWiki\Tests\Storage\NameTableStoreTest.

Definition at line 1283 of file MediaWikiTestCase.php.

References $user, SiteStatsInit\doPlaceholderInit(), EDIT_NEW, EDIT_SUPPRESS_RC, and User\resetIdByNameCache().

Referenced by resetDB(), and run().

◆ addDBData()

MediaWikiTestCase::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 in BotPasswordTest, LocalIdLookupTest, MediaWiki\Tests\Maintenance\BackupDumperLoggerTest, MediaWiki\Tests\Maintenance\BackupDumperPageTest, and MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest.

Definition at line 1277 of file MediaWikiTestCase.php.

Referenced by run().

◆ addDBDataOnce()

MediaWikiTestCase::addDBDataOnce ( )

Stub.

If a test suite needs to add additional data to the database, it should implement this method and do so. This method is called once per test suite (i.e. once per class).

Note data added by this method may be removed by resetDB() depending on the contents of $tablesUsed.

To add additional data between test function runs, override prepareDB().

See also: addDBData(); resetDB()

Since: 1.27

Reimplemented in ApiComparePagesTest, ApiParseTest, ApiQueryBasicTest, ApiQueryContinue2Test, ApiQueryContinueTest, ApiQueryUserContribsTest, GenderCacheTest, MessageCacheTest, CategoryMembershipChangeTest, ContentHandlerTest, LinksUpdateTest, CategoryMembershipChangeJobTest, MergeHistoryTest, PrefixSearchTest, SearchEnginePrefixTest, SearchEngineTest, MediaWiki\Session\BotPasswordSessionProviderTest, SpecialMyLanguageTest, and MediaWiki\Tests\Maintenance\FetchTextTest.

Definition at line 1265 of file MediaWikiTestCase.php.

Referenced by run().

◆ addTmpFiles()

MediaWikiTestCase::addTmpFiles ( $files )

protected

Definition at line 540 of file MediaWikiTestCase.php.

References array().

Referenced by FileBackendTest\doTestDoOperationsPipeline(), CSSMinTest\testGetMimeType(), and FileBackendTest\testStore().

◆ arrayWrap()

MediaWikiTestCase::arrayWrap ( array $elements )

protected

Utility method taking an array of elements and wrapping each element in its own array.

Useful for data providers that only return a single argument.

Since: 1.20

Parameters

array $elements

Returns: array

Definition at line 2015 of file MediaWikiTestCase.php.

Referenced by SiteTest\instanceProvider(), SiteListTest\siteArrayProvider(), and SiteListTest\siteListProvider().

◆ assertArrayEquals()

MediaWikiTestCase::assertArrayEquals	(	array	$expected,
		array	$actual,
			$ordered = `false`,
			$named = `false`
	)

protected

Assert that two arrays are equal.

By default this means that both arrays need to hold the same set of values. Using additional arguments, order and associated key can also be set as relevant.

Since: 1.20

Parameters

array	$expected
array	$actual
bool	$ordered	If the order of the values should match
bool	$named	If the keys should match

Definition at line 2036 of file MediaWikiTestCase.php.

References objectAssociativeSort().

Referenced by MediaWiki\Tests\Revision\RevisionStoreDbTestBase\assertRevisionRecordsEqual(), BotPasswordTest\testCanonicalizeLoginData(), ResourcesTest\testCommentedLocalFileReferences(), SpecialWatchlistTest\testFetchOptionsFromRequest(), ChangesListSpecialPageTest\testFilterUserExpLevel(), WikiMapTest\testGetCanonicalServerInfoForAllWikis(), RangeChronologicalPagerTest\testGetDateRangeCond(), SiteListTest\testGetGlobalIdentifiers(), ApiModuleManagerTest\testGetGroups(), DjVuTest\testGetImageSize(), ComposerInstalledTest\testGetInstalledDependencies(), ComposerLockTest\testGetInstalledDependencies(), ChangesListBooleanFilterGroupTest\testGetJsData(), ChangesListBooleanFilterTest\testGetJsData(), ChangesListStringOptionsFilterGroupTest\testGetJsData(), ApiModuleManagerTest\testGetNames(), ApiModuleManagerTest\testGetNamesWithClasses(), DjVuTest\testGetPageDimensions(), TextContentTest\testGetParserOutput(), UserPasswordPolicyTest\testGetPoliciesForGroups(), UserPasswordPolicyTest\testGetPoliciesForUser(), ComposerJsonTest\testGetRequiredDependencies(), MediaWiki\Tests\Revision\RevisionSlotsTest\testGetRolesWithDifferentContent(), ChangesListSpecialPageTest\testGetStructuredFilterJsData(), MediaWiki\Session\CookieSessionProviderTest\testGetVaryCookies(), PoolCounterTest\testHashKeyIntoSlots(), WikitextStructureTest\testHeadingsNone(), UserPasswordPolicyTest\testMaxOfPolicies(), ChangeTagsTest\testModifyDisplayQuery(), MediaWiki\Tests\Storage\RevisionSlotsUpdateTest\testModifySlot(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testNewNullRevision(), StatusTest\testOkAndErrorsGetters(), AbstractChangesListSpecialPageTestCase\testParseParameters(), SiteListTest\testSerialization(), ChangesListFilterTest\testSetAsSupersetOf(), CategoryChangesRdfTest\testSparqlUpdate(), LinksUpdateTest\testUpdate_pagelinks(), and AbstractChangesListSpecialPageTestCase\testValidateOptions().

◆ assertFileContains()

MediaWikiTestCase::assertFileContains	(	$fileName,
		$actualData,
		$createIfMissing = `false`,
		$msg = `''`
	)

protected

Check whether file contains given data.

Parameters

string	$fileName
string	$actualData
bool	$createIfMissing	If true, and file does not exist, create it with given data and skip the test.
string	$msg

Since: 1.30

Definition at line 2304 of file MediaWikiTestCase.php.

Referenced by MediaWiki\Tests\Maintenance\CategoriesRdfTest\testCategoriesDump(), CategoryChangesRdfTest\testSparqlUpdate(), and CategoryChangesRdfTest\testUpdateTs().

◆ assertHTMLEquals()

MediaWikiTestCase::assertHTMLEquals	(	$expected,
		$actual,
		$msg = `''`
	)

protected

Put each HTML element on its own line and then equals() the results.

Use for nicely formatting of PHPUnit diff output when comparing very simple HTML

Since: 1.20

Parameters

string	$expected	HTML on oneline
string	$actual	HTML on oneline
string	$msg	Optional message

Definition at line 2067 of file MediaWikiTestCase.php.

◆ assertSelect()

MediaWikiTestCase::assertSelect	(		$table,
			$fields,
			$condition,
		array	$expectedRows,
		array	$options = `[]`,
		array	$join_conds = `[]`
	)

protected

Asserts that the given database query yields the rows given by $expectedRows.

The expected rows should be given as indexed (not associative) arrays, with the values given in the order of the columns in the $fields parameter. Note that the rows are sorted by the columns given in $fields.

Since: 1.20

Parameters

string \| array	$table	The table(s) to query
string \| array	$fields	The columns to include in the result (and to sort by)
string \| array	$condition	"where" condition(s)
array	$expectedRows	An array of arrays giving the expected rows.
array	$options	Options for the query
array	$join_conds	Join conditions for the query

Exceptions

MWException If this test cases's needsDB() method doesn't return true. Test cases can use " Database" to enable database test support, or list the tables under testing in $this->tablesUsed, or override the needsDB() method.

Definition at line 1966 of file MediaWikiTestCase.php.

References $options, $res, as, DB_REPLICA, Wikimedia\Rdbms\IDatabase\lastError(), needsDB(), Wikimedia\Rdbms\Database\select(), wfGetCaller(), and wfGetDB().

Referenced by LinksUpdateTest\assertLinksUpdate(), LinksUpdateTest\assertRecentChangeByCategorization(), MediaWiki\Tests\Revision\McrReadNewRevisionStoreDbTest\assertRevisionExistsInDatabase(), MediaWiki\Tests\Revision\McrRevisionStoreDbTest\assertRevisionExistsInDatabase(), MediaWiki\Tests\Revision\McrWriteBothRevisionStoreDbTest\assertRevisionExistsInDatabase(), MediaWiki\Tests\Revision\PreMcrRevisionStoreDbTest\assertRevisionExistsInDatabase(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\assertRevisionExistsInDatabase(), WikiPageDbTestBase\testDoDeleteArticleReal_suppress(), WikiPageDbTestBase\testDoDeleteArticleReal_user0(), WikiPageDbTestBase\testDoDeleteArticleReal_userSysop(), WikiPageDbTestBase\testDoEditContent(), RevisionDbTestBase\testInsertOn_success(), PageArchiveMcrTest\testListRevisions_slots(), RefreshLinksJobTest\testRunForSinglePage(), and MediaWiki\Tests\Storage\PageUpdaterTest\testSetUsePageCreationLog().

◆ assertType()

MediaWikiTestCase::assertType	(	$type,
		$actual,
		$message = `''`
	)

protected

Asserts the type of the provided value.

This can be either in internal type such as boolean or integer, or a class or interface the value extends or implements.

Since: 1.20

Parameters

string	$type
mixed	$actual
string	$message

Definition at line 2143 of file MediaWikiTestCase.php.

References $type.

Referenced by assertTypeOrValue(), MediaWiki\Auth\AbstractAuthenticationProviderTest\testAbstractAuthenticationProvider(), ActionTest\testActionFactory(), MediaWiki\Auth\AuthenticationRequestTest\testBasics(), JobQueueTest\testDeduplicationWhileClaimed(), LanguageTest\testFormatNum(), MediaWiki\Auth\AuthenticationRequestTestCase\testGetFieldInfo(), BagOStuffTest\testGetScopedLock(), MediaWiki\Tests\Storage\NameTableStoreFactoryTest\testIntegratedGetChangeTagDef(), MediaWiki\Tests\Storage\NameTableStoreFactoryTest\testIntegratedGetContentModels(), MediaWiki\Tests\Storage\NameTableStoreFactoryTest\testIntegratedGetSlotRoles(), ShellTest\testMakeScriptCommand(), and ApiStructureTest\validateType().

◆ assertTypeOrValue()

MediaWikiTestCase::assertTypeOrValue	(	$type,
		$actual,
		$value = `false`,
		$message = `''`
	)

protected

Asserts that the provided variable is of the specified internal type or equals the $value argument.

This is useful for testing return types of functions that return a certain type or value when not set or on error.

Since: 1.20

Parameters

string	$type
mixed	$actual
mixed	$value
string	$message

Definition at line 2124 of file MediaWikiTestCase.php.

References $type, $value, and assertType().

Referenced by SiteTest\testGetGlobalId(), SiteTest\testGetLanguageCode(), and SiteTest\testGetPath().

◆ canShallowCopy()

static MediaWikiTestCase::canShallowCopy ( $value )

staticprivate

Check if we can back up a value by performing a shallow copy.

Values which fail this test are copied recursively.

Parameters

mixed $value

Returns: bool True if a shallow copy will do; false if a deep copy is required.

Definition at line 780 of file MediaWikiTestCase.php.

References $value, and as.

◆ checkDbIsSupported()

MediaWikiTestCase::checkDbIsSupported ( )

protected

Exceptions

MWException

Since: 1.18

Definition at line 1909 of file MediaWikiTestCase.php.

Referenced by run().

◆ checkPHPExtension()

MediaWikiTestCase::checkPHPExtension ( $extName )

protected

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

Since: 1.21

Parameters

string $extName

Returns: bool

Definition at line 2254 of file MediaWikiTestCase.php.

Referenced by CollationTest\setUp(), DiffHistoryBlobTest\setUp(), ExifBitmapTest\setUp(), ExifRotationTest\setUp(), ExifTest\setUp(), FormatMetadataTest\setUp(), JpegTest\setUp(), TiffTest\setUp(), RevisionTest\testCompressRevisionTextUtf8Gzip(), MediaWiki\Tests\Storage\SqlBlobStoreTest\testCompressRevisionTextUtf8Gzip(), HttpTest\testCurlConstants(), RevisionTest\testGetRevisionWithGzipAndLegacyEncoding(), RevisionTest\testGetRevisionWithZlibExtension(), RevisionTest\testGetRevisionWithZlibExtension_badData(), BitmapMetadataHandlerTest\testMultilingualCascade(), PNGMetadataExtractorTest\testPngNativetZtxt(), and BitmapMetadataHandlerTest\testPNGXMP().

◆ containsClosure()

MediaWikiTestCase::containsClosure	(	$var,
		$maxDepth = `15`
	)

private

Parameters

mixed	$var
int	$maxDepth

Returns: bool

Definition at line 870 of file MediaWikiTestCase.php.

References $value, as, and containsClosure().

Referenced by containsClosure(), and doStashMwGlobals().

◆ copyTestData()

MediaWikiTestCase::copyTestData	(	IDatabase	$source,
		IDatabase	$target
	)

Copy test data from one database connection to another.

This should only be used for small data sets.

Parameters

IDatabase	$source
IDatabase	$target

Definition at line 1890 of file MediaWikiTestCase.php.

References $res, $source, $tables, array(), as, and Wikimedia\Rdbms\IDatabase\insert().

◆ dbPrefix()

MediaWikiTestCase::dbPrefix ( )

Returns: string

Since: 1.18

Definition at line 1170 of file MediaWikiTestCase.php.

Referenced by LoadBalancerTest\makeServerConfig(), setupAllTestDBs(), LoadBalancerTest\testOpenConnection(), LoadBalancerTest\testTransactionCallbackChains(), LoadBalancerTest\testWithoutReplica(), and LoadBalancerTest\testWithReplica().

◆ doSetMwGlobals()

MediaWikiTestCase::doSetMwGlobals	(	$pairs,
		$value = `null`
	)

private

An internal method that allows setService() to set globals that tests are not supposed to touch.

Definition at line 724 of file MediaWikiTestCase.php.

References $GLOBALS, $value, as, doStashMwGlobals(), and resetNamespaces().

Referenced by setContentLang(), setMwGlobals(), and setService().

◆ doStashMwGlobals()

MediaWikiTestCase::doStashMwGlobals ( $globalKeys )

private

Definition at line 818 of file MediaWikiTestCase.php.

References $e, $GLOBALS, as, containsClosure(), serialize(), and unserialize().

Referenced by doSetMwGlobals(), and stashMwGlobals().

◆ dropMockTables()

MediaWikiTestCase::dropMockTables	(	IMaintainableDatabase	$db,
		array	$tables
	)

private

Drops the given mock tables.

Parameters

IMaintainableDatabase	$db
array	$tables

Definition at line 1693 of file MediaWikiTestCase.php.

References $tables, as, ensureMockDatabaseConnection(), Wikimedia\Rdbms\IDatabase\query(), and Wikimedia\Rdbms\IMaintainableDatabase\tableName().

Referenced by setUpSchema(), and undoSchemaOverrides().

◆ editPage()

MediaWikiTestCase::editPage	(	$pageName,
		$text,
		$summary = `''`,
		$defaultNs = `NS_MAIN`
	)

protected

Edits or creates a page/revision.

Parameters

string	$pageName	Page title
string	$text	Content of the page
string	$summary	Optional summary string for the revision
int	$defaultNs	Optional namespace id

Returns: array Array as returned by WikiPage::doEditContent()

Exceptions

MWException If this test cases's needsDB() method doesn't return true. Test cases can use " Database" to enable database test support, or list the tables under testing in $this->tablesUsed, or override the needsDB() method.

Definition at line 2333 of file MediaWikiTestCase.php.

References $title, and needsDB().

◆ ensureMockDatabaseConnection()

MediaWikiTestCase::ensureMockDatabaseConnection ( IDatabase $db )

protected

Exceptions

LogicException if the given database connection is not a set up to use mock tables.

Since: 1.31 this is no longer private.

Definition at line 1553 of file MediaWikiTestCase.php.

References Wikimedia\Rdbms\IDatabase\tablePrefix().

Referenced by dropMockTables(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\getTestPage(), recloneMockTables(), setUpSchema(), and undoSchemaOverrides().

◆ getCliArg()

MediaWikiTestCase::getCliArg ( $offset )

Since: 1.18

Parameters

string $offset

Returns: mixed

Definition at line 1920 of file MediaWikiTestCase.php.

Referenced by run(), FileBackendTest\setUp(), StoreBatchTest\setUp(), JobQueueTest\setUp(), BagOStuffTest\setUp(), and BagOStuffTest\testMerge_fork().

◆ getDefaultWikitextNS()

MediaWikiTestCase::getDefaultWikitextNS ( )

protected

Returns the ID of a namespace that defaults to Wikitext.

Exceptions

MWException If there is none.

Returns: int The ID of the wikitext Namespace

Since: 1.21

Definition at line 2177 of file MediaWikiTestCase.php.

References $namespaces, $wgNamespaceContentModels, as, CONTENT_MODEL_WIKITEXT, NS_CATEGORY, NS_FILE, NS_HELP, NS_MAIN, NS_MEDIAWIKI, NS_PROJECT, and NS_USER.

Referenced by MediaWiki\Tests\Maintenance\BackupDumperPageTest\addDBData(), MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\addDBData(), MediaWiki\Tests\Maintenance\FetchTextTest\addDBDataOnce(), EditPageTest\assertEdit(), RefreshLinksJobTest\createPage(), PagePropsTest\createPage(), RevisionDbTestBase\createPage(), MediaWiki\Tests\Storage\PageUpdaterTest\getDummyTitle(), RevisionTest\getMockTitle(), RevisionDbTestBase\getMockTitle(), ArticleViewTest\getPage(), MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest\getTitle(), DifferenceEngineTest\getTitle(), WikiPageDbTestBase\newPage(), EditPageTest\testAutoMerge(), WikiPageNoContentModelDbTest\testGetDeletionUpdates(), WikitextContentTest\testGetSecondaryDataUpdates(), RevisionDbTestBase\testUserWasLastToEdit(), and ArticleViewTest\testViewRedirect().

◆ getExistingTestPage()

MediaWikiTestCase::getExistingTestPage ( $title = null )

protected

Returns a WikiPage representing an existing page.

Since: 1.32

Parameters

Title | string | null $title

Returns: WikiPage

Exceptions

MWException If this test cases's needsDB() method doesn't return true. Test cases can use " Database" to enable database test support, or list the tables under testing in $this->tablesUsed, or override the needsDB() method.

Definition at line 219 of file MediaWikiTestCase.php.

References $title, $user, EDIT_NEW, EDIT_SUPPRESS_RC, and needsDB().

Referenced by PoolWorkArticleViewTest\testDoWorkDeletedContent(), PoolWorkArticleViewTest\testDoWorkLoadRevision(), PoolWorkArticleViewTest\testDoWorkParserCache(), PoolWorkArticleViewTest\testDoWorkWithContent(), PoolWorkArticleViewTest\testDoWorkWithExplicitRevision(), PoolWorkArticleViewTest\testDoWorkWithString(), ApiQueryInfoTest\testExecute(), ApiQueryInfoTest\testExecuteEditActions(), ApiQueryInfoTest\testExecuteEditActionsFull(), ApiQueryInfoTest\testExecuteEditActionsFullBlock(), ApiBaseTest\testGetTitleFromTitleOrPageIdPageId(), ApiBaseTest\testGetTitleOrPageIdPageId(), and PoolWorkArticleViewTest\testMagicWords().

◆ getExternalStoreDatabaseConnections()

static MediaWikiTestCase::getExternalStoreDatabaseConnections ( )

staticprotected

Gets master database connections for all of the ExternalStoreDB stores configured in $wgDefaultExternalStore.

Returns: Database[] Array of Database master connections

Definition at line 1507 of file MediaWikiTestCase.php.

References $wgDefaultExternalStore, array(), as, and list.

◆ getMutableTestUser()

static MediaWikiTestCase::getMutableTestUser ( $groups = [] )

static

Convenience method for getting a mutable test user.

Since: 1.28

Parameters

string | string[] $groups Groups the test user should be added in.

Returns: TestUser

Definition at line 191 of file MediaWikiTestCase.php.

Referenced by LocalIdLookupTest\addDBData(), GenderCacheTest\addDBDataOnce(), ApiUserrightsTest\doFailedRightsChange(), ApiUserrightsTest\doSuccessfulRightsChange(), EnhancedChangesListTest\getCategorizationChange(), OldChangesListTest\getContext(), RCCacheEntryFactoryTest\getContext(), EnhancedChangesListTest\getEditChange(), OldChangesListTest\getEditChange(), OldChangesListTest\getLogChange(), EnhancedChangesListTest\getLogChange(), ApiUserrightsTest\getMockForProcessingExpiries(), OldChangesListTest\getNewBotEditChange(), BlockTest\getUserForBlocking(), ApiBlockTest\setUp(), ApiQueryRecentChangesIntegrationTest\setUp(), ApiQueryWatchlistIntegrationTest\setUp(), ApiQueryWatchlistRawIntegrationTest\setUp(), ApiUnblockTest\setUp(), BotPasswordTest\setUp(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testAccountCreation(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testAccountCreationEmail(), UserGroupMembershipTest\testAddAndRemoveGroups(), ApiUserrightsTest\testAddAndRemoveGroups(), ApiMainTest\testAssert(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testAuthentication(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testAuthentication(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testBasics(), ApiBlockTest\testBlockByBlockedUser(), UserTest\testBlockInstanceCache(), UserTest\testCheckAndSetTouched(), ApiStashEditTest\testCheckCache(), UserTest\testEquals(), ApiBaseTest\testErrorArrayToStatus(), UserTest\testFindUsersByGroup(), UserTest\testGetEditCount(), UserTest\testIncEditCount(), UserTest\testLoggedIn(), ParserOptionsTest\testNewCanonical(), RCCacheEntryFactoryTest\testNewForDeleteChange(), RCCacheEntryFactoryTest\testNewForRevUserDeleteChange(), RCCacheEntryFactoryTest\testNewFromRecentChange(), UserTest\testOptions(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testProviderChangeAuthenticationData(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testProviderChangeAuthenticationDataEmail(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testSetPasswordResetFlag(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testTestUserCanAuthenticate(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testTestUserCanAuthenticate(), ApiUserrightsTest\testWebToken(), ApiUserrightsTest\testWithTag(), and ApiUserrightsTest\testWithTagNewBackend().

◆ getNewTempDirectory()

MediaWikiTestCase::getNewTempDirectory ( )

protected

obtains a new temporary directory

The obtained directory is enlisted to be removed (recursively with all its contained files) upon tearDown.

Since: 1.20

Returns: string Absolute name of the temporary directory

Definition at line 488 of file MediaWikiTestCase.php.

References getNewTempFile(), and wfMkdirParents().

Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\checkpointHelper(), FileBackendTest\setUp(), MigrateFileRepoLayoutTest\setUp(), StoreBatchTest\setUp(), MediaWikiMediaTestCase\setUp(), ApiQuerySiteinfoTest\testExtensions(), ApiUploadTest\testUpload(), ApiUploadTest\testUploadChunks(), ApiUploadTest\testUploadSameContent(), ApiUploadTest\testUploadSameFileName(), and ApiUploadTest\testUploadStash().

◆ getNewTempFile()

MediaWikiTestCase::getNewTempFile ( )

protected

Obtains a new temporary file name.

The obtained filename is enlisted to be removed upon tearDown

Since: 1.20

Returns: string Absolute name of the temporary file

Definition at line 471 of file MediaWikiTestCase.php.

References wfTempDir().

◆ getNonexistingTestPage()

MediaWikiTestCase::getNonexistingTestPage ( $title = null )

protected

Returns a WikiPage representing a non-existing page.

Since: 1.32

Parameters

Title | string | null $title

Returns: WikiPage

Exceptions

MWException If this test cases's needsDB() method doesn't return true. Test cases can use " Database" to enable database test support, or list the tables under testing in $this->tablesUsed, or override the needsDB() method.

Definition at line 255 of file MediaWikiTestCase.php.

References $title, and needsDB().

Referenced by TextContentTest\testDeletionUpdates(), and PoolWorkArticleViewTest\testDoWorkMissingPage().

◆ getSchemaOverrides()

MediaWikiTestCase::getSchemaOverrides ( IMaintainableDatabase $db )

protected

Stub.

If a test suite needs to test against a specific database schema, it should override this method and return the appropriate information from it.

Parameters

IMaintainableDatabase $db The DB connection to use for the mock schema. May be used to check the current state of the schema, to determine what overrides are needed.

Returns

array An associative array with the following fields:

'scripts': any SQL scripts to run. If empty or not present, schema overrides are skipped.

'create': A list of tables created (may or may not exist in the original schema).
'drop': A list of tables dropped (expected to be present in the original schema).
'alter': A list of tables altered (expected to be present in the original schema).

Reimplemented in MediaWikiTestCaseSchema1Test.

Definition at line 1582 of file MediaWikiTestCase.php.

Referenced by setUpSchema().

◆ getTestPrefixFor()

static MediaWikiTestCase::getTestPrefixFor ( IDatabase $db )

static

Parameters

IDatabase $db

Returns: string

Since: 1.32

Definition at line 1179 of file MediaWikiTestCase.php.

References Wikimedia\Rdbms\IDatabase\getType().

◆ getTestSysop()

static MediaWikiTestCase::getTestSysop ( )

static

Convenience method for getting an immutable admin test user.

Since: 1.28

Parameters

string[] $groups Groups the test user should be added to.

Returns: TestUser

Definition at line 203 of file MediaWikiTestCase.php.

◆ getTestUser()

static MediaWikiTestCase::getTestUser ( $groups = [] )

static

Convenience method for getting an immutable test user.

Since: 1.28

Parameters

string | string[] $groups Groups the test user should be in.

Returns: TestUser

Definition at line 179 of file MediaWikiTestCase.php.

◆ hideDeprecated()

MediaWikiTestCase::hideDeprecated ( $function )

Don't throw a warning if $function is deprecated and called later.

Since: 1.19

Parameters

string $function

Definition at line 1940 of file MediaWikiTestCase.php.

References wfDeprecated().

Referenced by MediaWiki\Auth\LegacyHookPreAuthenticationProviderTest\hook(), CommentStoreTest\makeStoreWithKey(), UserTest\testActorId(), OutputPageTest\testAddDeprecatedScriptFileNoOp(), ArticleViewTest\testArticleAfterFetchContentObjectHook(), ArticleViewTest\testArticleContentViewCustomHook(), MediaWiki\Auth\AuthManagerTest\testAutoAccountCreation(), BlockTest\testDeprecatedConstructor(), ApiEditPageTest\testEditAbortedByHook(), ApiEditPageTest\testEditAbortedByHookWithCustomOutput(), RevisionDbTestBase\testFetchRevision(), PageArchiveTestBase\testGetLastRevisionText(), LBFactoryTest\testGetLBFactoryClass(), PageArchivePreMcrTest\testGetTextFromRow(), PageArchiveTestBase\testGetTextFromRowThrowsInvalidArgumentException(), WatchActionTest\testGetUnwatchToken(), ActorMigrationTest\testInsertWithTempTableDeprecated(), CommentStoreTest\testInsertWithTempTableDeprecated(), UserTest\testIsLocallyBlockedProxy(), SearchResultSetTest\testIterate(), DeprecatedGlobalTest\testLazyLoad(), LinkerTest\testLinkBeginHook(), LinkerTest\testLinkEndHook(), RevisionDbTestBase\testLoadFromId(), CommentStoreTest\testNewKey(), DeprecatedGlobalTest\testObjectDeStub(), MediaWiki\Tests\Revision\RevisionQueryInfoTest\testRevisionPageJoinCond(), MediaWiki\Tests\Revision\RevisionQueryInfoTest\testRevisionSelectArchiveFields(), MediaWiki\Tests\Revision\RevisionQueryInfoTest\testRevisionSelectFields(), MediaWiki\Tests\Revision\RevisionQueryInfoTest\testRevisionSelectPageFields(), MediaWiki\Tests\Revision\RevisionQueryInfoTest\testRevisionSelectTextFields(), MediaWiki\Tests\Revision\RevisionQueryInfoTest\testRevisionSelectUserFields(), MediaWiki\Tests\Revision\RevisionQueryInfoTest\testRevisionUserJoinCond(), MediaWiki\Session\PHPSessionHandlerTest\testSessionHandling(), MediaWikiTestCaseTest\testStashedGlobalsAreRestoredOnTearDown(), WfArrayFilterTest\testWfArrayFilter(), and WfArrayFilterTest\testWfArrayFilterByKey().

◆ insertPage()

MediaWikiTestCase::insertPage	(		$pageName,
			$text = `'Sample page for unit test.'`,
			$namespace = `null`,
		User	$user = `null`
	)

protected

Insert a new page.

Should be called from addDBData().

Since: 1.25 ($namespace in 1.28)

Parameters

string \| Title	$pageName	Page name or title
string	$text	Page's content
int \| null	$namespace	Namespace id (name cannot already contain namespace)
User \| null	$user	If null, static::getTestSysop()->getUser() is used.

Returns: array Title object and page id

Exceptions

MWException If this test cases's needsDB() method doesn't return true. Test cases can use " Database" to enable database test support, or list the tables under testing in $this->tablesUsed, or override the needsDB() method.

Definition at line 1219 of file MediaWikiTestCase.php.

References $title, $user, and needsDB().

◆ installMockMwServices()

static MediaWikiTestCase::installMockMwServices ( Config $configOverrides = null )

static

Creates a new "mock" MediaWikiServices instance, and installs it.

This effectively resets all cached states in services, with the exception of the ConfigFactory and the DBLoadBalancerFactory service, which are inherited from the original MediaWikiServices.

Note: The new original MediaWikiServices instance can later be restored by calling restoreMwServices(). That original is determined by the first call to this method, or by setUpBeforeClass, whichever is called first. The caller is responsible for managing and, when appropriate, destroying any other MediaWikiServices instances that may get replaced when calling this method.

Parameters

Config | null $configOverrides Configuration overrides for the new MediaWikiServices instance.

Returns: MediaWikiServices the new mock service locator.

Definition at line 975 of file MediaWikiTestCase.php.

References $services, and use.

◆ isNotUnittest()

static MediaWikiTestCase::isNotUnittest ( $table )

staticprivate

Definition at line 1842 of file MediaWikiTestCase.php.

◆ isTestInDatabaseGroup()

MediaWikiTestCase::isTestInDatabaseGroup ( )

protected

Returns: bool

Since: 1.32

Definition at line 1196 of file MediaWikiTestCase.php.

Referenced by needsDB(), and run().

◆ isUsingExternalStoreDB()

static MediaWikiTestCase::isUsingExternalStoreDB ( )

staticprotected

Check whether ExternalStoreDB is being used.

Returns: bool True if it's being used

Definition at line 1531 of file MediaWikiTestCase.php.

References $wgDefaultExternalStore, array(), and as.

◆ isWikitextNS()

MediaWikiTestCase::isWikitextNS ( $ns )

protected

Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels.

Parameters

int $ns The namespace ID to check

Returns: bool

Since: 1.21

Definition at line 2160 of file MediaWikiTestCase.php.

References $wgNamespaceContentModels, and CONTENT_MODEL_WIKITEXT.

Referenced by PrefixSearchTest\addDBDataOnce(), SearchEnginePrefixTest\addDBDataOnce(), SearchEngineTest\addDBDataOnce(), SearchEngineTest\fetchIds(), PrefixSearchTest\setUp(), SearchEnginePrefixTest\setUp(), and TitlePermissionTest\testQuickPermissions().

◆ listOriginalTables()

MediaWikiTestCase::listOriginalTables	(	IMaintainableDatabase	$db,
			$prefix = `'prefixed'`
	)

private

Lists all tables in the live database schema.

Parameters

IMaintainableDatabase	$db
string	$prefix	Either 'prefixed' or 'unprefixed'

Returns: array

Definition at line 1709 of file MediaWikiTestCase.php.

References Wikimedia\Rdbms\IMaintainableDatabase\listTables(), and use.

Referenced by recloneMockTables(), setUpSchema(), and undoSchemaOverrides().

◆ listTables()

static MediaWikiTestCase::listTables ( IMaintainableDatabase $db )

static

Since: 1.18

Parameters

IMaintainableDatabase $db

Returns: array

Definition at line 1853 of file MediaWikiTestCase.php.

References $tables, Wikimedia\Rdbms\IDatabase\getType(), Wikimedia\Rdbms\IMaintainableDatabase\listTables(), Wikimedia\Rdbms\IMaintainableDatabase\listViews(), and Wikimedia\Rdbms\IDatabase\tablePrefix().

◆ makeTestConfig()

static MediaWikiTestCase::makeTestConfig	(	Config	$baseConfig = `null`,
		Config	$customOverrides = `null`
	)

staticprivate

Create a config suitable for testing, based on a base config, default overrides, and custom overrides.

Parameters

Config \| null	$baseConfig
Config \| null	$customOverrides

Returns: Config

Definition at line 287 of file MediaWikiTestCase.php.

References CACHE_ACCEL, CACHE_DB, CACHE_MEMCACHED, CACHE_NONE, and false.

◆ makeTestConfigFactoryInstantiator()

static MediaWikiTestCase::makeTestConfigFactoryInstantiator	(	ConfigFactory	$oldFactory,
		array	$configurations
	)

staticprivate

Parameters

ConfigFactory	$oldFactory
Config[]	$configurations

Returns: Closure

Definition at line 331 of file MediaWikiTestCase.php.

References $name, $services, as, ConfigFactory\getConfigNames(), ConfigFactory\makeConfig(), and use.

◆ markTestSkippedIfDbType()

MediaWikiTestCase::markTestSkippedIfDbType ( $type )

protected

Skip the test if using the specified database type.

Parameters

string $type Database type

Since: 1.32

Definition at line 2269 of file MediaWikiTestCase.php.

References $type.

Referenced by MediaWikiTestCaseSchema1Test\setUp(), MediaWikiTestCaseSchema2Test\setUp(), UserTest\testFindUsersByGroup(), MediaWiki\Tests\Storage\NameTableStoreTest\testGetAndAcquireIdInsertCallback(), ApiBaseTest\testGetTitleOrPageIdInvalidPageId(), LBFactoryTest\testInvalidSelectDB(), MediaWiki\Tests\Maintenance\DeleteAutoPatrolLogsTest\testRun(), PrefixSearchTest\testSearch(), PrefixSearchTest\testSearchWithOffset(), MediaWiki\Tests\Storage\SqlBlobStoreTest\testSimpleStoreGetBlobSimpleRoundtripWindowsLegacyEncodingGzip(), ApiQueryUserContribsTest\testSorting(), and ChangeTagsTest\testUpdateTagsMigrationWriteBoth().

◆ markTestSkippedIfNoDiff3()

MediaWikiTestCase::markTestSkippedIfNoDiff3 ( )

protected

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

Since: 1.21

Definition at line 2232 of file MediaWikiTestCase.php.

References $wgDiff3.

Referenced by EditPageTest\testAutoMerge(), GlobalTest\testMerge(), WikitextContentHandlerTest\testMerge3(), and GlobalTest\testMerge_worksWithLessParameters().

◆ mergeMwGlobalArrayValue()

MediaWikiTestCase::mergeMwGlobalArrayValue	(	$name,
		$values
	)

protected

Merges the given values into a MW global array variable.

Useful for setting some entries in a configuration array, instead of setting the entire array.

Parameters

string	$name	The name of the global, as in wgFooBar
array	$values	The array containing the entries to set in that global

Exceptions

MWException If the designated global is not an array.

Note: To allow changes to global variables to take effect on global service instances, call overrideMwServices().

Since: 1.21

Definition at line 901 of file MediaWikiTestCase.php.

References $GLOBALS, $name, as, and setMwGlobals().

Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\addDBData(), GenderCacheTest\addDBDataOnce(), WikiPageDbTestBase\defineMockContentModelForUpdateTesting(), MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest\defineMockContentModelForUpdateTesting(), MediaWiki\Auth\LegacyHookPreAuthenticationProviderTest\hook(), DifferenceEngineTest\provideGenerateContentDiffBody(), TextSlotDiffRendererTest\provideGetDiff(), ApiUserrightsTest\setPermissions(), setTemporaryHook(), ApiEditPageTest\setUp(), ApiOptionsTest\setUp(), ApiRevisionDeleteTest\setUp(), AutoLoaderTest\setUp(), EditPageTest\setUp(), NewUsersLogFormatterTest\setUp(), PageLangLogFormatterTest\setUp(), PagePropsTest\setUp(), RevisionDbTestBase\setUp(), TitleMethodsTest\setUp(), BotPasswordTest\setUp(), SearchEngineTest\testAugmentorSearch(), MediaWiki\Auth\AuthManagerTest\testAutoAccountCreation(), UserTest\testAutoblockCookieInauthentic(), UserTest\testAutoblockCookieInfiniteExpiry(), UserTest\testAutoblockCookieNoSecretKey(), UserTest\testAutoblockCookies(), UserTest\testAutoblockCookiesDisabled(), ApiBlockTest\testBlockWithHide(), TitleTest\testCreateFragmentTitle(), MediaWiki\Session\SessionBackendTest\testDelaySave(), ApiDisabledTest\testDisabled(), ApiQueryDisabledTest\testDisabled(), PasswordResetTest\testExecute_email(), SpecialMyLanguageTest\testFindTitle(), SpecialPageFactoryTest\testGetAliasListRecursion(), UserTest\testGetCanonicalName(), SpecialPageFactoryTest\testGetNames(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testGetNewPasswordExpiry(), SpecialPageFactoryTest\testGetPage(), ContentHandlerTest\testGetSlotDiffRenderer_bc(), ContentHandlerTest\testGetSlotDiffRenderer_default(), ContentHandlerTest\testGetSlotDiffRenderer_hook(), ContentHandlerTest\testGetSlotDiffRenderer_nobc(), SpecialPageFactoryTest\testHookNotCalledTwice(), JobTest\testJobFactory(), ApiMainTest\testLacksSameOriginSecurity(), MediaWiki\Session\SessionManagerTest\testLoadSessionInfoFromStore(), ApiMoveTest\testMoveSubpages(), ApiQuerySiteinfoTest\testNamespaceAliases(), ApiMainTest\testNonWhitelistedCorsWithCookies(), MediaWiki\Session\CookieSessionProviderTest\testPersistSession(), MediaWiki\Session\CookieSessionProviderTest\testPersistSessionWithHook(), ApiMoveTest\testPingLimiter(), ApiStashEditTest\testPingLimiter(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testProviderChangeAuthenticationData(), MediaWiki\Auth\AbstractPrimaryAuthenticationProviderTest\testProviderNormalizeUsername(), LocalisationCacheTest\testRecacheFallbacksWithHooks(), MediaWiki\Session\SessionBackendTest\testRenew(), MediaWiki\Session\SessionBackendTest\testSave(), ApiParseTest\testSerializationError(), MediaWiki\Session\PHPSessionHandlerTest\testSessionHandling(), MediaWiki\Auth\ThrottlePreAuthenticationProviderTest\testTestForAccountCreation(), ApiLoginTest\testUnsupportedAuthResponseType(), UserTest\testUserGetRightsHooks(), and MediaWiki\Auth\LegacyHookPreAuthenticationProviderTest\unhook().

◆ mungeSchemaUpdateQuery()

MediaWikiTestCase::mungeSchemaUpdateQuery ( $cmd )

private

Definition at line 1681 of file MediaWikiTestCase.php.

Referenced by setUpSchema().

◆ needsDB()

MediaWikiTestCase::needsDB ( )

Returns: bool

Since: 1.18

Definition at line 1187 of file MediaWikiTestCase.php.

References isTestInDatabaseGroup().

Referenced by assertSelect(), editPage(), getExistingTestPage(), getNonexistingTestPage(), insertPage(), run(), setUp(), and tearDown().

◆ objectAssociativeSort()

MediaWikiTestCase::objectAssociativeSort ( array & $array )

protected

Does an associative sort that works for objects.

Since: 1.20

Parameters

array &$array

Definition at line 2081 of file MediaWikiTestCase.php.

References serialize().

Referenced by assertArrayEquals(), and MediaWiki\Tests\Revision\RevisionQueryInfoTest\assertArrayEqualsIgnoringIntKeyOrder().

◆ oncePerClass()

MediaWikiTestCase::oncePerClass ( )

private

Returns: bool

Definition at line 440 of file MediaWikiTestCase.php.

Referenced by run().

◆ overrideMwServices()

MediaWikiTestCase::overrideMwServices	(	Config	$configOverrides = `null`,
		array	$services = `[]`
	)

protected

Stashes the global instance of MediaWikiServices, and installs a new one, allowing test cases to override settings and services.

The previous instance of MediaWikiServices will be restored on tearDown.

Since: 1.27

Parameters

Config \| null	$configOverrides	Configuration overrides for the new MediaWikiServices instance.
callable[]	$services	An associative array of services to re-define. Keys are service names, values are callables.

Returns: MediaWikiServices

Exceptions

MWException

Definition at line 934 of file MediaWikiTestCase.php.

References $name, $services, and as.

◆ prepareServices()

static MediaWikiTestCase::prepareServices ( Config $bootstrapConfig )

static

Deprecated:: since 1.32

Definition at line 275 of file MediaWikiTestCase.php.

◆ recloneMockTables()

MediaWikiTestCase::recloneMockTables	(	IMaintainableDatabase	$db,
		array	$tables
	)

private

Re-clones the given mock tables to restore them based on the live database schema.

The tables listed in $tables are expected to currently not exist, so dropMockTables() should be called first.

Parameters

IMaintainableDatabase	$db
array	$tables

Definition at line 1736 of file MediaWikiTestCase.php.

References $tables, ensureMockDatabaseConnection(), listOriginalTables(), and Wikimedia\Rdbms\IDatabase\tablePrefix().

Referenced by undoSchemaOverrides().

◆ resetDB()

MediaWikiTestCase::resetDB	(	$db,
		$tablesUsed
	)

private

Empty all tables so they can be repopulated for tests.

Parameters

Database	$db,\|null	Database to reset
array	$tablesUsed	Tables to reset

Definition at line 1758 of file MediaWikiTestCase.php.

References addCoreDBData(), as, Wikimedia\Rdbms\IDatabase\getType(), overrideMwServices(), and truncateTable().

Referenced by run().

◆ resetNamespaces()

MediaWikiTestCase::resetNamespaces ( )

private

Must be called whenever namespaces are changed, e.g., $wgExtraNamespaces is altered.

Otherwise old namespace data will lurk and cause bugs.

Definition at line 752 of file MediaWikiTestCase.php.

Referenced by doSetMwGlobals(), and tearDown().

◆ resetNonServiceCaches()

static MediaWikiTestCase::resetNonServiceCaches ( )

static

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

It's not necessary to reset services here.

Definition at line 360 of file MediaWikiTestCase.php.

References $type, $wgJobClasses, $wgRequest, as, and FileBackendGroup\destroySingleton().

◆ restoreLoggers()

MediaWikiTestCase::restoreLoggers ( )

private

Restores loggers replaced by setLogger().

Since: 1.27

Definition at line 1143 of file MediaWikiTestCase.php.

References as.

Referenced by tearDown().

◆ restoreMwServices()

static MediaWikiTestCase::restoreMwServices ( )

static

Restores the original, non-mock MediaWikiServices instance.

The previously active MediaWikiServices instance is destroyed, if it is different from the original that is to be restored.

Note: this if for internal use by test framework code. It should never be called from inside a test case, a data provider, or a setUp or tearDown method.

Returns: bool true if the original service locator was restored, false if there was nothing too do.

Definition at line 1033 of file MediaWikiTestCase.php.

◆ revisionDelete()

MediaWikiTestCase::revisionDelete	(		$rev,
		array	$value = `[ Revision::DELETED_TEXT => 1 ]`,
			$comment = `''`
	)

protected

Revision-deletes a revision.

Parameters

Revision \| int	$rev	Revision to delete
array	$value	Keys are Revision::DELETED_* flags. Values are 1 to set the bit, 0 to clear, -1 to leave alone. (All other values also clear the bit.)
string	$comment	Deletion comment

Definition at line 2353 of file MediaWikiTestCase.php.

References $rev, $value, RevisionDeleter\createList(), and Revision\newFromId().

Referenced by ApiParseTest\addDBDataOnce(), ApiStashEditTest\testDeletedRevision(), and ApiStashEditTest\testDeletedRevisionSection().

◆ run()

MediaWikiTestCase::run ( PHPUnit_Framework_TestResult $result = null )

Definition at line 383 of file MediaWikiTestCase.php.

References addCoreDBData(), addDBData(), addDBDataOnce(), checkDbIsSupported(), DB_MASTER, getCliArg(), isTestInDatabaseGroup(), needsDB(), oncePerClass(), overrideMwServices(), resetDB(), setupAllTestDBs(), setUpSchema(), and wfGetDB().

◆ setCliArg()

MediaWikiTestCase::setCliArg	(	$offset,
		$value
	)

Since: 1.18

Parameters

string	$offset
mixed	$value

Definition at line 1929 of file MediaWikiTestCase.php.

References $value.

◆ setContentLang()

MediaWikiTestCase::setContentLang ( $lang )

Since: 1.27

Parameters

string | Language $lang

Definition at line 1063 of file MediaWikiTestCase.php.

References $lang, $services, doSetMwGlobals(), setMwGlobals(), and setService().

Referenced by MediaWiki\Tests\Maintenance\BackupDumperPageTest\addDBData(), MessageCacheTest\configureLanguages(), ApiOptionsTest\setUp(), CategoryMembershipChangeTest\setUp(), EditPageTest\setUp(), ExtraParserTest\setUp(), HtmlTest\setUp(), CategoryMembershipChangeJobTest\setUp(), MagicVariableTest\setUp(), StripStateTest\setUp(), SampleTest\setUp(), SpecialPageTest\setUp(), MediaWikiTitleCodecTest\setUp(), NaiveImportTitleFactoryTest\setUp(), NamespaceImportTitleFactoryTest\setUp(), SubpageImportTitleFactoryTest\setUp(), TitleTest\setUp(), LanguageConverterTest\setUp(), MediaWikiLangTestCase\setUp(), DifferenceEngineTest\testAddLocalisedTitleTooltips(), SpecialPageFactoryTest\testConflictResolution(), InterwikiTest\testConstructor(), SpecialMyLanguageTest\testFindTitle(), ContentHandlerTest\testGetAutosummary(), SpecialPageFactoryTest\testGetLocalNameFor(), TitleTest\testGetPageViewLanguage(), LanguageConverterTest\testGetPreferredVariantDefaultLanguageVsUrlVariant(), LanguageConverterTest\testGetPreferredVariantHeaderUserVsUrl(), LanguageConverterTest\testGetPreferredVariantUserOptionForForeignLanguage(), LanguageConverterTest\testGetPreferredVariantUserOptionForForeignLanguageBCP47(), LanguageConverterTest\testGetPreferredVariantUserOptionForForeignLanguageDeprecated(), SpecialPageFactoryTest\testGetTitleForAlias(), ApiQuerySiteinfoTest\testLinkPrefixCharset(), ParserOptionsTest\testNewCanonical(), SpecialPageFactoryTest\testResolveAlias(), MediaWiki\Auth\AuthManagerTest\testSetDefaultUserOptions(), MediaWiki\Tests\Storage\PageUpdaterTest\testSetUseAutomaticEditSummaries(), SpecialPageDataTest\testSpecialPageWithoutParameters(), ArticleTablesTest\testTemplatelinksUsesContentLanguage(), and ApiQuerySiteinfoTest\testVariants().

◆ setGroupPermissions()

MediaWikiTestCase::setGroupPermissions	(	$newPerms,
		$newKey = `null`,
		$newValue = `null`
	)

Alters $wgGroupPermissions for the duration of the test.

Can be called with an array, like [ '*' => [ 'read' => false ], 'user' => [ 'read' => false ] ] or three values to set a single permission, like $this->setGroupPermissions( '*', 'read', false );

Since: 1.31

Parameters

array \| string	$newPerms	Either an array of permissions to change, in which case the next two parameters are ignored; or a single string identifying a group, to use with the next two parameters.
string \| null	$newKey
mixed \| null	$newValue

Definition at line 1092 of file MediaWikiTestCase.php.

References $value, $wgGroupPermissions, as, and setMwGlobals().

Referenced by ApiUserrightsTest\setPermissions(), LocalIdLookupTest\setUp(), MediaWiki\Auth\AuthManagerTest\testAutoAccountCreation(), ApiLoginTest\testBotPasswordThrottled(), MediaWiki\Auth\AuthManagerTest\testCheckAccountCreatePermissions(), ApiMainTest\testCheckExecutePermissionsReadProhibited(), ApiMainTest\testCheckExecutePermissionWriteApiProhibited(), ApiMainTest\testSetCacheModePrivateWiki(), ApiParseTest\testSuppressed(), ApiMoveTest\testSuppressRedirectNoPermission(), ApiMoveTest\testTagsNoPermission(), ApiUnblockTest\testUnblockNoPermission(), ApiUnblockTest\testUnblockWithProhibitedTag(), ApiQuerySiteinfoTest\testUserGroups(), and ApiUserrightsTest\testWithoutTagPermission().

◆ setIniSetting()

MediaWikiTestCase::setIniSetting	(	$name,
		$value
	)

protected

Set an ini setting for the duration of the test.

Parameters

string	$name	Name of the setting
string	$value	Value to set

Since: 1.32

Definition at line 742 of file MediaWikiTestCase.php.

References $name, and $value.

Referenced by LanguageConverterTest\testAutoConvertT124404().

◆ setLogger()

MediaWikiTestCase::setLogger	(		$channel,
		LoggerInterface	$logger
	)

protected

Sets the logger for a specified channel, for the duration of the test.

Since: 1.27

Parameters

string	$channel
LoggerInterface	$logger

Definition at line 1115 of file MediaWikiTestCase.php.

Referenced by GlobalTest\testDebugFunctionTest(), ResourceLoaderStartUpModuleTest\testGetModuleRegistrations(), MediaWikiTestCaseTest\testLoggersAreRestoredOnTearDown_replacingExistingLogger(), MediaWikiTestCaseTest\testLoggersAreRestoredOnTearDown_replacingNonExistingLogger(), MediaWikiTestCaseTest\testLoggersAreRestoredOnTearDown_replacingSameLoggerTwice(), ResourceLoaderTest\testMakeModuleResponseError(), ResourceLoaderTest\testMakeModuleResponseErrorCSS(), ResourceLoaderTest\testMakeModuleResponseStartupError(), ApiMainTest\testNonWhitelistedCorsWithCookies(), MediaWikiTest\testPostSendJobDoesNotSetCookie(), and ResourceLoaderTest\testRespondInternalFailures().

◆ setMwGlobals()

MediaWikiTestCase::setMwGlobals	(	$pairs,
		$value = `null`
	)

protected

Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.

The key is added to the array of globals that will be reset afterwards in the tearDown().

Example: protected function setUp() {

$this->setMwGlobals( 'wgRestrictStuff', true );

}

function testFoo() {}

function testBar() {}

$this->assertTrue( self::getX()->doStuff() );

$this->setMwGlobals( 'wgRestrictStuff', false );

$this->assertTrue( self::getX()->doStuff() );

}

function testQuux() {}

MediaWikiTestCase\setUp
setUp()
Definition MediaWikiTestCase.php:501

MediaWikiTestCase\setMwGlobals
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition MediaWikiTestCase.php:706

Parameters

array \| string	$pairs	Key to the global variable, or an array of key/value pairs.
mixed \| null	$value	Value to set the global to (ignored if an array is given as first argument).

Note: To allow changes to global variables to take effect on global service instances, call overrideMwServices().

Since: 1.21

Definition at line 706 of file MediaWikiTestCase.php.

References $value, and doSetMwGlobals().

◆ setService()

MediaWikiTestCase::setService	(	$name,
		$object
	)

protected

Sets a service, maintaining a stashed version of the previous service to be restored in tearDown.

Since: 1.27

Parameters

string	$name
object	$object

Definition at line 646 of file MediaWikiTestCase.php.

References $name, doSetMwGlobals(), and use.

Referenced by ApiMainTest\doTestCheckMaxLag(), ApiOpenSearchTest\replaceSearchEngine(), ApiOpenSearchTest\replaceSearchEngineConfig(), TitleTest\secureAndSplitGlobals(), setContentLang(), ApiParseTest\setupSkin(), RevisionTest\testCompressRevisionTextUtf8Gzip(), ApiQuerySiteinfoTest\testDbReplLagInfo(), RevisionTest\testDecompressRevisionText(), ExternalStoreTest\testExternalFetchFromURL_noExternalStores(), ExternalStoreTest\testExternalFetchFromURL_someExternalStore(), WebRequestTest\testGetIP(), WebRequestTest\testGetIpLackOfRemoteAddrThrowAnException(), TitleMethodsTest\testGetLinkURL(), MediaWiki\Tests\Revision\RenderedRevisionTest\testGetRevisionParserOutput_incompleteWithId(), RevisionTest\testGetRevisionText_external_noOldId(), RevisionTest\testGetRevisionText_external_oldId(), RevisionTest\testGetRevisionWithGzipAndLegacyEncoding(), RevisionTest\testGetRevisionWithLegacyEncoding(), MediaWiki\Tests\Revision\RevisionStoreTest\testGetTitle_correctFallbackAndthrowsExceptionAfterFallbacks(), MediaWiki\Tests\Revision\RevisionStoreTest\testGetTitle_successFromPageId(), MediaWiki\Tests\Revision\RevisionStoreTest\testGetTitle_successFromPageIdOnFallback(), MediaWiki\Tests\Revision\RevisionStoreTest\testGetTitle_successFromRevId(), MediaWiki\Tests\Revision\RevisionStoreTest\testGetTitle_successFromRevIdOnFallback(), ExternalUserNamesTest\testGetUserLinkTitle(), WfThumbIsStandardTest\testIsStandard(), SiteStatsTest\testJobsCountGetCached(), ResourceLoaderTest\testMeasureResponseTime(), MultiHttpClientTest\testMultiHttpClientHeaders(), MultiHttpClientTest\testMultiHttpClientMultipleFailure(), MultiHttpClientTest\testMultiHttpClientMultipleSuccess(), MultiHttpClientTest\testMultiHttpClientSingleFailure(), MultiHttpClientTest\testMultiHttpClientSingleSuccess(), RevisionDbTestBase\testNewFromArchiveRow(), RevisionDbTestBase\testNewKnownCurrent(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testNewMutableRevisionFromArray_legacyEncoding(), ParserMethodsTest\testRevisionAccess(), and MediaWikiTestCaseTest\testSetService().

◆ setTemporaryHook()

MediaWikiTestCase::setTemporaryHook	(	$hookName,
		$handler
	)

protected

Create a temporary hook handler which will be reset by tearDown.

This replaces other handlers for the same hook.

Parameters

string	$hookName	Hook name
mixed	$handler	Value suitable for a hook handler

Since: 1.28

Definition at line 2291 of file MediaWikiTestCase.php.

References $handler, and mergeMwGlobalArrayValue().

Referenced by MediaWiki\Auth\AuthManagerTest\hook(), ParserOptionsTest\setUp(), SpecialWatchlistTest\setUp(), ParserOptionsTest\testAllCacheVaryingOptions(), ApiEditPageTest\testAppendInMediaWikiNamespaceWithSerializationError(), ApiEditPageTest\testAppendWithNonTextContentHandler(), ArticleViewTest\testArticleAfterFetchContentObjectHook(), ArticleViewTest\testArticleContentViewCustomHook(), ArticleViewTest\testArticleRevisionViewCustomHook(), ArticleViewTest\testArticleViewHeaderHook(), ApiLoginTest\testBotPasswordLocked(), ApiMainTest\testCheckExecutePermissionHookAbort(), ContentHandlerTest\testDataIndexFields(), ApiDeleteTest\testDeleteAbortedByHook(), ApiEditPageTest\testEditAbortedByEditPageHookWithNoResult(), ApiEditPageTest\testEditAbortedByEditPageHookWithResult(), ApiEditPageTest\testEditAbortedByHook(), ApiEditPageTest\testEditAbortedByHookWithCustomOutput(), ApiParseTest\testEffectiveLangLinks(), ContentHandlerTest\testGetContentModelsHook(), DefaultPreferencesFactoryTest\testGetForm(), ApiQuerySiteinfoTest\testGetHooks(), SpecialShortpagesTest\testGetQueryInfoRespectsContentNS(), ContentHandlerTest\testGetSlotDiffRenderer_hook(), ShellTest\testMakeScriptCommand(), ApiParseTest\testModules(), ApiLoginTest\testNoSameOriginSecurity(), ParserOptionsTest\testOptionsHash(), SearchEngineTest\testParseNamespacePrefix(), MediaWikiTest\testPostSendJobDoesNotSetCookie(), DefaultPreferencesFactoryTest\testPreferencesFormPreSaveHookHasCorrectData(), SearchEngineTest\testSearchIndexFields(), ArticleViewTest\testShowMissingArticleHook(), ApiQuerySiteinfoTest\testStatistics(), ParserOptionsTest\testUsedLazyOptionsInHash(), AbstractChangesListSpecialPageTestCase\testValidateOptions(), and ArticleViewTest\testViewNonText().

◆ setUp()

MediaWikiTestCase::setUp ( )

protected

Reimplemented in ActionTest, WatchActionTest, ApiBlockTest, ApiComparePagesTest, ApiDeleteTest, ApiEditPageTest, ApiLoginTest, ApiLogoutTest, ApiOptionsTest, ApiQueryPrefixSearchTest, ApiQueryRecentChangesIntegrationTest, ApiQuerySearchTest, ApiQueryWatchlistIntegrationTest, ApiQueryWatchlistRawIntegrationTest, ApiRevisionDeleteTest, ApiSetNotificationTimestampIntegrationTest, ApiStashEditTest, ApiTestCase, ApiUnblockTest, ApiUploadTestCase, ApiUserrightsTest, ApiFormatBaseTest, ApiQueryTest, MediaWiki\Auth\AuthManagerTest, MediaWiki\Auth\UserDataAuthenticationRequestTest, AutoLoaderTest, LocalisationCacheTest, MessageCacheTest, CategoryMembershipChangeTest, ChangesListFilterTest, OldChangesListTest, RCCacheEntryFactoryTest, RecentChangeTest, ChangeTagsTest, CollationTest, CustomUppercaseCollationTest, ContentHandlerTest, CssContentTest, FileContentHandlerTest, TextContentTest, WikitextContentHandlerTest, ContentSecurityPolicyTest, DatabaseSqliteTest, DeprecationHelperTest, MediaWiki\Logger\Monolog\AvroFormatterTest, MediaWiki\Logger\Monolog\KafkaHandlerTest, MediaWiki\Logger\Monolog\LineFormatterTest, MWDebugTest, LinksUpdateTest, SearchUpdateTest, DeprecatedGlobalTest, DifferenceEngineTest, DiffHistoryBlobTest, EditPageTest, ExportTest, ExtraParserTest, FauxResponseTest, FileBackendTest, SwiftFileBackendTest, LocalFileTest, MigrateFileRepoLayoutTest, StoreBatchTest, FormOptionsInitializationTest, FormOptionsTest, GitInfoTest, GlobalTest, WfParseUrlTest, WfThumbIsStandardTest, HooksTest, HtmlTest, ImportLinkCacheIntegrationTest, InterwikiLookupAdapterTest, JobQueueTest, CategoryMembershipChangeJobTest, ClearUserWatchlistJobTest, RefreshLinksJobTest, ComposerInstalledTest, ComposerJsonTest, ComposerLockTest, CSSMinTest, BagOStuffTest, MultiWriteBagOStuffTest, ReplicatedBagOStuffTest, PageDataRequestHandlerTest, LinkRendererFactoryTest, LinkRendererTest, LinkFilterTest, DatabaseLogEntryTest, LogFormatterTest, NewUsersLogFormatterTest, PageLangLogFormatterTest, BitmapMetadataHandlerTest, BitmapScalingTest, DjVuTest, ExifBitmapTest, ExifRotationTest, ExifTest, FormatMetadataTest, GIFMetadataExtractorTest, GIFHandlerTest, JpegMetadataExtractorTest, JpegPixelFormatTest, JpegTest, MediaWikiMediaTestCase, PNGMetadataExtractorTest, PNGHandlerTest, SVGTest, TiffTest, WebPHandlerTest, XCFHandlerTest, MediaWikiTest, MessageTest, MultiHttpClientTest, MWNamespaceTest, MWTimestampTest, MemcachedBagOStuffTest, ObjectCacheTest, RESTBagOStuffTest, OutputPageTest, ArticleTest, ArticleViewTest, ImagePage404Test, ImagePageTest, PageArchiveTestBase, WikiPageDbTestBase, WikiPageMcrDbTest, PagePropsTest, MagicVariableTest, ParserOptionsTest, ParserPreloadTest, PreprocessorTest, StripStateTest, TidyTest, PasswordTestCase, PathRouterTest, DefaultPreferencesFactoryTest, PreferencesTest, PrefixSearchTest, RCFeedIntegrationTest, ExtensionProcessorTest, ExtensionRegistryTest, ResourceLoaderFileModuleTest, ResourceLoaderImageTest, ResourceLoaderTest, MediaWiki\Tests\Revision\RenderedRevisionTest, MediaWiki\Tests\Revision\RevisionStoreDbTestBase, RevisionDbTestBase, RevisionMcrDbTest, RevisionTest, SampleTest, SearchEnginePrefixTest, SearchEngineTest, MediaWiki\Session\BotPasswordSessionProviderTest, SiteConfigurationTest, AbstractChangesListSpecialPageTestCase, SpecialPageTest, ContribsPagerTest, SpecialMIMESearchTest, SpecialPageTestBase, SpecialWatchlistTest, MediaWiki\Tests\Storage\NameTableStoreTest, MediaWiki\Tests\Storage\PageUpdaterTest, TemplateParserTest, TimeAdjustTest, MediaWikiTitleCodecTest, NaiveImportTitleFactoryTest, NamespaceImportTitleFactoryTest, SubpageImportTitleFactoryTest, TitleMethodsTest, TitlePermissionTest, TitleTest, UploadBaseTest, UploadFromUrlTest, UploadStashTest, BotPasswordTest, LocalIdLookupTest, UserGroupMembershipTest, UserTest, MWCryptHKDFTest, MWGrantsTest, WatchedItemStoreIntegrationTest, WebRequestTest, WikiMapTest, XmlSelectTest, XmlTest, LanguageClassesTestCase, LanguageConverterTest, MediaWiki\Tests\Maintenance\BackupDumperPageTest, MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest, CategoryChangesRdfTest, MediaWiki\Tests\Maintenance\DeleteAutoPatrolLogsTest, MediaWiki\Tests\Maintenance\DumpTestCase, MediaWiki\Tests\Maintenance\FetchTextTest, MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase, MediaWiki\Tests\Maintenance\PopulateChangeTagDefTest, MediaWikiLangTestCase, ResourceLoaderTestCase, SideBarTest, DatabaseIntegrationTest, MediaWikiTestCaseSchema1Test, and MediaWikiTestCaseSchema2Test.

Definition at line 501 of file MediaWikiTestCase.php.

References as, needsDB(), Maintenance\setLBFactoryTriggers(), and wfRecursiveRemoveDir().

◆ setupAllTestDBs()

MediaWikiTestCase::setupAllTestDBs ( )

Set up all test DBs.

Definition at line 1420 of file MediaWikiTestCase.php.

References $wgDBprefix, CloneDatabase\changePrefix(), and dbPrefix().

Referenced by run().

◆ setUpBeforeClass()

static MediaWikiTestCase::setUpBeforeClass ( )

static

Reimplemented in ApiFormatXmlTest, MWDebugTest, GitInfoTest, LogFormatterTest, and MediaWikiTestCaseTest.

Definition at line 162 of file MediaWikiTestCase.php.

◆ setupDatabaseWithTestPrefix()

static MediaWikiTestCase::setupDatabaseWithTestPrefix	(	IMaintainableDatabase	$db,
			$prefix = `null`
	)

staticprotected

Setups a database with cloned tables using the given prefix.

If reuseDB is true and certain conditions apply, it will just change the prefix. Otherwise, it will clone the tables and change the prefix.

Parameters

IMaintainableDatabase	$db	Database to use
string \| null	$prefix	Prefix to use for test tables. If not given, the prefix is determined automatically for $db.

Returns: bool True if tables were cloned, false if only the prefix was changed

Definition at line 1382 of file MediaWikiTestCase.php.

References Wikimedia\Rdbms\IDatabase\getType(), and Wikimedia\Rdbms\IDatabase\tablePrefix().

◆ setupExternalStoreTestDBs()

static MediaWikiTestCase::setupExternalStoreTestDBs ( $testPrefix = null )

staticprotected

Clones the External Store database(s) for testing.

Parameters

string | null $testPrefix Prefix for test tables. Will be determined automatically if not given.

Definition at line 1494 of file MediaWikiTestCase.php.

References as.

◆ setUpSchema()

MediaWikiTestCase::setUpSchema ( IMaintainableDatabase $db )

private

Applies the schema overrides returned by getSchemaOverrides(), after undoing any previously applied schema overrides.

Called once per test class, just before addDataOnce().

Definition at line 1621 of file MediaWikiTestCase.php.

References as, dropMockTables(), ensureMockDatabaseConnection(), getSchemaOverrides(), listOriginalTables(), mungeSchemaUpdateQuery(), Wikimedia\Rdbms\IMaintainableDatabase\sourceFile(), and undoSchemaOverrides().

Referenced by run().

◆ setupTestDB()

static MediaWikiTestCase::setupTestDB	(	Database	$db,
			$prefix
	)

static

Creates an empty skeleton of the wiki database by cloning its structure to equivalent tables using the given $prefix.

Then sets MediaWiki to use the new set of tables (aka schema) instead of the original set.

This is used to generate a dummy table set, typically consisting of temporary tables, that will be used by tests instead of the original wiki database tables.

Since: 1.21

Note: the original table prefix is stored in self::$oldTablePrefix. This is used by teardownTestDB() to return the wiki to using the original table set.; this method only works when first called. Subsequent calls have no effect, even if using different parameters.

Parameters

Database	$db	The database connection
string	$prefix	The prefix to use for the new table set (aka schema).

Exceptions

MWException If the database table prefix is already $prefix

Definition at line 1460 of file MediaWikiTestCase.php.

References Wikimedia\Rdbms\IDatabase\getType(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tablePrefix().

◆ setUserLang()

MediaWikiTestCase::setUserLang ( $lang )

Since: 1.27

Parameters

string | Language $lang

Definition at line 1054 of file MediaWikiTestCase.php.

References $lang, and setMwGlobals().

Referenced by MessageCacheTest\configureLanguages(), OldChangesListTest\setUp(), ExtraParserTest\setUp(), HtmlTest\setUp(), MessageTest\setUp(), ArticleViewTest\setUp(), MediaWikiTitleCodecTest\setUp(), TitleTest\setUp(), MediaWikiLangTestCase\setUp(), TitleTest\testGetPageViewLanguage(), MessageTest\testInContentLanguage(), MessageTest\testInContentLanguageOverride(), and ArticleTablesTest\testTemplatelinksUsesContentLanguage().

◆ stashMwGlobals()

MediaWikiTestCase::stashMwGlobals ( $globalKeys )

protected

Stashes the global, will be restored in tearDown()

Individual test functions may override globals through the setMwGlobals() function or directly. When directly overriding globals their keys should first be passed to this method in setUp to avoid breaking global state for other tests

That way all other tests are executed with the same settings (instead of using the unreliable local settings for most tests and fix it only for some tests).

Parameters

array | string $globalKeys Key to the global variable, or an array of keys.

Note: To allow changes to global variables to take effect on global service instances, call overrideMwServices().

Since: 1.23

Deprecated:: since 1.32, use setMwGlobals() and don't alter globals directly

Definition at line 813 of file MediaWikiTestCase.php.

References doStashMwGlobals(), and wfDeprecated().

Referenced by MediaWikiTestCaseTest\testStashedGlobalsAreRestoredOnTearDown().

◆ stripStringKeys()

static MediaWikiTestCase::stripStringKeys ( & $r )

staticprotected

Utility function for eliminating all string keys from an array.

Useful to turn a database result row as returned by fetchRow() into a pure indexed array.

Since: 1.20

Parameters

mixed &$r The array to remove string keys from.

Definition at line 2099 of file MediaWikiTestCase.php.

References as.

◆ tearDown()

MediaWikiTestCase::tearDown ( )

protected

Reimplemented in WatchActionTest, ApiTestCase, AutoLoaderTest, ContentHandlerTest, TextContentTest, DeprecatedGlobalTest, MigrateFileRepoLayoutTest, StoreBatchTest, HtmlTest, JobQueueTest, PageDataRequestHandlerTest, DatabaseLogEntryTest, WebPHandlerTest, MediaWikiTest, OutputPageTest, ArticleTest, WikiPageDbTestBase, ParserOptionsTest, ParserOutputTest, ParserPreloadTest, PrefixSearchTest, SampleTest, SearchEnginePrefixTest, SearchEngineTest, AbstractChangesListSpecialPageTestCase, SpecialPageTestBase, MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest, TitleMethodsTest, WebRequestTest, XmlSelectTest, XmlTest, LanguageClassesTestCase, LanguageConverterTest, MediaWiki\Tests\Maintenance\BaseDumpTest, MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase, and DatabaseIntegrationTest.

Definition at line 544 of file MediaWikiTestCase.php.

References $GLOBALS, $name, $value, $wgRequest, $wgSQLMode, as, needsDB(), resetNamespaces(), restoreLoggers(), and wfRecursiveRemoveDir().

Referenced by MediaWikiTestCaseTest\testLoggersAreRestoredOnTearDown_replacingExistingLogger(), MediaWikiTestCaseTest\testLoggersAreRestoredOnTearDown_replacingNonExistingLogger(), MediaWikiTestCaseTest\testLoggersAreRestoredOnTearDown_replacingSameLoggerTwice(), MediaWikiTestCaseTest\testSetGlobalsAreRestoredOnTearDown(), MediaWikiTestCaseTest\testSetNonExistentGlobalsAreUnsetOnTearDown(), and MediaWikiTestCaseTest\testStashedGlobalsAreRestoredOnTearDown().

◆ teardownTestDB()

static MediaWikiTestCase::teardownTestDB ( )

static

Restores MediaWiki to using the table set (table prefix) it was using before setupTestDB() was called.

Useful if we need to perform database operations after the test run has finished (such as saving logs or profiling info).

This is called by phpunit/bootstrap.php after the last test.

Since: 1.21

Definition at line 1351 of file MediaWikiTestCase.php.

References $type, $wgJobClasses, as, and CloneDatabase\changePrefix().

◆ testMediaWikiTestCaseParentSetupCalled()

MediaWikiTestCase::testMediaWikiTestCaseParentSetupCalled ( )

final

Make sure MediaWikiTestCase extending classes have called their parent setUp method.

With strict coverage activated in PHP_CodeCoverage, this test would be marked as risky without the following annotation (T152923). @coversNothing

Definition at line 631 of file MediaWikiTestCase.php.

◆ truncateTable()

MediaWikiTestCase::truncateTable	(		$tableName,
		IDatabase	$db = `null`
	)

protected

Empties the given table and resets any auto-increment counters.

Will also purge caches associated with some well known tables. If the table is not know, this method just returns.

Parameters

string	$tableName
IDatabase \| null	$db

Definition at line 1810 of file MediaWikiTestCase.php.

References Wikimedia\Rdbms\Database\delete(), SiteStatsInit\doPlaceholderInit(), Wikimedia\Rdbms\IDatabase\getType(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\tableExists(), and Wikimedia\Rdbms\Database\tableName().

Referenced by resetDB(), and MediaWiki\Tests\Storage\NameTableStoreTest\testGetAndAcquireId().

◆ undoSchemaOverrides()

MediaWikiTestCase::undoSchemaOverrides	(	IMaintainableDatabase	$db,
			$oldOverrides
	)

private

Undoes the specified schema overrides.

Called once per test class, just before addDataOnce().

Parameters

IMaintainableDatabase	$db
array	$oldOverrides

Definition at line 1593 of file MediaWikiTestCase.php.

References dropMockTables(), ensureMockDatabaseConnection(), listOriginalTables(), and recloneMockTables().

Referenced by setUpSchema().

◆ unprefixTable()

static MediaWikiTestCase::unprefixTable	(	&	$tableName,
			$ind,
			$prefix
	)

staticprivate

Definition at line 1838 of file MediaWikiTestCase.php.

◆ usesTemporaryTables()

MediaWikiTestCase::usesTemporaryTables ( )

Since: 1.21

Returns: bool

Definition at line 458 of file MediaWikiTestCase.php.

◆ wfResetOutputBuffersBarrier()

static MediaWikiTestCase::wfResetOutputBuffersBarrier ( $buffer )

static

Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.

Parameters

string $buffer

Returns: string

Definition at line 2280 of file MediaWikiTestCase.php.

References $buffer.

Member Data Documentation

◆ $called

MediaWikiTestCase::$called = []

private

$called tracks whether the setUp and tearDown method has been called.

class extending MediaWikiTestCase usually override setUp and tearDown but forget to call the parent.

The array format takes a method name as key and anything as a value. By asserting the key exist, we know the child class has called the parent.

This property must be private, we do not want child to override it, they should call the appropriate parent method instead.

Definition at line 46 of file MediaWikiTestCase.php.

Referenced by SpecialPageFactoryTest\testGetAliasListRecursion(), DeprecatedGlobalTest\testLazyLoad(), LBFactoryTest\testLBFactoryMultiRoundCallbacks(), MediaWiki\Session\SessionManagerTest\testLoadSessionInfoFromStore(), HTMLCheckMatrixTest\testValidateCallsUserDefinedValidationCallback(), and LoadBalancerTest\testWithoutReplica().

◆ $cliArgs

array MediaWikiTestCase::$cliArgs = []

private

The CLI arguments passed through from phpunit.php.

Definition at line 121 of file MediaWikiTestCase.php.

◆ $db

Database MediaWikiTestCase::$db

protected

Primary database.

Since: 1.18

Definition at line 60 of file MediaWikiTestCase.php.

◆ $dbSetup

MediaWikiTestCase::$dbSetup = false

staticprivate

Definition at line 70 of file MediaWikiTestCase.php.

◆ $iniSettings

array MediaWikiTestCase::$iniSettings = []

private

Holds original values of ini settings to be restored in tearDown().

See also: setIniSettings()

Definition at line 109 of file MediaWikiTestCase.php.

◆ $localServices

MediaWikiServices MediaWikiTestCase::$localServices

private

The local service locator, created during setUp().

Definition at line 32 of file MediaWikiTestCase.php.

◆ $loggers

LoggerInterface [] MediaWikiTestCase::$loggers = []

private

Holds original loggers which have been replaced by setLogger()

Definition at line 115 of file MediaWikiTestCase.php.

◆ $mwGlobals

array MediaWikiTestCase::$mwGlobals = []

private

Holds original values of MediaWiki configuration settings to be restored in tearDown().

◆ $mwGlobalsToUnset

array MediaWikiTestCase::$mwGlobalsToUnset = []

private

Holds list of MediaWiki configuration settings to be unset in tearDown().

◆ $oldTablePrefix

MediaWikiTestCase::$oldTablePrefix = ''

staticprivate

Definition at line 71 of file MediaWikiTestCase.php.

◆ $originalServices

MediaWikiServices null MediaWikiTestCase::$originalServices

staticprivate

The original service locator.

This is overridden during setUp().

Definition at line 26 of file MediaWikiTestCase.php.

◆ $overriddenServices

string [] MediaWikiTestCase::$overriddenServices = []

private

Holds a list of services that were overridden with setService().

Used for printing an error if overrideMwServices() overrides a service that was previously set.

Definition at line 128 of file MediaWikiTestCase.php.

◆ $phpErrorLevel

int MediaWikiTestCase::$phpErrorLevel

private

Original value of PHP's error_reporting setting.

Definition at line 78 of file MediaWikiTestCase.php.

◆ $reuseDB

MediaWikiTestCase::$reuseDB = false

staticprivate

Definition at line 69 of file MediaWikiTestCase.php.

◆ $schemaOverrideDefaults

MediaWikiTestCase::$schemaOverrideDefaults

staticprivate

Initial value:

= [
        'scripts' => [],
        'create' => [],
        'drop' => [],
        'alter' => [],
    ]

Definition at line 1561 of file MediaWikiTestCase.php.

◆ $supportedDBs

array MediaWikiTestCase::$supportedDBs

protected

Initial value:

= [
        'mysql',
        'sqlite',
        'postgres',
        'oracle'
    ]

Since: 1.18

Definition at line 140 of file MediaWikiTestCase.php.

◆ $tablesUsed

array MediaWikiTestCase::$tablesUsed = []

protected

Since: 1.19

Definition at line 66 of file MediaWikiTestCase.php.

◆ $tmpFiles

array MediaWikiTestCase::$tmpFiles = []

private

Holds the paths of temporary files/directories created through getNewTempFile, and getNewTempDirectory.

Definition at line 86 of file MediaWikiTestCase.php.

Referenced by FileBackendTest\doTestGetLocalCopy(), and FileBackendTest\doTestGetLocalReference().

◆ $users

TestUser [] MediaWikiTestCase::$users

static

Since: 1.20

Definition at line 52 of file MediaWikiTestCase.php.

Referenced by ApiQueryUserContribsTest\addDBDataOnce(), ApiQueryUserContribsTest\provideSorting(), UserTest\testFindUsersByGroup(), and ActorMigrationTest\testGetWhere().

◆ $useTemporaryTables

MediaWikiTestCase::$useTemporaryTables = true

staticprivate

Definition at line 68 of file MediaWikiTestCase.php.

◆ DB_PREFIX

const MediaWikiTestCase::DB_PREFIX = 'unittest_'

Table name prefixes.

Oracle likes it shorter.

Definition at line 133 of file MediaWikiTestCase.php.

◆ ORA_DB_PREFIX

const MediaWikiTestCase::ORA_DB_PREFIX = 'ut_'

Definition at line 134 of file MediaWikiTestCase.php.

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

tests/phpunit/MediaWikiTestCase.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ addCoreDBData()

◆ addDBData()

◆ addDBDataOnce()

◆ addTmpFiles()

◆ arrayWrap()

◆ assertArrayEquals()

◆ assertFileContains()

◆ assertHTMLEquals()

◆ assertSelect()

◆ assertType()

◆ assertTypeOrValue()

◆ canShallowCopy()

◆ checkDbIsSupported()

◆ checkPHPExtension()

◆ containsClosure()

◆ copyTestData()

◆ dbPrefix()

◆ doSetMwGlobals()

◆ doStashMwGlobals()

◆ dropMockTables()

◆ editPage()

◆ ensureMockDatabaseConnection()

◆ getCliArg()

◆ getDefaultWikitextNS()

◆ getExistingTestPage()

◆ getExternalStoreDatabaseConnections()

◆ getMutableTestUser()

◆ getNewTempDirectory()

◆ getNewTempFile()

◆ getNonexistingTestPage()

◆ getSchemaOverrides()

◆ getTestPrefixFor()

◆ getTestSysop()

◆ getTestUser()

◆ hideDeprecated()

◆ insertPage()

◆ installMockMwServices()

◆ isNotUnittest()

◆ isTestInDatabaseGroup()

◆ isUsingExternalStoreDB()

◆ isWikitextNS()

◆ listOriginalTables()

◆ listTables()

◆ makeTestConfig()

◆ makeTestConfigFactoryInstantiator()

◆ markTestSkippedIfDbType()

◆ markTestSkippedIfNoDiff3()

◆ mergeMwGlobalArrayValue()

◆ mungeSchemaUpdateQuery()

◆ needsDB()

◆ objectAssociativeSort()

◆ oncePerClass()

◆ overrideMwServices()

◆ prepareServices()

◆ recloneMockTables()

◆ resetDB()

◆ resetNamespaces()

◆ resetNonServiceCaches()

◆ restoreLoggers()

◆ restoreMwServices()

◆ revisionDelete()

◆ run()

◆ setCliArg()

◆ setContentLang()