API Database medium. More...

Inheritance diagram for ApiMainTest:

[legend]

Collaboration diagram for ApiMainTest:

[legend]

Public Member Functions
	provideExceptionErrors ()

	testApi ()
	Test that the API will accept a FauxRequest and execute.

	testApiErrorFormatterCreation (array $request, array $expect)
	Test proper creation of the ApiErrorFormatter ApiMain::__construct provideApiErrorFormatterCreation.

	testAssert ( $registered, $rights, $assert, $error)
	Tests the assert={user\|bot} functionality.

	testAssertUser ()
	Tests the assertuser= functionality.

	testCheckConditionalRequestHeaders ( $headers, $conditions, $status, $post=false)
	Test HTTP precondition headers.

	testClassNamesInModuleManager ()
	Test if all classes in the main module manager exists.

	testConditionalRequestHeadersOutput ( $conditions, $headers, $isError=false, $post=false)
	Test conditional headers output provideConditionalRequestHeadersOutput.

	testExceptionErrors ( $error, $expectReturn, $expectResult)
	ApiMain::errorMessagesFromException ApiMain::substituteResultWithError provideExceptionErrors.

	testLacksSameOriginSecurity ()
	ApiMain::lacksSameOriginSecurity.

Public Member Functions inherited from ApiTestCase
	testApiTestGroup ()

Public Member Functions inherited from MediaWikiTestCase
	__call ( $func, $args)

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

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

static	provideAssert ()

static	provideCheckConditionalRequestHeaders ()

static	provideConditionalRequestHeadersOutput ()

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

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)
	Does the API request and returns the result.

	doApiRequestWithToken (array $params, array $session=null, User $user=null)
	Add an edit token to the API request This is cheating a bit – we grab a token in the correct format and then add it to the pseudo-session and to the request, without actually requesting a "real" edit token.

	doLogin ( $testUser='sysop')

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

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

	assertValidHtmlDocument ( $html)
	Asserts that the given string is valid HTML document.

	assertValidHtmlSnippet ( $html)
	Asserts that the given string is a valid HTML snippet.

	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.

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

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

ApiMain

Definition at line 12 of file ApiMainTest.php.

Member Function Documentation

◆ provideApiErrorFormatterCreation()

static ApiMainTest::provideApiErrorFormatterCreation ( )

static

Definition at line 338 of file ApiMainTest.php.

◆ provideAssert()

static ApiMainTest::provideAssert ( )

static

Definition at line 27 of file ApiMainTest.php.

References false.

◆ provideCheckConditionalRequestHeaders()

static ApiMainTest::provideCheckConditionalRequestHeaders ( )

static

Definition at line 145 of file ApiMainTest.php.

References true, and wfTimestamp().

◆ provideConditionalRequestHeadersOutput()

static ApiMainTest::provideConditionalRequestHeadersOutput ( )

static

Definition at line 248 of file ApiMainTest.php.

◆ provideExceptionErrors()

ApiMainTest::provideExceptionErrors ( )

Definition at line 481 of file ApiMainTest.php.

References wfExpandUrl(), wfHostname(), wfMessage(), and wfScript().

◆ testApi()

ApiMainTest::testApi ( )

Test that the API will accept a FauxRequest and execute.

Definition at line 17 of file ApiMainTest.php.

◆ testApiErrorFormatterCreation()

ApiMainTest::testApiErrorFormatterCreation	(	array	$request,
		array	$expect )

Test proper creation of the ApiErrorFormatter ApiMain::__construct provideApiErrorFormatterCreation.

Parameters

array	$request	Request parameters
array	$expect	Expected data uselang: ApiMain language class: ApiErrorFormatter class lang: ApiErrorFormatter language format: ApiErrorFormatter format usedb: ApiErrorFormatter use-database flag

Definition at line 322 of file ApiMainTest.php.

References $context, and $request.

◆ testAssert()

ApiMainTest::testAssert	(	$registered,
		$rights,
		$assert,
		$error )

Tests the assert={user|bot} functionality.

ApiMain::checkAsserts provideAssert

Parameters

bool	$registered
array	$rights
string	$assert
string \| bool	$error	False if no error expected

Definition at line 47 of file ApiMainTest.php.

References $e, ApiTestCase\doApiRequest(), and MediaWikiTestCase\getMutableTestUser().

◆ testAssertUser()

ApiMainTest::testAssertUser ( )

Tests the assertuser= functionality.

ApiMain::checkAsserts

Definition at line 72 of file ApiMainTest.php.

References $e, ApiTestCase\doApiRequest(), and MediaWikiTestCase\getTestUser().

◆ testCheckConditionalRequestHeaders()

ApiMainTest::testCheckConditionalRequestHeaders	(	$headers,
		$conditions,
		$status,
		$post = false )

Test HTTP precondition headers.

ApiMain::checkConditionalRequestHeaders provideCheckConditionalRequestHeaders

Parameters

array	$headers	HTTP headers
array	$conditions	Return data for ApiBase::getConditionalRequestData
int	$status	Expected response status
bool	$post	Request is a POST

Definition at line 117 of file ApiMainTest.php.

References $context, $request, $ret, and any.

◆ testClassNamesInModuleManager()

ApiMainTest::testClassNamesInModuleManager ( )

Test if all classes in the main module manager exists.

Definition at line 93 of file ApiMainTest.php.

References $modules.

◆ testConditionalRequestHeadersOutput()

ApiMainTest::testConditionalRequestHeadersOutput	(	$conditions,
		$headers,
		$isError = false,
		$post = false )

Test conditional headers output provideConditionalRequestHeadersOutput.

Parameters

array	$conditions	Return data for ApiBase::getConditionalRequestData
array	$headers	Expected output headers
bool	$isError	$isError flag
bool	$post	Request is a POST

Definition at line 216 of file ApiMainTest.php.

References $header, $request, $response, and any.

◆ testExceptionErrors()

ApiMainTest::testExceptionErrors	(	$error,
		$expectReturn,
		$expectResult )

ApiMain::errorMessagesFromException ApiMain::substituteResultWithError provideExceptionErrors.

Parameters

Exception	$exception
array	$expectReturn
array	$expectResult

Definition at line 453 of file ApiMainTest.php.

References $context, and $ret.

◆ testLacksSameOriginSecurity()

ApiMainTest::testLacksSameOriginSecurity ( )

ApiMain::lacksSameOriginSecurity.

Definition at line 283 of file ApiMainTest.php.

References $request, and MediaWikiTestCase\mergeMwGlobalArrayValue().

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

tests/phpunit/includes/api/ApiMainTest.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ provideApiErrorFormatterCreation()

◆ provideAssert()

◆ provideCheckConditionalRequestHeaders()

◆ provideConditionalRequestHeadersOutput()

◆ provideExceptionErrors()

◆ testApi()

◆ testApiErrorFormatterCreation()

◆ testAssert()

◆ testAssertUser()

◆ testCheckConditionalRequestHeaders()

◆ testClassNamesInModuleManager()

◆ testConditionalRequestHeadersOutput()

◆ testExceptionErrors()

◆ testLacksSameOriginSecurity()