MediaWiki REL1_28
ApiQueryWatchlistIntegrationTest Class Reference

API Database medium. More...

Inheritance diagram for ApiQueryWatchlistIntegrationTest:
Collaboration diagram for ApiQueryWatchlistIntegrationTest:

Public Member Functions

 __construct ( $name=null, array $data=[], $dataName='')
 testAllRevParam ()
 testCategorizeTypeParameter ()
 testCommentPropParameter ()
 testContinueParam ()
 testDirParams ()
 testEmptyPropParameter ()
 testExcludeUserParam ()
 testExternalTypeParameters ()
 testFlagsPropParameter ()
 testGeneratorWatchlistPropInfo_returnsWatchedPages ()
 testGeneratorWatchlistPropRevisions_returnsWatchedItemsRevisions ()
 testIdsPropParameter ()
 testLimitParam ()
 testListWatchlist_returnsWatchedItemsWithRCInfo ()
 testLoginfoPropParameter ()
 testLogTypeParameters ()
 testNamespaceParam ()
 testNewAndEditTypeParameters ()
 testNotificationTimestampPropParameter ()
 testOwnerAndTokenParams ()
 testOwnerAndTokenParams_noWatchlistTokenSet ()
 testOwnerAndTokenParams_wrongToken ()
 testParsedCommentPropParameter ()
 testPatrolPropParameter ()
 testShowAnonParams ()
 testShowBotParams ()
 testShowMinorParams ()
 testShowPatrolledParams ()
 testShowUnreadParams ()
 testSizesPropParameter ()
 testStartEndParams ()
 testTimestampPropParameter ()
 testTitlePropParameter ()
 testUserIdPropParameter ()
 testUserParam ()
 testUserPropParameter ()
- Public Member Functions inherited from ApiTestCase
 testApiTestGroup ()
- Public Member Functions inherited from MediaWikiTestCase
 __call ( $func, $args)
 __destruct ()
 addDBData ()
 addDBDataOnce ()
 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)
 setupAllTestDBs ()
 Set up all test DBs.
 setUserLang ( $lang)
 testMediaWikiTestCaseParentSetupCalled ()
 Make sure MediaWikiTestCase extending classes have called their parent setUp method.
 usesTemporaryTables ()

Protected Member Functions

 setUp ()
- Protected Member Functions inherited from ApiTestCase
 doApiRequest (array $params, array $session=null, $appendModule=false, User $user=null)
 Does the API request and returns the result.
 doApiRequestWithToken (array $params, array $session=null, User $user=null)
 Add an edit token to the API request This is cheating a bit – we grab a token in the correct format and then add it to the pseudo-session and to the request, without actually requesting a "real" edit token.
 doLogin ( $testUser='sysop')
 editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
 Edits or creates a page/revision.
 getTokenList (TestUser $user, $session=null)
 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.
 assertHTMLEquals ( $expected, $actual, $msg='')
 Put each HTML element on its own line and then equals() the results.
 assertSelect ( $table, $fields, $condition, array $expectedRows)
 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.
 assertValidHtmlDocument ( $html)
 Asserts that the given string is valid HTML document.
 assertValidHtmlSnippet ( $html)
 Asserts that the given string is a valid HTML snippet.
 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.
 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)
 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()

Private Member Functions

 assertArraySubsetsEqual (array $actualItems, array $expectedItems, array $keysUsedInValueComparison, array $requiredKeys=[])
 Convenience method to assert that actual items array fetched from API is equal to the expected array, Unlike assertEquals this only checks if values of specified keys are equal in both arrays.
 cleanTestUsersWatchlist ()
 createPageAndDeleteIt (LinkTarget $target)
 deletePage (LinkTarget $target, $reason)
 doAnonPageEdit (LinkTarget $target, $content, $summary)
 doBotPageEdit (User $user, LinkTarget $target, $content, $summary)
 doGeneratorWatchlistRequest (array $params=[])
 doListWatchlistRequest (array $params=[], $user=null)
 doMinorPageEdit (User $user, LinkTarget $target, $content, $summary)
 doPageEdit (User $user, LinkTarget $target, $content, $summary)
 doPageEdits (User $user, array $editData)
 Performs a batch of page edits as a specified user.
 doPatrolledPageEdit (User $user, LinkTarget $target, $content, $summary, User $patrollingUser)
 getExternalRC (LinkTarget $target)
 getItemsFromApiResponse (array $response)
 getLoggedInTestUser ()
 getNonLoggedInTestUser ()
 getPrefixedText (LinkTarget $target)
 getTitleFormatter ()
 getWatchedItemStore ()
 setupPatrolledSpecificFixtures (User $user)
 watchPages (User $user, array $targets)

Additional Inherited Members

- Static Public Member Functions inherited from MediaWikiTestCase
static assertNotTag ( $matcher, $actual, $message='', $isHtml=true)
static assertTag ( $matcher, $actual, $message='', $isHtml=true)
 Note: we are overriding this method to remove the deprecated error.
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 (Database $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 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 (Database $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 = []
- Static Protected Attributes inherited from ApiTestCase
static $apiUrl

Detailed Description

API Database medium.


Definition at line 13 of file ApiQueryWatchlistIntegrationTest.php.

Constructor & Destructor Documentation

◆ __construct()

ApiQueryWatchlistIntegrationTest::__construct (   $name = null,
array  $data = [],
  $dataName = '' 

Reimplemented from MediaWikiTestCase.

Definition at line 15 of file ApiQueryWatchlistIntegrationTest.php.

References $name.

Member Function Documentation

◆ assertArraySubsetsEqual()

ApiQueryWatchlistIntegrationTest::assertArraySubsetsEqual ( array  $actualItems,
array  $expectedItems,
array  $keysUsedInValueComparison,
array  $requiredKeys = [] 

Convenience method to assert that actual items array fetched from API is equal to the expected array, Unlike assertEquals this only checks if values of specified keys are equal in both arrays.

This could be used e.g. not to compare IDs that could change between test run but only stable keys. Optionally this also checks that specified keys are present in the actual item without performing any checks on the related values.

array$actualItemsarray of actual items (associative arrays)
array$expectedItemsarray of expected items (associative arrays), those items have less keys than actual items
array$keysUsedInValueComparisonlist of keys of the actual item that will be used in the comparison of values
array$requiredKeysoptional, list of keys that must be present in the actual items. Values of those keys are not checked.

Definition at line 203 of file ApiQueryWatchlistIntegrationTest.php.

References array(), as, and use.

Referenced by testGeneratorWatchlistPropInfo_returnsWatchedPages(), testGeneratorWatchlistPropRevisions_returnsWatchedItemsRevisions(), testListWatchlist_returnsWatchedItemsWithRCInfo(), testLoginfoPropParameter(), testNamespaceParam(), testShowAnonParams(), testShowBotParams(), and testShowMinorParams().

◆ cleanTestUsersWatchlist()

ApiQueryWatchlistIntegrationTest::cleanTestUsersWatchlist ( )

◆ createPageAndDeleteIt()

ApiQueryWatchlistIntegrationTest::createPageAndDeleteIt ( LinkTarget  $target)

◆ deletePage()

ApiQueryWatchlistIntegrationTest::deletePage ( LinkTarget  $target,

Definition at line 107 of file ApiQueryWatchlistIntegrationTest.php.

References $page, $title, and WikiPage\factory().

Referenced by createPageAndDeleteIt().

◆ doAnonPageEdit()

ApiQueryWatchlistIntegrationTest::doAnonPageEdit ( LinkTarget  $target,

◆ doBotPageEdit()

ApiQueryWatchlistIntegrationTest::doBotPageEdit ( User  $user,
LinkTarget  $target,

◆ doGeneratorWatchlistRequest()

ApiQueryWatchlistIntegrationTest::doGeneratorWatchlistRequest ( array  $params = [])

◆ doListWatchlistRequest()

◆ doMinorPageEdit()

ApiQueryWatchlistIntegrationTest::doMinorPageEdit ( User  $user,
LinkTarget  $target,

◆ doPageEdit()

◆ doPageEdits()

ApiQueryWatchlistIntegrationTest::doPageEdits ( User  $user,
array  $editData 

Performs a batch of page edits as a specified user.

array$editDataassociative array, keys:
  • target => LinkTarget page to edit
  • content => string new content
  • summary => string edit summary
  • minorEdit => bool mark as minor edit if true (defaults to false)
  • botEdit => bool mark as bot edit if true (defaults to false)

Definition at line 123 of file ApiQueryWatchlistIntegrationTest.php.

References as, doBotPageEdit(), doMinorPageEdit(), and doPageEdit().

Referenced by testAllRevParam(), testCategorizeTypeParameter(), testContinueParam(), testDirParams(), testFlagsPropParameter(), testGeneratorWatchlistPropRevisions_returnsWatchedItemsRevisions(), testLimitParam(), testNamespaceParam(), testNewAndEditTypeParameters(), testShowMinorParams(), and testTitlePropParameter().

◆ doPatrolledPageEdit()

ApiQueryWatchlistIntegrationTest::doPatrolledPageEdit ( User  $user,
LinkTarget  $target,
User  $patrollingUser 

◆ getExternalRC()

ApiQueryWatchlistIntegrationTest::getExternalRC ( LinkTarget  $target)

Definition at line 1061 of file ApiQueryWatchlistIntegrationTest.php.

References $title, RC_EXTERNAL, TS_MW, and wfTimestamp().

Referenced by testExternalTypeParameters().

◆ getItemsFromApiResponse()

◆ getLoggedInTestUser()

◆ getNonLoggedInTestUser()

◆ getPrefixedText()

ApiQueryWatchlistIntegrationTest::getPrefixedText ( LinkTarget  $target)

◆ getTitleFormatter()

ApiQueryWatchlistIntegrationTest::getTitleFormatter ( )

Definition at line 231 of file ApiQueryWatchlistIntegrationTest.php.

Referenced by getPrefixedText().

◆ getWatchedItemStore()

ApiQueryWatchlistIntegrationTest::getWatchedItemStore ( )

◆ setUp()

ApiQueryWatchlistIntegrationTest::setUp ( )

◆ setupPatrolledSpecificFixtures()

ApiQueryWatchlistIntegrationTest::setupPatrolledSpecificFixtures ( User  $user)

◆ testAllRevParam()

ApiQueryWatchlistIntegrationTest::testAllRevParam ( )

◆ testCategorizeTypeParameter()

ApiQueryWatchlistIntegrationTest::testCategorizeTypeParameter ( )

◆ testCommentPropParameter()

ApiQueryWatchlistIntegrationTest::testCommentPropParameter ( )

◆ testContinueParam()

ApiQueryWatchlistIntegrationTest::testContinueParam ( )

◆ testDirParams()

ApiQueryWatchlistIntegrationTest::testDirParams ( )

◆ testEmptyPropParameter()

ApiQueryWatchlistIntegrationTest::testEmptyPropParameter ( )

◆ testExcludeUserParam()

ApiQueryWatchlistIntegrationTest::testExcludeUserParam ( )

◆ testExternalTypeParameters()

ApiQueryWatchlistIntegrationTest::testExternalTypeParameters ( )

◆ testFlagsPropParameter()

ApiQueryWatchlistIntegrationTest::testFlagsPropParameter ( )

◆ testGeneratorWatchlistPropInfo_returnsWatchedPages()

ApiQueryWatchlistIntegrationTest::testGeneratorWatchlistPropInfo_returnsWatchedPages ( )

◆ testGeneratorWatchlistPropRevisions_returnsWatchedItemsRevisions()

ApiQueryWatchlistIntegrationTest::testGeneratorWatchlistPropRevisions_returnsWatchedItemsRevisions ( )

◆ testIdsPropParameter()

ApiQueryWatchlistIntegrationTest::testIdsPropParameter ( )

◆ testLimitParam()

ApiQueryWatchlistIntegrationTest::testLimitParam ( )

◆ testListWatchlist_returnsWatchedItemsWithRCInfo()

ApiQueryWatchlistIntegrationTest::testListWatchlist_returnsWatchedItemsWithRCInfo ( )

◆ testLoginfoPropParameter()

ApiQueryWatchlistIntegrationTest::testLoginfoPropParameter ( )

◆ testLogTypeParameters()

ApiQueryWatchlistIntegrationTest::testLogTypeParameters ( )

◆ testNamespaceParam()

◆ testNewAndEditTypeParameters()

ApiQueryWatchlistIntegrationTest::testNewAndEditTypeParameters ( )

◆ testNotificationTimestampPropParameter()

ApiQueryWatchlistIntegrationTest::testNotificationTimestampPropParameter ( )

◆ testOwnerAndTokenParams()

ApiQueryWatchlistIntegrationTest::testOwnerAndTokenParams ( )

◆ testOwnerAndTokenParams_noWatchlistTokenSet()

ApiQueryWatchlistIntegrationTest::testOwnerAndTokenParams_noWatchlistTokenSet ( )

◆ testOwnerAndTokenParams_wrongToken()

ApiQueryWatchlistIntegrationTest::testOwnerAndTokenParams_wrongToken ( )

◆ testParsedCommentPropParameter()

ApiQueryWatchlistIntegrationTest::testParsedCommentPropParameter ( )

◆ testPatrolPropParameter()

ApiQueryWatchlistIntegrationTest::testPatrolPropParameter ( )

◆ testShowAnonParams()

ApiQueryWatchlistIntegrationTest::testShowAnonParams ( )

◆ testShowBotParams()

ApiQueryWatchlistIntegrationTest::testShowBotParams ( )

◆ testShowMinorParams()

ApiQueryWatchlistIntegrationTest::testShowMinorParams ( )

◆ testShowPatrolledParams()

ApiQueryWatchlistIntegrationTest::testShowPatrolledParams ( )

◆ testShowUnreadParams()

ApiQueryWatchlistIntegrationTest::testShowUnreadParams ( )

◆ testSizesPropParameter()

ApiQueryWatchlistIntegrationTest::testSizesPropParameter ( )

◆ testStartEndParams()

ApiQueryWatchlistIntegrationTest::testStartEndParams ( )

◆ testTimestampPropParameter()

ApiQueryWatchlistIntegrationTest::testTimestampPropParameter ( )

◆ testTitlePropParameter()

ApiQueryWatchlistIntegrationTest::testTitlePropParameter ( )

◆ testUserIdPropParameter()

ApiQueryWatchlistIntegrationTest::testUserIdPropParameter ( )

◆ testUserParam()

ApiQueryWatchlistIntegrationTest::testUserParam ( )

◆ testUserPropParameter()

ApiQueryWatchlistIntegrationTest::testUserPropParameter ( )

◆ watchPages()

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