tests/phpunit/includes/api/ApiTestCase.php

   1 <?php
   2
   3 abstract class ApiTestCase extends MediaWikiLangTestCase {
   4         /**
   5          * @var Array of ApiTestUser
   6          */
   7         public static $users;
   8         protected static $apiUrl;
   9
  10         /**
  11          * @var ApiTestContext
  12          */
  13         protected $apiContext;
  14
  15         function setUp() {
  16                 global $wgContLang, $wgAuth, $wgMemc, $wgRequest, $wgUser, $wgServer;
  17
  18                 parent::setUp();
  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() );
  24
  25                 self::$users = array(
  26                         'sysop' => new ApiTestUser(
  27                                 'Apitestsysop',
  28                                 'Api Test Sysop',
  29                                 'api_test_sysop@example.com',
  30                                 array( 'sysop' )
  31                         ),
  32                         'uploader' => new ApiTestUser(
  33                                 'Apitestuser',
  34                                 'Api Test User',
  35                                 'api_test_user@example.com',
  36                                 array()
  37                         )
  38                 );
  39
  40                 $wgUser = self::$users['sysop']->user;
  41
  42                 $this->apiContext = new ApiTestContext();
  43
  44         }
  45
  46         protected function doApiRequest( Array $params, Array $session = null, $appendModule = false, User $user = null ) {
  47                 global $wgRequest, $wgUser;
  48
  49                 if ( is_null( $session ) ) {
  50                         # re-use existing global session by default
  51                         $session = $wgRequest->getSessionArray();
  52                 }
  53
  54                 # set up global environment
  55                 if ( $user ) {
  56                         $wgUser = $user;
  57                 }
  58
  59                 $wgRequest = new FauxRequest( $params, true, $session );
  60                 RequestContext::getMain()->setRequest( $wgRequest );
  61
  62                 # set up local environment
  63                 $context = $this->apiContext->newTestContext( $wgRequest, $wgUser );
  64
  65                 $module = new ApiMain( $context, true );
  66
  67                 # run it!
  68                 $module->execute();
  69
  70                 # construct result
  71                 $results = array(
  72                         $module->getResultData(),
  73                         $context->getRequest(),
  74                         $context->getRequest()->getSessionArray()
  75                 );
  76                 if( $appendModule ) {
  77                         $results[] = $module;
  78                 }
  79
  80                 return $results;
  81         }
  82
  83         /**
  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
  90          */
  91         protected function doApiRequestWithToken( Array $params, Array $session = null, User $user = null ) {
  92                 global $wgRequest;
  93
  94                 if ( $session === null ) {
  95                         $session = $wgRequest->getSessionArray();
  96                 }
  97
  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 );
 104                 } else {
 105                         throw new Exception( "request data not in right format" );
 106                 }
 107         }
 108
 109         protected function doLogin() {
 110                 $data = $this->doApiRequest( array(
 111                         'action' => 'login',
 112                         'lgname' => self::$users['sysop']->username,
 113                         'lgpassword' => self::$users['sysop']->password ) );
 114
 115                 $token = $data[0]['login']['token'];
 116
 117                 $data = $this->doApiRequest( array(
 118                         'action' => 'login',
 119                         'lgtoken' => $token,
 120                         'lgname' => self::$users['sysop']->username,
 121                         'lgpassword' => self::$users['sysop']->password
 122                         ), $data[2] );
 123
 124                 return $data;
 125         }
 126
 127         protected function getTokenList( $user, $session = null ) {
 128                 $data = $this->doApiRequest( array(
 129                         'action' => 'query',
 130                         'titles' => 'Main Page',
 131                         'intoken' => 'edit|delete|protect|move|block|unblock|watch',
 132                         'prop' => 'info' ), $session, false, $user->user );
 133                 return $data;
 134         }
 135 }
 136
 137 class UserWrapper {
 138         public $userName, $password, $user;
 139
 140         public function __construct( $userName, $password, $group = '' ) {
 141                 $this->userName = $userName;
 142                 $this->password = $password;
 143
 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" ) );
 149                 }
 150                 $this->user->setPassword( $this->password );
 151
 152                 if ( $group !== '' ) {
 153                         $this->user->addGroup( $group );
 154                 }
 155                 $this->user->saveSettings();
 156         }
 157 }
 158
 159 class MockApi extends ApiBase {
 160         public function execute() { }
 161         public function getVersion() { }
 162
 163         public function __construct() { }
 164
 165         public function getAllowedParams() {
 166                 return array(
 167                         'filename' => null,
 168                         'enablechunks' => false,
 169                         'sessionkey' => null,
 170                 );
 171         }
 172 }
 173
 174 class ApiTestContext extends RequestContext {
 175
 176         /**
 177          * Returns a DerivativeContext with the request variables in place
 178          *
 179          * @param $request WebRequest request object including parameters and session
 180          * @param $user User or null
 181          * @return DerivativeContext
 182          */
 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 );
 188                 }
 189                 return $context;
 190         }
 191 }