tests/phpunit/includes/db/LoadBalancerTest.php

   1 <?php
   2
   3 use Wikimedia\Rdbms\DBError;
   4 use Wikimedia\Rdbms\IDatabase;
   5 use Wikimedia\Rdbms\LoadBalancer;
   6
   7 /**
   8  * Holds tests for LoadBalancer MediaWiki class.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  *
  25  * @group Database
  26  * @file
  27  *
  28  * @covers \Wikimedia\Rdbms\LoadBalancer
  29  */
  30 class LoadBalancerTest extends MediaWikiTestCase {
  31         public function testWithoutReplica() {
  32                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
  33
  34                 $servers = [
  35                         [
  36                                 'host'        => $wgDBserver,
  37                                 'dbname'      => $wgDBname,
  38                                 'user'        => $wgDBuser,
  39                                 'password'    => $wgDBpassword,
  40                                 'type'        => $wgDBtype,
  41                                 'dbDirectory' => $wgSQLiteDataDir,
  42                                 'load'        => 0,
  43                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
  44                         ],
  45                 ];
  46
  47                 $lb = new LoadBalancer( [
  48                         'servers' => $servers,
  49                         'localDomain' => wfWikiID()
  50                 ] );
  51
  52                 $dbw = $lb->getConnection( DB_MASTER );
  53                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
  54                 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX ), "DBO_TRX set on master" );
  55                 $this->assertWriteAllowed( $dbw );
  56
  57                 $dbr = $lb->getConnection( DB_REPLICA );
  58                 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
  59                 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX ), "DBO_TRX set on replica" );
  60
  61                 $dbwAuto = $lb->getConnection( DB_MASTER, [], false, $lb::CONN_TRX_AUTO );
  62                 $this->assertFalse( $dbwAuto->getFlag( $dbw::DBO_TRX ), "No DBO_TRX with CONN_TRX_AUTO" );
  63                 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX ), "DBO_TRX still set on master" );
  64                 $this->assertNotEquals( $dbw, $dbwAuto, "CONN_TRX_AUTO uses separate connection" );
  65
  66                 $dbrAuto = $lb->getConnection( DB_REPLICA, [], false, $lb::CONN_TRX_AUTO );
  67                 $this->assertFalse( $dbrAuto->getFlag( $dbw::DBO_TRX ), "No DBO_TRX with CONN_TRX_AUTO" );
  68                 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX ), "DBO_TRX still set on replica" );
  69                 $this->assertNotEquals( $dbr, $dbrAuto, "CONN_TRX_AUTO uses separate connection" );
  70
  71                 $dbwAuto2 = $lb->getConnection( DB_MASTER, [], false, $lb::CONN_TRX_AUTO );
  72                 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTO reuses connections" );
  73
  74                 $lb->closeAll();
  75         }
  76
  77         public function testWithReplica() {
  78                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
  79
  80                 $servers = [
  81                         [ // master
  82                                 'host'        => $wgDBserver,
  83                                 'dbname'      => $wgDBname,
  84                                 'user'        => $wgDBuser,
  85                                 'password'    => $wgDBpassword,
  86                                 'type'        => $wgDBtype,
  87                                 'dbDirectory' => $wgSQLiteDataDir,
  88                                 'load'        => 0,
  89                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
  90                         ],
  91                         [ // emulated replica
  92                                 'host'        => $wgDBserver,
  93                                 'dbname'      => $wgDBname,
  94                                 'user'        => $wgDBuser,
  95                                 'password'    => $wgDBpassword,
  96                                 'type'        => $wgDBtype,
  97                                 'dbDirectory' => $wgSQLiteDataDir,
  98                                 'load'        => 100,
  99                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
 100                         ]
 101                 ];
 102
 103                 $lb = new LoadBalancer( [
 104                         'servers' => $servers,
 105                         'localDomain' => wfWikiID(),
 106                         'loadMonitorClass' => 'LoadMonitorNull'
 107                 ] );
 108
 109                 $dbw = $lb->getConnection( DB_MASTER );
 110                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
 111                 $this->assertEquals(
 112                         ( $wgDBserver != '' ) ? $wgDBserver : 'localhost',
 113                         $dbw->getLBInfo( 'clusterMasterHost' ),
 114                         'cluster master set' );
 115                 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX ), "DBO_TRX set on master" );
 116                 $this->assertWriteAllowed( $dbw );
 117
 118                 $dbr = $lb->getConnection( DB_REPLICA );
 119                 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
 120                 $this->assertEquals(
 121                         ( $wgDBserver != '' ) ? $wgDBserver : 'localhost',
 122                         $dbr->getLBInfo( 'clusterMasterHost' ),
 123                         'cluster master set' );
 124                 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX ), "DBO_TRX set on replica" );
 125                 $this->assertWriteForbidden( $dbr );
 126
 127                 $dbwAuto = $lb->getConnection( DB_MASTER, [], false, $lb::CONN_TRX_AUTO );
 128                 $this->assertFalse( $dbwAuto->getFlag( $dbw::DBO_TRX ), "No DBO_TRX with CONN_TRX_AUTO" );
 129                 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX ), "DBO_TRX still set on master" );
 130                 $this->assertNotEquals( $dbw, $dbwAuto, "CONN_TRX_AUTO uses separate connection" );
 131
 132                 $dbrAuto = $lb->getConnection( DB_REPLICA, [], false, $lb::CONN_TRX_AUTO );
 133                 $this->assertFalse( $dbrAuto->getFlag( $dbw::DBO_TRX ), "No DBO_TRX with CONN_TRX_AUTO" );
 134                 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX ), "DBO_TRX still set on replica" );
 135                 $this->assertNotEquals( $dbr, $dbrAuto, "CONN_TRX_AUTO uses separate connection" );
 136
 137                 $dbwAuto2 = $lb->getConnection( DB_MASTER, [], false, $lb::CONN_TRX_AUTO );
 138                 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTO reuses connections" );
 139
 140                 $lb->closeAll();
 141         }
 142
 143         private function assertWriteForbidden( IDatabase $db ) {
 144                 try {
 145                         $db->delete( 'user', [ 'user_id' => 57634126 ], 'TEST' );
 146                         $this->fail( 'Write operation should have failed!' );
 147                 } catch ( DBError $ex ) {
 148                         // check that the exception message contains "Write operation"
 149                         $constraint = new PHPUnit_Framework_Constraint_StringContains( 'Write operation' );
 150
 151                         if ( !$constraint->evaluate( $ex->getMessage(), '', true ) ) {
 152                                 // re-throw original error, to preserve stack trace
 153                                 throw $ex;
 154                         }
 155                 } finally {
 156                         $db->rollback( __METHOD__, 'flush' );
 157                 }
 158         }
 159
 160         private function assertWriteAllowed( IDatabase $db ) {
 161                 try {
 162                         $this->assertNotSame( false, $db->delete( 'user', [ 'user_id' => 57634126 ] ) );
 163                 } finally {
 164                         $db->rollback( __METHOD__, 'flush' );
 165                 }
 166         }
 167
 168 }