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 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
57 $ld = DatabaseDomain
::newFromId( $lb->getLocalDomainID() );
58 $this->assertEquals( $wgDBname, $ld->getDatabase(), 'local domain DB set' );
59 $this->assertEquals( $this->dbPrefix(), $ld->getTablePrefix(), 'local domain prefix set' );
61 $dbw = $lb->getConnection( DB_MASTER
);
62 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
63 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
64 $this->assertWriteAllowed( $dbw );
66 $dbr = $lb->getConnection( DB_REPLICA
);
67 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
68 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
70 if ( !$lb->getServerAttributes( $lb->getWriterIndex() )[$dbw::ATTR_DB_LEVEL_LOCKING
] ) {
71 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
73 $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
74 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
75 $this->assertNotEquals(
76 $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
78 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
80 $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
81 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
82 $this->assertNotEquals(
83 $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
85 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
86 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
92 public function testWithReplica() {
93 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
97 'host' => $wgDBserver,
98 'dbname' => $wgDBname,
99 'tablePrefix' => $this->dbPrefix(),
101 'password' => $wgDBpassword,
103 'dbDirectory' => $wgSQLiteDataDir,
105 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
107 [ // emulated replica
108 'host' => $wgDBserver,
109 'dbname' => $wgDBname,
110 'tablePrefix' => $this->dbPrefix(),
112 'password' => $wgDBpassword,
114 'dbDirectory' => $wgSQLiteDataDir,
116 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
120 $lb = new LoadBalancer( [
121 'servers' => $servers,
122 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() ),
123 'loadMonitorClass' => LoadMonitorNull
::class
126 $dbw = $lb->getConnection( DB_MASTER
);
127 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
129 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
130 $dbw->getLBInfo( 'clusterMasterHost' ),
131 'cluster master set' );
132 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
133 $this->assertWriteAllowed( $dbw );
135 $dbr = $lb->getConnection( DB_REPLICA
);
136 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
138 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
139 $dbr->getLBInfo( 'clusterMasterHost' ),
140 'cluster master set' );
141 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
142 $this->assertWriteForbidden( $dbr );
144 if ( !$lb->getServerAttributes( $lb->getWriterIndex() )[$dbw::ATTR_DB_LEVEL_LOCKING
] ) {
145 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
147 $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
148 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
149 $this->assertNotEquals(
150 $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
152 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
154 $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
155 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
156 $this->assertNotEquals(
157 $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
159 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
160 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
166 private function assertWriteForbidden( Database
$db ) {
168 $db->delete( 'some_table', [ 'id' => 57634126 ], __METHOD__
);
169 $this->fail( 'Write operation should have failed!' );
170 } catch ( DBError
$ex ) {
171 // check that the exception message contains "Write operation"
172 $constraint = new PHPUnit_Framework_Constraint_StringContains( 'Write operation' );
174 if ( !$constraint->evaluate( $ex->getMessage(), '', true ) ) {
175 // re-throw original error, to preserve stack trace
179 $db->rollback( __METHOD__
, 'flush' );
183 private function assertWriteAllowed( Database
$db ) {
184 $table = $db->tableName( 'some_table' );
186 $db->dropTable( 'some_table' ); // clear for sanity
187 // Use only basic SQL and trivial types for these queries for compatibility
188 $this->assertNotSame(
190 $db->query( "CREATE TABLE $table (id INT, time INT)", __METHOD__
),
193 $this->assertNotSame(
195 $db->query( "DELETE FROM $table WHERE id=57634126", __METHOD__
),
198 $this->assertNotSame(
200 $db->query( "DROP TABLE $table", __METHOD__
),
204 $db->rollback( __METHOD__
, 'flush' );
208 public function testServerAttributes() {
211 'dbname' => 'my_unittest_wiki',
212 'tablePrefix' => 'unittest_',
214 'dbDirectory' => "some_directory",
219 $lb = new LoadBalancer( [
220 'servers' => $servers,
221 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
222 'loadMonitorClass' => LoadMonitorNull
::class
225 $this->assertTrue( $lb->getServerAttributes( 0 )[Database
::ATTR_DB_LEVEL_LOCKING
] );
230 'user' => 'wikiuser',
231 'password' => 'none',
232 'dbname' => 'my_unittest_wiki',
233 'tablePrefix' => 'unittest_',
237 [ // emulated replica
239 'user' => 'wikiuser',
240 'password' => 'none',
241 'dbname' => 'my_unittest_wiki',
242 'tablePrefix' => 'unittest_',
248 $lb = new LoadBalancer( [
249 'servers' => $servers,
250 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
251 'loadMonitorClass' => LoadMonitorNull
::class
254 $this->assertFalse( $lb->getServerAttributes( 1 )[Database
::ATTR_DB_LEVEL_LOCKING
] );