tests/phpunit/includes/libs/rdbms/database/DatabaseMysqlBaseTest.php

   1 <?php
   2 /**
   3  * Holds tests for DatabaseMysqlBase 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 and contributors
  24  */
  25
  26 use Wikimedia\Rdbms\MySQLMasterPos;
  27 use Wikimedia\TestingAccessWrapper;
  28
  29 class DatabaseMysqlBaseTest extends PHPUnit\Framework\TestCase {
  30
  31         use MediaWikiCoversValidator;
  32         use PHPUnit4And6Compat;
  33
  34         /**
  35          * @dataProvider provideDiapers
  36          * @covers Wikimedia\Rdbms\DatabaseMysqlBase::addIdentifierQuotes
  37          */
  38         public function testAddIdentifierQuotes( $expected, $in ) {
  39                 $db = $this->getMockBuilder( DatabaseMysqli::class )
  40                         ->disableOriginalConstructor()
  41                         ->setMethods( null )
  42                         ->getMock();
  43
  44                 $quoted = $db->addIdentifierQuotes( $in );
  45                 $this->assertEquals( $expected, $quoted );
  46         }
  47
  48         /**
  49          * Feeds testAddIdentifierQuotes
  50          *
  51          * Named per T22281 convention.
  52          */
  53         public static function provideDiapers() {
  54                 return [
  55                         // Format: expected, input
  56                         [ '``', '' ],
  57
  58                         // Yeah I really hate loosely typed PHP idiocies nowadays
  59                         [ '``', null ],
  60
  61                         // Dear codereviewer, guess what addIdentifierQuotes()
  62                         // will return with thoses:
  63                         [ '``', false ],
  64                         [ '`1`', true ],
  65
  66                         // We never know what could happen
  67                         [ '`0`', 0 ],
  68                         [ '`1`', 1 ],
  69
  70                         // Whatchout! Should probably use something more meaningful
  71                         [ "`'`", "'" ],  # single quote
  72                         [ '`"`', '"' ],  # double quote
  73                         [ '````', '`' ], # backtick
  74                         [ '`’`', '’' ],  # apostrophe (look at your encyclopedia)
  75
  76                         // sneaky NUL bytes are lurking everywhere
  77                         [ '``', "\0" ],
  78                         [ '`xyzzy`', "\0x\0y\0z\0z\0y\0" ],
  79
  80                         // unicode chars
  81                         [
  82                                 self::createUnicodeString( '`\u0001a\uFFFFb`' ),
  83                                 self::createUnicodeString( '\u0001a\uFFFFb' )
  84                         ],
  85                         [
  86                                 self::createUnicodeString( '`\u0001\uFFFF`' ),
  87                                 self::createUnicodeString( '\u0001\u0000\uFFFF\u0000' )
  88                         ],
  89                         [ '`☃`', '☃' ],
  90                         [ '`メインページ`', 'メインページ' ],
  91                         [ '`Басты_бет`', 'Басты_бет' ],
  92
  93                         // Real world:
  94                         [ '`Alix`', 'Alix' ],  # while( ! $recovered ) { sleep(); }
  95                         [ '`Backtick: ```', 'Backtick: `' ],
  96                         [ '`This is a test`', 'This is a test' ],
  97                 ];
  98         }
  99
 100         private static function createUnicodeString( $str ) {
 101                 return json_decode( '"' . $str . '"' );
 102         }
 103
 104         private function getMockForViews() {
 105                 $db = $this->getMockBuilder( DatabaseMysqli::class )
 106                         ->disableOriginalConstructor()
 107                         ->setMethods( [ 'fetchRow', 'query' ] )
 108                         ->getMock();
 109
 110                 $db->method( 'query' )
 111                         ->with( $this->anything() )
 112                         ->willReturn( new FakeResultWrapper( [
 113                                 (object)[ 'Tables_in_' => 'view1' ],
 114                                 (object)[ 'Tables_in_' => 'view2' ],
 115                                 (object)[ 'Tables_in_' => 'myview' ]
 116                         ] ) );
 117
 118                 return $db;
 119         }
 120
 121         /**
 122          * @covers Wikimedia\Rdbms\DatabaseMysqlBase::listViews
 123          */
 124         public function testListviews() {
 125                 $db = $this->getMockForViews();
 126
 127                 $this->assertEquals( [ 'view1', 'view2', 'myview' ],
 128                         $db->listViews() );
 129
 130                 // Prefix filtering
 131                 $this->assertEquals( [ 'view1', 'view2' ],
 132                         $db->listViews( 'view' ) );
 133                 $this->assertEquals( [ 'myview' ],
 134                         $db->listViews( 'my' ) );
 135                 $this->assertEquals( [],
 136                         $db->listViews( 'UNUSED_PREFIX' ) );
 137                 $this->assertEquals( [ 'view1', 'view2', 'myview' ],
 138                         $db->listViews( '' ) );
 139         }
 140
 141         public function testBinLogName() {
 142                 $pos = new MySQLMasterPos( "db1052.2424/4643", 1 );
 143
 144                 $this->assertEquals( "db1052", $pos->binlog );
 145                 $this->assertEquals( "db1052.2424", $pos->getLogFile() );
 146                 $this->assertEquals( [ 2424, 4643 ], $pos->pos );
 147         }
 148
 149         /**
 150          * @dataProvider provideComparePositions
 151          * @covers Wikimedia\Rdbms\MySQLMasterPos
 152          */
 153         public function testHasReached(
 154                 MySQLMasterPos $lowerPos, MySQLMasterPos $higherPos, $match, $hetero
 155         ) {
 156                 if ( $match ) {
 157                         $this->assertTrue( $lowerPos->channelsMatch( $higherPos ) );
 158
 159                         if ( $hetero ) {
 160                                 // Each position is has one channel higher than the other
 161                                 $this->assertFalse( $higherPos->hasReached( $lowerPos ) );
 162                         } else {
 163                                 $this->assertTrue( $higherPos->hasReached( $lowerPos ) );
 164                         }
 165                         $this->assertTrue( $lowerPos->hasReached( $lowerPos ) );
 166                         $this->assertTrue( $higherPos->hasReached( $higherPos ) );
 167                         $this->assertFalse( $lowerPos->hasReached( $higherPos ) );
 168                 } else { // channels don't match
 169                         $this->assertFalse( $lowerPos->channelsMatch( $higherPos ) );
 170
 171                         $this->assertFalse( $higherPos->hasReached( $lowerPos ) );
 172                         $this->assertFalse( $lowerPos->hasReached( $higherPos ) );
 173                 }
 174         }
 175
 176         public static function provideComparePositions() {
 177                 $now = microtime( true );
 178
 179                 return [
 180                         // Binlog style
 181                         [
 182                                 new MySQLMasterPos( 'db1034-bin.000976/843431247', $now ),
 183                                 new MySQLMasterPos( 'db1034-bin.000976/843431248', $now ),
 184                                 true,
 185                                 false
 186                         ],
 187                         [
 188                                 new MySQLMasterPos( 'db1034-bin.000976/999', $now ),
 189                                 new MySQLMasterPos( 'db1034-bin.000976/1000', $now ),
 190                                 true,
 191                                 false
 192                         ],
 193                         [
 194                                 new MySQLMasterPos( 'db1034-bin.000976/999', $now ),
 195                                 new MySQLMasterPos( 'db1035-bin.000976/1000', $now ),
 196                                 false,
 197                                 false
 198                         ],
 199                         // MySQL GTID style
 200                         [
 201                                 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:23', $now ),
 202                                 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:24', $now ),
 203                                 true,
 204                                 false
 205                         ],
 206                         [
 207                                 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:99', $now ),
 208                                 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:100', $now ),
 209                                 true,
 210                                 false
 211                         ],
 212                         [
 213                                 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:99', $now ),
 214                                 new MySQLMasterPos( '1E11FA47-71CA-11E1-9E33-C80AA9429562:100', $now ),
 215                                 false,
 216                                 false
 217                         ],
 218                         // MariaDB GTID style
 219                         [
 220                                 new MySQLMasterPos( '255-11-23', $now ),
 221                                 new MySQLMasterPos( '255-11-24', $now ),
 222                                 true,
 223                                 false
 224                         ],
 225                         [
 226                                 new MySQLMasterPos( '255-11-99', $now ),
 227                                 new MySQLMasterPos( '255-11-100', $now ),
 228                                 true,
 229                                 false
 230                         ],
 231                         [
 232                                 new MySQLMasterPos( '255-11-999', $now ),
 233                                 new MySQLMasterPos( '254-11-1000', $now ),
 234                                 false,
 235                                 false
 236                         ],
 237                         [
 238                                 new MySQLMasterPos( '255-11-23,256-12-50', $now ),
 239                                 new MySQLMasterPos( '255-11-24', $now ),
 240                                 true,
 241                                 false
 242                         ],
 243                         [
 244                                 new MySQLMasterPos( '255-11-99,256-12-50,257-12-50', $now ),
 245                                 new MySQLMasterPos( '255-11-1000', $now ),
 246                                 true,
 247                                 false
 248                         ],
 249                         [
 250                                 new MySQLMasterPos( '255-11-23,256-12-50', $now ),
 251                                 new MySQLMasterPos( '255-11-24,155-52-63', $now ),
 252                                 true,
 253                                 false
 254                         ],
 255                         [
 256                                 new MySQLMasterPos( '255-11-99,256-12-50,257-12-50', $now ),
 257                                 new MySQLMasterPos( '255-11-1000,256-12-51', $now ),
 258                                 true,
 259                                 false
 260                         ],
 261                         [
 262                                 new MySQLMasterPos( '255-11-99,256-12-50', $now ),
 263                                 new MySQLMasterPos( '255-13-1000,256-14-49', $now ),
 264                                 true,
 265                                 true
 266                         ],
 267                         [
 268                                 new MySQLMasterPos( '253-11-999,255-11-999', $now ),
 269                                 new MySQLMasterPos( '254-11-1000', $now ),
 270                                 false,
 271                                 false
 272                         ],
 273                 ];
 274         }
 275
 276         /**
 277          * @dataProvider provideChannelPositions
 278          * @covers Wikimedia\Rdbms\MySQLMasterPos
 279          */
 280         public function testChannelsMatch( MySQLMasterPos $pos1, MySQLMasterPos $pos2, $matches ) {
 281                 $this->assertEquals( $matches, $pos1->channelsMatch( $pos2 ) );
 282                 $this->assertEquals( $matches, $pos2->channelsMatch( $pos1 ) );
 283
 284                 $roundtripPos = new MySQLMasterPos( (string)$pos1, 1 );
 285                 $this->assertEquals( (string)$pos1, (string)$roundtripPos );
 286         }
 287
 288         public static function provideChannelPositions() {
 289                 $now = microtime( true );
 290
 291                 return [
 292                         [
 293                                 new MySQLMasterPos( 'db1034-bin.000876/44', $now ),
 294                                 new MySQLMasterPos( 'db1034-bin.000976/74', $now ),
 295                                 true
 296                         ],
 297                         [
 298                                 new MySQLMasterPos( 'db1052-bin.000976/999', $now ),
 299                                 new MySQLMasterPos( 'db1052-bin.000976/1000', $now ),
 300                                 true
 301                         ],
 302                         [
 303                                 new MySQLMasterPos( 'db1066-bin.000976/9999', $now ),
 304                                 new MySQLMasterPos( 'db1035-bin.000976/10000', $now ),
 305                                 false
 306                         ],
 307                         [
 308                                 new MySQLMasterPos( 'db1066-bin.000976/9999', $now ),
 309                                 new MySQLMasterPos( 'trump2016.000976/10000', $now ),
 310                                 false
 311                         ],
 312                 ];
 313         }
 314
 315         /**
 316          * @dataProvider provideCommonDomainGTIDs
 317          * @covers Wikimedia\Rdbms\MySQLMasterPos
 318          */
 319         public function testCommonGtidDomains( MySQLMasterPos $pos, MySQLMasterPos $ref, $gtids ) {
 320                 $this->assertEquals( $gtids, MySQLMasterPos::getCommonDomainGTIDs( $pos, $ref ) );
 321         }
 322
 323         public static function provideCommonDomainGTIDs() {
 324                 return [
 325                         [
 326                                 new MySQLMasterPos( '255-13-99,256-12-50,257-14-50', 1 ),
 327                                 new MySQLMasterPos( '255-11-1000', 1 ),
 328                                 [ '255-13-99' ]
 329                         ],
 330                         [
 331                                 new MySQLMasterPos(
 332                                         '2E11FA47-71CA-11E1-9E33-C80AA9429562:5,' .
 333                                         '3E11FA47-71CA-11E1-9E33-C80AA9429562:99,' .
 334                                         '7E11FA47-71CA-11E1-9E33-C80AA9429562:30',
 335                                         1
 336                                 ),
 337                                 new MySQLMasterPos(
 338                                         '1E11FA47-71CA-11E1-9E33-C80AA9429562:100,' .
 339                                         '3E11FA47-71CA-11E1-9E33-C80AA9429562:66',
 340                                         1
 341                                 ),
 342                                 [ '3E11FA47-71CA-11E1-9E33-C80AA9429562:99' ]
 343                         ]
 344                 ];
 345         }
 346
 347         /**
 348          * @dataProvider provideLagAmounts
 349          * @covers Wikimedia\Rdbms\DatabaseMysqlBase::getLag
 350          * @covers Wikimedia\Rdbms\DatabaseMysqlBase::getLagFromPtHeartbeat
 351          */
 352         public function testPtHeartbeat( $lag ) {
 353                 $db = $this->getMockBuilder( DatabaseMysqli::class )
 354                         ->disableOriginalConstructor()
 355                         ->setMethods( [
 356                                 'getLagDetectionMethod', 'getHeartbeatData', 'getMasterServerInfo' ] )
 357                         ->getMock();
 358
 359                 $db->method( 'getLagDetectionMethod' )
 360                         ->willReturn( 'pt-heartbeat' );
 361
 362                 $db->method( 'getMasterServerInfo' )
 363                         ->willReturn( [ 'serverId' => 172, 'asOf' => time() ] );
 364
 365                 // Fake the current time.
 366                 list( $nowSecFrac, $nowSec ) = explode( ' ', microtime() );
 367                 $now = (float)$nowSec + (float)$nowSecFrac;
 368                 // Fake the heartbeat time.
 369                 // Work arounds for weak DataTime microseconds support.
 370                 $ptTime = $now - $lag;
 371                 $ptSec = (int)$ptTime;
 372                 $ptSecFrac = ( $ptTime - $ptSec );
 373                 $ptDateTime = new DateTime( "@$ptSec" );
 374                 $ptTimeISO = $ptDateTime->format( 'Y-m-d\TH:i:s' );
 375                 $ptTimeISO .= ltrim( number_format( $ptSecFrac, 6 ), '0' );
 376
 377                 $db->method( 'getHeartbeatData' )
 378                         ->with( [ 'server_id' => 172 ] )
 379                         ->willReturn( [ $ptTimeISO, $now ] );
 380
 381                 $db->setLBInfo( 'clusterMasterHost', 'db1052' );
 382                 $lagEst = $db->getLag();
 383
 384                 $this->assertGreaterThan( $lag - 0.010, $lagEst, "Correct heatbeat lag" );
 385                 $this->assertLessThan( $lag + 0.010, $lagEst, "Correct heatbeat lag" );
 386         }
 387
 388         public static function provideLagAmounts() {
 389                 return [
 390                         [ 0 ],
 391                         [ 0.3 ],
 392                         [ 6.5 ],
 393                         [ 10.1 ],
 394                         [ 200.2 ],
 395                         [ 400.7 ],
 396                         [ 600.22 ],
 397                         [ 1000.77 ],
 398                 ];
 399         }
 400
 401         /**
 402          * @covers Wikimedia\Rdbms\MySQLMasterPos
 403          */
 404         public function testSerialize() {
 405                 $pos = new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:99', 53636363 );
 406                 $roundtripPos = unserialize( serialize( $pos ) );
 407
 408                 $this->assertEquals( $pos, $roundtripPos );
 409
 410                 $pos = new MySQLMasterPos( '255-11-23', 53636363 );
 411                 $roundtripPos = unserialize( serialize( $pos ) );
 412
 413                 $this->assertEquals( $pos, $roundtripPos );
 414         }
 415
 416         /**
 417          * @covers Wikimedia\Rdbms\DatabaseMysqlBase::isInsertSelectSafe
 418          * @dataProvider provideInsertSelectCases
 419          */
 420         public function testInsertSelectIsSafe( $insertOpts, $selectOpts, $row, $safe ) {
 421                 $db = $this->getMockBuilder( DatabaseMysqli::class )
 422                         ->disableOriginalConstructor()
 423                         ->setMethods( [ 'getReplicationSafetyInfo' ] )
 424                         ->getMock();
 425                 $db->method( 'getReplicationSafetyInfo' )->willReturn( (object)$row );
 426                 $dbw = TestingAccessWrapper::newFromObject( $db );
 427
 428                 $this->assertEquals( $safe, $dbw->isInsertSelectSafe( $insertOpts, $selectOpts ) );
 429         }
 430
 431         public function provideInsertSelectCases() {
 432                 return [
 433                         [
 434                                 [],
 435                                 [],
 436                                 [
 437                                         'innodb_autoinc_lock_mode' => '2',
 438                                         'binlog_format' => 'ROW',
 439                                 ],
 440                                 true
 441                         ],
 442                         [
 443                                 [],
 444                                 [ 'LIMIT' => 100 ],
 445                                 [
 446                                         'innodb_autoinc_lock_mode' => '2',
 447                                         'binlog_format' => 'ROW',
 448                                 ],
 449                                 true
 450                         ],
 451                         [
 452                                 [],
 453                                 [ 'LIMIT' => 100 ],
 454                                 [
 455                                         'innodb_autoinc_lock_mode' => '0',
 456                                         'binlog_format' => 'STATEMENT',
 457                                 ],
 458                                 false
 459                         ],
 460                         [
 461                                 [],
 462                                 [],
 463                                 [
 464                                         'innodb_autoinc_lock_mode' => '2',
 465                                         'binlog_format' => 'STATEMENT',
 466                                 ],
 467                                 false
 468                         ],
 469                         [
 470                                 [ 'NO_AUTO_COLUMNS' ],
 471                                 [ 'LIMIT' => 100 ],
 472                                 [
 473                                         'innodb_autoinc_lock_mode' => '0',
 474                                         'binlog_format' => 'STATEMENT',
 475                                 ],
 476                                 false
 477                         ],
 478                         [
 479                                 [],
 480                                 [],
 481                                 [
 482                                         'innodb_autoinc_lock_mode' => 0,
 483                                         'binlog_format' => 'STATEMENT',
 484                                 ],
 485                                 true
 486                         ],
 487                         [
 488                                 [ 'NO_AUTO_COLUMNS' ],
 489                                 [],
 490                                 [
 491                                         'innodb_autoinc_lock_mode' => 2,
 492                                         'binlog_format' => 'STATEMENT',
 493                                 ],
 494                                 true
 495                         ],
 496                         [
 497                                 [ 'NO_AUTO_COLUMNS' ],
 498                                 [],
 499                                 [
 500                                         'innodb_autoinc_lock_mode' => 0,
 501                                         'binlog_format' => 'STATEMENT',
 502                                 ],
 503                                 true
 504                         ],
 505
 506                 ];
 507         }
 508
 509         /**
 510          * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::buildIntegerCast
 511          */
 512         public function testBuildIntegerCast() {
 513                 $db = $this->getMockBuilder( DatabaseMysqli::class )
 514                         ->disableOriginalConstructor()
 515                         ->setMethods( null )
 516                         ->getMock();
 517                 $output = $db->buildIntegerCast( 'fieldName' );
 518                 $this->assertSame( 'CAST( fieldName AS SIGNED )', $output );
 519         }
 520
 521         /*
 522          * @covers Wikimedia\Rdbms\Database::setIndexAliases
 523          */
 524         public function testIndexAliases() {
 525                 $db = $this->getMockBuilder( DatabaseMysqli::class )
 526                         ->disableOriginalConstructor()
 527                         ->setMethods( [ 'mysqlRealEscapeString' ] )
 528                         ->getMock();
 529                 $db->method( 'mysqlRealEscapeString' )->willReturnCallback(
 530                         function ( $s ) {
 531                                 return str_replace( "'", "\\'", $s );
 532                         }
 533                 );
 534
 535                 $db->setIndexAliases( [ 'a_b_idx' => 'a_c_idx' ] );
 536                 $sql = $db->selectSQLText(
 537                         'zend', 'field', [ 'a' => 'x' ], __METHOD__, [ 'USE INDEX' => 'a_b_idx' ] );
 538
 539                 $this->assertEquals(
 540                         "SELECT  field  FROM `zend`  FORCE INDEX (a_c_idx)  WHERE a = 'x'  ",
 541                         $sql
 542                 );
 543
 544                 $db->setIndexAliases( [] );
 545                 $sql = $db->selectSQLText(
 546                         'zend', 'field', [ 'a' => 'x' ], __METHOD__, [ 'USE INDEX' => 'a_b_idx' ] );
 547
 548                 $this->assertEquals(
 549                         "SELECT  field  FROM `zend`  FORCE INDEX (a_b_idx)  WHERE a = 'x'  ",
 550                         $sql
 551                 );
 552         }
 553
 554         /**
 555          * @covers Wikimedia\Rdbms\Database::setTableAliases
 556          */
 557         public function testTableAliases() {
 558                 $db = $this->getMockBuilder( DatabaseMysqli::class )
 559                         ->disableOriginalConstructor()
 560                         ->setMethods( [ 'mysqlRealEscapeString' ] )
 561                         ->getMock();
 562                 $db->method( 'mysqlRealEscapeString' )->willReturnCallback(
 563                         function ( $s ) {
 564                                 return str_replace( "'", "\\'", $s );
 565                         }
 566                 );
 567
 568                 $db->setTableAliases( [
 569                         'meow' => [ 'dbname' => 'feline', 'schema' => null, 'prefix' => 'cat_' ]
 570                 ] );
 571                 $sql = $db->selectSQLText( 'meow', 'field', [ 'a' => 'x' ], __METHOD__ );
 572
 573                 $this->assertEquals(
 574                         "SELECT  field  FROM `feline`.`cat_meow`    WHERE a = 'x'  ",
 575                         $sql
 576                 );
 577
 578                 $db->setTableAliases( [] );
 579                 $sql = $db->selectSQLText( 'meow', 'field', [ 'a' => 'x' ], __METHOD__ );
 580
 581                 $this->assertEquals(
 582                         "SELECT  field  FROM `meow`    WHERE a = 'x'  ",
 583                         $sql
 584                 );
 585         }
 586 }