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 $testUser = $this->getTestUser();
67 $form = $this->getPreferencesFactory()->getForm( $testUser->getUser(), $this->context
);
68 $this->assertInstanceOf( PreferencesFormLegacy
::class, $form );
69 $this->assertCount( 5, $form->getPreferenceSections() );
73 * CSS classes for emailauthentication preference field when there's no email.
74 * @see https://phabricator.wikimedia.org/T36302
75 * @covers MediaWiki\Preferences\DefaultPreferencesFactory::profilePreferences()
76 * @dataProvider emailAuthenticationProvider
78 public function testEmailAuthentication( $user, $cssClass ) {
79 $prefs = $this->getPreferencesFactory()->getFormDescriptor( $user, $this->context
);
80 $this->assertArrayHasKey( 'cssclass', $prefs['emailauthentication'] );
81 $this->assertEquals( $cssClass, $prefs['emailauthentication']['cssclass'] );
84 public function emailAuthenticationProvider() {
85 $userNoEmail = new User
;
86 $userEmailUnauthed = new User
;
87 $userEmailUnauthed->setEmail( 'noauth@example.org' );
88 $userEmailAuthed = new User
;
89 $userEmailAuthed->setEmail( 'noauth@example.org' );
90 $userEmailAuthed->setEmailAuthenticationTimestamp( wfTimestamp() );
92 [ $userNoEmail, 'mw-email-none' ],
93 [ $userEmailUnauthed, 'mw-email-not-authenticated' ],
94 [ $userEmailAuthed, 'mw-email-authenticated' ],
99 * Test that PreferencesFormPreSave hook has correct data:
100 * - user Object is passed
101 * - oldUserOptions contains previous user options (before save)
102 * - formData and User object have set up new properties
104 * @see https://phabricator.wikimedia.org/T169365
105 * @covers MediaWiki\Preferences\DefaultPreferencesFactory::submitForm()
107 public function testPreferencesFormPreSaveHookHasCorrectData() {
116 $configMock = new HashConfig( [
119 $form = $this->getMockBuilder( PreferencesFormLegacy
::class )
120 ->disableOriginalConstructor()
123 $userMock = $this->getMockBuilder( User
::class )
124 ->disableOriginalConstructor()
126 $userMock->method( 'getOptions' )
127 ->willReturn( $oldOptions );
128 $userMock->method( 'isAllowedAny' )
129 ->willReturn( true );
130 $userMock->method( 'isAllowed' )
131 ->willReturn( true );
133 $userMock->expects( $this->exactly( 2 ) )
134 ->method( 'setOption' )
136 [ $this->equalTo( 'test' ), $this->equalTo( $newOptions[ 'test' ] ) ],
137 [ $this->equalTo( 'option' ), $this->equalTo( $newOptions[ 'option' ] ) ]
140 $form->expects( $this->any() )
141 ->method( 'getModifiedUser' )
142 ->willReturn( $userMock );
144 $form->expects( $this->any() )
145 ->method( 'getContext' )
146 ->willReturn( $this->context
);
148 $form->expects( $this->any() )
149 ->method( 'getConfig' )
150 ->willReturn( $configMock );
152 $this->setTemporaryHook( 'PreferencesFormPreSave',
153 function ( $formData, $form, $user, &$result, $oldUserOptions )
154 use ( $newOptions, $oldOptions, $userMock ) {
155 $this->assertSame( $userMock, $user );
156 foreach ( $newOptions as $option => $value ) {
157 $this->assertSame( $value, $formData[ $option ] );
159 foreach ( $oldOptions as $option => $value ) {
160 $this->assertSame( $value, $oldUserOptions[ $option ] );
162 $this->assertEquals( true, $result );
166 /** @var DefaultPreferencesFactory $factory */
167 $factory = TestingAccessWrapper
::newFromObject( $this->getPreferencesFactory() );
168 $factory->saveFormData( $newOptions, $form, [] );
172 * The rclimit preference should accept non-integer input and filter it to become an integer.
174 * @covers \MediaWiki\Preferences\DefaultPreferencesFactory::saveFormData
176 public function testIntvalFilter() {
177 // Test a string with leading zeros (i.e. not octal) and spaces.
178 $this->context
->getRequest()->setVal( 'wprclimit', ' 0012 ' );
180 $form = $this->getPreferencesFactory()->getForm( $user, $this->context
);
183 $this->assertEquals( 12, $user->getOption( 'rclimit' ) );