MediaWiki  master
ApiQueryBasicTest Class Reference

These tests validate basic functionality of the api query module. More...

Inheritance diagram for ApiQueryBasicTest:
Collaboration diagram for ApiQueryBasicTest:

Public Member Functions

 addDBDataOnce ()
 Create a set of pages. More...
 
 testAllTogether ()
 Test basic lists. More...
 
 testGenerator ()
 Test basic lists. More...
 
 testGeneratorRedirects ()
 Test T53821. More...
 
 testLists ()
 Test basic lists. More...
 
static static testProps ()
 Test basic props. More...
 
- Public Member Functions inherited from ApiTestCase
 testApiTestGroup ()
 
- Public Member Functions inherited from MediaWikiTestCase
 __construct ( $name=null, array $data=[], $dataName='')
 
 __destruct ()
 
 addDBData ()
 Stub. More...
 
 addDBDataOnce ()
 Stub. More...
 
 copyTestData (IDatabase $source, IDatabase $target)
 Copy test data from one database connection to another. 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)
 
 setGroupPermissions ( $newPerms, $newKey=null, $newValue=null)
 Alters $wgGroupPermissions for the duration of the test. More...
 
 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 ApiTestCase
ApiTestContext $apiContext
 
- Protected Attributes inherited from MediaWikiTestCase
Database $db
 Primary database. More...
 
array $supportedDBs
 
array $tablesUsed = []
 

Static Private Attributes

static static static static $allcategories
 
static static $alllinks
 
static $allpages
 
static static static $alltransclusions
 
static $backlinks
 
static $categories
 
static static static $categorymembers
 
static static $embeddedin
 
static static static static $generatorAllpages
 
static $generatorLinks
 
static $generatorLinksPropLinks
 
static static $generatorLinksPropTemplates
 
static $links
 
static $templates
 

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 getTestPrefixFor (IDatabase $db)
 
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 installMockMwServices (Config $configOverrides=null)
 Creates a new "mock" MediaWikiServices instance, and installs it. More...
 
static listTables (IMaintainableDatabase $db)
 
static prepareServices (Config $bootstrapConfig)
 
static resetNonServiceCaches ()
 Resets some non-service singleton instances and other static caches. More...
 
static restoreMwServices ()
 Restores the original, non-mock MediaWikiServices instance. More...
 
static setUpBeforeClass ()
 
static setupTestDB (IMaintainableDatabase $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 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 (... $arrays)
 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, $tokenType=null)
 Does the API request and returns the result. More...
 
 doApiRequestWithToken (array $params, array $session=null, User $user=null, $tokenType='auto')
 Convenience function to access the token parameter of doApiRequest() more succinctly. More...
 
 doLogin ( $testUser=null)
 Previously this would do API requests to log in, as well as setting $wgUser and the request context's user. 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 MediaWikiLangTestCase
 setUp ()
 
- Protected Member Functions inherited from MediaWikiTestCase
 addCoreDBData ()
 
 addTmpFiles ( $files)
 
 anythingBut (... $values)
 Returns a PHPUnit constraint that matches anything other than a fixed set of values. More...
 
 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=false, $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, array $options=[], array $join_conds=[])
 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...
 
 checkDbIsSupported ()
 
 checkPHPExtension ( $extName)
 Check if $extName is a loaded PHP extension, will skip the test whenever it is not loaded. More...
 
 editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
 Edits or creates a page/revision. More...
 
 ensureMockDatabaseConnection (IDatabase $db)
 
 getDefaultWikitextNS ()
 Returns the ID of a namespace that defaults to Wikitext. More...
 
 getExistingTestPage ( $title=null)
 Returns a WikiPage representing an existing page. More...
 
 getNewTempDirectory ()
 obtains a new temporary directory More...
 
 getNewTempFile ()
 Obtains a new temporary file name. More...
 
 getNonexistingTestPage ( $title=null)
 Returns a WikiPage representing a non-existing page. More...
 
static getSchemaOverrides (IMaintainableDatabase $db)
 Stub. More...
 
 insertPage ( $pageName, $text='Sample page for unit test.', $namespace=null, User $user=null)
 Insert a new page. More...
 
 isTestInDatabaseGroup ()
 
 isWikitextNS ( $ns)
 Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels. More...
 
 markTestSkippedIfDbType ( $type)
 Skip the test if using the specified database type. 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...
 
 revisionDelete ( $rev, array $value=[Revision::DELETED_TEXT=> 1], $comment='')
 Revision-deletes a revision. More...
 
 setIniSetting ( $name, $value)
 Set an ini setting for the duration of the test. 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...
 
 setUp ()
 
 tearDown ()
 
 truncateTable ( $tableName, IDatabase $db=null)
 Empties the given table and resets any auto-increment counters. 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 setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix=null)
 Setups a database with cloned tables using the given prefix. More...
 
static setupExternalStoreTestDBs ( $testPrefix=null)
 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

These tests validate basic functionality of the api query module.

API Database medium ApiQuery

Definition at line 31 of file ApiQueryBasicTest.php.

Member Function Documentation

◆ addDBDataOnce()

ApiQueryBasicTest::addDBDataOnce ( )

Create a set of pages.

These must not change, otherwise the tests might give wrong results.

See also
MediaWikiTestCase::addDBDataOnce()

Definition at line 39 of file ApiQueryBasicTest.php.

References $e, MediaWikiTestCase\editPage(), Title\newFromText(), and NS_TEMPLATE.

◆ testAllTogether()

ApiQueryBasicTest::testAllTogether ( )

Test basic lists.

Definition at line 245 of file ApiQueryBasicTest.php.

References ApiQueryTestBase\check(), and ApiQueryTestBase\merge().

◆ testGenerator()

ApiQueryBasicTest::testGenerator ( )

Test basic lists.

Definition at line 284 of file ApiQueryBasicTest.php.

References ApiQueryTestBase\check(), and ApiQueryTestBase\merge().

◆ testGeneratorRedirects()

ApiQueryBasicTest::testGeneratorRedirects ( )

Test T53821.

Definition at line 324 of file ApiQueryBasicTest.php.

References ApiQueryTestBase\check(), and MediaWikiTestCase\editPage().

◆ testLists()

ApiQueryBasicTest::testLists ( )

Test basic lists.

Definition at line 232 of file ApiQueryBasicTest.php.

References ApiQueryTestBase\check().

◆ testProps()

static static ApiQueryBasicTest::testProps ( )

Test basic props.

Definition at line 223 of file ApiQueryBasicTest.php.

References ApiQueryTestBase\check().

Member Data Documentation

◆ $allcategories

static static static ApiQueryBasicTest::$allcategories
staticprivate
Initial value:
= [
[ 'list' => 'allcategories', 'acprefix' => 'AQBT-' ],
[ 'allcategories' => [
[ 'category' => 'AQBT-Cat' ],
] ]
]

Definition at line 131 of file ApiQueryBasicTest.php.

◆ $alllinks

static ApiQueryBasicTest::$alllinks
staticprivate
Initial value:
= [
[ 'list' => 'alllinks', 'alprefix' => 'AQBT-' ],
[ 'alllinks' => [
[ 'ns' => 0

Definition at line 112 of file ApiQueryBasicTest.php.

◆ $allpages

ApiQueryBasicTest::$allpages
staticprivate
Initial value:
= [
[ 'list' => 'allpages', 'apprefix' => 'AQBT-' ],
[ 'allpages' => [
[ 'pageid' => 1

Definition at line 102 of file ApiQueryBasicTest.php.

◆ $alltransclusions

static static ApiQueryBasicTest::$alltransclusions
staticprivate
Initial value:
= [
[ 'list' => 'alltransclusions', 'atprefix' => 'AQBT-' ],
[ 'alltransclusions' => [
[ 'ns' => 10

Definition at line 122 of file ApiQueryBasicTest.php.

◆ $backlinks

ApiQueryBasicTest::$backlinks
staticprivate
Initial value:
= [
[ 'list' => 'backlinks', 'bltitle' => 'AQBT-Links' ],
[ 'backlinks' => [
[ 'pageid' => 1

Definition at line 138 of file ApiQueryBasicTest.php.

◆ $categories

ApiQueryBasicTest::$categories
staticprivate
Initial value:
= [
[ 'prop' => 'categories', 'titles' => 'AQBT-All' ],
[ 'pages' => [
'1' => [
'pageid' => 1,
'ns' => 0,
'title' => 'AQBT-All',
'categories' => [
[ 'ns' => 14, 'title' => 'Category:AQBT-Cat' ],
]
]
] ]
]

Definition at line 88 of file ApiQueryBasicTest.php.

◆ $categorymembers

static static ApiQueryBasicTest::$categorymembers
staticprivate
Initial value:
= [
[ 'list' => 'categorymembers', 'cmtitle' => 'Category:AQBT-Cat' ],
[ 'categorymembers' => [
[ 'pageid' => 1

Definition at line 153 of file ApiQueryBasicTest.php.

◆ $embeddedin

static ApiQueryBasicTest::$embeddedin
staticprivate
Initial value:
= [
[ 'list' => 'embeddedin', 'eititle' => 'Template:AQBT-T' ],
[ 'embeddedin' => [
[ 'pageid' => 1

Definition at line 145 of file ApiQueryBasicTest.php.

◆ $exceptionFromAddDBData

ApiQueryBasicTest::$exceptionFromAddDBData
protected

Definition at line 32 of file ApiQueryBasicTest.php.

◆ $generatorAllpages

static static static ApiQueryBasicTest::$generatorAllpages
staticprivate
Initial value:
= [
[ 'generator' => 'allpages', 'gapprefix' => 'AQBT-' ],
[ 'pages' => [
'1' => [
'pageid' => 1,
'ns' => 0,
'title' => 'AQBT-All' ],
'2' => [
'pageid' => 2,
'ns' => 0,
'title' => 'AQBT-Categories' ],
'3' => [
'pageid' => 3,
'ns' => 0,
'title' => 'AQBT-Links' ],
'4' => [
'pageid' => 4,
'ns' => 0,
'title' => 'AQBT-Templates' ],
] ]
]

Definition at line 161 of file ApiQueryBasicTest.php.

◆ $generatorLinks

ApiQueryBasicTest::$generatorLinks
staticprivate
Initial value:
= [
[ 'generator' => 'links', 'titles' => 'AQBT-Links' ],
[ 'pages' => [
'1' => [
'pageid' => 1,
'ns' => 0,
'title' => 'AQBT-All' ],
'2' => [
'pageid' => 2,
'ns' => 0,
'title' => 'AQBT-Categories' ],
'4' => [
'pageid' => 4,
'ns' => 0,
'title' => 'AQBT-Templates' ],
] ]
]

Definition at line 183 of file ApiQueryBasicTest.php.

◆ $generatorLinksPropLinks

ApiQueryBasicTest::$generatorLinksPropLinks
staticprivate
Initial value:
= [
[ 'prop' => 'links' ]

Definition at line 201 of file ApiQueryBasicTest.php.

◆ $generatorLinksPropTemplates

static ApiQueryBasicTest::$generatorLinksPropTemplates
staticprivate
Initial value:
= [
[ 'prop' => 'templates' ]

Definition at line 210 of file ApiQueryBasicTest.php.

◆ $links

ApiQueryBasicTest::$links
staticprivate
Initial value:
= [
[ 'prop' => 'links', 'titles' => 'AQBT-All' ],
[ 'pages' => [
'1' => [
'pageid' => 1,
'ns' => 0,
'title' => 'AQBT-All',
'links' => [
[ 'ns' => 0, 'title' => 'AQBT-Links' ],
]
]
] ]
]

Definition at line 60 of file ApiQueryBasicTest.php.

◆ $templates

ApiQueryBasicTest::$templates
staticprivate
Initial value:
= [
[ 'prop' => 'templates', 'titles' => 'AQBT-All' ],
[ 'pages' => [
'1' => [
'pageid' => 1,
'ns' => 0,
'title' => 'AQBT-All',
'templates' => [
[ 'ns' => 10, 'title' => 'Template:AQBT-T' ],
]
]
] ]
]

Definition at line 74 of file ApiQueryBasicTest.php.


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