These tests validate basic functionality of the api query module. More...

Inheritance diagram for ApiQueryBasicTest:

[legend]

Collaboration diagram for ApiQueryBasicTest:

[legend]

Public Member Functions
	addDBDataOnce ()

	testAllTogether ()
	Test basic lists.

	testGenerator ()
	Test basic lists.

	testGeneratorRedirects ()
	Test T53821.

	testLists ()
	Test basic lists.

	testProps ()
	Test basic props.

Public Member Functions inherited from ApiTestCase
	testApiTestGroup ()
	@coversNothing

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

	__destruct ()

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

Protected Attributes
	$exceptionFromAddDBData

Protected Attributes inherited from ApiTestCase
ApiTestContext	$apiContext

Protected Attributes inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

Static Private Attributes
static	$allcategories

static	$alllinks

static	$allpages

static	$alltransclusions

static	$backlinks

static	$categories

static	$categorymembers

static	$embeddedin

static	$generatorAllpages

static	$generatorLinks

static	$generatorLinksPropLinks

static	$generatorLinksPropTemplates

static	$links

static	$templates

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	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 (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 ApiQueryTestBase
const	PARAM_ASSERT =

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 ApiQueryTestBase
	assertResult ( $exp, $result, $message='')

	check ( $values, array $session=null, $appendModule=false, User $user=null)
	Checks that the request's result matches the expected results.

	merge ()
	Merges all requests parameter + expected values into one.

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.

	getTokenList (TestUser $user, $session=null)

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

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

	truncateTable ( $tableName, IDatabase $db=null)
	Empties the given table and resets any auto-increment counters.

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

Static Protected Attributes inherited from ApiTestCase
static	$apiUrl

static	$errorFormatter = null

Detailed Description

These tests validate basic functionality of the api query module.

API Database medium ApiQuery

Definition at line 31 of file ApiQueryBasicTest.php.

Member Function Documentation

◆ addDBDataOnce()

ApiQueryBasicTest::addDBDataOnce ( )

  Create a set of pages. These must not change, otherwise the tests might give wrong results.

See also: MediaWikiTestCase::addDBDataOnce()

Reimplemented from MediaWikiTestCase.

Definition at line 39 of file ApiQueryBasicTest.php.

References $e, MediaWikiTestCase\editPage(), and NS_TEMPLATE.

◆ testAllTogether()

ApiQueryBasicTest::testAllTogether ( )

Test basic lists.

Definition at line 245 of file ApiQueryBasicTest.php.

References check, and ApiQueryTestBase\merge().

◆ testGenerator()

ApiQueryBasicTest::testGenerator ( )

Test basic lists.

Definition at line 284 of file ApiQueryBasicTest.php.

References check, and ApiQueryTestBase\merge().

◆ testGeneratorRedirects()

ApiQueryBasicTest::testGeneratorRedirects ( )

Test T53821.

Definition at line 324 of file ApiQueryBasicTest.php.

References check, and MediaWikiTestCase\editPage().

◆ testLists()

ApiQueryBasicTest::testLists ( )

Test basic lists.

Definition at line 232 of file ApiQueryBasicTest.php.

References check.

◆ testProps()

ApiQueryBasicTest::testProps ( )

Test basic props.

Definition at line 223 of file ApiQueryBasicTest.php.

References check.

Member Data Documentation

◆ $allcategories

ApiQueryBasicTest::$allcategories

staticprivate

Initial value:

= [
        [ 'list' => 'allcategories', 'acprefix' => 'AQBT-' ],
        [ 'allcategories' => [
            [ 'category' => 'AQBT-Cat' ],
        ] ]
    ]

Definition at line 131 of file ApiQueryBasicTest.php.

◆ $alllinks

ApiQueryBasicTest::$alllinks

staticprivate

Initial value:

= [
        [ 'list' => 'alllinks', 'alprefix' => 'AQBT-' ],
        [ 'alllinks' => [
            [ 'ns' => 0, 'title' => 'AQBT-All' ],
            [ 'ns' => 0, 'title' => 'AQBT-Categories' ],
            [ 'ns' => 0, 'title' => 'AQBT-Links' ],
            [ 'ns' => 0, 'title' => 'AQBT-Templates' ],
        ] ]
    ]

Definition at line 112 of file ApiQueryBasicTest.php.

◆ $allpages

ApiQueryBasicTest::$allpages

staticprivate

Initial value:

= [
        [ 'list' => 'allpages', 'apprefix' => 'AQBT-' ],
        [ 'allpages' => [
            [ 'pageid' => 1, 'ns' => 0, 'title' => 'AQBT-All' ],
            [ 'pageid' => 2, 'ns' => 0, 'title' => 'AQBT-Categories' ],
            [ 'pageid' => 3, 'ns' => 0, 'title' => 'AQBT-Links' ],
            [ 'pageid' => 4, 'ns' => 0, 'title' => 'AQBT-Templates' ],
        ] ]
    ]

Definition at line 102 of file ApiQueryBasicTest.php.

◆ $alltransclusions

ApiQueryBasicTest::$alltransclusions

staticprivate

Initial value:

= [
        [ 'list' => 'alltransclusions', 'atprefix' => 'AQBT-' ],
        [ 'alltransclusions' => [
            [ 'ns' => 10, 'title' => 'Template:AQBT-T' ],
            [ 'ns' => 10, 'title' => 'Template:AQBT-T' ],
        ] ]
    ]

Definition at line 122 of file ApiQueryBasicTest.php.

◆ $backlinks

ApiQueryBasicTest::$backlinks

staticprivate

Initial value:

= [
        [ 'list' => 'backlinks', 'bltitle' => 'AQBT-Links' ],
        [ 'backlinks' => [
            [ 'pageid' => 1, 'ns' => 0, 'title' => 'AQBT-All' ],
        ] ]
    ]

Definition at line 138 of file ApiQueryBasicTest.php.

◆ $categories

ApiQueryBasicTest::$categories

staticprivate

Initial value:

= [
        [ 'prop' => 'categories', 'titles' => 'AQBT-All' ],
        [ 'pages' => [
            '1' => [
                'pageid' => 1,
                'ns' => 0,
                'title' => 'AQBT-All',
                'categories' => [
                    [ 'ns' => 14, 'title' => 'Category:AQBT-Cat' ],
                ]
            ]
        ] ]
    ]

Definition at line 88 of file ApiQueryBasicTest.php.

◆ $categorymembers

ApiQueryBasicTest::$categorymembers

staticprivate

Initial value:

= [
        [ 'list' => 'categorymembers', 'cmtitle' => 'Category:AQBT-Cat' ],
        [ 'categorymembers' => [
            [ 'pageid' => 1, 'ns' => 0, 'title' => 'AQBT-All' ],
            [ 'pageid' => 2, 'ns' => 0, 'title' => 'AQBT-Categories' ],
        ] ]
    ]

Definition at line 153 of file ApiQueryBasicTest.php.

◆ $embeddedin

ApiQueryBasicTest::$embeddedin

staticprivate

Initial value:

= [
        [ 'list' => 'embeddedin', 'eititle' => 'Template:AQBT-T' ],
        [ 'embeddedin' => [
            [ 'pageid' => 1, 'ns' => 0, 'title' => 'AQBT-All' ],
            [ 'pageid' => 4, 'ns' => 0, 'title' => 'AQBT-Templates' ],
        ] ]
    ]

Definition at line 145 of file ApiQueryBasicTest.php.

◆ $exceptionFromAddDBData

ApiQueryBasicTest::$exceptionFromAddDBData

protected

Definition at line 32 of file ApiQueryBasicTest.php.

◆ $generatorAllpages

ApiQueryBasicTest::$generatorAllpages

staticprivate

Initial value:

= [
        [ 'generator' => 'allpages', 'gapprefix' => 'AQBT-' ],
        [ 'pages' => [
            '1' => [
                'pageid' => 1,
                'ns' => 0,
                'title' => 'AQBT-All' ],
            '2' => [
                'pageid' => 2,
                'ns' => 0,
                'title' => 'AQBT-Categories' ],
            '3' => [
                'pageid' => 3,
                'ns' => 0,
                'title' => 'AQBT-Links' ],
            '4' => [
                'pageid' => 4,
                'ns' => 0,
                'title' => 'AQBT-Templates' ],
        ] ]
    ]

Definition at line 161 of file ApiQueryBasicTest.php.

◆ $generatorLinks

ApiQueryBasicTest::$generatorLinks

staticprivate

Initial value:

= [
        [ 'generator' => 'links', 'titles' => 'AQBT-Links' ],
        [ 'pages' => [
            '1' => [
                'pageid' => 1,
                'ns' => 0,
                'title' => 'AQBT-All' ],
            '2' => [
                'pageid' => 2,
                'ns' => 0,
                'title' => 'AQBT-Categories' ],
            '4' => [
                'pageid' => 4,
                'ns' => 0,
                'title' => 'AQBT-Templates' ],
        ] ]
    ]

Definition at line 183 of file ApiQueryBasicTest.php.

◆ $generatorLinksPropLinks

ApiQueryBasicTest::$generatorLinksPropLinks

staticprivate

Initial value:

= [
        [ 'prop' => 'links' ],
        [ 'pages' => [
            '1' => [ 'links' => [
                [ 'ns' => 0, 'title' => 'AQBT-Links' ],
            ] ]
        ] ]
    ]

Definition at line 201 of file ApiQueryBasicTest.php.

◆ $generatorLinksPropTemplates

ApiQueryBasicTest::$generatorLinksPropTemplates

staticprivate

Initial value:

= [
        [ 'prop' => 'templates' ],
        [ 'pages' => [
            '1' => [ 'templates' => [
                [ 'ns' => 10, 'title' => 'Template:AQBT-T' ] ] ],
            '4' => [ 'templates' => [
                [ 'ns' => 10, 'title' => 'Template:AQBT-T' ] ] ],
        ] ]
    ]

Definition at line 210 of file ApiQueryBasicTest.php.

◆ $links

ApiQueryBasicTest::$links

staticprivate

Initial value:

= [
        [ 'prop' => 'links', 'titles' => 'AQBT-All' ],
        [ 'pages' => [
            '1' => [
                'pageid' => 1,
                'ns' => 0,
                'title' => 'AQBT-All',
                'links' => [
                    [ 'ns' => 0, 'title' => 'AQBT-Links' ],
                ]
            ]
        ] ]
    ]

Definition at line 60 of file ApiQueryBasicTest.php.

◆ $templates

ApiQueryBasicTest::$templates

staticprivate

Initial value:

= [
        [ 'prop' => 'templates', 'titles' => 'AQBT-All' ],
        [ 'pages' => [
            '1' => [
                'pageid' => 1,
                'ns' => 0,
                'title' => 'AQBT-All',
                'templates' => [
                    [ 'ns' => 10, 'title' => 'Template:AQBT-T' ],
                ]
            ]
        ] ]
    ]

Definition at line 74 of file ApiQueryBasicTest.php.

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

tests/phpunit/includes/api/query/ApiQueryBasicTest.php

Public Member Functions

Protected Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addDBDataOnce()

◆ testAllTogether()

◆ testGenerator()

◆ testGeneratorRedirects()

◆ testLists()

◆ testProps()

Member Data Documentation

◆ $allcategories

◆ $alllinks

◆ $allpages

◆ $alltransclusions

◆ $backlinks

◆ $categories

◆ $categorymembers

◆ $embeddedin

◆ $exceptionFromAddDBData

◆ $generatorAllpages

◆ $generatorLinks

◆ $generatorLinksPropLinks

◆ $generatorLinksPropTemplates

◆ $links

◆ $templates