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 use Wikimedia\Rdbms\LoadMonitorNull;
  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( IDatabase::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         }
 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         }
 164
 165         public function testLBFactoryMultiConns() {
 166                 $factory = $this->newLBFactoryMultiLBs();
 167
 168                 $dbw = $factory->getMainLB()->getConnection( DB_MASTER );
 169                 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
 170
 171                 $dbr = $factory->getMainLB()->getConnection( DB_REPLICA );
 172                 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
 173
 174                 // Destructor should trigger without round stage errors
 175                 unset( $factory );
 176         }
 177
 178         public function testLBFactoryMultiRoundCallbacks() {
 179                 $called = 0;
 180                 $countLBsFunc = function ( LBFactoryMulti $factory ) {
 181                         $count = 0;
 182                         $factory->forEachLB( function () use ( &$count ) {
 183                                 ++$count;
 184                         } );
 185
 186                         return $count;
 187                 };
 188
 189                 $factory = $this->newLBFactoryMultiLBs();
 190                 $this->assertEquals( 0, $countLBsFunc( $factory ) );
 191                 $dbw = $factory->getMainLB()->getConnection( DB_MASTER );
 192                 $this->assertEquals( 1, $countLBsFunc( $factory ) );
 193                 // Test that LoadBalancer instances made during pre-commit callbacks in do not
 194                 // throw DBTransactionError due to transaction ROUND_* stages being mismatched.
 195                 $factory->beginMasterChanges( __METHOD__ );
 196                 $dbw->onTransactionPreCommitOrIdle( function () use ( $factory, &$called ) {
 197                         ++$called;
 198                         // Trigger s1 LoadBalancer instantiation during "finalize" stage.
 199                         // There is no s1wiki DB to select so it is not in getConnection(),
 200                         // but this fools getMainLB() at least.
 201                         $factory->getMainLB( 's1wiki' )->getConnection( DB_MASTER );
 202                 } );
 203                 $factory->commitMasterChanges( __METHOD__ );
 204                 $this->assertEquals( 1, $called );
 205                 $this->assertEquals( 2, $countLBsFunc( $factory ) );
 206                 $factory->shutdown();
 207                 $factory->closeAll();
 208
 209                 $called = 0;
 210                 $factory = $this->newLBFactoryMultiLBs();
 211                 $this->assertEquals( 0, $countLBsFunc( $factory ) );
 212                 $dbw = $factory->getMainLB()->getConnection( DB_MASTER );
 213                 $this->assertEquals( 1, $countLBsFunc( $factory ) );
 214                 // Test that LoadBalancer instances made during pre-commit callbacks in do not
 215                 // throw DBTransactionError due to transaction ROUND_* stages being mismatched.hrow
 216                 // DBTransactionError due to transaction ROUND_* stages being mismatched.
 217                 $factory->beginMasterChanges( __METHOD__ );
 218                 $dbw->query( "SELECT 1 as t", __METHOD__ );
 219                 $dbw->onTransactionResolution( function () use ( $factory, &$called ) {
 220                         ++$called;
 221                         // Trigger s1 LoadBalancer instantiation during "finalize" stage.
 222                         // There is no s1wiki DB to select so it is not in getConnection(),
 223                         // but this fools getMainLB() at least.
 224                         $factory->getMainLB( 's1wiki' )->getConnection( DB_MASTER );
 225                 } );
 226                 $factory->commitMasterChanges( __METHOD__ );
 227                 $this->assertEquals( 1, $called );
 228                 $this->assertEquals( 2, $countLBsFunc( $factory ) );
 229                 $factory->shutdown();
 230                 $factory->closeAll();
 231
 232                 $factory = $this->newLBFactoryMultiLBs();
 233                 $dbw = $factory->getMainLB()->getConnection( DB_MASTER );
 234                 // DBTransactionError should not be thrown
 235                 $ran = 0;
 236                 $dbw->onTransactionPreCommitOrIdle( function () use ( &$ran ) {
 237                         ++$ran;
 238                 } );
 239                 $factory->commitAll( __METHOD__ );
 240                 $this->assertEquals( 1, $ran );
 241
 242                 $factory->shutdown();
 243                 $factory->closeAll();
 244         }
 245
 246         private function newLBFactoryMultiLBs() {
 247                 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
 248
 249                 return new LBFactoryMulti( [
 250                         'sectionsByDB' => [
 251                                 's1wiki' => 's1',
 252                         ],
 253                         'sectionLoads' => [
 254                                 's1' => [
 255                                         'test-db3' => 0,
 256                                         'test-db4' => 100,
 257                                 ],
 258                                 'DEFAULT' => [
 259                                         'test-db1' => 0,
 260                                         'test-db2' => 100,
 261                                 ]
 262                         ],
 263                         'serverTemplate' => [
 264                                 'dbname' => $wgDBname,
 265                                 'user' => $wgDBuser,
 266                                 'password' => $wgDBpassword,
 267                                 'type' => $wgDBtype,
 268                                 'dbDirectory' => $wgSQLiteDataDir,
 269                                 'flags' => DBO_DEFAULT
 270                         ],
 271                         'hostsByName' => [
 272                                 'test-db1' => $wgDBserver,
 273                                 'test-db2' => $wgDBserver,
 274                                 'test-db3' => $wgDBserver,
 275                                 'test-db4' => $wgDBserver
 276                         ],
 277                         'loadMonitorClass' => LoadMonitorNull::class
 278                 ] );
 279         }
 280
 281         /**
 282          * @covers \Wikimedia\Rdbms\ChronologyProtector
 283          */
 284         public function testChronologyProtector() {
 285                 $now = microtime( true );
 286
 287                 // (a) First HTTP request
 288                 $m1Pos = new MySQLMasterPos( 'db1034-bin.000976/843431247', $now );
 289                 $m2Pos = new MySQLMasterPos( 'db1064-bin.002400/794074907', $now );
 290
 291                 // Master DB 1
 292                 $mockDB1 = $this->getMockBuilder( IDatabase::class )
 293                         ->disableOriginalConstructor()
 294                         ->getMock();
 295                 $mockDB1->method( 'writesOrCallbacksPending' )->willReturn( true );
 296                 $mockDB1->method( 'lastDoneWrites' )->willReturn( $now );
 297                 $mockDB1->method( 'getMasterPos' )->willReturn( $m1Pos );
 298                 // Load balancer for master DB 1
 299                 $lb1 = $this->getMockBuilder( LoadBalancer::class )
 300                         ->disableOriginalConstructor()
 301                         ->getMock();
 302                 $lb1->method( 'getConnection' )->willReturn( $mockDB1 );
 303                 $lb1->method( 'getServerCount' )->willReturn( 2 );
 304                 $lb1->method( 'hasReplicaServers' )->willReturn( true );
 305                 $lb1->method( 'hasStreamingReplicaServers' )->willReturn( true );
 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( 'getReplicaResumePos' )->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( 'getReplicaResumePos' )->willReturn( $m2Pos );
 346                 $lb2->method( 'getServerName' )->with( 0 )->willReturn( 'master2' );
 347
 348                 $bag = new HashBagOStuff();
 349                 $cp = new ChronologyProtector(
 350                         $bag,
 351                         [
 352                                 'ip' => '127.0.0.1',
 353                                 'agent' => "Totally-Not-FireFox"
 354                         ],
 355                         null
 356                 );
 357
 358                 $mockDB1->expects( $this->exactly( 1 ) )->method( 'writesOrCallbacksPending' );
 359                 $mockDB1->expects( $this->exactly( 1 ) )->method( 'lastDoneWrites' );
 360                 $mockDB2->expects( $this->exactly( 1 ) )->method( 'writesOrCallbacksPending' );
 361                 $mockDB2->expects( $this->exactly( 1 ) )->method( 'lastDoneWrites' );
 362
 363                 // Nothing to wait for on first HTTP request start
 364                 $cp->applySessionReplicationPosition( $lb1 );
 365                 $cp->applySessionReplicationPosition( $lb2 );
 366                 // Record positions in stash on first HTTP request end
 367                 $cp->storeSessionReplicationPosition( $lb1 );
 368                 $cp->storeSessionReplicationPosition( $lb2 );
 369                 $cpIndex = null;
 370                 $cp->shutdown( null, 'sync', $cpIndex );
 371
 372                 $this->assertEquals( 1, $cpIndex, "CP write index set" );
 373
 374                 // (b) Second HTTP request
 375
 376                 // Load balancer for master DB 1
 377                 $lb1 = $this->getMockBuilder( LoadBalancer::class )
 378                         ->disableOriginalConstructor()
 379                         ->getMock();
 380                 $lb1->method( 'getServerCount' )->willReturn( 2 );
 381                 $lb1->method( 'hasReplicaServers' )->willReturn( true );
 382                 $lb1->method( 'hasStreamingReplicaServers' )->willReturn( true );
 383                 $lb1->method( 'getServerName' )->with( 0 )->willReturn( 'master1' );
 384                 $lb1->expects( $this->once() )
 385                         ->method( 'waitFor' )->with( $this->equalTo( $m1Pos ) );
 386                 // Load balancer for master DB 2
 387                 $lb2 = $this->getMockBuilder( LoadBalancer::class )
 388                         ->disableOriginalConstructor()
 389                         ->getMock();
 390                 $lb2->method( 'getServerCount' )->willReturn( 2 );
 391                 $lb2->method( 'hasReplicaServers' )->willReturn( true );
 392                 $lb2->method( 'hasStreamingReplicaServers' )->willReturn( true );
 393                 $lb2->method( 'getServerName' )->with( 0 )->willReturn( 'master2' );
 394                 $lb2->expects( $this->once() )
 395                         ->method( 'waitFor' )->with( $this->equalTo( $m2Pos ) );
 396
 397                 $cp = new ChronologyProtector(
 398                         $bag,
 399                         [
 400                                 'ip' => '127.0.0.1',
 401                                 'agent' => "Totally-Not-FireFox"
 402                         ],
 403                         $cpIndex
 404                 );
 405
 406                 // Wait for last positions to be reached on second HTTP request start
 407                 $cp->applySessionReplicationPosition( $lb1 );
 408                 $cp->applySessionReplicationPosition( $lb2 );
 409                 // Shutdown (nothing to record)
 410                 $cp->storeSessionReplicationPosition( $lb1 );
 411                 $cp->storeSessionReplicationPosition( $lb2 );
 412                 $cpIndex = null;
 413                 $cp->shutdown( null, 'sync', $cpIndex );
 414
 415                 $this->assertEquals( null, $cpIndex, "CP write index retained" );
 416
 417                 $this->assertEquals( '45e93a9c215c031d38b7c42d8e4700ca', $cp->getClientId() );
 418         }
 419
 420         private function newLBFactoryMulti( array $baseOverride = [], array $serverOverride = [] ) {
 421                 global $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, $wgDBprefix, $wgDBtype;
 422                 global $wgSQLiteDataDir;
 423
 424                 return new LBFactoryMulti( $baseOverride + [
 425                         'sectionsByDB' => [],
 426                         'sectionLoads' => [
 427                                 'DEFAULT' => [
 428                                         'test-db1' => 1,
 429                                 ],
 430                         ],
 431                         'serverTemplate' => $serverOverride + [
 432                                 'dbname' => $wgDBname,
 433                                 'tablePrefix' => $wgDBprefix,
 434                                 'user' => $wgDBuser,
 435                                 'password' => $wgDBpassword,
 436                                 'type' => $wgDBtype,
 437                                 'dbDirectory' => $wgSQLiteDataDir,
 438                                 'flags' => DBO_DEFAULT
 439                         ],
 440                         'hostsByName' => [
 441                                 'test-db1' => $wgDBserver,
 442                         ],
 443                         'loadMonitorClass' => LoadMonitorNull::class,
 444                         'localDomain' => new DatabaseDomain( $wgDBname, null, $wgDBprefix ),
 445                         'agent' => 'MW-UNIT-TESTS'
 446                 ] );
 447         }
 448
 449         /**
 450          * @covers \Wikimedia\Rdbms\LoadBalancer::getConnection
 451          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::doSelectDomain
 452          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::selectDB
 453          */
 454         public function testNiceDomains() {
 455                 global $wgDBname;
 456
 457                 if ( wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 458                         self::markTestSkipped( "Skipping tests about selecting DBs: not applicable" );
 459                         return;
 460                 }
 461
 462                 $factory = $this->newLBFactoryMulti(
 463                         [],
 464                         []
 465                 );
 466                 $lb = $factory->getMainLB();
 467
 468                 $db = $lb->getConnectionRef( DB_MASTER );
 469                 $this->assertEquals(
 470                         wfWikiID(),
 471                         $db->getDomainID()
 472                 );
 473                 unset( $db );
 474
 475                 /** @var IMaintainableDatabase $db */
 476                 $db = $lb->getConnection( DB_MASTER, [], '' );
 477
 478                 $this->assertEquals(
 479                         '',
 480                         $db->getDomainId(),
 481                         'Null domain ID handle used'
 482                 );
 483                 $this->assertEquals(
 484                         '',
 485                         $db->getDBname(),
 486                         'Null domain ID handle used'
 487                 );
 488                 $this->assertEquals(
 489                         '',
 490                         $db->tablePrefix(),
 491                         'Main domain ID handle used; prefix is empty though'
 492                 );
 493                 $this->assertEquals(
 494                         $this->quoteTable( $db, 'page' ),
 495                         $db->tableName( 'page' ),
 496                         "Correct full table name"
 497                 );
 498                 $this->assertEquals(
 499                         $this->quoteTable( $db, $wgDBname ) . '.' . $this->quoteTable( $db, 'page' ),
 500                         $db->tableName( "$wgDBname.page" ),
 501                         "Correct full table name"
 502                 );
 503                 $this->assertEquals(
 504                         $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 505                         $db->tableName( 'nice_db.page' ),
 506                         "Correct full table name"
 507                 );
 508
 509                 $lb->reuseConnection( $db ); // don't care
 510
 511                 $db = $lb->getConnection( DB_MASTER ); // local domain connection
 512                 $factory->setLocalDomainPrefix( 'my_' );
 513
 514                 $this->assertEquals( $wgDBname, $db->getDBname() );
 515                 $this->assertEquals(
 516                         "$wgDBname-my_",
 517                         $db->getDomainID()
 518                 );
 519                 $this->assertEquals(
 520                         $this->quoteTable( $db, 'my_page' ),
 521                         $db->tableName( 'page' ),
 522                         "Correct full table name"
 523                 );
 524                 $this->assertEquals(
 525                         $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 526                         $db->tableName( 'other_nice_db.page' ),
 527                         "Correct full table name"
 528                 );
 529
 530                 $factory->closeAll();
 531                 $factory->destroy();
 532         }
 533
 534         /**
 535          * @covers \Wikimedia\Rdbms\LoadBalancer::getConnection
 536          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::doSelectDomain
 537          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::selectDB
 538          */
 539         public function testTrickyDomain() {
 540                 global $wgDBname;
 541
 542                 if ( wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 543                         self::markTestSkipped( "Skipping tests about selecting DBs: not applicable" );
 544                         return;
 545                 }
 546
 547                 $dbname = 'unittest-domain'; // explodes if DB is selected
 548                 $factory = $this->newLBFactoryMulti(
 549                         [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
 550                         [
 551                                 'dbname' => 'do_not_select_me' // explodes if DB is selected
 552                         ]
 553                 );
 554                 $lb = $factory->getMainLB();
 555                 /** @var IMaintainableDatabase $db */
 556                 $db = $lb->getConnection( DB_MASTER, [], '' );
 557
 558                 $this->assertEquals( '', $db->getDomainID(), "Null domain used" );
 559
 560                 $this->assertEquals(
 561                         $this->quoteTable( $db, 'page' ),
 562                         $db->tableName( 'page' ),
 563                         "Correct full table name"
 564                 );
 565
 566                 $this->assertEquals(
 567                         $this->quoteTable( $db, $dbname ) . '.' . $this->quoteTable( $db, 'page' ),
 568                         $db->tableName( "$dbname.page" ),
 569                         "Correct full table name"
 570                 );
 571
 572                 $this->assertEquals(
 573                         $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 574                         $db->tableName( 'nice_db.page' ),
 575                         "Correct full table name"
 576                 );
 577
 578                 $lb->reuseConnection( $db ); // don't care
 579
 580                 $factory->setLocalDomainPrefix( 'my_' );
 581                 $db = $lb->getConnection( DB_MASTER, [], "$wgDBname-my_" );
 582
 583                 $this->assertEquals(
 584                         $this->quoteTable( $db, 'my_page' ),
 585                         $db->tableName( 'page' ),
 586                         "Correct full table name"
 587                 );
 588                 $this->assertEquals(
 589                         $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 590                         $db->tableName( 'other_nice_db.page' ),
 591                         "Correct full table name"
 592                 );
 593                 $this->assertEquals(
 594                         $this->quoteTable( $db, 'garbage-db' ) . '.' . $this->quoteTable( $db, 'page' ),
 595                         $db->tableName( 'garbage-db.page' ),
 596                         "Correct full table name"
 597                 );
 598
 599                 $lb->reuseConnection( $db ); // don't care
 600
 601                 $factory->closeAll();
 602                 $factory->destroy();
 603         }
 604
 605         /**
 606          * @covers \Wikimedia\Rdbms\LoadBalancer::getConnection
 607          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::doSelectDomain
 608          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::selectDB
 609          */
 610         public function testInvalidSelectDB() {
 611                 if ( wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 612                         $this->markTestSkipped( "Not applicable per databasesAreIndependent()" );
 613                 }
 614
 615                 $dbname = 'unittest-domain'; // explodes if DB is selected
 616                 $factory = $this->newLBFactoryMulti(
 617                         [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
 618                         [
 619                                 'dbname' => 'do_not_select_me' // explodes if DB is selected
 620                         ]
 621                 );
 622                 $lb = $factory->getMainLB();
 623                 /** @var IDatabase $db */
 624                 $db = $lb->getConnection( DB_MASTER, [], '' );
 625
 626                 \Wikimedia\suppressWarnings();
 627                 try {
 628                         $this->assertFalse( $db->selectDB( 'garbage-db' ) );
 629                         $this->fail( "No error thrown." );
 630                 } catch ( \Wikimedia\Rdbms\DBQueryError $e ) {
 631                         $this->assertRegExp( '/[\'"]garbage-db[\'"]/', $e->getMessage() );
 632                 }
 633                 \Wikimedia\restoreWarnings();
 634         }
 635
 636         /**
 637          * @covers \Wikimedia\Rdbms\DatabaseSqlite::selectDB
 638          * @covers \Wikimedia\Rdbms\DatabasePostgres::selectDB
 639          * @expectedException \Wikimedia\Rdbms\DBConnectionError
 640          */
 641         public function testInvalidSelectDBIndependent() {
 642                 $dbname = 'unittest-domain'; // explodes if DB is selected
 643                 $factory = $this->newLBFactoryMulti(
 644                         [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
 645                         [
 646                                 // Explodes with SQLite and Postgres during open/USE
 647                                 'dbname' => 'bad_dir/do_not_select_me'
 648                         ]
 649                 );
 650                 $lb = $factory->getMainLB();
 651
 652                 if ( !$lb->getConnection( DB_MASTER )->databasesAreIndependent() ) {
 653                         $this->markTestSkipped( "Not applicable per databasesAreIndependent()" );
 654                 }
 655
 656                 /** @var IDatabase $db */
 657                 $lb->getConnection( DB_MASTER, [], '' );
 658         }
 659
 660         /**
 661          * @covers \Wikimedia\Rdbms\DatabaseSqlite::selectDB
 662          * @covers \Wikimedia\Rdbms\DatabasePostgres::selectDB
 663          * @expectedException \Wikimedia\Rdbms\DBExpectedError
 664          */
 665         public function testInvalidSelectDBIndependent2() {
 666                 $dbname = 'unittest-domain'; // explodes if DB is selected
 667                 $factory = $this->newLBFactoryMulti(
 668                         [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
 669                         [
 670                                 // Explodes with SQLite and Postgres during open/USE
 671                                 'dbname' => 'bad_dir/do_not_select_me'
 672                         ]
 673                 );
 674                 $lb = $factory->getMainLB();
 675
 676                 if ( !$lb->getConnection( DB_MASTER )->databasesAreIndependent() ) {
 677                         $this->markTestSkipped( "Not applicable per databasesAreIndependent()" );
 678                 }
 679
 680                 $db = $lb->getConnection( DB_MASTER );
 681                 $db->selectDB( 'garbage-db' );
 682         }
 683
 684         /**
 685          * @covers \Wikimedia\Rdbms\LoadBalancer::getConnection
 686          * @covers \Wikimedia\Rdbms\LoadBalancer::redefineLocalDomain
 687          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::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 }