Page MenuHomeWickedGov Phorge
Files F5983381

TestUser.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

TestUser.php
View Options

<?php
use MediaWiki\MediaWikiServices;
use MediaWiki\Permissions\Authority;
use MediaWiki\User\User;
use MediaWiki\User\UserIdentity;
use MediaWiki\User\UserIdentityValue;
/**
* Wraps the user object, so we can also retain full access to properties
* like password if we log in via the API.
*/
class TestUser {
/**
* @var string
*/
private $username;
/**
* @var string
*/
private $password;
/**
* @var User
*/
private $user;
private function assertNotReal() {
global $wgDBprefix;
if (
$wgDBprefix !== MediaWikiIntegrationTestCase::DB_PREFIX &&
$wgDBprefix !== ParserTestRunner::DB_PREFIX
) {
throw new RuntimeException( "Can't create user on real database" );
}
}
public function __construct( string $username, string $realname = 'Real Name',
string $email = 'sample@example.com', array $groups = []
) {
$this->assertNotReal();
$this->username = $username;
$this->password = 'TestUser';
$this->user = User::newFromName( $this->username );
$this->user->load();
// In an ideal world we'd have a new wiki (or mock data store) for every single test.
// But for now, we just need to create or update the user with the desired properties.
// we particularly need the new password, since we just generated it randomly.
// In core MediaWiki, there is no functionality to delete users, so this is the best we can do.
if ( !$this->user->isRegistered() ) {
// create the user
$this->user = User::createNew(
$this->username, [
"email" => $email,
"real_name" => $realname
]
);
if ( !$this->user ) {
throw new RuntimeException( "Error creating TestUser " . $username );
}
}
// Update the user to use the password and other details
$this->setPassword( $this->password );
$change = $this->setEmail( $email ) ||
$this->setRealName( $realname );
// Adjust groups by adding any missing ones and removing any extras
$userGroupManager = MediaWikiServices::getInstance()->getUserGroupManager();
$currentGroups = $userGroupManager->getUserGroups( $this->user );
$userGroupManager->addUserToMultipleGroups( $this->user, array_diff( $groups, $currentGroups ) );
foreach ( array_diff( $currentGroups, $groups ) as $group ) {
$userGroupManager->removeUserFromGroup( $this->user, $group );
}
if ( $change ) {
// Disable CAS check before saving. The User object may have been initialized from cached
// information that may be out of whack with the database during testing. If tests were
// perfectly isolated, this would not happen. But if it does happen, let's just ignore the
// inconsistency, and just write the data we want - during testing, we are not worried
// about data loss.
$this->user->mTouched = '';
$this->user->saveSettings();
}
}
/**
* @param string $realname
* @return bool
*/
private function setRealName( $realname ) {
if ( $this->user->getRealName() !== $realname ) {
$this->user->setRealName( $realname );
return true;
}
return false;
}
/**
* @param string $email
* @return bool
*/
private function setEmail( string $email ) {
if ( $this->user->getEmail() !== $email ) {
$this->user->setEmail( $email );
return true;
}
return false;
}
/**
* @param string $password
*/
private function setPassword( $password ) {
self::setPasswordForUser( $this->user, $password );
}
/**
* Set the password on a testing user
*
* This assumes we're still using the generic AuthManager config from
* PHPUnitMaintClass::finalSetup(), and just sets the password in the
* database directly.
* @param User $user
* @param string $password
*/
public static function setPasswordForUser( User $user, $password ) {
if ( !$user->getId() ) {
throw new InvalidArgumentException( "Passed User has not been added to the database yet!" );
}
$services = MediaWikiServices::getInstance();
$dbw = $services->getConnectionProvider()->getPrimaryDatabase();
$row = $dbw->newSelectQueryBuilder()
->select( [ 'user_password' ] )
->from( 'user' )
->where( [ 'user_id' => $user->getId() ] )
->caller( __METHOD__ )->fetchRow();
if ( !$row ) {
throw new RuntimeException( "Passed User has an ID but is not in the database?" );
}
$passwordFactory = $services->getPasswordFactory();
if ( !$passwordFactory->newFromCiphertext( $row->user_password )->verify( $password ) ) {
$passwordHash = $passwordFactory->newFromPlaintext( $password );
$dbw->newUpdateQueryBuilder()
->update( 'user' )
->set( [ 'user_password' => $passwordHash->toString() ] )
->where( [ 'user_id' => $user->getId() ] )
->caller( __METHOD__ )->execute();
}
}
/**
* @since 1.25
* @return User
*/
public function getUser() {
return $this->user;
}
/**
* @since 1.39
* @return Authority
*/
public function getAuthority(): Authority {
return $this->user;
}
/**
* @since 1.36
* @return UserIdentity
*/
public function getUserIdentity(): UserIdentity {
return new UserIdentityValue( $this->user->getId(), $this->user->getName() );
}
/**
* @since 1.25
* @return string
*/
public function getPassword() {
return $this->password;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 22:51 (1 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
34/e4/34e3292f5ad69002bea89a0c2392
Default Alt Text
TestUser.php (5 KB)

Event Timeline