ApiTestCaseUpload Class Reference

Abstract class to support upload tests. More...

Inheritance diagram for ApiTestCaseUpload:

Collaboration diagram for ApiTestCaseUpload:

Public Member Functions
	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 ()
Public Member Functions inherited from MediaWikiTestCase
	__call ( $func, $args)
	__construct ( $name=null, array $data=[], $dataName='')
	__destruct ()
	addDBData ()
	Stub.
	addDBDataOnce ()
	Stub.
	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 ()

Protected Member Functions
	setUp ()
	Fixture – run before every test.
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)
	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
	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=true, $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)
	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)
	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()

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	getTestSysop ()
	Convenience method for getting an immutable admin test user.
static	getTestUser ( $groups=[])
	Convenience method for getting an immutable test user.
static	listTables (IMaintainableDatabase $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.
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
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	resetGlobalServices (Config $bootstrapConfig=null)
	Reset global services, and install testing environment.
static	setupDatabaseWithTestPrefix (IMaintainableDatabase $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
static	$errorFormatter = null

Detailed Description

Abstract class to support upload tests.

Definition at line 6 of file ApiTestCaseUpload.php.

Member Function Documentation

clearFakeUploads()

ApiTestCaseUpload::clearFakeUploads

(

)

Remove traces of previous fake uploads.

Definition at line 150 of file ApiTestCaseUpload.php.

Referenced by setUp(), ApiUploadTest\testUploadChunks(), and ApiUploadTest\testUploadStash().

deleteFileByContent()

ApiTestCaseUpload::deleteFileByContent

(

$filePath

)

Helper function – given a file on the filesystem, find matching content in the db (and associated articles) and remove them.

Parameters

string

$filePath

Path to file on the filesystem

Returns

bool

Definition at line 75 of file ApiTestCaseUpload.php.

References $success, deleteFileByTitle(), FSFile\getSha1Base36FromPath(), and RepoGroup\singleton().

Referenced by ApiUploadTest\testUpload(), ApiUploadTest\testUploadChunks(), ApiUploadTest\testUploadSameContent(), and ApiUploadTest\testUploadStash().

deleteFileByFileName()

ApiTestCaseUpload::deleteFileByFileName

(

$fileName

)

Helper function – remove files and associated articles with a particular filename.

Parameters

string

$fileName

Filename to be removed

Returns

bool

Definition at line 63 of file ApiTestCaseUpload.php.

References deleteFileByTitle(), and NS_FILE.

Referenced by ApiUploadTest\testUpload(), ApiUploadTest\testUploadChunks(), ApiUploadTest\testUploadSameContent(), ApiUploadTest\testUploadSameFileName(), ApiUploadTest\testUploadStash(), and ApiUploadTest\testUploadZeroLength().

deleteFileByTitle()

ApiTestCaseUpload::deleteFileByTitle

(

$title

)

Helper function – remove files and associated articles by Title.

Parameters

Title

$title

Title to be removed

Returns

bool

Definition at line 28 of file ApiTestCaseUpload.php.

References FileDeleteForm\doDelete(), Title\exists(), WikiPage\factory(), NS_FILE, and wfFindFile().

Referenced by deleteFileByContent(), and deleteFileByFileName().

fakeUploadChunk()

ApiTestCaseUpload::fakeUploadChunk	(		$fieldName,
			$fileName,
			$type,
		&	$chunkData )

Definition at line 125 of file ApiTestCaseUpload.php.

References $type, and MediaWikiTestCase\getNewTempFile().

Referenced by ApiUploadTest\testUploadChunks().

fakeUploadFile()

ApiTestCaseUpload::fakeUploadFile	(		$fieldName,
			$fileName,
			$type,
			$filePath )

Fake an upload by dumping the file into temp space, and adding info to $_FILES.

(This is what PHP would normally do).

Parameters

string	$fieldName	Name this would have in the upload form
string	$fileName	Name to title this
string	$type	MIME type
string	$filePath	Path where to find file contents

Exceptions

Exception

Returns

bool

Definition at line 98 of file ApiTestCaseUpload.php.

References $type, copy, and MediaWikiTestCase\getNewTempFile().

Referenced by ApiUploadTest\testUpload(), ApiUploadTest\testUploadSameContent(), ApiUploadTest\testUploadSameFileName(), ApiUploadTest\testUploadStash(), and ApiUploadTest\testUploadZeroLength().

setUp()

ApiTestCaseUpload::setUp ( )

protected

Fixture – run before every test.

Reimplemented from ApiTestCase.

Definition at line 10 of file ApiTestCaseUpload.php.

References clearFakeUploads(), and MediaWikiTestCase\setMwGlobals().

---

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

• tests/phpunit/includes/api/ApiTestCaseUpload.php