1fc8d79ac6
For example, documenting the method getUser() with "get the User object" does not add any information that's not already there. But I have to read the text first to understand that it doesn't document anything that's not already obvious from the code. Some of this is from a time when we had a PHPCS sniff that was complaining when a line like `@param User $user` doesn't end with some descriptive text. Some users started adding text like `@param User $user The User` back then. Let's please remove this. Change-Id: I0ea8d051bc732466c73940de9259f87ffb86ce7a
121 lines
3.3 KiB
PHP
121 lines
3.3 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @since 1.28
|
|
*/
|
|
class TestUserRegistry {
|
|
|
|
/** @var TestUser[] (group key => TestUser) */
|
|
private static $testUsers = [];
|
|
|
|
/** @var int Count of users that have been generated */
|
|
private static $counter = 0;
|
|
|
|
/** @var int Random int, included in IDs */
|
|
private static $randInt;
|
|
|
|
public static function getNextId() {
|
|
if ( !self::$randInt ) {
|
|
self::$randInt = mt_rand( 1, 0xFFFFFF );
|
|
}
|
|
return sprintf( '%06x.%03x', self::$randInt, ++self::$counter );
|
|
}
|
|
|
|
/**
|
|
* Get a TestUser object that the caller may modify.
|
|
*
|
|
* @since 1.28
|
|
*
|
|
* @param string $testName Caller's __CLASS__. Used to generate the
|
|
* user's username.
|
|
* @param string|string[] $groups Groups the test user should be added to.
|
|
* @return TestUser
|
|
*/
|
|
public static function getMutableTestUser( $testName, $groups = [] ) {
|
|
$id = self::getNextId();
|
|
$password = "password_for_test_user_id_{$id}";
|
|
$testUser = new TestUser(
|
|
"TestUser $testName $id", // username
|
|
"Name $id", // real name
|
|
"$id@mediawiki.test", // e-mail
|
|
(array)$groups, // groups
|
|
$password // password
|
|
);
|
|
$testUser->getUser()->clearInstanceCache();
|
|
return $testUser;
|
|
}
|
|
|
|
/**
|
|
* Get a TestUser object that the caller may not modify.
|
|
*
|
|
* Whenever possible, unit tests should use immutable users, because
|
|
* immutable users can be reused in multiple tests, which helps keep
|
|
* the unit tests fast.
|
|
*
|
|
* @since 1.28
|
|
*
|
|
* @param string|string[] $groups Groups the test user should be added to.
|
|
* @return TestUser
|
|
*/
|
|
public static function getImmutableTestUser( $groups = [] ) {
|
|
$groups = array_unique( (array)$groups );
|
|
sort( $groups );
|
|
$key = implode( ',', $groups );
|
|
|
|
$testUser = self::$testUsers[$key] ?? false;
|
|
|
|
if ( !$testUser || !$testUser->getUser()->isLoggedIn() ) {
|
|
$id = self::getNextId();
|
|
// Hack! If this is the primary sysop account, make the username
|
|
// be 'UTSysop', for back-compat, and for the sake of PHPUnit data
|
|
// provider methods, which are executed before the test database
|
|
// is set up. See T136348.
|
|
if ( $groups === [ 'bureaucrat', 'sysop' ] ) {
|
|
$username = 'UTSysop';
|
|
$password = 'UTSysopPassword';
|
|
} else {
|
|
$username = "TestUser $id";
|
|
$password = "password_for_test_user_id_{$id}";
|
|
}
|
|
self::$testUsers[$key] = $testUser = new TestUser(
|
|
$username, // username
|
|
"Name $id", // real name
|
|
"$id@mediawiki.test", // e-mail
|
|
$groups, // groups
|
|
$password // password
|
|
);
|
|
}
|
|
|
|
$testUser->getUser()->clearInstanceCache();
|
|
return self::$testUsers[$key];
|
|
}
|
|
|
|
/**
|
|
* TestUsers created by this class will not be deleted, but any handles
|
|
* to existing immutable TestUsers will be deleted, ensuring these users
|
|
* are not reused. We don't reset the counter or random string by design.
|
|
*
|
|
* @since 1.28
|
|
*
|
|
* @return TestUser
|
|
*/
|
|
public static function clear() {
|
|
self::$testUsers = [];
|
|
}
|
|
|
|
/**
|
|
* @todo It would be nice if this were a non-static method of TestUser
|
|
* instead, but that doesn't seem possible without friends?
|
|
*
|
|
* @param User $user
|
|
* @return bool True if it's safe to modify the user
|
|
*/
|
|
public static function isMutable( User $user ) {
|
|
foreach ( self::$testUsers as $key => $testUser ) {
|
|
if ( $user === $testUser->getUser() ) {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
}
|