MediaWiki  REL1_31
TestUserRegistry.php
Go to the documentation of this file.
1 <?php
2 
7 
9  private static $testUsers = [];
10 
12  private static $counter = 0;
13 
15  private static $randInt;
16 
17  public static function getNextId() {
18  if ( !self::$randInt ) {
19  self::$randInt = mt_rand( 1, 0xFFFFFF );
20  }
21  return sprintf( '%06x.%03x', self::$randInt, ++self::$counter );
22  }
23 
34  public static function getMutableTestUser( $testName, $groups = [] ) {
35  $id = self::getNextId();
36  $password = wfRandomString( 20 );
37  $testUser = new TestUser(
38  "TestUser $testName $id", // username
39  "Name $id", // real name
40  "$id@mediawiki.test", // e-mail
41  $groups, // groups
42  $password // password
43  );
44  $testUser->getUser()->clearInstanceCache();
45  return $testUser;
46  }
47 
60  public static function getImmutableTestUser( $groups = [] ) {
61  $groups = array_unique( $groups );
62  sort( $groups );
63  $key = implode( ',', $groups );
64 
65  $testUser = isset( self::$testUsers[$key] )
66  ? self::$testUsers[$key]
67  : false;
68 
69  if ( !$testUser || !$testUser->getUser()->isLoggedIn() ) {
70  $id = self::getNextId();
71  // Hack! If this is the primary sysop account, make the username
72  // be 'UTSysop', for back-compat, and for the sake of PHPUnit data
73  // provider methods, which are executed before the test database
74  // is set up. See T136348.
75  if ( $groups === [ 'bureaucrat', 'sysop' ] ) {
76  $username = 'UTSysop';
77  $password = 'UTSysopPassword';
78  } else {
79  $username = "TestUser $id";
80  $password = wfRandomString( 20 );
81  }
82  self::$testUsers[$key] = $testUser = new TestUser(
83  $username, // username
84  "Name $id", // real name
85  "$id@mediawiki.test", // e-mail
86  $groups, // groups
87  $password // password
88  );
89  }
90 
91  $testUser->getUser()->clearInstanceCache();
92  return self::$testUsers[$key];
93  }
94 
107  public static function clear() {
108  self::$testUsers = [];
109  }
110 
117  public static function isMutable( User $user ) {
118  foreach ( self::$testUsers as $key => $testUser ) {
119  if ( $user === $testUser->getUser() ) {
120  return false;
121  }
122  }
123  return true;
124  }
125 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
TestUserRegistry
Definition: TestUserRegistry.php:6
TestUserRegistry\$randInt
static int $randInt
Random int, included in IDs.
Definition: TestUserRegistry.php:15
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
TestUser
Wraps the user object, so we can also retain full access to properties like password if we log in via...
Definition: TestUser.php:7
TestUserRegistry\isMutable
static isMutable(User $user)
Definition: TestUserRegistry.php:117
TestUserRegistry\getNextId
static getNextId()
Definition: TestUserRegistry.php:17
TestUserRegistry\$counter
static int $counter
Count of users that have been generated.
Definition: TestUserRegistry.php:12
TestUserRegistry\$testUsers
static TestUser[] $testUsers
(group key => TestUser)
Definition: TestUserRegistry.php:9
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:785
TestUserRegistry\getMutableTestUser
static getMutableTestUser( $testName, $groups=[])
Get a TestUser object that the caller may modify.
Definition: TestUserRegistry.php:34
TestUserRegistry\getImmutableTestUser
static getImmutableTestUser( $groups=[])
Get a TestUser object that the caller may not modify.
Definition: TestUserRegistry.php:60
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
TestUserRegistry\clear
static clear()
Clear the registry.
Definition: TestUserRegistry.php:107
wfRandomString
wfRandomString( $length=32)
Get a random string containing a number of pseudo-random hex characters.
Definition: GlobalFunctions.php:305