MediaWiki  1.27.2
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. More...
 
 testAssert ($registered, $rights, $assert, $error)
 Tests the assert={user|bot} functionality. More...
 
 testCheckConditionalRequestHeaders ($headers, $conditions, $status, $post=false)
 Test HTTP precondition headers. More...
 
 testClassNamesInModuleManager ()
 Test if all classes in the main module manager exists. More...
 
 testConditionalRequestHeadersOutput ($conditions, $headers, $isError=false, $post=false)
 Test conditional headers output provideConditionalRequestHeadersOutput. More...
 
 testLacksSameOriginSecurity ()
 ApiMain::lacksSameOriginSecurity. 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...
 
 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)
 
 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 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. More...
 
static listTables ($db)
 
static setupTestDB (DatabaseBase $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 ($user= 'sysop')
 
 editPage ($pageName, $text, $summary= '', $defaultNs=NS_MAIN)
 Edits or creates a page/revision. More...
 
 getTokenList ($user, $session=null)
 
 setUp ()
 
 tearDown ()
 
- Protected Member Functions inherited from MediaWikiLangTestCase
 setUp ()
 
- 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...
 
 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 ()
 
 checkHasGzip ()
 Check whether we have the 'gzip' commandline utility, will skip the test whenever "gzip -V" fails. More...
 
 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.')
 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...
 
 setLogger ($channel, LoggerInterface $logger)
 Sets the logger for a specified channel, for the duration of the test. More...
 
 setMwGlobals ($pairs, $value=null)
 
 setUp ()
 
 stashMwGlobals ($globalKeys)
 Stashes the global, will be restored in tearDown() More...
 
 tearDown ()
 
- 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 (DatabaseBase $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
 
array $tablesUsed = [ 'user', 'user_groups', 'user_properties' ]
 
- Protected Attributes inherited from MediaWikiTestCase
DatabaseBase $db
 Primary database. More...
 
array $supportedDBs
 
array $tablesUsed = []
 
- Static Protected Attributes inherited from ApiTestCase
static $apiUrl
 

Detailed Description

API medium.

ApiMain

Definition at line 9 of file ApiMainTest.php.

Member Function Documentation

static ApiMainTest::provideAssert ( )
static

Definition at line 24 of file ApiMainTest.php.

References false.

static ApiMainTest::provideCheckConditionalRequestHeaders ( )
static

Definition at line 121 of file ApiMainTest.php.

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

static ApiMainTest::provideConditionalRequestHeadersOutput ( )
static

Definition at line 224 of file ApiMainTest.php.

ApiMainTest::testApi ( )

Test that the API will accept a FauxRequest and execute.

Definition at line 14 of file ApiMainTest.php.

ApiMainTest::testAssert (   $registered,
  $rights,
  $assert,
  $error 
)

Tests the assert={user|bot} functionality.

ApiMain::checkAsserts provideAssert

Parameters
bool$registered
array$rights
string$assert
string | bool$errorFalse if no error expected

Definition at line 44 of file ApiMainTest.php.

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

ApiMainTest::testCheckConditionalRequestHeaders (   $headers,
  $conditions,
  $status,
  $post = false 
)

Test HTTP precondition headers.

ApiMain::checkConditionalRequestHeaders provideCheckConditionalRequestHeaders

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

Definition at line 93 of file ApiMainTest.php.

References $context, $request, $ret, $status, TestingAccessWrapper\newFromObject(), and use.

ApiMainTest::testClassNamesInModuleManager ( )

Test if all classes in the main module manager exists.

Definition at line 64 of file ApiMainTest.php.

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

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

Test conditional headers output provideConditionalRequestHeadersOutput.

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

Definition at line 192 of file ApiMainTest.php.

References $request, $response, as, TestingAccessWrapper\newFromObject(), and use.

ApiMainTest::testLacksSameOriginSecurity ( )

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