Sanity checks for making sure registered resources are sane. More...

Inheritance diagram for ResourcesTest:

[legend]

Collaboration diagram for ResourcesTest:

[legend]

Public Member Functions
	testCommentedLocalFileReferences ()
	CSSMin::getLocalFileReferences should ignore url(...) expressions that have been commented out.

	testFileExistence ( $filename, $module, $resource)
	provideResourceFiles

	testIllegalDependencies ()
	Verify that nothing explicitly depends on raw modules (such as "query").

	testMissingDependencies ()
	Verify that all modules specified as dependencies of other modules actually exist.

	testMissingMessages ()
	Verify that all specified messages actually exist.

	testStyleMedia ( $moduleName, $media, $filename, $css)
	provideMediaStylesheets

	testUnsatisfiableDependencies ()
	Verify that all dependencies of all modules are always satisfiable with the 'targets' defined for the involved modules.

	testVersionHash ()

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
static	provideMediaStylesheets ()
	Get all stylesheet files from modules that are an instance of ResourceLoaderFileModule (or one of its subclasses).

static	provideResourceFiles ()
	Get all resource files from modules that are an instance of ResourceLoaderFileModule (or one of its subclasses).

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.

Static Protected Member Functions
static	getAllModules ()
	Get all registered modules from ResouceLoader.

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.

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

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.

	setUp ()

	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 inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

Detailed Description

Sanity checks for making sure registered resources are sane.

Author: Antoine Musso; Niklas Laxström; Santhosh Thottingal; Timo Tijhof

Note: © 2012, Antoine Musso; © 2012, Niklas Laxström; © 2012, Santhosh Thottingal; © 2012, Timo Tijhof @coversNothing

Definition at line 19 of file ResourcesTest.php.

Member Function Documentation

◆ getAllModules()

static ResourcesTest::getAllModules ( )

staticprotected

Get all registered modules from ResouceLoader.

Returns: array

Definition at line 169 of file ResourcesTest.php.

References $modules, $wgEnableJavaScriptTest, and and().

Referenced by provideMediaStylesheets(), provideResourceFiles(), testIllegalDependencies(), testMissingDependencies(), testMissingMessages(), testUnsatisfiableDependencies(), and testVersionHash().

◆ provideMediaStylesheets()

static ResourcesTest::provideMediaStylesheets ( )

static

Get all stylesheet files from modules that are an instance of ResourceLoaderFileModule (or one of its subclasses).

Definition at line 200 of file ResourcesTest.php.

References $data, $file, and(), getAllModules(), and object.

◆ provideResourceFiles()

static ResourcesTest::provideResourceFiles ( )

static

Get all resource files from modules that are an instance of ResourceLoaderFileModule (or one of its subclasses).

Definition at line 250 of file ResourcesTest.php.

References $data, $file, $value, and(), getAllModules(), and ResourceLoaderFilePath\getPath().

◆ testCommentedLocalFileReferences()

ResourcesTest::testCommentedLocalFileReferences ( )

CSSMin::getLocalFileReferences should ignore url(...) expressions that have been commented out.

Definition at line 153 of file ResourcesTest.php.

References $css, and and().

◆ testFileExistence()

ResourcesTest::testFileExistence	(	$filename,
		$module,
		$resource )

provideResourceFiles

Definition at line 24 of file ResourcesTest.php.

References and().

◆ testIllegalDependencies()

ResourcesTest::testIllegalDependencies ( )

Verify that nothing explicitly depends on raw modules (such as "query").

Depending on them is unsupported as they are not registered client-side by the startup module.

Todo: Modules can dynamically choose dependencies based on context. This method does not test such dependencies. The same goes for testMissingDependencies() and testUnsatisfiableDependencies().

Definition at line 59 of file ResourcesTest.php.

References $data, and(), and getAllModules().

◆ testMissingDependencies()

ResourcesTest::testMissingDependencies ( )

Verify that all modules specified as dependencies of other modules actually exist.

Definition at line 84 of file ResourcesTest.php.

References $data, and(), and getAllModules().

◆ testMissingMessages()

ResourcesTest::testMissingMessages ( )

Verify that all specified messages actually exist.

Definition at line 103 of file ResourcesTest.php.

References $data, $lang, and(), getAllModules(), and wfMessage().

◆ testStyleMedia()

ResourcesTest::testStyleMedia	(	$moduleName,
		$media,
		$filename,
		$css )

provideMediaStylesheets

Definition at line 33 of file ResourcesTest.php.

References $css, and and().

◆ testUnsatisfiableDependencies()

ResourcesTest::testUnsatisfiableDependencies ( )

Verify that all dependencies of all modules are always satisfiable with the 'targets' defined for the involved modules.

Example: A depends on B. A has targets: mobile, desktop. B has targets: desktop. Therefore the dependency is sometimes unsatisfiable: it's impossible to load module A on mobile.

Definition at line 125 of file ResourcesTest.php.

References $data, and(), and getAllModules().

◆ testVersionHash()

ResourcesTest::testVersionHash ( )

Definition at line 42 of file ResourcesTest.php.

References $data, and(), and getAllModules().

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

tests/phpunit/structure/ResourcesTest.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAllModules()

◆ provideMediaStylesheets()

◆ provideResourceFiles()

◆ testCommentedLocalFileReferences()

◆ testFileExistence()

◆ testIllegalDependencies()

◆ testMissingDependencies()

◆ testMissingMessages()

◆ testStyleMedia()

◆ testUnsatisfiableDependencies()

◆ testVersionHash()