MediaWiki  master
ApiStashEditTest Class Reference

ApiStashEdit \MediaWiki\Storage\PageEditStash API medium Database. More...

Inheritance diagram for ApiStashEditTest:
Collaboration diagram for ApiStashEditTest:

Public Member Functions

 setUp ()
 
 signatureProvider ()
 
 tearDown ()
 
 testBasicEdit ()
 
 testBot ()
 
 testBusy ()
 
 testCheckCache ()
 
 testCheckCacheAnon ()
 
 testCheckCacheInterveningEdits ()
 
 testCheckCacheOldNoEdits ()
 
 testCheckCacheOldNoEditsAnon ()
 
 testDeletedRevision ()
 
 testDeletedRevisionSection ()
 
 testEditConflict ()
 
 testExistingPage ()
 
 testHashNormalization ()
 
 testInterveningEdit ()
 
 testIsInternal ()
 
 testMalformedStashedTextHash ()
 
 testMissingStashedTextHash ()
 
 testMissingTextAndStashedTextHash ()
 
 testNonexistentBaseRevId ()
 
 testPageWithNoRevisions ()
 
 testPingLimiter ()
 
 testSignatureTtl ( $text, $ttl)
 signatureProvider More...
 
 testStashedTextHash ()
 
 testUnrecognizedFormat ()
 
- Public Member Functions inherited from ApiTestCase
 testApiTestGroup ()
 

Protected Member Functions

 doCheckCache (User $user, $text='Content')
 Shortcut for calling PageStashEdit::checkCache() without having to create Titles and Contents in every test. More...
 
 doStash (array $params=[], User $user=null, $expectedResult='stashed')
 Make a stashedit API call with suitable default parameters. More...
 
 doStashOld (User $user, $text='Content', $howOld=PageEditStash::PRESUME_FRESH_TTL_SEC)
 Stash an edit some time in the past, for testing expiry and freshness logic. More...
 
 getStashedText ( $hash)
 Return the text stashed for $hash. More...
 
 getStashKey ( $title=__CLASS__, $text='Content', User $user=null)
 Return a key that can be passed to the cache to obtain a stashed edit object. More...
 
- 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. More...
 
 doApiRequestWithToken (array $params, array $session=null, User $user=null, $tokenType='auto')
 Convenience function to access the token parameter of doApiRequest() more succinctly. More...
 
 doLogin ( $testUser=null)
 Previously this would do API requests to log in, as well as setting $wgUser and the request context's user. More...
 
 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. More...
 
 setUp ()
 
 tearDown ()
 
- Protected Member Functions inherited from MediaWikiLangTestCase
 setUp ()
 

Additional Inherited Members

- Static Public Member Functions inherited from ApiTestCase
static apiExceptionHasCode (ApiUsageException $ex, $code)
 
- Static Protected Member Functions inherited from ApiTestCase
static getErrorFormatter ()
 
- Protected Attributes inherited from ApiTestCase
ApiTestContext $apiContext
 
- Static Protected Attributes inherited from ApiTestCase
static $apiUrl
 
static $errorFormatter = null
 

Detailed Description

ApiStashEdit \MediaWiki\Storage\PageEditStash API medium Database.

Definition at line 15 of file ApiStashEditTest.php.

Member Function Documentation

◆ doCheckCache()

ApiStashEditTest::doCheckCache ( User  $user,
  $text = 'Content' 
)
protected

Shortcut for calling PageStashEdit::checkCache() without having to create Titles and Contents in every test.

Parameters
User$user
string$textThe text of the article
Returns
stdClass|bool Return value of PageStashEdit::checkCache(), false if not in cache

Definition at line 287 of file ApiStashEditTest.php.

References Title\newFromText().

Referenced by testCheckCache(), testCheckCacheAnon(), testCheckCacheInterveningEdits(), testCheckCacheOldNoEdits(), and testCheckCacheOldNoEditsAnon().

◆ doStash()

ApiStashEditTest::doStash ( array  $params = [],
User  $user = null,
  $expectedResult = 'stashed' 
)
protected

Make a stashedit API call with suitable default parameters.

Parameters
array$paramsQuery parameters for API request. All are optional and will have sensible defaults filled in. To make a parameter actually not passed, set to null.
User$userUser to do the request
string$expectedResult'stashed', 'editconflict'
Returns
array

Definition at line 42 of file ApiStashEditTest.php.

References $params, $res, $user, as, ApiTestCase\doApiRequestWithToken(), getStashedText(), and null.

Referenced by doStashOld(), testBasicEdit(), testBot(), testBusy(), testCheckCache(), testCheckCacheAnon(), testDeletedRevision(), testDeletedRevisionSection(), testEditConflict(), testExistingPage(), testHashNormalization(), testInterveningEdit(), testMalformedStashedTextHash(), testMissingStashedTextHash(), testMissingTextAndStashedTextHash(), testNonexistentBaseRevId(), testPageWithNoRevisions(), testPingLimiter(), testSignatureTtl(), testStashedTextHash(), and testUnrecognizedFormat().

◆ doStashOld()

ApiStashEditTest::doStashOld ( User  $user,
  $text = 'Content',
  $howOld = PageEditStash::PRESUME_FRESH_TTL_SEC 
)
protected

Stash an edit some time in the past, for testing expiry and freshness logic.

Parameters
User$userWho's doing the editing
string$textWhat text should be cached
int$howOldHow many seconds is "old" (we actually set it one second before this)

Definition at line 338 of file ApiStashEditTest.php.

References $cache, doStash(), getStashKey(), and wfTimestamp().

Referenced by testCheckCacheInterveningEdits(), testCheckCacheOldNoEdits(), and testCheckCacheOldNoEditsAnon().

◆ getStashedText()

ApiStashEditTest::getStashedText (   $hash)
protected

Return the text stashed for $hash.

Parameters
string$hash
Returns
string

Definition at line 104 of file ApiStashEditTest.php.

Referenced by doStash(), and testHashNormalization().

◆ getStashKey()

ApiStashEditTest::getStashKey (   $title = __CLASS__,
  $text = 'Content',
User  $user = null 
)
protected

Return a key that can be passed to the cache to obtain a stashed edit object.

Parameters
string$titleTitle of page
stringContent $text Content of edit
User$userUser who made edit
Returns
string

Definition at line 116 of file ApiStashEditTest.php.

References $content, $title, $user, and Title\newFromText().

Referenced by doStashOld(), testBusy(), and testSignatureTtl().

◆ setUp()

ApiStashEditTest::setUp ( )

Definition at line 16 of file ApiStashEditTest.php.

◆ signatureProvider()

ApiStashEditTest::signatureProvider ( )

Definition at line 408 of file ApiStashEditTest.php.

◆ tearDown()

ApiStashEditTest::tearDown ( )

Definition at line 29 of file ApiStashEditTest.php.

◆ testBasicEdit()

ApiStashEditTest::testBasicEdit ( )

Definition at line 128 of file ApiStashEditTest.php.

References doStash().

◆ testBot()

ApiStashEditTest::testBot ( )

Definition at line 132 of file ApiStashEditTest.php.

References doStash(), and ApiTestCase\setExpectedApiException().

◆ testBusy()

ApiStashEditTest::testBusy ( )

Definition at line 426 of file ApiStashEditTest.php.

References doStash(), getStashKey(), and null.

◆ testCheckCache()

ApiStashEditTest::testCheckCache ( )

Definition at line 295 of file ApiStashEditTest.php.

References $user, class, doCheckCache(), and doStash().

◆ testCheckCacheAnon()

ApiStashEditTest::testCheckCacheAnon ( )

Definition at line 323 of file ApiStashEditTest.php.

References $user, class, doCheckCache(), doStash(), and User\newFromName().

◆ testCheckCacheInterveningEdits()

ApiStashEditTest::testCheckCacheInterveningEdits ( )

Definition at line 377 of file ApiStashEditTest.php.

References $user, doCheckCache(), and doStashOld().

◆ testCheckCacheOldNoEdits()

ApiStashEditTest::testCheckCacheOldNoEdits ( )

Definition at line 358 of file ApiStashEditTest.php.

References $user, class, doCheckCache(), and doStashOld().

◆ testCheckCacheOldNoEditsAnon()

ApiStashEditTest::testCheckCacheOldNoEditsAnon ( )

Definition at line 367 of file ApiStashEditTest.php.

References $user, class, doCheckCache(), doStashOld(), and User\newFromName().

◆ testDeletedRevision()

ApiStashEditTest::testDeletedRevision ( )

Definition at line 237 of file ApiStashEditTest.php.

References $name, doStash(), and ApiTestCase\setExpectedApiException().

◆ testDeletedRevisionSection()

ApiStashEditTest::testDeletedRevisionSection ( )

Definition at line 253 of file ApiStashEditTest.php.

References $name, doStash(), and ApiTestCase\setExpectedApiException().

◆ testEditConflict()

ApiStashEditTest::testEditConflict ( )

Definition at line 225 of file ApiStashEditTest.php.

References $name, doStash(), and null.

◆ testExistingPage()

ApiStashEditTest::testExistingPage ( )

Definition at line 206 of file ApiStashEditTest.php.

References $name, $rev, and doStash().

◆ testHashNormalization()

ApiStashEditTest::testHashNormalization ( )

Definition at line 171 of file ApiStashEditTest.php.

References doStash(), and getStashedText().

◆ testInterveningEdit()

ApiStashEditTest::testInterveningEdit ( )

Definition at line 213 of file ApiStashEditTest.php.

References $name, and doStash().

◆ testIsInternal()

ApiStashEditTest::testIsInternal ( )

Definition at line 416 of file ApiStashEditTest.php.

References $res, and ApiTestCase\doApiRequest().

◆ testMalformedStashedTextHash()

ApiStashEditTest::testMalformedStashedTextHash ( )

Definition at line 161 of file ApiStashEditTest.php.

References doStash(), and ApiTestCase\setExpectedApiException().

◆ testMissingStashedTextHash()

ApiStashEditTest::testMissingStashedTextHash ( )

Definition at line 166 of file ApiStashEditTest.php.

References doStash(), and ApiTestCase\setExpectedApiException().

◆ testMissingTextAndStashedTextHash()

ApiStashEditTest::testMissingTextAndStashedTextHash ( )

◆ testNonexistentBaseRevId()

ApiStashEditTest::testNonexistentBaseRevId ( )

Definition at line 180 of file ApiStashEditTest.php.

References $name, doStash(), and ApiTestCase\setExpectedApiException().

◆ testPageWithNoRevisions()

ApiStashEditTest::testPageWithNoRevisions ( )

◆ testPingLimiter()

ApiStashEditTest::testPingLimiter ( )

Definition at line 270 of file ApiStashEditTest.php.

References doStash(), and null.

◆ testSignatureTtl()

ApiStashEditTest::testSignatureTtl (   $text,
  $ttl 
)

signatureProvider

Parameters
string$textWhich signature to test (~~~, ~~~~, or ~~~~~)
int$ttlExpected TTL in seconds

Definition at line 395 of file ApiStashEditTest.php.

References $cache, doStash(), getStashKey(), and HashBagOStuff\KEY_EXP.

◆ testStashedTextHash()

ApiStashEditTest::testStashedTextHash ( )

Definition at line 155 of file ApiStashEditTest.php.

References $res, and doStash().

◆ testUnrecognizedFormat()

ApiStashEditTest::testUnrecognizedFormat ( )

Definition at line 139 of file ApiStashEditTest.php.

References doStash(), and ApiTestCase\setExpectedApiException().


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