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\LoadBalancer
;
29 use Wikimedia\Rdbms\ChronologyProtector
;
30 use Wikimedia\Rdbms\DatabaseMysqli
;
31 use Wikimedia\Rdbms\MySQLMasterPos
;
32 use Wikimedia\Rdbms\DatabaseDomain
;
36 * @covers \Wikimedia\Rdbms\LBFactorySimple
37 * @covers \Wikimedia\Rdbms\LBFactoryMulti
39 class LBFactoryTest
extends MediaWikiTestCase
{
42 * @covers MWLBFactory::getLBFactoryClass
43 * @dataProvider getLBFactoryClassProvider
45 public function testGetLBFactoryClass( $expected, $deprecated ) {
46 $mockDB = $this->getMockBuilder( DatabaseMysqli
::class )
47 ->disableOriginalConstructor()
51 'class' => $deprecated,
52 'connection' => $mockDB,
53 # Various other parameters required:
56 'serverTemplate' => [],
59 $this->hideDeprecated( '$wgLBFactoryConf must be updated. See RELEASE-NOTES for details' );
60 $result = MWLBFactory
::getLBFactoryClass( $config );
62 $this->assertEquals( $expected, $result );
65 public function getLBFactoryClassProvider() {
67 # Format: new class, old class
68 [ Wikimedia\Rdbms\LBFactorySimple
::class, 'LBFactory_Simple' ],
69 [ Wikimedia\Rdbms\LBFactorySingle
::class, 'LBFactory_Single' ],
70 [ Wikimedia\Rdbms\LBFactoryMulti
::class, 'LBFactory_Multi' ],
71 [ Wikimedia\Rdbms\LBFactorySimple
::class, 'LBFactorySimple' ],
72 [ Wikimedia\Rdbms\LBFactorySingle
::class, 'LBFactorySingle' ],
73 [ Wikimedia\Rdbms\LBFactoryMulti
::class, 'LBFactoryMulti' ],
77 public function testLBFactorySimpleServer() {
78 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
82 'host' => $wgDBserver,
83 'dbname' => $wgDBname,
85 'password' => $wgDBpassword,
87 'dbDirectory' => $wgSQLiteDataDir,
89 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
93 $factory = new LBFactorySimple( [ 'servers' => $servers ] );
94 $lb = $factory->getMainLB();
96 $dbw = $lb->getConnection( DB_MASTER
);
97 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
99 $dbr = $lb->getConnection( DB_REPLICA
);
100 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
102 $factory->shutdown();
106 public function testLBFactorySimpleServers() {
107 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
111 'host' => $wgDBserver,
112 'dbname' => $wgDBname,
114 'password' => $wgDBpassword,
116 'dbDirectory' => $wgSQLiteDataDir,
118 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
121 'host' => $wgDBserver,
122 'dbname' => $wgDBname,
124 'password' => $wgDBpassword,
126 'dbDirectory' => $wgSQLiteDataDir,
128 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
132 $factory = new LBFactorySimple( [
133 'servers' => $servers,
134 'loadMonitorClass' => LoadMonitorNull
::class
136 $lb = $factory->getMainLB();
138 $dbw = $lb->getConnection( DB_MASTER
);
139 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
141 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
142 $dbw->getLBInfo( 'clusterMasterHost' ),
143 'cluster master set' );
145 $dbr = $lb->getConnection( DB_REPLICA
);
146 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
148 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
149 $dbr->getLBInfo( 'clusterMasterHost' ),
150 'cluster master set' );
152 $factory->shutdown();
156 public function testLBFactoryMulti() {
157 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
159 $factory = new LBFactoryMulti( [
160 'sectionsByDB' => [],
167 'serverTemplate' => [
168 'dbname' => $wgDBname,
170 'password' => $wgDBpassword,
172 'dbDirectory' => $wgSQLiteDataDir,
173 'flags' => DBO_DEFAULT
176 'test-db1' => $wgDBserver,
177 'test-db2' => $wgDBserver
179 'loadMonitorClass' => LoadMonitorNull
::class
181 $lb = $factory->getMainLB();
183 $dbw = $lb->getConnection( DB_MASTER
);
184 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
186 $dbr = $lb->getConnection( DB_REPLICA
);
187 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
189 $factory->shutdown();
194 * @covers \Wikimedia\Rdbms\ChronologyProtector
196 public function testChronologyProtector() {
197 // (a) First HTTP request
198 $m1Pos = new MySQLMasterPos( 'db1034-bin.000976', '843431247' );
199 $m2Pos = new MySQLMasterPos( 'db1064-bin.002400', '794074907' );
201 $now = microtime( true );
204 $mockDB1 = $this->getMockBuilder( DatabaseMysqli
::class )
205 ->disableOriginalConstructor()
207 $mockDB1->method( 'writesOrCallbacksPending' )->willReturn( true );
208 $mockDB1->method( 'lastDoneWrites' )->willReturn( $now );
209 $mockDB1->method( 'getMasterPos' )->willReturn( $m1Pos );
210 // Load balancer for master DB 1
211 $lb1 = $this->getMockBuilder( LoadBalancer
::class )
212 ->disableOriginalConstructor()
214 $lb1->method( 'getConnection' )->willReturn( $mockDB1 );
215 $lb1->method( 'getServerCount' )->willReturn( 2 );
216 $lb1->method( 'getAnyOpenConnection' )->willReturn( $mockDB1 );
217 $lb1->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
218 function () use ( $mockDB1 ) {
220 $p |
= call_user_func( [ $mockDB1, 'writesOrCallbacksPending' ] );
221 $p |
= call_user_func( [ $mockDB1, 'lastDoneWrites' ] );
226 $lb1->method( 'getMasterPos' )->willReturn( $m1Pos );
227 $lb1->method( 'getServerName' )->with( 0 )->willReturn( 'master1' );
229 $mockDB2 = $this->getMockBuilder( DatabaseMysqli
::class )
230 ->disableOriginalConstructor()
232 $mockDB2->method( 'writesOrCallbacksPending' )->willReturn( true );
233 $mockDB2->method( 'lastDoneWrites' )->willReturn( $now );
234 $mockDB2->method( 'getMasterPos' )->willReturn( $m2Pos );
235 // Load balancer for master DB 2
236 $lb2 = $this->getMockBuilder( LoadBalancer
::class )
237 ->disableOriginalConstructor()
239 $lb2->method( 'getConnection' )->willReturn( $mockDB2 );
240 $lb2->method( 'getServerCount' )->willReturn( 2 );
241 $lb2->method( 'getAnyOpenConnection' )->willReturn( $mockDB2 );
242 $lb2->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
243 function () use ( $mockDB2 ) {
245 $p |
= call_user_func( [ $mockDB2, 'writesOrCallbacksPending' ] );
246 $p |
= call_user_func( [ $mockDB2, 'lastDoneWrites' ] );
251 $lb2->method( 'getMasterPos' )->willReturn( $m2Pos );
252 $lb2->method( 'getServerName' )->with( 0 )->willReturn( 'master2' );
254 $bag = new HashBagOStuff();
255 $cp = new ChronologyProtector(
259 'agent' => "Totally-Not-FireFox"
263 $mockDB1->expects( $this->exactly( 1 ) )->method( 'writesOrCallbacksPending' );
264 $mockDB1->expects( $this->exactly( 1 ) )->method( 'lastDoneWrites' );
265 $mockDB2->expects( $this->exactly( 1 ) )->method( 'writesOrCallbacksPending' );
266 $mockDB2->expects( $this->exactly( 1 ) )->method( 'lastDoneWrites' );
268 // Nothing to wait for on first HTTP request start
271 // Record positions in stash on first HTTP request end
272 $cp->shutdownLB( $lb1 );
273 $cp->shutdownLB( $lb2 );
275 $cp->shutdown( null, 'sync', $cpIndex );
277 $this->assertEquals( 1, $cpIndex, "CP write index set" );
279 // (b) Second HTTP request
281 // Load balancer for master DB 1
282 $lb1 = $this->getMockBuilder( LoadBalancer
::class )
283 ->disableOriginalConstructor()
285 $lb1->method( 'getServerCount' )->willReturn( 2 );
286 $lb1->method( 'getServerName' )->with( 0 )->willReturn( 'master1' );
287 $lb1->expects( $this->once() )
288 ->method( 'waitFor' )->with( $this->equalTo( $m1Pos ) );
289 // Load balancer for master DB 2
290 $lb2 = $this->getMockBuilder( LoadBalancer
::class )
291 ->disableOriginalConstructor()
293 $lb2->method( 'getServerCount' )->willReturn( 2 );
294 $lb2->method( 'getServerName' )->with( 0 )->willReturn( 'master2' );
295 $lb2->expects( $this->once() )
296 ->method( 'waitFor' )->with( $this->equalTo( $m2Pos ) );
298 $cp = new ChronologyProtector(
302 'agent' => "Totally-Not-FireFox"
307 // Wait for last positions to be reached on second HTTP request start
310 // Shutdown (nothing to record)
311 $cp->shutdownLB( $lb1 );
312 $cp->shutdownLB( $lb2 );
314 $cp->shutdown( null, 'sync', $cpIndex );
316 $this->assertEquals( null, $cpIndex, "CP write index retained" );
319 private function newLBFactoryMulti( array $baseOverride = [], array $serverOverride = [] ) {
320 global $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, $wgDBprefix, $wgDBtype;
321 global $wgSQLiteDataDir;
323 return new LBFactoryMulti( $baseOverride +
[
324 'sectionsByDB' => [],
330 'serverTemplate' => $serverOverride +
[
331 'dbname' => $wgDBname,
332 'tablePrefix' => $wgDBprefix,
334 'password' => $wgDBpassword,
336 'dbDirectory' => $wgSQLiteDataDir,
337 'flags' => DBO_DEFAULT
340 'test-db1' => $wgDBserver,
342 'loadMonitorClass' => LoadMonitorNull
::class,
343 'localDomain' => new DatabaseDomain( $wgDBname, null, $wgDBprefix )
347 public function testNiceDomains() {
348 global $wgDBname, $wgDBtype;
350 if ( $wgDBtype === 'sqlite' ) {
351 $tmpDir = $this->getNewTempDirectory();
352 $dbPath = "$tmpDir/unit_test_db.sqlite";
353 file_put_contents( $dbPath, '' );
354 $tempFsFile = new TempFSFile( $dbPath );
355 $tempFsFile->autocollect();
360 $factory = $this->newLBFactoryMulti(
362 [ 'dbFilePath' => $dbPath ]
364 $lb = $factory->getMainLB();
366 if ( $wgDBtype !== 'sqlite' ) {
367 $db = $lb->getConnectionRef( DB_MASTER
);
375 /** @var Database $db */
376 $db = $lb->getConnection( DB_MASTER
, [], '' );
381 'Null domain ID handle used'
386 'Null domain ID handle used'
391 'Main domain ID handle used; prefix is empty though'
394 $this->quoteTable( $db, 'page' ),
395 $db->tableName( 'page' ),
396 "Correct full table name"
399 $this->quoteTable( $db, $wgDBname ) . '.' . $this->quoteTable( $db, 'page' ),
400 $db->tableName( "$wgDBname.page" ),
401 "Correct full table name"
404 $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
405 $db->tableName( 'nice_db.page' ),
406 "Correct full table name"
409 $lb->reuseConnection( $db ); // don't care
411 $db = $lb->getConnection( DB_MASTER
); // local domain connection
412 $factory->setDomainPrefix( 'my_' );
419 $this->quoteTable( $db, 'my_page' ),
420 $db->tableName( 'page' ),
421 "Correct full table name"
424 $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
425 $db->tableName( 'other_nice_db.page' ),
426 "Correct full table name"
429 $factory->closeAll();
433 public function testTrickyDomain() {
434 global $wgDBtype, $wgDBname;
436 if ( $wgDBtype === 'sqlite' ) {
437 $tmpDir = $this->getNewTempDirectory();
438 $dbPath = "$tmpDir/unit_test_db.sqlite";
439 file_put_contents( $dbPath, '' );
440 $tempFsFile = new TempFSFile( $dbPath );
441 $tempFsFile->autocollect();
446 $dbname = 'unittest-domain'; // explodes if DB is selected
447 $factory = $this->newLBFactoryMulti(
448 [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
450 'dbFilePath' => $dbPath,
451 'dbName' => 'do_not_select_me' // explodes if DB is selected
454 $lb = $factory->getMainLB();
455 /** @var Database $db */
456 $db = $lb->getConnection( DB_MASTER
, [], '' );
458 $this->assertEquals( '', $db->getDomainID(), "Null domain used" );
461 $this->quoteTable( $db, 'page' ),
462 $db->tableName( 'page' ),
463 "Correct full table name"
467 $this->quoteTable( $db, $dbname ) . '.' . $this->quoteTable( $db, 'page' ),
468 $db->tableName( "$dbname.page" ),
469 "Correct full table name"
473 $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
474 $db->tableName( 'nice_db.page' ),
475 "Correct full table name"
478 $lb->reuseConnection( $db ); // don't care
480 $factory->setDomainPrefix( 'my_' );
481 $db = $lb->getConnection( DB_MASTER
, [], "$wgDBname-my_" );
484 $this->quoteTable( $db, 'my_page' ),
485 $db->tableName( 'page' ),
486 "Correct full table name"
489 $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
490 $db->tableName( 'other_nice_db.page' ),
491 "Correct full table name"
494 $this->quoteTable( $db, 'garbage-db' ) . '.' . $this->quoteTable( $db, 'page' ),
495 $db->tableName( 'garbage-db.page' ),
496 "Correct full table name"
499 if ( $db->databasesAreIndependent() ) {
502 $db->selectDB( 'garbage-db' );
503 } catch ( \Wikimedia\Rdbms\DBConnectionError
$e ) {
506 $this->assertInstanceOf( \Wikimedia\Rdbms\DBConnectionError
::class, $e );
507 $this->assertFalse( $db->isOpen() );
509 \Wikimedia\
suppressWarnings();
510 $this->assertFalse( $db->selectDB( 'garbage-db' ) );
511 \Wikimedia\restoreWarnings
();
514 $lb->reuseConnection( $db ); // don't care
516 $factory->closeAll();
520 private function quoteTable( Database
$db, $table ) {
521 if ( $db->getType() === 'sqlite' ) {
524 return $db->addIdentifierQuotes( $table );