1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
<?php
namespace MediaWiki\Tests\Maintenance;
use Maintenance;
use MediaWikiIntegrationTestCase;
use Wikimedia\TestingAccessWrapper;
abstract class MaintenanceBaseTestCase extends MediaWikiIntegrationTestCase {
/**
* 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 );
}
}
|
