API Database medium. More...

Inheritance diagram for ApiBaseTest:

[legend]

Collaboration diagram for ApiBaseTest:

[legend]

Public Member Functions
	provideStubMethods ()

	testDieStatus ()

	testErrorArrayToStatus ()

	testExtractRequestParams ()
	ApiBase::extractRequestParams.

	testGetParameter ()

	testGetParameterFromSettings_noprefix ( $input, $paramSettings, $expected, $warnings, $options=[])
	provideGetParameterFromSettings

	testGetParameterFromSettings_prefix ( $input, $paramSettings, $expected, $warnings, $options=[])
	provideGetParameterFromSettings

	testGetTitleFromTitleOrPageIdBadParams ()

	testGetTitleFromTitleOrPageIdInvalidPageId ()

	testGetTitleFromTitleOrPageIdInvalidTitle ()

	testGetTitleFromTitleOrPageIdPageId ()

	testGetTitleFromTitleOrPageIdTitle ()

	testGetTitleOrPageIdBadParams ()

	testGetTitleOrPageIdInvalidPageId ()

	testGetTitleOrPageIdInvalidTitle ()

	testGetTitleOrPageIdPageId ()

	testGetTitleOrPageIdSpecialTitle ()

	testGetTitleOrPageIdTitle ()

	testRequireAtLeastOneParameterOne ()

	testRequireAtLeastOneParameterTwo ()

	testRequireAtLeastOneParameterZero ()

	testRequireMaxOneParameterOne ()

	testRequireMaxOneParameterTwo ()

	testRequireMaxOneParameterZero ()

	testRequireOnlyOneParameterDefault ()

	testRequireOnlyOneParameterMissing ()

	testRequireOnlyOneParameterTrue ()
	ApiUsageException.

	testRequireOnlyOneParameterZero ()
	ApiUsageException.

	testStubMethods ( $expected, $method, $args=[])
	This covers a variety of stub methods that return a fixed value.

Public Member Functions inherited from ApiTestCase
	testApiTestGroup ()
	@coversNothing

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

	__destruct ()

	addDBData ()
	Stub.

	addDBDataOnce ()
	Stub.

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

	dbPrefix ()

	getCliArg ( $offset)

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

	needsDB ()

	run (PHPUnit_Framework_TestResult $result=null)

	setCliArg ( $offset, $value)

	setContentLang ( $lang)

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

	setupAllTestDBs ()
	Set up all test DBs.

	setUserLang ( $lang)

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

	usesTemporaryTables ()

Static Public Member Functions
static	provideGetParameterFromSettings ()

Static Public Member Functions inherited from ApiTestCase
static	apiExceptionHasCode (ApiUsageException $ex, $code)

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

static	getTestPrefixFor (IDatabase $db)

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

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

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

static	listTables (IMaintainableDatabase $db)

static	prepareServices (Config $bootstrapConfig)

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

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

static	setUpBeforeClass ()

static	setupTestDB (Database $db, $prefix)
	Creates an empty skeleton of the wiki database by cloning its structure to equivalent tables using the given $prefix.

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

static	wfResetOutputBuffersBarrier ( $buffer)
	Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.

Private Member Functions
	doGetParameterFromSettings ( $input, $paramSettings, $expected, $warnings, $options=[])

Additional Inherited Members
Public Attributes inherited from MediaWikiTestCase
const	DB_PREFIX = 'unittest_'
	Table name prefixes.

const	ORA_DB_PREFIX = 'ut_'

Static Public Attributes inherited from MediaWikiTestCase
static TestUser[]	$users

Protected Member Functions inherited from ApiTestCase
	doApiRequest (array $params, array $session=null, $appendModule=false, User $user=null, $tokenType=null)
	Does the API request and returns the result.

	doApiRequestWithToken (array $params, array $session=null, User $user=null, $tokenType='auto')
	Convenience function to access the token parameter of doApiRequest() more succinctly.

	doLogin ( $testUser=null)
	Previously this would do API requests to log in, as well as setting $wgUser and the request context's user.

	getTokenList (TestUser $user, $session=null)

	setExpectedApiException ( $msg, $code=null, array $data=null, $httpCode=0)
	Expect an ApiUsageException to be thrown with the given parameters, which are the same as ApiUsageException::newWithMessage()'s parameters.

	setUp ()

	tearDown ()

Protected Member Functions inherited from MediaWikiTestCase
	addCoreDBData ()

	addTmpFiles ( $files)

	arrayWrap (array $elements)
	Utility method taking an array of elements and wrapping each element in its own array.

	assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
	Assert that two arrays are equal.

	assertFileContains ( $fileName, $actualData, $createIfMissing=false, $msg='')
	Check whether file contains given data.

	assertHTMLEquals ( $expected, $actual, $msg='')
	Put each HTML element on its own line and then equals() the results.

	assertSelect ( $table, $fields, $condition, array $expectedRows, array $options=[], array $join_conds=[])
	Asserts that the given database query yields the rows given by $expectedRows.

	assertType ( $type, $actual, $message='')
	Asserts the type of the provided value.

	assertTypeOrValue ( $type, $actual, $value=false, $message='')
	Asserts that the provided variable is of the specified internal type or equals the $value argument.

	checkDbIsSupported ()

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

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

	ensureMockDatabaseConnection (IDatabase $db)

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

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

	getNewTempDirectory ()
	obtains a new temporary directory

	getNewTempFile ()
	Obtains a new temporary file name.

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

	getSchemaOverrides (IMaintainableDatabase $db)
	Stub.

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

	isTestInDatabaseGroup ()

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

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

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

	mergeMwGlobalArrayValue ( $name, $values)
	Merges the given values into a MW global array variable.

	objectAssociativeSort (array &$array)
	Does an associative sort that works for objects.

	overrideMwServices (Config $configOverrides=null, array $services=[])
	Stashes the global instance of MediaWikiServices, and installs a new one, allowing test cases to override settings and services.

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

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

	setLogger ( $channel, LoggerInterface $logger)
	Sets the logger for a specified channel, for the duration of the test.

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

	setService ( $name, $object)
	Sets a service, maintaining a stashed version of the previous service to be restored in tearDown.

	setTemporaryHook ( $hookName, $handler)
	Create a temporary hook handler which will be reset by tearDown.

	stashMwGlobals ( $globalKeys)
	Stashes the global, will be restored in tearDown()

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

Static Protected Member Functions inherited from ApiTestCase
static	getErrorFormatter ()

Static Protected Member Functions inherited from MediaWikiTestCase
static	getExternalStoreDatabaseConnections ()
	Gets master database connections for all of the ExternalStoreDB stores configured in $wgDefaultExternalStore.

static	isUsingExternalStoreDB ()
	Check whether ExternalStoreDB is being used.

static	setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix=null)
	Setups a database with cloned tables using the given prefix.

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

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

Protected Attributes inherited from ApiTestCase
ApiTestContext	$apiContext

Protected Attributes inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

Static Protected Attributes inherited from ApiTestCase
static	$apiUrl

static	$errorFormatter = null

Detailed Description

API Database medium.

ApiBase

Definition at line 12 of file ApiBaseTest.php.

Member Function Documentation

◆ doGetParameterFromSettings()

ApiBaseTest::doGetParameterFromSettings	(	$input,
		$paramSettings,
		$expected,
		$warnings,
		$options = `[]`
	)

private

Parameters

string \| null	$input
array	$paramSettings
mixed	$expected
array	$options	Key-value pairs: 'parseLimits': true\|false 'apihighlimits': true\|false 'internalmode': true\|false 'prefix': true\|false
string[]	$warnings

Definition at line 272 of file ApiBaseTest.php.

References $context, $input, $options, ApiBase\PARAM_SENSITIVE, ApiBase\PARAM_TYPE, and wfTimestamp().

Referenced by testGetParameterFromSettings_noprefix(), and testGetParameterFromSettings_prefix().

◆ provideGetParameterFromSettings()

static ApiBaseTest::provideGetParameterFromSettings ( )

static

◆ provideStubMethods()

ApiBaseTest::provideStubMethods ( )

Definition at line 28 of file ApiBaseTest.php.

◆ testDieStatus()

ApiBaseTest::testDieStatus ( )

Definition at line 1322 of file ApiBaseTest.php.

References ApiTestCase\apiExceptionHasCode().

◆ testErrorArrayToStatus()

ApiBaseTest::testErrorArrayToStatus ( )

Definition at line 1273 of file ApiBaseTest.php.

References $user, ApiMessage\create(), ApiQueryUserInfo\getBlockInfo(), and MediaWikiTestCase\getMutableTestUser().

◆ testExtractRequestParams()

ApiBaseTest::testExtractRequestParams ( )

ApiBase::extractRequestParams.

Definition at line 1361 of file ApiBaseTest.php.

References $context, $request, ApiBase\PARAM_ISMULTI, and ApiBase\PARAM_TEMPLATE_VARS.

◆ testGetParameter()

ApiBaseTest::testGetParameter ( )

Definition at line 223 of file ApiBaseTest.php.

References $context, ApiTestCase\apiExceptionHasCode(), and ApiBase\PARAM_TYPE.

◆ testGetParameterFromSettings_noprefix()

ApiBaseTest::testGetParameterFromSettings_noprefix	(	$input,
		$paramSettings,
		$expected,
		$warnings,
		$options = `[]`
	)

provideGetParameterFromSettings

See also: self::doGetParameterFromSettings()

Definition at line 355 of file ApiBaseTest.php.

References $input, $options, and doGetParameterFromSettings().

◆ testGetParameterFromSettings_prefix()

ApiBaseTest::testGetParameterFromSettings_prefix	(	$input,
		$paramSettings,
		$expected,
		$warnings,
		$options = `[]`
	)

provideGetParameterFromSettings

See also: self::doGetParameterFromSettings()

Definition at line 366 of file ApiBaseTest.php.

References $input, $options, and doGetParameterFromSettings().

◆ testGetTitleFromTitleOrPageIdBadParams()

ApiBaseTest::testGetTitleFromTitleOrPageIdBadParams ( )

Definition at line 187 of file ApiBaseTest.php.

◆ testGetTitleFromTitleOrPageIdInvalidPageId()

ApiBaseTest::testGetTitleFromTitleOrPageIdInvalidPageId ( )

Definition at line 216 of file ApiBaseTest.php.

◆ testGetTitleFromTitleOrPageIdInvalidTitle()

ApiBaseTest::testGetTitleFromTitleOrPageIdInvalidTitle ( )

Definition at line 201 of file ApiBaseTest.php.

◆ testGetTitleFromTitleOrPageIdPageId()

ApiBaseTest::testGetTitleFromTitleOrPageIdPageId ( )

Definition at line 208 of file ApiBaseTest.php.

References MediaWikiTestCase\getExistingTestPage().

◆ testGetTitleFromTitleOrPageIdTitle()

ApiBaseTest::testGetTitleFromTitleOrPageIdTitle ( )

Definition at line 194 of file ApiBaseTest.php.

◆ testGetTitleOrPageIdBadParams()

ApiBaseTest::testGetTitleOrPageIdBadParams ( )

Definition at line 138 of file ApiBaseTest.php.

◆ testGetTitleOrPageIdInvalidPageId()

ApiBaseTest::testGetTitleOrPageIdInvalidPageId ( )

Definition at line 177 of file ApiBaseTest.php.

References MediaWikiTestCase\markTestSkippedIfDbType().

◆ testGetTitleOrPageIdInvalidTitle()

ApiBaseTest::testGetTitleOrPageIdInvalidTitle ( )

Definition at line 152 of file ApiBaseTest.php.

◆ testGetTitleOrPageIdPageId()

ApiBaseTest::testGetTitleOrPageIdPageId ( )

Definition at line 166 of file ApiBaseTest.php.

References MediaWikiTestCase\getExistingTestPage().

◆ testGetTitleOrPageIdSpecialTitle()

ApiBaseTest::testGetTitleOrPageIdSpecialTitle ( )

Definition at line 159 of file ApiBaseTest.php.

◆ testGetTitleOrPageIdTitle()

ApiBaseTest::testGetTitleOrPageIdTitle ( )

Definition at line 145 of file ApiBaseTest.php.

◆ testRequireAtLeastOneParameterOne()

ApiBaseTest::testRequireAtLeastOneParameterOne ( )

Definition at line 122 of file ApiBaseTest.php.

◆ testRequireAtLeastOneParameterTwo()

ApiBaseTest::testRequireAtLeastOneParameterTwo ( )

Definition at line 130 of file ApiBaseTest.php.

◆ testRequireAtLeastOneParameterZero()

ApiBaseTest::testRequireAtLeastOneParameterZero ( )

Definition at line 113 of file ApiBaseTest.php.

◆ testRequireMaxOneParameterOne()

ApiBaseTest::testRequireMaxOneParameterOne ( )

Definition at line 96 of file ApiBaseTest.php.

◆ testRequireMaxOneParameterTwo()

ApiBaseTest::testRequireMaxOneParameterTwo ( )

Definition at line 104 of file ApiBaseTest.php.

◆ testRequireMaxOneParameterZero()

ApiBaseTest::testRequireMaxOneParameterZero ( )

Definition at line 88 of file ApiBaseTest.php.

◆ testRequireOnlyOneParameterDefault()

ApiBaseTest::testRequireOnlyOneParameterDefault ( )

Definition at line 48 of file ApiBaseTest.php.

◆ testRequireOnlyOneParameterMissing()

ApiBaseTest::testRequireOnlyOneParameterMissing ( )

Definition at line 79 of file ApiBaseTest.php.

◆ testRequireOnlyOneParameterTrue()

ApiBaseTest::testRequireOnlyOneParameterTrue ( )

ApiUsageException.

Definition at line 71 of file ApiBaseTest.php.

◆ testRequireOnlyOneParameterZero()

ApiBaseTest::testRequireOnlyOneParameterZero ( )