MediaWiki  master
MediaWikiTestCase Class Reference

Inherits TestCase.

Inherited by AbstractChangesListSpecialPageTestCase, ActionTest, ApiContinuationManagerTest, ApiFormatTestBase, ApiMessageTest, ApiModuleManagerTest, ApiOpenSearchTest, ApiPrefixUniquenessTest, ApiResultTest, ApiStructureTest, ApiUsageExceptionTest, ArrayDiffFormatterTest, ArticleTest, AutoLoaderStructureTest, AutoLoaderTest, AutopromoteTest, BadTitleErrorTest, BagOStuffTest, BatchRowUpdateTest, BitmapMetadataHandlerTest, BitmapScalingTest, BotPasswordTest, CachingSiteStoreTest, CategoryMembershipChangeJobTest, CdnCacheUpdateTest, CentralIdLookupTest, ChangesListBooleanFilterGroupTest, ChangesListBooleanFilterTest, ChangesListFilterGroupTest, ChangesListFilterTest, ChangesListStringOptionsFilterGroupTest, ChangeTagsTest, ClassicInterwikiLookupTest, ClearUserWatchlistJobTest, ComposerInstalledTest, ComposerJsonTest, ComposerLockTest, ConfigFactoryTest, ContentHandlerSanityTest, ContentHandlerTest, ContentSecurityPolicyTest, ContribsPagerTest, CoreParserFunctionsTest, CSSMinTest, CustomUppercaseCollationTest, DatabaseIntegrationTest, DatabaseLogEntryTest, DatabasePostgresTest, DatabaseSqliteTest, DBSiteStoreTest, DefaultPreferencesFactoryTest, DeferredUpdatesTest, DeprecatedGlobalTest, DeprecationHelperTest, DifferenceEngineTest, DiffHistoryBlobTest, DiffOpTest, DiffTest, DummyExtensionsTest, ErrorPageErrorTest, ExifTest, ExtensionJsonValidatorTest, ExtensionProcessorTest, ExtensionRegistryTest, ExternalStoreTest, ExternalUserNamesTest, ExtraParserTest, FauxResponseTest, FileBackendDBRepoWrapperTest, FileBackendTest, FileRepoTest, FiltersTest, ForeignTitleTest, FormatJsonTest, FormOptionsInitializationTest, FormOptionsTest, GIFMetadataExtractorTest, GitInfoTest, GlobalTest, GlobalVarConfigTest, GlobalWithDBTest, HashConfigTest, HashSiteStoreTest, HooksTest, HTMLAutoCompleteSelectFieldTest, HTMLCheckMatrixTest, HTMLFormTest, HtmlTest, HttpErrorTest, HttpTest, ImageListPagerTest, ImportLinkCacheIntegrationTest, InstallDocFormatterTest, InterwikiLookupAdapterTest, InterwikiTest, IPTCTest, JobQueueTest, JobTest, JpegMetadataExtractorTest, JsonContentHandlerTest, LanguageClassesTestCase, LBFactoryTest, LicensesTest, ListToggleTest, LoadBalancerTest, LocalFileTest, LocalIdLookupTest, LocalisationCacheTest, MagicVariableTest, MailAddressTest, MediaHandlerTest, MediaWiki\Auth\AbstractAuthenticationProviderTest, MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest, MediaWiki\Auth\AbstractPreAuthenticationProviderTest, MediaWiki\Auth\AbstractPrimaryAuthenticationProviderTest, MediaWiki\Auth\AbstractSecondaryAuthenticationProviderTest, MediaWiki\Auth\AuthenticationRequestTest, MediaWiki\Auth\AuthenticationRequestTestCase, MediaWiki\Auth\AuthenticationResponseTest, MediaWiki\Auth\AuthManagerTest, MediaWiki\Auth\AuthPluginPrimaryAuthenticationProviderTest, MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProviderTest, MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProviderTest, MediaWiki\Auth\LegacyHookPreAuthenticationProviderTest, MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest, MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProviderTest, MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest, MediaWiki\Auth\ThrottlePreAuthenticationProviderTest, MediaWiki\Auth\ThrottlerTest, MediaWiki\Logger\LegacyLoggerTest, MediaWiki\Logger\Monolog\AvroFormatterTest, MediaWiki\Logger\Monolog\KafkaHandlerTest, MediaWiki\Logger\Monolog\LineFormatterTest, MediaWiki\Logger\MonologSpiTest, MediaWiki\Session\BotPasswordSessionProviderTest, MediaWiki\Session\CookieSessionProviderTest, MediaWiki\Session\ImmutableSessionProviderWithCookieTest, MediaWiki\Session\MetadataMergeExceptionTest, MediaWiki\Session\PHPSessionHandlerTest, MediaWiki\Session\SessionBackendTest, MediaWiki\Session\SessionIdTest, MediaWiki\Session\SessionInfoTest, MediaWiki\Session\SessionManagerTest, MediaWiki\Session\SessionProviderTest, MediaWiki\Session\SessionTest, MediaWiki\Session\TokenTest, MediaWiki\Session\UserInfoTest, MediaWiki\Tests\EditPage\TextboxBuilderTest, MediaWiki\Tests\Maintenance\BaseDumpTest, MediaWiki\Tests\Maintenance\FetchTextTest, MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase, MediaWiki\Tests\Storage\BlobStoreFactoryTest, MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest, MediaWiki\Tests\Storage\MutableRevisionRecordTest, MediaWiki\Tests\Storage\NameTableStoreTest, MediaWiki\Tests\Storage\PageUpdaterTest, MediaWiki\Tests\Storage\RevisionArchiveRecordTest, MediaWiki\Tests\Storage\RevisionSlotsTest, MediaWiki\Tests\Storage\RevisionSlotsUpdateTest, MediaWiki\Tests\Storage\RevisionStoreDbTestBase, MediaWiki\Tests\Storage\RevisionStoreFactoryTest, MediaWiki\Tests\Storage\RevisionStoreRecordTest, MediaWiki\Tests\Storage\RevisionStoreTest, MediaWiki\Tests\Storage\SlotRecordTest, MediaWiki\Tests\Storage\SqlBlobStoreTest, MediaWikiLangTestCase, MediaWikiMediaTestCase, MediaWikiServicesTest, MediaWikiTest, MediaWikiTestCaseSchema1Test, MediaWikiTestCaseSchema2Test, MediaWikiTestCaseTest, MediaWikiTitleCodecTest, MediaWikiVersionFetcherTest, MemcachedBagOStuffTest, MergeHistoryTest, MigrateFileRepoLayoutTest, MovePageTest, MultiConfigTest, MultiHttpClientTest, MultiWriteBagOStuffTest, MWCryptHKDFTest, MWDebugTest, MWExceptionHandlerTest, MWExceptionTest, MWGrantsTest, MWNamespaceTest, NaiveForeignTitleFactoryTest, NaiveImportTitleFactoryTest, NamespaceAwareForeignTitleFactoryTest, NamespaceImportTitleFactoryTest, NoWriteWatchedItemStoreUnitTest, ObjectCacheTest, OracleInstallerTest, OutputPageTest, PageArchiveTestBase, PageDataRequestHandlerTest, ParserFactoryTest, ParserOptionsTest, ParserOutputTest, ParserPreloadTest, PasswordFactoryTest, PasswordPolicyChecksTest, PasswordResetTest, PasswordTest, PasswordTestCase, PathRouterTest, PNGMetadataExtractorTest, PoolCounterTest, PreferencesTest, PreprocessorTest, QueryAllSpecialPagesTest, RCFeedIntegrationTest, ReadOnlyErrorTest, ReadOnlyModeTest, RecentChangeTest, RefreshLinksPartitionTest, ReleaseNotesTest, RemexDriverTest, ReplicatedBagOStuffTest, RepoGroupTest, RequestContextTest, ResourceLoaderTestCase, ResourcesTest, RESTBagOStuffTest, RevisionDbTestBase, RevisionTest, SanitizerTest, SearchIndexFieldTest, SearchResultSetTest, SearchUpdateTest, ServiceWiringTest, ShellTest, SiteConfigurationTest, SiteListTest, SiteStatsTest, SiteStatsUpdateTest, SiteTest, SkinFactoryTest, SkinTemplateTest, SkinTest, SpecialMIMESearchTest, SpecialMyLanguageTest, SpecialPageAliasTest, SpecialPageFactoryTest, SpecialPageFatalTest, SpecialPageTest, SpecialPageTestBase, SpecialPreferencesTest, SpecialSearchTest, SpecialShortpagesTest, SpecialUploadTest, StoreBatchTest, StripStateTest, StructureTest, SubpageImportTitleFactoryTest, SVGMetadataExtractorTest, SwiftFileBackendTest, TagHooksTest, TemplateParserTest, ThrottledErrorTest, TidyTest, TiffTest, TitleTest, TitleValueTest, UncategorizedCategoriesPageTest, UploadBaseTest, UploadStashTest, UserArrayFromResultTest, UserGroupMembershipTest, UserNotLoggedInTest, UserPasswordPolicyTest, UserTest, WatchActionTest, WatchedItemQueryServiceUnitTest, WatchedItemStoreIntegrationTest, WatchedItemStoreUnitTest, WebPHandlerTest, WebRequestTest, WfAppendQueryTest, WfArrayFilterTest, WfArrayPlus2dTest, WfAssembleUrlTest, WfBaseNameTest, WfEscapeShellArgTest, WfExpandUrlTest, WfGetCallerTest, WfParseUrlTest, WfRemoveDotSegmentsTest, WfShellExecTest, WfShorthandToIntegerTest, WfStringToBoolTest, WfThumbIsStandardTest, WfTimestampTest, WfUrlencodeTest, XmlSelectTest, and XmlTest.

Collaboration diagram for MediaWikiTestCase:

Public Member Functions

 __construct ( $name=null, array $data=[], $dataName='')
 
 __destruct ()
 
 addDBData ()
 Stub. More...
 
 addDBDataOnce ()
 Stub. More...
 
 copyTestData (IDatabase $source, IDatabase $target)
 Copy test data from one database connection to another. More...
 
 dbPrefix ()
 
 getCliArg ( $offset)
 
 hideDeprecated ( $function)
 Don't throw a warning if $function is deprecated and called later. More...
 
 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. More...
 
 setupAllTestDBs ()
 Set up all test DBs. More...
 
 setUserLang ( $lang)
 
 testMediaWikiTestCaseParentSetupCalled ()
 Make sure MediaWikiTestCase extending classes have called their parent setUp method. More...
 
 usesTemporaryTables ()
 

Static Public Member Functions

static getMutableTestUser ( $groups=[])
 Convenience method for getting a mutable test user. More...
 
static getTestPrefixFor (IDatabase $db)
 
static getTestSysop ()
 Convenience method for getting an immutable admin test user. More...
 
static getTestUser ( $groups=[])
 Convenience method for getting an immutable test user. More...
 
static listTables (IMaintainableDatabase $db)
 
static prepareServices (Config $bootstrapConfig)
 Prepare service configuration for unit testing. More...
 
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. More...
 
static teardownTestDB ()
 Restores MediaWiki to using the table set (table prefix) it was using before setupTestDB() was called. More...
 
static wfResetOutputBuffersBarrier ( $buffer)
 Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit. More...
 

Public Attributes

const DB_PREFIX = 'unittest_'
 Table name prefixes. More...
 
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. More...
 
 assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
 Assert that two arrays are equal. More...
 
 assertFileContains ( $fileName, $actualData, $createIfMissing=true, $msg='')
 Check whether file contains given data. More...
 
 assertHTMLEquals ( $expected, $actual, $msg='')
 Put each HTML element on its own line and then equals() the results. More...
 
 assertSelect ( $table, $fields, $condition, array $expectedRows, array $options=[], array $join_conds=[])
 Asserts that the given database query yields the rows given by $expectedRows. More...
 
 assertType ( $type, $actual, $message='')
 Asserts the type of the provided value. More...
 
 assertTypeOrValue ( $type, $actual, $value=false, $message='')
 Asserts that the provided variable is of the specified internal type or equals the $value argument. More...
 
 checkDbIsSupported ()
 
 checkPHPExtension ( $extName)
 Check if $extName is a loaded PHP extension, will skip the test whenever it is not loaded. More...
 
 editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
 Edits or creates a page/revision. More...
 
 ensureMockDatabaseConnection (IDatabase $db)
 
 getDefaultWikitextNS ()
 Returns the ID of a namespace that defaults to Wikitext. More...
 
 getExistingTestPage ( $title=null)
 Returns a WikiPage representing an existing page. More...
 
 getNewTempDirectory ()
 obtains a new temporary directory More...
 
 getNewTempFile ()
 Obtains a new temporary file name. More...
 
 getNonexistingTestPage ( $title=null)
 Returns a WikiPage representing a non-existing page. More...
 
static getSchemaOverrides (IMaintainableDatabase $db)
 Stub. More...
 
 insertPage ( $pageName, $text='Sample page for unit test.', $namespace=null, User $user=null)
 Insert a new page. More...
 
 isWikitextNS ( $ns)
 Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels. More...
 
 markTestSkippedIfDbType ( $type)
 Skip the test if using the specified database type. More...
 
 markTestSkippedIfNoDiff3 ()
 Check, if $wgDiff3 is set and ready to merge Will mark the calling test as skipped, if not ready. More...
 
 mergeMwGlobalArrayValue ( $name, $values)
 Merges the given values into a MW global array variable. More...
 
 objectAssociativeSort (array &$array)
 Does an associative sort that works for objects. More...
 
 prepareConnectionForTesting (IMaintainableDatabase $db)
 Prepares the given database connection for usage in the context of usage tests. More...
 
 revisionDelete ( $rev, array $value=[Revision::DELETED_TEXT=> 1], $comment='')
 Revision-deletes a revision. More...
 
 setLogger ( $channel, LoggerInterface $logger)
 Sets the logger for a specified channel, for the duration of the test. More...
 
 setMwGlobals ( $pairs, $value=null)
 Sets a global, maintaining a stashed version of the previous global to be restored in tearDown. More...
 
 setService ( $name, $object)
 Sets a service, maintaining a stashed version of the previous service to be restored in tearDown. More...
 
 setTemporaryHook ( $hookName, $handler)
 Create a temporary hook handler which will be reset by tearDown. More...
 
 setUp ()
 
 stashMwGlobals ( $globalKeys)
 Stashes the global, will be restored in tearDown() More...
 
 tearDown ()
 

Static Protected Member Functions

static getExternalStoreDatabaseConnections ()
 Gets master database connections for all of the ExternalStoreDB stores configured in $wgDefaultExternalStore. More...
 
static isUsingExternalStoreDB ()
 Check whether ExternalStoreDB is being used. More...
 
static 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. More...
 
static setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix=null)
 Setups a database with cloned tables using the given prefix. More...
 
static setupExternalStoreTestDBs ( $testPrefix=null)
 Clones the External Store database(s) for testing. More...
 
static stripStringKeys (&$r)
 Utility function for eliminating all string keys from an array. More...
 

Protected Attributes

Database $db
 Primary database. More...
 
array $supportedDBs
 
array $tablesUsed = []
 

Private Member Functions

 containsClosure ( $var, $maxDepth=15)
 
 doLightweightServiceReset ()
 Resets some well known services that typically have state that may interfere with unit tests. More...
 
 doSetMwGlobals ( $pairs, $value=null)
 An internal method that allows setService() to set globals that tests are not supposed to touch. More...
 
 dropMockTables (IMaintainableDatabase $db, array $tables)
 Drops the given mock tables. More...
 
 listOriginalTables (IMaintainableDatabase $db, $prefix='prefixed')
 Lists all tables in the live database schema. More...
 
 mungeSchemaUpdateQuery ( $cmd)
 
 oncePerClass ()
 
 recloneMockTables (IMaintainableDatabase $db, array $tables)
 Re-clones the given mock tables to restore them based on the live database schema. More...
 
 resetDB ( $db, $tablesUsed)
 Empty all tables so they can be repopulated for tests. More...
 
 resetNamespaces ()
 Must be called whenever namespaces are changed, e.g., $wgExtraNamespaces is altered. More...
 
 restoreLoggers ()
 Restores loggers replaced by setLogger(). More...
 
 setUpSchema (IMaintainableDatabase $db)
 Applies the schema overrides returned by getSchemaOverrides(), after undoing any previously applied schema overrides. More...
 
 undoSchemaOverrides (IMaintainableDatabase $db, $oldOverrides)
 Undoes the specified schema overrides. More...
 

Static Private Member Functions

static canShallowCopy ( $value)
 Check if we can back up a value by performing a shallow copy. More...
 
static installTestServices (ConfigFactory $oldConfigFactory, LBFactory $oldLoadBalancerFactory, MediaWikiServices $newServices)
 
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. More...
 
static makeTestConfigFactoryInstantiator (ConfigFactory $oldFactory, array $configurations)
 
static resetGlobalServices (Config $bootstrapConfig=null)
 Reset global services, and install testing environment. More...
 
static unprefixTable (&$tableName, $ind, $prefix)
 

Private Attributes

 $called = []
 $called tracks whether the setUp and tearDown method has been called. More...
 
IResultWrapper $interwikiTable = null
 Holds original contents of interwiki table. More...
 
LoggerInterface [] $loggers = []
 Holds original loggers which have been replaced by setLogger() More...
 
array $mwGlobals = []
 Holds original values of MediaWiki configuration settings to be restored in tearDown(). More...
 
array $mwGlobalsToUnset = []
 Holds list of MediaWiki configuration settings to be unset in tearDown(). More...
 
int $phpErrorLevel
 Original value of PHP's error_reporting setting. More...
 
array $tmpFiles = []
 Holds the paths of temporary files/directories created through getNewTempFile, and getNewTempDirectory. More...
 

Static Private Attributes

static $dbSetup = false
 
static $oldTablePrefix = ''
 
static $reuseDB = false
 
static $schemaOverrideDefaults
 
static MediaWikiServices null $serviceLocator = null
 The service locator created by prepareServices(). More...
 
static $useTemporaryTables = true
 

Detailed Description

Since
1.18

Definition at line 17 of file MediaWikiTestCase.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 129 of file MediaWikiTestCase.php.

References $name.

◆ __destruct()

MediaWikiTestCase::__destruct ( )

Definition at line 136 of file MediaWikiTestCase.php.

References class.

Member Function Documentation

◆ addCoreDBData()

MediaWikiTestCase::addCoreDBData ( )
protected

◆ 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

Definition at line 1200 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

Definition at line 1188 of file MediaWikiTestCase.php.

Referenced by run().

◆ addTmpFiles()

MediaWikiTestCase::addTmpFiles (   $files)
protected

◆ 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 1989 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$orderedIf the order of the values should match
bool$namedIf the keys should match

Definition at line 2010 of file MediaWikiTestCase.php.

References objectAssociativeSort().

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

◆ assertFileContains()

MediaWikiTestCase::assertFileContains (   $fileName,
  $actualData,
  $createIfMissing = true,
  $msg = '' 
)
protected

Check whether file contains given data.

Parameters
string$fileName
string$actualData
bool$createIfMissingIf true, and file does not exist, create it with given data and skip the test.
string$msg
Since
1.30

Definition at line 2278 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$expectedHTML on oneline
string$actualHTML on oneline
string$msgOptional message

Definition at line 2041 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$tableThe table(s) to query
string | array$fieldsThe columns to include in the result (and to sort by)
string | array$condition"where" condition(s)
array$expectedRowsAn array of arrays giving the expected rows.
array$optionsOptions for the query
array$join_condsJoin conditions for the query
Exceptions
MWExceptionIf 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 1940 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\Storage\McrReadNewRevisionStoreDbTest\assertRevisionExistsInDatabase(), MediaWiki\Tests\Storage\McrRevisionStoreDbTest\assertRevisionExistsInDatabase(), MediaWiki\Tests\Storage\PreMcrRevisionStoreDbTest\assertRevisionExistsInDatabase(), MediaWiki\Tests\Storage\McrWriteBothRevisionStoreDbTest\assertRevisionExistsInDatabase(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\assertRevisionExistsInDatabase(), WikiPageDbTestBase\testDoDeleteArticleReal_suppress(), WikiPageDbTestBase\testDoDeleteArticleReal_user0(), WikiPageDbTestBase\testDoDeleteArticleReal_userSysop(), WikiPageDbTestBase\testDoEditContent(), RevisionDbTestBase\testInsertOn_success(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testInsertRevisionOn_archive(), PageArchiveMcrTest\testListRevisions_slots(), 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 2117 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(), 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 2098 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 802 of file MediaWikiTestCase.php.

References $value, and as.

◆ checkDbIsSupported()

MediaWikiTestCase::checkDbIsSupported ( )
protected
Exceptions
MWException
Since
1.18

Definition at line 1879 of file MediaWikiTestCase.php.

References $supportedDBs.

Referenced by run().

◆ checkPHPExtension()

◆ containsClosure()

MediaWikiTestCase::containsClosure (   $var,
  $maxDepth = 15 
)
private
Parameters
mixed$var
int$maxDepth
Returns
bool

Definition at line 886 of file MediaWikiTestCase.php.

References $value, and as.

Referenced by stashMwGlobals().

◆ 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 1860 of file MediaWikiTestCase.php.

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

◆ dbPrefix()

◆ doLightweightServiceReset()

MediaWikiTestCase::doLightweightServiceReset ( )
private

Resets some well known services that typically have state that may interfere with unit tests.

This is a lightweight alternative to resetGlobalServices().

Note
There is no guarantee that no references remain to stale service instances destroyed by a call to doLightweightServiceReset().
Exceptions
MWExceptionif called outside of PHPUnit tests.
See also
resetGlobalServices()

Definition at line 417 of file MediaWikiTestCase.php.

References $services, $type, $wgJobClasses, $wgRequest, as, ObjectCache\clear(), DeferredUpdates\clearPendingUpdates(), FileBackendGroup\destroySingleton(), JobQueueGroup\destroySingletons(), global, MediaWiki\Session\SessionManager\resetCache(), RequestContext\resetMain(), and JobQueueGroup\singleton().

Referenced by setUp().

◆ 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 766 of file MediaWikiTestCase.php.

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

Referenced by setMwGlobals(), and setService().

◆ dropMockTables()

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

Drops the given mock tables.

Parameters
IMaintainableDatabase$db
array$tables

Definition at line 1662 of file MediaWikiTestCase.php.

References 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$pageNamePage title
string$textContent of the page
string$summaryOptional summary string for the revision
int$defaultNsOptional namespace id
Returns
array Array as returned by WikiPage::doEditContent()

Definition at line 2303 of file MediaWikiTestCase.php.

References $title, WikiPage\factory(), ContentHandler\makeContent(), and Title\newFromText().

Referenced by ApiParseTest\addDBDataOnce(), ApiQueryContinue2Test\addDBDataOnce(), ApiQueryBasicTest\addDBDataOnce(), ApiQueryContinueTest\addDBDataOnce(), ApiMoveTest\createPage(), ApiQueryPrefixSearchTest\setUp(), OutputPageTest\testAddBacklinkSubtitle(), ApiEditPageTest\testAppendNewSection(), ApiEditPageTest\testAppendNewSectionWithInvalidContentModel(), ApiEditPageTest\testAppendNewSectionWithSummary(), ApiEditPageTest\testAppendNewSectionWithTitle(), ApiEditPageTest\testAppendNewSectionWithTitleAndSummary(), ApiEditPageTest\testAppendToFirstSection(), ApiEditPageTest\testAppendToNonexistentSection(), ApiEditPageTest\testAppendToSection(), OutputPageTest\testBuildBacklinkSubtitle(), ApiParseTest\testCategoriesHtml(), ApiEditPageTest\testCreateOnly(), ApiDeleteTest\testDelete(), ApiDeleteTest\testDeleteAbortedByHook(), ApiDeleteTest\testDeleteUnwatch(), ApiDeleteTest\testDeleteWatch(), ApiDeleteTest\testDeleteWithoutTagPermission(), ApiDeleteTest\testDeleteWithTag(), ApiDeleteTest\testDeletionWithoutPermission(), ApiEditPageTest\testEditMalformedSection(), ApiEditPageTest\testEditMinor(), ApiEditPageTest\testEditRecreate(), ApiEditPageTest\testEditWithStartTimestamp(), ApiParseTest\testFollowedRedirect(), ApiParseTest\testFollowedRedirectById(), ApiParseTest\testFormatCategories(), ApiQueryBasicTest\testGeneratorRedirects(), ApiQuerySiteinfoTest\testInterwikiMap(), ApiEditPageTest\testMd5AppendText(), ApiEditPageTest\testMd5PrependAndAppendText(), ApiEditPageTest\testMd5PrependText(), ApiParseTest\testNoPst(), ApiParseTest\testOnlyPst(), ApiParseTest\testPst(), ApiEditPageTest\testReversedUndoAfter(), ApiParseTest\testSection(), ApiParseTest\testSectionNoContent(), ApiEditPageTest\testUndoAfterToHiddenRev(), ApiEditPageTest\testUndoAfterToInvalidRev(), ApiEditPageTest\testUndoAfterToRevFromDifferentPage(), ApiEditPageTest\testUndoToInvalidRev(), ApiEditPageTest\testUndoToRevFromDifferentPage(), ApiEditPageTest\testUndoWithConflicts(), ApiEditPageTest\testUndoWithSwappedRevisions(), and ApiParseTest\testUnfollowedRedirect().

◆ ensureMockDatabaseConnection()

MediaWikiTestCase::ensureMockDatabaseConnection ( IDatabase  $db)
protected
Exceptions
LogicExceptionif the given database connection is not a set up to use mock tables.
Since
1.31 this is no longer private.

Definition at line 1522 of file MediaWikiTestCase.php.

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

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

◆ getCliArg()

MediaWikiTestCase::getCliArg (   $offset)
Since
1.18
Parameters
string$offset
Returns
mixed

Definition at line 1890 of file MediaWikiTestCase.php.

References PHPUnitMaintClass\$additionalOptions.

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

◆ getDefaultWikitextNS()

◆ 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

Definition at line 196 of file MediaWikiTestCase.php.

References $title, $user, EDIT_NEW, EDIT_SUPPRESS_RC, WikiPage\factory(), and Title\newFromText().

Referenced by ApiBaseTest\testGetTitleFromTitleOrPageIdPageId(), and ApiBaseTest\testGetTitleOrPageIdPageId().

◆ 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 1476 of file MediaWikiTestCase.php.

References $wgDefaultExternalStore, array(), as, ExternalStore\getStoreObject(), global, and list.

◆ getMutableTestUser()

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

Convenience method for getting a mutable test user.

Since
1.28
Parameters
string[]$groups Groups the test user should be added in.
Returns
TestUser

Definition at line 171 of file MediaWikiTestCase.php.

References TestUserRegistry\getMutableTestUser().

Referenced by LocalIdLookupTest\addDBData(), GenderCacheTest\addDBDataOnce(), ApiUserrightsTest\doFailedRightsChange(), ApiUserrightsTest\doSuccessfulRightsChange(), EnhancedChangesListTest\getCategorizationChange(), OldChangesListTest\getContext(), RCCacheEntryFactoryTest\getContext(), EnhancedChangesListTest\getEditChange(), OldChangesListTest\getEditChange(), EnhancedChangesListTest\getLogChange(), OldChangesListTest\getLogChange(), ApiUserrightsTest\getMockForProcessingExpiries(), OldChangesListTest\getNewBotEditChange(), BlockTest\getUserForBlocking(), ApiBlockTest\setUp(), ApiQueryWatchlistRawIntegrationTest\setUp(), BotPasswordTest\setUp(), ApiQueryRecentChangesIntegrationTest\setUp(), ApiQueryWatchlistIntegrationTest\setUp(), UserGroupMembershipTest\testAddAndRemoveGroups(), ApiUserrightsTest\testAddAndRemoveGroups(), ApiMainTest\testAssert(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testAuthentication(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testBasics(), ApiBlockTest\testBlockByBlockedUser(), UserTest\testBlockInstanceCache(), UserTest\testCheckAndSetTouched(), 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\LocalPasswordPrimaryAuthenticationProviderTest\testSetPasswordResetFlag(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testTestUserCanAuthenticate(), ApiUserrightsTest\testWebToken(), and ApiUserrightsTest\testWithTag().

◆ 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 533 of file MediaWikiTestCase.php.

References getNewTempFile(), and wfMkdirParents().

Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\checkpointHelper(), MigrateFileRepoLayoutTest\setUp(), MediaWikiMediaTestCase\setUp(), StoreBatchTest\setUp(), FileBackendTest\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 516 of file MediaWikiTestCase.php.

References class, and wfTempDir().

Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\checkpointHelper(), ReadOnlyModeTest\createFile(), UploadBaseTest\createFileOfSize(), FileBackendTest\doTestConcatenate(), ApiUploadTestCase\fakeUploadChunk(), ApiUploadTestCase\fakeUploadFile(), getNewTempDirectory(), GlobalTest\setUp(), UploadStashTest\setUp(), MediaWiki\Tests\Maintenance\BaseDumpTest\setUpPrefetch(), MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\setUpStub(), UploadBaseTest\testCheckXMLEncodingMissmatch(), ReadOnlyModeTest\testClearCache(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testCurrentStubGzip(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testCurrentStubPlain(), GlobalTest\testDebugFunctionTest(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testFullStubPlain(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testFullTextPlain(), ApiMainTest\testNonWhitelistedCorsWithCookies(), MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\testPlain(), MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\testPlain(), MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\testPrefetchPlain(), JpegTest\testSwappingICCProfile(), ApiUploadTest\testUploadZeroLength(), GlobalTest\testWfMkdirParents(), MediaWiki\Tests\Maintenance\BackupDumperPageTest\testXmlDumpsBackupUseCase(), and MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\testXmlDumpsBackupUseCaseLogging().

◆ 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

Definition at line 224 of file MediaWikiTestCase.php.

References $title, WikiPage\factory(), and Title\newFromText().

◆ getSchemaOverrides()

static 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$dbThe 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).

Definition at line 1551 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 1111 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 183 of file MediaWikiTestCase.php.

Referenced by BlockTest\addBlockForUser(), MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProviderTest\getBlockedUser(), ApiUserrightsTest\getMockForProcessingExpiries(), NoWriteWatchedItemStoreUnitTest\testAddWatch(), NoWriteWatchedItemStoreUnitTest\testAddWatchBatchForUser(), UserTest\testAutoblockCookieInauthentic(), UserTest\testAutoblockCookieInfiniteExpiry(), UserTest\testAutoblockCookieNoSecretKey(), UserTest\testAutoblockCookies(), UserTest\testAutoblockCookiesDisabled(), ApiUserrightsTest\testBlockedWithoutUserrights(), UserTest\testBlockInstanceCache(), MediaWiki\Auth\AuthManagerTest\testCheckAccountCreatePermissions(), NoWriteWatchedItemStoreUnitTest\testCountUnreadNotifications(), NoWriteWatchedItemStoreUnitTest\testCountWatchedItems(), BlockTest\testDeprecatedConstructor(), WikiPageDbTestBase\testDoDeleteArticleReal_suppress(), WikiPageDbTestBase\testDoDeleteArticleReal_userSysop(), ApiBaseTest\testErrorArrayToStatus(), NoWriteWatchedItemStoreUnitTest\testGetNotificationTimestampsBatch(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testGetRcIdIfUnpatrolled_returnsZeroIfPatrolled(), RevisionDbTestBase\testGetUserAndText(), NoWriteWatchedItemStoreUnitTest\testGetWatchedItem(), NoWriteWatchedItemStoreUnitTest\testGetWatchedItemsForUser(), UserTest\testIpBlockCookieIgnoredWhenUserLoggedIn(), UserTest\testIpBlockCookieNotSet(), UserTest\testIpBlockCookieSet(), RevisionDbTestBase\testIsMinor_true(), RevisionDbTestBase\testIsUnpatrolled_returnsZeroIfPatrolled(), NoWriteWatchedItemStoreUnitTest\testIsWatched(), NoWriteWatchedItemStoreUnitTest\testLoadWatchedItem(), RCFeedIntegrationTest\testNotify(), MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProviderTest\testRangeBlock(), ChangesListSpecialPageTest\testRcHidepatrolledFilter(), ChangesListSpecialPageTest\testRcHideunpatrolledFilter(), ChangesListSpecialPageTest\testRcReviewStatusFilter(), NoWriteWatchedItemStoreUnitTest\testRemoveWatch(), NoWriteWatchedItemStoreUnitTest\testResetNotificationTimestamp(), MediaWiki\Tests\Storage\MutableRevisionRecordTest\testSetGetUser(), NoWriteWatchedItemStoreUnitTest\testSetNotificationTimestampsForUser(), NoWriteWatchedItemStoreUnitTest\testUpdateNotificationTimestamp(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testUserWasLastToEdit_false(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testUserWasLastToEdit_true(), AbstractChangesListSpecialPageTestCase\testValidateOptions(), and ApiUserrightsTest\testWebToken().

◆ getTestUser()

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

Convenience method for getting an immutable test user.

Since
1.28
Parameters
string[]$groups Groups the test user should be in.
Returns
TestUser

Definition at line 159 of file MediaWikiTestCase.php.

References TestUserRegistry\getImmutableTestUser().

Referenced by BlockTest\addXffBlocks(), MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest\createRevision(), MediaWiki\Tests\Storage\PageUpdaterTest\createRevision(), PageArchivePreMcrTest\getExpectedArchiveRows(), PageArchiveMcrTest\getExpectedArchiveRows(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\getRevisionRecordFromDetailsArray(), RevisionDbTestBase\makeRevisionWithProps(), OutputPageTest\provideCheckLastModified(), AbstractChangesListSpecialPageTestCase\setUp(), UserTest\setUp(), PageArchiveTestBase\setUp(), ApiMainTest\testAssertUser(), UserTest\testAutoblockCookieInauthentic(), UserTest\testAutoblockCookieInfiniteExpiry(), UserTest\testAutoblockCookieNoSecretKey(), UserTest\testAutoblockCookies(), UserTest\testAutoblockCookiesDisabled(), MediaWiki\Tests\Storage\PageUpdaterTest\testCompareAndSwapFailure(), RevisionTest\testConstructFromArray_userSetAsExpected(), MediaWiki\Tests\Storage\PageUpdaterTest\testCreatePage(), WikiPageDbTestBase\testDoEditContent(), WikiPageDbTestBase\testDoEditUpdates(), UserTest\testExperienceLevel(), MediaWiki\Tests\Storage\PageUpdaterTest\testFailureOnEditFlags(), SpecialWatchlistTest\testFetchOptionsFromRequest(), MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest\testGetCanonicalParserOptions(), DefaultPreferencesFactoryTest\testGetForm(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testGetKnownCurrentRevision(), MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest\testGetPreparedEditAfterPrepareContent(), PageArchiveTestBase\testGetPreviousRevision(), MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest\testGetSecondaryDataUpdatesAfterPrepareContent(), MediaWiki\Tests\Storage\RevisionStoreRecordTest\testGetSlot_audience_latest(), WikitextContentTest\testHadSignature(), MediaWiki\Tests\Storage\PageUpdaterTest\testInheritSlot(), ActorMigrationTest\testInsertRoundTrip(), ActorMigrationTest\testInsertUserIdentity(), ActorMigrationTest\testInsertWithTempTableCallbackMissingFields(), ActorMigrationTest\testInsertWithTempTableDeprecated(), ActorMigrationTest\testInsertWithTempTableWrong(), ActorMigrationTest\testInsertWrong(), UserTest\testIpBlockCookieIgnoredWhenUserLoggedIn(), UserTest\testNewFromAnyId(), UserTest\testNewFromIdentity(), RecentChangeTest\testNewFromRow(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testNewRevisionFromRow_userEdit(), MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest\testPrepareContent(), WikiPageDbTestBase\testPrepareContentForEdit(), MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest\testPrepareContentInherit(), MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest\testPrepareUpdateOutputReset(), MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest\testPrepareUpdateReusesParserOutput(), ChangesListSpecialPageTest\testRcHidebyothersFilter(), ChangesListSpecialPageTest\testRcHidemyselfFilter(), ChangesListSpecialPageTest\testRcHidepatrolledDisabledFilter(), ChangesListSpecialPageTest\testRcHideunpatrolledDisabledFilter(), MediaWiki\Tests\Storage\PageUpdaterTest\testSetRcPatrolStatus(), MediaWiki\Tests\Storage\PageUpdaterTest\testSetUseAutomaticEditSummaries(), MediaWiki\Tests\Storage\PageUpdaterTest\testSetUsePageCreationLog(), UserTest\testSoftBlockRanges(), ApiPageSetTest\testSpecialRedirects(), ImportTest\testUnknownUserHandling(), MediaWiki\Tests\Storage\PageUpdaterTest\testUpdatePage(), RevisionDbTestBase\testUserCan(), RevisionDbTestBase\testUserCanBitfield(), and UserTest\testUserGetRightsHooks().

◆ 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 1914 of file MediaWikiTestCase.php.

References wfDeprecated().

Referenced by UserTest\testActorId(), MediaWiki\Auth\AuthManagerTest\testAutoAccountCreation(), BlockTest\testDeprecatedConstructor(), ApiEditPageTest\testEditAbortedByHook(), ApiEditPageTest\testEditAbortedByHookWithCustomOutput(), RevisionDbTestBase\testFetchRevision(), PageArchiveTestBase\testGetLastRevisionText(), LBFactoryTest\testGetLBFactoryClass(), ApiErrorFormatterTest\testGetMessageFromException(), PageArchivePreMcrTest\testGetTextFromRow(), PageArchiveTestBase\testGetTextFromRowThrowsInvalidArgumentException(), WatchActionTest\testGetUnwatchToken(), ActorMigrationTest\testInsertWithTempTableDeprecated(), CommentStoreTest\testInsertWithTempTableDeprecated(), UserTest\testIsLocallyBlockedProxy(), SearchResultSetTest\testIterate(), DeprecatedGlobalTest\testLazyLoad(), LinkerTest\testLinkBeginHook(), LinkerTest\testLinkEndHook(), RevisionDbTestBase\testLoadFromId(), DeprecatedGlobalTest\testObjectDeStub(), HooksTest\testOldStyleHooks(), RevisionTest\testPageJoinCond(), RevisionTest\testSelectArchiveFields(), RevisionTest\testSelectFields(), RevisionTest\testSelectPageFields(), RevisionTest\testSelectTextFields(), RevisionTest\testSelectUserFields(), MediaWiki\Session\PHPSessionHandlerTest\testSessionHandling(), RevisionTest\testUserJoinCond(), 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$pageNamePage name or title
string$textPage's content
int | null$namespaceNamespace id (name cannot already contain namespace)
User | null$userIf null, static::getTestSysop()->getUser() is used.
Returns
array Title object and page id

Definition at line 1147 of file MediaWikiTestCase.php.

References $title, $user, WikiPage\factory(), ContentHandler\makeContent(), and Title\newFromText().

Referenced by MergeHistoryTest\addDBDataOnce(), PrefixSearchTest\addDBDataOnce(), SearchEnginePrefixTest\addDBDataOnce(), CategoryMembershipChangeJobTest\addDBDataOnce(), SearchEngineTest\addDBDataOnce(), ContentHandlerTest\addDBDataOnce(), LinksUpdateTest\addDBDataOnce(), CategoryMembershipChangeTest\addDBDataOnce(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testNewMutableRevisionFromArray(), and MediaWiki\Tests\Storage\PageUpdaterTest\testUpdatePage().

◆ installTestServices()

static MediaWikiTestCase::installTestServices ( ConfigFactory  $oldConfigFactory,
LBFactory  $oldLoadBalancerFactory,
MediaWikiServices  $newServices 
)
staticprivate
Parameters
ConfigFactory$oldConfigFactory
LBFactory$oldLoadBalancerFactory
MediaWikiServices$newServices
Exceptions
MWException

Definition at line 350 of file MediaWikiTestCase.php.

References $services, MediaWiki\MediaWikiServices\getBootstrapConfig(), MediaWiki\Services\ServiceContainer\redefineService(), MediaWiki\MediaWikiServices\resetServiceForTesting(), and use.

◆ isNotUnittest()

static MediaWikiTestCase::isNotUnittest (   $table)
staticprivate

Definition at line 1812 of file MediaWikiTestCase.php.

◆ isUsingExternalStoreDB()

static MediaWikiTestCase::isUsingExternalStoreDB ( )
staticprotected

Check whether ExternalStoreDB is being used.

Returns
bool True if it's being used

Definition at line 1500 of file MediaWikiTestCase.php.

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

◆ isWikitextNS()

MediaWikiTestCase::isWikitextNS (   $ns)
protected

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

Parameters
int$nsThe namespace ID to check
Returns
bool
Since
1.21

Definition at line 2134 of file MediaWikiTestCase.php.

References $wgNamespaceContentModels, CONTENT_MODEL_WIKITEXT, and global.

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$prefixEither 'prefixed' or 'unprefixed'
Returns
array

Definition at line 1684 of file MediaWikiTestCase.php.

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

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

◆ listTables()

static MediaWikiTestCase::listTables ( IMaintainableDatabase  $db)
static

◆ 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 305 of file MediaWikiTestCase.php.

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

◆ makeTestConfigFactoryInstantiator()

static MediaWikiTestCase::makeTestConfigFactoryInstantiator ( ConfigFactory  $oldFactory,
array  $configurations 
)
staticprivate
Parameters
ConfigFactory$oldFactory
Config[]$configurations
Returns
Closure

Definition at line 381 of file MediaWikiTestCase.php.

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

◆ markTestSkippedIfDbType()

◆ 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 2206 of file MediaWikiTestCase.php.

References $wgDiff3, and global.

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$nameThe name of the global, as in wgFooBar
array$valuesThe array containing the entries to set in that global
Exceptions
MWExceptionIf 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 917 of file MediaWikiTestCase.php.

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

Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\addDBData(), GenderCacheTest\addDBDataOnce(), MediaWiki\Auth\LegacyHookPreAuthenticationProviderTest\hook(), setTemporaryHook(), PageLangLogFormatterTest\setUp(), NewUsersLogFormatterTest\setUp(), AutoLoaderTest\setUp(), TitleMethodsTest\setUp(), ApiRevisionDeleteTest\setUp(), ApiEditPageTest\setUp(), EditPageTest\setUp(), BotPasswordTest\setUp(), ApiOptionsTest\setUp(), PagePropsTest\setUp(), RevisionDbTestBase\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(), ApiQueryDisabledTest\testDisabled(), ApiDisabledTest\testDisabled(), PasswordResetTest\testExecute_email(), SpecialMyLanguageTest\testFindTitle(), SpecialPageFactoryTest\testGetAliasListRecursion(), UserTest\testGetCanonicalName(), SpecialPageFactoryTest\testGetNames(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testGetNewPasswordExpiry(), SpecialPageFactoryTest\testGetPage(), SpecialPageFactoryTest\testHookNotCalledTwice(), JobTest\testJobFactory(), ApiMainTest\testLacksSameOriginSecurity(), MediaWiki\Session\SessionManagerTest\testLoadSessionInfoFromStore(), ApiQuerySiteinfoTest\testNamespaceAliases(), ApiMainTest\testNonWhitelistedCorsWithCookies(), MediaWiki\Session\CookieSessionProviderTest\testPersistSession(), MediaWiki\Session\CookieSessionProviderTest\testPersistSessionWithHook(), 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(), UserTest\testUserGetRightsHooks(), and MediaWiki\Auth\LegacyHookPreAuthenticationProviderTest\unhook().

◆ mungeSchemaUpdateQuery()

MediaWikiTestCase::mungeSchemaUpdateQuery (   $cmd)
private

Definition at line 1650 of file MediaWikiTestCase.php.

Referenced by setUpSchema().

◆ needsDB()

MediaWikiTestCase::needsDB ( )
Returns
bool
Since
1.18

Definition at line 1119 of file MediaWikiTestCase.php.

Referenced by assertSelect(), 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 2055 of file MediaWikiTestCase.php.

References serialize().

Referenced by assertArrayEquals(), RevisionTest\assertArrayEqualsIgnoringIntKeyOrder(), and MediaWiki\Tests\Storage\RevisionStoreDbTestBase\assertArrayEqualsIgnoringIntKeyOrder().

◆ oncePerClass()

MediaWikiTestCase::oncePerClass ( )
private
Returns
bool

Definition at line 485 of file MediaWikiTestCase.php.

References class.

Referenced by run().

◆ overrideMwServices()

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

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$configOverridesConfiguration 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 950 of file MediaWikiTestCase.php.

References $name, $services, as, MediaWikiServices, and Hooks\run().

Referenced by ApiQueryUserContribsTest\addDBDataOnce(), setService(), UserTest\setUp(), TitlePermissionTest\setUp(), PrefixSearchTest\setUp(), SearchEnginePrefixTest\setUp(), WikiPageDbTestBase\setUp(), RevisionDbTestBase\setUp(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\setUp(), PageArchiveTestBase\setUp(), InterwikiTest\setWgInterwikiCache(), PrefixSearchTest\tearDown(), SearchEnginePrefixTest\tearDown(), SpecialPageFactoryTest\testConflictResolution(), RevisionTest\testConstructFromRowWithBadPageId(), ChangesListSpecialPageTest\testFilterUserExpLevelAllExperienceLevels(), ChangesListSpecialPageTest\testFilterUserExpLevelRegistrered(), ChangesListSpecialPageTest\testFilterUserExpLevelRegistreredOrLearner(), ChangesListSpecialPageTest\testFilterUserExpLevelUnregistrered(), ChangesListSpecialPageTest\testFilterUserExpLevelUnregistreredOrExperienced(), SpecialPageFactoryTest\testGetAliasListRecursion(), SpecialPageFactoryTest\testGetLocalNameFor(), SpecialPageFactoryTest\testGetNames(), SpecialPageFactoryTest\testGetPage(), SpecialPageFactoryTest\testGetTitleForAlias(), SpecialPageFactoryTest\testHookNotCalledTwice(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testInsertRevisionOn_blobAddressExists(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testInsertRevisionOn_successes(), ApiQueryUserContribsTest\testInterwikiUser(), RevisionTest\testLoadFromTitle(), ObjectCacheTest\testNewAnythingNoAccelNoDb(), ObjectCacheTest\testNewAnythingNothingNoDb(), RevisionDbTestBase\testNewKnownCurrent(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testNewNullRevision(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testNewRevisionFromArchiveRow_legacyEncoding(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testNewRevisionFromRow_anonEdit_legacyEncoding(), MediaWikiTestCaseTest\testOverrideMwServices(), ChangesListSpecialPageTest\testRcHidebyothersFilter(), ChangesListSpecialPageTest\testRcHidemyselfFilter(), SpecialPageFactoryTest\testResolveAlias(), ApiQueryUserContribsTest\testSorting(), and RevisionTest\testUserJoinCond().

◆ prepareConnectionForTesting()

MediaWikiTestCase::prepareConnectionForTesting ( IMaintainableDatabase  $db)
protected

Prepares the given database connection for usage in the context of usage tests.

This sets up clones database tables and changes the table prefix as appropriate. If the database connection already has cloned tables, calling this method has no effect. The tables are not re-cloned or reset in that case.

Parameters
IMaintainableDatabase$db

Definition at line 1302 of file MediaWikiTestCase.php.

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

◆ prepareServices()

static MediaWikiTestCase::prepareServices ( Config  $bootstrapConfig)
static

Prepare service configuration for unit testing.

This calls MediaWikiServices::resetGlobalInstance() to allow some critical services to be overridden for testing.

prepareServices() only needs to be called once, but should be called as early as possible, before any class has a chance to grab a reference to any of the global services instances that get discarded by prepareServices(). Only the first call has any effect, later calls are ignored.

Note
This is called by PHPUnitMaintClass::finalSetup.
See also
MediaWikiServices::resetGlobalInstance()
Parameters
Config$bootstrapConfigThe bootstrap config to use with the new MediaWikiServices. Only used for the first call to this method.
Returns
MediaWikiServices

Definition at line 255 of file MediaWikiTestCase.php.

References $services.

Referenced by PHPUnitMaintClass\execute().

◆ 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 1711 of file MediaWikiTestCase.php.

References ensureMockDatabaseConnection(), listOriginalTables(), Wikimedia\Rdbms\IDatabase\tablePrefix(), and CloneDatabase\useTemporaryTables().

Referenced by undoSchemaOverrides().

◆ resetDB()

MediaWikiTestCase::resetDB (   $db,
  $tablesUsed 
)
private

Empty all tables so they can be repopulated for tests.

Parameters
Database$db,|nullDatabase to reset
array$tablesUsedTables to reset

Definition at line 1733 of file MediaWikiTestCase.php.

References addCoreDBData(), as, TestUserRegistry\clear(), Wikimedia\Rdbms\Database\delete(), Wikimedia\Rdbms\IDatabase\getType(), Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\tableExists(), Wikimedia\Rdbms\Database\tableName(), and true.

Referenced by run().

◆ resetGlobalServices()

static MediaWikiTestCase::resetGlobalServices ( Config  $bootstrapConfig = null)
staticprivate

Reset global services, and install testing environment.

This is the testing equivalent of MediaWikiServices::resetGlobalInstance(). This should only be used to set up the testing environment, not when running unit tests. Use MediaWikiTestCase::overrideMwServices() for that.

See also
MediaWikiServices::resetGlobalInstance()
prepareServices()
MediaWikiTestCase::overrideMwServices()
Parameters
Config | null$bootstrapConfigThe bootstrap config to use with the new MediaWikiServices.
Returns
MediaWikiServices

Definition at line 278 of file MediaWikiTestCase.php.

References $serviceLocator.

◆ 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 782 of file MediaWikiTestCase.php.

References $services, MWNamespace\clearCaches(), and Language\clearCaches().

Referenced by doSetMwGlobals(), and tearDown().

◆ restoreLoggers()

MediaWikiTestCase::restoreLoggers ( )
private

Restores loggers replaced by setLogger().

Since
1.27

Definition at line 1075 of file MediaWikiTestCase.php.

References as.

Referenced by tearDown().

◆ revisionDelete()

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

Revision-deletes a revision.

Parameters
Revision | int$revRevision to delete
array$valueKeys 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$commentDeletion comment

Definition at line 2318 of file MediaWikiTestCase.php.

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

Referenced by ApiParseTest\addDBDataOnce().

◆ run()

MediaWikiTestCase::run ( PHPUnit_Framework_TestResult  $result = null)

◆ setCliArg()

MediaWikiTestCase::setCliArg (   $offset,
  $value 
)
Since
1.18
Parameters
string$offset
mixed$value

Definition at line 1903 of file MediaWikiTestCase.php.

References PHPUnitMaintClass\$additionalOptions, and $value.

◆ setContentLang()

MediaWikiTestCase::setContentLang (   $lang)
Since
1.27
Parameters
string | Language$lang

Definition at line 999 of file MediaWikiTestCase.php.

References $lang, Language\factory(), setMwGlobals(), and setService().

Referenced by MediaWiki\Tests\Maintenance\BackupDumperPageTest\addDBData(), MessageCacheTest\configureLanguages(), HtmlTest\setUp(), StripStateTest\setUp(), LanguageConverterTest\setUp(), MediaWikiLangTestCase\setUp(), TitleTest\setUp(), SampleTest\setUp(), SpecialPageTest\setUp(), EditPageTest\setUp(), ExtraParserTest\setUp(), CategoryMembershipChangeJobTest\setUp(), SubpageImportTitleFactoryTest\setUp(), NamespaceImportTitleFactoryTest\setUp(), NaiveImportTitleFactoryTest\setUp(), MediaWikiTitleCodecTest\setUp(), MagicVariableTest\setUp(), CategoryMembershipChangeTest\setUp(), OutputPageTest\setupCategoryTests(), DifferenceEngineTest\testAddLocalisedTitleTooltips(), SpecialPageFactoryTest\testConflictResolution(), InterwikiTest\testConstructor(), SpecialMyLanguageTest\testFindTitle(), ContentHandlerTest\testGetAutosummary(), SpecialPageFactoryTest\testGetLocalNameFor(), TitleTest\testGetPageViewLanguage(), LanguageConverterTest\testGetPreferredVariantDefaultLanguageVsUrlVariant(), LanguageConverterTest\testGetPreferredVariantHeaderUserVsUrl(), LanguageConverterTest\testGetPreferredVariantUserOptionForForeignLanguage(), 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$newPermsEither 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 1025 of file MediaWikiTestCase.php.

References $value, $wgGroupPermissions, as, global, and stashMwGlobals().

Referenced by ApiUserrightsTest\setPermissions(), ApiMainTest\testCheckExecutePermissionsReadProhibited(), ApiMainTest\testCheckExecutePermissionWriteApiProhibited(), ApiMainTest\testSetCacheModePrivateWiki(), ApiParseTest\testSuppressed(), ApiMoveTest\testSuppressRedirectNoPermission(), ApiMoveTest\testTagsNoPermission(), and ApiQuerySiteinfoTest\testUserGroups().

◆ setLogger()

◆ 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() {}
Parameters
array | string$pairsKey to the global variable, or an array of key/value pairs.
mixed | null$valueValue 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 748 of file MediaWikiTestCase.php.

References $value, and doSetMwGlobals().

Referenced by SearchEngineTest\addDBDataOnce(), EditPageTest\assertEdit(), OutputPageTest\assertTransformCssMediaCase(), ApiFormatBaseTest\encodeData(), mergeMwGlobalArrayValue(), ApiQuerySearchTest\registerMockSearchEngine(), PrefixSearchTest\searchProvision(), SearchEnginePrefixTest\searchProvision(), TitleTest\secureAndSplitGlobals(), ObjectCacheTest\setCacheConfig(), setContentLang(), MWGrantsTest\setUp(), ImagePageTest\setUp(), HtmlTest\setUp(), ObjectCacheTest\setUp(), MediaWikiTest\setUp(), MWTimestampTest\setUp(), ResourceLoaderTest\setUp(), GlobalTest\setUp(), PageLangLogFormatterTest\setUp(), BitmapScalingTest\setUp(), XmlTest\setUp(), FormatMetadataTest\setUp(), BitmapMetadataHandlerTest\setUp(), ContentSecurityPolicyTest\setUp(), MWCryptHKDFTest\setUp(), LanguageConverterTest\setUp(), CategoryChangesRdfTest\setUp(), JpegTest\setUp(), LocalisationCacheTest\setUp(), ContentHandlerTest\setUp(), LocalFileTest\setUp(), ApiUploadTestCase\setUp(), TitleTest\setUp(), ApiQueryTest\setUp(), MWNamespaceTest\setUp(), WfThumbIsStandardTest\setUp(), TemplateParserTest\setUp(), UploadBaseTest\setUp(), UploadFromUrlTest\setUp(), CSSMinTest\setUp(), LinkFilterTest\setUp(), WikiMapTest\setUp(), MessageTest\setUp(), ImagePage404Test\setUp(), SampleTest\setUp(), SpecialPageTest\setUp(), ApiQueryPrefixSearchTest\setUp(), CssContentTest\setUp(), ExifTest\setUp(), SpecialWatchlistTest\setUp(), ApiFormatBaseTest\setUp(), TextContentTest\setUp(), ExifBitmapTest\setUp(), ApiComparePagesTest\setUp(), TiffTest\setUp(), SVGTest\setUp(), RCFeedIntegrationTest\setUp(), ActionTest\setUp(), ExportTest\setUp(), ExifRotationTest\setUp(), MediaWiki\Auth\UserDataAuthenticationRequestTest\setUp(), ApiTestCase\setUp(), DeprecationHelperTest\setUp(), EditPageTest\setUp(), ApiEditPageTest\setUp(), LinkRendererTest\setUp(), ExtraParserTest\setUp(), AbstractChangesListSpecialPageTestCase\setUp(), ChangesListSpecialPageTest\setUp(), UserTest\setUp(), BotPasswordTest\setUp(), RevisionTest\setUp(), CategoryMembershipChangeJobTest\setUp(), SearchEngineTest\setUp(), UserGroupMembershipTest\setUp(), ParserOptionsTest\setUp(), OldChangesListTest\setUp(), WfParseUrlTest\setUp(), TitlePermissionTest\setUp(), NaiveImportTitleFactoryTest\setUp(), SubpageImportTitleFactoryTest\setUp(), PagePropsTest\setUp(), GitInfoTest\setUp(), MediaWikiTitleCodecTest\setUp(), LinksUpdateTest\setUp(), RCCacheEntryFactoryTest\setUp(), PreferencesTest\setUp(), MediaWiki\Auth\AuthManagerTest\setUp(), DefaultPreferencesFactoryTest\setUp(), PrefixSearchTest\setUp(), LogFormatterTest\setUp(), SearchEnginePrefixTest\setUp(), MediaWiki\Session\BotPasswordSessionProviderTest\setUp(), WikiPageDbTestBase\setUp(), RevisionDbTestBase\setUp(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\setUp(), ResourceLoaderTestCase\setUp(), PageArchiveTestBase\setUp(), MediaWiki\Tests\Maintenance\DumpTestCase\setUp(), OutputPageTest\setupCategoryTests(), RepoGroupTest\setUpForeignRepo(), ApiParseTest\setupInterwiki(), setUserLang(), InterwikiTest\setWgInterwikiCache(), DeferredUpdatesTest\testAddCallableUpdate(), DeferredUpdatesTest\testAddMergeable(), ApiFormatBaseTest\testApiFrameOptions(), FileBackendTest\testAsyncWrites(), MediaWiki\Auth\AuthManagerTest\testAutoAccountCreation(), UserTest\testAutoblockCookieInauthentic(), UserTest\testAutoblockCookieInfiniteExpiry(), UserTest\testAutoblockCookieNoSecretKey(), UserTest\testAutoblockCookies(), UserTest\testAutoblockCookiesDisabled(), BotPasswordTest\testBasics(), ApiBlockTest\testBlockWithProhibitedEmailBlock(), ApiBlockTest\testBlockWithProhibitedTag(), ApiLoginTest\testBotPassword(), UploadStashTest\testBug29408(), SpecialPreferencesTest\testBug41337(), OutputPageTest\testBuildExemptModules(), FileTest\testCanAnimateThumbIfAppropriate(), MediaWiki\Tests\Maintenance\CategoriesRdfTest\testCategoriesDump(), MediaWiki\Auth\AuthManagerTest\testCheckAccountCreatePermissions(), ApiMainTest\testCheckConditionalRequestHeaders(), ApiMainTest\testCheckConditionalRequestHeadersFailed(), ApiMainTest\testCheckMaxLagExceeded(), ApiMainTest\testCheckMaxLagExceededWithHostNames(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testCheckPasswordValidity(), UserTest\testCheckPasswordValidity(), PasswordPolicyChecksTest\testCheckPopularPasswordBlacklist(), ExtraParserTest\testCleanSigDisabled(), SpecialPageFactoryTest\testConflictResolution(), RevisionTest\testConstructFromArray_userSetAsExpected(), RevisionTest\testConstructFromRowWithBadPageId(), MediaWiki\Auth\ThrottlerTest\testConstructor(), ResourceLoaderTest\testConstructRegistrationHook(), ApiQuerySiteinfoTest\testContinuation(), MediaWiki\Session\CookieSessionProviderTest\testCookieData(), ApiEditPageTest\testCreateImageRedirectLoggedIn(), EditPageTest\testCreatePage(), EditPageTest\testCreatePageTrx(), ContentSecurityPolicyTest\testCSPIsEnabled(), ApiQuerySiteinfoTest\testDbReplLagInfo(), GlobalTest\testDebugFunctionTest(), ChangeTagsTest\testDeleteTagsMigrationOld(), ChangeTagsTest\testDeleteTagsMigrationWriteBoth(), ApiDeleteTest\testDeleteWithoutTagPermission(), WebRequestTest\testDetectServer(), ApiFormatBaseTest\testDisable(), ApiParseTest\testDisableTidy(), ApiStructureTest\testDocumentationExists(), WikiPageDbTestBase\testDoEditContent(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testDomainCheck(), SiteStatsUpdateTest\testDoUpdate(), DeferredUpdatesTest\testDoUpdatesCLI(), DeferredUpdatesTest\testDoUpdatesWeb(), MediaWiki\Tests\Maintenance\PopulateChangeTagDefTest\testDryRunMigrationNew(), MediaWiki\Tests\Maintenance\PopulateChangeTagDefTest\testDryRunMigrationWriteBoth(), AutopromoteTest\testEditCountLookupIsSkippedIfRequirementIsZero(), ApiEditPageTest\testEditWithoutTagPermission(), SanitizerTest\testEscapeIdForStuff(), BadTitleErrorTest\testExceptionSetsStatusCode(), ThrottledErrorTest\testExceptionSetsStatusCode(), UserTest\testExperienceLevel(), ExtensionRegistryTest\testExportExtractedDataGlobals(), ApiQuerySiteinfoTest\testExtensions(), SideBarTest\testExternalUrlsRequireADescription(), CentralIdLookupTest\testFactory(), ChangesListSpecialPageTest\testFilterUserExpLevel(), ChangesListSpecialPageTest\testFilterUserExpLevelAllExperienceLevels(), ChangesListSpecialPageTest\testFilterUserExpLevelRegistrered(), ChangesListSpecialPageTest\testFilterUserExpLevelRegistreredOrLearner(), ChangesListSpecialPageTest\testFilterUserExpLevelUnregistrered(), ChangesListSpecialPageTest\testFilterUserExpLevelUnregistreredOrExperienced(), RepoGroupTest\testForEachForeignRepoNone(), LinkerTest\testFormatComment(), LinkerTest\testFormatLinksInComment(), LanguageTest\testFormatNum(), ApiQuerySiteinfoTest\testGeneral(), FileTest\testGenerateBucketsIfNeeded(), RevisionTest\testGetArchiveQueryInfo(), WikitextContentHandlerTest\testGetChangeTag(), ContentHandlerTest\testGetChangeTag(), ContentHandlerTest\testGetContentText_NonTextContent_fail(), ContentHandlerTest\testGetContentText_NonTextContent_ignore(), ContentHandlerTest\testGetContentText_NonTextContent_serialize(), ContentHandlerTest\testGetContentText_Null(), ContentHandlerTest\testGetContentText_TextContent(), TitleTest\testGetFragmentForURL(), WebRequestTest\testGetIP(), WebRequestTest\testGetIpLackOfRemoteAddrThrowAnException(), ResourceLoaderTest\testGetLoadScript(), ResourceLoaderStartUpModuleTest\testGetModuleRegistrations(), TitleTest\testGetPageViewLanguage(), DeferredUpdatesTest\testGetPendingUpdates(), HttpTest\testGetProxy(), RevisionTest\testGetQueryInfo(), SpecialShortpagesTest\testGetQueryInfoRespectsContentNS(), CssContentTest\testGetRedirectTarget(), JavaScriptContentTest\testGetRedirectTarget(), WikiPageDbTestBase\testGetRedirectTarget(), MediaWiki\Session\ImmutableSessionProviderWithCookieTest\testGetSessionIdFromCookie(), ChangeTagsTest\testGetSoftwareTags(), ParserOutputTest\testGetText(), MediaWiki\Tests\EditPage\TextboxBuilderTest\testGetTextboxProtectionCSSClasses(), FileTest\testGetThumbnailBucket(), ResourceLoaderStartUpModuleTest\testGetVersionHash_varyConfig(), WikiMapTest\testGetWiki(), RepoGroupTest\testHasForeignRepoNegative(), RequestContextTest\testImportScopedSession(), MessageTest\testInContentLanguageOverride(), RevisionDbTestBase\testInsertOn_exceptionOnIncomplete(), RevisionDbTestBase\testInsertOn_success(), ImportLogFormatterTest\testInterwikiLogDatabaseRows(), ApiQuerySiteinfoTest\testInterwikiMap(), ApiQueryUserContribsTest\testInterwikiUser(), SanitizerTest\testInvalidFragmentThrows(), UserTest\testIpBlockCookieIgnoredWhenUserLoggedIn(), UserTest\testIpBlockCookieNotSet(), UserTest\testIpBlockCookieSet(), LocalIdLookupTest\testIsAttachedShared(), MWExceptionTest\testisCommandLine(), TextContentTest\testIsCountable(), WikiPageDbTestBase\testIsCountable(), RecentChangeTest\testIsInRCLifespan(), UserTest\testIsLocallyBlockedProxy(), UserTest\testIsPingLimitable(), MergeHistoryTest\testIsValidMerge(), MovePageTest\testIsValidMove(), TitleTest\testIsValidMoveOperation(), MWExceptionTest\testJsonserializeexceptionBacktracingDisabled(), MWExceptionTest\testJsonserializeexceptionBacktracingEnabled(), MWExceptionTest\testJsonserializeexceptionKeys(), ApiQuerySiteinfoTest\testLanguageVariantsDisabled(), LinkerTest\testLinkBeginHook(), LinkerTest\testLinkEndHook(), MediaWiki\Auth\UserDataAuthenticationRequestTest\testLoadFromSubmission(), RevisionTest\testLoadFromTitle(), BotPasswordTest\testLogin(), ResourceLoaderTest\testMakeLoaderImplementScript(), ResourceLoaderTest\testMakeModuleResponseConcat(), JavaScriptContentHandlerTest\testMakeRedirectContent(), CssContentHandlerTest\testMakeRedirectContent(), OutputPageTest\testMakeResourceLoaderLink(), ShellTest\testMakeScriptCommand(), UploadBaseTest\testMaxUploadSize(), MessageTest\testMessageAsParam(), ExifRotationTest\testMetadataAutoRotate(), ExifRotationTest\testMetadataAutoRotateUnsupported(), ExifRotationTest\testMetadataNoAutoRotate(), ChangeTagsTest\testModifyDisplayQuery(), BitmapMetadataHandlerTest\testMultilingualCascade(), ApiQuerySiteinfoTest\testNamespaces(), ObjectCacheTest\testNewAnythingAccel(), ObjectCacheTest\testNewAnythingHash(), ObjectCacheTest\testNewAnythingNoAccel(), ObjectCacheTest\testNewAnythingNoAccelNoDb(), ParserOptionsTest\testNewCanonical(), DatabaseLogEntryTest\testNewFromId(), MailAddressTest\testNewFromUser(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testNewRevisionFromArchiveRow_legacyEncoding(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testNewRevisionFromRow_anonEdit_legacyEncoding(), SanitizerTest\testNoPrimaryFragmentModeThrows(), SanitizerTest\testNoPrimaryFragmentModeThrows2(), LanguageArTest\testNormalize(), LanguageMlTest\testNormalize(), MediaWikiSiteTest\testNormalizePageTitle(), RCFeedIntegrationTest\testNotify(), ApiFormatBaseTest\testNullMimeType(), LinksUpdateTest\testOnAddingAndRemovingCategory_recentChangesRowIsAdded(), LinksUpdateTest\testOnAddingAndRemovingCategoryToTemplates_embeddingPagesAreIgnored(), ParserOptionsTest\testOptionsHash(), MediaWiki\Session\ImmutableSessionProviderWithCookieTest\testPersistSession(), ApiMoveTest\testPingLimiter(), JpegPixelFormatTest\testPixelFormatRendering(), ResourceLoaderModuleTest\testPlaceholderize(), MediaWikiTest\testPostSendJobDoesNotSetCookie(), OutputPageTest\testPreloadLinkHeaders(), DeferredUpdatesTest\testPresendAddOnPostsendRun(), ApiEditPageTest\testProhibitedAnonymousEdit(), ApiEditPageTest\testProhibitedChangeContentModel(), CdnCacheUpdateTest\testPurgeMergeWeb(), ContribsPagerTest\testQueryableRanges(), MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProviderTest\testRangeBlock(), MessageTest\testRawHtmlInMsg(), ChangesListSpecialPageTest\testRcHidebyothersFilter(), ChangesListSpecialPageTest\testRcHidemyselfFilter(), ChangesListSpecialPageTest\testRcHidepatrolledDisabledFilter(), ChangesListSpecialPageTest\testRcHideunpatrolledDisabledFilter(), GlobalTest\testReadOnlyGlobalChange(), ResourceLoaderStartUpModuleTest\testRegistrationsMinified(), ErrorPageErrorTest\testReport(), SideBarTest\testRespectExternallinktarget(), SideBarTest\testRespectWgnofollowlinks(), ApiQuerySiteinfoTest\testRightsInfo(), ExifRotationTest\testRotationRenderingNoAutoRotate(), ClearUserWatchlistJobTest\testRun(), MediaWiki\Tests\Maintenance\PopulateChangeTagDefTest\testRun(), DeferredUpdatesTest\testRunOuterScopeUpdate(), MediaWiki\Tests\Maintenance\PopulateChangeTagDefTest\testRunUpdateHitCountMigrationNew(), MediaWiki\Tests\Maintenance\PopulateChangeTagDefTest\testRunUpdateHitCountMigrationWriteBoth(), DeferredUpdatesTest\testRunUpdateTransactionScope(), SpecialSearchTest\testSearchTermIsNotExpanded(), RevisionTest\testSelectArchiveFields(), RevisionTest\testSelectFields(), MediaWiki\Session\PHPSessionHandlerTest\testSessionHandling(), MediaWikiTestCaseTest\testSetGlobalsAreRestoredOnTearDown(), MediaWikiTestCaseTest\testSetNonExistentGlobalsAreUnsetOnTearDown(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testSetPasswordResetFlag(), MediaWiki\Logger\LegacyLoggerTest\testShouldEmit(), UserTest\testSoftBlockRanges(), ApiQueryUserContribsTest\testSorting(), SpecialSearchTest\testSubPageRedirect(), JpegTest\testSwappingICCProfile(), ChangeTagsTest\testTagUsageStatisticsNewBackend(), ChangeTagsTest\testTagUsageStatisticsNewMigrationOldBackedn(), ChangeTagsTest\testTagUsageStatisticsOldBackend(), SideBarTest\testTestAttributesAssertionHelper(), ApiQueryTest\testTitlePartToKey(), ApiQueryTest\testTitlesGetNormalized(), ApiEditPageTest\testTooBigEdit(), MailAddressTest\testToString(), OutputPageTest\testTransformResourcePath(), ImportTest\testUnknownUserHandling(), ContribsPagerTest\testUnqueryableRanges(), LinksUpdateTest\testUpdate_categorylinks(), LinksUpdateTest\testUpdate_langlinks(), LinksUpdateTest\testUpdate_page_props_without_sortkey(), EditPageTest\testUpdatePage(), EditPageTest\testUpdatePageTrx(), JavaScriptContentTest\testUpdateRedirect(), ChangeTagsTest\testUpdateTagsMigrationOld(), ChangeTagsTest\testUpdateTagsMigrationWriteBoth(), ApiUploadTest\testUploadChunks(), ApiUploadTest\testUploadStash(), MWExceptionTest\testUseMessageCache(), MWExceptionTest\testUseOutputPage(), TimeAdjustTest\testUserAdjust(), TitlePermissionTest\testUserBlock(), RevisionDbTestBase\testUserCan(), RevisionDbTestBase\testUserCanBitfield(), ApiQuerySiteinfoTest\testUserGroups(), RevisionTest\testUserJoinCond(), LinkerTest\testUserLink(), ResourceLoaderModuleTest\testValidateScriptFile(), WfExpandUrlTest\testWfExpandUrl(), TitleTest\testWgWhitelistReadRegexp(), AutoLoaderTest\testWrongCaseClass(), AutoLoaderTest\testWrongCaseSerializedClass(), and GlobalTest\wfWikiID().

◆ 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 694 of file MediaWikiTestCase.php.

References $name, doSetMwGlobals(), overrideMwServices(), and use.

Referenced by ApiMainTest\doTestCheckMaxLag(), RevisionTest\overrideCommentStoreAndActorMigration(), ApiOpenSearchTest\replaceSearchEngine(), ApiOpenSearchTest\replaceSearchEngineConfig(), TitleTest\secureAndSplitGlobals(), setContentLang(), ApiParseTest\setupSkin(), RevisionTest\testCompressRevisionTextUtf8Gzip(), RevisionTest\testConstructFromRow(), ApiQuerySiteinfoTest\testDbReplLagInfo(), RevisionTest\testDecompressRevisionText(), ExternalStoreTest\testExternalFetchFromURL_noExternalStores(), ExternalStoreTest\testExternalFetchFromURL_someExternalStore(), RevisionTest\testGetArchiveQueryInfo(), WebRequestTest\testGetIP(), WebRequestTest\testGetIpLackOfRemoteAddrThrowAnException(), RevisionTest\testGetQueryInfo(), RevisionTest\testGetRevisionText_external_noOldId(), RevisionTest\testGetRevisionText_external_oldId(), RevisionTest\testGetRevisionWithGzipAndLegacyEncoding(), RevisionTest\testGetRevisionWithLegacyEncoding(), MediaWiki\Tests\Storage\RevisionStoreTest\testGetTitle_correctFallbackAndthrowsExceptionAfterFallbacks(), MediaWiki\Tests\Storage\RevisionStoreTest\testGetTitle_successFromPageId(), MediaWiki\Tests\Storage\RevisionStoreTest\testGetTitle_successFromPageIdOnFallback(), MediaWiki\Tests\Storage\RevisionStoreTest\testGetTitle_successFromRevId(), MediaWiki\Tests\Storage\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\Storage\RevisionStoreDbTestBase\testNewMutableRevisionFromArray_legacyEncoding(), 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$hookNameHook name
mixed$handlerValue suitable for a hook handler
Since
1.28

Definition at line 2265 of file MediaWikiTestCase.php.

References $handler, and mergeMwGlobalArrayValue().

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

◆ setUp()

MediaWikiTestCase::setUp ( )
protected

◆ setupAllTestDBs()

MediaWikiTestCase::setupAllTestDBs ( )

Set up all test DBs.

Definition at line 1389 of file MediaWikiTestCase.php.

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

Referenced by run().

◆ setUpBeforeClass()

static MediaWikiTestCase::setUpBeforeClass ( )
static

Definition at line 144 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$dbDatabase to use
string | null$prefixPrefix 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 1351 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$testPrefixPrefix for test tables. Will be determined automatically if not given.

Definition at line 1463 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 1590 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$dbThe database connection
string$prefixThe prefix to use for the new table set (aka schema).
Exceptions
MWExceptionIf the database table prefix is already $prefix

Definition at line 1429 of file MediaWikiTestCase.php.

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

Referenced by ParserTestTopLevelSuite\setUp().

◆ setUserLang()

◆ 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$globalKeysKey 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

Definition at line 834 of file MediaWikiTestCase.php.

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

Referenced by doSetMwGlobals(), GlobalVarConfigTest\maybeStashGlobal(), setGroupPermissions(), ApiUserrightsTest\setPermissions(), LocalIdLookupTest\setUp(), MediaWiki\Auth\AuthManagerTest\testAutoAccountCreation(), MediaWiki\Auth\AuthManagerTest\testCheckAccountCreatePermissions(), ApiQuerySiteinfoTest\testFileExtensions(), ApiMoveTest\testMoveSubpages(), MediaWiki\Auth\TemporaryPasswordAuthenticationRequestTest\testNewRandom(), ApiMoveTest\testPingLimiter(), MediaWikiTestCaseTest\testStashedGlobalsAreRestoredOnTearDown(), and ApiUserrightsTest\testWithoutTagPermission().

◆ 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&$rThe array to remove string keys from.

Definition at line 2073 of file MediaWikiTestCase.php.

References as.

◆ tearDown()

◆ 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 1274 of file MediaWikiTestCase.php.

References $type, $wgJobClasses, as, CloneDatabase\changePrefix(), global, Hooks\run(), and JobQueueGroup\singleton().

Referenced by MediaWikiPHPUnitBootstrap\__destruct().

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

Definition at line 679 of file MediaWikiTestCase.php.

References class.

◆ 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 1562 of file MediaWikiTestCase.php.

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

Referenced by setUpSchema().

◆ unprefixTable()

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

Definition at line 1808 of file MediaWikiTestCase.php.

◆ usesTemporaryTables()

MediaWikiTestCase::usesTemporaryTables ( )
Since
1.21
Returns
bool

Definition at line 503 of file MediaWikiTestCase.php.

Referenced by ApiQueryUserContribsTest\testSorting().

◆ wfResetOutputBuffersBarrier()

static MediaWikiTestCase::wfResetOutputBuffersBarrier (   $buffer)
static

Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.

Parameters
string$buffer
Returns
string

Definition at line 2254 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 43 of file MediaWikiTestCase.php.

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

◆ $db

Database MediaWikiTestCase::$db
protected

Primary database.

Since
1.18

Definition at line 57 of file MediaWikiTestCase.php.

Referenced by MediaWiki\Tests\Storage\RevisionStoreDbTestBase\getDatabaseMock(), RangeChronologicalPagerTest\getDateRangeCondProvider(), MediaWiki\Tests\Storage\NameTableStoreTest\getMockLoadBalancer(), BatchRowUpdateTest\mockDbConsecutiveSelect(), MediaWiki\Tests\Storage\PreMcrRevisionStoreDbTest\provideGetSlotsQueryInfo(), MediaWiki\Tests\Storage\NoContentModelRevisionStoreDbTest\provideGetSlotsQueryInfo(), MediaWiki\Tests\Storage\McrWriteBothRevisionStoreDbTest\provideGetSlotsQueryInfo(), CommentStoreTest\provideInsertRoundTrip(), ActorMigrationTest\provideInsertRoundTrip(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testDomainCheck(), UserTest\testExperienceLevel(), ReverseChronologicalPagerTest\testGetDateCond(), MediaWiki\Tests\Storage\RevisionStoreTest\testGetTitle_correctFallbackAndthrowsExceptionAfterFallbacks(), MediaWiki\Tests\Storage\RevisionStoreTest\testGetTitle_successFromPageId(), MediaWiki\Tests\Storage\RevisionStoreTest\testGetTitle_successFromPageIdOnFallback(), MediaWiki\Tests\Storage\RevisionStoreTest\testGetTitle_successFromRevId(), MediaWiki\Tests\Storage\RevisionStoreTest\testGetTitle_successFromRevIdOnFallback(), WatchedItemQueryServiceUnitTest\testGetWatchedItemsWithRecentChangeInfo_extension(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testInsertRevisionOn_archive(), LBFactoryTest\testInvalidSelectDB(), RevisionTest\testLoadFromTitle(), DatabaseLogEntryTest\testNewFromId(), RevisionDbTestBase\testNewKnownCurrent(), RevisionDbTestBase\testNewKnownCurrent_returnsFalseWhenTitleDoesntExist(), RevisionDbTestBase\testNewKnownCurrent_withPageId(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testNewRevisionFromArchiveRow(), MediaWiki\Tests\Storage\RevisionStoreDbTestBase\testNewRevisionFromArchiveRow_legacyEncoding(), LBFactoryTest\testNiceDomains(), BatchRowUpdateTest\testReaderBasicIterate(), BatchRowUpdateTest\testReaderSelectConditionsMultiplePrimaryKeys(), BatchRowUpdateTest\testReaderSetFetchColumns(), LBFactoryTest\testTrickyDomain(), ImportTest\testUnknownUserHandling(), and BatchRowUpdateTest\testWriterBasicFunctionality().

◆ $dbSetup

MediaWikiTestCase::$dbSetup = false
staticprivate

Definition at line 67 of file MediaWikiTestCase.php.

◆ $interwikiTable

IResultWrapper MediaWikiTestCase::$interwikiTable = null
private

Holds original contents of interwiki table.

Definition at line 104 of file MediaWikiTestCase.php.

◆ $loggers

LoggerInterface [] MediaWikiTestCase::$loggers = []
private

Holds original loggers which have been replaced by setLogger()

Definition at line 110 of file MediaWikiTestCase.php.

◆ $mwGlobals

array MediaWikiTestCase::$mwGlobals = []
private

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

See also setMwGlobals().

Definition at line 91 of file MediaWikiTestCase.php.

◆ $mwGlobalsToUnset

array MediaWikiTestCase::$mwGlobalsToUnset = []
private

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

See also setMwGlobals().

Definition at line 98 of file MediaWikiTestCase.php.

◆ $oldTablePrefix

MediaWikiTestCase::$oldTablePrefix = ''
staticprivate

Definition at line 68 of file MediaWikiTestCase.php.

◆ $phpErrorLevel

int MediaWikiTestCase::$phpErrorLevel
private

Original value of PHP's error_reporting setting.

Definition at line 75 of file MediaWikiTestCase.php.

◆ $reuseDB

MediaWikiTestCase::$reuseDB = false
staticprivate

Definition at line 66 of file MediaWikiTestCase.php.

◆ $schemaOverrideDefaults

MediaWikiTestCase::$schemaOverrideDefaults
staticprivate
Initial value:
= [
'scripts' => []

Definition at line 1530 of file MediaWikiTestCase.php.

◆ $serviceLocator

MediaWikiServices null MediaWikiTestCase::$serviceLocator = null
staticprivate

The service locator created by prepareServices().

This service locator will be restored after each test. Tests that pollute the global service locator instance should use overrideMwServices() to isolate the test.

Definition at line 29 of file MediaWikiTestCase.php.

Referenced by resetGlobalServices().

◆ $supportedDBs

array MediaWikiTestCase::$supportedDBs
protected
Initial value:
= [
'mysql',
'sqlite',
'postgres',
'oracle'
]
Since
1.18

Definition at line 122 of file MediaWikiTestCase.php.

Referenced by checkDbIsSupported().

◆ $tablesUsed

array MediaWikiTestCase::$tablesUsed = []
protected
Since
1.19

Definition at line 63 of file MediaWikiTestCase.php.

◆ $tmpFiles

array MediaWikiTestCase::$tmpFiles = []
private

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

Definition at line 83 of file MediaWikiTestCase.php.

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

◆ $users

◆ $useTemporaryTables

MediaWikiTestCase::$useTemporaryTables = true
staticprivate

Definition at line 65 of file MediaWikiTestCase.php.

◆ DB_PREFIX

const MediaWikiTestCase::DB_PREFIX = 'unittest_'

Table name prefixes.

Oracle likes it shorter.

Definition at line 115 of file MediaWikiTestCase.php.

Referenced by TestUser\assertNotReal(), ParserTestTopLevelSuite\setUp(), and ParserTestRunner\setupDatabase().

◆ ORA_DB_PREFIX

const MediaWikiTestCase::ORA_DB_PREFIX = 'ut_'

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