TestUserRegistry.php

Go to the documentation of this file.

<?php
 
class TestUserRegistry {
 
    private static $testUsers = [];
 
    private static $counter = 0;
 
    private static $randInt;
 
    public static function getNextId() {
        if ( !self::$randInt ) {
            self::$randInt = mt_rand( 1, 0xFFFFFF );
        }
        return sprintf( '%06x.%03x', self::$randInt, ++self::$counter );
    }
 
    public static function getMutableTestUser( $testName, $groups = [] ) {
        $id = self::getNextId();
        $password = wfRandomString( 20 );
        $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;
    }
 
    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 = wfRandomString( 20 );
            }
            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];
    }
 
    public static function clear() {
        self::$testUsers = [];
    }
 
    public static function isMutable( User $user ) {
        foreach ( self::$testUsers as $key => $testUser ) {
            if ( $user === $testUser->getUser() ) {
                return false;
            }
        }
        return true;
    }
}