tests/phpunit/includes/TestUser.php

   1 <?php
   2
   3 /**
   4  * Wraps the user object, so we can also retain full access to properties
   5  * like password if we log in via the API.
   6  */
   7 class TestUser {
   8         /**
   9          * @deprecated Since 1.25. Use TestUser::getUser()->getName()
  10          * @private
  11          * @var string
  12          */
  13         public $username;
  14
  15         /**
  16          * @deprecated Since 1.25. Use TestUser::getPassword()
  17          * @private
  18          * @var string
  19          */
  20         public $password;
  21
  22         /**
  23          * @deprecated Since 1.25. Use TestUser::getUser()
  24          * @private
  25          * @var User
  26          */
  27         public $user;
  28
  29         private function assertNotReal() {
  30                 global $wgDBprefix;
  31                 if ( $wgDBprefix !== MediaWikiTestCase::DB_PREFIX &&
  32                         $wgDBprefix !== MediaWikiTestCase::ORA_DB_PREFIX
  33                 ) {
  34                         throw new MWException( "Can't create user on real database" );
  35                 }
  36         }
  37
  38         public function __construct( $username, $realname = 'Real Name',
  39                 $email = 'sample@example.com', $groups = array()
  40         ) {
  41                 $this->assertNotReal();
  42
  43                 $this->username = $username;
  44                 $this->password = 'TestUser';
  45
  46                 $this->user = User::newFromName( $this->username );
  47                 $this->user->load();
  48
  49                 // In an ideal world we'd have a new wiki (or mock data store) for every single test.
  50                 // But for now, we just need to create or update the user with the desired properties.
  51                 // we particularly need the new password, since we just generated it randomly.
  52                 // In core MediaWiki, there is no functionality to delete users, so this is the best we can do.
  53                 if ( !$this->user->isLoggedIn() ) {
  54                         // create the user
  55                         $this->user = User::createNew(
  56                                 $this->username, array(
  57                                         "email" => $email,
  58                                         "real_name" => $realname
  59                                 )
  60                         );
  61
  62                         if ( !$this->user ) {
  63                                 throw new MWException( "Error creating TestUser " . $username );
  64                         }
  65                 }
  66
  67                 // Update the user to use the password and other details
  68                 $change = $this->setPassword( $this->password ) ||
  69                         $this->setEmail( $email ) ||
  70                         $this->setRealName( $realname );
  71
  72                 // Adjust groups by adding any missing ones and removing any extras
  73                 $currentGroups = $this->user->getGroups();
  74                 foreach ( array_diff( $groups, $currentGroups ) as $group ) {
  75                         $this->user->addGroup( $group );
  76                 }
  77                 foreach ( array_diff( $currentGroups, $groups ) as $group ) {
  78                         $this->user->removeGroup( $group );
  79                 }
  80                 if ( $change ) {
  81                         $this->user->saveSettings();
  82                 }
  83         }
  84
  85         /**
  86          * @param string $realname
  87          * @return bool
  88          */
  89         private function setRealName( $realname ) {
  90                 if ( $this->user->getRealName() !== $realname ) {
  91                         $this->user->setRealName( $realname );
  92                         return true;
  93                 }
  94
  95                 return false;
  96         }
  97
  98         /**
  99          * @param string $email
 100          * @return bool
 101          */
 102         private function setEmail( $email ) {
 103                 if ( $this->user->getEmail() !== $email ) {
 104                         $this->user->setEmail( $email );
 105                         return true;
 106                 }
 107
 108                 return false;
 109         }
 110
 111         /**
 112          * @param string $password
 113          * @return bool
 114          */
 115         private function setPassword( $password ) {
 116                 $passwordFactory = $this->user->getPasswordFactory();
 117                 $oldDefaultType = $passwordFactory->getDefaultType();
 118
 119                 // A is unsalted MD5 (thus fast) ... we don't care about security here, this is test only
 120                 $passwordFactory->setDefaultType( 'A' );
 121                 $newPassword = $passwordFactory->newFromPlaintext( $password, $this->user->getPassword() );
 122
 123                 $change = false;
 124                 if ( !$this->user->getPassword()->equals( $newPassword ) ) {
 125                         // Password changed
 126                         $this->user->setPassword( $password );
 127                         $change = true;
 128                 }
 129
 130                 $passwordFactory->setDefaultType( $oldDefaultType );
 131
 132                 return $change;
 133         }
 134
 135         /**
 136          * @return User
 137          */
 138         public function getUser() {
 139                 return $this->user;
 140         }
 141
 142         /**
 143          * @return string
 144          */
 145         public function getPassword() {
 146                 return $this->password;
 147         }
 148 }