47464abb4f
Now that resetServices() will preserve (but reset) customized services, it should be reasonably safe to call it every time globals are changed, and much more effective than relying on tests to call it every time themselves. Depends-On: Iab8ea3a61bbc6803805d855ef23c071067646f71 Depends-On: I00e35ecea6a27468674b2a6e7d9d9eb6518e3bd5 Change-Id: Ie7a89f6ed7d52a0bc01672019ff92e7ee105a1f3
410 lines
11 KiB
PHP
410 lines
11 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @group API
|
|
* @group Database
|
|
* @group medium
|
|
*
|
|
* @covers ApiOptions
|
|
*/
|
|
class ApiOptionsTest extends MediaWikiLangTestCase {
|
|
|
|
/** @var PHPUnit_Framework_MockObject_MockObject */
|
|
private $mUserMock;
|
|
/** @var ApiOptions */
|
|
private $mTested;
|
|
private $mSession;
|
|
/** @var DerivativeContext */
|
|
private $mContext;
|
|
|
|
private static $Success = [ 'options' => 'success' ];
|
|
|
|
protected function setUp() {
|
|
parent::setUp();
|
|
|
|
$this->mUserMock = $this->getMockBuilder( User::class )
|
|
->disableOriginalConstructor()
|
|
->getMock();
|
|
|
|
// Set up groups and rights
|
|
$this->mUserMock->expects( $this->any() )
|
|
->method( 'getEffectiveGroups' )->will( $this->returnValue( [ '*', 'user' ] ) );
|
|
|
|
// Set up callback for User::getOptionKinds
|
|
$this->mUserMock->expects( $this->any() )
|
|
->method( 'getOptionKinds' )->will( $this->returnCallback( [ $this, 'getOptionKinds' ] ) );
|
|
|
|
// No actual DB data
|
|
$this->mUserMock->expects( $this->any() )
|
|
->method( 'getInstanceForUpdate' )->will( $this->returnValue( $this->mUserMock ) );
|
|
|
|
// Needs to return something
|
|
$this->mUserMock->method( 'getOptions' )
|
|
->willReturn( [] );
|
|
|
|
// DefaultPreferencesFactory calls a ton of user methods, but we still want to list all of
|
|
// them in case bugs are caused by unexpected things returning null that shouldn't.
|
|
$this->mUserMock->expects( $this->never() )->method( $this->anythingBut(
|
|
'getEffectiveGroups', 'getOptionKinds', 'getInstanceForUpdate', 'getOptions', 'getId',
|
|
'isAnon', 'getRequest', 'isLoggedIn', 'getName', 'getGroupMemberships', 'getEditCount',
|
|
'getRegistration', 'isAllowed', 'getRealName', 'getOption', 'getStubThreshold',
|
|
'getBoolOption', 'getEmail', 'getDatePreference', 'useRCPatrol', 'useNPPatrol',
|
|
'setOption', 'saveSettings', 'resetOptions', 'isRegistered'
|
|
) );
|
|
|
|
// Create a new context
|
|
$this->mContext = new DerivativeContext( new RequestContext() );
|
|
$this->mContext->getContext()->setTitle( Title::newFromText( 'Test' ) );
|
|
$this->mContext->setUser( $this->mUserMock );
|
|
|
|
$this->overrideUserPermissions( $this->mUserMock, [ 'editmyoptions' ] );
|
|
$main = new ApiMain( $this->mContext );
|
|
|
|
// Empty session
|
|
$this->mSession = [];
|
|
|
|
$this->mTested = new ApiOptions( $main, 'options' );
|
|
|
|
$this->mergeMwGlobalArrayValue( 'wgHooks', [
|
|
'GetPreferences' => [
|
|
[ $this, 'hookGetPreferences' ]
|
|
]
|
|
] );
|
|
$this->mergeMwGlobalArrayValue( 'wgDefaultUserOptions', [
|
|
'testradio' => 'option1',
|
|
] );
|
|
// Workaround for static caching in User::getDefaultOptions()
|
|
$this->setContentLang( Language::factory( 'qqq' ) );
|
|
}
|
|
|
|
public function hookGetPreferences( $user, &$preferences ) {
|
|
$preferences = [];
|
|
|
|
foreach ( [ 'name', 'willBeNull', 'willBeEmpty', 'willBeHappy' ] as $k ) {
|
|
$preferences[$k] = [
|
|
'type' => 'text',
|
|
'section' => 'test',
|
|
'label' => "\u{00A0}",
|
|
];
|
|
}
|
|
|
|
$preferences['testmultiselect'] = [
|
|
'type' => 'multiselect',
|
|
'options' => [
|
|
'Test' => [
|
|
'<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' => "\u{00A0}",
|
|
'prefix' => 'testmultiselect-',
|
|
'default' => [],
|
|
];
|
|
|
|
$preferences['testradio'] = [
|
|
'type' => 'radio',
|
|
'options' => [ 'Option 1' => 'option1', 'Option 2' => 'option2' ],
|
|
'section' => 'test',
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @param IContextSource $context
|
|
* @param array|null $options
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getOptionKinds( IContextSource $context, $options = null ) {
|
|
// Match with above.
|
|
$kinds = [
|
|
'name' => 'registered',
|
|
'willBeNull' => 'registered',
|
|
'willBeEmpty' => 'registered',
|
|
'willBeHappy' => 'registered',
|
|
'testradio' => '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 = [];
|
|
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 = [] ) {
|
|
$request = [
|
|
'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->mUserMock->method( 'getRequest' )->willReturn( $this->mContext->getRequest() );
|
|
|
|
$this->mTested->execute();
|
|
|
|
return $this->mTested->getResult()->getResultData( null, [ 'Strip' => 'all' ] );
|
|
}
|
|
|
|
/**
|
|
* @expectedException ApiUsageException
|
|
*/
|
|
public function testNoToken() {
|
|
$request = $this->getSampleRequest( [ '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 ( ApiUsageException $e ) {
|
|
$this->assertTrue( ApiTestCase::apiExceptionHasCode( $e, 'notloggedin' ) );
|
|
return;
|
|
}
|
|
$this->fail( "ApiUsageException was not thrown" );
|
|
}
|
|
|
|
public function testNoOptionname() {
|
|
try {
|
|
$request = $this->getSampleRequest( [ 'optionvalue' => '1' ] );
|
|
|
|
$this->executeQuery( $request );
|
|
} catch ( ApiUsageException $e ) {
|
|
$this->assertTrue( ApiTestCase::apiExceptionHasCode( $e, 'nooptionname' ) );
|
|
return;
|
|
}
|
|
$this->fail( "ApiUsageException 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 ( ApiUsageException $e ) {
|
|
$this->assertTrue( ApiTestCase::apiExceptionHasCode( $e, 'nochanges' ) );
|
|
return;
|
|
}
|
|
$this->fail( "ApiUsageException was not thrown" );
|
|
}
|
|
|
|
public function testReset() {
|
|
$this->mUserMock->expects( $this->once() )
|
|
->method( 'resetOptions' )
|
|
->with( $this->equalTo( [ 'all' ] ) );
|
|
|
|
$this->mUserMock->expects( $this->never() )
|
|
->method( 'setOption' );
|
|
|
|
$this->mUserMock->expects( $this->once() )
|
|
->method( 'saveSettings' );
|
|
|
|
$request = $this->getSampleRequest( [ 'reset' => '' ] );
|
|
|
|
$response = $this->executeQuery( $request );
|
|
|
|
$this->assertEquals( self::$Success, $response );
|
|
}
|
|
|
|
public function testResetKinds() {
|
|
$this->mUserMock->expects( $this->once() )
|
|
->method( 'resetOptions' )
|
|
->with( $this->equalTo( [ 'registered' ] ) );
|
|
|
|
$this->mUserMock->expects( $this->never() )
|
|
->method( 'setOption' );
|
|
|
|
$this->mUserMock->expects( $this->once() )
|
|
->method( 'saveSettings' );
|
|
|
|
$request = $this->getSampleRequest( [ 'reset' => '', 'resetkinds' => 'registered' ] );
|
|
|
|
$response = $this->executeQuery( $request );
|
|
|
|
$this->assertEquals( self::$Success, $response );
|
|
}
|
|
|
|
public function testResetChangeOption() {
|
|
$this->mUserMock->expects( $this->once() )
|
|
->method( 'resetOptions' );
|
|
|
|
$this->mUserMock->expects( $this->exactly( 2 ) )
|
|
->method( 'setOption' )
|
|
->withConsecutive(
|
|
[ $this->equalTo( 'willBeHappy' ), $this->equalTo( 'Happy' ) ],
|
|
[ $this->equalTo( 'name' ), $this->equalTo( 'value' ) ]
|
|
);
|
|
|
|
$this->mUserMock->expects( $this->once() )
|
|
->method( 'saveSettings' );
|
|
|
|
$args = [
|
|
'reset' => '',
|
|
'change' => 'willBeHappy=Happy',
|
|
'optionname' => 'name',
|
|
'optionvalue' => 'value'
|
|
];
|
|
|
|
$response = $this->executeQuery( $this->getSampleRequest( $args ) );
|
|
|
|
$this->assertEquals( self::$Success, $response );
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideOptionManupulation
|
|
* @param array $params
|
|
* @param array $setOptions
|
|
* @param array|null $result
|
|
*/
|
|
public function testOptionManupulation( array $params, array $setOptions, array $result = null,
|
|
$message = ''
|
|
) {
|
|
$this->mUserMock->expects( $this->never() )
|
|
->method( 'resetOptions' );
|
|
|
|
$this->mUserMock->expects( $this->exactly( count( $setOptions ) ) )
|
|
->method( 'setOption' )
|
|
->withConsecutive( ...$setOptions );
|
|
|
|
if ( $setOptions ) {
|
|
$this->mUserMock->expects( $this->once() )
|
|
->method( 'saveSettings' );
|
|
} else {
|
|
$this->mUserMock->expects( $this->never() )
|
|
->method( 'saveSettings' );
|
|
}
|
|
|
|
$request = $this->getSampleRequest( $params );
|
|
$response = $this->executeQuery( $request );
|
|
|
|
if ( !$result ) {
|
|
$result = self::$Success;
|
|
}
|
|
$this->assertEquals( $result, $response, $message );
|
|
}
|
|
|
|
public function provideOptionManupulation() {
|
|
return [
|
|
[
|
|
[ 'change' => 'userjs-option=1' ],
|
|
[ [ 'userjs-option', '1' ] ],
|
|
null,
|
|
'Setting userjs options',
|
|
],
|
|
[
|
|
[ 'change' => 'willBeNull|willBeEmpty=|willBeHappy=Happy' ],
|
|
[
|
|
[ 'willBeNull', null ],
|
|
[ 'willBeEmpty', '' ],
|
|
[ 'willBeHappy', 'Happy' ],
|
|
],
|
|
null,
|
|
'Basic option setting',
|
|
],
|
|
[
|
|
[ 'change' => 'testradio=option2' ],
|
|
[ [ 'testradio', 'option2' ] ],
|
|
null,
|
|
'Changing radio options',
|
|
],
|
|
[
|
|
[ 'change' => 'testradio' ],
|
|
[ [ 'testradio', null ] ],
|
|
null,
|
|
'Resetting radio options',
|
|
],
|
|
[
|
|
[ 'change' => 'unknownOption=1' ],
|
|
[],
|
|
[
|
|
'options' => 'success',
|
|
'warnings' => [
|
|
'options' => [
|
|
'warnings' => "Validation error for \"unknownOption\": not a valid preference."
|
|
],
|
|
],
|
|
],
|
|
'Unrecognized options should be rejected',
|
|
],
|
|
[
|
|
[ 'change' => 'special=1' ],
|
|
[],
|
|
[
|
|
'options' => 'success',
|
|
'warnings' => [
|
|
'options' => [
|
|
'warnings' => "Validation error for \"special\": cannot be set by this module."
|
|
]
|
|
]
|
|
],
|
|
'Refuse setting special options',
|
|
],
|
|
[
|
|
[
|
|
'change' => 'testmultiselect-opt1=1|testmultiselect-opt2|'
|
|
. 'testmultiselect-opt3=|testmultiselect-opt4=0'
|
|
],
|
|
[
|
|
[ 'testmultiselect-opt1', true ],
|
|
[ 'testmultiselect-opt2', null ],
|
|
[ 'testmultiselect-opt3', false ],
|
|
[ 'testmultiselect-opt4', false ],
|
|
],
|
|
null,
|
|
'Setting multiselect options',
|
|
],
|
|
[
|
|
[ 'optionname' => 'name', 'optionvalue' => 'value' ],
|
|
[ [ 'name', 'value' ] ],
|
|
null,
|
|
'Setting options via optionname/optionvalue'
|
|
],
|
|
[
|
|
[ 'optionname' => 'name' ],
|
|
[ [ 'name', null ] ],
|
|
null,
|
|
'Resetting options via optionname without optionvalue',
|
|
],
|
|
];
|
|
}
|
|
}
|