MediaWiki  master
MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase Class Reference
Inheritance diagram for MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase:
Collaboration diagram for MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase:

Protected Member Functions

 assertOutputPrePostShutdown ( $preShutdownOutput, $expectNLAppending)
 Asserts the output before and after simulating shutdown. More...
 
 createMaintenance ()
 Called by setUp to initialize $this->maintenance. More...
 
 getMaintenanceClass ()
 
 setUp ()
 
 tearDown ()
 Do a little stream cleanup to prevent output in case the child class hasn't tested the capture buffer. More...
 
- Protected Member Functions inherited from MediaWikiTestCase
 addCoreDBData ()
 
 addTmpFiles ( $files)
 
 anythingBut (... $values)
 Returns a PHPUnit constraint that matches anything other than a fixed set of values. More...
 
 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=false, $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...
 
 editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
 Edits or creates a page/revision. More...
 
 ensureMockDatabaseConnection (IDatabase $db)
 
 getDefaultWikitextNS ()
 Returns the ID of a namespace that defaults to Wikitext. More...
 
 getExistingTestPage ( $title=null)
 Returns a WikiPage representing an existing page. More...
 
 getNewTempDirectory ()
 obtains a new temporary directory More...
 
 getNewTempFile ()
 Obtains a new temporary file name. More...
 
 getNonexistingTestPage ( $title=null)
 Returns a WikiPage representing a non-existing page. More...
 
static getSchemaOverrides (IMaintainableDatabase $db)
 Stub. More...
 
 insertPage ( $pageName, $text='Sample page for unit test.', $namespace=null, User $user=null)
 Insert a new page. More...
 
 isTestInDatabaseGroup ()
 
 isWikitextNS ( $ns)
 Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels. More...
 
 markTestSkippedIfDbType ( $type)
 Skip the test if using the specified database type. 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...
 
 revisionDelete ( $rev, array $value=[Revision::DELETED_TEXT=> 1], $comment='')
 Revision-deletes a revision. More...
 
 setIniSetting ( $name, $value)
 Set an ini setting for the duration of the test. 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 ()
 
 tearDown ()
 
 truncateTable ( $tableName, IDatabase $db=null)
 Empties the given table and resets any auto-increment counters. More...
 

Protected Attributes

Maintenance $maintenance
 The main Maintenance instance that is used for testing, wrapped and mockable. More...
 
- 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...
 
 copyTestData (IDatabase $source, IDatabase $target)
 Copy test data from one database connection to another. 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 getTestPrefixFor (IDatabase $db)
 
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 installMockMwServices (Config $configOverrides=null)
 Creates a new "mock" MediaWikiServices instance, and installs it. More...
 
static listTables (IMaintainableDatabase $db)
 
static prepareServices (Config $bootstrapConfig)
 
static resetNonServiceCaches ()
 Resets some non-service singleton instances and other static caches. More...
 
static restoreMwServices ()
 Restores the original, non-mock MediaWikiServices instance. More...
 
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. 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 setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix=null)
 Setups a database with cloned tables using the given prefix. More...
 
static setupExternalStoreTestDBs ( $testPrefix=null)
 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

Definition at line 9 of file MaintenanceBaseTestCase.php.

Member Function Documentation

◆ assertOutputPrePostShutdown()

MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase::assertOutputPrePostShutdown (   $preShutdownOutput,
  $expectNLAppending 
)
protected

Asserts the output before and after simulating shutdown.

This function simulates shutdown of self::maintenance.

Parameters
string$preShutdownOutputExpected output before simulating shutdown
bool$expectNLAppendingWhether or not shutdown simulation is expected to add a newline to the output. If false, $preShutdownOutput is the expected output after shutdown simulation. Otherwise, $preShutdownOutput with an appended newline is the expected output after shutdown simulation.

Definition at line 83 of file MaintenanceBaseTestCase.php.

Referenced by MediaWiki\Tests\Maintenance\MaintenanceTest\testCleanupChanneledAfterNLOutput(), MediaWiki\Tests\Maintenance\MaintenanceTest\testCleanupChanneledAfterNLOutputWChannel(), MediaWiki\Tests\Maintenance\MaintenanceTest\testCleanupChanneledAfterNLOutputWNullChannel(), MediaWiki\Tests\Maintenance\MaintenanceTest\testCleanupChanneledAfterOutput(), MediaWiki\Tests\Maintenance\MaintenanceTest\testCleanupChanneledAfterOutputChanneledWChannel(), MediaWiki\Tests\Maintenance\MaintenanceTest\testCleanupChanneledAfterOutputChanneledWNullChannel(), MediaWiki\Tests\Maintenance\MaintenanceTest\testCleanupChanneledAfterOutputChanneledWOChannel(), MediaWiki\Tests\Maintenance\MaintenanceTest\testCleanupChanneledAfterOutputWChannel(), MediaWiki\Tests\Maintenance\MaintenanceTest\testCleanupChanneledAfterOutputWNullChannel(), MediaWiki\Tests\Maintenance\MaintenanceTest\testCleanupChanneledClean(), MediaWiki\Tests\Maintenance\MaintenanceTest\testMultipleMaintenanceObjectsInteractionCleanupChanneledWChannel(), MediaWiki\Tests\Maintenance\MaintenanceTest\testMultipleMaintenanceObjectsInteractionOutput(), MediaWiki\Tests\Maintenance\MaintenanceTest\testMultipleMaintenanceObjectsInteractionOutputChanneled(), MediaWiki\Tests\Maintenance\MaintenanceTest\testMultipleMaintenanceObjectsInteractionOutputChanneledWChannel(), MediaWiki\Tests\Maintenance\MaintenanceTest\testMultipleMaintenanceObjectsInteractionOutputChanneledWNullChannel(), MediaWiki\Tests\Maintenance\MaintenanceTest\testMultipleMaintenanceObjectsInteractionOutputWChannel(), MediaWiki\Tests\Maintenance\MaintenanceTest\testMultipleMaintenanceObjectsInteractionOutputWChannelNL(), MediaWiki\Tests\Maintenance\MaintenanceTest\testMultipleMaintenanceObjectsInteractionOutputWNullChannel(), MediaWiki\Tests\Maintenance\MaintenanceTest\testMultipleMaintenanceObjectsInteractionOutputWNullChannelNL(), MediaWiki\Tests\Maintenance\MaintenanceTest\testOutput(), and MediaWiki\Tests\Maintenance\MaintenanceTest\testOutputChanneled().

◆ createMaintenance()

MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase::createMaintenance ( )
protected

Called by setUp to initialize $this->maintenance.

Returns
object The Maintenance instance to test.

Definition at line 62 of file MaintenanceBaseTestCase.php.

References MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\getMaintenanceClass().

Referenced by MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\setUp().

◆ getMaintenanceClass()

MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase::getMaintenanceClass ( )
abstractprotected
Returns
string Class name

Subclasses must implement this in order to use the $this->maintenance variable. Normally, it will be set like: return PopulateDatabaseMaintenance::class;

If you need to change the way your maintenance class is constructed, override createMaintenance.

Referenced by MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\createMaintenance(), and MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\tearDown().

◆ setUp()

MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase::setUp ( )
protected

◆ tearDown()

MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase::tearDown ( )
protected

Do a little stream cleanup to prevent output in case the child class hasn't tested the capture buffer.

Definition at line 28 of file MaintenanceBaseTestCase.php.

References MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\getMaintenanceClass().

Member Data Documentation

◆ $maintenance

Maintenance MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase::$maintenance
protected

The main Maintenance instance that is used for testing, wrapped and mockable.

Definition at line 16 of file MaintenanceBaseTestCase.php.


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