ApiBaseTest Class Reference
API Database medium. More...
Inheritance diagram for ApiBaseTest:
Collaboration diagram for ApiBaseTest:
Static Public Member Functions | |
| static | provideGetParameterFromSettings () |
 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... | |
Additional Inherited Members | |
| 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 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... | |
| Protected Attributes inherited from ApiTestCase | |
| ApiTestContext | $apiContext |
| Protected Attributes inherited from MediaWikiTestCase | |
| Database | $db |
| Primary database. More... | |
| array | $supportedDBs |
| array | $tablesUsed = [] |
| Static Protected Attributes inherited from ApiTestCase | |
| static | $apiUrl |
| static | $errorFormatter = null |
Detailed Description
API Database medium.
Definition at line 10 of file ApiBaseTest.php.
Member Function Documentation
◆ provideGetParameterFromSettings()
|
static |
Definition at line 76 of file ApiBaseTest.php.
References ApiUsageException\newWithMessage(), ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_REQUIRED, and true.
◆ testDieStatus()
| ApiBaseTest::testDieStatus | ( | ) |
Definition at line 180 of file ApiBaseTest.php.
References ApiTestCase\apiExceptionHasCode(), and StatusValue\newGood().
◆ testErrorArrayToStatus()
| ApiBaseTest::testErrorArrayToStatus | ( | ) |
Definition at line 129 of file ApiBaseTest.php.
References $user, ApiMessage\create(), ApiQueryUserInfo\getBlockInfo(), MediaWikiTestCase\getMutableTestUser(), and StatusValue\newGood().
◆ testGetParameterFromSettings()
| ApiBaseTest::testGetParameterFromSettings | ( | $input, | |
| $paramSettings, | |||
| $expected, | |||
| $warnings | |||
| ) |
provideGetParameterFromSettings
- Parameters
-
string | null $input array $paramSettings mixed $expected string[] $warnings
Definition at line 55 of file ApiBaseTest.php.
◆ testRequireOnlyOneParameterDefault()
| ApiBaseTest::testRequireOnlyOneParameterDefault | ( | ) |
ApiBase::requireOnlyOneParameter.
Definition at line 15 of file ApiBaseTest.php.
◆ testRequireOnlyOneParameterTrue()
| ApiBaseTest::testRequireOnlyOneParameterTrue | ( | ) |
ApiUsageException ApiBase::requireOnlyOneParameter.
Definition at line 40 of file ApiBaseTest.php.
◆ testRequireOnlyOneParameterZero()
| ApiBaseTest::testRequireOnlyOneParameterZero | ( | ) |
ApiUsageException ApiBase::requireOnlyOneParameter.
Definition at line 28 of file ApiBaseTest.php.
The documentation for this class was generated from the following file:
- tests/phpunit/includes/api/ApiBaseTest.php
