wiki.techinc.nl/tests/phpunit/includes/auth/UserDataAuthenticationRequestTest.php
mainframe98 7299aed7a5 tests: Allow overridable data providers to be static
This uses some reflection to identify if the data provider is static or
not. If it isn't, a deprecation notice is emitted. This doesn't fail the
tests, but is still printed in the output.

To facilitate this, the relevant abstract method has been uncommented,
as PHP does not like it when function signatures do not match up.

This approach means that tests in extensions or skins do not immediately
break when making data providers static. Instead, they can do so at
their own pace.

Bug: T332865
Change-Id: I5ff35ad0e894f0a27beae00257dc1fc599ad518d
2023-05-16 16:28:43 +01:00

179 lines
4.1 KiB
PHP

<?php
namespace MediaWiki\Auth;
use MediaWiki\MainConfigNames;
/**
* @group AuthManager
* @covers \MediaWiki\Auth\UserDataAuthenticationRequest
*/
class UserDataAuthenticationRequestTest extends AuthenticationRequestTestCase {
protected function getInstance( array $args = [] ) {
return new UserDataAuthenticationRequest;
}
protected function setUp(): void {
parent::setUp();
$this->overrideConfigValue( MainConfigNames::HiddenPrefs, [] );
}
/**
* @dataProvider providePopulateUser
* @param string $email Email to set
* @param string $realname Realname to set
* @param \StatusValue $expect Expected return
*/
public function testPopulateUser( $email, $realname, $expect ) {
$user = new \User();
$user->setEmail( 'default@example.com' );
$user->setRealName( 'Fake Name' );
$req = new UserDataAuthenticationRequest;
$req->email = $email;
$req->realname = $realname;
$this->assertEquals( $expect, $req->populateUser( $user ) );
if ( $expect->isOK() ) {
$this->assertSame( $email ?: 'default@example.com', $user->getEmail() );
$this->assertSame( $realname ?: 'Fake Name', $user->getRealName() );
}
}
public static function providePopulateUser() {
$good = \StatusValue::newGood();
return [
[ 'email@example.com', 'Real Name', $good ],
[ 'email@example.com', '', $good ],
[ '', 'Real Name', $good ],
[ '', '', $good ],
[ 'invalid-email', 'Real Name', \StatusValue::newFatal( 'invalidemailaddress' ) ],
];
}
/**
* @dataProvider provideLoadFromSubmission
*/
public function testLoadFromSubmission(
array $args, array $data, $expectState, $hiddenPref = null, $enableEmail = null
) {
$this->overrideConfigValues( [
MainConfigNames::HiddenPrefs => $hiddenPref,
MainConfigNames::EnableEmail => $enableEmail,
] );
parent::testLoadFromSubmission( $args, $data, $expectState );
}
public static function provideLoadFromSubmission() {
$unhidden = [];
$hidden = [ 'realname' ];
return [
'Empty request, unhidden, email enabled' => [
[],
[],
false,
$unhidden,
true
],
'email + realname, unhidden, email enabled' => [
[],
$data = [ 'email' => 'Email', 'realname' => 'Name' ],
$data,
$unhidden,
true
],
'email empty, unhidden, email enabled' => [
[],
$data = [ 'email' => '', 'realname' => 'Name' ],
$data,
$unhidden,
true
],
'email omitted, unhidden, email enabled' => [
[],
[ 'realname' => 'Name' ],
false,
$unhidden,
true
],
'realname empty, unhidden, email enabled' => [
[],
$data = [ 'email' => 'Email', 'realname' => '' ],
$data,
$unhidden,
true
],
'realname omitted, unhidden, email enabled' => [
[],
[ 'email' => 'Email' ],
false,
$unhidden,
true
],
'Empty request, hidden, email enabled' => [
[],
[],
false,
$hidden,
true
],
'email + realname, hidden, email enabled' => [
[],
[ 'email' => 'Email', 'realname' => 'Name' ],
[ 'email' => 'Email' ],
$hidden,
true
],
'email empty, hidden, email enabled' => [
[],
$data = [ 'email' => '', 'realname' => 'Name' ],
[ 'email' => '' ],
$hidden,
true
],
'email omitted, hidden, email enabled' => [
[],
[ 'realname' => 'Name' ],
false,
$hidden,
true
],
'realname empty, hidden, email enabled' => [
[],
$data = [ 'email' => 'Email', 'realname' => '' ],
[ 'email' => 'Email' ],
$hidden,
true
],
'realname omitted, hidden, email enabled' => [
[],
[ 'email' => 'Email' ],
[ 'email' => 'Email' ],
$hidden,
true
],
'email + realname, unhidden, email disabled' => [
[],
[ 'email' => 'Email', 'realname' => 'Name' ],
[ 'realname' => 'Name' ],
$unhidden,
false
],
'email omitted, unhidden, email disabled' => [
[],
[ 'realname' => 'Name' ],
[ 'realname' => 'Name' ],
$unhidden,
false
],
'email empty, unhidden, email disabled' => [
[],
[ 'email' => '', 'realname' => 'Name' ],
[ 'realname' => 'Name' ],
$unhidden,
false
],
];
}
}