1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
|
<?php
namespace MediaWiki\Tests\User\Options;
use MediaWiki\Config\HashConfig;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\MainConfigNames;
use MediaWiki\User\Options\ConditionalDefaultsLookup;
use MediaWiki\User\Registration\UserRegistrationLookup;
use MediaWiki\User\UserGroupManager;
use MediaWiki\User\UserIdentityUtils;
use MediaWiki\User\UserIdentityValue;
use MediaWikiUnitTestCase;
/**
* @coversDefaultClass \MediaWiki\User\Options\ConditionalDefaultsLookup
*/
class ConditionalDefaultsLookupTest extends MediaWikiUnitTestCase {
private const CONDITIONAL_USER_DEFAULTS = [
[
'new accounts',
[ CUDCOND_AFTER, '20231215000000' ],
],
[
'anonymous users',
[ CUDCOND_ANON ],
],
[
'named users',
[ CUDCOND_NAMED ],
],
[
'sysop users',
[ CUDCOND_USERGROUP, 'sysop' ],
],
];
private const CONDITIONAL_USER_DEFAULTS_AFTER = [
[
'new accounts',
[ CUDCOND_AFTER, '20231215000000' ],
]
];
private const CONDITIONAL_USER_DEFAULTS_ANON = [
[
'anonymous users',
[ CUDCOND_ANON ],
]
];
private const CONDITIONAL_USER_DEFAULTS_NAMED = [
[
'named users',
[ CUDCOND_NAMED ],
]
];
private const CONDITIONAL_USER_DEFAULTS_USERGROUP = [
[
'sysop users',
[ CUDCOND_USERGROUP, 'sysop' ],
]
];
/**
* Construct ServiceOptions using a HashConfig
*
* @param array $configOverrides
* @return ServiceOptions
*/
private function getServiceOptions( array $configOverrides = [] ) {
return new ServiceOptions(
ConditionalDefaultsLookup::CONSTRUCTOR_OPTIONS,
new HashConfig( $configOverrides + [
MainConfigNames::ConditionalUserOptions => [],
] )
);
}
/**
* @covers ::hasConditionalDefault
* @dataProvider provideIsConditionallyDefault
* @param bool $expected
* @param string $option
* @return void
*/
public function testIsConditionallyDefault( bool $expected, string $option ) {
$lookup = new ConditionalDefaultsLookup(
$this->getServiceOptions( [
MainConfigNames::ConditionalUserOptions => [
'foo-option' => self::CONDITIONAL_USER_DEFAULTS,
'bar-option' => [
[ 'all accounts' ]
],
]
] ),
$this->createNoOpMock( UserRegistrationLookup::class ),
$this->createNoOpMock( UserIdentityUtils::class ),
static function () {
}
);
$this->assertSame(
$expected,
$lookup->hasConditionalDefault( $option )
);
}
public static function provideIsConditionallyDefault() {
return [
'foo-option' => [ true, 'foo-option' ],
'bar-option' => [ true, 'bar-option' ],
'some-option' => [ false, 'some-option' ],
];
}
/**
* @covers ::getOptionDefaultForUser
*/
public function testGetOptionDefaultForUser__notConditionallyDefault() {
$lookup = new ConditionalDefaultsLookup(
$this->getServiceOptions(),
$this->createNoOpMock( UserRegistrationLookup::class ),
$this->createNoOpMock( UserIdentityUtils::class ),
static function () {
}
);
$this->assertNull( $lookup->getOptionDefaultForUser(
'foo-option',
new UserIdentityValue( 1, 'Admin' )
) );
}
/**
* @covers ::getOptionDefaultForUser
* @covers ::checkConditionsForUser
* @covers ::checkConditionForUser
* @dataProvider provideGetOptionDefaultForUser__registration
* @param string|null $expected
* @param string|null $registrationTS
* @param array $conditions
*/
public function testGetOptionDefaultForUser__registration(
?string $expected,
?string $registrationTS,
array $conditions
) {
$userIdentity = new UserIdentityValue( 1, 'User' );
$registrationLookup = $this->createMock( UserRegistrationLookup::class );
$registrationLookup->expects( $this->once() )
->method( 'getRegistration' )
->with( $userIdentity )
->willReturn( $registrationTS );
$lookup = new ConditionalDefaultsLookup(
$this->getServiceOptions( [
MainConfigNames::ConditionalUserOptions => [
'foo-option' => $conditions,
]
] ),
$registrationLookup,
$this->createNoOpMock( UserIdentityUtils::class ),
static function () {
}
);
$this->assertSame(
$expected,
$lookup->getOptionDefaultForUser( 'foo-option', $userIdentity )
);
}
public static function provideGetOptionDefaultForUser__registration(): array {
return [
[ null, '20231101000000', self::CONDITIONAL_USER_DEFAULTS_AFTER ],
[ 'new accounts', '20241101000000', self::CONDITIONAL_USER_DEFAULTS_AFTER ],
[ null, null, self::CONDITIONAL_USER_DEFAULTS_AFTER ],
];
}
/**
* @covers ::getOptionDefaultForUser
* @covers ::checkConditionsForUser
* @covers ::checkConditionForUser
* @dataProvider provideGetOptionDefaultForUser__anon
* @param int $id the user ID
* @param string|null $expected the default option or null if none apply
*/
public function testGetOptionDefaultForUser__anon( int $id, ?string $expected ) {
$userIdentity = new UserIdentityValue( $id, 'test user' );
$options = $this->getServiceOptions( [
MainConfigNames::ConditionalUserOptions => [
'test-option' => self::CONDITIONAL_USER_DEFAULTS_ANON,
]
] );
$registrationLookup = $this->createNoOpMock( UserRegistrationLookup::class );
$userIdentityUtils = $this->createNoOpMock( UserIdentityUtils::class );
$lookup = new ConditionalDefaultsLookup( $options, $registrationLookup, $userIdentityUtils,
static function () {
} );
$this->assertSame( $expected, $lookup->getOptionDefaultForUser( 'test-option', $userIdentity ) );
}
public static function provideGetOptionDefaultForUser__anon(): array {
return [
[ 0, 'anonymous users' ],
[ 1, null ],
];
}
/**
* @covers ::getOptionDefaultForUser
* @covers ::checkConditionsForUser
* @covers ::checkConditionForUser
* @dataProvider provideGetOptionDefaultForUser__named
* @param bool $isNamed whether the user is named or not (logged in and not temporary)
* @param string|null $expected the default option or null if none apply
*/
public function testGetOptionDefaultForUser__named( bool $isNamed, ?string $expected ) {
$userIdentity = new UserIdentityValue( 1, 'test user' );
$options = $this->getServiceOptions( [
MainConfigNames::ConditionalUserOptions => [
'test-option' => self::CONDITIONAL_USER_DEFAULTS_NAMED,
]
] );
$registrationLookup = $this->createNoOpMock( UserRegistrationLookup::class );
$userIdentityUtils = $this->createMock( UserIdentityUtils::class );
$userIdentityUtils->expects( $this->once() )
->method( 'isNamed' )
->with( $userIdentity )
->willReturn( $isNamed );
$lookup = new ConditionalDefaultsLookup( $options, $registrationLookup, $userIdentityUtils,
static function () {
} );
$this->assertSame( $expected, $lookup->getOptionDefaultForUser( 'test-option', $userIdentity ) );
}
public static function provideGetOptionDefaultForUser__named(): array {
return [
[ true, 'named users' ],
[ false, null ],
];
}
/**
* @covers ::getOptionDefaultForUser
* @covers ::checkConditionsForUser
* @covers ::checkConditionForUser
* @dataProvider provideGetOptionDefaultForUser__usergroup
* @param array[string] $usergroups the user groups the user has
* @param string|null $expected the default option or null if none apply
*/
public function testGetOptionDefaultForUser__usergroup( array $usergroups, ?string $expected ) {
$userIdentity = new UserIdentityValue( 1, 'test user' );
$options = $this->getServiceOptions( [
MainConfigNames::ConditionalUserOptions => [
'test-option' => self::CONDITIONAL_USER_DEFAULTS_USERGROUP,
]
] );
$registrationLookup = $this->createNoOpMock( UserRegistrationLookup::class );
$userIdentityUtils = $this->createMock( UserIdentityUtils::class );
$userGroupManager = $this->createMock( UserGroupManager::class );
$userGroupManager->expects( $this->once() )
->method( 'getUserEffectiveGroups' )
->with( $userIdentity )
->willReturn( $usergroups );
$lookup = new ConditionalDefaultsLookup( $options, $registrationLookup, $userIdentityUtils,
static function () use ( $userGroupManager ) {
return $userGroupManager;
} );
$this->assertSame( $expected, $lookup->getOptionDefaultForUser( 'test-option', $userIdentity ) );
}
public static function provideGetOptionDefaultForUser__usergroup(): array {
return [
[ [ '*', 'user', 'sysop' ], 'sysop users' ],
[ [ 'user' ], null ],
];
}
/**
* @covers ::getOptionDefaultForUser
* @covers ::checkConditionsForUser
* @covers ::checkConditionForUser
* @dataProvider provideGetOptionDefaultForUser__extraCondition
* @param array $configConditions An array of condition descriptors as described for $wgConditionalUserOptions
* @param array $extraConditions Key is the condition name and value is a callable
* @param string|null $expected the default option or null if none apply
*/
public function testGetOptionDefaultForUser__extraCondition( array $configConditions, array $extraConditions, ?string $expected ) {
$userIdentity = new UserIdentityValue( 1, 'test user' );
$options = $this->getServiceOptions( [
MainConfigNames::ConditionalUserOptions => [
'test-option' => $configConditions
]
] );
$registrationLookup = $this->createNoOpMock( UserRegistrationLookup::class );
$userIdentityUtils = $this->createMock( UserIdentityUtils::class );
$lookup = new ConditionalDefaultsLookup( $options, $registrationLookup, $userIdentityUtils,
static function () {
},
$extraConditions
);
$this->assertSame( $expected, $lookup->getOptionDefaultForUser( 'test-option', $userIdentity ) );
}
public static function provideGetOptionDefaultForUser__extraCondition(): array {
return [
[
[
[ 'No', [ 'if-condition', false ] ],
[ 'Yes', [ 'if-condition', true ] ],
],
[
'if-condition' => static function ( $userIdentity, $args ) {
return (bool)$args[0];
},
],
'Yes'
],
[
[
[ 'Yes', [ 'if-condition', true ] ],
[ 'No', [ 'if-condition', false ] ],
],
[
'if-condition' => static function ( $userIdentity, $args ) {
return !(bool)$args[0];
},
],
'No'
]
];
}
}
|