ApiOptionsTest.php

Go to the documentation of this file.

<?php

class ApiOptionsTest extends MediaWikiLangTestCase {

    private $mUserMock;
    private $mTested;
    private $mSession;
    private $mContext;

    private $mOldGetPreferencesHooks;

    private static $Success = array( 'options' => 'success' );

    protected function setUp() {
        parent::setUp();

        $this->mUserMock = $this->getMockBuilder( 'User' )
            ->disableOriginalConstructor()
            ->getMock();

        // Set up groups and rights
        $this->mUserMock->expects( $this->any() )
            ->method( 'getEffectiveGroups' )->will( $this->returnValue( array( '*', 'user' ) ) );
        $this->mUserMock->expects( $this->any() )
            ->method( 'isAllowed' )->will( $this->returnValue( true ) );

        // Set up callback for User::getOptionKinds
        $this->mUserMock->expects( $this->any() )
            ->method( 'getOptionKinds' )->will( $this->returnCallback( array( $this, 'getOptionKinds' ) ) );

        // Create a new context
        $this->mContext = new DerivativeContext( new RequestContext() );
        $this->mContext->getContext()->setTitle( Title::newFromText( 'Test' ) );
        $this->mContext->setUser( $this->mUserMock );

        $main = new ApiMain( $this->mContext );

        // Empty session
        $this->mSession = array();

        $this->mTested = new ApiOptions( $main, 'options' );

        global $wgHooks;
        if ( !isset( $wgHooks['GetPreferences'] ) ) {
            $wgHooks['GetPreferences'] = array();
        }
        $this->mOldGetPreferencesHooks = $wgHooks['GetPreferences'];
        $wgHooks['GetPreferences'][] = array( $this, 'hookGetPreferences' );
    }

    protected function tearDown() {
        global $wgHooks;

        $wgHooks['GetPreferences'] = $this->mOldGetPreferencesHooks;
        $this->mOldGetPreferencesHooks = false;

        parent::tearDown();
    }

    public function hookGetPreferences( $user, &$preferences ) {
        $preferences = array();

        foreach ( array( 'name', 'willBeNull', 'willBeEmpty', 'willBeHappy' ) as $k ) {
            $preferences[$k] = array(
                'type' => 'text',
                'section' => 'test',
                'label' => '&#160;',
            );
        }

        $preferences['testmultiselect'] = array(
            'type' => 'multiselect',
            'options' => array(
                'Test' => array(
                    '<span dir="auto">Some HTML here for option 1</span>' => 'opt1',
                    '<span dir="auto">Some HTML here for option 2</span>' => 'opt2',
                    '<span dir="auto">Some HTML here for option 3</span>' => 'opt3',
                    '<span dir="auto">Some HTML here for option 4</span>' => 'opt4',
                ),
            ),
            'section' => 'test',
            'label' => '&#160;',
            'prefix' => 'testmultiselect-',
            'default' => array(),
        );

        return true;
    }

    public function getOptionKinds( IContextSource $context, $options = null ) {
        // Match with above.
        $kinds = array(
            'name' => 'registered',
            'willBeNull' => 'registered',
            'willBeEmpty' => 'registered',
            'willBeHappy' => 'registered',
            'testmultiselect-opt1' => 'registered-multiselect',
            'testmultiselect-opt2' => 'registered-multiselect',
            'testmultiselect-opt3' => 'registered-multiselect',
            'testmultiselect-opt4' => 'registered-multiselect',
            'special' => 'special',
        );

        if ( $options === null ) {
            return $kinds;
        }

        $mapping = array();
        foreach ( $options as $key => $value ) {
            if ( isset( $kinds[$key] ) ) {
                $mapping[$key] = $kinds[$key];
            } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
                $mapping[$key] = 'userjs';
            } else {
                $mapping[$key] = 'unused';
            }
        }

        return $mapping;
    }

    private function getSampleRequest( $custom = array() ) {
        $request = array(
            'token' => '123ABC',
            'change' => null,
            'optionname' => null,
            'optionvalue' => null,
        );

        return array_merge( $request, $custom );
    }

    private function executeQuery( $request ) {
        $this->mContext->setRequest( new FauxRequest( $request, true, $this->mSession ) );
        $this->mTested->execute();

        return $this->mTested->getResult()->getData();
    }

    public function testNoToken() {
        $request = $this->getSampleRequest( array( 'token' => null ) );

        $this->executeQuery( $request );
    }

    public function testAnon() {
        $this->mUserMock->expects( $this->once() )
            ->method( 'isAnon' )
            ->will( $this->returnValue( true ) );

        try {
            $request = $this->getSampleRequest();

            $this->executeQuery( $request );
        } catch ( UsageException $e ) {
            $this->assertEquals( 'notloggedin', $e->getCodeString() );
            $this->assertEquals( 'Anonymous users cannot change preferences', $e->getMessage() );

            return;
        }
        $this->fail( "UsageException was not thrown" );
    }

    public function testNoOptionname() {
        try {
            $request = $this->getSampleRequest( array( 'optionvalue' => '1' ) );

            $this->executeQuery( $request );
        } catch ( UsageException $e ) {
            $this->assertEquals( 'nooptionname', $e->getCodeString() );
            $this->assertEquals( 'The optionname parameter must be set', $e->getMessage() );

            return;
        }
        $this->fail( "UsageException was not thrown" );
    }

    public function testNoChanges() {
        $this->mUserMock->expects( $this->never() )
            ->method( 'resetOptions' );

        $this->mUserMock->expects( $this->never() )
            ->method( 'setOption' );

        $this->mUserMock->expects( $this->never() )
            ->method( 'saveSettings' );

        try {
            $request = $this->getSampleRequest();

            $this->executeQuery( $request );
        } catch ( UsageException $e ) {
            $this->assertEquals( 'nochanges', $e->getCodeString() );
            $this->assertEquals( 'No changes were requested', $e->getMessage() );

            return;
        }
        $this->fail( "UsageException was not thrown" );
    }

    public function testReset() {
        $this->mUserMock->expects( $this->once() )
            ->method( 'resetOptions' )
            ->with( $this->equalTo( array( 'all' ) ) );

        $this->mUserMock->expects( $this->never() )
            ->method( 'setOption' );

        $this->mUserMock->expects( $this->once() )
            ->method( 'saveSettings' );

        $request = $this->getSampleRequest( array( 'reset' => '' ) );

        $response = $this->executeQuery( $request );

        $this->assertEquals( self::$Success, $response );
    }

    public function testResetKinds() {
        $this->mUserMock->expects( $this->once() )
            ->method( 'resetOptions' )
            ->with( $this->equalTo( array( 'registered' ) ) );

        $this->mUserMock->expects( $this->never() )
            ->method( 'setOption' );

        $this->mUserMock->expects( $this->once() )
            ->method( 'saveSettings' );

        $request = $this->getSampleRequest( array( 'reset' => '', 'resetkinds' => 'registered' ) );

        $response = $this->executeQuery( $request );

        $this->assertEquals( self::$Success, $response );
    }

    public function testOptionWithValue() {
        $this->mUserMock->expects( $this->never() )
            ->method( 'resetOptions' );

        $this->mUserMock->expects( $this->once() )
            ->method( 'setOption' )
            ->with( $this->equalTo( 'name' ), $this->equalTo( 'value' ) );

        $this->mUserMock->expects( $this->once() )
            ->method( 'saveSettings' );

        $request = $this->getSampleRequest( array( 'optionname' => 'name', 'optionvalue' => 'value' ) );

        $response = $this->executeQuery( $request );

        $this->assertEquals( self::$Success, $response );
    }

    public function testOptionResetValue() {
        $this->mUserMock->expects( $this->never() )
            ->method( 'resetOptions' );

        $this->mUserMock->expects( $this->once() )
            ->method( 'setOption' )
            ->with( $this->equalTo( 'name' ), $this->identicalTo( null ) );

        $this->mUserMock->expects( $this->once() )
            ->method( 'saveSettings' );

        $request = $this->getSampleRequest( array( 'optionname' => 'name' ) );
        $response = $this->executeQuery( $request );

        $this->assertEquals( self::$Success, $response );
    }

    public function testChange() {
        $this->mUserMock->expects( $this->never() )
            ->method( 'resetOptions' );

        $this->mUserMock->expects( $this->at( 2 ) )
            ->method( 'getOptions' );

        $this->mUserMock->expects( $this->at( 4 ) )
            ->method( 'setOption' )
            ->with( $this->equalTo( 'willBeNull' ), $this->identicalTo( null ) );

        $this->mUserMock->expects( $this->at( 5 ) )
            ->method( 'getOptions' );

        $this->mUserMock->expects( $this->at( 6 ) )
            ->method( 'setOption' )
            ->with( $this->equalTo( 'willBeEmpty' ), $this->equalTo( '' ) );

        $this->mUserMock->expects( $this->at( 7 ) )
            ->method( 'getOptions' );

        $this->mUserMock->expects( $this->at( 8 ) )
            ->method( 'setOption' )
            ->with( $this->equalTo( 'willBeHappy' ), $this->equalTo( 'Happy' ) );

        $this->mUserMock->expects( $this->once() )
            ->method( 'saveSettings' );

        $request = $this->getSampleRequest( array(
            'change' => 'willBeNull|willBeEmpty=|willBeHappy=Happy'
        ) );

        $response = $this->executeQuery( $request );

        $this->assertEquals( self::$Success, $response );
    }

    public function testResetChangeOption() {
        $this->mUserMock->expects( $this->once() )
            ->method( 'resetOptions' );

        $this->mUserMock->expects( $this->at( 4 ) )
            ->method( 'getOptions' );

        $this->mUserMock->expects( $this->at( 5 ) )
            ->method( 'setOption' )
            ->with( $this->equalTo( 'willBeHappy' ), $this->equalTo( 'Happy' ) );

        $this->mUserMock->expects( $this->at( 6 ) )
            ->method( 'getOptions' );

        $this->mUserMock->expects( $this->at( 7 ) )
            ->method( 'setOption' )
            ->with( $this->equalTo( 'name' ), $this->equalTo( 'value' ) );

        $this->mUserMock->expects( $this->once() )
            ->method( 'saveSettings' );

        $args = array(
            'reset' => '',
            'change' => 'willBeHappy=Happy',
            'optionname' => 'name',
            'optionvalue' => 'value'
        );

        $response = $this->executeQuery( $this->getSampleRequest( $args ) );

        $this->assertEquals( self::$Success, $response );
    }

    public function testMultiSelect() {
        $this->mUserMock->expects( $this->never() )
            ->method( 'resetOptions' );

        $this->mUserMock->expects( $this->at( 3 ) )
            ->method( 'setOption' )
            ->with( $this->equalTo( 'testmultiselect-opt1' ), $this->identicalTo( true ) );

        $this->mUserMock->expects( $this->at( 4 ) )
            ->method( 'setOption' )
            ->with( $this->equalTo( 'testmultiselect-opt2' ), $this->identicalTo( null ) );

        $this->mUserMock->expects( $this->at( 5 ) )
            ->method( 'setOption' )
            ->with( $this->equalTo( 'testmultiselect-opt3' ), $this->identicalTo( false ) );

        $this->mUserMock->expects( $this->at( 6 ) )
            ->method( 'setOption' )
            ->with( $this->equalTo( 'testmultiselect-opt4' ), $this->identicalTo( false ) );

        $this->mUserMock->expects( $this->once() )
            ->method( 'saveSettings' );

        $request = $this->getSampleRequest( array(
            'change' => 'testmultiselect-opt1=1|testmultiselect-opt2|'
                . 'testmultiselect-opt3=|testmultiselect-opt4=0'
        ) );

        $response = $this->executeQuery( $request );

        $this->assertEquals( self::$Success, $response );
    }

    public function testSpecialOption() {
        $this->mUserMock->expects( $this->never() )
            ->method( 'resetOptions' );

        $this->mUserMock->expects( $this->never() )
            ->method( 'saveSettings' );

        $request = $this->getSampleRequest( array(
            'change' => 'special=1'
        ) );

        $response = $this->executeQuery( $request );

        $this->assertEquals( array(
            'options' => 'success',
            'warnings' => array(
                'options' => array(
                    '*' => "Validation error for 'special': cannot be set by this module"
                )
            )
        ), $response );
    }

    public function testUnknownOption() {
        $this->mUserMock->expects( $this->never() )
            ->method( 'resetOptions' );

        $this->mUserMock->expects( $this->never() )
            ->method( 'saveSettings' );

        $request = $this->getSampleRequest( array(
            'change' => 'unknownOption=1'
        ) );

        $response = $this->executeQuery( $request );

        $this->assertEquals( array(
            'options' => 'success',
            'warnings' => array(
                'options' => array(
                    '*' => "Validation error for 'unknownOption': not a valid preference"
                )
            )
        ), $response );
    }

    public function testUserjsOption() {
        $this->mUserMock->expects( $this->never() )
            ->method( 'resetOptions' );

        $this->mUserMock->expects( $this->at( 3 ) )
            ->method( 'setOption' )
            ->with( $this->equalTo( 'userjs-option' ), $this->equalTo( '1' ) );

        $this->mUserMock->expects( $this->once() )
            ->method( 'saveSettings' );

        $request = $this->getSampleRequest( array(
            'change' => 'userjs-option=1'
        ) );

        $response = $this->executeQuery( $request );

        $this->assertEquals( self::$Success, $response );
    }
}