4 * Holds tests for LoadBalancer MediaWiki class.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
24 use Wikimedia\Rdbms\DBError
;
25 use Wikimedia\Rdbms\DatabaseDomain
;
26 use Wikimedia\Rdbms\Database
;
27 use Wikimedia\Rdbms\LoadBalancer
;
28 use Wikimedia\Rdbms\LoadMonitorNull
;
32 * @covers \Wikimedia\Rdbms\LoadBalancer
34 class LoadBalancerTest
extends MediaWikiTestCase
{
35 private function makeServerConfig( $flags = DBO_DEFAULT
) {
36 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
39 'host' => $wgDBserver,
40 'dbname' => $wgDBname,
41 'tablePrefix' => $this->dbPrefix(),
43 'password' => $wgDBpassword,
45 'dbDirectory' => $wgSQLiteDataDir,
52 * @covers LoadBalancer::getLocalDomainID()
53 * @covers LoadBalancer::resolveDomainID()
55 public function testWithoutReplica() {
59 $lb = new LoadBalancer( [
60 // Simulate web request with DBO_TRX
61 'servers' => [ $this->makeServerConfig( DBO_TRX
) ],
62 'queryLogger' => MediaWiki\Logger\LoggerFactory
::getInstance( 'DBQuery' ),
63 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() ),
64 'chronologyCallback' => function () use ( &$called ) {
69 $ld = DatabaseDomain
::newFromId( $lb->getLocalDomainID() );
70 $this->assertEquals( $wgDBname, $ld->getDatabase(), 'local domain DB set' );
71 $this->assertEquals( $this->dbPrefix(), $ld->getTablePrefix(), 'local domain prefix set' );
72 $this->assertSame( 'my_test_wiki', $lb->resolveDomainID( 'my_test_wiki' ) );
73 $this->assertSame( $ld->getId(), $lb->resolveDomainID( false ) );
74 $this->assertSame( $ld->getId(), $lb->resolveDomainID( $ld ) );
75 $this->assertFalse( $called );
77 $dbw = $lb->getConnection( DB_MASTER
);
78 $this->assertTrue( $called );
79 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
80 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
81 $this->assertWriteAllowed( $dbw );
83 $dbr = $lb->getConnection( DB_REPLICA
);
84 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
85 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
87 if ( !$lb->getServerAttributes( $lb->getWriterIndex() )[$dbw::ATTR_DB_LEVEL_LOCKING
] ) {
88 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
90 $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
91 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
92 $this->assertNotEquals(
93 $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
95 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
97 $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
98 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
99 $this->assertNotEquals(
100 $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
102 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
103 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
109 public function testWithReplica() {
112 // Simulate web request with DBO_TRX
113 $lb = $this->newMultiServerLocalLoadBalancer( DBO_TRX
);
115 $dbw = $lb->getConnection( DB_MASTER
);
116 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
118 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
119 $dbw->getLBInfo( 'clusterMasterHost' ),
120 'cluster master set' );
121 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
122 $this->assertWriteAllowed( $dbw );
124 $dbr = $lb->getConnection( DB_REPLICA
);
125 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
127 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
128 $dbr->getLBInfo( 'clusterMasterHost' ),
129 'cluster master set' );
130 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
131 $this->assertWriteForbidden( $dbr );
133 if ( !$lb->getServerAttributes( $lb->getWriterIndex() )[$dbw::ATTR_DB_LEVEL_LOCKING
] ) {
134 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
136 $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
137 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
138 $this->assertNotEquals(
139 $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
141 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
143 $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
144 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
145 $this->assertNotEquals(
146 $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
148 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
149 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
155 private function newSingleServerLocalLoadBalancer() {
158 return new LoadBalancer( [
159 'servers' => [ $this->makeServerConfig() ],
160 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
164 private function newMultiServerLocalLoadBalancer( $flags = DBO_DEFAULT
) {
165 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
169 'host' => $wgDBserver,
170 'dbname' => $wgDBname,
171 'tablePrefix' => $this->dbPrefix(),
173 'password' => $wgDBpassword,
175 'dbDirectory' => $wgSQLiteDataDir,
179 [ // emulated replica
180 'host' => $wgDBserver,
181 'dbname' => $wgDBname,
182 'tablePrefix' => $this->dbPrefix(),
184 'password' => $wgDBpassword,
186 'dbDirectory' => $wgSQLiteDataDir,
192 return new LoadBalancer( [
193 'servers' => $servers,
194 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() ),
195 'queryLogger' => MediaWiki\Logger\LoggerFactory
::getInstance( 'DBQuery' ),
196 'loadMonitorClass' => LoadMonitorNull
::class
200 private function assertWriteForbidden( Database
$db ) {
202 $db->delete( 'some_table', [ 'id' => 57634126 ], __METHOD__
);
203 $this->fail( 'Write operation should have failed!' );
204 } catch ( DBError
$ex ) {
205 // check that the exception message contains "Write operation"
206 $constraint = new PHPUnit_Framework_Constraint_StringContains( 'Write operation' );
208 if ( !$constraint->evaluate( $ex->getMessage(), '', true ) ) {
209 // re-throw original error, to preserve stack trace
215 private function assertWriteAllowed( Database
$db ) {
216 $table = $db->tableName( 'some_table' );
217 // Trigger a transaction so that rollback() will remove all the tables.
218 // Don't do this for MySQL/Oracle as they auto-commit transactions for DDL
219 // statements such as CREATE TABLE.
220 $useAtomicSection = in_array( $db->getType(), [ 'sqlite', 'postgres', 'mssql' ], true );
222 $db->dropTable( 'some_table' ); // clear for sanity
223 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
225 if ( $useAtomicSection ) {
226 $db->startAtomic( __METHOD__
);
228 // Use only basic SQL and trivial types for these queries for compatibility
229 $this->assertNotSame(
231 $db->query( "CREATE TABLE $table (id INT, time INT)", __METHOD__
),
234 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
235 $this->assertNotSame(
237 $db->query( "DELETE FROM $table WHERE id=57634126", __METHOD__
),
240 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
242 if ( !$useAtomicSection ) {
243 // Drop the table to clean up, ignoring any error.
244 $db->dropTable( 'some_table' );
246 // Rollback the atomic section for sqlite's benefit.
247 $db->rollback( __METHOD__
, 'flush' );
248 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
252 public function testServerAttributes() {
255 'dbname' => 'my_unittest_wiki',
256 'tablePrefix' => 'unittest_',
258 'dbDirectory' => "some_directory",
263 $lb = new LoadBalancer( [
264 'servers' => $servers,
265 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
266 'loadMonitorClass' => LoadMonitorNull
::class
269 $this->assertTrue( $lb->getServerAttributes( 0 )[Database
::ATTR_DB_LEVEL_LOCKING
] );
274 'user' => 'wikiuser',
275 'password' => 'none',
276 'dbname' => 'my_unittest_wiki',
277 'tablePrefix' => 'unittest_',
281 [ // emulated replica
283 'user' => 'wikiuser',
284 'password' => 'none',
285 'dbname' => 'my_unittest_wiki',
286 'tablePrefix' => 'unittest_',
292 $lb = new LoadBalancer( [
293 'servers' => $servers,
294 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
295 'loadMonitorClass' => LoadMonitorNull
::class
298 $this->assertFalse( $lb->getServerAttributes( 1 )[Database
::ATTR_DB_LEVEL_LOCKING
] );
302 * @covers LoadBalancer::openConnection()
303 * @covers LoadBalancer::getAnyOpenConnection()
305 function testOpenConnection() {
308 $lb = new LoadBalancer( [
309 'servers' => [ $this->makeServerConfig() ],
310 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
313 $i = $lb->getWriterIndex();
314 $this->assertEquals( null, $lb->getAnyOpenConnection( $i ) );
316 $conn1 = $lb->getConnection( $i );
317 $this->assertNotEquals( null, $conn1 );
318 $this->assertEquals( $conn1, $lb->getAnyOpenConnection( $i ) );
319 $this->assertFalse( $conn1->getFlag( DBO_TRX
) );
321 $conn2 = $lb->getConnection( $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
322 $this->assertNotEquals( null, $conn2 );
323 $this->assertFalse( $conn2->getFlag( DBO_TRX
) );
325 if ( $lb->getServerAttributes( $i )[Database
::ATTR_DB_LEVEL_LOCKING
] ) {
326 $this->assertEquals( null,
327 $lb->getAnyOpenConnection( $i, $lb::CONN_TRX_AUTOCOMMIT
) );
328 $this->assertEquals( $conn1,
330 $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
), $lb::CONN_TRX_AUTOCOMMIT
);
332 $this->assertEquals( $conn2,
333 $lb->getAnyOpenConnection( $i, $lb::CONN_TRX_AUTOCOMMIT
) );
334 $this->assertEquals( $conn2,
335 $lb->getConnection( $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
) );
337 $conn2->startAtomic( __METHOD__
);
339 $lb->getConnection( $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
340 $conn2->endAtomic( __METHOD__
);
341 $this->fail( "No exception thrown." );
342 } catch ( DBUnexpectedError
$e ) {
344 'Wikimedia\Rdbms\LoadBalancer::openConnection: ' .
345 'CONN_TRX_AUTOCOMMIT handle has a transaction.',
349 $conn2->endAtomic( __METHOD__
);
355 public function testTransactionCallbackChains() {
356 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
360 'host' => $wgDBserver,
361 'dbname' => $wgDBname,
362 'tablePrefix' => $this->dbPrefix(),
364 'password' => $wgDBpassword,
366 'dbDirectory' => $wgSQLiteDataDir,
368 'flags' => DBO_TRX
// simulate a web request with DBO_TRX
372 $lb = new LoadBalancer( [
373 'servers' => $servers,
374 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
377 $conn1 = $lb->openConnection( $lb->getWriterIndex(), false );
378 $conn2 = $lb->openConnection( $lb->getWriterIndex(), '' );
381 $lb->forEachOpenMasterConnection( function () use ( &$count ) {
384 $this->assertEquals( 2, $count, 'Connection handle count' );
387 $lb->setTransactionListener( 'test-listener', function () use ( &$tlCalls ) {
391 $lb->beginMasterChanges( __METHOD__
);
392 $bc = array_fill_keys( [ 'a', 'b', 'c', 'd' ], 0 );
393 $conn1->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
395 $conn2->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
397 $conn1->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
399 $conn1->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
405 $lb->finalizeMasterChanges();
406 $lb->approveMasterChanges( [] );
407 $lb->commitMasterChanges( __METHOD__
);
408 $lb->runMasterTransactionIdleCallbacks();
409 $lb->runMasterTransactionListenerCallbacks();
411 $this->assertEquals( array_fill_keys( [ 'a', 'b', 'c', 'd' ], 1 ), $bc );
412 $this->assertEquals( 2, $tlCalls );
415 $lb->beginMasterChanges( __METHOD__
);
416 $ac = array_fill_keys( [ 'a', 'b', 'c', 'd' ], 0 );
417 $conn1->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
419 $conn2->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
421 $conn1->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
423 $conn1->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
429 $lb->finalizeMasterChanges();
430 $lb->approveMasterChanges( [] );
431 $lb->commitMasterChanges( __METHOD__
);
432 $lb->runMasterTransactionIdleCallbacks();
433 $lb->runMasterTransactionListenerCallbacks();
435 $this->assertEquals( array_fill_keys( [ 'a', 'b', 'c', 'd' ], 1 ), $ac );
436 $this->assertEquals( 2, $tlCalls );
442 public function testDBConnRefReadsMasterAndReplicaRoles() {
443 $lb = $this->newSingleServerLocalLoadBalancer();
445 $rConn = $lb->getConnectionRef( DB_REPLICA
);
446 $wConn = $lb->getConnectionRef( DB_MASTER
);
447 $wConn2 = $lb->getConnectionRef( 0 );
449 $v = [ 'value' => '1', '1' ];
450 $sql = 'SELECT MAX(1) AS value';
451 foreach ( [ $rConn, $wConn, $wConn2 ] as $conn ) {
452 $conn->clearFlag( $conn::DBO_TRX
);
454 $res = $conn->query( $sql, __METHOD__
);
455 $this->assertEquals( $v, $conn->fetchRow( $res ) );
457 $res = $conn->query( $sql, __METHOD__
, $conn::QUERY_REPLICA_ROLE
);
458 $this->assertEquals( $v, $conn->fetchRow( $res ) );
461 $wConn->getScopedLockAndFlush( 'key', __METHOD__
, 1 );
462 $wConn2->getScopedLockAndFlush( 'key2', __METHOD__
, 1 );
466 * @expectedException \Wikimedia\Rdbms\DBReadOnlyRoleError
468 public function testDBConnRefWritesReplicaRole() {
469 $lb = $this->newSingleServerLocalLoadBalancer();
471 $rConn = $lb->getConnectionRef( DB_REPLICA
);
473 $rConn->query( 'DELETE FROM sometesttable WHERE 1=0' );
477 * @expectedException \Wikimedia\Rdbms\DBReadOnlyRoleError
479 public function testDBConnRefWritesReplicaRoleIndex() {
480 $lb = $this->newMultiServerLocalLoadBalancer();
482 $rConn = $lb->getConnectionRef( 1 );
484 $rConn->query( 'DELETE FROM sometesttable WHERE 1=0' );
488 * @expectedException \Wikimedia\Rdbms\DBReadOnlyRoleError
490 public function testDBConnRefWritesReplicaRoleInsert() {
491 $lb = $this->newMultiServerLocalLoadBalancer();
493 $rConn = $lb->getConnectionRef( DB_REPLICA
);
495 $rConn->insert( 'test', [ 't' => 1 ], __METHOD__
);