MediaWiki  master
MediaWikiMediaTestCase Class Reference

Specificly for testing Media handlers. More...

Inheritance diagram for MediaWikiMediaTestCase:
Collaboration diagram for MediaWikiMediaTestCase:

Protected Member Functions

 createsThumbnails ()
 Will the test create thumbnails (and thus do we need to set aside a temporary directory for them?) More...
 
 dataFile ($name, $type=null)
 Utility function: Get a new file object for a file on disk but not actually in db. More...
 
 getFilePath ()
 The result of this method will set the file path to use, as well as the protected member $filePath. More...
 
 getRepoOptions ()
 
 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...
 
 assertFileContains ($fileName, $actualData, $createIfMissing=true, $msg= '')
 Check whether file contains given data. 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, array $options=[], array $join_conds=[])
 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...
 
 checkDbIsSupported ()
 
 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...
 
static getSchemaOverrides (IMaintainableDatabase $db)
 Stub. More...
 
 insertPage ($pageName, $text= 'Sample page for unit test.', $namespace=null)
 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...
 
 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. More...
 
 setLogger ($channel, LoggerInterface $logger)
 Sets the logger for a specified channel, for the duration of the test. More...
 
 setMwGlobals ($pairs, $value=null)
 Sets a global, maintaining a stashed version of the previous global to be restored in tearDown. More...
 
 setService ($name, $object)
 Sets a service, maintaining a stashed version of the previous service to be restored in tearDown. More...
 
 setTemporaryHook ($hookName, $handler)
 Create a temporary hook handler which will be reset by tearDown. More...
 
 setUp ()
 
 stashMwGlobals ($globalKeys)
 Stashes the global, will be restored in tearDown() More...
 
 tearDown ()
 

Protected Attributes

FSFileBackend $backend
 
string $filePath
 
FileRepo $repo
 
- Protected Attributes inherited from MediaWikiTestCase
Database $db
 Primary database. More...
 
array $supportedDBs
 
array $tablesUsed = []
 

Additional Inherited Members

- Public Member Functions inherited from MediaWikiTestCase
 __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)
 
 setGroupPermissions ($newPerms, $newKey=null, $newValue=null)
 Alters $wgGroupPermissions for the duration of the test. More...
 
 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 inherited from MediaWikiTestCase
static getMutableTestUser ($groups=[])
 Convenience method for getting a mutable test user. More...
 
static getTestSysop ()
 Convenience method for getting an immutable admin test user. More...
 
static getTestUser ($groups=[])
 Convenience method for getting an immutable test user. More...
 
static listTables (IMaintainableDatabase $db)
 
static prepareServices (Config $bootstrapConfig)
 Prepare service configuration for unit testing. More...
 
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. 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...
 
- 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
 
- 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 resetGlobalServices (Config $bootstrapConfig=null)
 Reset global services, and install testing environment. More...
 
static setupDatabaseWithTestPrefix (IMaintainableDatabase $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...
 

Detailed Description

Specificly for testing Media handlers.

Sets up a FileRepo backend

Definition at line 5 of file MediaWikiMediaTestCase.php.

Member Function Documentation

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

Definition at line 64 of file MediaWikiMediaTestCase.php.

Referenced by setUp().

MediaWikiMediaTestCase::dataFile (   $name,
  $type = null 
)
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$nameFile name
string$typeMIME type [optional]
Returns
UnregisteredLocalFile

Definition at line 76 of file MediaWikiMediaTestCase.php.

References $name, $type, and MediaWiki\MediaWikiServices\getInstance().

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

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

MediaWikiMediaTestCase::getRepoOptions ( )
protected
Returns
array Argument for FileRepo constructor

Definition at line 38 of file MediaWikiMediaTestCase.php.

References $backend.

Referenced by setUp().

MediaWikiMediaTestCase::setUp ( )
protected

Member Data Documentation

FSFileBackend MediaWikiMediaTestCase::$backend
protected

Definition at line 10 of file MediaWikiMediaTestCase.php.

Referenced by getRepoOptions().

string MediaWikiMediaTestCase::$filePath
protected

Definition at line 12 of file MediaWikiMediaTestCase.php.

Referenced by setUp().

FileRepo MediaWikiMediaTestCase::$repo
protected

Definition at line 8 of file MediaWikiMediaTestCase.php.


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