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\TransactionProfiler
;
27 use Wikimedia\Rdbms\DatabaseDomain
;
28 use Wikimedia\Rdbms\MySQLMasterPos
;
29 use Wikimedia\Rdbms\DatabaseMysqlBase
;
30 use Wikimedia\Rdbms\DatabaseMysqli
;
31 use Wikimedia\Rdbms\Database
;
34 * Fake class around abstract class so we can call concrete methods.
36 class FakeDatabaseMysqlBase
extends DatabaseMysqlBase
{
38 function __construct() {
39 $this->profiler
= new ProfilerStub( [] );
40 $this->trxProfiler
= new TransactionProfiler();
41 $this->cliMode
= true;
42 $this->connLogger
= new \Psr\Log\
NullLogger();
43 $this->queryLogger
= new \Psr\Log\
NullLogger();
44 $this->errorLogger
= function ( Exception
$e ) {
45 wfWarn( get_class( $e ) . ": {$e->getMessage()}" );
47 $this->currentDomain
= DatabaseDomain
::newUnspecified();
50 protected function closeConnection() {
53 protected function doQuery( $sql ) {
56 protected function fetchAffectedRowCount() {
59 // From DatabaseMysqli
60 protected function mysqlConnect( $realServer ) {
63 protected function mysqlSetCharset( $charset ) {
66 protected function mysqlFreeResult( $res ) {
69 protected function mysqlFetchObject( $res ) {
72 protected function mysqlFetchArray( $res ) {
75 protected function mysqlNumRows( $res ) {
78 protected function mysqlNumFields( $res ) {
81 protected function mysqlFieldName( $res, $n ) {
84 protected function mysqlFieldType( $res, $n ) {
87 protected function mysqlDataSeek( $res, $row ) {
90 protected function mysqlError( $conn = null ) {
93 protected function mysqlFetchField( $res, $n ) {
96 protected function mysqlRealEscapeString( $s ) {
102 function lastErrno() {
105 function affectedRows() {
108 function getServerVersion() {
112 class DatabaseMysqlBaseTest
extends PHPUnit\Framework\TestCase
{
114 use MediaWikiCoversValidator
;
117 * @dataProvider provideDiapers
118 * @covers Wikimedia\Rdbms\DatabaseMysqlBase::addIdentifierQuotes
120 public function testAddIdentifierQuotes( $expected, $in ) {
121 $db = new FakeDatabaseMysqlBase();
122 $quoted = $db->addIdentifierQuotes( $in );
123 $this->assertEquals( $expected, $quoted );
127 * Feeds testAddIdentifierQuotes
129 * Named per T22281 convention.
131 public static function provideDiapers() {
133 // Format: expected, input
136 // Yeah I really hate loosely typed PHP idiocies nowadays
139 // Dear codereviewer, guess what addIdentifierQuotes()
140 // will return with thoses:
144 // We never know what could happen
148 // Whatchout! Should probably use something more meaningful
149 [ "`'`", "'" ], # single quote
150 [ '`"`', '"' ], # double quote
151 [ '````', '`' ], # backtick
152 [ '`’`', '’' ], # apostrophe (look at your encyclopedia)
154 // sneaky NUL bytes are lurking everywhere
156 [ '`xyzzy`', "\0x\0y\0z\0z\0y\0" ],
160 self
::createUnicodeString( '`\u0001a\uFFFFb`' ),
161 self
::createUnicodeString( '\u0001a\uFFFFb' )
164 self
::createUnicodeString( '`\u0001\uFFFF`' ),
165 self
::createUnicodeString( '\u0001\u0000\uFFFF\u0000' )
168 [ '`メインページ`', 'メインページ' ],
169 [ '`Басты_бет`', 'Басты_бет' ],
172 [ '`Alix`', 'Alix' ], # while( ! $recovered ) { sleep(); }
173 [ '`Backtick: ```', 'Backtick: `' ],
174 [ '`This is a test`', 'This is a test' ],
178 private static function createUnicodeString( $str ) {
179 return json_decode( '"' . $str . '"' );
182 private function getMockForViews() {
183 $db = $this->getMockBuilder( DatabaseMysqli
::class )
184 ->disableOriginalConstructor()
185 ->setMethods( [ 'fetchRow', 'query' ] )
188 $db->method( 'query' )
189 ->with( $this->anything() )
190 ->willReturn( new FakeResultWrapper( [
191 (object)[ 'Tables_in_' => 'view1' ],
192 (object)[ 'Tables_in_' => 'view2' ],
193 (object)[ 'Tables_in_' => 'myview' ]
200 * @covers Wikimedia\Rdbms\DatabaseMysqlBase::listViews
202 public function testListviews() {
203 $db = $this->getMockForViews();
205 $this->assertEquals( [ 'view1', 'view2', 'myview' ],
209 $this->assertEquals( [ 'view1', 'view2' ],
210 $db->listViews( 'view' ) );
211 $this->assertEquals( [ 'myview' ],
212 $db->listViews( 'my' ) );
213 $this->assertEquals( [],
214 $db->listViews( 'UNUSED_PREFIX' ) );
215 $this->assertEquals( [ 'view1', 'view2', 'myview' ],
216 $db->listViews( '' ) );
219 public function testBinLogName() {
220 $pos = new MySQLMasterPos( "db1052.2424/4643", 1 );
222 $this->assertEquals( "db1052", $pos->binlog
);
223 $this->assertEquals( "db1052.2424", $pos->getLogFile() );
224 $this->assertEquals( [ 2424, 4643 ], $pos->pos
);
228 * @dataProvider provideComparePositions
229 * @covers Wikimedia\Rdbms\MySQLMasterPos
231 public function testHasReached(
232 MySQLMasterPos
$lowerPos, MySQLMasterPos
$higherPos, $match, $hetero
235 $this->assertTrue( $lowerPos->channelsMatch( $higherPos ) );
238 // Each position is has one channel higher than the other
239 $this->assertFalse( $higherPos->hasReached( $lowerPos ) );
241 $this->assertTrue( $higherPos->hasReached( $lowerPos ) );
243 $this->assertTrue( $lowerPos->hasReached( $lowerPos ) );
244 $this->assertTrue( $higherPos->hasReached( $higherPos ) );
245 $this->assertFalse( $lowerPos->hasReached( $higherPos ) );
246 } else { // channels don't match
247 $this->assertFalse( $lowerPos->channelsMatch( $higherPos ) );
249 $this->assertFalse( $higherPos->hasReached( $lowerPos ) );
250 $this->assertFalse( $lowerPos->hasReached( $higherPos ) );
254 public static function provideComparePositions() {
255 $now = microtime( true );
260 new MySQLMasterPos( 'db1034-bin.000976/843431247', $now ),
261 new MySQLMasterPos( 'db1034-bin.000976/843431248', $now ),
266 new MySQLMasterPos( 'db1034-bin.000976/999', $now ),
267 new MySQLMasterPos( 'db1034-bin.000976/1000', $now ),
272 new MySQLMasterPos( 'db1034-bin.000976/999', $now ),
273 new MySQLMasterPos( 'db1035-bin.000976/1000', $now ),
279 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:23', $now ),
280 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:24', $now ),
285 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:99', $now ),
286 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:100', $now ),
291 new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:99', $now ),
292 new MySQLMasterPos( '1E11FA47-71CA-11E1-9E33-C80AA9429562:100', $now ),
296 // MariaDB GTID style
298 new MySQLMasterPos( '255-11-23', $now ),
299 new MySQLMasterPos( '255-11-24', $now ),
304 new MySQLMasterPos( '255-11-99', $now ),
305 new MySQLMasterPos( '255-11-100', $now ),
310 new MySQLMasterPos( '255-11-999', $now ),
311 new MySQLMasterPos( '254-11-1000', $now ),
316 new MySQLMasterPos( '255-11-23,256-12-50', $now ),
317 new MySQLMasterPos( '255-11-24', $now ),
322 new MySQLMasterPos( '255-11-99,256-12-50,257-12-50', $now ),
323 new MySQLMasterPos( '255-11-1000', $now ),
328 new MySQLMasterPos( '255-11-23,256-12-50', $now ),
329 new MySQLMasterPos( '255-11-24,155-52-63', $now ),
334 new MySQLMasterPos( '255-11-99,256-12-50,257-12-50', $now ),
335 new MySQLMasterPos( '255-11-1000,256-12-51', $now ),
340 new MySQLMasterPos( '255-11-99,256-12-50', $now ),
341 new MySQLMasterPos( '255-13-1000,256-14-49', $now ),
346 new MySQLMasterPos( '253-11-999,255-11-999', $now ),
347 new MySQLMasterPos( '254-11-1000', $now ),
355 * @dataProvider provideChannelPositions
356 * @covers Wikimedia\Rdbms\MySQLMasterPos
358 public function testChannelsMatch( MySQLMasterPos
$pos1, MySQLMasterPos
$pos2, $matches ) {
359 $this->assertEquals( $matches, $pos1->channelsMatch( $pos2 ) );
360 $this->assertEquals( $matches, $pos2->channelsMatch( $pos1 ) );
362 $roundtripPos = new MySQLMasterPos( (string)$pos1, 1 );
363 $this->assertEquals( (string)$pos1, (string)$roundtripPos );
366 public static function provideChannelPositions() {
367 $now = microtime( true );
371 new MySQLMasterPos( 'db1034-bin.000876/44', $now ),
372 new MySQLMasterPos( 'db1034-bin.000976/74', $now ),
376 new MySQLMasterPos( 'db1052-bin.000976/999', $now ),
377 new MySQLMasterPos( 'db1052-bin.000976/1000', $now ),
381 new MySQLMasterPos( 'db1066-bin.000976/9999', $now ),
382 new MySQLMasterPos( 'db1035-bin.000976/10000', $now ),
386 new MySQLMasterPos( 'db1066-bin.000976/9999', $now ),
387 new MySQLMasterPos( 'trump2016.000976/10000', $now ),
394 * @dataProvider provideCommonDomainGTIDs
395 * @covers Wikimedia\Rdbms\MySQLMasterPos
397 public function testCommonGtidDomains( MySQLMasterPos
$pos, MySQLMasterPos
$ref, $gtids ) {
398 $this->assertEquals( $gtids, MySQLMasterPos
::getCommonDomainGTIDs( $pos, $ref ) );
401 public static function provideCommonDomainGTIDs() {
404 new MySQLMasterPos( '255-13-99,256-12-50,257-14-50', 1 ),
405 new MySQLMasterPos( '255-11-1000', 1 ),
410 '2E11FA47-71CA-11E1-9E33-C80AA9429562:5,' .
411 '3E11FA47-71CA-11E1-9E33-C80AA9429562:99,' .
412 '7E11FA47-71CA-11E1-9E33-C80AA9429562:30',
416 '1E11FA47-71CA-11E1-9E33-C80AA9429562:100,' .
417 '3E11FA47-71CA-11E1-9E33-C80AA9429562:66',
420 [ '3E11FA47-71CA-11E1-9E33-C80AA9429562:99' ]
426 * @dataProvider provideLagAmounts
427 * @covers Wikimedia\Rdbms\DatabaseMysqlBase::getLag
428 * @covers Wikimedia\Rdbms\DatabaseMysqlBase::getLagFromPtHeartbeat
430 public function testPtHeartbeat( $lag ) {
431 $db = $this->getMockBuilder( DatabaseMysqli
::class )
432 ->disableOriginalConstructor()
434 'getLagDetectionMethod', 'getHeartbeatData', 'getMasterServerInfo' ] )
437 $db->method( 'getLagDetectionMethod' )
438 ->willReturn( 'pt-heartbeat' );
440 $db->method( 'getMasterServerInfo' )
441 ->willReturn( [ 'serverId' => 172, 'asOf' => time() ] );
443 // Fake the current time.
444 list( $nowSecFrac, $nowSec ) = explode( ' ', microtime() );
445 $now = (float)$nowSec +
(float)$nowSecFrac;
446 // Fake the heartbeat time.
447 // Work arounds for weak DataTime microseconds support.
448 $ptTime = $now - $lag;
449 $ptSec = (int)$ptTime;
450 $ptSecFrac = ( $ptTime - $ptSec );
451 $ptDateTime = new DateTime( "@$ptSec" );
452 $ptTimeISO = $ptDateTime->format( 'Y-m-d\TH:i:s' );
453 $ptTimeISO .= ltrim( number_format( $ptSecFrac, 6 ), '0' );
455 $db->method( 'getHeartbeatData' )
456 ->with( [ 'server_id' => 172 ] )
457 ->willReturn( [ $ptTimeISO, $now ] );
459 $db->setLBInfo( 'clusterMasterHost', 'db1052' );
460 $lagEst = $db->getLag();
462 $this->assertGreaterThan( $lag - 0.010, $lagEst, "Correct heatbeat lag" );
463 $this->assertLessThan( $lag +
0.010, $lagEst, "Correct heatbeat lag" );
466 public static function provideLagAmounts() {
480 * @expectedException UnexpectedValueException
481 * @covers Wikimedia\Rdbms\Database::setFlag
483 public function testDBOIgnoreSet() {
484 $db = new FakeDatabaseMysqlBase();
486 $db->setFlag( Database
::DBO_IGNORE
);
490 * @expectedException UnexpectedValueException
491 * @covers Wikimedia\Rdbms\Database::clearFlag
493 public function testDBOIgnoreClear() {
494 $db = new FakeDatabaseMysqlBase();
496 $db->clearFlag( Database
::DBO_IGNORE
);
500 * @covers Wikimedia\Rdbms\MySQLMasterPos
502 public function testSerialize() {
503 $pos = new MySQLMasterPos( '3E11FA47-71CA-11E1-9E33-C80AA9429562:99', 53636363 );
504 $roundtripPos = unserialize( serialize( $pos ) );
506 $this->assertEquals( $pos, $roundtripPos );
508 $pos = new MySQLMasterPos( '255-11-23', 53636363 );
509 $roundtripPos = unserialize( serialize( $pos ) );
511 $this->assertEquals( $pos, $roundtripPos );