wiki.techinc.nl/tests/phpunit/includes/htmlform/HTMLFormTest.php
Gergő Tisza e67c9b3090
HTMLForm: Add test for CSRF token check
Bug: T301467
Change-Id: I52edb26f53c79795e3d501f810974aa97665bb77
2022-02-13 19:29:15 -08:00

134 lines
4.4 KiB
PHP

<?php
/**
* @covers HTMLForm
*
* @license GPL-2.0-or-later
* @author Gergő Tisza
*/
class HTMLFormTest extends MediaWikiIntegrationTestCase {
private function newInstance() {
$context = new RequestContext();
$out = new OutputPage( $context );
$out->setTitle( Title::newMainPage() );
$context->setOutput( $out );
$form = new HTMLForm( [], $context );
$form->setTitle( Title::newFromText( 'Foo' ) );
return $form;
}
public function testGetHTML_empty() {
$form = $this->newInstance();
$form->prepareForm();
$html = $form->getHTML( false );
$this->assertStringStartsWith( '<form ', $html );
}
public function testGetHTML_noPrepare() {
$form = $this->newInstance();
$this->expectException( LogicException::class );
$form->getHTML( false );
}
public function testAutocompleteDefaultsToNull() {
$form = $this->newInstance();
$this->assertStringNotContainsString( 'autocomplete', $form->wrapForm( '' ) );
}
public function testAutocompleteWhenSetToNull() {
$form = $this->newInstance();
$form->setAutocomplete( null );
$this->assertStringNotContainsString( 'autocomplete', $form->wrapForm( '' ) );
}
public function testAutocompleteWhenSetToFalse() {
$form = $this->newInstance();
// Previously false was used instead of null to indicate the attribute should not be set
$form->setAutocomplete( false );
$this->assertStringNotContainsString( 'autocomplete', $form->wrapForm( '' ) );
}
public function testAutocompleteWhenSetToOff() {
$form = $this->newInstance();
$form->setAutocomplete( 'off' );
$this->assertStringContainsString( ' autocomplete="off"', $form->wrapForm( '' ) );
}
public function testGetPreText() {
$preText = 'TEST';
$form = $this->newInstance();
$form->setPreText( $preText );
$this->assertSame( $preText, $form->getPreText() );
}
public function testGetPreHtml() {
$preHtml = 'TEST';
$form = $this->newInstance();
$form->setPreHtml( $preHtml );
$this->assertSame( $preHtml, $form->getPreHtml() );
}
public function testGetErrorsOrWarningsWithRawParams() {
$form = $this->newInstance();
$msg = new RawMessage( 'message with $1' );
$msg->rawParams( '<a href="raw">params</a>' );
$status = Status::newFatal( $msg );
$result = $form->getErrorsOrWarnings( $status, 'error' );
$this->assertStringContainsString( 'message with <a href="raw">params</a>', $result );
}
/**
* @dataProvider provideCsrf
* @param string|null $formTokenSalt Salt to pass to HTMLForm::setTokenSalt()
* @param array $requestData HTTP request data
* @param array|null $tokens User's CSRF tokens in a salt => value format, or null for anon
* @param bool $shouldBeAuthorized
* @throws MWException
*/
public function testCsrf(
?string $formTokenSalt,
array $requestData,
?array $tokens,
bool $shouldBeAuthorized
) {
$user = $this->createNoOpMock( User::class, [ 'isRegistered', 'matchEditToken' ] );
$user->method( 'isRegistered' )->willReturn( $tokens !== null );
$user->method( 'matchEditToken' )->willReturnCallback(
static function ( $token, $salt ) use ( $tokens ) {
return $tokens && isset( $tokens[$salt] ) && $tokens[$salt] === $token;
} );
$context = $this->createConfiguredMock( RequestContext::class, [
'getConfig' => new HashConfig( [ 'HTMLFormAllowTableFormat' => true ] ),
'getRequest' => new FauxRequest( $requestData, true ),
'getUser' => $user,
] );
$form = new HTMLForm( [], $context );
if ( $formTokenSalt !== null ) {
$form->setTokenSalt( $formTokenSalt );
}
$form->setSubmitCallback( static function () {
return true;
} );
$this->assertSame( $shouldBeAuthorized, $form->tryAuthorizedSubmit() );
}
public function provideCsrf() {
return [
// form token salt, request data, tokens, should be authorized?
'Anon user, CSRF token ignored' => [ null, [], null, true ],
'No CSRF token sent' => [ null, [], [ '' => '123' ], false ],
'Wrong CSRF token sent' => [ null, [ 'wpEditToken' => 'xyz' ], [ '' => '123' ], false ],
// this isn't possible but helps catch errors in the test itself
'User has no CSRF token' => [ null, [ 'wpEditToken' => 'xyz' ], [], false ],
'Correct CSRF token' => [ null, [ 'wpEditToken' => '123' ], [ '' => '123' ], true ],
'Wrong CSRF token type' => [ 'delete', [ 'wpEditToken' => '123' ], [ '' => '123' ], false ],
'Correct non-default CSRF token' => [ 'delete', [ 'wpEditToken' => 'xyz' ],
[ '' => 123, 'delete' => 'xyz' ], true ],
];
}
}