MediaWiki REL1_31
Public Member Functions | Protected Member Functions | List of all members
MediaWiki\Tests\Maintenance\MaintenanceTest Class Reference

Maintenance. More...

Inheritance diagram for MediaWiki\Tests\Maintenance\MaintenanceTest:
Inheritance graph
[legend]
Collaboration diagram for MediaWiki\Tests\Maintenance\MaintenanceTest:
Collaboration graph
[legend]

Public Member Functions

 provideOutputChanneledData ()
 
 provideOutputData ()
 
 testCleanupChanneledAfterNLOutput ()
 
 testCleanupChanneledAfterNLOutputWChannel ()
 
 testCleanupChanneledAfterNLOutputWNullChannel ()
 
 testCleanupChanneledAfterOutput ()
 
 testCleanupChanneledAfterOutputChanneledWChannel ()
 
 testCleanupChanneledAfterOutputChanneledWNullChannel ()
 
 testCleanupChanneledAfterOutputChanneledWOChannel ()
 
 testCleanupChanneledAfterOutputWChannel ()
 
 testCleanupChanneledAfterOutputWNullChannel ()
 
 testCleanupChanneledClean ()
 
 testGetConfig ()
 Maintenance::getConfig.
 
 testMultipleMaintenanceObjectsInteractionCleanupChanneledWChannel ()
 
 testMultipleMaintenanceObjectsInteractionOutput ()
 
 testMultipleMaintenanceObjectsInteractionOutputChanneled ()
 
 testMultipleMaintenanceObjectsInteractionOutputChanneledWChannel ()
 
 testMultipleMaintenanceObjectsInteractionOutputChanneledWNullChannel ()
 
 testMultipleMaintenanceObjectsInteractionOutputWChannel ()
 
 testMultipleMaintenanceObjectsInteractionOutputWChannelNL ()
 
 testMultipleMaintenanceObjectsInteractionOutputWNullChannel ()
 
 testMultipleMaintenanceObjectsInteractionOutputWNullChannelNL ()
 
 testOutput ( $outputs, $expected, $extraNL)
 provideOutputData
 
 testOutputChanneled ( $outputs, $expected, $extraNL)
 provideOutputChanneledData
 
 testParseArgs ()
 
 testSetConfig ()
 Maintenance::setConfig.
 
- Public Member Functions inherited from MediaWikiTestCase
 __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)
 
 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 ()
 

Protected Member Functions

 createMaintenance ()
 
 getMaintenanceClass ()
 
- Protected Member Functions inherited from MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase
 assertOutputPrePostShutdown ( $preShutdownOutput, $expectNLAppending)
 Asserts the output before and after simulating shutdown.
 
 setUp ()
 
 tearDown ()
 Do a little stream cleanup to prevent output in case the child class hasn't tested the capture buffer.
 
- 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, 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.
 
 getDefaultWikitextNS ()
 Returns the ID of a namespace that defaults to Wikitext.
 
 getNewTempDirectory ()
 obtains a new temporary directory
 
 getNewTempFile ()
 Obtains a new temporary file name.
 
 getSchemaOverrides (IMaintainableDatabase $db)
 Stub.
 
 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 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 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 MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase
Maintenance $maintenance
 The main Maintenance instance that is used for testing, wrapped and mockable.
 
- Protected Attributes inherited from MediaWikiTestCase
Database $db
 Primary database.
 
array $supportedDBs
 
array $tablesUsed = []
 

Detailed Description

Maintenance.

Definition at line 12 of file MaintenanceTest.php.

Member Function Documentation

◆ createMaintenance()

MediaWiki\Tests\Maintenance\MaintenanceTest::createMaintenance ( )
protected
See also
MaintenanceBaseTestCase::createMaintenance

Note to extension authors looking for a model to follow: This function is normally not needed in a maintenance test, it's only overridden here because Maintenance is abstract.

Reimplemented from MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase.

Definition at line 28 of file MaintenanceTest.php.

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

Referenced by 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(), and MediaWiki\Tests\Maintenance\MaintenanceTest\testParseArgs().

◆ getMaintenanceClass()

MediaWiki\Tests\Maintenance\MaintenanceTest::getMaintenanceClass ( )
protected
See also
MaintenanceBaseTestCase::getMaintenanceClass

Reimplemented from MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase.

Definition at line 17 of file MaintenanceTest.php.

Referenced by MediaWiki\Tests\Maintenance\MaintenanceTest\createMaintenance().

◆ provideOutputChanneledData()

MediaWiki\Tests\Maintenance\MaintenanceTest::provideOutputChanneledData ( )

Definition at line 209 of file MaintenanceTest.php.

References false, and true.

◆ provideOutputData()

MediaWiki\Tests\Maintenance\MaintenanceTest::provideOutputData ( )

Definition at line 56 of file MaintenanceTest.php.

References false, and true.

◆ testCleanupChanneledAfterNLOutput()

MediaWiki\Tests\Maintenance\MaintenanceTest::testCleanupChanneledAfterNLOutput ( )

Definition at line 331 of file MaintenanceTest.php.

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

◆ testCleanupChanneledAfterNLOutputWChannel()

MediaWiki\Tests\Maintenance\MaintenanceTest::testCleanupChanneledAfterNLOutputWChannel ( )

Definition at line 343 of file MaintenanceTest.php.

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

◆ testCleanupChanneledAfterNLOutputWNullChannel()

MediaWiki\Tests\Maintenance\MaintenanceTest::testCleanupChanneledAfterNLOutputWNullChannel ( )

Definition at line 337 of file MaintenanceTest.php.

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

◆ testCleanupChanneledAfterOutput()

MediaWiki\Tests\Maintenance\MaintenanceTest::testCleanupChanneledAfterOutput ( )

Definition at line 313 of file MaintenanceTest.php.

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

◆ testCleanupChanneledAfterOutputChanneledWChannel()

MediaWiki\Tests\Maintenance\MaintenanceTest::testCleanupChanneledAfterOutputChanneledWChannel ( )

Definition at line 361 of file MaintenanceTest.php.

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

◆ testCleanupChanneledAfterOutputChanneledWNullChannel()

MediaWiki\Tests\Maintenance\MaintenanceTest::testCleanupChanneledAfterOutputChanneledWNullChannel ( )

Definition at line 355 of file MaintenanceTest.php.

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

◆ testCleanupChanneledAfterOutputChanneledWOChannel()

MediaWiki\Tests\Maintenance\MaintenanceTest::testCleanupChanneledAfterOutputChanneledWOChannel ( )

Definition at line 349 of file MaintenanceTest.php.

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

◆ testCleanupChanneledAfterOutputWChannel()

MediaWiki\Tests\Maintenance\MaintenanceTest::testCleanupChanneledAfterOutputWChannel ( )

Definition at line 325 of file MaintenanceTest.php.

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

◆ testCleanupChanneledAfterOutputWNullChannel()

MediaWiki\Tests\Maintenance\MaintenanceTest::testCleanupChanneledAfterOutputWNullChannel ( )

Definition at line 319 of file MaintenanceTest.php.

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

◆ testCleanupChanneledClean()

MediaWiki\Tests\Maintenance\MaintenanceTest::testCleanupChanneledClean ( )

Definition at line 308 of file MaintenanceTest.php.

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

◆ testGetConfig()

MediaWiki\Tests\Maintenance\MaintenanceTest::testGetConfig ( )

Maintenance::getConfig.

Definition at line 485 of file MaintenanceTest.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ testMultipleMaintenanceObjectsInteractionCleanupChanneledWChannel()

MediaWiki\Tests\Maintenance\MaintenanceTest::testMultipleMaintenanceObjectsInteractionCleanupChanneledWChannel ( )

Definition at line 463 of file MaintenanceTest.php.

References MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\assertOutputPrePostShutdown(), and MediaWiki\Tests\Maintenance\MaintenanceTest\createMaintenance().

◆ testMultipleMaintenanceObjectsInteractionOutput()

MediaWiki\Tests\Maintenance\MaintenanceTest::testMultipleMaintenanceObjectsInteractionOutput ( )

Definition at line 367 of file MaintenanceTest.php.

References MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\assertOutputPrePostShutdown(), and MediaWiki\Tests\Maintenance\MaintenanceTest\createMaintenance().

◆ testMultipleMaintenanceObjectsInteractionOutputChanneled()

MediaWiki\Tests\Maintenance\MaintenanceTest::testMultipleMaintenanceObjectsInteractionOutputChanneled ( )

Definition at line 427 of file MaintenanceTest.php.

References MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\assertOutputPrePostShutdown(), and MediaWiki\Tests\Maintenance\MaintenanceTest\createMaintenance().

◆ testMultipleMaintenanceObjectsInteractionOutputChanneledWChannel()

MediaWiki\Tests\Maintenance\MaintenanceTest::testMultipleMaintenanceObjectsInteractionOutputChanneledWChannel ( )

Definition at line 451 of file MaintenanceTest.php.

References MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\assertOutputPrePostShutdown(), and MediaWiki\Tests\Maintenance\MaintenanceTest\createMaintenance().

◆ testMultipleMaintenanceObjectsInteractionOutputChanneledWNullChannel()

MediaWiki\Tests\Maintenance\MaintenanceTest::testMultipleMaintenanceObjectsInteractionOutputChanneledWNullChannel ( )

Definition at line 439 of file MaintenanceTest.php.

References MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\assertOutputPrePostShutdown(), and MediaWiki\Tests\Maintenance\MaintenanceTest\createMaintenance().

◆ testMultipleMaintenanceObjectsInteractionOutputWChannel()

MediaWiki\Tests\Maintenance\MaintenanceTest::testMultipleMaintenanceObjectsInteractionOutputWChannel ( )

Definition at line 391 of file MaintenanceTest.php.

References MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\assertOutputPrePostShutdown(), and MediaWiki\Tests\Maintenance\MaintenanceTest\createMaintenance().

◆ testMultipleMaintenanceObjectsInteractionOutputWChannelNL()

MediaWiki\Tests\Maintenance\MaintenanceTest::testMultipleMaintenanceObjectsInteractionOutputWChannelNL ( )

Definition at line 415 of file MaintenanceTest.php.

References MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\assertOutputPrePostShutdown(), and MediaWiki\Tests\Maintenance\MaintenanceTest\createMaintenance().

◆ testMultipleMaintenanceObjectsInteractionOutputWNullChannel()

MediaWiki\Tests\Maintenance\MaintenanceTest::testMultipleMaintenanceObjectsInteractionOutputWNullChannel ( )

Definition at line 379 of file MaintenanceTest.php.

References MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\assertOutputPrePostShutdown(), and MediaWiki\Tests\Maintenance\MaintenanceTest\createMaintenance().

◆ testMultipleMaintenanceObjectsInteractionOutputWNullChannelNL()

MediaWiki\Tests\Maintenance\MaintenanceTest::testMultipleMaintenanceObjectsInteractionOutputWNullChannelNL ( )

Definition at line 403 of file MaintenanceTest.php.

References MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\assertOutputPrePostShutdown(), and MediaWiki\Tests\Maintenance\MaintenanceTest\createMaintenance().

◆ testOutput()

MediaWiki\Tests\Maintenance\MaintenanceTest::testOutput (   $outputs,
  $expected,
  $extraNL 
)

provideOutputData

Definition at line 43 of file MaintenanceTest.php.

References as, MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\assertOutputPrePostShutdown(), and list.

◆ testOutputChanneled()

MediaWiki\Tests\Maintenance\MaintenanceTest::testOutputChanneled (   $outputs,
  $expected,
  $extraNL 
)

provideOutputChanneledData

Definition at line 196 of file MaintenanceTest.php.

References as, MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase\assertOutputPrePostShutdown(), and list.

◆ testParseArgs()

MediaWiki\Tests\Maintenance\MaintenanceTest::testParseArgs ( )

Definition at line 502 of file MaintenanceTest.php.

References MediaWiki\Tests\Maintenance\MaintenanceTest\createMaintenance().

◆ testSetConfig()

MediaWiki\Tests\Maintenance\MaintenanceTest::testSetConfig ( )

Maintenance::setConfig.

Definition at line 496 of file MaintenanceTest.php.

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