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( 'getAnyOpenConnection' )->willReturn( $mockDB1 );
 306                 $lb1->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
 307                                 function () use ( $mockDB1 ) {
 308                                         $p = 0;
 309                                         $p |= call_user_func( [ $mockDB1, 'writesOrCallbacksPending' ] );
 310                                         $p |= call_user_func( [ $mockDB1, 'lastDoneWrites' ] );
 311
 312                                         return (bool)$p;
 313                                 }
 314                         ) );
 315                 $lb1->method( 'getMasterPos' )->willReturn( $m1Pos );
 316                 $lb1->method( 'getServerName' )->with( 0 )->willReturn( 'master1' );
 317                 // Master DB 2
 318                 $mockDB2 = $this->getMockBuilder( IDatabase::class )
 319                         ->disableOriginalConstructor()
 320                         ->getMock();
 321                 $mockDB2->method( 'writesOrCallbacksPending' )->willReturn( true );
 322                 $mockDB2->method( 'lastDoneWrites' )->willReturn( $now );
 323                 $mockDB2->method( 'getMasterPos' )->willReturn( $m2Pos );
 324                 // Load balancer for master DB 2
 325                 $lb2 = $this->getMockBuilder( LoadBalancer::class )
 326                         ->disableOriginalConstructor()
 327                         ->getMock();
 328                 $lb2->method( 'getConnection' )->willReturn( $mockDB2 );
 329                 $lb2->method( 'getServerCount' )->willReturn( 2 );
 330                 $lb2->method( 'getAnyOpenConnection' )->willReturn( $mockDB2 );
 331                 $lb2->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
 332                         function () use ( $mockDB2 ) {
 333                                 $p = 0;
 334                                 $p |= call_user_func( [ $mockDB2, 'writesOrCallbacksPending' ] );
 335                                 $p |= call_user_func( [ $mockDB2, 'lastDoneWrites' ] );
 336
 337                                 return (bool)$p;
 338                         }
 339                 ) );
 340                 $lb2->method( 'getMasterPos' )->willReturn( $m2Pos );
 341                 $lb2->method( 'getServerName' )->with( 0 )->willReturn( 'master2' );
 342
 343                 $bag = new HashBagOStuff();
 344                 $cp = new ChronologyProtector(
 345                         $bag,
 346                         [
 347                                 'ip' => '127.0.0.1',
 348                                 'agent' => "Totally-Not-FireFox"
 349                         ],
 350                         null
 351                 );
 352
 353                 $mockDB1->expects( $this->exactly( 1 ) )->method( 'writesOrCallbacksPending' );
 354                 $mockDB1->expects( $this->exactly( 1 ) )->method( 'lastDoneWrites' );
 355                 $mockDB2->expects( $this->exactly( 1 ) )->method( 'writesOrCallbacksPending' );
 356                 $mockDB2->expects( $this->exactly( 1 ) )->method( 'lastDoneWrites' );
 357
 358                 // Nothing to wait for on first HTTP request start
 359                 $cp->initLB( $lb1 );
 360                 $cp->initLB( $lb2 );
 361                 // Record positions in stash on first HTTP request end
 362                 $cp->shutdownLB( $lb1 );
 363                 $cp->shutdownLB( $lb2 );
 364                 $cpIndex = null;
 365                 $cp->shutdown( null, 'sync', $cpIndex );
 366
 367                 $this->assertEquals( 1, $cpIndex, "CP write index set" );
 368
 369                 // (b) Second HTTP request
 370
 371                 // Load balancer for master DB 1
 372                 $lb1 = $this->getMockBuilder( LoadBalancer::class )
 373                         ->disableOriginalConstructor()
 374                         ->getMock();
 375                 $lb1->method( 'getServerCount' )->willReturn( 2 );
 376                 $lb1->method( 'getServerName' )->with( 0 )->willReturn( 'master1' );
 377                 $lb1->expects( $this->once() )
 378                         ->method( 'waitFor' )->with( $this->equalTo( $m1Pos ) );
 379                 // Load balancer for master DB 2
 380                 $lb2 = $this->getMockBuilder( LoadBalancer::class )
 381                         ->disableOriginalConstructor()
 382                         ->getMock();
 383                 $lb2->method( 'getServerCount' )->willReturn( 2 );
 384                 $lb2->method( 'getServerName' )->with( 0 )->willReturn( 'master2' );
 385                 $lb2->expects( $this->once() )
 386                         ->method( 'waitFor' )->with( $this->equalTo( $m2Pos ) );
 387
 388                 $cp = new ChronologyProtector(
 389                         $bag,
 390                         [
 391                                 'ip' => '127.0.0.1',
 392                                 'agent' => "Totally-Not-FireFox"
 393                         ],
 394                         $cpIndex
 395                 );
 396
 397                 // Wait for last positions to be reached on second HTTP request start
 398                 $cp->initLB( $lb1 );
 399                 $cp->initLB( $lb2 );
 400                 // Shutdown (nothing to record)
 401                 $cp->shutdownLB( $lb1 );
 402                 $cp->shutdownLB( $lb2 );
 403                 $cpIndex = null;
 404                 $cp->shutdown( null, 'sync', $cpIndex );
 405
 406                 $this->assertEquals( null, $cpIndex, "CP write index retained" );
 407
 408                 $this->assertEquals( '45e93a9c215c031d38b7c42d8e4700ca', $cp->getClientId() );
 409         }
 410
 411         private function newLBFactoryMulti( array $baseOverride = [], array $serverOverride = [] ) {
 412                 global $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, $wgDBprefix, $wgDBtype;
 413                 global $wgSQLiteDataDir;
 414
 415                 return new LBFactoryMulti( $baseOverride + [
 416                         'sectionsByDB' => [],
 417                         'sectionLoads' => [
 418                                 'DEFAULT' => [
 419                                         'test-db1' => 1,
 420                                 ],
 421                         ],
 422                         'serverTemplate' => $serverOverride + [
 423                                 'dbname' => $wgDBname,
 424                                 'tablePrefix' => $wgDBprefix,
 425                                 'user' => $wgDBuser,
 426                                 'password' => $wgDBpassword,
 427                                 'type' => $wgDBtype,
 428                                 'dbDirectory' => $wgSQLiteDataDir,
 429                                 'flags' => DBO_DEFAULT
 430                         ],
 431                         'hostsByName' => [
 432                                 'test-db1' => $wgDBserver,
 433                         ],
 434                         'loadMonitorClass' => LoadMonitorNull::class,
 435                         'localDomain' => new DatabaseDomain( $wgDBname, null, $wgDBprefix ),
 436                         'agent' => 'MW-UNIT-TESTS'
 437                 ] );
 438         }
 439
 440         /**
 441          * @covers \Wikimedia\Rdbms\LoadBalancer::getConnection
 442          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::doSelectDomain
 443          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::selectDB
 444          * @covers \Wikimedia\Rdbms\DatabaseMssql::selectDB
 445          * @covers DatabaseOracle::selectDB
 446          */
 447         public function testNiceDomains() {
 448                 global $wgDBname;
 449
 450                 if ( wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 451                         self::markTestSkipped( "Skipping tests about selecting DBs: not applicable" );
 452                         return;
 453                 }
 454
 455                 $factory = $this->newLBFactoryMulti(
 456                         [],
 457                         []
 458                 );
 459                 $lb = $factory->getMainLB();
 460
 461                 $db = $lb->getConnectionRef( DB_MASTER );
 462                 $this->assertEquals(
 463                         wfWikiID(),
 464                         $db->getDomainID()
 465                 );
 466                 unset( $db );
 467
 468                 /** @var IMaintainableDatabase $db */
 469                 $db = $lb->getConnection( DB_MASTER, [], '' );
 470
 471                 $this->assertEquals(
 472                         '',
 473                         $db->getDomainId(),
 474                         'Null domain ID handle used'
 475                 );
 476                 $this->assertEquals(
 477                         '',
 478                         $db->getDBname(),
 479                         'Null domain ID handle used'
 480                 );
 481                 $this->assertEquals(
 482                         '',
 483                         $db->tablePrefix(),
 484                         'Main domain ID handle used; prefix is empty though'
 485                 );
 486                 $this->assertEquals(
 487                         $this->quoteTable( $db, 'page' ),
 488                         $db->tableName( 'page' ),
 489                         "Correct full table name"
 490                 );
 491                 $this->assertEquals(
 492                         $this->quoteTable( $db, $wgDBname ) . '.' . $this->quoteTable( $db, 'page' ),
 493                         $db->tableName( "$wgDBname.page" ),
 494                         "Correct full table name"
 495                 );
 496                 $this->assertEquals(
 497                         $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 498                         $db->tableName( 'nice_db.page' ),
 499                         "Correct full table name"
 500                 );
 501
 502                 $lb->reuseConnection( $db ); // don't care
 503
 504                 $db = $lb->getConnection( DB_MASTER ); // local domain connection
 505                 $factory->setLocalDomainPrefix( 'my_' );
 506
 507                 $this->assertEquals( $wgDBname, $db->getDBname() );
 508                 $this->assertEquals(
 509                         "$wgDBname-my_",
 510                         $db->getDomainID()
 511                 );
 512                 $this->assertEquals(
 513                         $this->quoteTable( $db, 'my_page' ),
 514                         $db->tableName( 'page' ),
 515                         "Correct full table name"
 516                 );
 517                 $this->assertEquals(
 518                         $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 519                         $db->tableName( 'other_nice_db.page' ),
 520                         "Correct full table name"
 521                 );
 522
 523                 $factory->closeAll();
 524                 $factory->destroy();
 525         }
 526
 527         /**
 528          * @covers \Wikimedia\Rdbms\LoadBalancer::getConnection
 529          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::doSelectDomain
 530          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::selectDB
 531          * @covers \Wikimedia\Rdbms\DatabaseMssql::selectDB
 532          * @covers DatabaseOracle::selectDB
 533          */
 534         public function testTrickyDomain() {
 535                 global $wgDBname;
 536
 537                 if ( wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 538                         self::markTestSkipped( "Skipping tests about selecting DBs: not applicable" );
 539                         return;
 540                 }
 541
 542                 $dbname = 'unittest-domain'; // explodes if DB is selected
 543                 $factory = $this->newLBFactoryMulti(
 544                         [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
 545                         [
 546                                 'dbname' => 'do_not_select_me' // explodes if DB is selected
 547                         ]
 548                 );
 549                 $lb = $factory->getMainLB();
 550                 /** @var IMaintainableDatabase $db */
 551                 $db = $lb->getConnection( DB_MASTER, [], '' );
 552
 553                 $this->assertEquals( '', $db->getDomainID(), "Null domain used" );
 554
 555                 $this->assertEquals(
 556                         $this->quoteTable( $db, 'page' ),
 557                         $db->tableName( 'page' ),
 558                         "Correct full table name"
 559                 );
 560
 561                 $this->assertEquals(
 562                         $this->quoteTable( $db, $dbname ) . '.' . $this->quoteTable( $db, 'page' ),
 563                         $db->tableName( "$dbname.page" ),
 564                         "Correct full table name"
 565                 );
 566
 567                 $this->assertEquals(
 568                         $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 569                         $db->tableName( 'nice_db.page' ),
 570                         "Correct full table name"
 571                 );
 572
 573                 $lb->reuseConnection( $db ); // don't care
 574
 575                 $factory->setLocalDomainPrefix( 'my_' );
 576                 $db = $lb->getConnection( DB_MASTER, [], "$wgDBname-my_" );
 577
 578                 $this->assertEquals(
 579                         $this->quoteTable( $db, 'my_page' ),
 580                         $db->tableName( 'page' ),
 581                         "Correct full table name"
 582                 );
 583                 $this->assertEquals(
 584                         $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
 585                         $db->tableName( 'other_nice_db.page' ),
 586                         "Correct full table name"
 587                 );
 588                 $this->assertEquals(
 589                         $this->quoteTable( $db, 'garbage-db' ) . '.' . $this->quoteTable( $db, 'page' ),
 590                         $db->tableName( 'garbage-db.page' ),
 591                         "Correct full table name"
 592                 );
 593
 594                 $lb->reuseConnection( $db ); // don't care
 595
 596                 $factory->closeAll();
 597                 $factory->destroy();
 598         }
 599
 600         /**
 601          * @covers \Wikimedia\Rdbms\LoadBalancer::getConnection
 602          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::doSelectDomain
 603          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::selectDB
 604          * @covers \Wikimedia\Rdbms\DatabaseMssql::selectDB
 605          * @covers DatabaseOracle::selectDB
 606          */
 607         public function testInvalidSelectDB() {
 608                 if ( wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 609                         $this->markTestSkipped( "Not applicable per databasesAreIndependent()" );
 610                 }
 611
 612                 $dbname = 'unittest-domain'; // explodes if DB is selected
 613                 $factory = $this->newLBFactoryMulti(
 614                         [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
 615                         [
 616                                 'dbname' => 'do_not_select_me' // explodes if DB is selected
 617                         ]
 618                 );
 619                 $lb = $factory->getMainLB();
 620                 /** @var IDatabase $db */
 621                 $db = $lb->getConnection( DB_MASTER, [], '' );
 622
 623                 \Wikimedia\suppressWarnings();
 624                 try {
 625                         $this->assertFalse( $db->selectDB( 'garbage-db' ) );
 626                         $this->fail( "No error thrown." );
 627                 } catch ( \Wikimedia\Rdbms\DBQueryError $e ) {
 628                         $this->assertRegExp( '/[\'"]garbage-db[\'"]/', $e->getMessage() );
 629                 }
 630                 \Wikimedia\restoreWarnings();
 631         }
 632
 633         /**
 634          * @covers \Wikimedia\Rdbms\DatabaseSqlite::selectDB
 635          * @covers \Wikimedia\Rdbms\DatabasePostgres::selectDB
 636          * @expectedException \Wikimedia\Rdbms\DBConnectionError
 637          */
 638         public function testInvalidSelectDBIndependant() {
 639                 $dbname = 'unittest-domain'; // explodes if DB is selected
 640                 $factory = $this->newLBFactoryMulti(
 641                         [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
 642                         [
 643                                 'dbname' => 'do_not_select_me' // explodes if DB is selected
 644                         ]
 645                 );
 646                 $lb = $factory->getMainLB();
 647
 648                 if ( !wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 649                         $this->markTestSkipped( "Not applicable per databasesAreIndependent()" );
 650                 }
 651
 652                 /** @var IDatabase $db */
 653                 $lb->getConnection( DB_MASTER, [], '' );
 654         }
 655
 656         /**
 657          * @covers \Wikimedia\Rdbms\DatabaseSqlite::selectDB
 658          * @covers \Wikimedia\Rdbms\DatabasePostgres::selectDB
 659          * @expectedException \Wikimedia\Rdbms\DBConnectionError
 660          */
 661         public function testInvalidSelectDBIndependant2() {
 662                 $dbname = 'unittest-domain'; // explodes if DB is selected
 663                 $factory = $this->newLBFactoryMulti(
 664                         [ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
 665                         [
 666                                 'dbname' => 'do_not_select_me' // explodes if DB is selected
 667                         ]
 668                 );
 669                 $lb = $factory->getMainLB();
 670
 671                 if ( !wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 672                         $this->markTestSkipped( "Not applicable per databasesAreIndependent()" );
 673                 }
 674
 675                 $db = $lb->getConnection( DB_MASTER );
 676                 \Wikimedia\suppressWarnings();
 677                 $db->selectDB( 'garbage-db' );
 678                 \Wikimedia\restoreWarnings();
 679         }
 680
 681         /**
 682          * @covers \Wikimedia\Rdbms\LoadBalancer::getConnection
 683          * @covers \Wikimedia\Rdbms\LoadBalancer::redefineLocalDomain
 684          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::selectDB
 685          * @covers \Wikimedia\Rdbms\DatabaseMssql::selectDB
 686          * @covers DatabaseOracle::selectDB
 687          */
 688         public function testRedefineLocalDomain() {
 689                 global $wgDBname;
 690
 691                 if ( wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
 692                         self::markTestSkipped( "Skipping tests about selecting DBs: not applicable" );
 693                         return;
 694                 }
 695
 696                 $factory = $this->newLBFactoryMulti(
 697                         [],
 698                         []
 699                 );
 700                 $lb = $factory->getMainLB();
 701
 702                 $conn1 = $lb->getConnectionRef( DB_MASTER );
 703                 $this->assertEquals(
 704                         wfWikiID(),
 705                         $conn1->getDomainID()
 706                 );
 707                 unset( $conn1 );
 708
 709                 $factory->redefineLocalDomain( 'somedb-prefix_' );
 710                 $this->assertEquals( 'somedb-prefix_', $factory->getLocalDomainID() );
 711
 712                 $domain = new DatabaseDomain( $wgDBname, null, 'pref_' );
 713                 $factory->redefineLocalDomain( $domain );
 714
 715                 $n = 0;
 716                 $lb->forEachOpenConnection( function () use ( &$n ) {
 717                         ++$n;
 718                 } );
 719                 $this->assertEquals( 0, $n, "Connections closed" );
 720
 721                 $conn2 = $lb->getConnectionRef( DB_MASTER );
 722                 $this->assertEquals(
 723                         $domain->getId(),
 724                         $conn2->getDomainID()
 725                 );
 726                 unset( $conn2 );
 727
 728                 $factory->closeAll();
 729                 $factory->destroy();
 730         }
 731
 732         private function quoteTable( IDatabase $db, $table ) {
 733                 if ( $db->getType() === 'sqlite' ) {
 734                         return $table;
 735                 } else {
 736                         return $db->addIdentifierQuotes( $table );
 737                 }
 738         }
 739
 740         /**
 741          * @covers \Wikimedia\Rdbms\LBFactory::makeCookieValueFromCPIndex()
 742          * @covers \Wikimedia\Rdbms\LBFactory::getCPInfoFromCookieValue()
 743          */
 744         public function testCPPosIndexCookieValues() {
 745                 $time = 1526522031;
 746                 $agentId = md5( 'Ramsey\'s Loyal Presa Canario' );
 747
 748                 $this->assertEquals(
 749                         '3@542#c47dcfb0566e7d7bc110a6128a45c93a',
 750                         LBFactory::makeCookieValueFromCPIndex( 3, 542, $agentId )
 751                 );
 752
 753                 $lbFactory = $this->newLBFactoryMulti();
 754                 $lbFactory->setRequestInfo( [ 'IPAddress' => '10.64.24.52', 'UserAgent' => 'meow' ] );
 755                 $this->assertEquals(
 756                         '1@542#c47dcfb0566e7d7bc110a6128a45c93a',
 757                         LBFactory::makeCookieValueFromCPIndex( 1, 542, $agentId )
 758                 );
 759
 760                 $this->assertSame(
 761                         null,
 762                         LBFactory::getCPInfoFromCookieValue( "5#$agentId", $time - 10 )['index'],
 763                         'No time set'
 764                 );
 765                 $this->assertSame(
 766                         null,
 767                         LBFactory::getCPInfoFromCookieValue( "5@$time", $time - 10 )['index'],
 768                         'No agent set'
 769                 );
 770                 $this->assertSame(
 771                         null,
 772                         LBFactory::getCPInfoFromCookieValue( "0@$time#$agentId", $time - 10 )['index'],
 773                         'Bad index'
 774                 );
 775
 776                 $this->assertSame(
 777                         2,
 778                         LBFactory::getCPInfoFromCookieValue( "2@$time#$agentId", $time - 10 )['index'],
 779                         'Fresh'
 780                 );
 781                 $this->assertSame(
 782                         2,
 783                         LBFactory::getCPInfoFromCookieValue( "2@$time#$agentId", $time + 9 - 10 )['index'],
 784                         'Almost stale'
 785                 );
 786                 $this->assertSame(
 787                         null,
 788                         LBFactory::getCPInfoFromCookieValue( "0@$time#$agentId", $time + 9 - 10 )['index'],
 789                         'Almost stale; bad index'
 790                 );
 791                 $this->assertSame(
 792                         null,
 793                         LBFactory::getCPInfoFromCookieValue( "2@$time#$agentId", $time + 11 - 10 )['index'],
 794                         'Stale'
 795                 );
 796
 797                 $this->assertSame(
 798                         $agentId,
 799                         LBFactory::getCPInfoFromCookieValue( "5@$time#$agentId", $time - 10 )['clientId'],
 800                         'Live (client ID)'
 801                 );
 802                 $this->assertSame(
 803                         null,
 804                         LBFactory::getCPInfoFromCookieValue( "5@$time#$agentId", $time + 11 - 10 )['clientId'],
 805                         'Stale (client ID)'
 806                 );
 807         }
 808 }