3 use MediaWiki\Auth\AuthManager
;
4 use MediaWiki\MediaWikiServices
;
5 use MediaWiki\Preferences\DefaultPreferencesFactory
;
6 use Wikimedia\TestingAccessWrapper
;
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
30 class DefaultPreferencesFactoryTest
extends MediaWikiTestCase
{
32 /** @var IContextSource */
38 public function setUp() {
40 $this->context
= new RequestContext();
41 $this->context
->setTitle( Title
::newFromText( self
::class ) );
43 $services = MediaWikiServices
::getInstance();
45 $this->setMwGlobals( 'wgParser', $services->getParserFactory()->create() );
46 $this->config
= $services->getMainConfig();
50 * Get a basic PreferencesFactory for testing with.
51 * @return DefaultPreferencesFactory
53 protected function getPreferencesFactory() {
54 return new DefaultPreferencesFactory(
57 AuthManager
::singleton(),
58 MediaWikiServices
::getInstance()->getLinkRenderer()
63 * @covers MediaWiki\Preferences\DefaultPreferencesFactory::getForm()
65 public function testGetForm() {
66 $this->setTemporaryHook( 'GetPreferences', null );
68 $testUser = $this->getTestUser();
69 $form = $this->getPreferencesFactory()->getForm( $testUser->getUser(), $this->context
);
70 $this->assertInstanceOf( PreferencesFormLegacy
::class, $form );
71 $this->assertCount( 5, $form->getPreferenceSections() );
75 * CSS classes for emailauthentication preference field when there's no email.
76 * @see https://phabricator.wikimedia.org/T36302
77 * @covers MediaWiki\Preferences\DefaultPreferencesFactory::profilePreferences()
78 * @dataProvider emailAuthenticationProvider
80 public function testEmailAuthentication( $user, $cssClass ) {
81 $prefs = $this->getPreferencesFactory()->getFormDescriptor( $user, $this->context
);
82 $this->assertArrayHasKey( 'cssclass', $prefs['emailauthentication'] );
83 $this->assertEquals( $cssClass, $prefs['emailauthentication']['cssclass'] );
86 public function emailAuthenticationProvider() {
87 $userNoEmail = new User
;
88 $userEmailUnauthed = new User
;
89 $userEmailUnauthed->setEmail( 'noauth@example.org' );
90 $userEmailAuthed = new User
;
91 $userEmailAuthed->setEmail( 'noauth@example.org' );
92 $userEmailAuthed->setEmailAuthenticationTimestamp( wfTimestamp() );
94 [ $userNoEmail, 'mw-email-none' ],
95 [ $userEmailUnauthed, 'mw-email-not-authenticated' ],
96 [ $userEmailAuthed, 'mw-email-authenticated' ],
101 * Test that PreferencesFormPreSave hook has correct data:
102 * - user Object is passed
103 * - oldUserOptions contains previous user options (before save)
104 * - formData and User object have set up new properties
106 * @see https://phabricator.wikimedia.org/T169365
107 * @covers MediaWiki\Preferences\DefaultPreferencesFactory::submitForm()
109 public function testPreferencesFormPreSaveHookHasCorrectData() {
118 $configMock = new HashConfig( [
121 $form = $this->getMockBuilder( PreferencesFormLegacy
::class )
122 ->disableOriginalConstructor()
125 $userMock = $this->getMockBuilder( User
::class )
126 ->disableOriginalConstructor()
128 $userMock->method( 'getOptions' )
129 ->willReturn( $oldOptions );
130 $userMock->method( 'isAllowedAny' )
131 ->willReturn( true );
132 $userMock->method( 'isAllowed' )
133 ->willReturn( true );
135 $userMock->expects( $this->exactly( 2 ) )
136 ->method( 'setOption' )
138 [ $this->equalTo( 'test' ), $this->equalTo( $newOptions[ 'test' ] ) ],
139 [ $this->equalTo( 'option' ), $this->equalTo( $newOptions[ 'option' ] ) ]
142 $form->expects( $this->any() )
143 ->method( 'getModifiedUser' )
144 ->willReturn( $userMock );
146 $form->expects( $this->any() )
147 ->method( 'getContext' )
148 ->willReturn( $this->context
);
150 $form->expects( $this->any() )
151 ->method( 'getConfig' )
152 ->willReturn( $configMock );
154 $this->setTemporaryHook( 'PreferencesFormPreSave',
155 function ( $formData, $form, $user, &$result, $oldUserOptions )
156 use ( $newOptions, $oldOptions, $userMock ) {
157 $this->assertSame( $userMock, $user );
158 foreach ( $newOptions as $option => $value ) {
159 $this->assertSame( $value, $formData[ $option ] );
161 foreach ( $oldOptions as $option => $value ) {
162 $this->assertSame( $value, $oldUserOptions[ $option ] );
164 $this->assertEquals( true, $result );
168 /** @var DefaultPreferencesFactory $factory */
169 $factory = TestingAccessWrapper
::newFromObject( $this->getPreferencesFactory() );
170 $factory->saveFormData( $newOptions, $form, [] );
174 * The rclimit preference should accept non-integer input and filter it to become an integer.
176 * @covers \MediaWiki\Preferences\DefaultPreferencesFactory::saveFormData
178 public function testIntvalFilter() {
179 // Test a string with leading zeros (i.e. not octal) and spaces.
180 $this->context
->getRequest()->setVal( 'wprclimit', ' 0012 ' );
182 $form = $this->getPreferencesFactory()->getForm( $user, $this->context
);
185 $this->assertEquals( 12, $user->getOption( 'rclimit' ) );