48a323f702
Bug: T192167 Depends-On: I581e54278ac5da3f4e399e33f2c7ad468bae6b43 Change-Id: I3a21fb55db76bac51afdd399cf40ed0760e4f343
93 lines
2.7 KiB
PHP
93 lines
2.7 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Tests\Maintenance;
|
|
|
|
use Maintenance;
|
|
use MediaWikiTestCase;
|
|
use Wikimedia\TestingAccessWrapper;
|
|
|
|
abstract class MaintenanceBaseTestCase extends MediaWikiTestCase {
|
|
|
|
/**
|
|
* The main Maintenance instance that is used for testing, wrapped and mockable.
|
|
*
|
|
* @var Maintenance
|
|
*/
|
|
protected $maintenance;
|
|
|
|
protected function setUp() : void {
|
|
parent::setUp();
|
|
|
|
$this->maintenance = $this->createMaintenance();
|
|
}
|
|
|
|
/**
|
|
* Do a little stream cleanup to prevent output in case the child class
|
|
* hasn't tested the capture buffer.
|
|
*/
|
|
protected function tearDown() : void {
|
|
if ( $this->maintenance ) {
|
|
$this->maintenance->cleanupChanneled();
|
|
}
|
|
|
|
// This is smelly, but maintenance scripts usually produce output, so
|
|
// we anticipate and ignore with a regex that will catch everything.
|
|
//
|
|
// If you call $this->expectOutputRegex in your subclass, this guard
|
|
// won't be triggered, and your specific pattern will be respected.
|
|
if ( !$this->hasExpectationOnOutput() ) {
|
|
$this->expectOutputRegex( '/.*/' );
|
|
}
|
|
|
|
parent::tearDown();
|
|
}
|
|
|
|
/**
|
|
* @return string Class name
|
|
*
|
|
* Subclasses must implement this in order to use the $this->maintenance
|
|
* variable. Normally, it will be set like:
|
|
* return PopulateDatabaseMaintenance::class;
|
|
*
|
|
* If you need to change the way your maintenance class is constructed,
|
|
* override createMaintenance.
|
|
*/
|
|
abstract protected function getMaintenanceClass();
|
|
|
|
/**
|
|
* Called by setUp to initialize $this->maintenance.
|
|
*
|
|
* @return object The Maintenance instance to test.
|
|
*/
|
|
protected function createMaintenance() {
|
|
$className = $this->getMaintenanceClass();
|
|
$obj = new $className();
|
|
|
|
// We use TestingAccessWrapper in order to access protected internals
|
|
// such as `output()`.
|
|
return TestingAccessWrapper::newFromObject( $obj );
|
|
}
|
|
|
|
/**
|
|
* Asserts the output before and after simulating shutdown
|
|
*
|
|
* This function simulates shutdown of self::maintenance.
|
|
*
|
|
* @param string $preShutdownOutput Expected output before simulating shutdown
|
|
* @param bool $expectNLAppending Whether or not shutdown simulation is expected
|
|
* to add a newline to the output. If false, $preShutdownOutput is the
|
|
* expected output after shutdown simulation. Otherwise,
|
|
* $preShutdownOutput with an appended newline is the expected output
|
|
* after shutdown simulation.
|
|
*/
|
|
protected function assertOutputPrePostShutdown( $preShutdownOutput, $expectNLAppending ) {
|
|
$this->assertEquals( $preShutdownOutput, $this->getActualOutput(),
|
|
"Output before shutdown simulation" );
|
|
|
|
$this->maintenance->cleanupChanneled();
|
|
|
|
$postShutdownOutput = $preShutdownOutput . ( $expectNLAppending ? "\n" : "" );
|
|
$this->expectOutputString( $postShutdownOutput );
|
|
}
|
|
|
|
}
|