tests/phpunit/includes/db/LoadBalancerTest.php

   1 <?php
   2
   3 /**
   4  * Holds tests for LoadBalancer MediaWiki class.
   5  *
   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.
  10  *
  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.
  15  *
  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
  20  *
  21  * @file
  22  */
  23
  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;
  29
  30 /**
  31  * @group Database
  32  * @covers \Wikimedia\Rdbms\LoadBalancer
  33  */
  34 class LoadBalancerTest extends MediaWikiTestCase {
  35         public function testWithoutReplica() {
  36                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
  37
  38                 $servers = [
  39                         [
  40                                 'host'        => $wgDBserver,
  41                                 'dbname'      => $wgDBname,
  42                                 'tablePrefix' => $this->dbPrefix(),
  43                                 'user'        => $wgDBuser,
  44                                 'password'    => $wgDBpassword,
  45                                 'type'        => $wgDBtype,
  46                                 'dbDirectory' => $wgSQLiteDataDir,
  47                                 'load'        => 0,
  48                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
  49                         ],
  50                 ];
  51
  52                 $lb = new LoadBalancer( [
  53                         'servers' => $servers,
  54                         'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
  55                 ] );
  56
  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' );
  60
  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 );
  65
  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" );
  69
  70                 $dbwAuto = $lb->getConnection( DB_MASTER, [], false, $lb::CONN_TRX_AUTOCOMMIT );
  71                 $this->assertFalse(
  72                         $dbwAuto->getFlag( $dbw::DBO_TRX ), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
  73                 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX ), "DBO_TRX still set on master" );
  74                 $this->assertNotEquals( $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
  75
  76                 $dbrAuto = $lb->getConnection( DB_REPLICA, [], false, $lb::CONN_TRX_AUTOCOMMIT );
  77                 $this->assertFalse(
  78                         $dbrAuto->getFlag( $dbw::DBO_TRX ), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
  79                 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX ), "DBO_TRX still set on replica" );
  80                 $this->assertNotEquals( $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
  81
  82                 $dbwAuto2 = $lb->getConnection( DB_MASTER, [], false, $lb::CONN_TRX_AUTOCOMMIT );
  83                 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
  84
  85                 $lb->closeAll();
  86         }
  87
  88         public function testWithReplica() {
  89                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
  90
  91                 $servers = [
  92                         [ // master
  93                                 'host'        => $wgDBserver,
  94                                 'dbname'      => $wgDBname,
  95                                 'tablePrefix' => $this->dbPrefix(),
  96                                 'user'        => $wgDBuser,
  97                                 'password'    => $wgDBpassword,
  98                                 'type'        => $wgDBtype,
  99                                 'dbDirectory' => $wgSQLiteDataDir,
 100                                 'load'        => 0,
 101                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
 102                         ],
 103                         [ // emulated replica
 104                                 'host'        => $wgDBserver,
 105                                 'dbname'      => $wgDBname,
 106                                 'tablePrefix' => $this->dbPrefix(),
 107                                 'user'        => $wgDBuser,
 108                                 'password'    => $wgDBpassword,
 109                                 'type'        => $wgDBtype,
 110                                 'dbDirectory' => $wgSQLiteDataDir,
 111                                 'load'        => 100,
 112                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
 113                         ]
 114                 ];
 115
 116                 $lb = new LoadBalancer( [
 117                         'servers' => $servers,
 118                         'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() ),
 119                         'loadMonitorClass' => LoadMonitorNull::class
 120                 ] );
 121
 122                 $dbw = $lb->getConnection( DB_MASTER );
 123                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
 124                 $this->assertEquals(
 125                         ( $wgDBserver != '' ) ? $wgDBserver : 'localhost',
 126                         $dbw->getLBInfo( 'clusterMasterHost' ),
 127                         'cluster master set' );
 128                 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX ), "DBO_TRX set on master" );
 129                 $this->assertWriteAllowed( $dbw );
 130
 131                 $dbr = $lb->getConnection( DB_REPLICA );
 132                 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
 133                 $this->assertEquals(
 134                         ( $wgDBserver != '' ) ? $wgDBserver : 'localhost',
 135                         $dbr->getLBInfo( 'clusterMasterHost' ),
 136                         'cluster master set' );
 137                 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX ), "DBO_TRX set on replica" );
 138                 $this->assertWriteForbidden( $dbr );
 139
 140                 $dbwAuto = $lb->getConnection( DB_MASTER, [], false, $lb::CONN_TRX_AUTOCOMMIT );
 141                 $this->assertFalse(
 142                         $dbwAuto->getFlag( $dbw::DBO_TRX ), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
 143                 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX ), "DBO_TRX still set on master" );
 144                 $this->assertNotEquals( $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
 145
 146                 $dbrAuto = $lb->getConnection( DB_REPLICA, [], false, $lb::CONN_TRX_AUTOCOMMIT );
 147                 $this->assertFalse(
 148                         $dbrAuto->getFlag( $dbw::DBO_TRX ), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
 149                 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX ), "DBO_TRX still set on replica" );
 150                 $this->assertNotEquals( $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
 151
 152                 $dbwAuto2 = $lb->getConnection( DB_MASTER, [], false, $lb::CONN_TRX_AUTOCOMMIT );
 153                 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
 154
 155                 $lb->closeAll();
 156         }
 157
 158         private function assertWriteForbidden( Database $db ) {
 159                 try {
 160                         $db->delete( 'some_table', [ 'id' => 57634126 ], __METHOD__ );
 161                         $this->fail( 'Write operation should have failed!' );
 162                 } catch ( DBError $ex ) {
 163                         // check that the exception message contains "Write operation"
 164                         $constraint = new PHPUnit_Framework_Constraint_StringContains( 'Write operation' );
 165
 166                         if ( !$constraint->evaluate( $ex->getMessage(), '', true ) ) {
 167                                 // re-throw original error, to preserve stack trace
 168                                 throw $ex;
 169                         }
 170                 } finally {
 171                         $db->rollback( __METHOD__, 'flush' );
 172                 }
 173         }
 174
 175         private function assertWriteAllowed( Database $db ) {
 176                 $table = $db->tableName( 'some_table' );
 177                 try {
 178                         $db->dropTable( 'some_table' ); // clear for sanity
 179                         // Use only basic SQL and trivial types for these queries for compatibility
 180                         $this->assertNotSame(
 181                                 false,
 182                                 $db->query( "CREATE TABLE $table (id INT, time INT)", __METHOD__ ),
 183                                 "table created"
 184                         );
 185                         $this->assertNotSame(
 186                                 false,
 187                                 $db->query( "DELETE FROM $table WHERE id=57634126", __METHOD__ ),
 188                                 "delete query"
 189                         );
 190                         $this->assertNotSame(
 191                                 false,
 192                                 $db->query( "DROP TABLE $table", __METHOD__ ),
 193                                 "table dropped"
 194                         );
 195                 } finally {
 196                         $db->rollback( __METHOD__, 'flush' );
 197                 }
 198         }
 199
 200         public function testServerAttributes() {
 201                 $servers = [
 202                         [ // master
 203                                 'dbname'      => 'my_unittest_wiki',
 204                                 'tablePrefix' => 'unittest_',
 205                                 'type'        => 'sqlite',
 206                                 'dbDirectory' => "some_directory",
 207                                 'load'        => 0
 208                         ]
 209                 ];
 210
 211                 $lb = new LoadBalancer( [
 212                         'servers' => $servers,
 213                         'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
 214                         'loadMonitorClass' => LoadMonitorNull::class
 215                 ] );
 216
 217                 $this->assertTrue( $lb->getServerAttributes( 0 )[Database::ATTR_DB_LEVEL_LOCKING] );
 218
 219                 $servers = [
 220                         [ // master
 221                                 'host'        => 'db1001',
 222                                 'user'        => 'wikiuser',
 223                                 'password'    => 'none',
 224                                 'dbname'      => 'my_unittest_wiki',
 225                                 'tablePrefix' => 'unittest_',
 226                                 'type'        => 'mysql',
 227                                 'load'        => 100
 228                         ],
 229                         [ // emulated replica
 230                                 'host'        => 'db1002',
 231                                 'user'        => 'wikiuser',
 232                                 'password'    => 'none',
 233                                 'dbname'      => 'my_unittest_wiki',
 234                                 'tablePrefix' => 'unittest_',
 235                                 'type'        => 'mysql',
 236                                 'load'        => 100
 237                         ]
 238                 ];
 239
 240                 $lb = new LoadBalancer( [
 241                         'servers' => $servers,
 242                         'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
 243                         'loadMonitorClass' => LoadMonitorNull::class
 244                 ] );
 245
 246                 $this->assertFalse( $lb->getServerAttributes( 1 )[Database::ATTR_DB_LEVEL_LOCKING] );
 247         }
 248 }