7299aed7a5
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
122 lines
3.4 KiB
PHP
122 lines
3.4 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Auth;
|
|
|
|
use ReflectionMethod;
|
|
use const E_USER_DEPRECATED;
|
|
|
|
/**
|
|
* @group AuthManager
|
|
*/
|
|
abstract class AuthenticationRequestTestCase extends \MediaWikiIntegrationTestCase {
|
|
|
|
/**
|
|
* @param array $args
|
|
*
|
|
* @return AuthenticationRequest
|
|
*/
|
|
abstract protected function getInstance( array $args = [] );
|
|
|
|
/**
|
|
* @dataProvider provideGetFieldInfo
|
|
*/
|
|
public function testGetFieldInfo( array $args ) {
|
|
$info = $this->getInstance( $args )->getFieldInfo();
|
|
$this->assertIsArray( $info );
|
|
|
|
foreach ( $info as $field => $data ) {
|
|
$this->assertIsArray( $data, "Field $field" );
|
|
$this->assertArrayHasKey( 'type', $data, "Field $field" );
|
|
$this->assertArrayHasKey( 'label', $data, "Field $field" );
|
|
$this->assertInstanceOf( \Message::class, $data['label'], "Field $field, label" );
|
|
|
|
if ( $data['type'] !== 'null' ) {
|
|
$this->assertArrayHasKey( 'help', $data, "Field $field" );
|
|
$this->assertInstanceOf( \Message::class, $data['help'], "Field $field, help" );
|
|
}
|
|
|
|
if ( isset( $data['optional'] ) ) {
|
|
$this->assertIsBool( $data['optional'], "Field $field, optional" );
|
|
}
|
|
if ( isset( $data['image'] ) ) {
|
|
$this->assertIsString( $data['image'], "Field $field, image" );
|
|
}
|
|
if ( isset( $data['sensitive'] ) ) {
|
|
$this->assertIsBool( $data['sensitive'], "Field $field, sensitive" );
|
|
}
|
|
if ( $data['type'] === 'password' ) {
|
|
$this->assertTrue( !empty( $data['sensitive'] ),
|
|
"Field $field, password field must be sensitive" );
|
|
}
|
|
|
|
switch ( $data['type'] ) {
|
|
case 'string':
|
|
case 'password':
|
|
case 'hidden':
|
|
break;
|
|
case 'select':
|
|
case 'multiselect':
|
|
$this->assertArrayHasKey( 'options', $data, "Field $field" );
|
|
$this->assertIsArray( $data['options'], "Field $field, options" );
|
|
foreach ( $data['options'] as $val => $msg ) {
|
|
$this->assertInstanceOf( \Message::class, $msg, "Field $field, option $val" );
|
|
}
|
|
break;
|
|
case 'checkbox':
|
|
break;
|
|
case 'button':
|
|
break;
|
|
case 'null':
|
|
break;
|
|
default:
|
|
$this->fail( "Field $field, unknown type " . $data['type'] );
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
public static function provideGetFieldInfo() {
|
|
return [
|
|
[ [] ]
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideLoadFromSubmissionStatically
|
|
* @param array $args
|
|
* @param array $data
|
|
* @param array|bool $expectState
|
|
*/
|
|
public function testLoadFromSubmission( array $args, array $data, $expectState ) {
|
|
$instance = $this->getInstance( $args );
|
|
$ret = $instance->loadFromSubmission( $data );
|
|
if ( is_array( $expectState ) ) {
|
|
$this->assertTrue( $ret );
|
|
$expect = $instance::__set_state( $expectState );
|
|
$this->assertEquals( $expect, $instance );
|
|
} else {
|
|
$this->assertFalse( $ret );
|
|
}
|
|
}
|
|
|
|
// abstract public static function provideLoadFromSubmission();
|
|
|
|
/**
|
|
* Tempory override to make provideLoadFromSubmission static.
|
|
* See T332865.
|
|
*/
|
|
final public static function provideLoadFromSubmissionStatically() {
|
|
$reflectionMethod = new ReflectionMethod( static::class, 'provideLoadFromSubmission' );
|
|
if ( $reflectionMethod->isStatic() ) {
|
|
return $reflectionMethod->invoke( null );
|
|
}
|
|
|
|
trigger_error(
|
|
'overriding provideLoadFromSubmission as an instance method is deprecated. (' .
|
|
$reflectionMethod->getFileName() . ':' . $reflectionMethod->getEndLine() . ')',
|
|
E_USER_DEPRECATED
|
|
);
|
|
|
|
return $reflectionMethod->invoke( new static() );
|
|
}
|
|
}
|