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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
<?php
use Wikimedia\FileBackend\FSFile\TempFSFile;
use Wikimedia\Rdbms\ConfiguredReadOnlyMode;
use Wikimedia\Rdbms\ILBFactory;
use Wikimedia\Rdbms\ILoadBalancer;
use Wikimedia\Rdbms\ReadOnlyMode;
/**
* @covers \Wikimedia\Rdbms\ReadOnlyMode
* @covers \Wikimedia\Rdbms\ConfiguredReadOnlyMode
*/
class ReadOnlyModeTest extends MediaWikiUnitTestCase {
/** @var string */
private $fileName;
protected function setUp(): void {
parent::setUp();
// Do not use wfTmpDir() as that depends on globals.
// Based on MediaWikiIntegrationTestCase::getNewTempFile()
$this->fileName = tempnam(
TempFSFile::getUsableTempDirectory(),
'MW_PHPUnit_ReadOnlyModeTest'
);
}
protected function tearDown(): void {
@unlink( $this->fileName );
parent::tearDown();
}
public static function provider() {
$rawTests = [
'None of anything' => [
'confMessage' => null,
'hasFileName' => false,
'fileContents' => false,
'lbMessage' => false,
'expectedState' => false,
'expectedMessage' => false,
'expectedConfState' => false,
'expectedConfMessage' => false
],
'File missing' => [
'confMessage' => null,
'hasFileName' => true,
'fileContents' => false,
'lbMessage' => false,
'expectedState' => false,
'expectedMessage' => false,
'expectedConfState' => false,
'expectedConfMessage' => false
],
'File empty' => [
'confMessage' => null,
'hasFileName' => true,
'fileContents' => '',
'lbMessage' => false,
'expectedState' => false,
'expectedMessage' => false,
'expectedConfState' => false,
'expectedConfMessage' => false
],
'File has message' => [
'confMessage' => null,
'hasFileName' => true,
'fileContents' => 'Message',
'lbMessage' => false,
'expectedState' => true,
'expectedMessage' => 'Message',
'expectedConfState' => true,
'expectedConfMessage' => 'Message',
],
'Conf has message' => [
'confMessage' => 'Message',
'hasFileName' => false,
'fileContents' => false,
'lbMessage' => false,
'expectedState' => true,
'expectedMessage' => 'Message',
'expectedConfState' => true,
'expectedConfMessage' => 'Message'
],
"Conf=false means don't check the file" => [
'confMessage' => false,
'hasFileName' => true,
'fileContents' => 'Message',
'lbMessage' => false,
'expectedState' => false,
'expectedMessage' => false,
'expectedConfState' => false,
'expectedConfMessage' => false,
],
'LB has message' => [
'confMessage' => null,
'hasFileName' => false,
'fileContents' => false,
'lbMessage' => 'Message',
'expectedState' => true,
'expectedMessage' => 'Message',
'expectedConfState' => false,
'expectedConfMessage' => false
],
'All three have a message: conf wins' => [
'confMessage' => 'conf',
'hasFileName' => true,
'fileContents' => 'file',
'lbMessage' => 'lb',
'expectedState' => true,
'expectedMessage' => 'conf',
'expectedConfState' => true,
'expectedConfMessage' => 'conf'
]
];
$cookedTests = [];
foreach ( $rawTests as $desc => $test ) {
$cookedTests[$desc] = [ $test ];
}
return $cookedTests;
}
private function createMode( $params, $makeLB ) {
$rom = new ConfiguredReadOnlyMode( $params['confMessage'], $this->createFile( $params ) );
if ( $makeLB ) {
$lb = $this->createLBF( $params );
$rom = new ReadOnlyMode( $rom, $lb );
}
return $rom;
}
private function createLBF( $params ) {
$lb = $this->createMock( ILoadBalancer::class );
$lb->method( 'getReadOnlyReason' )
->willReturn( $params['lbMessage'] );
$lbf = $this->createMock( ILBFactory::class );
$lbf->method( 'getLoadBalancer' )
->willReturn( $lb );
return $lbf;
}
private function createFile( $params ) {
if ( $params['hasFileName'] ) {
$fileName = $this->fileName;
if ( $params['fileContents'] === false ) {
unlink( $this->fileName );
} else {
file_put_contents( $this->fileName, $params['fileContents'] );
}
} else {
$fileName = null;
}
return $fileName;
}
/**
* @dataProvider provider
*/
public function testWithLB( $params ) {
$rom = $this->createMode( $params, true );
$this->assertSame( $params['expectedMessage'], $rom->getReason() );
$this->assertSame( $params['expectedState'], $rom->isReadOnly() );
}
/**
* @dataProvider provider
*/
public function testWithoutLB( $params ) {
$cro = $this->createMode( $params, false );
$this->assertSame( $params['expectedConfMessage'], $cro->getReason() );
$this->assertSame( $params['expectedConfState'], $cro->isReadOnly() );
}
public function testSetReadOnlyReason() {
$rom = $this->createMode(
[
'confMessage' => 'conf',
'hasFileName' => false,
'fileContents' => false,
'lbMessage' => 'lb'
],
true );
$rom->setReason( 'override' );
$this->assertSame( 'override', $rom->getReason() );
}
}
|
