3 abstract class ApiTestCase
extends MediaWikiLangTestCase
{
5 * @var Array of ApiTestUser
8 protected static $apiUrl;
13 protected $apiContext;
16 global $wgContLang, $wgAuth, $wgMemc, $wgRequest, $wgUser, $wgServer;
19 self
::$apiUrl = $wgServer . wfScript( 'api' );
20 $wgMemc = new EmptyBagOStuff();
21 $wgContLang = Language
::factory( 'en' );
22 $wgAuth = new StubObject( 'wgAuth', 'AuthPlugin' );
23 $wgRequest = new FauxRequest( array() );
26 'sysop' => new ApiTestUser(
29 'api_test_sysop@example.com',
32 'uploader' => new ApiTestUser(
35 'api_test_user@example.com',
40 $wgUser = self
::$users['sysop']->user
;
42 $this->apiContext
= new ApiTestContext();
46 protected function doApiRequest( Array $params, Array $session = null, $appendModule = false, User
$user = null ) {
47 global $wgRequest, $wgUser;
49 if ( is_null( $session ) ) {
50 # re-use existing global session by default
51 $session = $wgRequest->getSessionArray();
54 # set up global environment
59 $wgRequest = new FauxRequest( $params, true, $session );
60 RequestContext
::getMain()->setRequest( $wgRequest );
62 # set up local environment
63 $context = $this->apiContext
->newTestContext( $wgRequest, $wgUser );
65 $module = new ApiMain( $context, true );
72 $module->getResultData(),
73 $context->getRequest(),
74 $context->getRequest()->getSessionArray()
84 * Add an edit token to the API request
85 * This is cheating a bit -- we grab a token in the correct format and then add it to the pseudo-session and to the
86 * request, without actually requesting a "real" edit token
87 * @param $params Array: key-value API params
88 * @param $session Array|null: session array
89 * @param $user User|null A User object for the context
91 protected function doApiRequestWithToken( Array $params, Array $session = null, User
$user = null ) {
94 if ( $session === null ) {
95 $session = $wgRequest->getSessionArray();
98 if ( $session['wsToken'] ) {
99 // add edit token to fake session
100 $session['wsEditToken'] = $session['wsToken'];
101 // add token to request parameters
102 $params['token'] = md5( $session['wsToken'] ) . User
::EDIT_TOKEN_SUFFIX
;
103 return $this->doApiRequest( $params, $session, false, $user );
105 throw new Exception( "request data not in right format" );
109 protected function doLogin() {
110 $data = $this->doApiRequest( array(
112 'lgname' => self
::$users['sysop']->username
,
113 'lgpassword' => self
::$users['sysop']->password
) );
115 $token = $data[0]['login']['token'];
117 $data = $this->doApiRequest( array(
120 'lgname' => self
::$users['sysop']->username
,
121 'lgpassword' => self
::$users['sysop']->password
127 protected function getTokenList( $user, $session = null ) {
128 $data = $this->doApiRequest( array(
130 'titles' => 'Main Page',
131 'intoken' => 'edit|delete|protect|move|block|unblock|watch',
132 'prop' => 'info' ), $session, false, $user->user
);
138 public $userName, $password, $user;
140 public function __construct( $userName, $password, $group = '' ) {
141 $this->userName
= $userName;
142 $this->password
= $password;
144 $this->user
= User
::newFromName( $this->userName
);
145 if ( !$this->user
->getID() ) {
146 $this->user
= User
::createNew( $this->userName
, array(
147 "email" => "test@example.com",
148 "real_name" => "Test User" ) );
150 $this->user
->setPassword( $this->password
);
152 if ( $group !== '' ) {
153 $this->user
->addGroup( $group );
155 $this->user
->saveSettings();
159 class MockApi
extends ApiBase
{
160 public function execute() { }
161 public function getVersion() { }
163 public function __construct() { }
165 public function getAllowedParams() {
168 'enablechunks' => false,
169 'sessionkey' => null,
174 class ApiTestContext
extends RequestContext
{
177 * Returns a DerivativeContext with the request variables in place
179 * @param $request WebRequest request object including parameters and session
180 * @param $user User or null
181 * @return DerivativeContext
183 public function newTestContext( WebRequest
$request, User
$user = null ) {
184 $context = new DerivativeContext( $this );
185 $context->setRequest( $request );
186 if ( $user !== null ) {
187 $context->setUser( $user );