3 * Holds tests for DatabaseMysqlBase class.
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.
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.
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
21 * @author Antoine Musso
22 * @copyright © 2013 Antoine Musso
23 * @copyright © 2013 Wikimedia Foundation and contributors
26 use Wikimedia\Rdbms\MySQLMasterPos
;
27 use Wikimedia\TestingAccessWrapper
;
29 class DatabaseMysqlBaseTest
extends PHPUnit\Framework\TestCase
{
31 use MediaWikiCoversValidator
;
32 use PHPUnit4And6Compat
;
35 * @dataProvider provideDiapers
36 * @covers Wikimedia\Rdbms\DatabaseMysqlBase::addIdentifierQuotes
38 public function testAddIdentifierQuotes( $expected, $in ) {
39 $db = $this->getMockBuilder( DatabaseMysqli
::class )
40 ->disableOriginalConstructor()
44 $quoted = $db->addIdentifierQuotes( $in );
45 $this->assertEquals( $expected, $quoted );
49 * Feeds testAddIdentifierQuotes
51 * Named per T22281 convention.
53 public static function provideDiapers() {
55 // Format: expected, input
58 // Yeah I really hate loosely typed PHP idiocies nowadays
61 // Dear codereviewer, guess what addIdentifierQuotes()
62 // will return with thoses:
66 // We never know what could happen
70 // Whatchout! Should probably use something more meaningful
71 [ "`'`", "'" ], # single quote
72 [ '`"`', '"' ], # double quote
73 [ '````', '`' ], # backtick
74 [ '`’`', '’' ], # apostrophe (look at your encyclopedia)
76 // sneaky NUL bytes are lurking everywhere
78 [ '`xyzzy`', "\0x\0y\0z\0z\0y\0" ],
82 "`\u{0001}a\u{FFFF}b`",
87 "\u{0001}\u{0000}\u{FFFF}\u{0000}"
90 [ '`メインページ`', 'メインページ' ],
91 [ '`Басты_бет`', 'Басты_бет' ],
94 [ '`Alix`', 'Alix' ], # while( ! $recovered ) { sleep(); }
95 [ '`Backtick: ```', 'Backtick: `' ],
96 [ '`This is a test`', 'This is a test' ],
100 private function getMockForViews() {
101 $db = $this->getMockBuilder( DatabaseMysqli
::class )
102 ->disableOriginalConstructor()
103 ->setMethods( [ 'fetchRow', 'query', 'getDBname' ] )
106 $db->method( 'query' )
107 ->with( $this->anything() )
108 ->willReturn( new FakeResultWrapper( [
109 (object)[ 'Tables_in_' => 'view1' ],
110 (object)[ 'Tables_in_' => 'view2' ],
111 (object)[ 'Tables_in_' => 'myview' ]
113 $db->method( 'getDBname' )->willReturn( '' );
119 * @covers Wikimedia\Rdbms\DatabaseMysqlBase::listViews
121 public function testListviews() {
122 $db = $this->getMockForViews();
124 $this->assertEquals( [ 'view1', 'view2', 'myview' ],
128 $this->assertEquals( [ 'view1', 'view2' ],
129 $db->listViews( 'view' ) );
130 $this->assertEquals( [ 'myview' ],
131 $db->listViews( 'my' ) );
132 $this->assertEquals( [],
133 $db->listViews( 'UNUSED_PREFIX' ) );
134 $this->assertEquals( [ 'view1', 'view2', 'myview' ],
135 $db->listViews( '' ) );
139 * @covers Wikimedia\Rdbms\MySQLMasterPos
141 public function testBinLogName() {
142 $pos = new MySQLMasterPos( "db1052.2424/4643", 1 );
144 $this->assertEquals( "db1052", $pos->getLogName() );
145 $this->assertEquals( "db1052.2424", $pos->getLogFile() );
146 $this->assertEquals( [ 2424, 4643 ], $pos->getLogPosition() );
150 * @dataProvider provideComparePositions
151 * @covers Wikimedia\Rdbms\MySQLMasterPos
153 public function testHasReached(
154 MySQLMasterPos
$lowerPos, MySQLMasterPos
$higherPos, $match, $hetero
157 $this->assertTrue( $lowerPos->channelsMatch( $higherPos ) );
160 // Each position is has one channel higher than the other
161 $this->assertFalse( $higherPos->hasReached( $lowerPos ) );
163 $this->assertTrue( $higherPos->hasReached( $lowerPos ) );
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 ) );
171 $this->assertFalse( $higherPos->hasReached( $lowerPos ) );
172 $this->assertFalse( $lowerPos->hasReached( $higherPos ) );
176 public static function provideComparePositions() {
177 $now = microtime( true );
182 new MySQLMasterPos( 'db1034-bin.000976/843431247', $now ),
183 new MySQLMasterPos( 'db1034-bin.000976/843431248', $now ),
188 new MySQLMasterPos( 'db1034-bin.000976/999', $now ),
189 new MySQLMasterPos( 'db1034-bin.000976/1000', $now ),
194 new MySQLMasterPos( 'db1034-bin.000976/999', $now ),
195 new MySQLMasterPos( 'db1035-bin.000976/1000', $now ),
201 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:1-23', $now ),
202 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:5-24', $now ),
207 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:5-99', $now ),
208 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:1-100', $now ),
213 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:1-99', $now ),
214 new MySQLMasterPos( '1E11FA47-71CA-11E1-9E33-C80AA9429562:1-100', $now ),
218 // MariaDB GTID style
220 new MySQLMasterPos( '255-11-23', $now ),
221 new MySQLMasterPos( '255-11-24', $now ),
226 new MySQLMasterPos( '255-11-99', $now ),
227 new MySQLMasterPos( '255-11-100', $now ),
232 new MySQLMasterPos( '255-11-999', $now ),
233 new MySQLMasterPos( '254-11-1000', $now ),
238 new MySQLMasterPos( '255-11-23,256-12-50', $now ),
239 new MySQLMasterPos( '255-11-24', $now ),
244 new MySQLMasterPos( '255-11-99,256-12-50,257-12-50', $now ),
245 new MySQLMasterPos( '255-11-1000', $now ),
250 new MySQLMasterPos( '255-11-23,256-12-50', $now ),
251 new MySQLMasterPos( '255-11-24,155-52-63', $now ),
256 new MySQLMasterPos( '255-11-99,256-12-50,257-12-50', $now ),
257 new MySQLMasterPos( '255-11-1000,256-12-51', $now ),
262 new MySQLMasterPos( '255-11-99,256-12-50', $now ),
263 new MySQLMasterPos( '255-13-1000,256-14-49', $now ),
268 new MySQLMasterPos( '253-11-999,255-11-999', $now ),
269 new MySQLMasterPos( '254-11-1000', $now ),
277 * @dataProvider provideChannelPositions
278 * @covers Wikimedia\Rdbms\MySQLMasterPos
280 public function testChannelsMatch( MySQLMasterPos
$pos1, MySQLMasterPos
$pos2, $matches ) {
281 $this->assertEquals( $matches, $pos1->channelsMatch( $pos2 ) );
282 $this->assertEquals( $matches, $pos2->channelsMatch( $pos1 ) );
284 $roundtripPos = new MySQLMasterPos( (string)$pos1, 1 );
285 $this->assertEquals( (string)$pos1, (string)$roundtripPos );
288 public static function provideChannelPositions() {
289 $now = microtime( true );
293 new MySQLMasterPos( 'db1034-bin.000876/44', $now ),
294 new MySQLMasterPos( 'db1034-bin.000976/74', $now ),
298 new MySQLMasterPos( 'db1052-bin.000976/999', $now ),
299 new MySQLMasterPos( 'db1052-bin.000976/1000', $now ),
303 new MySQLMasterPos( 'db1066-bin.000976/9999', $now ),
304 new MySQLMasterPos( 'db1035-bin.000976/10000', $now ),
308 new MySQLMasterPos( 'db1066-bin.000976/9999', $now ),
309 new MySQLMasterPos( 'trump2016.000976/10000', $now ),
316 * @dataProvider provideCommonDomainGTIDs
317 * @covers Wikimedia\Rdbms\MySQLMasterPos
319 public function testGetRelevantActiveGTIDs( MySQLMasterPos
$pos, MySQLMasterPos
$ref, $gtids ) {
320 $this->assertEquals( $gtids, MySQLMasterPos
::getRelevantActiveGTIDs( $pos, $ref ) );
323 public static function provideCommonDomainGTIDs() {
326 new MySQLMasterPos( '255-13-99,256-12-50,257-14-50', 1 ),
327 new MySQLMasterPos( '255-11-1000', 1 ),
331 ( new MySQLMasterPos( '255-13-99,256-12-50,257-14-50', 1 ) )
332 ->setActiveDomain( 257 ),
333 new MySQLMasterPos( '255-11-1000,257-14-30', 1 ),
338 '2E11FA47-71CA-11E1-9E33-C80AA9429562:1-5,' .
339 '3E11FA47-71CA-11E1-9E33-C80AA9429562:20-99,' .
340 '7E11FA47-71CA-11E1-9E33-C80AA9429562:1-30',
344 '1E11FA47-71CA-11E1-9E33-C80AA9429562:30-100,' .
345 '3E11FA47-71CA-11E1-9E33-C80AA9429562:30-66',
348 [ '3E11FA47-71CA-11E1-9E33-C80AA9429562:20-99' ]
354 * @dataProvider provideLagAmounts
355 * @covers Wikimedia\Rdbms\DatabaseMysqlBase::getLag
356 * @covers Wikimedia\Rdbms\DatabaseMysqlBase::getLagFromPtHeartbeat
358 public function testPtHeartbeat( $lag ) {
359 $db = $this->getMockBuilder( DatabaseMysqli
::class )
360 ->disableOriginalConstructor()
362 'getLagDetectionMethod', 'getHeartbeatData', 'getMasterServerInfo' ] )
365 $db->method( 'getLagDetectionMethod' )
366 ->willReturn( 'pt-heartbeat' );
368 $db->method( 'getMasterServerInfo' )
369 ->willReturn( [ 'serverId' => 172, 'asOf' => time() ] );
371 // Fake the current time.
372 list( $nowSecFrac, $nowSec ) = explode( ' ', microtime() );
373 $now = (float)$nowSec +
(float)$nowSecFrac;
374 // Fake the heartbeat time.
375 // Work arounds for weak DataTime microseconds support.
376 $ptTime = $now - $lag;
377 $ptSec = (int)$ptTime;
378 $ptSecFrac = ( $ptTime - $ptSec );
379 $ptDateTime = new DateTime( "@$ptSec" );
380 $ptTimeISO = $ptDateTime->format( 'Y-m-d\TH:i:s' );
381 $ptTimeISO .= ltrim( number_format( $ptSecFrac, 6 ), '0' );
383 $db->method( 'getHeartbeatData' )
384 ->with( [ 'server_id' => 172 ] )
385 ->willReturn( [ $ptTimeISO, $now ] );
387 $db->setLBInfo( 'clusterMasterHost', 'db1052' );
388 $lagEst = $db->getLag();
390 $this->assertGreaterThan( $lag - 0.010, $lagEst, "Correct heatbeat lag" );
391 $this->assertLessThan( $lag +
0.010, $lagEst, "Correct heatbeat lag" );
394 public static function provideLagAmounts() {
408 * @dataProvider provideGtidData
409 * @covers Wikimedia\Rdbms\MySQLMasterPos
410 * @covers Wikimedia\Rdbms\DatabaseMysqlBase::getReplicaPos
411 * @covers Wikimedia\Rdbms\DatabaseMysqlBase::getMasterPos
413 public function testServerGtidTable( $gtable, $rBLtable, $mBLtable, $rGTIDs, $mGTIDs ) {
414 $db = $this->getMockBuilder( DatabaseMysqli
::class )
415 ->disableOriginalConstructor()
419 'getServerRoleStatus',
425 $db->method( 'useGTIDs' )->willReturn( true );
426 $db->method( 'getServerGTIDs' )->willReturn( $gtable );
427 $db->method( 'getServerRoleStatus' )->willReturnCallback(
428 function ( $role ) use ( $rBLtable, $mBLtable ) {
429 if ( $role === 'SLAVE' ) {
431 } elseif ( $role === 'MASTER' ) {
438 $db->method( 'getServerId' )->willReturn( 1 );
439 $db->method( 'getServerUUID' )->willReturn( '2E11FA47-71CA-11E1-9E33-C80AA9429562' );
441 if ( is_array( $rGTIDs ) ) {
442 $this->assertEquals( $rGTIDs, $db->getReplicaPos()->getGTIDs() );
444 $this->assertEquals( false, $db->getReplicaPos() );
446 if ( is_array( $mGTIDs ) ) {
447 $this->assertEquals( $mGTIDs, $db->getMasterPos()->getGTIDs() );
449 $this->assertEquals( false, $db->getMasterPos() );
453 public static function provideGtidData() {
458 'gtid_domain_id' => 100,
459 'gtid_current_pos' => '100-13-77',
460 'gtid_binlog_pos' => '100-13-77',
461 'gtid_slave_pos' => null // master
464 'Relay_Master_Log_File' => 'host.1600',
465 'Exec_Master_Log_Pos' => '77'
468 'File' => 'host.1600',
472 [ '100' => '100-13-77' ]
476 'gtid_domain_id' => 100,
477 'gtid_current_pos' => '100-13-77',
478 'gtid_binlog_pos' => '100-13-77',
479 'gtid_slave_pos' => '100-13-77' // replica
482 'Relay_Master_Log_File' => 'host.1600',
483 'Exec_Master_Log_Pos' => '77'
486 [ '100' => '100-13-77' ],
487 [ '100' => '100-13-77' ]
491 'gtid_current_pos' => '100-13-77',
492 'gtid_binlog_pos' => '100-13-77',
493 'gtid_slave_pos' => '100-13-77' // replica
496 'Relay_Master_Log_File' => 'host.1600',
497 'Exec_Master_Log_Pos' => '77'
500 [ '100' => '100-13-77' ],
501 [ '100' => '100-13-77' ]
506 'gtid_executed' => '2E11FA47-71CA-11E1-9E33-C80AA9429562:1-77'
509 'Relay_Master_Log_File' => 'host.1600',
510 'Exec_Master_Log_Pos' => '77'
512 [], // only a replica
513 [ '2E11FA47-71CA-11E1-9E33-C80AA9429562'
514 => '2E11FA47-71CA-11E1-9E33-C80AA9429562:1-77' ],
515 // replica/master use same var
516 [ '2E11FA47-71CA-11E1-9E33-C80AA9429562'
517 => '2E11FA47-71CA-11E1-9E33-C80AA9429562:1-77' ],
521 'gtid_executed' => '2E11FA47-71CA-11E1-9E33-C80AA9429562:1-49,' .
522 '2E11FA47-71CA-11E1-9E33-C80AA9429562:51-77'
525 'Relay_Master_Log_File' => 'host.1600',
526 'Exec_Master_Log_Pos' => '77'
528 [], // only a replica
529 [ '2E11FA47-71CA-11E1-9E33-C80AA9429562'
530 => '2E11FA47-71CA-11E1-9E33-C80AA9429562:51-77' ],
531 // replica/master use same var
532 [ '2E11FA47-71CA-11E1-9E33-C80AA9429562'
533 => '2E11FA47-71CA-11E1-9E33-C80AA9429562:51-77' ],
537 'gtid_executed' => null, // not enabled?
538 'gtid_binlog_pos' => null
541 'Relay_Master_Log_File' => 'host.1600',
542 'Exec_Master_Log_Pos' => '77'
544 [], // only a replica
545 [], // binlog fallback
550 'gtid_executed' => null, // not enabled?
551 'gtid_binlog_pos' => null
553 [], // no replication
554 [], // no replication
562 * @covers Wikimedia\Rdbms\MySQLMasterPos
564 public function testSerialize() {
565 $pos = new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:99', 53636363 );
566 $roundtripPos = unserialize( serialize( $pos ) );
568 $this->assertEquals( $pos, $roundtripPos );
570 $pos = new MySQLMasterPos( '255-11-23', 53636363 );
571 $roundtripPos = unserialize( serialize( $pos ) );
573 $this->assertEquals( $pos, $roundtripPos );
577 * @covers Wikimedia\Rdbms\DatabaseMysqlBase::isInsertSelectSafe
578 * @dataProvider provideInsertSelectCases
580 public function testInsertSelectIsSafe( $insertOpts, $selectOpts, $row, $safe ) {
581 $db = $this->getMockBuilder( DatabaseMysqli
::class )
582 ->disableOriginalConstructor()
583 ->setMethods( [ 'getReplicationSafetyInfo' ] )
585 $db->method( 'getReplicationSafetyInfo' )->willReturn( (object)$row );
586 $dbw = TestingAccessWrapper
::newFromObject( $db );
588 $this->assertEquals( $safe, $dbw->isInsertSelectSafe( $insertOpts, $selectOpts ) );
591 public function provideInsertSelectCases() {
597 'innodb_autoinc_lock_mode' => '2',
598 'binlog_format' => 'ROW',
606 'innodb_autoinc_lock_mode' => '2',
607 'binlog_format' => 'ROW',
615 'innodb_autoinc_lock_mode' => '0',
616 'binlog_format' => 'STATEMENT',
624 'innodb_autoinc_lock_mode' => '2',
625 'binlog_format' => 'STATEMENT',
630 [ 'NO_AUTO_COLUMNS' ],
633 'innodb_autoinc_lock_mode' => '0',
634 'binlog_format' => 'STATEMENT',
642 'innodb_autoinc_lock_mode' => 0,
643 'binlog_format' => 'STATEMENT',
648 [ 'NO_AUTO_COLUMNS' ],
651 'innodb_autoinc_lock_mode' => 2,
652 'binlog_format' => 'STATEMENT',
657 [ 'NO_AUTO_COLUMNS' ],
660 'innodb_autoinc_lock_mode' => 0,
661 'binlog_format' => 'STATEMENT',
670 * @covers \Wikimedia\Rdbms\DatabaseMysqlBase::buildIntegerCast
672 public function testBuildIntegerCast() {
673 $db = $this->getMockBuilder( DatabaseMysqli
::class )
674 ->disableOriginalConstructor()
677 $output = $db->buildIntegerCast( 'fieldName' );
678 $this->assertSame( 'CAST( fieldName AS SIGNED )', $output );
682 * @covers Wikimedia\Rdbms\Database::setIndexAliases
684 public function testIndexAliases() {
685 $db = $this->getMockBuilder( DatabaseMysqli
::class )
686 ->disableOriginalConstructor()
687 ->setMethods( [ 'mysqlRealEscapeString', 'dbSchema', 'tablePrefix' ] )
689 $db->method( 'mysqlRealEscapeString' )->willReturnCallback(
691 return str_replace( "'", "\\'", $s );
695 $db->setIndexAliases( [ 'a_b_idx' => 'a_c_idx' ] );
696 $sql = $db->selectSQLText(
697 'zend', 'field', [ 'a' => 'x' ], __METHOD__
, [ 'USE INDEX' => 'a_b_idx' ] );
700 "SELECT field FROM `zend` FORCE INDEX (a_c_idx) WHERE a = 'x' ",
704 $db->setIndexAliases( [] );
705 $sql = $db->selectSQLText(
706 'zend', 'field', [ 'a' => 'x' ], __METHOD__
, [ 'USE INDEX' => 'a_b_idx' ] );
709 "SELECT field FROM `zend` FORCE INDEX (a_b_idx) WHERE a = 'x' ",
715 * @covers Wikimedia\Rdbms\Database::setTableAliases
717 public function testTableAliases() {
718 $db = $this->getMockBuilder( DatabaseMysqli
::class )
719 ->disableOriginalConstructor()
720 ->setMethods( [ 'mysqlRealEscapeString', 'dbSchema', 'tablePrefix' ] )
722 $db->method( 'mysqlRealEscapeString' )->willReturnCallback(
724 return str_replace( "'", "\\'", $s );
728 $db->setTableAliases( [
729 'meow' => [ 'dbname' => 'feline', 'schema' => null, 'prefix' => 'cat_' ]
731 $sql = $db->selectSQLText( 'meow', 'field', [ 'a' => 'x' ], __METHOD__
);
734 "SELECT field FROM `feline`.`cat_meow` WHERE a = 'x' ",
738 $db->setTableAliases( [] );
739 $sql = $db->selectSQLText( 'meow', 'field', [ 'a' => 'x' ], __METHOD__
);
742 "SELECT field FROM `meow` WHERE a = 'x' ",