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() {
36 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
39 'host' => $wgDBserver,
40 'dbname' => $wgDBname,
41 'tablePrefix' => $this->dbPrefix(),
43 'password' => $wgDBpassword,
45 'dbDirectory' => $wgSQLiteDataDir,
47 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
52 * @covers LoadBalancer::getLocalDomainID()
53 * @covers LoadBalancer::resolveDomainID()
55 public function testWithoutReplica() {
59 $lb = new LoadBalancer( [
60 'servers' => [ $this->makeServerConfig() ],
61 'queryLogger' => MediaWiki\Logger\LoggerFactory
::getInstance( 'DBQuery' ),
62 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() ),
63 'chronologyCallback' => function () use ( &$called ) {
68 $ld = DatabaseDomain
::newFromId( $lb->getLocalDomainID() );
69 $this->assertEquals( $wgDBname, $ld->getDatabase(), 'local domain DB set' );
70 $this->assertEquals( $this->dbPrefix(), $ld->getTablePrefix(), 'local domain prefix set' );
71 $this->assertSame( 'my_test_wiki', $lb->resolveDomainID( 'my_test_wiki' ) );
72 $this->assertSame( $ld->getId(), $lb->resolveDomainID( false ) );
73 $this->assertSame( $ld->getId(), $lb->resolveDomainID( $ld ) );
75 $this->assertFalse( $called );
76 $dbw = $lb->getConnection( DB_MASTER
);
77 $this->assertTrue( $called );
78 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
79 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
80 $this->assertWriteAllowed( $dbw );
82 $dbr = $lb->getConnection( DB_REPLICA
);
83 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
84 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
86 if ( !$lb->getServerAttributes( $lb->getWriterIndex() )[$dbw::ATTR_DB_LEVEL_LOCKING
] ) {
87 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
89 $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
90 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
91 $this->assertNotEquals(
92 $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
94 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
96 $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
97 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
98 $this->assertNotEquals(
99 $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
101 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
102 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
108 public function testWithReplica() {
109 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
113 'host' => $wgDBserver,
114 'dbname' => $wgDBname,
115 'tablePrefix' => $this->dbPrefix(),
117 'password' => $wgDBpassword,
119 'dbDirectory' => $wgSQLiteDataDir,
121 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
123 [ // emulated replica
124 'host' => $wgDBserver,
125 'dbname' => $wgDBname,
126 'tablePrefix' => $this->dbPrefix(),
128 'password' => $wgDBpassword,
130 'dbDirectory' => $wgSQLiteDataDir,
132 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
136 $lb = new LoadBalancer( [
137 'servers' => $servers,
138 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() ),
139 'queryLogger' => MediaWiki\Logger\LoggerFactory
::getInstance( 'DBQuery' ),
140 'loadMonitorClass' => LoadMonitorNull
::class
143 $dbw = $lb->getConnection( DB_MASTER
);
144 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
146 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
147 $dbw->getLBInfo( 'clusterMasterHost' ),
148 'cluster master set' );
149 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
150 $this->assertWriteAllowed( $dbw );
152 $dbr = $lb->getConnection( DB_REPLICA
);
153 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
155 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
156 $dbr->getLBInfo( 'clusterMasterHost' ),
157 'cluster master set' );
158 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
159 $this->assertWriteForbidden( $dbr );
161 if ( !$lb->getServerAttributes( $lb->getWriterIndex() )[$dbw::ATTR_DB_LEVEL_LOCKING
] ) {
162 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
164 $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
165 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
166 $this->assertNotEquals(
167 $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
169 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
171 $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
172 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
173 $this->assertNotEquals(
174 $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
176 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
177 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
183 private function assertWriteForbidden( Database
$db ) {
185 $db->delete( 'some_table', [ 'id' => 57634126 ], __METHOD__
);
186 $this->fail( 'Write operation should have failed!' );
187 } catch ( DBError
$ex ) {
188 // check that the exception message contains "Write operation"
189 $constraint = new PHPUnit_Framework_Constraint_StringContains( 'Write operation' );
191 if ( !$constraint->evaluate( $ex->getMessage(), '', true ) ) {
192 // re-throw original error, to preserve stack trace
198 private function assertWriteAllowed( Database
$db ) {
199 $table = $db->tableName( 'some_table' );
200 // Trigger a transaction so that rollback() will remove all the tables.
201 // Don't do this for MySQL/Oracle as they auto-commit transactions for DDL
202 // statements such as CREATE TABLE.
203 $useAtomicSection = in_array( $db->getType(), [ 'sqlite', 'postgres', 'mssql' ], true );
205 $db->dropTable( 'some_table' ); // clear for sanity
206 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
208 if ( $useAtomicSection ) {
209 $db->startAtomic( __METHOD__
);
211 // Use only basic SQL and trivial types for these queries for compatibility
212 $this->assertNotSame(
214 $db->query( "CREATE TABLE $table (id INT, time INT)", __METHOD__
),
217 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
218 $this->assertNotSame(
220 $db->query( "DELETE FROM $table WHERE id=57634126", __METHOD__
),
223 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
225 if ( !$useAtomicSection ) {
226 // Drop the table to clean up, ignoring any error.
227 $db->dropTable( 'some_table' );
229 // Rollback the atomic section for sqlite's benefit.
230 $db->rollback( __METHOD__
, 'flush' );
231 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
235 public function testServerAttributes() {
238 'dbname' => 'my_unittest_wiki',
239 'tablePrefix' => 'unittest_',
241 'dbDirectory' => "some_directory",
246 $lb = new LoadBalancer( [
247 'servers' => $servers,
248 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
249 'loadMonitorClass' => LoadMonitorNull
::class
252 $this->assertTrue( $lb->getServerAttributes( 0 )[Database
::ATTR_DB_LEVEL_LOCKING
] );
257 'user' => 'wikiuser',
258 'password' => 'none',
259 'dbname' => 'my_unittest_wiki',
260 'tablePrefix' => 'unittest_',
264 [ // emulated replica
266 'user' => 'wikiuser',
267 'password' => 'none',
268 'dbname' => 'my_unittest_wiki',
269 'tablePrefix' => 'unittest_',
275 $lb = new LoadBalancer( [
276 'servers' => $servers,
277 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
278 'loadMonitorClass' => LoadMonitorNull
::class
281 $this->assertFalse( $lb->getServerAttributes( 1 )[Database
::ATTR_DB_LEVEL_LOCKING
] );
285 * @covers LoadBalancer::openConnection()
286 * @covers LoadBalancer::getAnyOpenConnection()
288 function testOpenConnection() {
291 $lb = new LoadBalancer( [
292 'servers' => [ $this->makeServerConfig() ],
293 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
296 $i = $lb->getWriterIndex();
297 $this->assertEquals( null, $lb->getAnyOpenConnection( $i ) );
298 $conn1 = $lb->getConnection( $i );
299 $this->assertNotEquals( null, $conn1 );
300 $this->assertEquals( $conn1, $lb->getAnyOpenConnection( $i ) );
301 $conn2 = $lb->getConnection( $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
302 $this->assertNotEquals( null, $conn2 );
303 if ( $lb->getServerAttributes( $i )[Database
::ATTR_DB_LEVEL_LOCKING
] ) {
304 $this->assertEquals( null,
305 $lb->getAnyOpenConnection( $i, $lb::CONN_TRX_AUTOCOMMIT
) );
306 $this->assertEquals( $conn1,
308 $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
), $lb::CONN_TRX_AUTOCOMMIT
);
310 $this->assertEquals( $conn2,
311 $lb->getAnyOpenConnection( $i, $lb::CONN_TRX_AUTOCOMMIT
) );
312 $this->assertEquals( $conn2,
313 $lb->getConnection( $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
) );
319 public function testTransactionCallbackChains() {
320 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
324 'host' => $wgDBserver,
325 'dbname' => $wgDBname,
326 'tablePrefix' => $this->dbPrefix(),
328 'password' => $wgDBpassword,
330 'dbDirectory' => $wgSQLiteDataDir,
332 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
336 $lb = new LoadBalancer( [
337 'servers' => $servers,
338 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
341 $conn1 = $lb->openConnection( $lb->getWriterIndex(), false );
342 $conn2 = $lb->openConnection( $lb->getWriterIndex(), '' );
345 $lb->forEachOpenMasterConnection( function () use ( &$count ) {
348 $this->assertEquals( 2, $count, 'Connection handle count' );
351 $lb->setTransactionListener( 'test-listener', function () use ( &$tlCalls ) {
355 $lb->beginMasterChanges( __METHOD__
);
356 $bc = array_fill_keys( [ 'a', 'b', 'c', 'd' ], 0 );
357 $conn1->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
359 $conn2->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
361 $conn1->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
363 $conn1->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
369 $lb->finalizeMasterChanges();
370 $lb->approveMasterChanges( [] );
371 $lb->commitMasterChanges( __METHOD__
);
372 $lb->runMasterTransactionIdleCallbacks();
373 $lb->runMasterTransactionListenerCallbacks();
375 $this->assertEquals( array_fill_keys( [ 'a', 'b', 'c', 'd' ], 1 ), $bc );
376 $this->assertEquals( 2, $tlCalls );
379 $lb->beginMasterChanges( __METHOD__
);
380 $ac = array_fill_keys( [ 'a', 'b', 'c', 'd' ], 0 );
381 $conn1->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
383 $conn2->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
385 $conn1->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
387 $conn1->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
393 $lb->finalizeMasterChanges();
394 $lb->approveMasterChanges( [] );
395 $lb->commitMasterChanges( __METHOD__
);
396 $lb->runMasterTransactionIdleCallbacks();
397 $lb->runMasterTransactionListenerCallbacks();
399 $this->assertEquals( array_fill_keys( [ 'a', 'b', 'c', 'd' ], 1 ), $ac );
400 $this->assertEquals( 2, $tlCalls );