ApiTestCase.php

Go to the documentation of this file.

<?php

use MediaWiki\Session\SessionManager;

abstract class ApiTestCase extends MediaWikiLangTestCase {
    protected static $apiUrl;

    protected static $errorFormatter = null;

    protected $apiContext;

    protected function setUp() {
        global $wgServer;

        parent::setUp();
        self::$apiUrl = $wgServer . wfScript( 'api' );

        ApiQueryInfo::resetTokenCache(); // tokens are invalid because we cleared the session

        self::$users = [
            'sysop' => static::getTestSysop(),
            'uploader' => static::getTestUser(),
        ];

        $this->setMwGlobals( [
            'wgRequest' => new FauxRequest( [] ),
            'wgUser' => self::$users['sysop']->getUser(),
        ] );

        $this->apiContext = new ApiTestContext();
    }

    protected function tearDown() {
        // Avoid leaking session over tests
        MediaWiki\Session\SessionManager::getGlobalSession()->clear();

        parent::tearDown();
    }

    protected function doApiRequest( array $params, array $session = null,
        $appendModule = false, User $user = null, $tokenType = null
    ) {
        global $wgRequest, $wgUser;

        if ( is_null( $session ) ) {
            // re-use existing global session by default
            $session = $wgRequest->getSessionArray();
        }

        $sessionObj = SessionManager::singleton()->getEmptySession();

        if ( $session !== null ) {
            foreach ( $session as $key => $value ) {
                $sessionObj->set( $key, $value );
            }
        }

        // set up global environment
        if ( $user ) {
            $wgUser = $user;
        }

        if ( $tokenType !== null ) {
            if ( $tokenType === 'auto' ) {
                $tokenType = ( new ApiMain() )->getModuleManager()
                    ->getModule( $params['action'], 'action' )->needsToken();
            }
            $params['token'] = ApiQueryTokens::getToken(
                $wgUser, $sessionObj, ApiQueryTokens::getTokenTypeSalts()[$tokenType]
            )->toString();
        }

        $wgRequest = new FauxRequest( $params, true, $sessionObj );
        RequestContext::getMain()->setRequest( $wgRequest );
        RequestContext::getMain()->setUser( $wgUser );
        MediaWiki\Auth\AuthManager::resetCache();

        // set up local environment
        $context = $this->apiContext->newTestContext( $wgRequest, $wgUser );

        $module = new ApiMain( $context, true );

        // run it!
        $module->execute();

        // construct result
        $results = [
            $module->getResult()->getResultData( null, [ 'Strip' => 'all' ] ),
            $context->getRequest(),
            $context->getRequest()->getSessionArray()
        ];

        if ( $appendModule ) {
            $results[] = $module;
        }

        return $results;
    }

    protected function doApiRequestWithToken( array $params, array $session = null,
        User $user = null, $tokenType = 'auto'
    ) {
        return $this->doApiRequest( $params, $session, false, $user, $tokenType );
    }

    protected function doLogin( $testUser = null ) {
        global $wgUser;

        if ( $testUser === null ) {
            $testUser = static::getTestSysop();
        } elseif ( is_string( $testUser ) && array_key_exists( $testUser, self::$users ) ) {
            $testUser = self::$users[$testUser];
        } elseif ( !$testUser instanceof TestUser ) {
            throw new MWException( "Can't log in to undefined user $testUser" );
        }

        $wgUser = $testUser->getUser();
        RequestContext::getMain()->setUser( $wgUser );
    }

    protected function getTokenList( TestUser $user, $session = null ) {
        $data = $this->doApiRequest( [
            'action' => 'tokens',
            'type' => 'edit|delete|protect|move|block|unblock|watch'
        ], $session, false, $user->getUser() );

        if ( !array_key_exists( 'tokens', $data[0] ) ) {
            throw new MWException( 'Api failed to return a token list' );
        }

        return $data[0]['tokens'];
    }

    protected static function getErrorFormatter() {
        if ( self::$errorFormatter === null ) {
            self::$errorFormatter = new ApiErrorFormatter(
                new ApiResult( false ),
                Language::factory( 'en' ),
                'none'
            );
        }
        return self::$errorFormatter;
    }

    public static function apiExceptionHasCode( ApiUsageException $ex, $code ) {
        return (bool)array_filter(
            self::getErrorFormatter()->arrayFromStatus( $ex->getStatusValue() ),
            function ( $e ) use ( $code ) {
                return is_array( $e ) && $e['code'] === $code;
            }
        );
    }

    public function testApiTestGroup() {
        $groups = PHPUnit_Util_Test::getGroups( static::class );
        $constraint = PHPUnit_Framework_Assert::logicalOr(
            $this->contains( 'medium' ),
            $this->contains( 'large' )
        );
        $this->assertThat( $groups, $constraint,
            'ApiTestCase::setUp can be slow, tests must be "medium" or "large"'
        );
    }

    protected function setExpectedApiException(
        $msg, $code = null, array $data = null, $httpCode = 0
    ) {
        $expected = ApiUsageException::newWithMessage( null, $msg, $code, $data, $httpCode );
        $this->setExpectedException( ApiUsageException::class, $expected->getMessage() );
    }
}