a805898fa1
Why: * Maintenance scripts in core have low test coverage * Improving this will reduce the chances of regressions and bugs What: * Create CreateBotPasswordTest which fully tests createBotPassword.php maintenance script. * While doing this, address a PHP warning that appears when the user does not specify the 'grants' option. Bug: T371167 Change-Id: I8256c278b8397de896906e5714d478883b518ba0
112 lines
3.6 KiB
PHP
112 lines
3.6 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Tests\Maintenance;
|
|
|
|
use CreateBotPassword;
|
|
use MediaWiki\MainConfigNames;
|
|
use MediaWiki\User\BotPassword;
|
|
|
|
/**
|
|
* @covers \CreateBotPassword
|
|
* @group Database
|
|
* @author Dreamy Jazz
|
|
*/
|
|
class CreateBotPasswordTest extends MaintenanceBaseTestCase {
|
|
|
|
protected function getMaintenanceClass() {
|
|
return CreateBotPassword::class;
|
|
}
|
|
|
|
public function testExecuteForShowGrants() {
|
|
$this->overrideConfigValue( MainConfigNames::GrantPermissions, [
|
|
'import' => [
|
|
'import' => true,
|
|
'importupload' => true,
|
|
],
|
|
] );
|
|
$this->maintenance->setOption( 'showgrants', 1 );
|
|
$this->maintenance->execute();
|
|
$this->expectOutputString(
|
|
str_pad( 'GRANT', 20 ) . " DESCRIPTION\n" .
|
|
str_pad( 'import', 20 ) . " Import pages from other wikis\n"
|
|
);
|
|
}
|
|
|
|
/** @dataProvider provideExecuteForFatalError */
|
|
public function testExecuteForFatalError( $args, $options, $expectedOutputRegex ) {
|
|
foreach ( $args as $name => $value ) {
|
|
$this->maintenance->setArg( $name, $value );
|
|
}
|
|
foreach ( $options as $name => $value ) {
|
|
$this->maintenance->setOption( $name, $value );
|
|
}
|
|
$this->expectCallToFatalError();
|
|
$this->expectOutputRegex( $expectedOutputRegex );
|
|
$this->maintenance->execute();
|
|
}
|
|
|
|
public static function provideExecuteForFatalError() {
|
|
return [
|
|
'Invalid grants provided' => [
|
|
[ 'user' => 'Test' ],
|
|
[ 'grants' => 'invalidgrant1234', 'appid' => 'abcdef' ],
|
|
'/These grants are invalid: invalidgrant1234/',
|
|
],
|
|
'Non-existing user provided' => [
|
|
[ 'user' => 'Test' ],
|
|
[ 'grants' => 'import', 'appid' => 'abcdef' ],
|
|
'/Cannot create bot password for non-existent user/',
|
|
],
|
|
'No arguments or options provided' => [
|
|
[], [], "/Argument <user> required!\nParam appid required!\nParam grants required!/",
|
|
],
|
|
];
|
|
}
|
|
|
|
public function testExecuteWhenBotPasswordToShort() {
|
|
$this->testExecuteForFatalError(
|
|
[ 'user' => $this->getTestUser()->getUserIdentity()->getName(), 'password' => 'abc' ],
|
|
[ 'grants' => 'import', 'appid' => 'abc' ],
|
|
'/Bot passwords must have at least ' . BotPassword::PASSWORD_MINLENGTH .
|
|
' characters. Given password is 3 characters/'
|
|
);
|
|
}
|
|
|
|
public function testExecuteWhenAppIdTooLong() {
|
|
$this->testExecuteForFatalError(
|
|
[ 'user' => $this->getTestUser()->getUserIdentity()->getName() ],
|
|
[ 'grants' => 'import', 'appid' => str_repeat( 'abc', 100 ) ],
|
|
'/Bot password creation failed/'
|
|
);
|
|
}
|
|
|
|
public function testExecuteWhenAppIdAlreadyExists() {
|
|
$this->overrideConfigValue( MainConfigNames::CentralIdLookupProvider, 'local' );
|
|
$username = $this->getMutableTestUser()->getUserIdentity()->getName();
|
|
// Get an existing bot password
|
|
$bp = BotPassword::newUnsaved( [
|
|
'username' => $username,
|
|
'appId' => 'abc',
|
|
'grants' => [ 'import', 'editpage' ]
|
|
] );
|
|
$bp->save( 'insert' );
|
|
// Call the maintenance script with the same appId used to create the bot password above.
|
|
$this->testExecuteForFatalError(
|
|
[ 'user' => $username ],
|
|
[ 'grants' => 'import', 'appid' => 'abc' ],
|
|
'/Bot password creation failed. Does this appid already exist for the user perhaps?/'
|
|
);
|
|
}
|
|
|
|
public function testExecuteForSuccess() {
|
|
$this->overrideConfigValue( MainConfigNames::CentralIdLookupProvider, 'local' );
|
|
$username = $this->getMutableTestUser()->getUserIdentity()->getName();
|
|
// Set the valid arguments and options
|
|
$this->maintenance->setArg( 'user', $username );
|
|
$this->maintenance->setOption( 'grants', 'import,editpage' );
|
|
$this->maintenance->setOption( 'appid', 'abcdef' );
|
|
// Run the maintenance script
|
|
$this->maintenance->execute();
|
|
$this->expectOutputRegex( "/Success[\s\S]*Log in using username.*$username@abcdef/" );
|
|
}
|
|
}
|