MediaWiki REL1_28
ApiMainTest Class Reference

API medium. More...

Inheritance diagram for ApiMainTest:
Collaboration diagram for ApiMainTest:

Public Member Functions

 testApi ()
 Test that the API will accept a FauxRequest and execute.
 testAssert ( $registered, $rights, $assert, $error)
 Tests the assert={user|bot} functionality.
 testAssertUser ()
 Tests the assertuser= functionality.
 testCheckConditionalRequestHeaders ( $headers, $conditions, $status, $post=false)
 Test HTTP precondition headers.
 testClassNamesInModuleManager ()
 Test if all classes in the main module manager exists.
 testConditionalRequestHeadersOutput ( $conditions, $headers, $isError=false, $post=false)
 Test conditional headers output provideConditionalRequestHeadersOutput.
 testLacksSameOriginSecurity ()
- Public Member Functions inherited from ApiTestCase
 testApiTestGroup ()
- Public Member Functions inherited from MediaWikiTestCase
 __call ( $func, $args)
 __construct ( $name=null, array $data=[], $dataName='')
 __destruct ()
 addDBData ()
 addDBDataOnce ()
 dbPrefix ()
 getCliArg ( $offset)
 hideDeprecated ( $function)
 Don't throw a warning if $function is deprecated and called later.
 needsDB ()
 run (PHPUnit_Framework_TestResult $result=null)
 setCliArg ( $offset, $value)
 setContentLang ( $lang)
 setupAllTestDBs ()
 Set up all test DBs.
 setUserLang ( $lang)
 testMediaWikiTestCaseParentSetupCalled ()
 Make sure MediaWikiTestCase extending classes have called their parent setUp method.
 usesTemporaryTables ()

Static Public Member Functions

static provideAssert ()
static provideCheckConditionalRequestHeaders ()
static provideConditionalRequestHeadersOutput ()
- Static Public Member Functions inherited from MediaWikiTestCase
static assertNotTag ( $matcher, $actual, $message='', $isHtml=true)
static assertTag ( $matcher, $actual, $message='', $isHtml=true)
 Note: we are overriding this method to remove the deprecated error.
static getMutableTestUser ( $groups=[])
 Convenience method for getting a mutable test user.
static getTestSysop ()
 Convenience method for getting an immutable admin test user.
static getTestUser ( $groups=[])
 Convenience method for getting an immutable test user.
static listTables (Database $db)
static prepareServices (Config $bootstrapConfig)
 Prepare service configuration for unit testing.
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.
static teardownTestDB ()
 Restores MediaWiki to using the table set (table prefix) it was using before setupTestDB() was called.
static wfResetOutputBuffersBarrier ( $buffer)
 Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.

Additional Inherited Members

- Public Attributes inherited from MediaWikiTestCase
const DB_PREFIX = 'unittest_'
 Table name prefixes.
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.
 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.
 doLogin ( $testUser='sysop')
 editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
 Edits or creates a page/revision.
 getTokenList (TestUser $user, $session=null)
 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.
 assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
 Assert that two arrays are equal.
 assertHTMLEquals ( $expected, $actual, $msg='')
 Put each HTML element on its own line and then equals() the results.
 assertSelect ( $table, $fields, $condition, array $expectedRows)
 Asserts that the given database query yields the rows given by $expectedRows.
 assertType ( $type, $actual, $message='')
 Asserts the type of the provided value.
 assertTypeOrValue ( $type, $actual, $value=false, $message='')
 Asserts that the provided variable is of the specified internal type or equals the $value argument.
 assertValidHtmlDocument ( $html)
 Asserts that the given string is valid HTML document.
 assertValidHtmlSnippet ( $html)
 Asserts that the given string is a valid HTML snippet.
 checkDbIsSupported ()
 checkPHPExtension ( $extName)
 Check if $extName is a loaded PHP extension, will skip the test whenever it is not loaded.
 getDefaultWikitextNS ()
 Returns the ID of a namespace that defaults to Wikitext.
 getNewTempDirectory ()
 obtains a new temporary directory
 getNewTempFile ()
 Obtains a new temporary file name.
 insertPage ( $pageName, $text='Sample page for unit test.', $namespace=null)
 Insert a new page.
 isWikitextNS ( $ns)
 Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels.
 markTestSkippedIfNoDiff3 ()
 Check, if $wgDiff3 is set and ready to merge Will mark the calling test as skipped, if not ready.
 mergeMwGlobalArrayValue ( $name, $values)
 Merges the given values into a MW global array variable.
 objectAssociativeSort (array &$array)
 Does an associative sort that works for objects.
 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.
 setLogger ( $channel, LoggerInterface $logger)
 Sets the logger for a specified channel, for the duration of the test.
 setMwGlobals ( $pairs, $value=null)
 setService ( $name, $object)
 Sets a service, maintaining a stashed version of the previous service to be restored in tearDown.
 setTemporaryHook ( $hookName, $handler)
 Create a temporary hook handler which will be reset by tearDown.
 stashMwGlobals ( $globalKeys)
 Stashes the global, will be restored in tearDown()
- Static Protected Member Functions inherited from MediaWikiTestCase
static getExternalStoreDatabaseConnections ()
 Gets master database connections for all of the ExternalStoreDB stores configured in $wgDefaultExternalStore.
static isUsingExternalStoreDB ()
 Check whether ExternalStoreDB is being used.
static resetGlobalServices (Config $bootstrapConfig=null)
 Reset global services, and install testing environment.
static setupDatabaseWithTestPrefix (Database $db, $prefix)
 Setups a database with the given prefix.
static setupExternalStoreTestDBs ( $testPrefix)
 Clones the External Store database(s) for testing.
static stripStringKeys (&$r)
 Utility function for eliminating all string keys from an array.
- Protected Attributes inherited from ApiTestCase
ApiTestContext $apiContext
- Protected Attributes inherited from MediaWikiTestCase
Database $db
 Primary database.
array $supportedDBs
array $tablesUsed = []
- Static Protected Attributes inherited from ApiTestCase
static $apiUrl

Detailed Description

API medium.


Definition at line 9 of file ApiMainTest.php.

Member Function Documentation

◆ provideAssert()

static ApiMainTest::provideAssert ( )

Definition at line 24 of file ApiMainTest.php.

References false.

◆ provideCheckConditionalRequestHeaders()

static ApiMainTest::provideCheckConditionalRequestHeaders ( )

Definition at line 144 of file ApiMainTest.php.

References true, TS_MW, TS_RFC2822, and wfTimestamp().

◆ provideConditionalRequestHeadersOutput()

static ApiMainTest::provideConditionalRequestHeadersOutput ( )

Definition at line 247 of file ApiMainTest.php.

◆ testApi()

ApiMainTest::testApi ( )

Test that the API will accept a FauxRequest and execute.

Definition at line 14 of file ApiMainTest.php.

◆ testAssert()

ApiMainTest::testAssert (   $registered,

Tests the assert={user|bot} functionality.

ApiMain::checkAsserts provideAssert

string | bool$errorFalse if no error expected

Definition at line 44 of file ApiMainTest.php.

References $e, $user, and ApiTestCase\doApiRequest().

◆ testAssertUser()

ApiMainTest::testAssertUser ( )

Tests the assertuser= functionality.


Definition at line 66 of file ApiMainTest.php.

References $e, $user, ApiTestCase\doApiRequest(), and MediaWikiTestCase\getTestUser().

◆ testCheckConditionalRequestHeaders()

ApiMainTest::testCheckConditionalRequestHeaders (   $headers,
  $post = false 

Test HTTP precondition headers.

ApiMain::checkConditionalRequestHeaders provideCheckConditionalRequestHeaders

array$headersHTTP headers
array$conditionsReturn data for ApiBase::getConditionalRequestData
int$statusExpected response status
bool$postRequest is a POST

Definition at line 116 of file ApiMainTest.php.

References $context, $request, $ret, $status, and use.

◆ testClassNamesInModuleManager()

ApiMainTest::testClassNamesInModuleManager ( )

Test if all classes in the main module manager exists.

Definition at line 87 of file ApiMainTest.php.

References $modules, $name, $wgAutoloadClasses, $wgAutoloadLocalClasses, as, and global.

◆ testConditionalRequestHeadersOutput()

ApiMainTest::testConditionalRequestHeadersOutput (   $conditions,
  $isError = false,
  $post = false 

Test conditional headers output provideConditionalRequestHeadersOutput.

array$conditionsReturn data for ApiBase::getConditionalRequestData
array$headersExpected output headers
bool$isError$isError flag
bool$postRequest is a POST

Definition at line 215 of file ApiMainTest.php.

References $header, $request, $response, as, and use.

◆ testLacksSameOriginSecurity()

ApiMainTest::testLacksSameOriginSecurity ( )

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