3 use Wikimedia\Rdbms\DBError
;
4 use Wikimedia\Rdbms\LoadBalancer
;
5 use Wikimedia\Rdbms\DatabaseDomain
;
6 use Wikimedia\Rdbms\Database
;
9 * Holds tests for LoadBalancer MediaWiki class.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24 * http://www.gnu.org/copyleft/gpl.html
29 * @covers \Wikimedia\Rdbms\LoadBalancer
31 class LoadBalancerTest
extends MediaWikiTestCase
{
32 public function testWithoutReplica() {
33 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
37 'host' => $wgDBserver,
38 'dbname' => $wgDBname,
39 'tablePrefix' => $this->dbPrefix(),
41 'password' => $wgDBpassword,
43 'dbDirectory' => $wgSQLiteDataDir,
45 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
49 $lb = new LoadBalancer( [
50 'servers' => $servers,
51 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
54 $ld = DatabaseDomain
::newFromId( $lb->getLocalDomainID() );
55 $this->assertEquals( $wgDBname, $ld->getDatabase(), 'local domain DB set' );
56 $this->assertEquals( $this->dbPrefix(), $ld->getTablePrefix(), 'local domain prefix set' );
58 $dbw = $lb->getConnection( DB_MASTER
);
59 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
60 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
61 $this->assertWriteAllowed( $dbw );
63 $dbr = $lb->getConnection( DB_REPLICA
);
64 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
65 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
67 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTO
);
68 $this->assertFalse( $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTO" );
69 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
70 $this->assertNotEquals( $dbw, $dbwAuto, "CONN_TRX_AUTO uses separate connection" );
72 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTO
);
73 $this->assertFalse( $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTO" );
74 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
75 $this->assertNotEquals( $dbr, $dbrAuto, "CONN_TRX_AUTO uses separate connection" );
77 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTO
);
78 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTO reuses connections" );
83 public function testWithReplica() {
84 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
88 'host' => $wgDBserver,
89 'dbname' => $wgDBname,
90 'tablePrefix' => $this->dbPrefix(),
92 'password' => $wgDBpassword,
94 'dbDirectory' => $wgSQLiteDataDir,
96 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
99 'host' => $wgDBserver,
100 'dbname' => $wgDBname,
101 'tablePrefix' => $this->dbPrefix(),
103 'password' => $wgDBpassword,
105 'dbDirectory' => $wgSQLiteDataDir,
107 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
111 $lb = new LoadBalancer( [
112 'servers' => $servers,
113 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() ),
114 'loadMonitorClass' => 'LoadMonitorNull'
117 $dbw = $lb->getConnection( DB_MASTER
);
118 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
120 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
121 $dbw->getLBInfo( 'clusterMasterHost' ),
122 'cluster master set' );
123 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
124 $this->assertWriteAllowed( $dbw );
126 $dbr = $lb->getConnection( DB_REPLICA
);
127 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
129 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
130 $dbr->getLBInfo( 'clusterMasterHost' ),
131 'cluster master set' );
132 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
133 $this->assertWriteForbidden( $dbr );
135 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTO
);
136 $this->assertFalse( $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTO" );
137 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
138 $this->assertNotEquals( $dbw, $dbwAuto, "CONN_TRX_AUTO uses separate connection" );
140 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTO
);
141 $this->assertFalse( $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTO" );
142 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
143 $this->assertNotEquals( $dbr, $dbrAuto, "CONN_TRX_AUTO uses separate connection" );
145 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTO
);
146 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTO reuses connections" );
151 private function assertWriteForbidden( Database
$db ) {
153 $db->delete( 'some_table', [ 'id' => 57634126 ], __METHOD__
);
154 $this->fail( 'Write operation should have failed!' );
155 } catch ( DBError
$ex ) {
156 // check that the exception message contains "Write operation"
157 $constraint = new PHPUnit_Framework_Constraint_StringContains( 'Write operation' );
159 if ( !$constraint->evaluate( $ex->getMessage(), '', true ) ) {
160 // re-throw original error, to preserve stack trace
164 $db->rollback( __METHOD__
, 'flush' );
168 private function assertWriteAllowed( Database
$db ) {
169 $table = $db->tableName( 'some_table' );
171 $db->dropTable( 'some_table' ); // clear for sanity
172 // Use only basic SQL and trivial types for these queries for compatibility
173 $this->assertNotSame(
175 $db->query( "CREATE TABLE $table (id INT, time INT)", __METHOD__
),
178 $this->assertNotSame(
180 $db->query( "DELETE FROM $table WHERE id=57634126", __METHOD__
),
183 $this->assertNotSame(
185 $db->query( "DROP TABLE $table", __METHOD__
),
189 $db->rollback( __METHOD__
, 'flush' );