MediaWiki  1.30.2
ApiQueryContinueTest Class Reference

Copyright © 2013 Yuri Astrakhan "<Firstname><Lastname>@gmail.com". More...

Inheritance diagram for ApiQueryContinueTest:
Collaboration diagram for ApiQueryContinueTest:

Public Member Functions

 addDBDataOnce ()
 
 test1List ()
 Test smart continue - list=allpages @medium. More...
 
 test2Lists ()
 Test smart continue - list=allpages|alltransclusions @medium. More...
 
 testGen1Prop ()
 Test smart continue - generator=allpages, prop=links @medium. More...
 
 testGen1Prop1List ()
 Test smart continue - generator=allpages, prop=links, list=alltransclusions @medium. More...
 
 testGen2Prop ()
 Test smart continue - generator=allpages, prop=links|templates @medium. More...
 
 testGen2Prop2List1Meta ()
 Test smart continue - generator=allpages, prop=links|templates, list=alllinks|alltransclusions, meta=siteinfo @medium. More...
 
 testSameGenAndProp ()
 Test smart continue - generator=templates, prop=templates @medium. More...
 
 testSameGenList ()
 Test smart continue - generator=allpages, list=allpages @medium. More...
 
- 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...
 
 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 ()
 

Protected Attributes

 $exceptionFromAddDBData
 
- Protected Attributes inherited from ApiQueryContinueTestBase
 $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 = []
 

Additional Inherited Members

- 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. 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 (IMaintainableDatabase $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
 
- Protected Member Functions inherited from ApiQueryContinueTestBase
 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)
 
 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. More...
 
 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. More...
 
 assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
 Assert that two arrays are equal. More...
 
 assertFileContains ( $fileName, $actualData, $createIfMissing=true, $msg='')
 Check whether file contains given data. 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)
 Sets a global, maintaining a stashed version of the previous global to be restored in tearDown. More...
 
 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...
 
 stashMwGlobals ( $globalKeys)
 Stashes the global, will be restored in tearDown() More...
 
- 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. 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 (IMaintainableDatabase $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
 
static $errorFormatter = null
 

Detailed Description

Copyright © 2013 Yuri Astrakhan "<Firstname><Lastname>@gmail.com".

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html These tests validate the new continue functionality of the api query module by doing multiple requests with varying parameters, merging the results, and checking that the result matches the full data received in one no-limits call.

API Database medium ApiQuery

Definition at line 31 of file ApiQueryContinueTest.php.

Member Function Documentation

◆ addDBDataOnce()

ApiQueryContinueTest::addDBDataOnce ( )
  Create a set of pages. These must not change, otherwise the tests might give wrong results.
See also
MediaWikiTestCase::addDBDataOnce()

Reimplemented from MediaWikiTestCase.

Definition at line 39 of file ApiQueryContinueTest.php.

References $e, and ApiTestCase\editPage().

◆ test1List()

ApiQueryContinueTest::test1List ( )

Test smart continue - list=allpages @medium.

Definition at line 61 of file ApiQueryContinueTest.php.

References ApiQueryContinueTestBase\checkC(), ApiQueryContinueTestBase\query(), and true.

◆ test2Lists()

ApiQueryContinueTest::test2Lists ( )

Test smart continue - list=allpages|alltransclusions @medium.

Definition at line 85 of file ApiQueryContinueTest.php.

References ApiQueryContinueTestBase\checkC(), ApiQueryContinueTestBase\query(), and true.

◆ testGen1Prop()

ApiQueryContinueTest::testGen1Prop ( )

Test smart continue - generator=allpages, prop=links @medium.

Definition at line 111 of file ApiQueryContinueTest.php.

References ApiQueryContinueTestBase\checkC(), ApiQueryContinueTestBase\query(), and true.

◆ testGen1Prop1List()

ApiQueryContinueTest::testGen1Prop1List ( )

Test smart continue - generator=allpages, prop=links, list=alltransclusions @medium.

Definition at line 167 of file ApiQueryContinueTest.php.

References ApiQueryContinueTestBase\checkC(), ApiQueryContinueTestBase\query(), and true.

◆ testGen2Prop()

ApiQueryContinueTest::testGen2Prop ( )

Test smart continue - generator=allpages, prop=links|templates @medium.

Definition at line 136 of file ApiQueryContinueTest.php.

References ApiQueryContinueTestBase\checkC(), ApiQueryContinueTestBase\query(), and true.

◆ testGen2Prop2List1Meta()

ApiQueryContinueTest::testGen2Prop2List1Meta ( )

Test smart continue - generator=allpages, prop=links|templates, list=alllinks|alltransclusions, meta=siteinfo @medium.

Definition at line 199 of file ApiQueryContinueTest.php.

References ApiQueryContinueTestBase\checkC(), ApiQueryContinueTestBase\query(), and true.

◆ testSameGenAndProp()

ApiQueryContinueTest::testSameGenAndProp ( )

Test smart continue - generator=templates, prop=templates @medium.

Definition at line 238 of file ApiQueryContinueTest.php.

References ApiQueryContinueTestBase\checkC(), ApiQueryContinueTestBase\query(), and true.

◆ testSameGenList()

ApiQueryContinueTest::testSameGenList ( )

Test smart continue - generator=allpages, list=allpages @medium.

Definition at line 284 of file ApiQueryContinueTest.php.

References ApiQueryContinueTestBase\checkC(), ApiQueryContinueTestBase\query(), and true.

Member Data Documentation

◆ $exceptionFromAddDBData

ApiQueryContinueTest::$exceptionFromAddDBData
protected

Definition at line 32 of file ApiQueryContinueTest.php.


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