%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
namespace MediaWiki\Tests\Maintenance;
use Maintenance;
use MediaWiki\MediaWikiServices;
use Wikimedia\TestingAccessWrapper;
/**
* @covers Maintenance
*/
class MaintenanceTest extends MaintenanceBaseTestCase {
/**
* @see MaintenanceBaseTestCase::getMaintenanceClass
*/
protected function getMaintenanceClass() {
return Maintenance::class;
}
/**
* @see MaintenanceBaseTestCase::createMaintenance
*
* Note to extension authors looking for a model to follow: This function
* is normally not needed in a maintenance test, it's only overridden here
* because Maintenance is abstract.
*/
protected function createMaintenance() {
$className = $this->getMaintenanceClass();
$obj = $this->getMockForAbstractClass( $className );
return TestingAccessWrapper::newFromObject( $obj );
}
// Although the following tests do not seem to be too consistent (compare for
// example the newlines within the test.*StringString tests, or the
// test.*Intermittent.* tests), the objective of these tests is not to describe
// consistent behavior, but rather currently existing behavior.
/**
* @dataProvider provideOutputData
*/
function testOutput( $outputs, $expected, $extraNL ) {
foreach ( $outputs as $data ) {
if ( is_array( $data ) ) {
list( $msg, $channel ) = $data;
} else {
$msg = $data;
$channel = null;
}
$this->maintenance->output( $msg, $channel );
}
$this->assertOutputPrePostShutdown( $expected, $extraNL );
}
public function provideOutputData() {
return [
[ [ "" ], "", false ],
[ [ "foo" ], "foo", false ],
[ [ "foo", "bar" ], "foobar", false ],
[ [ "foo\n" ], "foo\n", false ],
[ [ "foo\n\n" ], "foo\n\n", false ],
[ [ "foo\nbar" ], "foo\nbar", false ],
[ [ "foo\nbar\n" ], "foo\nbar\n", false ],
[ [ "foo\n", "bar\n" ], "foo\nbar\n", false ],
[ [ "", "foo", "", "\n", "ba", "", "r\n" ], "foo\nbar\n", false ],
[ [ "", "foo", "", "\nb", "a", "", "r\n" ], "foo\nbar\n", false ],
[ [ [ "foo", "bazChannel" ] ], "foo", true ],
[ [ [ "foo\n", "bazChannel" ] ], "foo", true ],
// If this test fails, note that output takes strings with double line
// endings (although output's implementation in this situation calls
// outputChanneled with a string ending in a nl ... which is not allowed
// according to the documentation of outputChanneled)
[ [ [ "foo\n\n", "bazChannel" ] ], "foo\n", true ],
[ [ [ "foo\nbar", "bazChannel" ] ], "foo\nbar", true ],
[ [ [ "foo\nbar\n", "bazChannel" ] ], "foo\nbar", true ],
[
[
[ "foo\n", "bazChannel" ],
[ "bar\n", "bazChannel" ],
],
"foobar",
true
],
[
[
[ "", "bazChannel" ],
[ "foo", "bazChannel" ],
[ "", "bazChannel" ],
[ "\n", "bazChannel" ],
[ "ba", "bazChannel" ],
[ "", "bazChannel" ],
[ "r\n", "bazChannel" ],
],
"foobar",
true
],
[
[
[ "", "bazChannel" ],
[ "foo", "bazChannel" ],
[ "", "bazChannel" ],
[ "\nb", "bazChannel" ],
[ "a", "bazChannel" ],
[ "", "bazChannel" ],
[ "r\n", "bazChannel" ],
],
"foo\nbar",
true
],
[
[
[ "foo", "bazChannel" ],
[ "bar", "bazChannel" ],
[ "qux", "quuxChannel" ],
[ "corge", "bazChannel" ],
],
"foobar\nqux\ncorge",
true
],
[
[
[ "foo", "bazChannel" ],
[ "bar\n", "bazChannel" ],
[ "qux\n", "quuxChannel" ],
[ "corge", "bazChannel" ],
],
"foobar\nqux\ncorge",
true
],
[
[
[ "foo", null ],
[ "bar", "bazChannel" ],
[ "qux", null ],
[ "quux", "bazChannel" ],
],
"foobar\nquxquux",
true
],
[
[
[ "foo", "bazChannel" ],
[ "bar", null ],
[ "qux", "bazChannel" ],
[ "quux", null ],
],
"foo\nbarqux\nquux",
false
],
[
[
[ "foo", 1 ],
[ "bar", 1.0 ],
],
"foo\nbar",
true
],
[ [ "foo", "", "bar" ], "foobar", false ],
[ [ "foo", false, "bar" ], "foobar", false ],
[
[
[ "qux", "quuxChannel" ],
"foo",
false,
"bar"
],
"qux\nfoobar",
false
],
[
[
[ "foo", "bazChannel" ],
[ "", "bazChannel" ],
[ "bar", "bazChannel" ],
],
"foobar",
true
],
[
[
[ "foo", "bazChannel" ],
[ false, "bazChannel" ],
[ "bar", "bazChannel" ],
],
"foobar",
true
],
];
}
/**
* @dataProvider provideOutputChanneledData
*/
function testOutputChanneled( $outputs, $expected, $extraNL ) {
foreach ( $outputs as $data ) {
if ( is_array( $data ) ) {
list( $msg, $channel ) = $data;
} else {
$msg = $data;
$channel = null;
}
$this->maintenance->outputChanneled( $msg, $channel );
}
$this->assertOutputPrePostShutdown( $expected, $extraNL );
}
public function provideOutputChanneledData() {
return [
[ [ "" ], "\n", false ],
[ [ "foo" ], "foo\n", false ],
[ [ "foo", "bar" ], "foo\nbar\n", false ],
[ [ "foo\nbar" ], "foo\nbar\n", false ],
[ [ "", "foo", "", "\nb", "a", "", "r" ], "\nfoo\n\n\nb\na\n\nr\n", false ],
[ [ [ "foo", "bazChannel" ] ], "foo", true ],
[
[
[ "foo\nbar", "bazChannel" ]
],
"foo\nbar",
true
],
[
[
[ "foo", "bazChannel" ],
[ "bar", "bazChannel" ],
],
"foobar",
true
],
[
[
[ "", "bazChannel" ],
[ "foo", "bazChannel" ],
[ "", "bazChannel" ],
[ "\nb", "bazChannel" ],
[ "a", "bazChannel" ],
[ "", "bazChannel" ],
[ "r", "bazChannel" ],
],
"foo\nbar",
true
],
[
[
[ "foo", "bazChannel" ],
[ "bar", "bazChannel" ],
[ "qux", "quuxChannel" ],
[ "corge", "bazChannel" ],
],
"foobar\nqux\ncorge",
true
],
[
[
[ "foo", "bazChannel" ],
[ "bar", "bazChannel" ],
[ "qux", "quuxChannel" ],
[ "corge", "bazChannel" ],
],
"foobar\nqux\ncorge",
true
],
[
[
[ "foo", "bazChannel" ],
[ "bar", null ],
[ "qux", null ],
[ "corge", "bazChannel" ],
],
"foo\nbar\nqux\ncorge",
true
],
[
[
[ "foo", null ],
[ "bar", "bazChannel" ],
[ "qux", null ],
[ "quux", "bazChannel" ],
],
"foo\nbar\nqux\nquux",
true
],
[
[
[ "foo", "bazChannel" ],
[ "bar", null ],
[ "qux", "bazChannel" ],
[ "quux", null ],
],
"foo\nbar\nqux\nquux\n",
false
],
[
[
[ "foo", 1 ],
[ "bar", 1.0 ],
],
"foo\nbar",
true
],
[ [ "foo", "", "bar" ], "foo\n\nbar\n", false ],
[ [ "foo", false, "bar" ], "foo\nbar\n", false ],
];
}
function testCleanupChanneledClean() {
$this->maintenance->cleanupChanneled();
$this->assertOutputPrePostShutdown( "", false );
}
function testCleanupChanneledAfterOutput() {
$this->maintenance->output( "foo" );
$this->maintenance->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foo", false );
}
function testCleanupChanneledAfterOutputWNullChannel() {
$this->maintenance->output( "foo", null );
$this->maintenance->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foo", false );
}
function testCleanupChanneledAfterOutputWChannel() {
$this->maintenance->output( "foo", "bazChannel" );
$this->maintenance->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foo\n", false );
}
function testCleanupChanneledAfterNLOutput() {
$this->maintenance->output( "foo\n" );
$this->maintenance->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foo\n", false );
}
function testCleanupChanneledAfterNLOutputWNullChannel() {
$this->maintenance->output( "foo\n", null );
$this->maintenance->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foo\n", false );
}
function testCleanupChanneledAfterNLOutputWChannel() {
$this->maintenance->output( "foo\n", "bazChannel" );
$this->maintenance->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foo\n", false );
}
function testCleanupChanneledAfterOutputChanneledWOChannel() {
$this->maintenance->outputChanneled( "foo" );
$this->maintenance->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foo\n", false );
}
function testCleanupChanneledAfterOutputChanneledWNullChannel() {
$this->maintenance->outputChanneled( "foo", null );
$this->maintenance->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foo\n", false );
}
function testCleanupChanneledAfterOutputChanneledWChannel() {
$this->maintenance->outputChanneled( "foo", "bazChannel" );
$this->maintenance->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foo\n", false );
}
function testMultipleMaintenanceObjectsInteractionOutput() {
$m2 = $this->createMaintenance();
$this->maintenance->output( "foo" );
$m2->output( "bar" );
$this->assertEquals( "foobar", $this->getActualOutput(),
"Output before shutdown simulation (m2)" );
$m2->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foobar", false );
}
function testMultipleMaintenanceObjectsInteractionOutputWNullChannel() {
$m2 = $this->createMaintenance();
$this->maintenance->output( "foo", null );
$m2->output( "bar", null );
$this->assertEquals( "foobar", $this->getActualOutput(),
"Output before shutdown simulation (m2)" );
$m2->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foobar", false );
}
function testMultipleMaintenanceObjectsInteractionOutputWChannel() {
$m2 = $this->createMaintenance();
$this->maintenance->output( "foo", "bazChannel" );
$m2->output( "bar", "bazChannel" );
$this->assertEquals( "foobar", $this->getActualOutput(),
"Output before shutdown simulation (m2)" );
$m2->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foobar\n", true );
}
function testMultipleMaintenanceObjectsInteractionOutputWNullChannelNL() {
$m2 = $this->createMaintenance();
$this->maintenance->output( "foo\n", null );
$m2->output( "bar\n", null );
$this->assertEquals( "foo\nbar\n", $this->getActualOutput(),
"Output before shutdown simulation (m2)" );
$m2->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foo\nbar\n", false );
}
function testMultipleMaintenanceObjectsInteractionOutputWChannelNL() {
$m2 = $this->createMaintenance();
$this->maintenance->output( "foo\n", "bazChannel" );
$m2->output( "bar\n", "bazChannel" );
$this->assertEquals( "foobar", $this->getActualOutput(),
"Output before shutdown simulation (m2)" );
$m2->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foobar\n", true );
}
function testMultipleMaintenanceObjectsInteractionOutputChanneled() {
$m2 = $this->createMaintenance();
$this->maintenance->outputChanneled( "foo" );
$m2->outputChanneled( "bar" );
$this->assertEquals( "foo\nbar\n", $this->getActualOutput(),
"Output before shutdown simulation (m2)" );
$m2->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foo\nbar\n", false );
}
function testMultipleMaintenanceObjectsInteractionOutputChanneledWNullChannel() {
$m2 = $this->createMaintenance();
$this->maintenance->outputChanneled( "foo", null );
$m2->outputChanneled( "bar", null );
$this->assertEquals( "foo\nbar\n", $this->getActualOutput(),
"Output before shutdown simulation (m2)" );
$m2->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foo\nbar\n", false );
}
function testMultipleMaintenanceObjectsInteractionOutputChanneledWChannel() {
$m2 = $this->createMaintenance();
$this->maintenance->outputChanneled( "foo", "bazChannel" );
$m2->outputChanneled( "bar", "bazChannel" );
$this->assertEquals( "foobar", $this->getActualOutput(),
"Output before shutdown simulation (m2)" );
$m2->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foobar\n", true );
}
function testMultipleMaintenanceObjectsInteractionCleanupChanneledWChannel() {
$m2 = $this->createMaintenance();
$this->maintenance->outputChanneled( "foo", "bazChannel" );
$m2->outputChanneled( "bar", "bazChannel" );
$this->assertEquals( "foobar", $this->getActualOutput(),
"Output before first cleanup" );
$this->maintenance->cleanupChanneled();
$this->assertEquals( "foobar\n", $this->getActualOutput(),
"Output after first cleanup" );
$m2->cleanupChanneled();
$this->assertEquals( "foobar\n\n", $this->getActualOutput(),
"Output after second cleanup" );
$m2->cleanupChanneled();
$this->assertOutputPrePostShutdown( "foobar\n\n", false );
}
/**
* @covers Maintenance::getConfig
*/
public function testGetConfig() {
$this->assertInstanceOf( 'Config', $this->maintenance->getConfig() );
$this->assertSame(
MediaWikiServices::getInstance()->getMainConfig(),
$this->maintenance->getConfig()
);
}
/**
* @covers Maintenance::setConfig
*/
public function testSetConfig() {
$conf = $this->createMock( 'Config' );
$this->maintenance->setConfig( $conf );
$this->assertSame( $conf, $this->maintenance->getConfig() );
}
function testParseArgs() {
$m2 = $this->createMaintenance();
// Create an option with an argument allowed to be specified multiple times
$m2->addOption( 'multi', 'This option does stuff', false, true, false, true );
$m2->loadWithArgv( [ '--multi', 'this1', '--multi', 'this2' ] );
$this->assertEquals( [ 'this1', 'this2' ], $m2->getOption( 'multi' ) );
$this->assertEquals( [ [ 'multi', 'this1' ], [ 'multi', 'this2' ] ],
$m2->orderedOptions );
$m2->cleanupChanneled();
$m2 = $this->createMaintenance();
$m2->addOption( 'multi', 'This option does stuff', false, false, false, true );
$m2->loadWithArgv( [ '--multi', '--multi' ] );
$this->assertEquals( [ 1, 1 ], $m2->getOption( 'multi' ) );
$this->assertEquals( [ [ 'multi', 1 ], [ 'multi', 1 ] ], $m2->orderedOptions );
$m2->cleanupChanneled();
$m2 = $this->createMaintenance();
// Create an option with an argument allowed to be specified multiple times
$m2->addOption( 'multi', 'This option doesn\'t actually support multiple occurrences' );
$m2->loadWithArgv( [ '--multi=yo' ] );
$this->assertEquals( 'yo', $m2->getOption( 'multi' ) );
$this->assertEquals( [ [ 'multi', 'yo' ] ], $m2->orderedOptions );
$m2->cleanupChanneled();
}
}
Zerion Mini Shell 1.0