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 class LoadBalancerTest extends MediaWikiTestCase {
  29         public function testWithoutReplica() {
  30                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
  31
  32                 $servers = [
  33                         [
  34                                 'host'        => $wgDBserver,
  35                                 'dbname'      => $wgDBname,
  36                                 'user'        => $wgDBuser,
  37                                 'password'    => $wgDBpassword,
  38                                 'type'        => $wgDBtype,
  39                                 'dbDirectory' => $wgSQLiteDataDir,
  40                                 'load'        => 0,
  41                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
  42                         ],
  43                 ];
  44
  45                 $lb = new LoadBalancer( [
  46                         'servers' => $servers,
  47                         'localDomain' => wfWikiID()
  48                 ] );
  49
  50                 $dbw = $lb->getConnection( DB_MASTER );
  51                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
  52                 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX ), "DBO_TRX set on master" );
  53                 $this->assertWriteAllowed( $dbw );
  54
  55                 $dbr = $lb->getConnection( DB_REPLICA );
  56                 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
  57                 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX ), "DBO_TRX set on replica" );
  58
  59                 $dbwAuto = $lb->getConnection( DB_MASTER, [], false, $lb::CONN_TRX_AUTO );
  60                 $this->assertFalse( $dbwAuto->getFlag( $dbw::DBO_TRX ), "No DBO_TRX with CONN_TRX_AUTO" );
  61                 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX ), "DBO_TRX still set on master" );
  62                 $this->assertNotEquals( $dbw, $dbwAuto, "CONN_TRX_AUTO uses separate connection" );
  63
  64                 $dbrAuto = $lb->getConnection( DB_REPLICA, [], false, $lb::CONN_TRX_AUTO );
  65                 $this->assertFalse( $dbrAuto->getFlag( $dbw::DBO_TRX ), "No DBO_TRX with CONN_TRX_AUTO" );
  66                 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX ), "DBO_TRX still set on replica" );
  67                 $this->assertNotEquals( $dbr, $dbrAuto, "CONN_TRX_AUTO uses separate connection" );
  68
  69                 $dbwAuto2 = $lb->getConnection( DB_MASTER, [], false, $lb::CONN_TRX_AUTO );
  70                 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTO reuses connections" );
  71
  72                 $lb->closeAll();
  73         }
  74
  75         public function testWithReplica() {
  76                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
  77
  78                 $servers = [
  79                         [ // master
  80                                 'host'        => $wgDBserver,
  81                                 'dbname'      => $wgDBname,
  82                                 'user'        => $wgDBuser,
  83                                 'password'    => $wgDBpassword,
  84                                 'type'        => $wgDBtype,
  85                                 'dbDirectory' => $wgSQLiteDataDir,
  86                                 'load'        => 0,
  87                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
  88                         ],
  89                         [ // emulated replica
  90                                 'host'        => $wgDBserver,
  91                                 'dbname'      => $wgDBname,
  92                                 'user'        => $wgDBuser,
  93                                 'password'    => $wgDBpassword,
  94                                 'type'        => $wgDBtype,
  95                                 'dbDirectory' => $wgSQLiteDataDir,
  96                                 'load'        => 100,
  97                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
  98                         ]
  99                 ];
 100
 101                 $lb = new LoadBalancer( [
 102                         'servers' => $servers,
 103                         'localDomain' => wfWikiID(),
 104                         'loadMonitorClass' => 'LoadMonitorNull'
 105                 ] );
 106
 107                 $dbw = $lb->getConnection( DB_MASTER );
 108                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
 109                 $this->assertEquals(
 110                         ( $wgDBserver != '' ) ? $wgDBserver : 'localhost',
 111                         $dbw->getLBInfo( 'clusterMasterHost' ),
 112                         'cluster master set' );
 113                 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX ), "DBO_TRX set on master" );
 114                 $this->assertWriteAllowed( $dbw );
 115
 116                 $dbr = $lb->getConnection( DB_REPLICA );
 117                 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
 118                 $this->assertEquals(
 119                         ( $wgDBserver != '' ) ? $wgDBserver : 'localhost',
 120                         $dbr->getLBInfo( 'clusterMasterHost' ),
 121                         'cluster master set' );
 122                 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX ), "DBO_TRX set on replica" );
 123                 $this->assertWriteForbidden( $dbr );
 124
 125                 $dbwAuto = $lb->getConnection( DB_MASTER, [], false, $lb::CONN_TRX_AUTO );
 126                 $this->assertFalse( $dbwAuto->getFlag( $dbw::DBO_TRX ), "No DBO_TRX with CONN_TRX_AUTO" );
 127                 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX ), "DBO_TRX still set on master" );
 128                 $this->assertNotEquals( $dbw, $dbwAuto, "CONN_TRX_AUTO uses separate connection" );
 129
 130                 $dbrAuto = $lb->getConnection( DB_REPLICA, [], false, $lb::CONN_TRX_AUTO );
 131                 $this->assertFalse( $dbrAuto->getFlag( $dbw::DBO_TRX ), "No DBO_TRX with CONN_TRX_AUTO" );
 132                 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX ), "DBO_TRX still set on replica" );
 133                 $this->assertNotEquals( $dbr, $dbrAuto, "CONN_TRX_AUTO uses separate connection" );
 134
 135                 $dbwAuto2 = $lb->getConnection( DB_MASTER, [], false, $lb::CONN_TRX_AUTO );
 136                 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTO reuses connections" );
 137
 138                 $lb->closeAll();
 139         }
 140
 141         private function assertWriteForbidden( IDatabase $db ) {
 142                 try {
 143                         $db->delete( 'user', [ 'user_id' => 57634126 ], 'TEST' );
 144                         $this->fail( 'Write operation should have failed!' );
 145                 } catch ( DBError $ex ) {
 146                         // check that the exception message contains "Write operation"
 147                         $constraint = new PHPUnit_Framework_Constraint_StringContains( 'Write operation' );
 148
 149                         if ( !$constraint->evaluate( $ex->getMessage(), '', true ) ) {
 150                                 // re-throw original error, to preserve stack trace
 151                                 throw $ex;
 152                         }
 153                 } finally {
 154                         $db->rollback( __METHOD__, 'flush' );
 155                 }
 156         }
 157
 158         private function assertWriteAllowed( IDatabase $db ) {
 159                 try {
 160                         $this->assertNotSame( false, $db->delete( 'user', [ 'user_id' => 57634126 ] ) );
 161                 } finally {
 162                         $db->rollback( __METHOD__, 'flush' );
 163                 }
 164         }
 165
 166 }