n.b. More...
Public Member Functions | |
| testLogin () | |
| Testing login XXX this is a funny way of getting session context. | |
| testUpload ( $session) | |
| @depends testLogin | |
| testUploadChunks ( $session) | |
| @depends testLogin | |
| testUploadMissingParams ( $session) | |
| @depends testLogin | |
| testUploadRequiresToken ( $session) | |
| @depends testLogin | |
| testUploadSameContent ( $session) | |
| @depends testLogin | |
| testUploadSameFileName ( $session) | |
| @depends testLogin | |
| testUploadStash ( $session) | |
| @depends testLogin | |
| testUploadZeroLength ( $session) | |
| @depends testLogin | |
 Public Member Functions inherited from ApiUploadTestCase | |
| clearFakeUploads () | |
| Remove traces of previous fake uploads. | |
| deleteFileByContent ( $filePath) | |
| Helper function – given a file on the filesystem, find matching content in the db (and associated articles) and remove them. | |
| deleteFileByFileName ( $fileName) | |
| Helper function – remove files and associated articles with a particular filename. | |
| deleteFileByTitle ( $title) | |
| Helper function – remove files and associated articles by Title. | |
| fakeUploadChunk ( $fieldName, $fileName, $type, & $chunkData) | |
| fakeUploadFile ( $fieldName, $fileName, $type, $filePath) | |
| Fake an upload by dumping the file into temp space, and adding info to $_FILES. | |
| Public Member Functions inherited from ApiTestCase | |
| testApiTestGroup () | |
| @coversNothing | |
| Public Member Functions inherited from MediaWikiTestCase | |
| __construct ( $name=null, array $data=[], $dataName='') | |
| __destruct () | |
| addDBData () | |
| Stub. | |
| addDBDataOnce () | |
| Stub. | |
| copyTestData (IDatabase $source, IDatabase $target) | |
| Copy test data from one database connection to another. | |
| 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) | |
| setGroupPermissions ( $newPerms, $newKey=null, $newValue=null) | |
| Alters $wgGroupPermissions for the duration of the test. | |
| setupAllTestDBs () | |
| Set up all test DBs. | |
| setUserLang ( $lang) | |
| testMediaWikiTestCaseParentSetupCalled () | |
| Make sure MediaWikiTestCase extending classes have called their parent setUp method. | |
| usesTemporaryTables () | |
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. | |
| static | getTestPrefixFor (IDatabase $db) |
| static | getTestSysop () |
| Convenience method for getting an immutable admin test user. | |
| static | getTestUser ( $groups=[]) |
| Convenience method for getting an immutable test user. | |
| static | installMockMwServices (Config $configOverrides=null) |
| Creates a new "mock" MediaWikiServices instance, and installs it. | |
| static | listTables (IMaintainableDatabase $db) |
| static | prepareServices (Config $bootstrapConfig) |
| static | resetNonServiceCaches () |
| Resets some non-service singleton instances and other static caches. | |
| static | restoreMwServices () |
| Restores the original, non-mock MediaWikiServices instance. | |
| static | setUpBeforeClass () |
| static | setupTestDB (IMaintainableDatabase $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. | |
| 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 ApiUploadTestCase | |
| setUp () | |
| Fixture – run before every test. | |
| 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. | |
| doApiRequestWithToken (array $params, array $session=null, User $user=null, $tokenType='auto') | |
| Convenience function to access the token parameter of doApiRequest() more succinctly. | |
| doLogin ( $testUser=null) | |
| Previously this would do API requests to log in, as well as setting $wgUser and the request context's user. | |
| 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. | |
| tearDown () | |
| Protected Member Functions inherited from MediaWikiTestCase | |
| addCoreDBData () | |
| 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. | |
| assertFileContains ( $fileName, $actualData, $createIfMissing=false, $msg='') | |
| Check whether file contains given data. | |
| assertHTMLEquals ( $expected, $actual, $msg='') | |
| Put each HTML element on its own line and then equals() the results. | |
| assertSelect ( $table, $fields, $condition, array $expectedRows, array $options=[], array $join_conds=[]) | |
| 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. | |
| checkDbIsSupported () | |
| checkPHPExtension ( $extName) | |
| Check if $extName is a loaded PHP extension, will skip the test whenever it is not loaded. | |
| editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN) | |
| Edits or creates a page/revision. | |
| ensureMockDatabaseConnection (IDatabase $db) | |
| getDefaultWikitextNS () | |
| Returns the ID of a namespace that defaults to Wikitext. | |
| getExistingTestPage ( $title=null) | |
| Returns a WikiPage representing an existing page. | |
| getNewTempDirectory () | |
| obtains a new temporary directory | |
| getNewTempFile () | |
| Obtains a new temporary file name. | |
| getNonexistingTestPage ( $title=null) | |
| Returns a WikiPage representing a non-existing page. | |
| getSchemaOverrides (IMaintainableDatabase $db) | |
| Stub. | |
| insertPage ( $pageName, $text='Sample page for unit test.', $namespace=null, User $user=null) | |
| Insert a new page. | |
| isTestInDatabaseGroup () | |
| isWikitextNS ( $ns) | |
| Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels. | |
| markTestSkippedIfDbType ( $type) | |
| Skip the test if using the specified database type. | |
| 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. | |
| revisionDelete ( $rev, array $value=[Revision::DELETED_TEXT=> 1], $comment='') | |
| Revision-deletes a revision. | |
| setIniSetting ( $name, $value) | |
| Set an ini setting for the duration of the test. | |
| setLogger ( $channel, LoggerInterface $logger) | |
| Sets the logger for a specified channel, for the duration of the test. | |
| setMwGlobals ( $pairs, $value=null) | |
| Sets a global, maintaining a stashed version of the previous global to be restored in tearDown. | |
| 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() | |
| truncateTable ( $tableName, IDatabase $db=null) | |
| Empties the given table and resets any auto-increment counters. | |
| 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. | |
| static | isUsingExternalStoreDB () |
| Check whether ExternalStoreDB is being used. | |
| static | setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix=null) |
| Setups a database with cloned tables using the given prefix. | |
| static | setupExternalStoreTestDBs ( $testPrefix=null) |
| 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 |
| static | $errorFormatter = null |
Detailed Description
n.b.
Ensure that you can write to the images/ directory as the user that will run tests.
Note for reviewers: this intentionally duplicates functionality already in "ApiSetup" and so on. This framework works better IMO and has less strangeness (such as test cases inheriting from "ApiSetup"...) (and in the case of the other Upload tests, this flat out just actually works... )
- Todo
- Port the other Upload tests, and other API tests to this framework
- Todo
- Broken test, reports false errors from time to time. See https://phabricator.wikimedia.org/T28169
- Todo
- This is pretty sucky... needs to be prettified.
API Database medium Broken
Definition at line 25 of file ApiUploadTest.php.
Member Function Documentation
◆ testLogin()
| ApiUploadTest::testLogin | ( | ) |
Testing login XXX this is a funny way of getting session context.
Definition at line 30 of file ApiUploadTest.php.
References $params, and(), ApiTestCase\doApiRequest(), and list.
◆ testUpload()
| ApiUploadTest::testUpload | ( | $session | ) |
@depends testLogin
Definition at line 100 of file ApiUploadTest.php.
References $e, $params, and(), ApiUploadTestCase\deleteFileByContent(), ApiUploadTestCase\deleteFileByFileName(), ApiTestCase\doApiRequestWithToken(), ApiUploadTestCase\fakeUploadFile(), MediaWikiTestCase\getNewTempDirectory(), and list.
◆ testUploadChunks()
| ApiUploadTest::testUploadChunks | ( | $session | ) |
@depends testLogin
Definition at line 420 of file ApiUploadTest.php.
References $e, $params, and(), ApiUploadTestCase\clearFakeUploads(), copy, ApiUploadTestCase\deleteFileByContent(), ApiUploadTestCase\deleteFileByFileName(), ApiTestCase\doApiRequestWithToken(), ApiUploadTestCase\fakeUploadChunk(), MediaWikiTestCase\getNewTempDirectory(), list, MediaWikiTestCase\setMwGlobals(), and wfDebug().
◆ testUploadMissingParams()
| ApiUploadTest::testUploadMissingParams | ( | $session | ) |
@depends testLogin
Definition at line 81 of file ApiUploadTest.php.
References $e, and(), and ApiTestCase\doApiRequestWithToken().
◆ testUploadRequiresToken()
| ApiUploadTest::testUploadRequiresToken | ( | $session | ) |
@depends testLogin
Definition at line 65 of file ApiUploadTest.php.
References $e, and(), and ApiTestCase\doApiRequest().
◆ testUploadSameContent()
| ApiUploadTest::testUploadSameContent | ( | $session | ) |
@depends testLogin
Definition at line 257 of file ApiUploadTest.php.
References $e, $params, and(), ApiUploadTestCase\deleteFileByContent(), ApiUploadTestCase\deleteFileByFileName(), ApiTestCase\doApiRequestWithToken(), ApiUploadTestCase\fakeUploadFile(), MediaWikiTestCase\getNewTempDirectory(), and list.
◆ testUploadSameFileName()
| ApiUploadTest::testUploadSameFileName | ( | $session | ) |
@depends testLogin
Definition at line 187 of file ApiUploadTest.php.
References $e, $params, and(), ApiUploadTestCase\deleteFileByFileName(), ApiTestCase\doApiRequestWithToken(), ApiUploadTestCase\fakeUploadFile(), MediaWikiTestCase\getNewTempDirectory(), and list.
◆ testUploadStash()
| ApiUploadTest::testUploadStash | ( | $session | ) |
@depends testLogin
Definition at line 337 of file ApiUploadTest.php.
References $e, $params, and(), ApiUploadTestCase\clearFakeUploads(), ApiUploadTestCase\deleteFileByContent(), ApiUploadTestCase\deleteFileByFileName(), ApiTestCase\doApiRequestWithToken(), ApiUploadTestCase\fakeUploadFile(), MediaWikiTestCase\getNewTempDirectory(), list, and MediaWikiTestCase\setMwGlobals().
◆ testUploadZeroLength()
| ApiUploadTest::testUploadZeroLength | ( | $session | ) |
@depends testLogin
Definition at line 151 of file ApiUploadTest.php.
References $e, $params, and(), ApiUploadTestCase\deleteFileByFileName(), ApiTestCase\doApiRequestWithToken(), ApiUploadTestCase\fakeUploadFile(), and MediaWikiTestCase\getNewTempFile().
The documentation for this class was generated from the following file:
- tests/phpunit/includes/api/ApiUploadTest.php
