This class has some common functionality for testing query module. More...

Inheritance diagram for ApiQueryTestBase:

Collaboration diagram for ApiQueryTestBase:

Public Attributes
const	PARAM_ASSERT

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

const	ORA_DB_PREFIX = 'ut_'

Protected Member Functions
	assertResult ($exp, $result, $message= '')

	check ($values, array $session=null, $appendModule=false, User $user=null)
	Checks that the request's result matches the expected results. More...

	merge ()
	Merges all requests parameter + expected values into one. More...

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

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

	doLogin ($testUser= 'sysop')

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

	getTokenList (TestUser $user, $session=null)

	setUp ()

	tearDown ()

Protected Member Functions inherited from MediaWikiLangTestCase
	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. More...

	assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
	Assert that two arrays are equal. 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)
	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...

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

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

	checkDbIsSupported ()

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

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

	getNewTempDirectory ()
	obtains a new temporary directory More...

	getNewTempFile ()
	Obtains a new temporary file name. More...

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

	isWikitextNS ($ns)
	Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels. 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...

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

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

	setMwGlobals ($pairs, $value=null)

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

	setUp ()

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

	tearDown ()

Private Member Functions
	mergeExpected (&$all, $item)
	Recursively merges the expected values in the $item into the $all. More...

	validateRequestExpectedPair ($v)
	Check that the parameter is a valid two element array, with the first element being API request and the second - expected result. More...

Static Private Member Functions
static	sanitizeResultArray ($result)
	Recursively ksorts a result array and removes any 'pageid' keys. More...

Additional Inherited Members
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. More...

	addDBDataOnce ()
	Stub. 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)

	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 inherited from MediaWikiTestCase
static	assertNotTag ($matcher, $actual, $message= '', $isHtml=true)

static	assertTag ($matcher, $actual, $message= '', $isHtml=true)
	Note: we are overriding this method to remove the deprecated error. More...

static	getMutableTestUser ($groups=[])
	Convenience method for getting a mutable test user. More...

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

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

static	setUpBeforeClass ()

static	setupTestDB (DatabaseBase $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...

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

static	isUsingExternalStoreDB ()
	Check whether ExternalStoreDB is being used. More...

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

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

static	setupExternalStoreTestDBs ($testPrefix)
	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 inherited from ApiTestCase
ApiTestContext	$apiContext

Protected Attributes inherited from MediaWikiTestCase
DatabaseBase	$db
	Primary database. More...

array	$supportedDBs

array	$tablesUsed = []

Static Protected Attributes inherited from ApiTestCase
static	$apiUrl

Detailed Description

This class has some common functionality for testing query module.

Definition at line 27 of file ApiQueryTestBase.php.

Member Function Documentation

ApiQueryTestBase::assertResult	(	$exp,
		$result,
		$message = `''`
	)

protected

Definition at line 112 of file ApiQueryTestBase.php.

References $e.

Referenced by check(), and ApiQueryContinueTestBase\checkC().

ApiQueryTestBase::check	(		$values,
		array	$session = `null`,
			$appendModule = `false`,
		User	$user = `null`
	)

protected

Checks that the request's result matches the expected results.

Assumes no rawcontinue and a complete batch.

Parameters

array	$values	Array is a two element array( request, expected_results )
array	$session
bool	$appendModule
User	$user

Definition at line 96 of file ApiQueryTestBase.php.

References $req, $user, as, assertResult(), ApiTestCase\doApiRequest(), list, and validateRequestExpectedPair().

Referenced by ApiQueryBasicTest\testAllTogether(), ApiQueryBasicTest\testGenerator(), ApiQueryBasicTest\testGeneratorRedirects(), ApiQueryBasicTest\testLists(), and ApiQueryBasicTest\testProps().

ApiQueryTestBase::merge ( )

protected

Merges all requests parameter + expected values into one.

Parameters

array $v,... List of arrays, each of which contains exactly two

Returns: array

Definition at line 40 of file ApiQueryTestBase.php.

References $req, $request, as, list, mergeExpected(), and validateRequestExpectedPair().

Referenced by ApiQueryBasicTest\testAllTogether(), and ApiQueryBasicTest\testGenerator().

ApiQueryTestBase::mergeExpected	(	&	$all,
			$item
	)

private

Recursively merges the expected values in the $item into the $all.

Parameters

array	&$all
array	$item

Definition at line 74 of file ApiQueryTestBase.php.

References as.

Referenced by merge().

static ApiQueryTestBase::sanitizeResultArray ( $result )

staticprivate

Recursively ksorts a result array and removes any 'pageid' keys.

Parameters

array $result

Returns: array

Definition at line 147 of file ApiQueryTestBase.php.

References $value, and as.

ApiQueryTestBase::validateRequestExpectedPair ( $v )

private

Check that the parameter is a valid two element array, with the first element being API request and the second - expected result.

Parameters

array $v

Returns: array

Definition at line 58 of file ApiQueryTestBase.php.

Referenced by check(), and merge().

Member Data Documentation

const ApiQueryTestBase::PARAM_ASSERT

Initial value:

= <<<STR
Each parameter must be an array of two elements,
first - an array of params to the API call,
and the second array - expected results as returned by the API
STR

Definition at line 29 of file ApiQueryTestBase.php.

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

tests/phpunit/includes/api/query/ApiQueryTestBase.php

Public Attributes

Protected Member Functions

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation