Checks that all API modules, core and extensions, conform to the conventions: More...

Inheritance diagram for ApiStructureTest:

[legend]

Collaboration diagram for ApiStructureTest:

[legend]

Public Member Functions
	testDocumentationExists ( $path, array $globals)
	provideDocumentationExists

	testParameterConsistency ( $path)
	provideParameterConsistency

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

static	provideParameterConsistency ()

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.

Static Protected Member Functions
static	getSubModulePaths (ApiModuleManager $manager)
	Return paths of all submodules in an ApiModuleManager, recursively.

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.

Private Member Functions
	checkMessage ( $msg, $what)
	Test a message.

	validateDefault ( $param, $config)
	Asserts that $default is a valid default for $type.

	validateType ( $types, $value, $param, $desc)
	Throws if $value does not match one of the types specified in $types.

Static Private Member Functions
static	getMain ()
	Initialize/fetch the ApiMain instance for testing.

Static Private Attributes
static	$constantNames = null

static ApiMain	$main

static	$paramAllowedTypes

static	$paramProhibitedTypes

static	$paramRequirements

static	$paramTypes
	Values are an array, where each array value is a permitted type.

static array	$testGlobals
	Sets of globals to test.

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

	setUp ()

	stashMwGlobals ( $globalKeys)
	Stashes the global, will be restored in tearDown()

	tearDown ()

Protected Attributes inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

Detailed Description

Checks that all API modules, core and extensions, conform to the conventions:

have documentation i18n messages (the test won't catch everything since i18n messages can vary based on the wiki configuration, but it should catch many cases for forgotten i18n)
do not have inconsistencies in the parameter definitions

API

Definition at line 14 of file ApiStructureTest.php.

Member Function Documentation

◆ checkMessage()

ApiStructureTest::checkMessage	(	$msg,
		$what
	)

private

Test a message.

Parameters

Message	$msg
string	$what	Which message is being checked

Definition at line 124 of file ApiStructureTest.php.

References getContext(), and ApiBase\makeMessage().

Referenced by testDocumentationExists().

◆ getMain()

static ApiStructureTest::getMain ( )

staticprivate

Initialize/fetch the ApiMain instance for testing.

Returns: ApiMain

Definition at line 108 of file ApiStructureTest.php.

References $main, RequestContext\getMain(), and NS_SPECIAL.

Referenced by provideDocumentationExists(), provideParameterConsistency(), testDocumentationExists(), and testParameterConsistency().

◆ getSubModulePaths()

static ApiStructureTest::getSubModulePaths ( ApiModuleManager $manager )

staticprotected

Return paths of all submodules in an ApiModuleManager, recursively.

Parameters

ApiModuleManager $manager

Returns: string[]

Definition at line 600 of file ApiStructureTest.php.

References $name, as, ApiModuleManager\getModule(), and ApiModuleManager\getNames().

Referenced by provideDocumentationExists(), and provideParameterConsistency().

◆ provideDocumentationExists()

static ApiStructureTest::provideDocumentationExists ( )

static

Definition at line 223 of file ApiStructureTest.php.

References $main, $path, $ret, as, getMain(), ApiMain\getModuleManager(), ApiBase\getModulePath(), and getSubModulePaths().

◆ provideParameterConsistency()

static ApiStructureTest::provideParameterConsistency ( )

static

Returns: array List of API module paths to test

Definition at line 583 of file ApiStructureTest.php.

References $main, $path, $ret, as, getMain(), ApiMain\getModuleManager(), ApiBase\getModulePath(), and getSubModulePaths().

◆ testDocumentationExists()

ApiStructureTest::testDocumentationExists	(		$path,
		array	$globals
	)

provideDocumentationExists

Parameters

string	$path	Module path
array	$globals	Globals to set

Definition at line 135 of file ApiStructureTest.php.

References $main, $name, $params, $path, $value, as, checkMessage(), ApiBase\GET_VALUES_FOR_HELP, ContextSource\getContext(), RequestContext\getMain(), getMain(), ApiBase\getModuleFromPath(), ApiBase\PARAM_HELP_MSG, ApiBase\PARAM_HELP_MSG_APPEND, ApiBase\PARAM_HELP_MSG_INFO, ApiBase\PARAM_HELP_MSG_PER_VALUE, ApiBase\PARAM_TYPE, and MediaWikiTestCase\setMwGlobals().

◆ testParameterConsistency()

ApiStructureTest::testParameterConsistency ( $path )

provideParameterConsistency

Parameters

string $path

Definition at line 246 of file ApiStructureTest.php.

References $main, $params, $path, array(), as, ApiBase\GET_VALUES_FOR_HELP, getMain(), ApiBase\getModuleFromPath(), ApiBase\PARAM_DEPRECATED_VALUES, ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI_LIMIT1, ApiBase\PARAM_ISMULTI_LIMIT2, ApiBase\PARAM_MAX, ApiBase\PARAM_MAX2, ApiBase\PARAM_MAX_BYTES, ApiBase\PARAM_MAX_CHARS, ApiBase\PARAM_MIN, ApiBase\PARAM_RANGE_ENFORCE, ApiBase\PARAM_REQUIRED, ApiBase\PARAM_TYPE, validateDefault(), and validateType().

◆ validateDefault()

ApiStructureTest::validateDefault	(	$param,
		$config
	)

private

Asserts that $default is a valid default for $type.

Parameters

string	$param	Name of param, for error messages
array	$config	Array of configuration options for this parameter

Definition at line 483 of file ApiStructureTest.php.

References $e, $type, as, ApiBase\PARAM_DFLT, ApiBase\PARAM_EXTRA_NAMESPACES, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_TYPE, validateDefault(), and wfTimestamp().

Referenced by testParameterConsistency(), and validateDefault().

◆ validateType()

ApiStructureTest::validateType	(	$types,
		$value,
		$param,
		$desc
	)

private

Throws if $value does not match one of the types specified in $types.

Parameters

array	$types	From self::$paramTypes array
mixed	$value	Value to check
string	$param	Name of param we're checking, for error messages
string	$desc	Description for error messages

Definition at line 437 of file ApiStructureTest.php.

References $type, $value, as, MediaWikiTestCase\assertType(), and validateType().

Referenced by testParameterConsistency(), and validateType().

Member Data Documentation

◆ $constantNames

ApiStructureTest::$constantNames = null

staticprivate

Definition at line 102 of file ApiStructureTest.php.

◆ $main

ApiMain ApiStructureTest::$main

staticprivate

Definition at line 17 of file ApiStructureTest.php.

Referenced by getMain(), provideDocumentationExists(), provideParameterConsistency(), testDocumentationExists(), and testParameterConsistency().

◆ $paramAllowedTypes

ApiStructureTest::$paramAllowedTypes

staticprivate

Initial value:

= [
        ApiBase::PARAM_MAX => [ 'integer', 'limit' ],
        ApiBase::PARAM_MAX2 => 'limit',
        ApiBase::PARAM_MIN => [ 'integer', 'limit' ],
        ApiBase::PARAM_RANGE_ENFORCE => 'integer',
        ApiBase::PARAM_VALUE_LINKS => 'array',
        ApiBase::PARAM_HELP_MSG_PER_VALUE => 'array',
        ApiBase::PARAM_SUBMODULE_MAP => 'submodule',
        ApiBase::PARAM_SUBMODULE_PARAM_PREFIX => 'submodule',
        ApiBase::PARAM_ALL => 'array',
        ApiBase::PARAM_EXTRA_NAMESPACES => 'namespace',
        ApiBase::PARAM_DEPRECATED_VALUES => 'array',
        ApiBase::PARAM_MAX_BYTES => [ 'NULL', 'string', 'text', 'password' ],
        ApiBase::PARAM_MAX_CHARS => [ 'NULL', 'string', 'text', 'password' ],
    ]

Definition at line 80 of file ApiStructureTest.php.

◆ $paramProhibitedTypes

ApiStructureTest::$paramProhibitedTypes

staticprivate

Initial value:

= [
        ApiBase::PARAM_ISMULTI => [ 'boolean', 'limit', 'upload' ],
        ApiBase::PARAM_ALL => 'namespace',
        ApiBase::PARAM_SENSITIVE => 'password',
    ]

Definition at line 96 of file ApiStructureTest.php.

◆ $paramRequirements

ApiStructureTest::$paramRequirements

staticprivate

Initial value:

= [
        ApiBase::PARAM_ALLOW_DUPLICATES => [ ApiBase::PARAM_ISMULTI => true ],
        ApiBase::PARAM_ALL => [ ApiBase::PARAM_ISMULTI => true ],
        ApiBase::PARAM_ISMULTI_LIMIT1 => [
            ApiBase::PARAM_ISMULTI => true,
            ApiBase::PARAM_ISMULTI_LIMIT2 => null,
        ],
        ApiBase::PARAM_ISMULTI_LIMIT2 => [
            ApiBase::PARAM_ISMULTI => true,
            ApiBase::PARAM_ISMULTI_LIMIT1 => null,
        ],
    ]

Definition at line 66 of file ApiStructureTest.php.

◆ $paramTypes

ApiStructureTest::$paramTypes

staticprivate

Initial value:

= [
        
        ApiBase::PARAM_ISMULTI => [ 'boolean' ],
        ApiBase::PARAM_TYPE => [ 'string', [ 'string' ] ],
        ApiBase::PARAM_MAX => [ 'integer' ],
        ApiBase::PARAM_MAX2 => [ 'integer' ],
        ApiBase::PARAM_MIN => [ 'integer' ],
        ApiBase::PARAM_ALLOW_DUPLICATES => [ 'boolean' ],
        ApiBase::PARAM_DEPRECATED => [ 'boolean' ],
        ApiBase::PARAM_REQUIRED => [ 'boolean' ],
        ApiBase::PARAM_RANGE_ENFORCE => [ 'boolean' ],
        ApiBase::PARAM_HELP_MSG => [ 'string', 'array', Message::class ],
        ApiBase::PARAM_HELP_MSG_APPEND => [ [ 'string', 'array', Message::class ] ],
        ApiBase::PARAM_HELP_MSG_INFO => [ [ 'array' ] ],
        ApiBase::PARAM_VALUE_LINKS => [ [ 'string' ] ],
        ApiBase::PARAM_HELP_MSG_PER_VALUE => [ [ 'string', 'array', Message::class ] ],
        ApiBase::PARAM_SUBMODULE_MAP => [ [ 'string' ] ],
        ApiBase::PARAM_SUBMODULE_PARAM_PREFIX => [ 'string' ],
        ApiBase::PARAM_ALL => [ 'boolean', 'string' ],
        ApiBase::PARAM_EXTRA_NAMESPACES => [ [ 'integer' ] ],
        ApiBase::PARAM_SENSITIVE => [ 'boolean' ],
        ApiBase::PARAM_DEPRECATED_VALUES => [ 'array' ],
        ApiBase::PARAM_ISMULTI_LIMIT1 => [ 'integer' ],
        ApiBase::PARAM_ISMULTI_LIMIT2 => [ 'integer' ],
        ApiBase::PARAM_MAX_BYTES => [ 'integer' ],
        ApiBase::PARAM_MAX_CHARS => [ 'integer' ],
    ]

Values are an array, where each array value is a permitted type.

A type can be a string, which is the name of an internal type or a class/interface. Or it can be an array, in which case the value must be an array whose elements are the types given in the array (e.g., [ 'string', integer' ] means an array whose entries are strings and/or integers).

Definition at line 37 of file ApiStructureTest.php.

◆ $testGlobals

array ApiStructureTest::$testGlobals

staticprivate

Initial value:

= [
        [
            'MiserMode' => false,
        ],
        [
            'MiserMode' => true,
        ],
    ]

Sets of globals to test.

Each array element is input to HashConfig

Definition at line 20 of file ApiStructureTest.php.

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

tests/phpunit/structure/ApiStructureTest.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Private Member Functions

Static Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkMessage()

◆ getMain()

◆ getSubModulePaths()

◆ provideDocumentationExists()

◆ provideParameterConsistency()

◆ testDocumentationExists()

◆ testParameterConsistency()

◆ validateDefault()

◆ validateType()

Member Data Documentation

◆ $constantNames

◆ $main

◆ $paramAllowedTypes

◆ $paramProhibitedTypes

◆ $paramRequirements

◆ $paramTypes

◆ $testGlobals