3 * Holds tests for LBFactory abstract MediaWiki class.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @author Antoine Musso
22 * @copyright © 2013 Antoine Musso
23 * @copyright © 2013 Wikimedia Foundation Inc.
26 use Wikimedia\Rdbms\LBFactorySimple
;
27 use Wikimedia\Rdbms\LBFactoryMulti
;
28 use Wikimedia\Rdbms\ChronologyProtector
;
29 use Wikimedia\Rdbms\MySQLMasterPos
;
30 use Wikimedia\Rdbms\DatabaseDomain
;
34 * @covers \Wikimedia\Rdbms\LBFactorySimple
35 * @covers \Wikimedia\Rdbms\LBFactoryMulti
37 class LBFactoryTest
extends MediaWikiTestCase
{
40 * @covers MWLBFactory::getLBFactoryClass
41 * @dataProvider getLBFactoryClassProvider
43 public function testGetLBFactoryClass( $expected, $deprecated ) {
44 $mockDB = $this->getMockBuilder( 'DatabaseMysqli' )
45 ->disableOriginalConstructor()
49 'class' => $deprecated,
50 'connection' => $mockDB,
51 # Various other parameters required:
54 'serverTemplate' => [],
57 $this->hideDeprecated( '$wgLBFactoryConf must be updated. See RELEASE-NOTES for details' );
58 $result = MWLBFactory
::getLBFactoryClass( $config );
60 $this->assertEquals( $expected, $result );
63 public function getLBFactoryClassProvider() {
65 # Format: new class, old class
66 [ Wikimedia\Rdbms\LBFactorySimple
::class, 'LBFactory_Simple' ],
67 [ Wikimedia\Rdbms\LBFactorySingle
::class, 'LBFactory_Single' ],
68 [ Wikimedia\Rdbms\LBFactoryMulti
::class, 'LBFactory_Multi' ],
69 [ Wikimedia\Rdbms\LBFactorySimple
::class, 'LBFactorySimple' ],
70 [ Wikimedia\Rdbms\LBFactorySingle
::class, 'LBFactorySingle' ],
71 [ Wikimedia\Rdbms\LBFactoryMulti
::class, 'LBFactoryMulti' ],
75 public function testLBFactorySimpleServer() {
76 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
80 'host' => $wgDBserver,
81 'dbname' => $wgDBname,
83 'password' => $wgDBpassword,
85 'dbDirectory' => $wgSQLiteDataDir,
87 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
91 $factory = new LBFactorySimple( [ 'servers' => $servers ] );
92 $lb = $factory->getMainLB();
94 $dbw = $lb->getConnection( DB_MASTER
);
95 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
97 $dbr = $lb->getConnection( DB_REPLICA
);
98 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
100 $factory->shutdown();
104 public function testLBFactorySimpleServers() {
105 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
109 'host' => $wgDBserver,
110 'dbname' => $wgDBname,
112 'password' => $wgDBpassword,
114 'dbDirectory' => $wgSQLiteDataDir,
116 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
119 'host' => $wgDBserver,
120 'dbname' => $wgDBname,
122 'password' => $wgDBpassword,
124 'dbDirectory' => $wgSQLiteDataDir,
126 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
130 $factory = new LBFactorySimple( [
131 'servers' => $servers,
132 'loadMonitorClass' => 'LoadMonitorNull'
134 $lb = $factory->getMainLB();
136 $dbw = $lb->getConnection( DB_MASTER
);
137 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
139 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
140 $dbw->getLBInfo( 'clusterMasterHost' ),
141 'cluster master set' );
143 $dbr = $lb->getConnection( DB_REPLICA
);
144 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
146 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
147 $dbr->getLBInfo( 'clusterMasterHost' ),
148 'cluster master set' );
150 $factory->shutdown();
154 public function testLBFactoryMulti() {
155 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
157 $factory = new LBFactoryMulti( [
158 'sectionsByDB' => [],
165 'serverTemplate' => [
166 'dbname' => $wgDBname,
168 'password' => $wgDBpassword,
170 'dbDirectory' => $wgSQLiteDataDir,
171 'flags' => DBO_DEFAULT
174 'test-db1' => $wgDBserver,
175 'test-db2' => $wgDBserver
177 'loadMonitorClass' => 'LoadMonitorNull'
179 $lb = $factory->getMainLB();
181 $dbw = $lb->getConnection( DB_MASTER
);
182 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
184 $dbr = $lb->getConnection( DB_REPLICA
);
185 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
187 $factory->shutdown();
192 * @covers \Wikimedia\Rdbms\ChronologyProtector
194 public function testChronologyProtector() {
195 // (a) First HTTP request
196 $m1Pos = new MySQLMasterPos( 'db1034-bin.000976', '843431247' );
197 $m2Pos = new MySQLMasterPos( 'db1064-bin.002400', '794074907' );
199 $now = microtime( true );
202 $mockDB1 = $this->getMockBuilder( 'DatabaseMysqli' )
203 ->disableOriginalConstructor()
205 $mockDB1->method( 'writesOrCallbacksPending' )->willReturn( true );
206 $mockDB1->method( 'lastDoneWrites' )->willReturn( $now );
207 $mockDB1->method( 'getMasterPos' )->willReturn( $m1Pos );
208 // Load balancer for master DB 1
209 $lb1 = $this->getMockBuilder( 'LoadBalancer' )
210 ->disableOriginalConstructor()
212 $lb1->method( 'getConnection' )->willReturn( $mockDB1 );
213 $lb1->method( 'getServerCount' )->willReturn( 2 );
214 $lb1->method( 'getAnyOpenConnection' )->willReturn( $mockDB1 );
215 $lb1->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
216 function () use ( $mockDB1 ) {
218 $p |
= call_user_func( [ $mockDB1, 'writesOrCallbacksPending' ] );
219 $p |
= call_user_func( [ $mockDB1, 'lastDoneWrites' ] );
224 $lb1->method( 'getMasterPos' )->willReturn( $m1Pos );
225 $lb1->method( 'getServerName' )->with( 0 )->willReturn( 'master1' );
227 $mockDB2 = $this->getMockBuilder( 'DatabaseMysqli' )
228 ->disableOriginalConstructor()
230 $mockDB2->method( 'writesOrCallbacksPending' )->willReturn( true );
231 $mockDB2->method( 'lastDoneWrites' )->willReturn( $now );
232 $mockDB2->method( 'getMasterPos' )->willReturn( $m2Pos );
233 // Load balancer for master DB 2
234 $lb2 = $this->getMockBuilder( 'LoadBalancer' )
235 ->disableOriginalConstructor()
237 $lb2->method( 'getConnection' )->willReturn( $mockDB2 );
238 $lb2->method( 'getServerCount' )->willReturn( 2 );
239 $lb2->method( 'getAnyOpenConnection' )->willReturn( $mockDB2 );
240 $lb2->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
241 function () use ( $mockDB2 ) {
243 $p |
= call_user_func( [ $mockDB2, 'writesOrCallbacksPending' ] );
244 $p |
= call_user_func( [ $mockDB2, 'lastDoneWrites' ] );
249 $lb2->method( 'getMasterPos' )->willReturn( $m2Pos );
250 $lb2->method( 'getServerName' )->with( 0 )->willReturn( 'master2' );
252 $bag = new HashBagOStuff();
253 $cp = new ChronologyProtector(
257 'agent' => "Totally-Not-FireFox"
261 $mockDB1->expects( $this->exactly( 1 ) )->method( 'writesOrCallbacksPending' );
262 $mockDB1->expects( $this->exactly( 1 ) )->method( 'lastDoneWrites' );
263 $mockDB2->expects( $this->exactly( 1 ) )->method( 'writesOrCallbacksPending' );
264 $mockDB2->expects( $this->exactly( 1 ) )->method( 'lastDoneWrites' );
266 // Nothing to wait for on first HTTP request start
269 // Record positions in stash on first HTTP request end
270 $cp->shutdownLB( $lb1 );
271 $cp->shutdownLB( $lb2 );
273 $cp->shutdown( null, 'sync', $cpIndex );
275 $this->assertEquals( 1, $cpIndex, "CP write index set" );
277 // (b) Second HTTP request
279 // Load balancer for master DB 1
280 $lb1 = $this->getMockBuilder( 'LoadBalancer' )
281 ->disableOriginalConstructor()
283 $lb1->method( 'getServerCount' )->willReturn( 2 );
284 $lb1->method( 'getServerName' )->with( 0 )->willReturn( 'master1' );
285 $lb1->expects( $this->once() )
286 ->method( 'waitFor' )->with( $this->equalTo( $m1Pos ) );
287 // Load balancer for master DB 2
288 $lb2 = $this->getMockBuilder( 'LoadBalancer' )
289 ->disableOriginalConstructor()
291 $lb2->method( 'getServerCount' )->willReturn( 2 );
292 $lb2->method( 'getServerName' )->with( 0 )->willReturn( 'master2' );
293 $lb2->expects( $this->once() )
294 ->method( 'waitFor' )->with( $this->equalTo( $m2Pos ) );
296 $cp = new ChronologyProtector(
300 'agent' => "Totally-Not-FireFox"
305 // Wait for last positions to be reached on second HTTP request start
308 // Shutdown (nothing to record)
309 $cp->shutdownLB( $lb1 );
310 $cp->shutdownLB( $lb2 );
312 $cp->shutdown( null, 'sync', $cpIndex );
314 $this->assertEquals( null, $cpIndex, "CP write index retained" );
317 private function newLBFactoryMulti( array $baseOverride = [], array $serverOverride = [] ) {
318 global $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, $wgDBprefix, $wgDBtype;
319 global $wgSQLiteDataDir;
321 return new LBFactoryMulti( $baseOverride +
[
322 'sectionsByDB' => [],
328 'serverTemplate' => $serverOverride +
[
329 'dbname' => $wgDBname,
330 'tablePrefix' => $wgDBprefix,
332 'password' => $wgDBpassword,
334 'dbDirectory' => $wgSQLiteDataDir,
335 'flags' => DBO_DEFAULT
338 'test-db1' => $wgDBserver,
340 'loadMonitorClass' => 'LoadMonitorNull',
341 'localDomain' => new DatabaseDomain( $wgDBname, null, $wgDBprefix )
345 public function testNiceDomains() {
346 global $wgDBname, $wgDBtype;
348 if ( $wgDBtype === 'sqlite' ) {
349 $tmpDir = $this->getNewTempDirectory();
350 $dbPath = "$tmpDir/unit_test_db.sqlite";
351 file_put_contents( $dbPath, '' );
352 $tempFsFile = new TempFSFile( $dbPath );
353 $tempFsFile->autocollect();
358 $factory = $this->newLBFactoryMulti(
360 [ 'dbFilePath' => $dbPath ]
362 $lb = $factory->getMainLB();
364 if ( $wgDBtype !== 'sqlite' ) {
365 $db = $lb->getConnectionRef( DB_MASTER
);
373 /** @var Database $db */
374 $db = $lb->getConnection( DB_MASTER
, [], '' );
379 'Main domain ID handle used; same DB name'
384 'Main domain ID handle used; same DB name'
389 'Main domain ID handle used; prefix is empty though'
392 $this->quoteTable( $db, 'page' ),
393 $db->tableName( 'page' ),
394 "Correct full table name"
397 $this->quoteTable( $db, $wgDBname ) . '.' . $this->quoteTable( $db, 'page' ),
398 $db->tableName( "$wgDBname.page" ),
399 "Correct full table name"
402 $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
403 $db->tableName( 'nice_db.page' ),
404 "Correct full table name"
407 $lb->reuseConnection( $db ); // don't care
409 $db = $lb->getConnection( DB_MASTER
); // local domain connection
410 $factory->setDomainPrefix( 'my_' );
417 $this->quoteTable( $db, 'my_page' ),
418 $db->tableName( 'page' ),
419 "Correct full table name"
422 $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
423 $db->tableName( 'other_nice_db.page' ),
424 "Correct full table name"
427 $factory->closeAll();
431 public function testTrickyDomain() {
432 global $wgDBtype, $wgDBname;
434 if ( $wgDBtype === 'sqlite' ) {
435 $tmpDir = $this->getNewTempDirectory();
436 $dbPath = "$tmpDir/unit_test_db.sqlite";
437 file_put_contents( $dbPath, '' );
438 $tempFsFile = new TempFSFile( $dbPath );
439 $tempFsFile->autocollect();
444 $dbname = 'unittest-domain'; // explodes if DB is selected
445 $factory = $this->newLBFactoryMulti(
446 [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
447 [ 'dbFilePath' => $dbPath ]
449 $lb = $factory->getMainLB();
450 /** @var Database $db */
451 $db = $lb->getConnection( DB_MASTER
, [], '' );
459 $this->quoteTable( $db, 'page' ),
460 $db->tableName( 'page' ),
461 "Correct full table name"
465 $this->quoteTable( $db, $dbname ) . '.' . $this->quoteTable( $db, 'page' ),
466 $db->tableName( "$dbname.page" ),
467 "Correct full table name"
471 $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
472 $db->tableName( 'nice_db.page' ),
473 "Correct full table name"
476 $lb->reuseConnection( $db ); // don't care
478 $factory->setDomainPrefix( 'my_' );
479 $db = $lb->getConnection( DB_MASTER
, [], "$wgDBname-my_" );
482 $this->quoteTable( $db, 'my_page' ),
483 $db->tableName( 'page' ),
484 "Correct full table name"
487 $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
488 $db->tableName( 'other_nice_db.page' ),
489 "Correct full table name"
492 $this->quoteTable( $db, 'garbage-db' ) . '.' . $this->quoteTable( $db, 'page' ),
493 $db->tableName( 'garbage-db.page' ),
494 "Correct full table name"
497 if ( $db->databasesAreIndependent() ) {
500 $db->selectDB( 'garbage-db' );
501 } catch ( \Wikimedia\Rdbms\DBConnectionError
$e ) {
504 $this->assertInstanceOf( '\Wikimedia\Rdbms\DBConnectionError', $e );
505 $this->assertFalse( $db->isOpen() );
507 \MediaWiki\
suppressWarnings();
508 $this->assertFalse( $db->selectDB( 'garbage-db' ) );
509 \MediaWiki\restoreWarnings
();
512 $lb->reuseConnection( $db ); // don't care
514 $factory->closeAll();
518 private function quoteTable( Database
$db, $table ) {
519 if ( $db->getType() === 'sqlite' ) {
522 return $db->addIdentifierQuotes( $table );