API Database medium. More...

Inheritance diagram for ApiOptionsTest:

[legend]

Collaboration diagram for ApiOptionsTest:

[legend]

Public Member Functions
	getOptionKinds (IContextSource $context, $options=null)

	hookGetPreferences ( $user, &$preferences)

	testAnon ()

	testChange ()

	testMultiSelect ()

	testNoChanges ()

	testNoOptionname ()

	testNoToken ()
	ApiUsageException.

	testOptionResetValue ()

	testOptionWithValue ()

	testReset ()

	testResetChangeOption ()

	testResetKinds ()

	testSpecialOption ()

	testUnknownOption ()

	testUserjsOption ()

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

	__destruct ()

	addDBData ()
	Stub.

	addDBDataOnce ()
	Stub.

	dbPrefix ()

	getCliArg ( $offset)

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

	needsDB ()

	run (PHPUnit_Framework_TestResult $result=null)

	setCliArg ( $offset, $value)

	setContentLang ( $lang)

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

	setupAllTestDBs ()
	Set up all test DBs.

	setUserLang ( $lang)

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

	usesTemporaryTables ()

Protected Member Functions
	setUp ()

Protected Member Functions inherited from MediaWikiTestCase
	addTmpFiles ( $files)

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

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

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

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

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

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

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

	checkDbIsSupported ()

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

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

	getNewTempDirectory ()
	obtains a new temporary directory

	getNewTempFile ()
	Obtains a new temporary file name.

	getSchemaOverrides (IMaintainableDatabase $db)
	Stub.

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

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

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

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

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

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

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

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

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

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

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

	tearDown ()

Private Member Functions
	executeQuery ( $request)

	getSampleRequest ( $custom=[])

Private Attributes
DerivativeContext	$mContext

	$mSession

ApiOptions	$mTested

PHPUnit_Framework_MockObject_MockObject	$mUserMock

Static Private Attributes
static	$Success = [ 'options' => 'success' ]

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

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

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

static	listTables (IMaintainableDatabase $db)

static	prepareServices (Config $bootstrapConfig)
	Prepare service configuration for unit testing.

static	setUpBeforeClass ()

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

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

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

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

const	ORA_DB_PREFIX = 'ut_'

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

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

static	isUsingExternalStoreDB ()
	Check whether ExternalStoreDB is being used.

static	resetGlobalServices (Config $bootstrapConfig=null)
	Reset global services, and install testing environment.

static	setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix)
	Setups a database with the given prefix.

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

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

Protected Attributes inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

Detailed Description

API Database medium.

ApiOptions

Definition at line 10 of file ApiOptionsTest.php.

Member Function Documentation

◆ executeQuery()

ApiOptionsTest::executeQuery ( $request )

private

Definition at line 141 of file ApiOptionsTest.php.

References $request.

Referenced by testAnon(), testChange(), testMultiSelect(), testNoChanges(), testNoOptionname(), testNoToken(), testOptionResetValue(), testOptionWithValue(), testReset(), testResetChangeOption(), testResetKinds(), testSpecialOption(), testUnknownOption(), and testUserjsOption().

◆ getOptionKinds()

ApiOptionsTest::getOptionKinds	(	IContextSource	$context,
			$options = null )

Parameters

IContextSource	$context
array \| null	$options

Returns: array

Definition at line 98 of file ApiOptionsTest.php.

References $options, and $value.

◆ getSampleRequest()

ApiOptionsTest::getSampleRequest ( $custom = [] )

private

Definition at line 130 of file ApiOptionsTest.php.

References $request.

Referenced by testAnon(), testChange(), testMultiSelect(), testNoChanges(), testNoOptionname(), testNoToken(), testOptionResetValue(), testOptionWithValue(), testReset(), testResetChangeOption(), testResetKinds(), testSpecialOption(), testUnknownOption(), and testUserjsOption().

◆ hookGetPreferences()

ApiOptionsTest::hookGetPreferences	(		$user,
		&	$preferences )

Definition at line 62 of file ApiOptionsTest.php.

◆ setUp()

ApiOptionsTest::setUp ( )

protected

Reimplemented from MediaWikiLangTestCase.

Definition at line 22 of file ApiOptionsTest.php.

References any, and MediaWikiTestCase\mergeMwGlobalArrayValue().

◆ testAnon()

ApiOptionsTest::testAnon ( )

Definition at line 157 of file ApiOptionsTest.php.

References $e, $request, ApiTestCase\apiExceptionHasCode(), executeQuery(), and getSampleRequest().

◆ testChange()

ApiOptionsTest::testChange ( )

Definition at line 277 of file ApiOptionsTest.php.

References $request, $response, executeQuery(), and getSampleRequest().

◆ testMultiSelect()

ApiOptionsTest::testMultiSelect ( )

Definition at line 327 of file ApiOptionsTest.php.

References $request, $response, executeQuery(), and getSampleRequest().

◆ testNoChanges()

ApiOptionsTest::testNoChanges ( )

Definition at line 185 of file ApiOptionsTest.php.

References $e, $request, ApiTestCase\apiExceptionHasCode(), executeQuery(), and getSampleRequest().

◆ testNoOptionname()

ApiOptionsTest::testNoOptionname ( )

Definition at line 173 of file ApiOptionsTest.php.

References $e, $request, ApiTestCase\apiExceptionHasCode(), executeQuery(), and getSampleRequest().

◆ testNoToken()

ApiOptionsTest::testNoToken ( )

ApiUsageException.

Definition at line 151 of file ApiOptionsTest.php.

References $request, executeQuery(), and getSampleRequest().

◆ testOptionResetValue()

ApiOptionsTest::testOptionResetValue ( )

Definition at line 260 of file ApiOptionsTest.php.

References $request, $response, executeQuery(), and getSampleRequest().

◆ testOptionWithValue()

ApiOptionsTest::testOptionWithValue ( )

Definition at line 242 of file ApiOptionsTest.php.

References $request, $response, executeQuery(), and getSampleRequest().

◆ testReset()

ApiOptionsTest::testReset ( )

Definition at line 206 of file ApiOptionsTest.php.

References $request, $response, executeQuery(), and getSampleRequest().

◆ testResetChangeOption()

ApiOptionsTest::testResetChangeOption ( )

Definition at line 301 of file ApiOptionsTest.php.

References $args, $response, executeQuery(), and getSampleRequest().

◆ testResetKinds()

ApiOptionsTest::testResetKinds ( )

Definition at line 224 of file ApiOptionsTest.php.

References $request, $response, executeQuery(), and getSampleRequest().

◆ testSpecialOption()

ApiOptionsTest::testSpecialOption ( )

Definition at line 353 of file ApiOptionsTest.php.

References $request, $response, executeQuery(), and getSampleRequest().

◆ testUnknownOption()

ApiOptionsTest::testUnknownOption ( )

Definition at line 376 of file ApiOptionsTest.php.

References $request, $response, executeQuery(), and getSampleRequest().

◆ testUserjsOption()

ApiOptionsTest::testUserjsOption ( )

Definition at line 399 of file ApiOptionsTest.php.

References $request, $response, executeQuery(), and getSampleRequest().

Member Data Documentation

◆ $mContext

DerivativeContext ApiOptionsTest::$mContext

private

Definition at line 18 of file ApiOptionsTest.php.

◆ $mSession

ApiOptionsTest::$mSession

private

Definition at line 16 of file ApiOptionsTest.php.

◆ $mTested

ApiOptions ApiOptionsTest::$mTested

private

Definition at line 15 of file ApiOptionsTest.php.

◆ $mUserMock

PHPUnit_Framework_MockObject_MockObject ApiOptionsTest::$mUserMock

private

Definition at line 13 of file ApiOptionsTest.php.

◆ $Success

ApiOptionsTest::$Success = [ 'options' => 'success' ]

staticprivate

Definition at line 20 of file ApiOptionsTest.php.

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

tests/phpunit/includes/api/ApiOptionsTest.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ executeQuery()

◆ getOptionKinds()

◆ getSampleRequest()

◆ hookGetPreferences()

◆ setUp()

◆ testAnon()

◆ testChange()

◆ testMultiSelect()

◆ testNoChanges()

◆ testNoOptionname()

◆ testNoToken()

◆ testOptionResetValue()

◆ testOptionWithValue()

◆ testReset()

◆ testResetChangeOption()

◆ testResetKinds()

◆ testSpecialOption()

◆ testUnknownOption()

◆ testUserjsOption()

Member Data Documentation

◆ $mContext

◆ $mSession

◆ $mTested

◆ $mUserMock

◆ $Success