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
;
33 * @covers \Wikimedia\Rdbms\LBFactorySimple
34 * @covers \Wikimedia\Rdbms\LBFactoryMulti
36 class LBFactoryTest
extends MediaWikiTestCase
{
39 * @covers MWLBFactory::getLBFactoryClass
40 * @dataProvider getLBFactoryClassProvider
42 public function testGetLBFactoryClass( $expected, $deprecated ) {
43 $mockDB = $this->getMockBuilder( 'DatabaseMysqli' )
44 ->disableOriginalConstructor()
48 'class' => $deprecated,
49 'connection' => $mockDB,
50 # Various other parameters required:
53 'serverTemplate' => [],
56 $this->hideDeprecated( '$wgLBFactoryConf must be updated. See RELEASE-NOTES for details' );
57 $result = MWLBFactory
::getLBFactoryClass( $config );
59 $this->assertEquals( $expected, $result );
62 public function getLBFactoryClassProvider() {
64 # Format: new class, old class
65 [ Wikimedia\Rdbms\LBFactorySimple
::class, 'LBFactory_Simple' ],
66 [ Wikimedia\Rdbms\LBFactorySingle
::class, 'LBFactory_Single' ],
67 [ Wikimedia\Rdbms\LBFactoryMulti
::class, 'LBFactory_Multi' ],
68 [ Wikimedia\Rdbms\LBFactorySimple
::class, 'LBFactorySimple' ],
69 [ Wikimedia\Rdbms\LBFactorySingle
::class, 'LBFactorySingle' ],
70 [ Wikimedia\Rdbms\LBFactoryMulti
::class, 'LBFactoryMulti' ],
74 public function testLBFactorySimpleServer() {
75 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
79 'host' => $wgDBserver,
80 'dbname' => $wgDBname,
82 'password' => $wgDBpassword,
84 'dbDirectory' => $wgSQLiteDataDir,
86 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
90 $factory = new LBFactorySimple( [ 'servers' => $servers ] );
91 $lb = $factory->getMainLB();
93 $dbw = $lb->getConnection( DB_MASTER
);
94 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
96 $dbr = $lb->getConnection( DB_REPLICA
);
97 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
103 public function testLBFactorySimpleServers() {
104 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
108 'host' => $wgDBserver,
109 'dbname' => $wgDBname,
111 'password' => $wgDBpassword,
113 'dbDirectory' => $wgSQLiteDataDir,
115 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
118 'host' => $wgDBserver,
119 'dbname' => $wgDBname,
121 'password' => $wgDBpassword,
123 'dbDirectory' => $wgSQLiteDataDir,
125 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
129 $factory = new LBFactorySimple( [
130 'servers' => $servers,
131 'loadMonitorClass' => 'LoadMonitorNull'
133 $lb = $factory->getMainLB();
135 $dbw = $lb->getConnection( DB_MASTER
);
136 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
138 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
139 $dbw->getLBInfo( 'clusterMasterHost' ),
140 'cluster master set' );
142 $dbr = $lb->getConnection( DB_REPLICA
);
143 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
145 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
146 $dbr->getLBInfo( 'clusterMasterHost' ),
147 'cluster master set' );
149 $factory->shutdown();
153 public function testLBFactoryMulti() {
154 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
156 $factory = new LBFactoryMulti( [
157 'sectionsByDB' => [],
164 'serverTemplate' => [
165 'dbname' => $wgDBname,
167 'password' => $wgDBpassword,
169 'dbDirectory' => $wgSQLiteDataDir,
170 'flags' => DBO_DEFAULT
173 'test-db1' => $wgDBserver,
174 'test-db2' => $wgDBserver
176 'loadMonitorClass' => 'LoadMonitorNull'
178 $lb = $factory->getMainLB();
180 $dbw = $lb->getConnection( DB_MASTER
);
181 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
183 $dbr = $lb->getConnection( DB_REPLICA
);
184 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
186 $factory->shutdown();
191 * @covers \Wikimedia\Rdbms\ChronologyProtector
193 public function testChronologyProtector() {
194 // (a) First HTTP request
195 $mPos = new MySQLMasterPos( 'db1034-bin.000976', '843431247' );
197 $now = microtime( true );
198 $mockDB = $this->getMockBuilder( 'DatabaseMysqli' )
199 ->disableOriginalConstructor()
201 $mockDB->method( 'writesOrCallbacksPending' )->willReturn( true );
202 $mockDB->method( 'lastDoneWrites' )->willReturn( $now );
203 $mockDB->method( 'getMasterPos' )->willReturn( $mPos );
205 $lb = $this->getMockBuilder( 'LoadBalancer' )
206 ->disableOriginalConstructor()
208 $lb->method( 'getConnection' )->willReturn( $mockDB );
209 $lb->method( 'getServerCount' )->willReturn( 2 );
210 $lb->method( 'parentInfo' )->willReturn( [ 'id' => "main-DEFAULT" ] );
211 $lb->method( 'getAnyOpenConnection' )->willReturn( $mockDB );
212 $lb->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
213 function () use ( $mockDB ) {
215 $p |
= call_user_func( [ $mockDB, 'writesOrCallbacksPending' ] );
216 $p |
= call_user_func( [ $mockDB, 'lastDoneWrites' ] );
221 $lb->method( 'getMasterPos' )->willReturn( $mPos );
223 $bag = new HashBagOStuff();
224 $cp = new ChronologyProtector(
228 'agent' => "Totally-Not-FireFox"
232 $mockDB->expects( $this->exactly( 2 ) )->method( 'writesOrCallbacksPending' );
233 $mockDB->expects( $this->exactly( 2 ) )->method( 'lastDoneWrites' );
235 // Nothing to wait for
238 $cp->shutdownLB( $lb );
241 // (b) Second HTTP request
242 $cp = new ChronologyProtector(
246 'agent' => "Totally-Not-FireFox"
250 $lb->expects( $this->once() )
251 ->method( 'waitFor' )->with( $this->equalTo( $mPos ) );
256 $cp->shutdownLB( $lb );
260 private function newLBFactoryMulti( array $baseOverride = [], array $serverOverride = [] ) {
261 global $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, $wgDBtype, $wgSQLiteDataDir;
263 return new LBFactoryMulti( $baseOverride +
[
264 'sectionsByDB' => [],
270 'serverTemplate' => $serverOverride +
[
271 'dbname' => $wgDBname,
273 'password' => $wgDBpassword,
275 'dbDirectory' => $wgSQLiteDataDir,
276 'flags' => DBO_DEFAULT
279 'test-db1' => $wgDBserver,
281 'loadMonitorClass' => 'LoadMonitorNull',
282 'localDomain' => wfWikiID()
286 public function testNiceDomains() {
287 global $wgDBname, $wgDBtype;
289 if ( $wgDBtype === 'sqlite' ) {
290 $tmpDir = $this->getNewTempDirectory();
291 $dbPath = "$tmpDir/unit_test_db.sqlite";
292 file_put_contents( $dbPath, '' );
293 $tempFsFile = new TempFSFile( $dbPath );
294 $tempFsFile->autocollect();
299 $factory = $this->newLBFactoryMulti(
301 [ 'dbFilePath' => $dbPath ]
303 $lb = $factory->getMainLB();
305 if ( $wgDBtype !== 'sqlite' ) {
306 $db = $lb->getConnectionRef( DB_MASTER
);
314 /** @var Database $db */
315 $db = $lb->getConnection( DB_MASTER
, [], '' );
316 $lb->reuseConnection( $db ); // don't care
324 $this->quoteTable( $db, 'page' ),
325 $db->tableName( 'page' ),
326 "Correct full table name"
330 $this->quoteTable( $db, $wgDBname ) . '.' . $this->quoteTable( $db, 'page' ),
331 $db->tableName( "$wgDBname.page" ),
332 "Correct full table name"
336 $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
337 $db->tableName( 'nice_db.page' ),
338 "Correct full table name"
341 $factory->setDomainPrefix( 'my_' );
347 $this->quoteTable( $db, 'my_page' ),
348 $db->tableName( 'page' ),
349 "Correct full table name"
352 $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
353 $db->tableName( 'other_nice_db.page' ),
354 "Correct full table name"
357 $factory->closeAll();
361 public function testTrickyDomain() {
364 if ( $wgDBtype === 'sqlite' ) {
365 $tmpDir = $this->getNewTempDirectory();
366 $dbPath = "$tmpDir/unit_test_db.sqlite";
367 file_put_contents( $dbPath, '' );
368 $tempFsFile = new TempFSFile( $dbPath );
369 $tempFsFile->autocollect();
374 $dbname = 'unittest-domain';
375 $factory = $this->newLBFactoryMulti(
376 [ 'localDomain' => $dbname ],
377 [ 'dbname' => $dbname, 'dbFilePath' => $dbPath ]
379 $lb = $factory->getMainLB();
380 /** @var Database $db */
381 $db = $lb->getConnection( DB_MASTER
, [], '' );
382 $lb->reuseConnection( $db ); // don't care
390 $this->quoteTable( $db, 'page' ),
391 $db->tableName( 'page' ),
392 "Correct full table name"
396 $this->quoteTable( $db, $dbname ) . '.' . $this->quoteTable( $db, 'page' ),
397 $db->tableName( "$dbname.page" ),
398 "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 $factory->setDomainPrefix( 'my_' );
410 $this->quoteTable( $db, 'my_page' ),
411 $db->tableName( 'page' ),
412 "Correct full table name"
415 $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
416 $db->tableName( 'other_nice_db.page' ),
417 "Correct full table name"
421 $this->quoteTable( $db, 'garbage-db' ) . '.' . $this->quoteTable( $db, 'page' ),
422 $db->tableName( 'garbage-db.page' ),
423 "Correct full table name"
426 if ( $db->databasesAreIndependent() ) {
429 $db->selectDB( 'garbage-db' );
430 } catch ( \Wikimedia\Rdbms\DBConnectionError
$e ) {
433 $this->assertInstanceOf( '\Wikimedia\Rdbms\DBConnectionError', $e );
434 $this->assertFalse( $db->isOpen() );
436 \MediaWiki\
suppressWarnings();
437 $this->assertFalse( $db->selectDB( 'garbage-db' ) );
438 \MediaWiki\restoreWarnings
();
441 $factory->closeAll();
445 private function quoteTable( Database
$db, $table ) {
446 if ( $db->getType() === 'sqlite' ) {
449 return $db->addIdentifierQuotes( $table );