MediaWiki  REL1_31
ApiTestCase.php
Go to the documentation of this file.
1 <?php
2 
4 
5 abstract class ApiTestCase extends MediaWikiLangTestCase {
6  protected static $apiUrl;
7 
8  protected static $errorFormatter = null;
9 
13  protected $apiContext;
14 
15  protected function setUp() {
17 
18  parent::setUp();
19  self::$apiUrl = $wgServer . wfScript( 'api' );
20 
21  ApiQueryInfo::resetTokenCache(); // tokens are invalid because we cleared the session
22 
23  self::$users = [
24  'sysop' => static::getTestSysop(),
25  'uploader' => static::getTestUser(),
26  ];
27 
28  $this->setMwGlobals( [
29  'wgAuth' => new MediaWiki\Auth\AuthManagerAuthPlugin,
30  'wgRequest' => new FauxRequest( [] ),
31  'wgUser' => self::$users['sysop']->getUser(),
32  ] );
33 
34  $this->apiContext = new ApiTestContext();
35  }
36 
37  protected function tearDown() {
38  // Avoid leaking session over tests
40 
41  parent::tearDown();
42  }
43 
52  protected function editPage( $pageName, $text, $summary = '', $defaultNs = NS_MAIN ) {
53  $title = Title::newFromText( $pageName, $defaultNs );
54  $page = WikiPage::factory( $title );
55 
56  return $page->doEditContent( ContentHandler::makeContent( $text, $title ), $summary );
57  }
58 
67  protected function revisionDelete(
68  $rev, array $value = [ Revision::DELETED_TEXT => 1 ], $comment = ''
69  ) {
70  if ( is_int( $rev ) ) {
72  }
74  'revision', RequestContext::getMain(), $rev->getTitle(), [ $rev->getId() ]
75  )->setVisibility( [
76  'value' => $value,
77  'comment' => $comment,
78  ] );
79  }
80 
100  protected function doApiRequest( array $params, array $session = null,
101  $appendModule = false, User $user = null, $tokenType = null
102  ) {
104 
105  if ( is_null( $session ) ) {
106  // re-use existing global session by default
107  $session = $wgRequest->getSessionArray();
108  }
109 
110  $sessionObj = SessionManager::singleton()->getEmptySession();
111 
112  if ( $session !== null ) {
113  foreach ( $session as $key => $value ) {
114  $sessionObj->set( $key, $value );
115  }
116  }
117 
118  // set up global environment
119  if ( $user ) {
120  $wgUser = $user;
121  }
122 
123  if ( $tokenType !== null ) {
124  if ( $tokenType === 'auto' ) {
125  $tokenType = ( new ApiMain() )->getModuleManager()
126  ->getModule( $params['action'], 'action' )->needsToken();
127  }
129  $wgUser, $sessionObj, ApiQueryTokens::getTokenTypeSalts()[$tokenType]
130  )->toString();
131  }
132 
133  $wgRequest = new FauxRequest( $params, true, $sessionObj );
134  RequestContext::getMain()->setRequest( $wgRequest );
135  RequestContext::getMain()->setUser( $wgUser );
137 
138  // set up local environment
139  $context = $this->apiContext->newTestContext( $wgRequest, $wgUser );
140 
141  $module = new ApiMain( $context, true );
142 
143  // run it!
144  $module->execute();
145 
146  // construct result
147  $results = [
148  $module->getResult()->getResultData( null, [ 'Strip' => 'all' ] ),
149  $context->getRequest(),
150  $context->getRequest()->getSessionArray()
151  ];
152 
153  if ( $appendModule ) {
154  $results[] = $module;
155  }
156 
157  return $results;
158  }
159 
170  protected function doApiRequestWithToken( array $params, array $session = null,
171  User $user = null, $tokenType = 'auto'
172  ) {
173  return $this->doApiRequest( $params, $session, false, $user, $tokenType );
174  }
175 
186  protected function doLogin( $testUser = null ) {
187  global $wgUser;
188 
189  if ( $testUser === null ) {
190  $testUser = static::getTestSysop();
191  } elseif ( is_string( $testUser ) && array_key_exists( $testUser, self::$users ) ) {
192  $testUser = self::$users[$testUser];
193  } elseif ( !$testUser instanceof TestUser ) {
194  throw new MWException( "Can't log in to undefined user $testUser" );
195  }
196 
197  $wgUser = $testUser->getUser();
198  RequestContext::getMain()->setUser( $wgUser );
199  }
200 
201  protected function getTokenList( TestUser $user, $session = null ) {
202  $data = $this->doApiRequest( [
203  'action' => 'tokens',
204  'type' => 'edit|delete|protect|move|block|unblock|watch'
205  ], $session, false, $user->getUser() );
206 
207  if ( !array_key_exists( 'tokens', $data[0] ) ) {
208  throw new MWException( 'Api failed to return a token list' );
209  }
210 
211  return $data[0]['tokens'];
212  }
213 
214  protected static function getErrorFormatter() {
215  if ( self::$errorFormatter === null ) {
216  self::$errorFormatter = new ApiErrorFormatter(
217  new ApiResult( false ),
218  Language::factory( 'en' ),
219  'none'
220  );
221  }
222  return self::$errorFormatter;
223  }
224 
225  public static function apiExceptionHasCode( ApiUsageException $ex, $code ) {
226  return (bool)array_filter(
227  self::getErrorFormatter()->arrayFromStatus( $ex->getStatusValue() ),
228  function ( $e ) use ( $code ) {
229  return is_array( $e ) && $e['code'] === $code;
230  }
231  );
232  }
233 
237  public function testApiTestGroup() {
238  $groups = PHPUnit_Util_Test::getGroups( static::class );
239  $constraint = PHPUnit_Framework_Assert::logicalOr(
240  $this->contains( 'medium' ),
241  $this->contains( 'large' )
242  );
243  $this->assertThat( $groups, $constraint,
244  'ApiTestCase::setUp can be slow, tests must be "medium" or "large"'
245  );
246  }
247 
254  protected function setExpectedApiException(
255  $msg, $code = null, array $data = null, $httpCode = 0
256  ) {
257  $expected = ApiUsageException::newWithMessage( null, $msg, $code, $data, $httpCode );
258  $this->setExpectedException( ApiUsageException::class, $expected->getMessage() );
259  }
260 }
ApiUsageException\getStatusValue
getStatusValue()
Fetch the error status.
Definition: ApiUsageException.php:181
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
ApiMain
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:43
ApiTestCase\$errorFormatter
static $errorFormatter
Definition: ApiTestCase.php:8
$wgUser
$wgUser
Definition: Setup.php:902
FauxRequest
WebRequest clone which takes values from a provided array.
Definition: FauxRequest.php:33
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
ApiUsageException
Exception used to abort API execution with an error.
Definition: ApiUsageException.php:103
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
Revision\newFromId
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:114
array
the array() calling protocol came about after MediaWiki 1.4rc1.
ApiTestCase\tearDown
tearDown()
Definition: ApiTestCase.php:37
ApiQueryInfo\resetTokenCache
static resetTokenCache()
Definition: ApiQueryInfo.php:126
$params
$params
Definition: styleTest.css.php:40
ApiTestCase\testApiTestGroup
testApiTestGroup()
@coversNothing
Definition: ApiTestCase.php:237
ApiUsageException\newWithMessage
static newWithMessage(ApiBase $module=null, $msg, $code=null, $data=null, $httpCode=0)
Definition: ApiUsageException.php:143
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
TestUser
Wraps the user object, so we can also retain full access to properties like password if we log in via...
Definition: TestUser.php:7
NS_MAIN
const NS_MAIN
Definition: Defines.php:74
ApiTestCase\getTokenList
getTokenList(TestUser $user, $session=null)
Definition: ApiTestCase.php:201
ApiTestCase\doApiRequest
doApiRequest(array $params, array $session=null, $appendModule=false, User $user=null, $tokenType=null)
Does the API request and returns the result.
Definition: ApiTestCase.php:100
MWException
MediaWiki exception.
Definition: MWException.php:26
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
wfScript
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:2890
ApiResult
This class represents the result of the API operations.
Definition: ApiResult.php:33
ApiTestCase\$apiUrl
static $apiUrl
Definition: ApiTestCase.php:6
MediaWikiTestCase\setMwGlobals
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition: MediaWikiTestCase.php:678
ApiQueryTokens\getTokenTypeSalts
static getTokenTypeSalts()
Get the salts for known token types.
Definition: ApiQueryTokens.php:63
MediaWiki
A helper class for throttling authentication attempts.
ApiTestCase\setUp
setUp()
Definition: ApiTestCase.php:15
function
when a variable name is used in a function
Definition: design.txt:93
ApiTestCase\doApiRequestWithToken
doApiRequestWithToken(array $params, array $session=null, User $user=null, $tokenType='auto')
Convenience function to access the token parameter of doApiRequest() more succinctly.
Definition: ApiTestCase.php:170
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
RevisionDeleter\createList
static createList( $typeName, IContextSource $context, Title $title, array $ids)
Instantiate the appropriate list class for a given list of IDs.
Definition: RevisionDeleter.php:83
MediaWiki\Auth\AuthManager\resetCache
static resetCache()
Reset the internal caching for unit testing.
Definition: AuthManager.php:2443
ContentHandler\makeContent
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
Definition: ContentHandler.php:129
MediaWiki\Session\SessionManager\getGlobalSession
static getGlobalSession()
Get the "global" session.
Definition: SessionManager.php:107
ApiTestCase
Definition: ApiTestCase.php:5
$value
$value
Definition: styleTest.css.php:45
ApiTestCase\editPage
editPage( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
Edits or creates a page/revision.
Definition: ApiTestCase.php:52
ApiTestContext
Definition: ApiTestContext.php:3
$wgServer
$wgServer
URL of the server.
Definition: DefaultSettings.php:106
MediaWiki\Session\SessionManager
This serves as the entry point to the MediaWiki session handling system.
Definition: SessionManager.php:50
MediaWikiLangTestCase
Base class that store and restore the Language objects.
Definition: MediaWikiLangTestCase.php:6
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:434
ApiErrorFormatter
Formats errors and warnings for the API, and add them to the associated ApiResult.
Definition: ApiErrorFormatter.php:30
$rev
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1777
ApiTestCase\$apiContext
ApiTestContext $apiContext
Definition: ApiTestCase.php:13
ApiTestCase\setExpectedApiException
setExpectedApiException( $msg, $code=null, array $data=null, $httpCode=0)
Expect an ApiUsageException to be thrown with the given parameters, which are the same as ApiUsageExc...
Definition: ApiTestCase.php:254
ApiQueryTokens\getToken
static getToken(User $user, MediaWiki\Session\Session $session, $salt)
Get a token from a salt.
Definition: ApiQueryTokens.php:94
$code
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:865
ApiTestCase\apiExceptionHasCode
static apiExceptionHasCode(ApiUsageException $ex, $code)
Definition: ApiTestCase.php:225
ApiTestCase\revisionDelete
revisionDelete( $rev, array $value=[Revision::DELETED_TEXT=> 1], $comment='')
Revision-deletes a revision.
Definition: ApiTestCase.php:67
ApiTestCase\getErrorFormatter
static getErrorFormatter()
Definition: ApiTestCase.php:214
ApiTestCase\doLogin
doLogin( $testUser=null)
Previously this would do API requests to log in, as well as setting $wgUser and the request context's...
Definition: ApiTestCase.php:186
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
Language\factory
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:183
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
$wgRequest
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:737
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
$context
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2811
Revision\DELETED_TEXT
const DELETED_TEXT
Definition: Revision.php:47
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171