API Database medium. More...

Inheritance diagram for ApiParseTest:

[legend]

Collaboration diagram for ApiParseTest:

[legend]

Public Member Functions
	addDBDataOnce ()
	Stub.

	testCategoriesHtml ()

	testDisableTidy ()

	testEffectiveLangLinks ()

	testExistingSection ()

	testFollowedRedirect ()

	testFollowedRedirectById ()

	testFormatCategories ()

	testHeadHtml ()

	testHeadItems ()

	testHeadItemsWithSkin ()

	testIndicators ()

	testIndicatorsWithSkin ()

	testInvalidSection ()

	testInvalidTitle ()

	testIwlinks ()

	testLangLinks ()

	testLangLinksWithSkin ()

	testLimitReports ()

	testModules ()

	testModulesWithSkin ()

	testNewSection ()

	testNewSectionWithPage ()

	testNonexistentOldId ()

	testNonexistentPage ()

	testNoPst ()

	testOnlyPst ()

	testParseById ()

	testParseByName ()

	testParseByOldId ()

	testParseTree ()

	testParseTreeNonWikitext ()

	testPst ()

	testRevDel ()

	testRevDelNoPermission ()

	testRevId ()

	testRevidNoText ()

	testSection ()

	testSectionNoContent ()

	testSerializationError ()

	testSuppressed ()

	testTextNoContentModel ()

	testTitleNoText ()

	testTitleProvided ()

	testTitleWithNonexistentRevId ()

	testTitleWithNonMatchingRevId ()

	testUnfollowedRedirect ()

Public Member Functions inherited from ApiTestCase
	testApiTestGroup ()
	@coversNothing

Public Member Functions inherited from MediaWikiTestCase
	__construct ( $name=null, array $data=[], $dataName='')

	__destruct ()

	addDBData ()
	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
	assertParsedTo ( $expected, array $res, $warnings=null)
	Assert that the given result of calling $this->doApiRequest() with action=parse resulted in $html, accounting for the boilerplate that the parser adds around the parsed page.

	assertParsedToRegExp ( $expected, array $res, $warnings=null)
	Same as above, but asserts that the HTML matches a regexp instead of a literal string match.

	setupInterwiki ()
	Set up an interwiki entry for testing.

	setupSkin ()
	Set up a skin for testing.

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.

	setUp ()

	tearDown ()

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

Static Protected Attributes
static	$pageId

static	$revIds = []

Static Protected Attributes inherited from ApiTestCase
static	$apiUrl

static	$errorFormatter = null

Private Member Functions
	doAssertParsedTo ( $expected, array $res, $warnings, callable $callback)

	doTestLangLinks (array $arr=[])

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.

Protected Attributes inherited from ApiTestCase
ApiTestContext	$apiContext

Protected Attributes inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

Detailed Description

API Database medium.

ApiParse

Definition at line 10 of file ApiParseTest.php.

Member Function Documentation

◆ addDBDataOnce()

ApiParseTest::addDBDataOnce ( )

Stub.

If a test suite needs to add additional data to the database, it should implement this method and do so. This method is called once per test suite (i.e. once per class).

Note data added by this method may be removed by resetDB() depending on the contents of $tablesUsed.

To add additional data between test function runs, override prepareDB().

See also: addDBData(); resetDB()

Since: 1.27

Reimplemented from MediaWikiTestCase.

Definition at line 15 of file ApiParseTest.php.

References ApiTestCase\editPage(), and ApiTestCase\revisionDelete().

◆ assertParsedTo()

ApiParseTest::assertParsedTo	(		$expected,
		array	$res,
			$warnings = null )

protected

Assert that the given result of calling $this->doApiRequest() with action=parse resulted in $html, accounting for the boilerplate that the parser adds around the parsed page.

Also asserts that warnings match the provided $warning.

Parameters

string	$html	Expected HTML
array	$res	Returned from doApiRequest()
string \| null	$warnings	Exact value of expected warnings, null for no warnings

Definition at line 51 of file ApiParseTest.php.

References $res, and doAssertParsedTo().

Referenced by testDisableTidy(), testFollowedRedirect(), testFollowedRedirectById(), testNoPst(), testParseById(), testParseByName(), testParseByOldId(), testPst(), testRevDel(), testRevId(), testRevidNoText(), testSuppressed(), testTextNoContentModel(), testTitleNoText(), testTitleProvided(), and testTitleWithNonMatchingRevId().

◆ assertParsedToRegExp()

ApiParseTest::assertParsedToRegExp	(		$expected,
		array	$res,
			$warnings = null )

protected

Same as above, but asserts that the HTML matches a regexp instead of a literal string match.

Parameters

string	$html	Expected HTML
array	$res	Returned from doApiRequest()
string \| null	$warnings	Exact value of expected warnings, null for no warnings

Definition at line 64 of file ApiParseTest.php.

References $res, and doAssertParsedTo().

Referenced by testExistingSection(), testNewSection(), and testSection().

◆ doAssertParsedTo()

ApiParseTest::doAssertParsedTo	(		$expected,
		array	$res,
			$warnings,
		callable	$callback )

private

Definition at line 68 of file ApiParseTest.php.

References $html, and $res.

Referenced by assertParsedTo(), and assertParsedToRegExp().

◆ doTestLangLinks()

ApiParseTest::doTestLangLinks ( array $arr = [] )

private

Parameters

array $arr Extra params to add to API request

Definition at line 579 of file ApiParseTest.php.

References $res, ApiTestCase\doApiRequest(), and setupInterwiki().

Referenced by testLangLinks(), and testLangLinksWithSkin().

◆ setupInterwiki()

ApiParseTest::setupInterwiki ( )

protected

Set up an interwiki entry for testing.

Definition at line 104 of file ApiParseTest.php.

References DB_MASTER, MediaWikiTestCase\setMwGlobals(), and wfGetDB().

Referenced by doTestLangLinks(), and testIwlinks().

◆ setupSkin()

ApiParseTest::setupSkin ( )

protected

Set up a skin for testing.

Todo: Should this code be in MediaWikiTestCase or something?

Definition at line 128 of file ApiParseTest.php.

References $out, $skin, and MediaWikiTestCase\setService().

Referenced by testHeadItemsWithSkin(), testIndicatorsWithSkin(), testLangLinksWithSkin(), and testModulesWithSkin().

◆ testCategoriesHtml()

ApiParseTest::testCategoriesHtml ( )

Definition at line 540 of file ApiParseTest.php.

References $res, ApiTestCase\doApiRequest(), and ApiTestCase\editPage().

◆ testDisableTidy()

ApiParseTest::testDisableTidy ( )

Definition at line 806 of file ApiParseTest.php.

References assertParsedTo(), ApiTestCase\doApiRequest(), and MediaWikiTestCase\setMwGlobals().

◆ testEffectiveLangLinks()

ApiParseTest::testEffectiveLangLinks ( )

Definition at line 556 of file ApiParseTest.php.

References $res, ApiTestCase\doApiRequest(), and MediaWikiTestCase\setTemporaryHook().

◆ testExistingSection()

ApiParseTest::testExistingSection ( )

Definition at line 461 of file ApiParseTest.php.

References $res, assertParsedToRegExp(), and ApiTestCase\doApiRequest().

◆ testFollowedRedirect()

ApiParseTest::testFollowedRedirect ( )

Definition at line 329 of file ApiParseTest.php.

References $res, assertParsedTo(), ApiTestCase\doApiRequest(), and ApiTestCase\editPage().

◆ testFollowedRedirectById()

ApiParseTest::testFollowedRedirectById ( )

Definition at line 344 of file ApiParseTest.php.

References $res, assertParsedTo(), ApiTestCase\doApiRequest(), and ApiTestCase\editPage().

◆ testFormatCategories()

ApiParseTest::testFormatCategories ( )

Definition at line 828 of file ApiParseTest.php.

References $res, ApiTestCase\doApiRequest(), and ApiTestCase\editPage().

◆ testHeadHtml()

ApiParseTest::testHeadHtml ( )

Definition at line 527 of file ApiParseTest.php.

References $res, and ApiTestCase\doApiRequest().

◆ testHeadItems()

ApiParseTest::testHeadItems ( )

Definition at line 607 of file ApiParseTest.php.

References $res, and ApiTestCase\doApiRequest().

◆ testHeadItemsWithSkin()

ApiParseTest::testHeadItemsWithSkin ( )

Definition at line 624 of file ApiParseTest.php.

References $res, ApiTestCase\doApiRequest(), and setupSkin().

◆ testIndicators()

ApiParseTest::testIndicators ( )

Definition at line 705 of file ApiParseTest.php.

References $res, and ApiTestCase\doApiRequest().

◆ testIndicatorsWithSkin()

ApiParseTest::testIndicatorsWithSkin ( )

Definition at line 722 of file ApiParseTest.php.

References $res, ApiTestCase\doApiRequest(), and setupSkin().

◆ testInvalidSection()

ApiParseTest::testInvalidSection ( )

Definition at line 256 of file ApiParseTest.php.

References ApiTestCase\doApiRequest().

◆ testInvalidTitle()

ApiParseTest::testInvalidTitle ( )

Definition at line 359 of file ApiParseTest.php.

References ApiTestCase\doApiRequest().

◆ testIwlinks()

ApiParseTest::testIwlinks ( )

Definition at line 742 of file ApiParseTest.php.

References $res, ApiTestCase\doApiRequest(), and setupInterwiki().

◆ testLangLinks()

ApiParseTest::testLangLinks ( )

Definition at line 598 of file ApiParseTest.php.

References doTestLangLinks().

◆ testLangLinksWithSkin()

ApiParseTest::testLangLinksWithSkin ( )

Definition at line 602 of file ApiParseTest.php.

References doTestLangLinks(), and setupSkin().

◆ testLimitReports()

ApiParseTest::testLimitReports ( )

Definition at line 761 of file ApiParseTest.php.

References $res, and ApiTestCase\doApiRequest().

◆ testModules()

ApiParseTest::testModules ( )

Definition at line 644 of file ApiParseTest.php.

References $output, $parser, $res, ApiTestCase\doApiRequest(), and MediaWikiTestCase\setTemporaryHook().

◆ testModulesWithSkin()

ApiParseTest::testModulesWithSkin ( )

Definition at line 669 of file ApiParseTest.php.

References $res, ApiTestCase\doApiRequest(), and setupSkin().

◆ testNewSection()

ApiParseTest::testNewSection ( )

Definition at line 449 of file ApiParseTest.php.

References $res, assertParsedToRegExp(), and ApiTestCase\doApiRequest().

◆ testNewSectionWithPage()

ApiParseTest::testNewSectionWithPage ( )

Definition at line 290 of file ApiParseTest.php.

References ApiTestCase\doApiRequest().

◆ testNonexistentOldId()

ApiParseTest::testNonexistentOldId ( )

Definition at line 302 of file ApiParseTest.php.

References ApiTestCase\doApiRequest().

◆ testNonexistentPage()

ApiParseTest::testNonexistentPage ( )

Definition at line 215 of file ApiParseTest.php.

References ApiTestCase\apiExceptionHasCode(), and ApiTestCase\doApiRequest().

◆ testNoPst()

ApiParseTest::testNoPst ( )

Definition at line 472 of file ApiParseTest.php.

References $res, assertParsedTo(), ApiTestCase\doApiRequest(), and ApiTestCase\editPage().

◆ testOnlyPst()

ApiParseTest::testOnlyPst ( )

Definition at line 503 of file ApiParseTest.php.

References $res, ApiTestCase\doApiRequest(), and ApiTestCase\editPage().

◆ testParseById()

ApiParseTest::testParseById ( )

Definition at line 163 of file ApiParseTest.php.

References $res, assertParsedTo(), and ApiTestCase\doApiRequest().

◆ testParseByName()

ApiParseTest::testParseByName ( )

Definition at line 148 of file ApiParseTest.php.

References $res, assertParsedTo(), and ApiTestCase\doApiRequest().

◆ testParseByOldId()

ApiParseTest::testParseByOldId ( )

Definition at line 171 of file ApiParseTest.php.

References $res, assertParsedTo(), and ApiTestCase\doApiRequest().

◆ testParseTree()

ApiParseTest::testParseTree ( )

Definition at line 786 of file ApiParseTest.php.

References $res, and ApiTestCase\doApiRequest().

◆ testParseTreeNonWikitext()

ApiParseTest::testParseTreeNonWikitext ( )

Definition at line 774 of file ApiParseTest.php.

References ApiTestCase\doApiRequest().

◆ testPst()

ApiParseTest::testPst ( )

Definition at line 486 of file ApiParseTest.php.

References $res, assertParsedTo(), ApiTestCase\doApiRequest(), and ApiTestCase\editPage().

◆ testRevDel()

ApiParseTest::testRevDel ( )

Definition at line 181 of file ApiParseTest.php.

References $res, assertParsedTo(), and ApiTestCase\doApiRequest().

◆ testRevDelNoPermission()

ApiParseTest::testRevDelNoPermission ( )

Definition at line 192 of file ApiParseTest.php.

References ApiTestCase\doApiRequest().

◆ testRevId()

ApiParseTest::testRevId ( )

Definition at line 393 of file ApiParseTest.php.

References $res, assertParsedTo(), and ApiTestCase\doApiRequest().

◆ testRevidNoText()

ApiParseTest::testRevidNoText ( )

Definition at line 414 of file ApiParseTest.php.

References $res, assertParsedTo(), and ApiTestCase\doApiRequest().

◆ testSection()

ApiParseTest::testSection ( )

Definition at line 241 of file ApiParseTest.php.

References $res, assertParsedToRegExp(), ApiTestCase\doApiRequest(), and ApiTestCase\editPage().

◆ testSectionNoContent()

ApiParseTest::testSectionNoContent ( )

Definition at line 266 of file ApiParseTest.php.

References ApiTestCase\doApiRequest(), and ApiTestCase\editPage().

◆ testSerializationError()

ApiParseTest::testSerializationError ( )

Definition at line 435 of file ApiParseTest.php.

References ApiTestCase\doApiRequest(), and MediaWikiTestCase\mergeMwGlobalArrayValue().

◆ testSuppressed()

ApiParseTest::testSuppressed ( )

Definition at line 202 of file ApiParseTest.php.

References $res, assertParsedTo(), ApiTestCase\doApiRequest(), and MediaWikiTestCase\setGroupPermissions().

◆ testTextNoContentModel()

ApiParseTest::testTextNoContentModel ( )

Definition at line 425 of file ApiParseTest.php.

References $res, assertParsedTo(), and ApiTestCase\doApiRequest().

◆ testTitleNoText()

ApiParseTest::testTitleNoText ( )

Definition at line 403 of file ApiParseTest.php.

References $res, assertParsedTo(), and ApiTestCase\doApiRequest().

◆ testTitleProvided()

ApiParseTest::testTitleProvided ( )

Definition at line 231 of file ApiParseTest.php.

References $res, assertParsedTo(), and ApiTestCase\doApiRequest().

◆ testTitleWithNonexistentRevId()

ApiParseTest::testTitleWithNonexistentRevId ( )

Definition at line 368 of file ApiParseTest.php.

References ApiTestCase\doApiRequest().

◆ testTitleWithNonMatchingRevId()

ApiParseTest::testTitleWithNonMatchingRevId ( )

Definition at line 379 of file ApiParseTest.php.

References $res, assertParsedTo(), and ApiTestCase\doApiRequest().

◆ testUnfollowedRedirect()

ApiParseTest::testUnfollowedRedirect ( )

Definition at line 312 of file ApiParseTest.php.

References $res, ApiTestCase\doApiRequest(), and ApiTestCase\editPage().

Member Data Documentation

◆ $pageId

ApiParseTest::$pageId

staticprotected

Definition at line 12 of file ApiParseTest.php.

◆ $revIds

ApiParseTest::$revIds = []

staticprotected

Definition at line 13 of file ApiParseTest.php.

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

tests/phpunit/includes/api/ApiParseTest.php

Public Member Functions

Protected Member Functions

Static Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addDBDataOnce()

◆ assertParsedTo()

◆ assertParsedToRegExp()

◆ doAssertParsedTo()

◆ doTestLangLinks()

◆ setupInterwiki()

◆ setupSkin()

◆ testCategoriesHtml()

◆ testDisableTidy()

◆ testEffectiveLangLinks()

◆ testExistingSection()

◆ testFollowedRedirect()

◆ testFollowedRedirectById()

◆ testFormatCategories()

◆ testHeadHtml()

◆ testHeadItems()

◆ testHeadItemsWithSkin()

◆ testIndicators()

◆ testIndicatorsWithSkin()

◆ testInvalidSection()

◆ testInvalidTitle()

◆ testIwlinks()

◆ testLangLinks()

◆ testLangLinksWithSkin()

◆ testLimitReports()

◆ testModules()

◆ testModulesWithSkin()

◆ testNewSection()

◆ testNewSectionWithPage()

◆ testNonexistentOldId()

◆ testNonexistentPage()

◆ testNoPst()

◆ testOnlyPst()

◆ testParseById()

◆ testParseByName()

◆ testParseByOldId()

◆ testParseTree()

◆ testParseTreeNonWikitext()

◆ testPst()

◆ testRevDel()

◆ testRevDelNoPermission()

◆ testRevId()

◆ testRevidNoText()

◆ testSection()

◆ testSectionNoContent()

◆ testSerializationError()

◆ testSuppressed()

◆ testTextNoContentModel()

◆ testTitleNoText()

◆ testTitleProvided()

◆ testTitleWithNonexistentRevId()

◆ testTitleWithNonMatchingRevId()

◆ testUnfollowedRedirect()

Member Data Documentation

◆ $pageId

◆ $revIds