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 () | |
| testAllTogether () | |
| Test basic lists. More... | |
| testGenerator () | |
| Test basic lists. More... | |
| testGeneratorRedirects () | |
| Test T53821. More... | |
| testLists () | |
| Test basic lists. More... | |
| testProps () | |
| Test basic props. 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 ApiTestCase | |
| ApiTestContext | $apiContext |
| Protected Attributes inherited from MediaWikiTestCase | |
| Database | $db |
| Primary database. More... | |
| array | $supportedDBs |
| array | $tablesUsed = [] |
Static Private Attributes | |
| static | $allcategories |
| static | $alllinks |
| static | $allpages |
| static | $alltransclusions |
| static | $backlinks |
| static | $categories |
| static | $categorymembers |
| static | $embeddedin |
| static | $generatorAllpages |
| static | $generatorLinks |
| static | $generatorLinksPropLinks |
| 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 | 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 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
These tests validate basic functionality of the api query module.
API Database medium ApiQuery
Definition at line 34 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.
Reimplemented from MediaWikiTestCase.
Definition at line 42 of file ApiQueryBasicTest.php.
References $e, ApiTestCase\editPage(), Title\newFromText(), and NS_TEMPLATE.
◆ testAllTogether()
| ApiQueryBasicTest::testAllTogether | ( | ) |
Test basic lists.
Definition at line 250 of file ApiQueryBasicTest.php.
References ApiQueryTestBase\check(), and ApiQueryTestBase\merge().
◆ testGenerator()
| ApiQueryBasicTest::testGenerator | ( | ) |
Test basic lists.
Definition at line 289 of file ApiQueryBasicTest.php.
References ApiQueryTestBase\check(), and ApiQueryTestBase\merge().
◆ testGeneratorRedirects()
| ApiQueryBasicTest::testGeneratorRedirects | ( | ) |
Test T53821.
Definition at line 329 of file ApiQueryBasicTest.php.
References ApiQueryTestBase\check(), and ApiTestCase\editPage().
◆ testLists()
| ApiQueryBasicTest::testLists | ( | ) |
Test basic lists.
Definition at line 235 of file ApiQueryBasicTest.php.
References ApiQueryTestBase\check().
◆ testProps()
| ApiQueryBasicTest::testProps | ( | ) |
Test basic props.
Definition at line 226 of file ApiQueryBasicTest.php.
References ApiQueryTestBase\check().
Member Data Documentation
◆ $allcategories
|
staticprivate |
Initial value:
= [
[ 'list' => 'allcategories', 'acprefix' => 'AQBT-' ],
[ 'allcategories' => [
[ '*' => 'AQBT-Cat' ],
] ]
]
Definition at line 134 of file ApiQueryBasicTest.php.
◆ $alllinks
|
staticprivate |
Initial value:
= [
[ 'list' => 'alllinks', 'alprefix' => 'AQBT-' ],
[ 'alllinks' => [
[ 'ns' => 0, 'title' => 'AQBT-All' ],
[ 'ns' => 0, 'title' => 'AQBT-Categories' ],
[ 'ns' => 0, 'title' => 'AQBT-Links' ],
[ 'ns' => 0, 'title' => 'AQBT-Templates' ],
] ]
]
Definition at line 115 of file ApiQueryBasicTest.php.
◆ $allpages
|
staticprivate |
Initial value:
= [
[ 'list' => 'allpages', 'apprefix' => 'AQBT-' ],
[ 'allpages' => [
[ 'pageid' => 1, 'ns' => 0, 'title' => 'AQBT-All' ],
[ 'pageid' => 2, 'ns' => 0, 'title' => 'AQBT-Categories' ],
[ 'pageid' => 3, 'ns' => 0, 'title' => 'AQBT-Links' ],
[ 'pageid' => 4, 'ns' => 0, 'title' => 'AQBT-Templates' ],
] ]
]
Definition at line 105 of file ApiQueryBasicTest.php.
◆ $alltransclusions
|
staticprivate |
Initial value:
= [
[ 'list' => 'alltransclusions', 'atprefix' => 'AQBT-' ],
[ 'alltransclusions' => [
[ 'ns' => 10, 'title' => 'Template:AQBT-T' ],
[ 'ns' => 10, 'title' => 'Template:AQBT-T' ],
] ]
]
Definition at line 125 of file ApiQueryBasicTest.php.
◆ $backlinks
|
staticprivate |
Initial value:
= [
[ 'list' => 'backlinks', 'bltitle' => 'AQBT-Links' ],
[ 'backlinks' => [
[ 'pageid' => 1, 'ns' => 0, 'title' => 'AQBT-All' ],
] ]
]
Definition at line 141 of file ApiQueryBasicTest.php.
◆ $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 91 of file ApiQueryBasicTest.php.
◆ $categorymembers
|
staticprivate |
Initial value:
= [
[ 'list' => 'categorymembers', 'cmtitle' => 'Category:AQBT-Cat' ],
[ 'categorymembers' => [
[ 'pageid' => 1, 'ns' => 0, 'title' => 'AQBT-All' ],
[ 'pageid' => 2, 'ns' => 0, 'title' => 'AQBT-Categories' ],
] ]
]
Definition at line 156 of file ApiQueryBasicTest.php.
◆ $embeddedin
|
staticprivate |
Initial value:
= [
[ 'list' => 'embeddedin', 'eititle' => 'Template:AQBT-T' ],
[ 'embeddedin' => [
[ 'pageid' => 1, 'ns' => 0, 'title' => 'AQBT-All' ],
[ 'pageid' => 4, 'ns' => 0, 'title' => 'AQBT-Templates' ],
] ]
]
Definition at line 148 of file ApiQueryBasicTest.php.
◆ $exceptionFromAddDBData
|
protected |
Definition at line 35 of file ApiQueryBasicTest.php.
◆ $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 164 of file ApiQueryBasicTest.php.
◆ $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 186 of file ApiQueryBasicTest.php.
◆ $generatorLinksPropLinks
|
staticprivate |
Initial value:
= [
[ 'prop' => 'links' ],
[ 'pages' => [
'1' => [ 'links' => [
[ 'ns' => 0, 'title' => 'AQBT-Links' ],
] ]
] ]
]
Definition at line 204 of file ApiQueryBasicTest.php.
◆ $generatorLinksPropTemplates
|
staticprivate |
Initial value:
= [
[ 'prop' => 'templates' ],
[ 'pages' => [
'1' => [ 'templates' => [
[ 'ns' => 10, 'title' => 'Template:AQBT-T' ] ] ],
'4' => [ 'templates' => [
[ 'ns' => 10, 'title' => 'Template:AQBT-T' ] ] ],
] ]
]
Definition at line 213 of file ApiQueryBasicTest.php.
◆ $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 63 of file ApiQueryBasicTest.php.
◆ $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 77 of file ApiQueryBasicTest.php.
The documentation for this class was generated from the following file:
- tests/phpunit/includes/api/query/ApiQueryBasicTest.php
