Revert "merged master"
[lhc/web/wiklou.git] / tests / phpunit / includes / api / ApiTestCase.php
index 54da690..3b044ef 100644 (file)
@@ -1,12 +1,22 @@
 <?php 
 
 abstract class ApiTestCase extends MediaWikiLangTestCase {
+       /**
+        * @var Array of ApiTestUser
+        */
        public static $users;
+       protected static $apiUrl;
+
+       /**
+        * @var ApiTestContext
+        */
+       protected $apiContext;
 
        function setUp() {
-               global $wgContLang, $wgAuth, $wgMemc, $wgRequest, $wgUser;
+               global $wgContLang, $wgAuth, $wgMemc, $wgRequest, $wgUser, $wgServer;
 
                parent::setUp();
+               self::$apiUrl = $wgServer . wfScript( 'api' );
                $wgMemc = new EmptyBagOStuff();
                $wgContLang = Language::factory( 'en' );
                $wgAuth = new StubObject( 'wgAuth', 'AuthPlugin' );
@@ -16,50 +26,160 @@ abstract class ApiTestCase extends MediaWikiLangTestCase {
                        'sysop' => new ApiTestUser(
                                'Apitestsysop',
                                'Api Test Sysop',
-                               'api_test_sysop@sample.com',
+                               'api_test_sysop@example.com',
                                array( 'sysop' )
                        ),
                        'uploader' => new ApiTestUser(
                                'Apitestuser',
                                'Api Test User',
-                               'api_test_user@sample.com',
+                               'api_test_user@example.com',
                                array()
                        )
                );
 
                $wgUser = self::$users['sysop']->user;
 
+               $this->apiContext = new ApiTestContext();
+
        }
 
-       protected function doApiRequest( $params, $session = null, $appendModule = false ) {
+       protected function doApiRequest( Array $params, Array $session = null, $appendModule = false, User $user = null ) {
+               global $wgRequest, $wgUser;
+
                if ( is_null( $session ) ) {
-                       $session = array();
+                       # re-use existing global session by default
+                       $session = $wgRequest->getSessionArray();
+               }
+
+               # set up global environment
+               if ( $user ) {
+                       $wgUser = $user;
                }
 
-               $request = new FauxRequest( $params, true, $session );
-               $module = new ApiMain( $request, true );
+               $wgRequest = new FauxRequest( $params, true, $session );
+               RequestContext::getMain()->setRequest( $wgRequest );
+
+               # set up local environment
+               $context = $this->apiContext->newTestContext( $wgRequest, $wgUser );
+
+               $module = new ApiMain( $context, true );
+
+               # run it!
                $module->execute();
 
-               return array( $module->getResultData(), $request, $request->getSessionArray() );
+               # construct result
+               $results = array(
+                       $module->getResultData(),
+                       $context->getRequest(),
+                       $context->getRequest()->getSessionArray()
+               );
+               if( $appendModule ) {
+                       $results[] = $module;
+               }
+
+               return $results;
        }
 
        /**
         * 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
-        * @param $params: key-value API params
-        * @param $session: session array
+        * @param $params Array: key-value API params
+        * @param $session Array: session array
+        * @param $user User|null A User object for the context
         */
-       protected function doApiRequestWithToken( $params, $session ) {
+       protected function doApiRequestWithToken( Array $params, Array $session, User $user = null ) {
                if ( $session['wsToken'] ) {
                        // add edit token to fake session
                        $session['wsEditToken'] = $session['wsToken'];
                        // add token to request parameters
                        $params['token'] = md5( $session['wsToken'] ) . User::EDIT_TOKEN_SUFFIX;
-                       return $this->doApiRequest( $params, $session );
+                       return $this->doApiRequest( $params, $session, false, $user );
                } else {
                        throw new Exception( "request data not in right format" );
                }
        }
 
+       protected function doLogin() {
+               $data = $this->doApiRequest( array(
+                       'action' => 'login',
+                       'lgname' => self::$users['sysop']->username,
+                       'lgpassword' => self::$users['sysop']->password ) );
+
+               $token = $data[0]['login']['token'];
+
+               $data = $this->doApiRequest( array(
+                       'action' => 'login',
+                       'lgtoken' => $token,
+                       'lgname' => self::$users['sysop']->username,
+                       'lgpassword' => self::$users['sysop']->password
+                       ), $data[2] );
+
+               return $data;
+       }
+
+       protected function getTokenList( $user, $session = null ) {
+               $data = $this->doApiRequest( array(
+                       'action' => 'query',
+                       'titles' => 'Main Page',
+                       'intoken' => 'edit|delete|protect|move|block|unblock|watch',
+                       'prop' => 'info' ), $session, false, $user->user );
+               return $data;
+       }
+}
+
+class UserWrapper {
+       public $userName, $password, $user;
+
+       public function __construct( $userName, $password, $group = '' ) {
+               $this->userName = $userName;
+               $this->password = $password;
+
+               $this->user = User::newFromName( $this->userName );
+               if ( !$this->user->getID() ) {
+                       $this->user = User::createNew( $this->userName, array(
+                               "email" => "test@example.com",
+                               "real_name" => "Test User" ) );
+               }
+               $this->user->setPassword( $this->password );
+
+               if ( $group !== '' ) {
+                       $this->user->addGroup( $group );
+               }
+               $this->user->saveSettings();
+       }
+}
+
+class MockApi extends ApiBase {
+       public function execute() { }
+       public function getVersion() { }
+
+       public function __construct() { }
+
+       public function getAllowedParams() {
+               return array(
+                       'filename' => null,
+                       'enablechunks' => false,
+                       'sessionkey' => null,
+               );
+       }
+}
+
+class ApiTestContext extends RequestContext {
+
+       /**
+        * Returns a DerivativeContext with the request variables in place
+        *
+        * @param $request WebRequest request object including parameters and session
+        * @param $user User or null
+        * @return DerivativeContext
+        */
+       public function newTestContext( WebRequest $request, User $user = null ) {
+               $context = new DerivativeContext( $this );
+               $context->setRequest( $request );
+               if ( $user !== null ) {
+                       $context->setUser( $user );
+               }
+               return $context;
+       }
 }