API Database medium. More...

Inheritance diagram for ApiBlockTest:

[legend]

Collaboration diagram for ApiBlockTest:

[legend]

Public Member Functions
	testBlockByBlockedUser ()
	A blocked user can't block.

	testBlockById ()
	Block by user ID.

	testBlockingActionWithNoToken ()
	ApiUsageException The "token" parameter must be set.

	testBlockOfNonexistentUser ()

	testBlockOfNonexistentUserId ()

	testBlockWithEmailBlock ()

	testBlockWithExpiry ()

	testBlockWithHide ()

	testBlockWithInvalidExpiry ()

	testBlockWithProhibitedEmailBlock ()

	testBlockWithProhibitedHide ()

	testBlockWithProhibitedTag ()

	testBlockWithTag ()

	testNormalBlock ()
	Block by username.

	testRangeBlock ()

	testVeryLargeRangeBlock ()
	ApiUsageException Range blocks larger than /16 are not allowed.

Public Member Functions inherited from ApiTestCase
	testApiTestGroup ()
	@coversNothing

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

	setUp ()

	tearDown ()

Protected Member Functions inherited from ApiTestCase
	doApiRequest (array $params, array $session=null, $appendModule=false, User $user=null, $tokenType=null)
	Does the API request and returns the result.

	doApiRequestWithToken (array $params, array $session=null, User $user=null, $tokenType='auto')
	Convenience function to access the token parameter of doApiRequest() more succinctly.

	doLogin ( $testUser=null)
	Previously this would do API requests to log in, as well as setting $wgUser and the request context's user.

	editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
	Edits or creates a page/revision.

	getTokenList (TestUser $user, $session=null)

	revisionDelete ( $rev, array $value=[Revision::DELETED_TEXT=> 1], $comment='')
	Revision-deletes a revision.

	setExpectedApiException ( $msg, $code=null, array $data=null, $httpCode=0)
	Expect an ApiUsageException to be thrown with the given parameters, which are the same as ApiUsageException::newWithMessage()'s parameters.

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

Protected Attributes
	$mUser = null

Protected Attributes inherited from ApiTestCase
ApiTestContext	$apiContext

Protected Attributes inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

Private Member Functions
	doBlock (array $extraParams=[], User $blocker=null)

Additional Inherited Members
Static Public Member Functions inherited from ApiTestCase
static	apiExceptionHasCode (ApiUsageException $ex, $code)

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 ApiTestCase
static	getErrorFormatter ()

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.

Static Protected Attributes inherited from ApiTestCase
static	$apiUrl

static	$errorFormatter = null

Detailed Description

API Database medium.

ApiBlock

Definition at line 10 of file ApiBlockTest.php.

Member Function Documentation

◆ doBlock()

ApiBlockTest::doBlock	(	array	$extraParams = [],
		User	$blocker = null )

private

Parameters

array	$extraParams	Extra API parameters to pass to doApiRequest
User	$blocker	User to do the blocking, null to pick arbitrarily

Definition at line 40 of file ApiBlockTest.php.

References $params, $ret, $tokens, ApiTestCase\doApiRequest(), getTokens(), and Block\newFromTarget().

Referenced by testBlockByBlockedUser(), testBlockById(), testBlockOfNonexistentUser(), testBlockOfNonexistentUserId(), testBlockWithEmailBlock(), testBlockWithExpiry(), testBlockWithHide(), testBlockWithInvalidExpiry(), testBlockWithProhibitedEmailBlock(), testBlockWithProhibitedHide(), testBlockWithProhibitedTag(), testBlockWithTag(), testNormalBlock(), testRangeBlock(), and testVeryLargeRangeBlock().

◆ getTokens()

ApiBlockTest::getTokens ( )

protected

Definition at line 31 of file ApiBlockTest.php.

References ApiTestCase\getTokenList().

Referenced by doBlock().

◆ setUp()

ApiBlockTest::setUp ( )

protected

Reimplemented from ApiTestCase.

Definition at line 13 of file ApiBlockTest.php.

References MediaWikiTestCase\getMutableTestUser(), and MediaWikiTestCase\setMwGlobals().

◆ tearDown()

ApiBlockTest::tearDown ( )

protected

Reimplemented from ApiTestCase.

Definition at line 23 of file ApiBlockTest.php.

References Block\newFromTarget().

◆ testBlockByBlockedUser()

ApiBlockTest::testBlockByBlockedUser ( )

A blocked user can't block.

Definition at line 91 of file ApiBlockTest.php.

References doBlock(), and MediaWikiTestCase\getMutableTestUser().

◆ testBlockById()

ApiBlockTest::testBlockById ( )

Block by user ID.

Definition at line 84 of file ApiBlockTest.php.

References doBlock().

◆ testBlockingActionWithNoToken()

ApiBlockTest::testBlockingActionWithNoToken ( )

ApiUsageException The "token" parameter must be set.

Definition at line 226 of file ApiBlockTest.php.

References ApiTestCase\doApiRequest().

◆ testBlockOfNonexistentUser()

ApiBlockTest::testBlockOfNonexistentUser ( )

Definition at line 108 of file ApiBlockTest.php.

References doBlock().

◆ testBlockOfNonexistentUserId()

ApiBlockTest::testBlockOfNonexistentUserId ( )

Definition at line 115 of file ApiBlockTest.php.

References doBlock(), and User\whoIs().

◆ testBlockWithEmailBlock()

ApiBlockTest::testBlockWithEmailBlock ( )

Definition at line 178 of file ApiBlockTest.php.

References $res, DB_MASTER, doBlock(), and wfGetDB().

◆ testBlockWithExpiry()

ApiBlockTest::testBlockWithExpiry ( )

Definition at line 200 of file ApiBlockTest.php.

References $res, DB_MASTER, doBlock(), wfGetDB(), and wfTimestamp().

◆ testBlockWithHide()

ApiBlockTest::testBlockWithHide ( )

Definition at line 153 of file ApiBlockTest.php.

References $res, $wgGroupPermissions, DB_MASTER, doBlock(), MediaWikiTestCase\mergeMwGlobalArrayValue(), and wfGetDB().

◆ testBlockWithInvalidExpiry()

ApiBlockTest::testBlockWithInvalidExpiry ( )

Definition at line 216 of file ApiBlockTest.php.

References doBlock().

◆ testBlockWithProhibitedEmailBlock()

ApiBlockTest::testBlockWithProhibitedEmailBlock ( )

Definition at line 190 of file ApiBlockTest.php.

References doBlock(), and MediaWikiTestCase\setMwGlobals().

◆ testBlockWithProhibitedHide()

ApiBlockTest::testBlockWithProhibitedHide ( )

Definition at line 171 of file ApiBlockTest.php.

References doBlock().

◆ testBlockWithProhibitedTag()

ApiBlockTest::testBlockWithProhibitedTag ( )

Definition at line 141 of file ApiBlockTest.php.

References ChangeTags\defineTag(), doBlock(), and MediaWikiTestCase\setMwGlobals().

◆ testBlockWithTag()

ApiBlockTest::testBlockWithTag ( )

Definition at line 125 of file ApiBlockTest.php.

References DB_MASTER, ChangeTags\defineTag(), doBlock(), and wfGetDB().

◆ testNormalBlock()

ApiBlockTest::testNormalBlock ( )

Block by username.

Definition at line 77 of file ApiBlockTest.php.

References doBlock().

◆ testRangeBlock()

ApiBlockTest::testRangeBlock ( )

Definition at line 239 of file ApiBlockTest.php.

References doBlock(), and User\newFromName().

◆ testVeryLargeRangeBlock()

ApiBlockTest::testVeryLargeRangeBlock ( )

ApiUsageException Range blocks larger than /16 are not allowed.

Definition at line 248 of file ApiBlockTest.php.

References doBlock(), and User\newFromName().

Member Data Documentation

◆ $mUser

ApiBlockTest::$mUser = null

protected

Definition at line 11 of file ApiBlockTest.php.

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

tests/phpunit/includes/api/ApiBlockTest.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ doBlock()

◆ getTokens()

◆ setUp()

◆ tearDown()

◆ testBlockByBlockedUser()

◆ testBlockById()

◆ testBlockingActionWithNoToken()

◆ testBlockOfNonexistentUser()

◆ testBlockOfNonexistentUserId()

◆ testBlockWithEmailBlock()

◆ testBlockWithExpiry()

◆ testBlockWithHide()

◆ testBlockWithInvalidExpiry()

◆ testBlockWithProhibitedEmailBlock()

◆ testBlockWithProhibitedHide()

◆ testBlockWithProhibitedTag()

◆ testBlockWithTag()

◆ testNormalBlock()

◆ testRangeBlock()

◆ testVeryLargeRangeBlock()

Member Data Documentation

◆ $mUser