Specificly for testing Media handlers. More...

Inheritance diagram for MediaWikiMediaTestCase:

[legend]

Collaboration diagram for MediaWikiMediaTestCase:

[legend]

Protected Member Functions
	createsThumbnails ()
	Will the test create thumbnails (and thus do we need to set aside a temporary directory for them?)

	dataFile ( $name, $type=false)
	Utility function: Get a new file object for a file on disk but not actually in db.

	getFilePath ()
	The result of this method will set the file path to use, as well as the protected member $filePath.

	getRepoOptions ()

	setUp ()

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()

	tearDown ()

	truncateTable ( $tableName, IDatabase $db=null)
	Empties the given table and resets any auto-increment counters.

Protected Attributes
FSFileBackend	$backend

string	$filePath

FileRepo	$repo

Protected Attributes inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

Additional Inherited Members
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 ()

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

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.

Detailed Description

Specificly for testing Media handlers.

Sets up a FileRepo backend

Definition at line 5 of file MediaWikiMediaTestCase.php.

Member Function Documentation

◆ createsThumbnails()

MediaWikiMediaTestCase::createsThumbnails ( )

protected

Will the test create thumbnails (and thus do we need to set aside a temporary directory for them?)

Override this method if your test case creates thumbnails

Returns: bool

Reimplemented in ExifRotationTest, and JpegPixelFormatTest.

Definition at line 64 of file MediaWikiMediaTestCase.php.

Referenced by setUp().

◆ dataFile()

MediaWikiMediaTestCase::dataFile	(	$name,
		$type = `false`
	)

protected

Utility function: Get a new file object for a file on disk but not actually in db.

File must be in the path returned by getFilePath()

Parameters

string	$name	File name
string \| false	$type	MIME type [optional]

Returns: UnregisteredLocalFile

Definition at line 76 of file MediaWikiMediaTestCase.php.

References $type.

Referenced by ImagePage404Test\getImagePage(), ImagePageTest\getImagePage(), FileTest\testCanAnimateThumbIfAppropriate(), GIFHandlerTest\testGetImageArea(), PNGHandlerTest\testGetImageArea(), XCFHandlerTest\testGetImageSize(), GIFHandlerTest\testGetIndependentMetaArray(), PNGHandlerTest\testGetIndependentMetaArray(), SvgHandlerTest\testGetIndependentMetaArray(), JpegTest\testGetIndependentMetaArray(), GIFHandlerTest\testGetLength(), PNGHandlerTest\testGetLength(), GIFHandlerTest\testGetMetadata(), PNGHandlerTest\testGetMetadata(), XCFHandlerTest\testGetMetadata(), DjVuTest\testGetPageDimensions(), DjVuTest\testGetPageText(), FormatMetadataTest\testInvalidDate(), JpegTest\testInvalidFile(), GIFHandlerTest\testIsAnimanted(), PNGHandlerTest\testIsAnimanted(), JpegTest\testJpegMetadataExtraction(), ExifRotationTest\testMetadata(), ExifRotationTest\testMetadataAutoRotate(), ExifRotationTest\testMetadataAutoRotateUnsupported(), ExifRotationTest\testMetadataNoAutoRotate(), DjVuTest\testPageCount(), JpegPixelFormatTest\testPixelFormatRendering(), ExifRotationTest\testRotationRendering(), ExifRotationTest\testRotationRenderingNoAutoRotate(), and JpegTest\testSwappingICCProfile().

◆ getFilePath()

MediaWikiMediaTestCase::getFilePath ( )

protected

The result of this method will set the file path to use, as well as the protected member $filePath.

Returns: string Path where files are

Definition at line 52 of file MediaWikiMediaTestCase.php.

Referenced by setUp().

◆ getRepoOptions()

MediaWikiMediaTestCase::getRepoOptions ( )

protected

Returns: array Argument for FileRepo constructor

Reimplemented in ImagePage404Test.

Definition at line 38 of file MediaWikiMediaTestCase.php.

References $backend.

Referenced by setUp().

◆ setUp()

MediaWikiMediaTestCase::setUp ( )

protected

Reimplemented from MediaWikiTestCase.

Reimplemented in DjVuTest, ExifBitmapTest, ExifRotationTest, FormatMetadataTest, GIFHandlerTest, JpegPixelFormatTest, JpegTest, PNGHandlerTest, XCFHandlerTest, ImagePage404Test, and ImagePageTest.

Definition at line 14 of file MediaWikiMediaTestCase.php.

References $filePath, createsThumbnails(), getFilePath(), MediaWikiTestCase\getNewTempDirectory(), getRepoOptions(), and wfWikiID().

Member Data Documentation

◆ $backend

FSFileBackend MediaWikiMediaTestCase::$backend

protected

Definition at line 10 of file MediaWikiMediaTestCase.php.

Referenced by getRepoOptions().

◆ $filePath

string MediaWikiMediaTestCase::$filePath

protected

Definition at line 12 of file MediaWikiMediaTestCase.php.

Referenced by setUp().

◆ $repo

FileRepo MediaWikiMediaTestCase::$repo

protected

Definition at line 8 of file MediaWikiMediaTestCase.php.

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

tests/phpunit/includes/media/MediaWikiMediaTestCase.php

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createsThumbnails()

◆ dataFile()

◆ getFilePath()

◆ getRepoOptions()

◆ setUp()

Member Data Documentation

◆ $backend

◆ $filePath

◆ $repo