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  * @file
  21  * @author Antoine Musso
  22  * @copyright © 2013 Antoine Musso
  23  * @copyright © 2013 Wikimedia Foundation Inc.
  24  */
  25
  26 use Wikimedia\Rdbms\LBFactorySimple;
  27 use Wikimedia\Rdbms\LBFactoryMulti;
  28 use Wikimedia\Rdbms\ChronologyProtector;
  29 use Wikimedia\Rdbms\MySQLMasterPos;
  30
  31 /**
  32  * @group Database
  33  * @covers \Wikimedia\Rdbms\LBFactorySimple
  34  * @covers \Wikimedia\Rdbms\LBFactoryMulti
  35  */
  36 class LBFactoryTest extends MediaWikiTestCase {
  37
  38         /**
  39          * @covers MWLBFactory::getLBFactoryClass
  40          * @dataProvider getLBFactoryClassProvider
  41          */
  42         public function testGetLBFactoryClass( $expected, $deprecated ) {
  43                 $mockDB = $this->getMockBuilder( 'DatabaseMysqli' )
  44                         ->disableOriginalConstructor()
  45                         ->getMock();
  46
  47                 $config = [
  48                         'class'          => $deprecated,
  49                         'connection'     => $mockDB,
  50                         # Various other parameters required:
  51                         'sectionsByDB'   => [],
  52                         'sectionLoads'   => [],
  53                         'serverTemplate' => [],
  54                 ];
  55
  56                 $this->hideDeprecated( '$wgLBFactoryConf must be updated. See RELEASE-NOTES for details' );
  57                 $result = MWLBFactory::getLBFactoryClass( $config );
  58
  59                 $this->assertEquals( $expected, $result );
  60         }
  61
  62         public function getLBFactoryClassProvider() {
  63                 return [
  64                         # Format: new class, old class
  65                         [ Wikimedia\Rdbms\LBFactorySimple::class, 'LBFactory_Simple' ],
  66                         [ Wikimedia\Rdbms\LBFactorySingle::class, 'LBFactory_Single' ],
  67                         [ Wikimedia\Rdbms\LBFactoryMulti::class, 'LBFactory_Multi' ],
  68                         [ Wikimedia\Rdbms\LBFactorySimple::class, 'LBFactorySimple' ],
  69                         [ Wikimedia\Rdbms\LBFactorySingle::class, 'LBFactorySingle' ],
  70                         [ Wikimedia\Rdbms\LBFactoryMulti::class, 'LBFactoryMulti' ],
  71                 ];
  72         }
  73
  74         public function testLBFactorySimpleServer() {
  75                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
  76
  77                 $servers = [
  78                         [
  79                                 'host'        => $wgDBserver,
  80                                 'dbname'      => $wgDBname,
  81                                 'user'        => $wgDBuser,
  82                                 'password'    => $wgDBpassword,
  83                                 'type'        => $wgDBtype,
  84                                 'dbDirectory' => $wgSQLiteDataDir,
  85                                 'load'        => 0,
  86                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
  87                         ],
  88                 ];
  89
  90                 $factory = new LBFactorySimple( [ 'servers' => $servers ] );
  91                 $lb = $factory->getMainLB();
  92
  93                 $dbw = $lb->getConnection( DB_MASTER );
  94                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
  95
  96                 $dbr = $lb->getConnection( DB_REPLICA );
  97                 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
  98
  99                 $factory->shutdown();
 100                 $lb->closeAll();
 101         }
 102
 103         public function testLBFactorySimpleServers() {
 104                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
 105
 106                 $servers = [
 107                         [ // master
 108                                 'host'        => $wgDBserver,
 109                                 'dbname'      => $wgDBname,
 110                                 'user'        => $wgDBuser,
 111                                 'password'    => $wgDBpassword,
 112                                 'type'        => $wgDBtype,
 113                                 'dbDirectory' => $wgSQLiteDataDir,
 114                                 'load'        => 0,
 115                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
 116                         ],
 117                         [ // emulated slave
 118                                 'host'        => $wgDBserver,
 119                                 'dbname'      => $wgDBname,
 120                                 'user'        => $wgDBuser,
 121                                 'password'    => $wgDBpassword,
 122                                 'type'        => $wgDBtype,
 123                                 'dbDirectory' => $wgSQLiteDataDir,
 124                                 'load'        => 100,
 125                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
 126                         ]
 127                 ];
 128
 129                 $factory = new LBFactorySimple( [
 130                         'servers' => $servers,
 131                         'loadMonitorClass' => 'LoadMonitorNull'
 132                 ] );
 133                 $lb = $factory->getMainLB();
 134
 135                 $dbw = $lb->getConnection( DB_MASTER );
 136                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
 137                 $this->assertEquals(
 138                         ( $wgDBserver != '' ) ? $wgDBserver : 'localhost',
 139                         $dbw->getLBInfo( 'clusterMasterHost' ),
 140                         'cluster master set' );
 141
 142                 $dbr = $lb->getConnection( DB_REPLICA );
 143                 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
 144                 $this->assertEquals(
 145                         ( $wgDBserver != '' ) ? $wgDBserver : 'localhost',
 146                         $dbr->getLBInfo( 'clusterMasterHost' ),
 147                         'cluster master set' );
 148
 149                 $factory->shutdown();
 150                 $lb->closeAll();
 151         }
 152
 153         public function testLBFactoryMulti() {
 154                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
 155
 156                 $factory = new LBFactoryMulti( [
 157                         'sectionsByDB' => [],
 158                         'sectionLoads' => [
 159                                 'DEFAULT' => [
 160                                         'test-db1' => 0,
 161                                         'test-db2' => 100,
 162                                 ],
 163                         ],
 164                         'serverTemplate' => [
 165                                 'dbname'      => $wgDBname,
 166                                 'user'        => $wgDBuser,
 167                                 'password'    => $wgDBpassword,
 168                                 'type'        => $wgDBtype,
 169                                 'dbDirectory' => $wgSQLiteDataDir,
 170                                 'flags'       => DBO_DEFAULT
 171                         ],
 172                         'hostsByName' => [
 173                                 'test-db1'  => $wgDBserver,
 174                                 'test-db2'  => $wgDBserver
 175                         ],
 176                         'loadMonitorClass' => 'LoadMonitorNull'
 177                 ] );
 178                 $lb = $factory->getMainLB();
 179
 180                 $dbw = $lb->getConnection( DB_MASTER );
 181                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
 182
 183                 $dbr = $lb->getConnection( DB_REPLICA );
 184                 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
 185
 186                 $factory->shutdown();
 187                 $lb->closeAll();
 188         }
 189
 190         /**
 191          * @covers \Wikimedia\Rdbms\ChronologyProtector
 192          */
 193         public function testChronologyProtector() {
 194                 // (a) First HTTP request
 195                 $mPos = new MySQLMasterPos( 'db1034-bin.000976', '843431247' );
 196
 197                 $now = microtime( true );
 198                 $mockDB = $this->getMockBuilder( 'DatabaseMysqli' )
 199                         ->disableOriginalConstructor()
 200                         ->getMock();
 201                 $mockDB->method( 'writesOrCallbacksPending' )->willReturn( true );
 202                 $mockDB->method( 'lastDoneWrites' )->willReturn( $now );
 203                 $mockDB->method( 'getMasterPos' )->willReturn( $mPos );
 204
 205                 $lb = $this->getMockBuilder( 'LoadBalancer' )
 206                         ->disableOriginalConstructor()
 207                         ->getMock();
 208                 $lb->method( 'getConnection' )->willReturn( $mockDB );
 209                 $lb->method( 'getServerCount' )->willReturn( 2 );
 210                 $lb->method( 'parentInfo' )->willReturn( [ 'id' => "main-DEFAULT" ] );
 211                 $lb->method( 'getAnyOpenConnection' )->willReturn( $mockDB );
 212                 $lb->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
 213                                 function () use ( $mockDB ) {
 214                                         $p = 0;
 215                                         $p |= call_user_func( [ $mockDB, 'writesOrCallbacksPending' ] );
 216                                         $p |= call_user_func( [ $mockDB, 'lastDoneWrites' ] );
 217
 218                                         return (bool)$p;
 219                                 }
 220                         ) );
 221                 $lb->method( 'getMasterPos' )->willReturn( $mPos );
 222
 223                 $bag = new HashBagOStuff();
 224                 $cp = new ChronologyProtector(
 225                         $bag,
 226                         [
 227                                 'ip' => '127.0.0.1',
 228                                 'agent' => "Totally-Not-FireFox"
 229                         ]
 230                 );
 231
 232                 $mockDB->expects( $this->exactly( 2 ) )->method( 'writesOrCallbacksPending' );
 233                 $mockDB->expects( $this->exactly( 2 ) )->method( 'lastDoneWrites' );
 234
 235                 // Nothing to wait for
 236                 $cp->initLB( $lb );
 237                 // Record in stash
 238                 $cp->shutdownLB( $lb );
 239                 $cp->shutdown();
 240
 241                 // (b) Second HTTP request
 242                 $cp = new ChronologyProtector(
 243                         $bag,
 244                         [
 245                                 'ip' => '127.0.0.1',
 246                                 'agent' => "Totally-Not-FireFox"
 247                         ]
 248                 );
 249
 250                 $lb->expects( $this->once() )
 251                         ->method( 'waitFor' )->with( $this->equalTo( $mPos ) );
 252
 253                 // Wait
 254                 $cp->initLB( $lb );
 255                 // Record in stash
 256                 $cp->shutdownLB( $lb );
 257                 $cp->shutdown();
 258         }
 259
 260         private function newLBFactoryMulti( array $baseOverride = [], array $serverOverride = [] ) {
 261                 global $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, $wgDBtype, $wgSQLiteDataDir;
 262
 263                 return new LBFactoryMulti( $baseOverride + [
 264                         'sectionsByDB' => [],
 265                         'sectionLoads' => [
 266                                 'DEFAULT' => [
 267                                         'test-db1' => 1,
 268                                 ],
 269                         ],
 270                         'serverTemplate' => $serverOverride + [
 271                                 'dbname' => $wgDBname,
 272                                 'user' => $wgDBuser,
 273                                 'password' => $wgDBpassword,
 274                                 'type' => $wgDBtype,
 275                                 'dbDirectory' => $wgSQLiteDataDir,
 276                                 'flags' => DBO_DEFAULT
 277                         ],
 278                         'hostsByName' => [
 279                                 'test-db1' => $wgDBserver,
 280                         ],
 281                         'loadMonitorClass' => 'LoadMonitorNull',
 282                         'localDomain' => wfWikiID()
 283                 ] );
 284         }
 285
 286         public function testNiceDomains() {
 287                 global $wgDBname, $wgDBtype;
 288
 289                 if ( $wgDBtype === 'sqlite' ) {
 290                         $tmpDir = $this->getNewTempDirectory();
 291                         $dbPath = "$tmpDir/unit_test_db.sqlite";
 292                         file_put_contents( $dbPath, '' );
 293                         $tempFsFile = new TempFSFile( $dbPath );
 294                         $tempFsFile->autocollect();
 295                 } else {
 296                         $dbPath = null;
 297                 }
 298
 299                 $factory = $this->newLBFactoryMulti(
 300                         [],
 301                         [ 'dbFilePath' => $dbPath ]
 302                 );
 303                 $lb = $factory->getMainLB();
 304
 305                 if ( $wgDBtype !== 'sqlite' ) {
 306                         $db = $lb->getConnectionRef( DB_MASTER );
 307                         $this->assertEquals(
 308                                 $wgDBname,
 309                                 $db->getDomainID()
 310                         );
 311                         unset( $db );
 312                 }
 313
 314                 /** @var Database $db */
 315                 $db = $lb->getConnection( DB_MASTER, [], '' );
 316                 $lb->reuseConnection( $db ); // don't care
 317
 318                 $this->assertEquals(
 319                         '',
 320                         $db->getDomainID()
 321                 );
 322
 323                 $this->assertEquals(
 324                         $this->quoteTable( $db, 'page' ),
 325                         $db->tableName( 'page' ),
 326                         "Correct full table name"
 327                 );
 328
 329                 $this->assertEquals(
 330                         $this->quoteTable( $db, $wgDBname ) . '.' . $this->quoteTable( $db, 'page' ),
 331                         $db->tableName( "$wgDBname.page" ),
 332                         "Correct full table name"
 333                 );
 334
 335                 $this->assertEquals(
 336                         $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 337                         $db->tableName( 'nice_db.page' ),
 338                         "Correct full table name"
 339                 );
 340
 341                 $factory->setDomainPrefix( 'my_' );
 342                 $this->assertEquals(
 343                         '',
 344                         $db->getDomainID()
 345                 );
 346                 $this->assertEquals(
 347                         $this->quoteTable( $db, 'my_page' ),
 348                         $db->tableName( 'page' ),
 349                         "Correct full table name"
 350                 );
 351                 $this->assertEquals(
 352                         $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 353                         $db->tableName( 'other_nice_db.page' ),
 354                         "Correct full table name"
 355                 );
 356
 357                 $factory->closeAll();
 358                 $factory->destroy();
 359         }
 360
 361         public function testTrickyDomain() {
 362                 global $wgDBtype;
 363
 364                 if ( $wgDBtype === 'sqlite' ) {
 365                         $tmpDir = $this->getNewTempDirectory();
 366                         $dbPath = "$tmpDir/unit_test_db.sqlite";
 367                         file_put_contents( $dbPath, '' );
 368                         $tempFsFile = new TempFSFile( $dbPath );
 369                         $tempFsFile->autocollect();
 370                 } else {
 371                         $dbPath = null;
 372                 }
 373
 374                 $dbname = 'unittest-domain';
 375                 $factory = $this->newLBFactoryMulti(
 376                         [ 'localDomain' => $dbname ],
 377                         [ 'dbname' => $dbname, 'dbFilePath' => $dbPath ]
 378                 );
 379                 $lb = $factory->getMainLB();
 380                 /** @var Database $db */
 381                 $db = $lb->getConnection( DB_MASTER, [], '' );
 382                 $lb->reuseConnection( $db ); // don't care
 383
 384                 $this->assertEquals(
 385                         '',
 386                         $db->getDomainID()
 387                 );
 388
 389                 $this->assertEquals(
 390                         $this->quoteTable( $db, 'page' ),
 391                         $db->tableName( 'page' ),
 392                         "Correct full table name"
 393                 );
 394
 395                 $this->assertEquals(
 396                         $this->quoteTable( $db, $dbname ) . '.' . $this->quoteTable( $db, 'page' ),
 397                         $db->tableName( "$dbname.page" ),
 398                         "Correct full table name"
 399                 );
 400
 401                 $this->assertEquals(
 402                         $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 403                         $db->tableName( 'nice_db.page' ),
 404                         "Correct full table name"
 405                 );
 406
 407                 $factory->setDomainPrefix( 'my_' );
 408
 409                 $this->assertEquals(
 410                         $this->quoteTable( $db, 'my_page' ),
 411                         $db->tableName( 'page' ),
 412                         "Correct full table name"
 413                 );
 414                 $this->assertEquals(
 415                         $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 416                         $db->tableName( 'other_nice_db.page' ),
 417                         "Correct full table name"
 418                 );
 419
 420                 $this->assertEquals(
 421                         $this->quoteTable( $db, 'garbage-db' ) . '.' . $this->quoteTable( $db, 'page' ),
 422                         $db->tableName( 'garbage-db.page' ),
 423                         "Correct full table name"
 424                 );
 425
 426                 if ( $db->databasesAreIndependent() ) {
 427                         try {
 428                                 $e = null;
 429                                 $db->selectDB( 'garbage-db' );
 430                         } catch ( \Wikimedia\Rdbms\DBConnectionError $e ) {
 431                                 // expected
 432                         }
 433                         $this->assertInstanceOf( '\Wikimedia\Rdbms\DBConnectionError', $e );
 434                         $this->assertFalse( $db->isOpen() );
 435                 } else {
 436                         \MediaWiki\suppressWarnings();
 437                         $this->assertFalse( $db->selectDB( 'garbage-db' ) );
 438                         \MediaWiki\restoreWarnings();
 439                 }
 440
 441                 $factory->closeAll();
 442                 $factory->destroy();
 443         }
 444
 445         private function quoteTable( Database $db, $table ) {
 446                 if ( $db->getType() === 'sqlite' ) {
 447                         return $table;
 448                 } else {
 449                         return $db->addIdentifierQuotes( $table );
 450                 }
 451         }
 452 }