3 define( 'NS_UNITTEST', 5600 );
4 define( 'NS_UNITTEST_TALK', 5601 );
9 class UserTest
extends MediaWikiTestCase
{
15 protected function setUp() {
18 $this->setMwGlobals( [
19 'wgGroupPermissions' => [],
20 'wgRevokePermissions' => [],
23 $this->setUpPermissionGlobals();
25 $this->user
= new User
;
26 $this->user
->addGroup( 'unittesters' );
29 private function setUpPermissionGlobals() {
30 global $wgGroupPermissions, $wgRevokePermissions;
32 # Data for regular $wgGroupPermissions test
33 $wgGroupPermissions['unittesters'] = [
39 $wgGroupPermissions['testwriters'] = [
45 # Data for regular $wgRevokePermissions test
46 $wgRevokePermissions['formertesters'] = [
50 # For the options test
51 $wgGroupPermissions['*'] = [
52 'editmyoptions' => true,
57 * @covers User::getGroupPermissions
59 public function testGroupPermissions() {
60 $rights = User
::getGroupPermissions( [ 'unittesters' ] );
61 $this->assertContains( 'runtest', $rights );
62 $this->assertNotContains( 'writetest', $rights );
63 $this->assertNotContains( 'modifytest', $rights );
64 $this->assertNotContains( 'nukeworld', $rights );
66 $rights = User
::getGroupPermissions( [ 'unittesters', 'testwriters' ] );
67 $this->assertContains( 'runtest', $rights );
68 $this->assertContains( 'writetest', $rights );
69 $this->assertContains( 'modifytest', $rights );
70 $this->assertNotContains( 'nukeworld', $rights );
74 * @covers User::getGroupPermissions
76 public function testRevokePermissions() {
77 $rights = User
::getGroupPermissions( [ 'unittesters', 'formertesters' ] );
78 $this->assertNotContains( 'runtest', $rights );
79 $this->assertNotContains( 'writetest', $rights );
80 $this->assertNotContains( 'modifytest', $rights );
81 $this->assertNotContains( 'nukeworld', $rights );
85 * @covers User::getRights
87 public function testUserPermissions() {
88 $rights = $this->user
->getRights();
89 $this->assertContains( 'runtest', $rights );
90 $this->assertNotContains( 'writetest', $rights );
91 $this->assertNotContains( 'modifytest', $rights );
92 $this->assertNotContains( 'nukeworld', $rights );
96 * @dataProvider provideGetGroupsWithPermission
97 * @covers User::getGroupsWithPermission
99 public function testGetGroupsWithPermission( $expected, $right ) {
100 $result = User
::getGroupsWithPermission( $right );
104 $this->assertEquals( $expected, $result, "Groups with permission $right" );
107 public static function provideGetGroupsWithPermission() {
110 [ 'unittesters', 'testwriters' ],
129 * @dataProvider provideIPs
132 public function testIsIP( $value, $result, $message ) {
133 $this->assertEquals( $this->user
->isIP( $value ), $result, $message );
136 public static function provideIPs() {
138 [ '', false, 'Empty string' ],
139 [ ' ', false, 'Blank space' ],
140 [ '10.0.0.0', true, 'IPv4 private 10/8' ],
141 [ '10.255.255.255', true, 'IPv4 private 10/8' ],
142 [ '192.168.1.1', true, 'IPv4 private 192.168/16' ],
143 [ '203.0.113.0', true, 'IPv4 example' ],
144 [ '2002:ffff:ffff:ffff:ffff:ffff:ffff:ffff', true, 'IPv6 example' ],
145 // Not valid IPs but classified as such by MediaWiki for negated asserting
146 // of whether this might be the identifier of a logged-out user or whether
147 // to allow usernames like it.
148 [ '300.300.300.300', true, 'Looks too much like an IPv4 address' ],
149 [ '203.0.113.xxx', true, 'Assigned by UseMod to cloaked logged-out users' ],
154 * @dataProvider provideUserNames
155 * @covers User::isValidUserName
157 public function testIsValidUserName( $username, $result, $message ) {
158 $this->assertEquals( $this->user
->isValidUserName( $username ), $result, $message );
161 public static function provideUserNames() {
163 [ '', false, 'Empty string' ],
164 [ ' ', false, 'Blank space' ],
165 [ 'abcd', false, 'Starts with small letter' ],
166 [ 'Ab/cd', false, 'Contains slash' ],
167 [ 'Ab cd', true, 'Whitespace' ],
168 [ '192.168.1.1', false, 'IP' ],
169 [ 'User:Abcd', false, 'Reserved Namespace' ],
170 [ '12abcd232', true, 'Starts with Numbers' ],
171 [ '?abcd', true, 'Start with ? mark' ],
172 [ '#abcd', false, 'Start with #' ],
173 [ 'Abcdകഖഗഘ', true, ' Mixed scripts' ],
174 [ 'ജോസ്തോമസ്', false, 'ZWNJ- Format control character' ],
175 [ 'Ab cd', false, ' Ideographic space' ],
176 [ '300.300.300.300', false, 'Looks too much like an IPv4 address' ],
177 [ '302.113.311.900', false, 'Looks too much like an IPv4 address' ],
178 [ '203.0.113.xxx', false, 'Reserved for usage by UseMod for cloaked logged-out users' ],
183 * Test, if for all rights a right- message exist,
184 * which is used on Special:ListGroupRights as help text
185 * Extensions and core
187 public function testAllRightsWithMessage() {
188 // Getting all user rights, for core: User::$mCoreRights, for extensions: $wgAvailableRights
189 $allRights = User
::getAllRights();
190 $allMessageKeys = Language
::getMessageKeysFor( 'en' );
192 $rightsWithMessage = [];
193 foreach ( $allMessageKeys as $message ) {
194 // === 0: must be at beginning of string (position 0)
195 if ( strpos( $message, 'right-' ) === 0 ) {
196 $rightsWithMessage[] = substr( $message, strlen( 'right-' ) );
201 sort( $rightsWithMessage );
206 'Each user rights (core/extensions) has a corresponding right- message.'
211 * Test User::editCount
213 * @covers User::getEditCount
215 public function testEditCount() {
216 $user = $this->getMutableTestUser()->getUser();
218 // let the user have a few (3) edits
219 $page = WikiPage
::factory( Title
::newFromText( 'Help:UserTest_EditCount' ) );
220 for ( $i = 0; $i < 3; $i++
) {
221 $page->doEdit( (string)$i, 'test', 0, false, $user );
224 $user->clearInstanceCache();
227 $user->getEditCount(),
228 'After three edits, the user edit count should be 3'
231 // increase the edit count and clear the cache
232 $user->incEditCount();
234 $user->clearInstanceCache();
237 $user->getEditCount(),
238 'After increasing the edit count manually, the user edit count should be 4'
243 * Test changing user options.
244 * @covers User::setOption
245 * @covers User::getOption
247 public function testOptions() {
248 $user = $this->getMutableTestUser()->getUser();
250 $user->setOption( 'userjs-someoption', 'test' );
251 $user->setOption( 'cols', 200 );
252 $user->saveSettings();
254 $user = User
::newFromName( $user->getName() );
255 $this->assertEquals( 'test', $user->getOption( 'userjs-someoption' ) );
256 $this->assertEquals( 200, $user->getOption( 'cols' ) );
261 * Make sure defaults are loaded when setOption is called.
262 * @covers User::loadOptions
264 public function testAnonOptions() {
265 global $wgDefaultUserOptions;
266 $this->user
->setOption( 'userjs-someoption', 'test' );
267 $this->assertEquals( $wgDefaultUserOptions['cols'], $this->user
->getOption( 'cols' ) );
268 $this->assertEquals( 'test', $this->user
->getOption( 'userjs-someoption' ) );
272 * Test password validity checks. There are 3 checks in core,
273 * - ensure the password meets the minimal length
274 * - ensure the password is not the same as the username
275 * - ensure the username/password combo isn't forbidden
276 * @covers User::checkPasswordValidity()
277 * @covers User::getPasswordValidity()
278 * @covers User::isValidPassword()
280 public function testCheckPasswordValidity() {
281 $this->setMwGlobals( [
282 'wgPasswordPolicy' => [
285 'MinimalPasswordLength' => 8,
286 'MinimumPasswordLengthToLogin' => 1,
287 'PasswordCannotMatchUsername' => 1,
290 'MinimalPasswordLength' => 6,
291 'PasswordCannotMatchUsername' => true,
292 'PasswordCannotMatchBlacklist' => true,
293 'MaximalPasswordLength' => 40,
297 'MinimalPasswordLength' => 'PasswordPolicyChecks::checkMinimalPasswordLength',
298 'MinimumPasswordLengthToLogin' => 'PasswordPolicyChecks::checkMinimumPasswordLengthToLogin',
299 'PasswordCannotMatchUsername' => 'PasswordPolicyChecks::checkPasswordCannotMatchUsername',
300 'PasswordCannotMatchBlacklist' => 'PasswordPolicyChecks::checkPasswordCannotMatchBlacklist',
301 'MaximalPasswordLength' => 'PasswordPolicyChecks::checkMaximalPasswordLength',
306 $user = static::getTestUser()->getUser();
309 $this->assertTrue( $user->isValidPassword( 'Password1234' ) );
312 $this->assertFalse( $user->isValidPassword( 'a' ) );
313 $this->assertFalse( $user->checkPasswordValidity( 'a' )->isGood() );
314 $this->assertTrue( $user->checkPasswordValidity( 'a' )->isOK() );
315 $this->assertEquals( 'passwordtooshort', $user->getPasswordValidity( 'a' ) );
318 $longPass = str_repeat( 'a', 41 );
319 $this->assertFalse( $user->isValidPassword( $longPass ) );
320 $this->assertFalse( $user->checkPasswordValidity( $longPass )->isGood() );
321 $this->assertFalse( $user->checkPasswordValidity( $longPass )->isOK() );
322 $this->assertEquals( 'passwordtoolong', $user->getPasswordValidity( $longPass ) );
325 $this->assertFalse( $user->checkPasswordValidity( $user->getName() )->isGood() );
326 $this->assertTrue( $user->checkPasswordValidity( $user->getName() )->isOK() );
327 $this->assertEquals( 'password-name-match', $user->getPasswordValidity( $user->getName() ) );
329 // On the forbidden list
330 $user = User
::newFromName( 'Useruser' );
331 $this->assertFalse( $user->checkPasswordValidity( 'Passpass' )->isGood() );
332 $this->assertEquals( 'password-login-forbidden', $user->getPasswordValidity( 'Passpass' ) );
336 * @covers User::getCanonicalName()
337 * @dataProvider provideGetCanonicalName
339 public function testGetCanonicalName( $name, $expectedArray ) {
340 // fake interwiki map for the 'Interwiki prefix' testcase
341 $this->mergeMwGlobalArrayValue( 'wgHooks', [
342 'InterwikiLoadPrefix' => [
343 function ( $prefix, &$iwdata ) {
344 if ( $prefix === 'interwiki' ) {
346 'iw_url' => 'http://example.com/',
356 foreach ( $expectedArray as $validate => $expected ) {
359 User
::getCanonicalName( $name, $validate === 'false' ?
false : $validate ), $validate );
363 public static function provideGetCanonicalName() {
365 'Leading space' => [ ' Leading space', [ 'creatable' => 'Leading space' ] ],
366 'Trailing space ' => [ 'Trailing space ', [ 'creatable' => 'Trailing space' ] ],
367 'Namespace prefix' => [ 'Talk:Username', [ 'creatable' => false, 'usable' => false,
368 'valid' => false, 'false' => 'Talk:Username' ] ],
369 'Interwiki prefix' => [ 'interwiki:Username', [ 'creatable' => false, 'usable' => false,
370 'valid' => false, 'false' => 'Interwiki:Username' ] ],
371 'With hash' => [ 'name with # hash', [ 'creatable' => false, 'usable' => false ] ],
372 'Multi spaces' => [ 'Multi spaces', [ 'creatable' => 'Multi spaces',
373 'usable' => 'Multi spaces' ] ],
374 'Lowercase' => [ 'lowercase', [ 'creatable' => 'Lowercase' ] ],
375 'Invalid character' => [ 'in[]valid', [ 'creatable' => false, 'usable' => false,
376 'valid' => false, 'false' => 'In[]valid' ] ],
377 'With slash' => [ 'with / slash', [ 'creatable' => false, 'usable' => false, 'valid' => false,
378 'false' => 'With / slash' ] ],
383 * @covers User::equals
385 public function testEquals() {
386 $first = $this->getMutableTestUser()->getUser();
387 $second = User
::newFromName( $first->getName() );
389 $this->assertTrue( $first->equals( $first ) );
390 $this->assertTrue( $first->equals( $second ) );
391 $this->assertTrue( $second->equals( $first ) );
393 $third = $this->getMutableTestUser()->getUser();
394 $fourth = $this->getMutableTestUser()->getUser();
396 $this->assertFalse( $third->equals( $fourth ) );
397 $this->assertFalse( $fourth->equals( $third ) );
399 // Test users loaded from db with id
400 $user = $this->getMutableTestUser()->getUser();
401 $fifth = User
::newFromId( $user->getId() );
402 $sixth = User
::newFromName( $user->getName() );
403 $this->assertTrue( $fifth->equals( $sixth ) );
407 * @covers User::getId
409 public function testGetId() {
410 $user = static::getTestUser()->getUser();
411 $this->assertTrue( $user->getId() > 0 );
416 * @covers User::isLoggedIn
417 * @covers User::isAnon
419 public function testLoggedIn() {
420 $user = $this->getMutableTestUser()->getUser();
421 $this->assertTrue( $user->isLoggedIn() );
422 $this->assertFalse( $user->isAnon() );
424 // Non-existent users are perceived as anonymous
425 $user = User
::newFromName( 'UTNonexistent' );
426 $this->assertFalse( $user->isLoggedIn() );
427 $this->assertTrue( $user->isAnon() );
430 $this->assertFalse( $user->isLoggedIn() );
431 $this->assertTrue( $user->isAnon() );
435 * @covers User::checkAndSetTouched
437 public function testCheckAndSetTouched() {
438 $user = $this->getMutableTestUser()->getUser();
439 $user = TestingAccessWrapper
::newFromObject( $user );
440 $this->assertTrue( $user->isLoggedIn() );
442 $touched = $user->getDBTouched();
444 $user->checkAndSetTouched(), "checkAndSetTouched() succeded" );
445 $this->assertGreaterThan(
446 $touched, $user->getDBTouched(), "user_touched increased with casOnTouched()" );
448 $touched = $user->getDBTouched();
450 $user->checkAndSetTouched(), "checkAndSetTouched() succeded #2" );
451 $this->assertGreaterThan(
452 $touched, $user->getDBTouched(), "user_touched increased with casOnTouched() #2" );