MediaWiki  REL1_31
ApiBaseTest Class Reference

API Database medium. More...

Inheritance diagram for ApiBaseTest:
Collaboration diagram for ApiBaseTest:

Public Member Functions

 provideStubMethods ()
 
 testDieStatus ()
 
 testErrorArrayToStatus ()
 
 testGetParameterFromSettings ( $input, $paramSettings, $expected, $warnings, $options=[])
 provideGetParameterFromSettings More...
 
 testGetTitleFromTitleOrPageIdBadParams ()
 
 testGetTitleFromTitleOrPageIdInvalidPageId ()
 
 testGetTitleFromTitleOrPageIdInvalidTitle ()
 
 testGetTitleFromTitleOrPageIdPageId ()
 
 testGetTitleFromTitleOrPageIdTitle ()
 
 testGetTitleOrPageIdBadParams ()
 
 testGetTitleOrPageIdInvalidPageId ()
 
 testGetTitleOrPageIdInvalidTitle ()
 
 testGetTitleOrPageIdPageId ()
 
 testGetTitleOrPageIdSpecialTitle ()
 
 testGetTitleOrPageIdTitle ()
 
 testRequireAtLeastOneParameterOne ()
 
 testRequireAtLeastOneParameterTwo ()
 
 testRequireAtLeastOneParameterZero ()
 
 testRequireMaxOneParameterOne ()
 
 testRequireMaxOneParameterTwo ()
 
 testRequireMaxOneParameterZero ()
 
 testRequireOnlyOneParameterDefault ()
 
 testRequireOnlyOneParameterMissing ()
 
 testRequireOnlyOneParameterTrue ()
 ApiUsageException. More...
 
 testRequireOnlyOneParameterZero ()
 ApiUsageException. More...
 
 testStubMethods ( $expected, $method, $args=[])
 This covers a variety of stub methods that return a fixed value. More...
 
- Public Member Functions inherited from ApiTestCase
 testApiTestGroup ()
 @coversNothing More...
 
- Public Member Functions inherited from MediaWikiTestCase
 __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)
 
 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 ()
 

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, $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...
 
 editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
 Edits or creates a page/revision. More...
 
 getTokenList (TestUser $user, $session=null)
 
 revisionDelete ( $rev, array $value=[Revision::DELETED_TEXT=> 1], $comment='')
 Revision-deletes a revision. More...
 
 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, 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...
 
 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...
 
 getSchemaOverrides (IMaintainableDatabase $db)
 Stub. 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.

ApiBase

Definition at line 12 of file ApiBaseTest.php.

Member Function Documentation

◆ provideGetParameterFromSettings()

◆ provideStubMethods()

ApiBaseTest::provideStubMethods ( )

Definition at line 28 of file ApiBaseTest.php.

◆ testDieStatus()

ApiBaseTest::testDieStatus ( )

Definition at line 1239 of file ApiBaseTest.php.

References ApiTestCase\apiExceptionHasCode(), and StatusValue\newGood().

◆ testErrorArrayToStatus()

ApiBaseTest::testErrorArrayToStatus ( )

◆ testGetParameterFromSettings()

ApiBaseTest::testGetParameterFromSettings (   $input,
  $paramSettings,
  $expected,
  $warnings,
  $options = [] 
)

provideGetParameterFromSettings

Parameters
string | null$input
array$paramSettings
mixed$expected
array$optionsKey-value pairs: 'parseLimits': true|false 'apihighlimits': true|false 'internalmode': true|false
string[]$warnings

Definition at line 226 of file ApiBaseTest.php.

References $context, $input, $options, ChangeTags\defineTag(), ApiBase\PARAM_SENSITIVE, ApiBase\PARAM_TYPE, and wfTimestamp().

◆ testGetTitleFromTitleOrPageIdBadParams()

ApiBaseTest::testGetTitleFromTitleOrPageIdBadParams ( )

Definition at line 180 of file ApiBaseTest.php.

References class.

◆ testGetTitleFromTitleOrPageIdInvalidPageId()

ApiBaseTest::testGetTitleFromTitleOrPageIdInvalidPageId ( )

Definition at line 208 of file ApiBaseTest.php.

References class.

◆ testGetTitleFromTitleOrPageIdInvalidTitle()

ApiBaseTest::testGetTitleFromTitleOrPageIdInvalidTitle ( )

Definition at line 194 of file ApiBaseTest.php.

References class.

◆ testGetTitleFromTitleOrPageIdPageId()

ApiBaseTest::testGetTitleFromTitleOrPageIdPageId ( )

Definition at line 201 of file ApiBaseTest.php.

References class, and Title\newFromText().

◆ testGetTitleFromTitleOrPageIdTitle()

ApiBaseTest::testGetTitleFromTitleOrPageIdTitle ( )

Definition at line 187 of file ApiBaseTest.php.

References class.

◆ testGetTitleOrPageIdBadParams()

ApiBaseTest::testGetTitleOrPageIdBadParams ( )

Definition at line 138 of file ApiBaseTest.php.

References class.

◆ testGetTitleOrPageIdInvalidPageId()

ApiBaseTest::testGetTitleOrPageIdInvalidPageId ( )

Definition at line 173 of file ApiBaseTest.php.

References class.

◆ testGetTitleOrPageIdInvalidTitle()

ApiBaseTest::testGetTitleOrPageIdInvalidTitle ( )

Definition at line 152 of file ApiBaseTest.php.

References class.

◆ testGetTitleOrPageIdPageId()

ApiBaseTest::testGetTitleOrPageIdPageId ( )

Definition at line 166 of file ApiBaseTest.php.

References class, and Title\newFromText().

◆ testGetTitleOrPageIdSpecialTitle()

ApiBaseTest::testGetTitleOrPageIdSpecialTitle ( )

Definition at line 159 of file ApiBaseTest.php.

References class.

◆ testGetTitleOrPageIdTitle()

ApiBaseTest::testGetTitleOrPageIdTitle ( )

Definition at line 145 of file ApiBaseTest.php.

References class.

◆ testRequireAtLeastOneParameterOne()

ApiBaseTest::testRequireAtLeastOneParameterOne ( )

Definition at line 122 of file ApiBaseTest.php.

◆ testRequireAtLeastOneParameterTwo()

ApiBaseTest::testRequireAtLeastOneParameterTwo ( )

Definition at line 130 of file ApiBaseTest.php.

◆ testRequireAtLeastOneParameterZero()

ApiBaseTest::testRequireAtLeastOneParameterZero ( )

Definition at line 113 of file ApiBaseTest.php.

References class.

◆ testRequireMaxOneParameterOne()

ApiBaseTest::testRequireMaxOneParameterOne ( )

Definition at line 96 of file ApiBaseTest.php.

◆ testRequireMaxOneParameterTwo()

ApiBaseTest::testRequireMaxOneParameterTwo ( )

Definition at line 104 of file ApiBaseTest.php.

References class.

◆ testRequireMaxOneParameterZero()

ApiBaseTest::testRequireMaxOneParameterZero ( )

Definition at line 88 of file ApiBaseTest.php.

◆ testRequireOnlyOneParameterDefault()

ApiBaseTest::testRequireOnlyOneParameterDefault ( )

Definition at line 48 of file ApiBaseTest.php.

◆ testRequireOnlyOneParameterMissing()

ApiBaseTest::testRequireOnlyOneParameterMissing ( )

Definition at line 79 of file ApiBaseTest.php.

References class.

◆ testRequireOnlyOneParameterTrue()

ApiBaseTest::testRequireOnlyOneParameterTrue ( )

ApiUsageException.

Definition at line 71 of file ApiBaseTest.php.

◆ testRequireOnlyOneParameterZero()

ApiBaseTest::testRequireOnlyOneParameterZero ( )

ApiUsageException.

Definition at line 60 of file ApiBaseTest.php.

◆ testStubMethods()

ApiBaseTest::testStubMethods (   $expected,
  $method,
  $args = [] 
)

This covers a variety of stub methods that return a fixed value.

Parameters
string | array$methodName of method, or [ name, params... ]
string$valueExpected value

provideStubMethods

Definition at line 21 of file ApiBaseTest.php.

References $args.


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