MediaWiki REL1_31
SampleTest Class Reference
Inheritance diagram for SampleTest:
Collaboration diagram for SampleTest:

Public Member Functions

 testCheckMainPageTitleIsConsideredLocal ( $title)
 Instead of putting a bunch of tests in a single test method, you should put only one or two tests in each test method.
 
 testCreateBasicListOfTitles ( $titleName, $ns, $text)
 phpcs:disable Generic.Files.LineLength provideTitles See https://phpunit.de/manual/3.7/en/appendixes.annotations.html#appendixes.annotations.dataProvider phpcs:enable
 
 testSetUpMainPageTitleForNextTest ()
 
 testTitleObjectFromObject ()
 InvalidArgumentException See https://phpunit.de/manual/3.7/en/appendixes.annotations.html#appendixes.annotations.expectedException.
 
 testTitleObjectStringConversion ()
 Name tests so that PHPUnit can turn them into sentences when they run.
 
- 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 ()
 

Static Public Member Functions

static provideTitles ()
 If you want to run a the same test with a variety of data, use a data provider.
 
- 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.
 

Protected Member Functions

 setUp ()
 Anything that needs to happen before your tests should go here.
 
 tearDown ()
 Anything cleanup you need to do should go here.
 
- 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

- 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 MediaWikiTestCase
Database $db
 Primary database.
 
array $supportedDBs
 
array $tablesUsed = []
 

Detailed Description

Definition at line 3 of file SampleTest.php.

Member Function Documentation

◆ provideTitles()

static SampleTest::provideTitles ( )
static

If you want to run a the same test with a variety of data, use a data provider.

see: https://www.phpunit.de/manual/3.4/en/writing-tests-for-phpunit.html

Definition at line 50 of file SampleTest.php.

References NS_FILE, NS_MEDIA, and NS_USER.

◆ setUp()

SampleTest::setUp ( )
protected

Anything that needs to happen before your tests should go here.

Reimplemented from MediaWikiLangTestCase.

Definition at line 8 of file SampleTest.php.

References MediaWikiTestCase\setMwGlobals().

◆ tearDown()

SampleTest::tearDown ( )
protected

Anything cleanup you need to do should go here.

Reimplemented from MediaWikiTestCase.

Definition at line 26 of file SampleTest.php.

◆ testCheckMainPageTitleIsConsideredLocal()

SampleTest::testCheckMainPageTitleIsConsideredLocal ( $title)

Instead of putting a bunch of tests in a single test method, you should put only one or two tests in each test method.

This way, the test method names can remain descriptive.

If you want to make tests depend on data created in another method, you can create dependencies feed whatever you return from the dependant method (e.g. testInitialCreation in this example) as arguments to the next method (e.g. $title in testTitleDepends is whatever testInitialCreatiion returned.) @depends testSetUpMainPageTitleForNextTest See https://phpunit.de/manual/3.7/en/appendixes.annotations.html#appendixes.annotations.depends

Definition at line 94 of file SampleTest.php.

◆ testCreateBasicListOfTitles()

SampleTest::testCreateBasicListOfTitles ( $titleName,
$ns,
$text )

phpcs:disable Generic.Files.LineLength provideTitles See https://phpunit.de/manual/3.7/en/appendixes.annotations.html#appendixes.annotations.dataProvider phpcs:enable

Definition at line 66 of file SampleTest.php.

◆ testSetUpMainPageTitleForNextTest()

SampleTest::testSetUpMainPageTitleForNextTest ( )

Definition at line 71 of file SampleTest.php.

References $title.

◆ testTitleObjectFromObject()

SampleTest::testTitleObjectFromObject ( )

◆ testTitleObjectStringConversion()

SampleTest::testTitleObjectStringConversion ( )

Name tests so that PHPUnit can turn them into sentences when they run.

While MediaWiki isn't strictly an Agile Programming project, you are encouraged to use the naming described under "Agile Documentation" at https://www.phpunit.de/manual/3.4/en/other-uses-for-tests.html

Definition at line 37 of file SampleTest.php.

References NS_MEDIA.


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