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\IDatabase;
  27 use Wikimedia\Rdbms\IMaintainableDatabase;
  28 use Wikimedia\Rdbms\LBFactory;
  29 use Wikimedia\Rdbms\LBFactorySimple;
  30 use Wikimedia\Rdbms\LBFactoryMulti;
  31 use Wikimedia\Rdbms\LoadBalancer;
  32 use Wikimedia\Rdbms\ChronologyProtector;
  33 use Wikimedia\Rdbms\DatabaseMysqli;
  34 use Wikimedia\Rdbms\MySQLMasterPos;
  35 use Wikimedia\Rdbms\DatabaseDomain;
  36
  37 /**
  38  * @group Database
  39  * @covers \Wikimedia\Rdbms\LBFactory
  40  * @covers \Wikimedia\Rdbms\LBFactorySimple
  41  * @covers \Wikimedia\Rdbms\LBFactoryMulti
  42  */
  43 class LBFactoryTest extends MediaWikiTestCase {
  44
  45         /**
  46          * @covers MWLBFactory::getLBFactoryClass()
  47          * @dataProvider getLBFactoryClassProvider
  48          */
  49         public function testGetLBFactoryClass( $expected, $deprecated ) {
  50                 $mockDB = $this->getMockBuilder( DatabaseMysqli::class )
  51                         ->disableOriginalConstructor()
  52                         ->getMock();
  53
  54                 $config = [
  55                         'class'          => $deprecated,
  56                         'connection'     => $mockDB,
  57                         # Various other parameters required:
  58                         'sectionsByDB'   => [],
  59                         'sectionLoads'   => [],
  60                         'serverTemplate' => [],
  61                 ];
  62
  63                 $this->hideDeprecated( '$wgLBFactoryConf must be updated. See RELEASE-NOTES for details' );
  64                 $result = MWLBFactory::getLBFactoryClass( $config );
  65
  66                 $this->assertEquals( $expected, $result );
  67         }
  68
  69         public function getLBFactoryClassProvider() {
  70                 return [
  71                         # Format: new class, old class
  72                         [ Wikimedia\Rdbms\LBFactorySimple::class, 'LBFactory_Simple' ],
  73                         [ Wikimedia\Rdbms\LBFactorySingle::class, 'LBFactory_Single' ],
  74                         [ Wikimedia\Rdbms\LBFactoryMulti::class, 'LBFactory_Multi' ],
  75                         [ Wikimedia\Rdbms\LBFactorySimple::class, 'LBFactorySimple' ],
  76                         [ Wikimedia\Rdbms\LBFactorySingle::class, 'LBFactorySingle' ],
  77                         [ Wikimedia\Rdbms\LBFactoryMulti::class, 'LBFactoryMulti' ],
  78                 ];
  79         }
  80
  81         /**
  82          * @covers \Wikimedia\Rdbms\LBFactory::getLocalDomainID()
  83          * @covers \Wikimedia\Rdbms\LBFactory::resolveDomainID()
  84          */
  85         public function testLBFactorySimpleServer() {
  86                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
  87
  88                 $servers = [
  89                         [
  90                                 'host'        => $wgDBserver,
  91                                 'dbname'      => $wgDBname,
  92                                 'user'        => $wgDBuser,
  93                                 'password'    => $wgDBpassword,
  94                                 'type'        => $wgDBtype,
  95                                 'dbDirectory' => $wgSQLiteDataDir,
  96                                 'load'        => 0,
  97                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
  98                         ],
  99                 ];
 100
 101                 $factory = new LBFactorySimple( [ 'servers' => $servers ] );
 102                 $lb = $factory->getMainLB();
 103
 104                 $dbw = $lb->getConnection( DB_MASTER );
 105                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
 106
 107                 $dbr = $lb->getConnection( DB_REPLICA );
 108                 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
 109
 110                 $this->assertSame( 'my_test_wiki', $factory->resolveDomainID( 'my_test_wiki' ) );
 111                 $this->assertSame( $factory->getLocalDomainID(), $factory->resolveDomainID( false ) );
 112
 113                 $factory->shutdown();
 114                 $lb->closeAll();
 115         }
 116
 117         public function testLBFactorySimpleServers() {
 118                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
 119
 120                 $servers = [
 121                         [ // master
 122                                 'host'        => $wgDBserver,
 123                                 'dbname'      => $wgDBname,
 124                                 'user'        => $wgDBuser,
 125                                 'password'    => $wgDBpassword,
 126                                 'type'        => $wgDBtype,
 127                                 'dbDirectory' => $wgSQLiteDataDir,
 128                                 'load'        => 0,
 129                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
 130                         ],
 131                         [ // emulated replica
 132                                 'host'        => $wgDBserver,
 133                                 'dbname'      => $wgDBname,
 134                                 'user'        => $wgDBuser,
 135                                 'password'    => $wgDBpassword,
 136                                 'type'        => $wgDBtype,
 137                                 'dbDirectory' => $wgSQLiteDataDir,
 138                                 'load'        => 100,
 139                                 'flags'       => DBO_TRX // REPEATABLE-READ for consistency
 140                         ]
 141                 ];
 142
 143                 $factory = new LBFactorySimple( [
 144                         'servers' => $servers,
 145                         'loadMonitorClass' => LoadMonitorNull::class
 146                 ] );
 147                 $lb = $factory->getMainLB();
 148
 149                 $dbw = $lb->getConnection( DB_MASTER );
 150                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
 151                 $this->assertEquals(
 152                         ( $wgDBserver != '' ) ? $wgDBserver : 'localhost',
 153                         $dbw->getLBInfo( 'clusterMasterHost' ),
 154                         'cluster master set' );
 155
 156                 $dbr = $lb->getConnection( DB_REPLICA );
 157                 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
 158                 $this->assertEquals(
 159                         ( $wgDBserver != '' ) ? $wgDBserver : 'localhost',
 160                         $dbr->getLBInfo( 'clusterMasterHost' ),
 161                         'cluster master set' );
 162
 163                 $factory->shutdown();
 164                 $lb->closeAll();
 165         }
 166
 167         public function testLBFactoryMultiConns() {
 168                 $factory = $this->newLBFactoryMultiLBs();
 169
 170                 $dbw = $factory->getMainLB()->getConnection( DB_MASTER );
 171                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
 172
 173                 $dbr = $factory->getMainLB()->getConnection( DB_REPLICA );
 174                 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
 175
 176                 // Destructor should trigger without round stage errors
 177                 unset( $factory );
 178         }
 179
 180         public function testLBFactoryMultiRoundCallbacks() {
 181                 $called = 0;
 182                 $countLBsFunc = function ( LBFactoryMulti $factory ) {
 183                         $count = 0;
 184                         $factory->forEachLB( function () use ( &$count ) {
 185                                 ++$count;
 186                         } );
 187
 188                         return $count;
 189                 };
 190
 191                 $factory = $this->newLBFactoryMultiLBs();
 192                 $this->assertEquals( 0, $countLBsFunc( $factory ) );
 193                 $dbw = $factory->getMainLB()->getConnection( DB_MASTER );
 194                 $this->assertEquals( 1, $countLBsFunc( $factory ) );
 195                 // Test that LoadBalancer instances made during pre-commit callbacks in do not
 196                 // throw DBTransactionError due to transaction ROUND_* stages being mismatched.
 197                 $factory->beginMasterChanges( __METHOD__ );
 198                 $dbw->onTransactionPreCommitOrIdle( function () use ( $factory, &$called ) {
 199                         ++$called;
 200                         // Trigger s1 LoadBalancer instantiation during "finalize" stage.
 201                         // There is no s1wiki DB to select so it is not in getConnection(),
 202                         // but this fools getMainLB() at least.
 203                         $factory->getMainLB( 's1wiki' )->getConnection( DB_MASTER );
 204                 } );
 205                 $factory->commitMasterChanges( __METHOD__ );
 206                 $this->assertEquals( 1, $called );
 207                 $this->assertEquals( 2, $countLBsFunc( $factory ) );
 208                 $factory->shutdown();
 209                 $factory->closeAll();
 210
 211                 $called = 0;
 212                 $factory = $this->newLBFactoryMultiLBs();
 213                 $this->assertEquals( 0, $countLBsFunc( $factory ) );
 214                 $dbw = $factory->getMainLB()->getConnection( DB_MASTER );
 215                 $this->assertEquals( 1, $countLBsFunc( $factory ) );
 216                 // Test that LoadBalancer instances made during pre-commit callbacks in do not
 217                 // throw DBTransactionError due to transaction ROUND_* stages being mismatched.hrow
 218                 // DBTransactionError due to transaction ROUND_* stages being mismatched.
 219                 $factory->beginMasterChanges( __METHOD__ );
 220                 $dbw->query( "SELECT 1 as t", __METHOD__ );
 221                 $dbw->onTransactionResolution( function () use ( $factory, &$called ) {
 222                         ++$called;
 223                         // Trigger s1 LoadBalancer instantiation during "finalize" stage.
 224                         // There is no s1wiki DB to select so it is not in getConnection(),
 225                         // but this fools getMainLB() at least.
 226                         $factory->getMainLB( 's1wiki' )->getConnection( DB_MASTER );
 227                 } );
 228                 $factory->commitMasterChanges( __METHOD__ );
 229                 $this->assertEquals( 1, $called );
 230                 $this->assertEquals( 2, $countLBsFunc( $factory ) );
 231                 $factory->shutdown();
 232                 $factory->closeAll();
 233
 234                 $factory = $this->newLBFactoryMultiLBs();
 235                 $dbw = $factory->getMainLB()->getConnection( DB_MASTER );
 236                 // DBTransactionError should not be thrown
 237                 $ran = 0;
 238                 $dbw->onTransactionPreCommitOrIdle( function () use ( &$ran ) {
 239                         ++$ran;
 240                 } );
 241                 $factory->commitAll( __METHOD__ );
 242                 $this->assertEquals( 1, $ran );
 243
 244                 $factory->shutdown();
 245                 $factory->closeAll();
 246         }
 247
 248         private function newLBFactoryMultiLBs() {
 249                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
 250
 251                 return new LBFactoryMulti( [
 252                         'sectionsByDB' => [
 253                                 's1wiki' => 's1',
 254                         ],
 255                         'sectionLoads' => [
 256                                 's1' => [
 257                                         'test-db3' => 0,
 258                                         'test-db4' => 100,
 259                                 ],
 260                                 'DEFAULT' => [
 261                                         'test-db1' => 0,
 262                                         'test-db2' => 100,
 263                                 ]
 264                         ],
 265                         'serverTemplate' => [
 266                                 'dbname' => $wgDBname,
 267                                 'user' => $wgDBuser,
 268                                 'password' => $wgDBpassword,
 269                                 'type' => $wgDBtype,
 270                                 'dbDirectory' => $wgSQLiteDataDir,
 271                                 'flags' => DBO_DEFAULT
 272                         ],
 273                         'hostsByName' => [
 274                                 'test-db1' => $wgDBserver,
 275                                 'test-db2' => $wgDBserver,
 276                                 'test-db3' => $wgDBserver,
 277                                 'test-db4' => $wgDBserver
 278                         ],
 279                         'loadMonitorClass' => LoadMonitorNull::class
 280                 ] );
 281         }
 282
 283         /**
 284          * @covers \Wikimedia\Rdbms\ChronologyProtector
 285          */
 286         public function testChronologyProtector() {
 287                 $now = microtime( true );
 288
 289                 // (a) First HTTP request
 290                 $m1Pos = new MySQLMasterPos( 'db1034-bin.000976/843431247', $now );
 291                 $m2Pos = new MySQLMasterPos( 'db1064-bin.002400/794074907', $now );
 292
 293                 // Master DB 1
 294                 $mockDB1 = $this->getMockBuilder( DatabaseMysqli::class )
 295                         ->disableOriginalConstructor()
 296                         ->getMock();
 297                 $mockDB1->method( 'writesOrCallbacksPending' )->willReturn( true );
 298                 $mockDB1->method( 'lastDoneWrites' )->willReturn( $now );
 299                 $mockDB1->method( 'getMasterPos' )->willReturn( $m1Pos );
 300                 // Load balancer for master DB 1
 301                 $lb1 = $this->getMockBuilder( LoadBalancer::class )
 302                         ->disableOriginalConstructor()
 303                         ->getMock();
 304                 $lb1->method( 'getConnection' )->willReturn( $mockDB1 );
 305                 $lb1->method( 'getServerCount' )->willReturn( 2 );
 306                 $lb1->method( 'getAnyOpenConnection' )->willReturn( $mockDB1 );
 307                 $lb1->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
 308                                 function () use ( $mockDB1 ) {
 309                                         $p = 0;
 310                                         $p |= call_user_func( [ $mockDB1, 'writesOrCallbacksPending' ] );
 311                                         $p |= call_user_func( [ $mockDB1, 'lastDoneWrites' ] );
 312
 313                                         return (bool)$p;
 314                                 }
 315                         ) );
 316                 $lb1->method( 'getMasterPos' )->willReturn( $m1Pos );
 317                 $lb1->method( 'getServerName' )->with( 0 )->willReturn( 'master1' );
 318                 // Master DB 2
 319                 $mockDB2 = $this->getMockBuilder( DatabaseMysqli::class )
 320                         ->disableOriginalConstructor()
 321                         ->getMock();
 322                 $mockDB2->method( 'writesOrCallbacksPending' )->willReturn( true );
 323                 $mockDB2->method( 'lastDoneWrites' )->willReturn( $now );
 324                 $mockDB2->method( 'getMasterPos' )->willReturn( $m2Pos );
 325                 // Load balancer for master DB 2
 326                 $lb2 = $this->getMockBuilder( LoadBalancer::class )
 327                         ->disableOriginalConstructor()
 328                         ->getMock();
 329                 $lb2->method( 'getConnection' )->willReturn( $mockDB2 );
 330                 $lb2->method( 'getServerCount' )->willReturn( 2 );
 331                 $lb2->method( 'getAnyOpenConnection' )->willReturn( $mockDB2 );
 332                 $lb2->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
 333                         function () use ( $mockDB2 ) {
 334                                 $p = 0;
 335                                 $p |= call_user_func( [ $mockDB2, 'writesOrCallbacksPending' ] );
 336                                 $p |= call_user_func( [ $mockDB2, 'lastDoneWrites' ] );
 337
 338                                 return (bool)$p;
 339                         }
 340                 ) );
 341                 $lb2->method( 'getMasterPos' )->willReturn( $m2Pos );
 342                 $lb2->method( 'getServerName' )->with( 0 )->willReturn( 'master2' );
 343
 344                 $bag = new HashBagOStuff();
 345                 $cp = new ChronologyProtector(
 346                         $bag,
 347                         [
 348                                 'ip' => '127.0.0.1',
 349                                 'agent' => "Totally-Not-FireFox"
 350                         ],
 351                         null
 352                 );
 353
 354                 $mockDB1->expects( $this->exactly( 1 ) )->method( 'writesOrCallbacksPending' );
 355                 $mockDB1->expects( $this->exactly( 1 ) )->method( 'lastDoneWrites' );
 356                 $mockDB2->expects( $this->exactly( 1 ) )->method( 'writesOrCallbacksPending' );
 357                 $mockDB2->expects( $this->exactly( 1 ) )->method( 'lastDoneWrites' );
 358
 359                 // Nothing to wait for on first HTTP request start
 360                 $cp->initLB( $lb1 );
 361                 $cp->initLB( $lb2 );
 362                 // Record positions in stash on first HTTP request end
 363                 $cp->shutdownLB( $lb1 );
 364                 $cp->shutdownLB( $lb2 );
 365                 $cpIndex = null;
 366                 $cp->shutdown( null, 'sync', $cpIndex );
 367
 368                 $this->assertEquals( 1, $cpIndex, "CP write index set" );
 369
 370                 // (b) Second HTTP request
 371
 372                 // Load balancer for master DB 1
 373                 $lb1 = $this->getMockBuilder( LoadBalancer::class )
 374                         ->disableOriginalConstructor()
 375                         ->getMock();
 376                 $lb1->method( 'getServerCount' )->willReturn( 2 );
 377                 $lb1->method( 'getServerName' )->with( 0 )->willReturn( 'master1' );
 378                 $lb1->expects( $this->once() )
 379                         ->method( 'waitFor' )->with( $this->equalTo( $m1Pos ) );
 380                 // Load balancer for master DB 2
 381                 $lb2 = $this->getMockBuilder( LoadBalancer::class )
 382                         ->disableOriginalConstructor()
 383                         ->getMock();
 384                 $lb2->method( 'getServerCount' )->willReturn( 2 );
 385                 $lb2->method( 'getServerName' )->with( 0 )->willReturn( 'master2' );
 386                 $lb2->expects( $this->once() )
 387                         ->method( 'waitFor' )->with( $this->equalTo( $m2Pos ) );
 388
 389                 $cp = new ChronologyProtector(
 390                         $bag,
 391                         [
 392                                 'ip' => '127.0.0.1',
 393                                 'agent' => "Totally-Not-FireFox"
 394                         ],
 395                         $cpIndex
 396                 );
 397
 398                 // Wait for last positions to be reached on second HTTP request start
 399                 $cp->initLB( $lb1 );
 400                 $cp->initLB( $lb2 );
 401                 // Shutdown (nothing to record)
 402                 $cp->shutdownLB( $lb1 );
 403                 $cp->shutdownLB( $lb2 );
 404                 $cpIndex = null;
 405                 $cp->shutdown( null, 'sync', $cpIndex );
 406
 407                 $this->assertEquals( null, $cpIndex, "CP write index retained" );
 408
 409                 $this->assertEquals( '45e93a9c215c031d38b7c42d8e4700ca', $cp->getClientId() );
 410         }
 411
 412         private function newLBFactoryMulti( array $baseOverride = [], array $serverOverride = [] ) {
 413                 global $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, $wgDBprefix, $wgDBtype;
 414                 global $wgSQLiteDataDir;
 415
 416                 return new LBFactoryMulti( $baseOverride + [
 417                         'sectionsByDB' => [],
 418                         'sectionLoads' => [
 419                                 'DEFAULT' => [
 420                                         'test-db1' => 1,
 421                                 ],
 422                         ],
 423                         'serverTemplate' => $serverOverride + [
 424                                 'dbname' => $wgDBname,
 425                                 'tablePrefix' => $wgDBprefix,
 426                                 'user' => $wgDBuser,
 427                                 'password' => $wgDBpassword,
 428                                 'type' => $wgDBtype,
 429                                 'dbDirectory' => $wgSQLiteDataDir,
 430                                 'flags' => DBO_DEFAULT
 431                         ],
 432                         'hostsByName' => [
 433                                 'test-db1' => $wgDBserver,
 434                         ],
 435                         'loadMonitorClass' => LoadMonitorNull::class,
 436                         'localDomain' => new DatabaseDomain( $wgDBname, null, $wgDBprefix ),
 437                         'agent' => 'MW-UNIT-TESTS'
 438                 ] );
 439         }
 440
 441         /**
 442          * @covers \Wikimedia\Rdbms\LoadBalancer::getConnection
 443          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::doSelectDomain
 444          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::selectDB
 445          * @covers \Wikimedia\Rdbms\DatabaseMssql::selectDB
 446          * @covers DatabaseOracle::selectDB
 447          */
 448         public function testNiceDomains() {
 449                 global $wgDBname;
 450
 451                 if ( wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 452                         self::markTestSkipped( "Skipping tests about selecting DBs: not applicable" );
 453                         return;
 454                 }
 455
 456                 $factory = $this->newLBFactoryMulti(
 457                         [],
 458                         []
 459                 );
 460                 $lb = $factory->getMainLB();
 461
 462                 $db = $lb->getConnectionRef( DB_MASTER );
 463                 $this->assertEquals(
 464                         wfWikiID(),
 465                         $db->getDomainID()
 466                 );
 467                 unset( $db );
 468
 469                 /** @var IMaintainableDatabase $db */
 470                 $db = $lb->getConnection( DB_MASTER, [], '' );
 471
 472                 $this->assertEquals(
 473                         '',
 474                         $db->getDomainId(),
 475                         'Null domain ID handle used'
 476                 );
 477                 $this->assertEquals(
 478                         '',
 479                         $db->getDBname(),
 480                         'Null domain ID handle used'
 481                 );
 482                 $this->assertEquals(
 483                         '',
 484                         $db->tablePrefix(),
 485                         'Main domain ID handle used; prefix is empty though'
 486                 );
 487                 $this->assertEquals(
 488                         $this->quoteTable( $db, 'page' ),
 489                         $db->tableName( 'page' ),
 490                         "Correct full table name"
 491                 );
 492                 $this->assertEquals(
 493                         $this->quoteTable( $db, $wgDBname ) . '.' . $this->quoteTable( $db, 'page' ),
 494                         $db->tableName( "$wgDBname.page" ),
 495                         "Correct full table name"
 496                 );
 497                 $this->assertEquals(
 498                         $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 499                         $db->tableName( 'nice_db.page' ),
 500                         "Correct full table name"
 501                 );
 502
 503                 $lb->reuseConnection( $db ); // don't care
 504
 505                 $db = $lb->getConnection( DB_MASTER ); // local domain connection
 506                 $factory->setLocalDomainPrefix( 'my_' );
 507
 508                 $this->assertEquals( $wgDBname, $db->getDBname() );
 509                 $this->assertEquals(
 510                         "$wgDBname-my_",
 511                         $db->getDomainID()
 512                 );
 513                 $this->assertEquals(
 514                         $this->quoteTable( $db, 'my_page' ),
 515                         $db->tableName( 'page' ),
 516                         "Correct full table name"
 517                 );
 518                 $this->assertEquals(
 519                         $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 520                         $db->tableName( 'other_nice_db.page' ),
 521                         "Correct full table name"
 522                 );
 523
 524                 $factory->closeAll();
 525                 $factory->destroy();
 526         }
 527
 528         /**
 529          * @covers \Wikimedia\Rdbms\LoadBalancer::getConnection
 530          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::doSelectDomain
 531          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::selectDB
 532          * @covers \Wikimedia\Rdbms\DatabaseMssql::selectDB
 533          * @covers DatabaseOracle::selectDB
 534          */
 535         public function testTrickyDomain() {
 536                 global $wgDBname;
 537
 538                 if ( wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 539                         self::markTestSkipped( "Skipping tests about selecting DBs: not applicable" );
 540                         return;
 541                 }
 542
 543                 $dbname = 'unittest-domain'; // explodes if DB is selected
 544                 $factory = $this->newLBFactoryMulti(
 545                         [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
 546                         [
 547                                 'dbname' => 'do_not_select_me' // explodes if DB is selected
 548                         ]
 549                 );
 550                 $lb = $factory->getMainLB();
 551                 /** @var IMaintainableDatabase $db */
 552                 $db = $lb->getConnection( DB_MASTER, [], '' );
 553
 554                 $this->assertEquals( '', $db->getDomainID(), "Null domain used" );
 555
 556                 $this->assertEquals(
 557                         $this->quoteTable( $db, 'page' ),
 558                         $db->tableName( 'page' ),
 559                         "Correct full table name"
 560                 );
 561
 562                 $this->assertEquals(
 563                         $this->quoteTable( $db, $dbname ) . '.' . $this->quoteTable( $db, 'page' ),
 564                         $db->tableName( "$dbname.page" ),
 565                         "Correct full table name"
 566                 );
 567
 568                 $this->assertEquals(
 569                         $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 570                         $db->tableName( 'nice_db.page' ),
 571                         "Correct full table name"
 572                 );
 573
 574                 $lb->reuseConnection( $db ); // don't care
 575
 576                 $factory->setLocalDomainPrefix( 'my_' );
 577                 $db = $lb->getConnection( DB_MASTER, [], "$wgDBname-my_" );
 578
 579                 $this->assertEquals(
 580                         $this->quoteTable( $db, 'my_page' ),
 581                         $db->tableName( 'page' ),
 582                         "Correct full table name"
 583                 );
 584                 $this->assertEquals(
 585                         $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 586                         $db->tableName( 'other_nice_db.page' ),
 587                         "Correct full table name"
 588                 );
 589                 $this->assertEquals(
 590                         $this->quoteTable( $db, 'garbage-db' ) . '.' . $this->quoteTable( $db, 'page' ),
 591                         $db->tableName( 'garbage-db.page' ),
 592                         "Correct full table name"
 593                 );
 594
 595                 $lb->reuseConnection( $db ); // don't care
 596
 597                 $factory->closeAll();
 598                 $factory->destroy();
 599         }
 600
 601         /**
 602          * @covers \Wikimedia\Rdbms\LoadBalancer::getConnection
 603          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::doSelectDomain
 604          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::selectDB
 605          * @covers \Wikimedia\Rdbms\DatabaseMssql::selectDB
 606          * @covers DatabaseOracle::selectDB
 607          */
 608         public function testInvalidSelectDB() {
 609                 if ( wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 610                         $this->markTestSkipped( "Not applicable per databasesAreIndependent()" );
 611                 }
 612
 613                 $dbname = 'unittest-domain'; // explodes if DB is selected
 614                 $factory = $this->newLBFactoryMulti(
 615                         [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
 616                         [
 617                                 'dbname' => 'do_not_select_me' // explodes if DB is selected
 618                         ]
 619                 );
 620                 $lb = $factory->getMainLB();
 621                 /** @var IDatabase $db */
 622                 $db = $lb->getConnection( DB_MASTER, [], '' );
 623
 624                 \Wikimedia\suppressWarnings();
 625                 try {
 626                         $this->assertFalse( $db->selectDB( 'garbage-db' ) );
 627                         $this->fail( "No error thrown." );
 628                 } catch ( \Wikimedia\Rdbms\DBQueryError $e ) {
 629                         $this->assertRegExp( '/[\'"]garbage-db[\'"]/', $e->getMessage() );
 630                 }
 631                 \Wikimedia\restoreWarnings();
 632         }
 633
 634         /**
 635          * @covers \Wikimedia\Rdbms\DatabaseSqlite::selectDB
 636          * @covers \Wikimedia\Rdbms\DatabasePostgres::selectDB
 637          * @expectedException \Wikimedia\Rdbms\DBConnectionError
 638          */
 639         public function testInvalidSelectDBIndependant() {
 640                 $dbname = 'unittest-domain'; // explodes if DB is selected
 641                 $factory = $this->newLBFactoryMulti(
 642                         [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
 643                         [
 644                                 'dbname' => 'do_not_select_me' // explodes if DB is selected
 645                         ]
 646                 );
 647                 $lb = $factory->getMainLB();
 648
 649                 if ( !wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 650                         $this->markTestSkipped( "Not applicable per databasesAreIndependent()" );
 651                 }
 652
 653                 /** @var IDatabase $db */
 654                 $lb->getConnection( DB_MASTER, [], '' );
 655         }
 656
 657         /**
 658          * @covers \Wikimedia\Rdbms\DatabaseSqlite::selectDB
 659          * @covers \Wikimedia\Rdbms\DatabasePostgres::selectDB
 660          * @expectedException \Wikimedia\Rdbms\DBConnectionError
 661          */
 662         public function testInvalidSelectDBIndependant2() {
 663                 $dbname = 'unittest-domain'; // explodes if DB is selected
 664                 $factory = $this->newLBFactoryMulti(
 665                         [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
 666                         [
 667                                 'dbname' => 'do_not_select_me' // explodes if DB is selected
 668                         ]
 669                 );
 670                 $lb = $factory->getMainLB();
 671
 672                 if ( !wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 673                         $this->markTestSkipped( "Not applicable per databasesAreIndependent()" );
 674                 }
 675
 676                 $db = $lb->getConnection( DB_MASTER );
 677                 \Wikimedia\suppressWarnings();
 678                 $db->selectDB( 'garbage-db' );
 679                 \Wikimedia\restoreWarnings();
 680         }
 681
 682         /**
 683          * @covers \Wikimedia\Rdbms\LoadBalancer::getConnection
 684          * @covers \Wikimedia\Rdbms\LoadBalancer::redefineLocalDomain
 685          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::selectDB
 686          * @covers \Wikimedia\Rdbms\DatabaseMssql::selectDB
 687          * @covers DatabaseOracle::selectDB
 688          */
 689         public function testRedefineLocalDomain() {
 690                 global $wgDBname;
 691
 692                 if ( wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 693                         self::markTestSkipped( "Skipping tests about selecting DBs: not applicable" );
 694                         return;
 695                 }
 696
 697                 $factory = $this->newLBFactoryMulti(
 698                         [],
 699                         []
 700                 );
 701                 $lb = $factory->getMainLB();
 702
 703                 $conn1 = $lb->getConnectionRef( DB_MASTER );
 704                 $this->assertEquals(
 705                         wfWikiID(),
 706                         $conn1->getDomainID()
 707                 );
 708                 unset( $conn1 );
 709
 710                 $factory->redefineLocalDomain( 'somedb-prefix_' );
 711                 $this->assertEquals( 'somedb-prefix_', $factory->getLocalDomainID() );
 712
 713                 $domain = new DatabaseDomain( $wgDBname, null, 'pref_' );
 714                 $factory->redefineLocalDomain( $domain );
 715
 716                 $n = 0;
 717                 $lb->forEachOpenConnection( function () use ( &$n ) {
 718                         ++$n;
 719                 } );
 720                 $this->assertEquals( 0, $n, "Connections closed" );
 721
 722                 $conn2 = $lb->getConnectionRef( DB_MASTER );
 723                 $this->assertEquals(
 724                         $domain->getId(),
 725                         $conn2->getDomainID()
 726                 );
 727                 unset( $conn2 );
 728
 729                 $factory->closeAll();
 730                 $factory->destroy();
 731         }
 732
 733         private function quoteTable( IDatabase $db, $table ) {
 734                 if ( $db->getType() === 'sqlite' ) {
 735                         return $table;
 736                 } else {
 737                         return $db->addIdentifierQuotes( $table );
 738                 }
 739         }
 740
 741         /**
 742          * @covers \Wikimedia\Rdbms\LBFactory::makeCookieValueFromCPIndex()
 743          * @covers \Wikimedia\Rdbms\LBFactory::getCPInfoFromCookieValue()
 744          */
 745         public function testCPPosIndexCookieValues() {
 746                 $time = 1526522031;
 747                 $agentId = md5( 'Ramsey\'s Loyal Presa Canario' );
 748
 749                 $this->assertEquals(
 750                         '3@542#c47dcfb0566e7d7bc110a6128a45c93a',
 751                         LBFactory::makeCookieValueFromCPIndex( 3, 542, $agentId )
 752                 );
 753
 754                 $lbFactory = $this->newLBFactoryMulti();
 755                 $lbFactory->setRequestInfo( [ 'IPAddress' => '10.64.24.52', 'UserAgent' => 'meow' ] );
 756                 $this->assertEquals(
 757                         '1@542#c47dcfb0566e7d7bc110a6128a45c93a',
 758                         LBFactory::makeCookieValueFromCPIndex( 1, 542, $agentId )
 759                 );
 760
 761                 $this->assertSame(
 762                         null,
 763                         LBFactory::getCPInfoFromCookieValue( "5#$agentId", $time - 10 )['index'],
 764                         'No time set'
 765                 );
 766                 $this->assertSame(
 767                         null,
 768                         LBFactory::getCPInfoFromCookieValue( "5@$time", $time - 10 )['index'],
 769                         'No agent set'
 770                 );
 771                 $this->assertSame(
 772                         null,
 773                         LBFactory::getCPInfoFromCookieValue( "0@$time#$agentId", $time - 10 )['index'],
 774                         'Bad index'
 775                 );
 776
 777                 $this->assertSame(
 778                         2,
 779                         LBFactory::getCPInfoFromCookieValue( "2@$time#$agentId", $time - 10 )['index'],
 780                         'Fresh'
 781                 );
 782                 $this->assertSame(
 783                         2,
 784                         LBFactory::getCPInfoFromCookieValue( "2@$time#$agentId", $time + 9 - 10 )['index'],
 785                         'Almost stale'
 786                 );
 787                 $this->assertSame(
 788                         null,
 789                         LBFactory::getCPInfoFromCookieValue( "0@$time#$agentId", $time + 9 - 10 )['index'],
 790                         'Almost stale; bad index'
 791                 );
 792                 $this->assertSame(
 793                         null,
 794                         LBFactory::getCPInfoFromCookieValue( "2@$time#$agentId", $time + 11 - 10 )['index'],
 795                         'Stale'
 796                 );
 797
 798                 $this->assertSame(
 799                         $agentId,
 800                         LBFactory::getCPInfoFromCookieValue( "5@$time#$agentId", $time - 10 )['clientId'],
 801                         'Live (client ID)'
 802                 );
 803                 $this->assertSame(
 804                         null,
 805                         LBFactory::getCPInfoFromCookieValue( "5@$time#$agentId", $time + 11 - 10 )['clientId'],
 806                         'Stale (client ID)'
 807                 );
 808         }
 809 }