tests/phpunit/includes/db/LBFactoryTest.php

   1 <?php
   2 /**
   3  * Holds tests for LBFactory abstract MediaWiki class.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @group Database
  21  * @file
  22  * @author Antoine Musso
  23  * @copyright © 2013 Antoine Musso
  24  * @copyright © 2013 Wikimedia Foundation Inc.
  25  */
  26 class LBFactoryTest extends MediaWikiTestCase {
  27
  28         /**
  29          * @dataProvider getLBFactoryClassProvider
  30          */
  31         public function testGetLBFactoryClass( $expected, $deprecated ) {
  32                 $mockDB = $this->getMockBuilder( 'DatabaseMysql' )
  33                         ->disableOriginalConstructor()
  34                         ->getMock();
  35
  36                 $config = [
  37                         'class'          => $deprecated,
  38                         'connection'     => $mockDB,
  39                         # Various other parameters required:
  40                         'sectionsByDB'   => [],
  41                         'sectionLoads'   => [],
  42                         'serverTemplate' => [],
  43                 ];
  44
  45                 $this->hideDeprecated( '$wgLBFactoryConf must be updated. See RELEASE-NOTES for details' );
  46                 $result = LBFactory::getLBFactoryClass( $config );
  47
  48                 $this->assertEquals( $expected, $result );
  49         }
  50
  51         public function getLBFactoryClassProvider() {
  52                 return [
  53                         # Format: new class, old class
  54                         [ 'LBFactorySimple', 'LBFactory_Simple' ],
  55                         [ 'LBFactorySingle', 'LBFactory_Single' ],
  56                         [ 'LBFactoryMulti', 'LBFactory_Multi' ],
  57                         [ 'LBFactoryFake', 'LBFactory_Fake' ],
  58                 ];
  59         }
  60
  61         public function testLBFactorySimpleServer() {
  62                 $this->setMwGlobals( 'wgDBservers', false );
  63
  64                 $factory = new LBFactorySimple( [] );
  65                 $lb = $factory->getMainLB();
  66
  67                 $dbw = $lb->getConnection( DB_MASTER );
  68                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
  69
  70                 $dbr = $lb->getConnection( DB_SLAVE );
  71                 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_SLAVE also gets the master' );
  72
  73                 $factory->shutdown();
  74                 $lb->closeAll();
  75         }
  76
  77         public function testLBFactorySimpleServers() {
  78                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype;
  79
  80                 $this->setMwGlobals( 'wgDBservers', [
  81                         [ // master
  82                                 'host'          => $wgDBserver,
  83                                 'dbname'    => $wgDBname,
  84                                 'user'          => $wgDBuser,
  85                                 'password'      => $wgDBpassword,
  86                                 'type'          => $wgDBtype,
  87                                 'load'      => 0,
  88                                 'flags'     => DBO_TRX // REPEATABLE-READ for consistency
  89                         ],
  90                         [ // emulated slave
  91                                 'host'          => $wgDBserver,
  92                                 'dbname'    => $wgDBname,
  93                                 'user'          => $wgDBuser,
  94                                 'password'      => $wgDBpassword,
  95                                 'type'          => $wgDBtype,
  96                                 'load'      => 100,
  97                                 'flags'     => DBO_TRX // REPEATABLE-READ for consistency
  98                         ]
  99                 ] );
 100
 101                 $factory = new LBFactorySimple( [ 'loadMonitorClass' => 'LoadMonitorNull' ] );
 102                 $lb = $factory->getMainLB();
 103
 104                 $dbw = $lb->getConnection( DB_MASTER );
 105                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
 106                 $this->assertEquals(
 107                         $wgDBserver, $dbw->getLBInfo( 'clusterMasterHost' ), 'cluster master set' );
 108
 109                 $dbr = $lb->getConnection( DB_SLAVE );
 110                 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
 111                 $this->assertEquals(
 112                         $wgDBserver, $dbr->getLBInfo( 'clusterMasterHost' ), 'cluster master set' );
 113
 114                 $factory->shutdown();
 115                 $lb->closeAll();
 116         }
 117
 118         public function testLBFactoryMulti() {
 119                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype;
 120
 121                 $factory = new LBFactoryMulti( [
 122                         'sectionsByDB' => [],
 123                         'sectionLoads' => [
 124                                 'DEFAULT' => [
 125                                         'test-db1' => 0,
 126                                         'test-db2' => 100,
 127                                 ],
 128                         ],
 129                         'serverTemplate' => [
 130                                 'dbname'          => $wgDBname,
 131                                 'user'            => $wgDBuser,
 132                                 'password'        => $wgDBpassword,
 133                                 'type'            => $wgDBtype,
 134                                 'flags'           => DBO_DEFAULT
 135                         ],
 136                         'hostsByName' => [
 137                                 'test-db1'  => $wgDBserver,
 138                                 'test-db2'  => $wgDBserver
 139                         ],
 140                         'loadMonitorClass' => 'LoadMonitorNull'
 141                 ] );
 142                 $lb = $factory->getMainLB();
 143
 144                 $dbw = $lb->getConnection( DB_MASTER );
 145                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
 146
 147                 $dbr = $lb->getConnection( DB_SLAVE );
 148                 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
 149
 150                 $factory->shutdown();
 151                 $lb->closeAll();
 152         }
 153
 154         public function testChronologyProtector() {
 155                 // (a) First HTTP request
 156                 $mPos = new MySQLMasterPos( 'db1034-bin.000976', '843431247' );
 157
 158                 $now = microtime( true );
 159                 $mockDB = $this->getMockBuilder( 'DatabaseMysql' )
 160                         ->disableOriginalConstructor()
 161                         ->getMock();
 162                 $mockDB->method( 'writesOrCallbacksPending' )->willReturn( true );
 163                 $mockDB->method( 'lastDoneWrites' )->willReturn( $now );
 164                 $mockDB->method( 'getMasterPos' )->willReturn( $mPos );
 165
 166                 $lb = $this->getMockBuilder( 'LoadBalancer' )
 167                         ->disableOriginalConstructor()
 168                         ->getMock();
 169                 $lb->method( 'getConnection' )->willReturn( $mockDB );
 170                 $lb->method( 'getServerCount' )->willReturn( 2 );
 171                 $lb->method( 'parentInfo' )->willReturn( [ 'id' => "main-DEFAULT" ] );
 172                 $lb->method( 'getAnyOpenConnection' )->willReturn( $mockDB );
 173                 $lb->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
 174                                 function () use ( $mockDB ) {
 175                                         $p = 0;
 176                                         $p |= call_user_func( [ $mockDB, 'writesOrCallbacksPending' ] );
 177                                         $p |= call_user_func( [ $mockDB, 'lastDoneWrites' ] );
 178
 179                                         return (bool)$p;
 180                                 }
 181                         ) );
 182                 $lb->method( 'getMasterPos' )->willReturn( $mPos );
 183
 184                 $bag = new HashBagOStuff();
 185                 $cp = new ChronologyProtector(
 186                         $bag,
 187                         [
 188                                 'ip' => '127.0.0.1',
 189                                 'agent' => "Totally-Not-FireFox"
 190                         ]
 191                 );
 192
 193                 $mockDB->expects( $this->exactly( 2 ) )->method( 'writesOrCallbacksPending' );
 194                 $mockDB->expects( $this->exactly( 2 ) )->method( 'lastDoneWrites' );
 195
 196                 // Nothing to wait for
 197                 $cp->initLB( $lb );
 198                 // Record in stash
 199                 $cp->shutdownLB( $lb );
 200                 $cp->shutdown();
 201
 202                 // (b) Second HTTP request
 203                 $cp = new ChronologyProtector(
 204                         $bag,
 205                         [
 206                                 'ip' => '127.0.0.1',
 207                                 'agent' => "Totally-Not-FireFox"
 208                         ]
 209                 );
 210
 211                 $lb->expects( $this->once() )
 212                         ->method( 'waitFor' )->with( $this->equalTo( $mPos ) );
 213
 214                 // Wait
 215                 $cp->initLB( $lb );
 216                 // Record in stash
 217                 $cp->shutdownLB( $lb );
 218                 $cp->shutdown();
 219         }
 220 }