MediaWiki REL1_31
ApiQueryContinueTestBase Class Reference
Inheritance diagram for ApiQueryContinueTestBase:
Collaboration diagram for ApiQueryContinueTestBase:

Protected Member Functions

 checkC ( $expected, $params, $expectedCount, $id, $continue=true)
 Run query() and compare against expected values.
 
 mergeResult (&$results, $newResult, $numericIds=false)
 Recursively merge the new result returned from the query to the previous results.
 
 query ( $params, $expectedCount, $id, $useContinue=true)
 Run query in a loop until no more values are available.
 
- Protected Member Functions inherited from ApiQueryTestBase
 assertResult ( $exp, $result, $message='')
 
 check ( $values, array $session=null, $appendModule=false, User $user=null)
 Checks that the request's result matches the expected results.
 
 merge ()
 Merges all requests parameter + expected values into one.
 
- 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.
 
 editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
 Edits or creates a page/revision.
 
 getTokenList (TestUser $user, $session=null)
 
 revisionDelete ( $rev, array $value=[Revision::DELETED_TEXT=> 1], $comment='')
 Revision-deletes a revision.
 
 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, 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()
 

Protected Attributes

 $mVerbose = false
 Enable to print in-depth debugging info during the test run.
 
- Protected Attributes inherited from ApiTestCase
ApiTestContext $apiContext
 
- Protected Attributes inherited from MediaWikiTestCase
Database $db
 Primary database.
 
array $supportedDBs
 
array $tablesUsed = []
 

Private Member Functions

 printResult ( $data)
 

Static Private Member Functions

static GetItems ( $q, $moduleName, $name, &$print)
 

Additional Inherited Members

- 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.
 
 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 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.
 
- Public Attributes inherited from ApiQueryTestBase
const PARAM_ASSERT =
 
- 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 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.
 
- Static Protected Attributes inherited from ApiTestCase
static $apiUrl
 
static $errorFormatter = null
 

Detailed Description

Definition at line 22 of file ApiQueryContinueTestBase.php.

Member Function Documentation

◆ checkC()

ApiQueryContinueTestBase::checkC ( $expected,
$params,
$expectedCount,
$id,
$continue = true )
protected

Run query() and compare against expected values.

Parameters
array$expected
array$paramsApi parameters
int$expectedCountMax number of iterations
string$idUnit test id
bool$continueTrue to use smart continue
Returns
array Merged results data array

Definition at line 38 of file ApiQueryContinueTestBase.php.

References $params, ApiQueryTestBase\assertResult(), and query.

Referenced by ApiQueryContinueTest\test1List(), ApiQueryContinueTest\test2Lists(), ApiQueryContinue2Test\testA(), ApiQueryContinueTest\testGen1Prop(), ApiQueryContinueTest\testGen1Prop1List(), ApiQueryContinueTest\testGen2Prop(), ApiQueryContinueTest\testGen2Prop2List1Meta(), ApiQueryContinueTest\testSameGenAndProp(), and ApiQueryContinueTest\testSameGenList().

◆ GetItems()

static ApiQueryContinueTestBase::GetItems ( $q,
$moduleName,
$name,
& $print )
staticprivate

Definition at line 147 of file ApiQueryContinueTestBase.php.

Referenced by printResult().

◆ mergeResult()

ApiQueryContinueTestBase::mergeResult ( & $results,
$newResult,
$numericIds = false )
protected

Recursively merge the new result returned from the query to the previous results.

Parameters
mixed&$results
mixed$newResult
bool$numericIdsIf true, treat keys as ids to be merged instead of appending

Definition at line 164 of file ApiQueryContinueTestBase.php.

References $sort, $value, and mergeResult().

Referenced by mergeResult(), and query().

◆ printResult()

ApiQueryContinueTestBase::printResult ( $data)
private
Parameters
array$data

Definition at line 111 of file ApiQueryContinueTestBase.php.

References GetItems(), and print.

Referenced by query().

◆ query()

ApiQueryContinueTestBase::query ( $params,
$expectedCount,
$id,
$useContinue = true )
protected

Run query in a loop until no more values are available.

Parameters
array$paramsApi parameters
int$expectedCountMax number of iterations
string$idUnit test id
bool$useContinueTrue to use smart continue
Returns
array Merged results data array
Exceptions
Exception

Definition at line 52 of file ApiQueryContinueTestBase.php.

References $e, $params, $request, $result, ApiTestCase\doApiRequest(), mergeResult(), print, and printResult().

Member Data Documentation

◆ $mVerbose

ApiQueryContinueTestBase::$mVerbose = false
protected

Enable to print in-depth debugging info during the test run.

Definition at line 27 of file ApiQueryContinueTestBase.php.


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