MediaWiki  1.28.1
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. More...
 
 mergeResult (&$results, $newResult, $numericIds=false)
 Recursively merge the new result returned from the query to the previous results. More...
 
 query ($params, $expectedCount, $id, $useContinue=true)
 Run query in a loop until no more values are available. More...
 
- 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. 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.', $namespace=null)
 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...
 
 setTemporaryHook ($hookName, $handler)
 Create a temporary hook handler which will be reset by tearDown. More...
 
 setUp ()
 
 stashMwGlobals ($globalKeys)
 Stashes the global, will be restored in tearDown() More...
 
 tearDown ()
 

Protected Attributes

 $mVerbose = false
 Enable to print in-depth debugging info during the test run. More...
 
- Protected Attributes inherited from ApiTestCase
ApiTestContext $apiContext
 
- Protected Attributes inherited from MediaWikiTestCase
Database $db
 Primary database. More...
 
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 ()
 
- 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 (Database $db)
 
static prepareServices (Config $bootstrapConfig)
 Prepare service configuration for unit testing. More...
 
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. 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...
 
- Public Attributes inherited from ApiQueryTestBase
const PARAM_ASSERT
 
- Public Attributes inherited from MediaWikiTestCase
const DB_PREFIX = 'unittest_'
 Table name prefixes. More...
 
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. 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 (Database $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...
 
- Static Protected Attributes inherited from ApiTestCase
static $apiUrl
 

Detailed Description

Definition at line 24 of file ApiQueryContinueTestBase.php.

Member Function Documentation

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

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

Definition at line 149 of file ApiQueryContinueTestBase.php.

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 166 of file ApiQueryContinueTestBase.php.

References $sort, $value, and as.

Referenced by query().

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

Definition at line 113 of file ApiQueryContinueTestBase.php.

References as, and print.

Referenced by 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 54 of file ApiQueryContinueTestBase.php.

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

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

Member Data Documentation

ApiQueryContinueTestBase::$mVerbose = false
protected

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

Definition at line 29 of file ApiQueryContinueTestBase.php.


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