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