tests/phpunit/includes/auth/UserDataAuthenticationRequestTest.php

   1 <?php
   2
   3 namespace MediaWiki\Tests\Auth;
   4
   5 use MediaWiki\Auth\UserDataAuthenticationRequest;
   6 use MediaWiki\MainConfigNames;
   7 use MediaWiki\User\User;
   8 use StatusValue;
   9
  10 /**
  11  * @group AuthManager
  12  * @covers \MediaWiki\Auth\UserDataAuthenticationRequest
  13  */
  14 class UserDataAuthenticationRequestTest extends AuthenticationRequestTestCase {
  15
  16         protected function getInstance( array $args = [] ) {
  17                 return new UserDataAuthenticationRequest;
  18         }
  19
  20         protected function setUp(): void {
  21                 parent::setUp();
  22                 $this->overrideConfigValue( MainConfigNames::HiddenPrefs, [] );
  23         }
  24
  25         /**
  26          * @dataProvider providePopulateUser
  27          * @param string $email Email to set
  28          * @param string $realname Realname to set
  29          * @param StatusValue $expect Expected return
  30          */
  31         public function testPopulateUser( $email, $realname, $expect ) {
  32                 $this->clearHooks( [
  33                         'UserGetEmail',
  34                         'UserSetEmailAuthenticationTimestamp',
  35                         'InvalidateEmailComplete',
  36                         'UserSetEmail',
  37                 ] );
  38
  39                 $user = new User();
  40                 $user->setEmail( 'default@example.com' );
  41                 $user->setRealName( 'Fake Name' );
  42
  43                 $req = new UserDataAuthenticationRequest;
  44                 $req->email = $email;
  45                 $req->realname = $realname;
  46                 $this->assertEquals( $expect, $req->populateUser( $user ) );
  47                 if ( $expect->isOK() ) {
  48                         $this->assertSame( $email ?: 'default@example.com', $user->getEmail() );
  49                         $this->assertSame( $realname ?: 'Fake Name', $user->getRealName() );
  50                 }
  51         }
  52
  53         public static function providePopulateUser() {
  54                 $good = StatusValue::newGood();
  55                 return [
  56                         [ 'email@example.com', 'Real Name', $good ],
  57                         [ 'email@example.com', '', $good ],
  58                         [ '', 'Real Name', $good ],
  59                         [ '', '', $good ],
  60                         [ 'invalid-email', 'Real Name', StatusValue::newFatal( 'invalidemailaddress' ) ],
  61                 ];
  62         }
  63
  64         /**
  65          * @dataProvider provideLoadFromSubmission
  66          */
  67         public function testLoadFromSubmission(
  68                 array $args, array $data, $expectState, $hiddenPref = null, $enableEmail = null
  69         ) {
  70                 $this->overrideConfigValues( [
  71                         MainConfigNames::HiddenPrefs => $hiddenPref,
  72                         MainConfigNames::EnableEmail => $enableEmail,
  73                 ] );
  74                 parent::testLoadFromSubmission( $args, $data, $expectState );
  75         }
  76
  77         public static function provideLoadFromSubmission() {
  78                 $unhidden = [];
  79                 $hidden = [ 'realname' ];
  80
  81                 return [
  82                         'Empty request, unhidden, email enabled' => [
  83                                 [],
  84                                 [],
  85                                 false,
  86                                 $unhidden,
  87                                 true
  88                         ],
  89                         'email + realname, unhidden, email enabled' => [
  90                                 [],
  91                                 $data = [ 'email' => 'Email', 'realname' => 'Name' ],
  92                                 $data,
  93                                 $unhidden,
  94                                 true
  95                         ],
  96                         'email empty, unhidden, email enabled' => [
  97                                 [],
  98                                 $data = [ 'email' => '', 'realname' => 'Name' ],
  99                                 $data,
 100                                 $unhidden,
 101                                 true
 102                         ],
 103                         'email omitted, unhidden, email enabled' => [
 104                                 [],
 105                                 [ 'realname' => 'Name' ],
 106                                 false,
 107                                 $unhidden,
 108                                 true
 109                         ],
 110                         'realname empty, unhidden, email enabled' => [
 111                                 [],
 112                                 $data = [ 'email' => 'Email', 'realname' => '' ],
 113                                 $data,
 114                                 $unhidden,
 115                                 true
 116                         ],
 117                         'realname omitted, unhidden, email enabled' => [
 118                                 [],
 119                                 [ 'email' => 'Email' ],
 120                                 false,
 121                                 $unhidden,
 122                                 true
 123                         ],
 124                         'Empty request, hidden, email enabled' => [
 125                                 [],
 126                                 [],
 127                                 false,
 128                                 $hidden,
 129                                 true
 130                         ],
 131                         'email + realname, hidden, email enabled' => [
 132                                 [],
 133                                 [ 'email' => 'Email', 'realname' => 'Name' ],
 134                                 [ 'email' => 'Email' ],
 135                                 $hidden,
 136                                 true
 137                         ],
 138                         'email empty, hidden, email enabled' => [
 139                                 [],
 140                                 $data = [ 'email' => '', 'realname' => 'Name' ],
 141                                 [ 'email' => '' ],
 142                                 $hidden,
 143                                 true
 144                         ],
 145                         'email omitted, hidden, email enabled' => [
 146                                 [],
 147                                 [ 'realname' => 'Name' ],
 148                                 false,
 149                                 $hidden,
 150                                 true
 151                         ],
 152                         'realname empty, hidden, email enabled' => [
 153                                 [],
 154                                 $data = [ 'email' => 'Email', 'realname' => '' ],
 155                                 [ 'email' => 'Email' ],
 156                                 $hidden,
 157                                 true
 158                         ],
 159                         'realname omitted, hidden, email enabled' => [
 160                                 [],
 161                                 [ 'email' => 'Email' ],
 162                                 [ 'email' => 'Email' ],
 163                                 $hidden,
 164                                 true
 165                         ],
 166                         'email + realname, unhidden, email disabled' => [
 167                                 [],
 168                                 [ 'email' => 'Email', 'realname' => 'Name' ],
 169                                 [ 'realname' => 'Name' ],
 170                                 $unhidden,
 171                                 false
 172                         ],
 173                         'email omitted, unhidden, email disabled' => [
 174                                 [],
 175                                 [ 'realname' => 'Name' ],
 176                                 [ 'realname' => 'Name' ],
 177                                 $unhidden,
 178                                 false
 179                         ],
 180                         'email empty, unhidden, email disabled' => [
 181                                 [],
 182                                 [ 'email' => '', 'realname' => 'Name' ],
 183                                 [ 'realname' => 'Name' ],
 184                                 $unhidden,
 185                                 false
 186                         ],
 187                 ];
 188         }
 189 }