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 public function testWithoutReplica() {
36 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
40 'host' => $wgDBserver,
41 'dbname' => $wgDBname,
42 'tablePrefix' => $this->dbPrefix(),
44 'password' => $wgDBpassword,
46 'dbDirectory' => $wgSQLiteDataDir,
48 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
52 $lb = new LoadBalancer( [
53 'servers' => $servers,
54 'queryLogger' => MediaWiki\Logger\LoggerFactory
::getInstance( 'DBQuery' ),
55 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
58 $ld = DatabaseDomain
::newFromId( $lb->getLocalDomainID() );
59 $this->assertEquals( $wgDBname, $ld->getDatabase(), 'local domain DB set' );
60 $this->assertEquals( $this->dbPrefix(), $ld->getTablePrefix(), 'local domain prefix set' );
62 $dbw = $lb->getConnection( DB_MASTER
);
63 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
64 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
65 $this->assertWriteAllowed( $dbw );
67 $dbr = $lb->getConnection( DB_REPLICA
);
68 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
69 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
71 if ( !$lb->getServerAttributes( $lb->getWriterIndex() )[$dbw::ATTR_DB_LEVEL_LOCKING
] ) {
72 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
74 $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
75 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
76 $this->assertNotEquals(
77 $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
79 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
81 $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
82 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
83 $this->assertNotEquals(
84 $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
86 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
87 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
93 public function testWithReplica() {
94 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
98 'host' => $wgDBserver,
99 'dbname' => $wgDBname,
100 'tablePrefix' => $this->dbPrefix(),
102 'password' => $wgDBpassword,
104 'dbDirectory' => $wgSQLiteDataDir,
106 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
108 [ // emulated replica
109 'host' => $wgDBserver,
110 'dbname' => $wgDBname,
111 'tablePrefix' => $this->dbPrefix(),
113 'password' => $wgDBpassword,
115 'dbDirectory' => $wgSQLiteDataDir,
117 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
121 $lb = new LoadBalancer( [
122 'servers' => $servers,
123 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() ),
124 'queryLogger' => MediaWiki\Logger\LoggerFactory
::getInstance( 'DBQuery' ),
125 'loadMonitorClass' => LoadMonitorNull
::class
128 $dbw = $lb->getConnection( DB_MASTER
);
129 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
131 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
132 $dbw->getLBInfo( 'clusterMasterHost' ),
133 'cluster master set' );
134 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
135 $this->assertWriteAllowed( $dbw );
137 $dbr = $lb->getConnection( DB_REPLICA
);
138 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
140 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
141 $dbr->getLBInfo( 'clusterMasterHost' ),
142 'cluster master set' );
143 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
144 $this->assertWriteForbidden( $dbr );
146 if ( !$lb->getServerAttributes( $lb->getWriterIndex() )[$dbw::ATTR_DB_LEVEL_LOCKING
] ) {
147 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
149 $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
150 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
151 $this->assertNotEquals(
152 $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
154 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
156 $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
157 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
158 $this->assertNotEquals(
159 $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
161 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
162 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
168 private function assertWriteForbidden( Database
$db ) {
170 $db->delete( 'some_table', [ 'id' => 57634126 ], __METHOD__
);
171 $this->fail( 'Write operation should have failed!' );
172 } catch ( DBError
$ex ) {
173 // check that the exception message contains "Write operation"
174 $constraint = new PHPUnit_Framework_Constraint_StringContains( 'Write operation' );
176 if ( !$constraint->evaluate( $ex->getMessage(), '', true ) ) {
177 // re-throw original error, to preserve stack trace
183 private function assertWriteAllowed( Database
$db ) {
184 $table = $db->tableName( 'some_table' );
186 $db->dropTable( 'some_table' ); // clear for sanity
188 // Trigger DBO_TRX to create a transaction so the flush below will
189 // roll everything here back in sqlite. But don't actually do the
190 // code below inside an atomic section becaue MySQL and Oracle
191 // auto-commit transactions for DDL statements like CREATE TABLE.
192 $db->startAtomic( __METHOD__
);
193 $db->endAtomic( __METHOD__
);
195 // Use only basic SQL and trivial types for these queries for compatibility
196 $this->assertNotSame(
198 $db->query( "CREATE TABLE $table (id INT, time INT)", __METHOD__
),
201 $this->assertNotSame(
203 $db->query( "DELETE FROM $table WHERE id=57634126", __METHOD__
),
207 // Drop the table to clean up, ignoring any error.
208 $db->query( "DROP TABLE $table", __METHOD__
, true );
209 // Rollback the DBO_TRX transaction for sqlite's benefit.
210 $db->rollback( __METHOD__
, 'flush' );
214 public function testServerAttributes() {
217 'dbname' => 'my_unittest_wiki',
218 'tablePrefix' => 'unittest_',
220 'dbDirectory' => "some_directory",
225 $lb = new LoadBalancer( [
226 'servers' => $servers,
227 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
228 'loadMonitorClass' => LoadMonitorNull
::class
231 $this->assertTrue( $lb->getServerAttributes( 0 )[Database
::ATTR_DB_LEVEL_LOCKING
] );
236 'user' => 'wikiuser',
237 'password' => 'none',
238 'dbname' => 'my_unittest_wiki',
239 'tablePrefix' => 'unittest_',
243 [ // emulated replica
245 'user' => 'wikiuser',
246 'password' => 'none',
247 'dbname' => 'my_unittest_wiki',
248 'tablePrefix' => 'unittest_',
254 $lb = new LoadBalancer( [
255 'servers' => $servers,
256 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
257 'loadMonitorClass' => LoadMonitorNull
::class
260 $this->assertFalse( $lb->getServerAttributes( 1 )[Database
::ATTR_DB_LEVEL_LOCKING
] );