3 use Wikimedia\Rdbms\IDatabase
;
4 use Wikimedia\Rdbms\Database
;
5 use Wikimedia\Rdbms\DatabaseMysqli
;
6 use Wikimedia\Rdbms\LBFactorySingle
;
7 use Wikimedia\Rdbms\TransactionProfiler
;
8 use Wikimedia\TestingAccessWrapper
;
10 class DatabaseTest
extends PHPUnit\Framework\TestCase
{
12 use MediaWikiCoversValidator
;
14 protected function setUp() {
15 $this->db
= new DatabaseTestHelper( __CLASS__
. '::' . $this->getName() );
18 public static function provideAddQuotes() {
22 [ 1234.5678, "'1234.5678'" ],
23 [ 'string', "'string'" ],
24 [ 'string\'s cause trouble', "'string\'s cause trouble'" ],
29 * @dataProvider provideAddQuotes
30 * @covers Wikimedia\Rdbms\Database::addQuotes
32 public function testAddQuotes( $input, $expected ) {
33 $this->assertEquals( $expected, $this->db
->addQuotes( $input ) );
36 public static function provideTableName() {
37 // Formatting is mostly ignored since addIdentifierQuotes is abstract.
38 // For testing of addIdentifierQuotes, see actual Database subclas tests.
54 [ 'dbname' => 'sharedb', 'schema' => null, 'prefix' => '' ],
60 [ 'dbname' => 'sharedb', 'schema' => null, 'prefix' => '' ],
63 'sharedb.sh_tablename',
66 [ 'dbname' => 'sharedb', 'schema' => null, 'prefix' => 'sh_' ],
68 'shared-prefix-raw' => [
69 'sharedb.sh_tablename',
72 [ 'dbname' => 'sharedb', 'schema' => null, 'prefix' => 'sh_' ],
75 'databasename.tablename',
76 'databasename.tablename',
80 'databasename.tablename',
81 'databasename.tablename',
88 * @dataProvider provideTableName
89 * @covers Wikimedia\Rdbms\Database::tableName
91 public function testTableName( $expected, $table, $format, array $alias = null ) {
93 $this->db
->setTableAliases( [ $table => $alias ] );
97 $this->db
->tableName( $table, $format ?
: 'quoted' )
101 public function provideTableNamesWithIndexClauseOrJOIN() {
103 'one-element array' => [
104 [ 'table' ], [], 'table '
107 [ 'table1', 'table2' ], [], 'table1,table2 '
110 [ 'table1', 'table2' ],
111 [ 'table2' => [ 'LEFT JOIN', 't1_id = t2_id' ] ],
112 'table1 LEFT JOIN table2 ON ((t1_id = t2_id))'
114 'real join with multiple conditionals' => [
115 [ 'table1', 'table2' ],
116 [ 'table2' => [ 'LEFT JOIN', [ 't1_id = t2_id', 't2_x = \'X\'' ] ] ],
117 'table1 LEFT JOIN table2 ON ((t1_id = t2_id) AND (t2_x = \'X\'))'
119 'join with parenthesized group' => [
120 [ 'table1', 'n' => [ 'table2', 'table3' ] ],
122 'table3' => [ 'JOIN', 't2_id = t3_id' ],
123 'n' => [ 'LEFT JOIN', 't1_id = t2_id' ],
125 'table1 LEFT JOIN (table2 JOIN table3 ON ((t2_id = t3_id))) ON ((t1_id = t2_id))'
127 'join with degenerate parenthesized group' => [
128 [ 'table1', 'n' => [ 't2' => 'table2' ] ],
130 'n' => [ 'LEFT JOIN', 't1_id = t2_id' ],
132 'table1 LEFT JOIN table2 t2 ON ((t1_id = t2_id))'
138 * @dataProvider provideTableNamesWithIndexClauseOrJOIN
139 * @covers Wikimedia\Rdbms\Database::tableNamesWithIndexClauseOrJOIN
141 public function testTableNamesWithIndexClauseOrJOIN( $tables, $join_conds, $expect ) {
142 $clause = TestingAccessWrapper
::newFromObject( $this->db
)
143 ->tableNamesWithIndexClauseOrJOIN( $tables, [], [], $join_conds );
144 $this->assertSame( $expect, $clause );
148 * @covers Wikimedia\Rdbms\Database::onTransactionIdle
149 * @covers Wikimedia\Rdbms\Database::runOnTransactionIdleCallbacks
151 public function testTransactionIdle() {
154 $db->setFlag( DBO_TRX
);
157 $db->onTransactionIdle(
158 function () use ( $db, &$flagSet, &$called ) {
160 $flagSet = $db->getFlag( DBO_TRX
);
164 $this->assertFalse( $flagSet, 'DBO_TRX off in callback' );
165 $this->assertTrue( $db->getFlag( DBO_TRX
), 'DBO_TRX restored to default' );
166 $this->assertTrue( $called, 'Callback reached' );
168 $db->clearFlag( DBO_TRX
);
170 $db->onTransactionIdle(
171 function () use ( $db, &$flagSet ) {
172 $flagSet = $db->getFlag( DBO_TRX
);
176 $this->assertFalse( $flagSet, 'DBO_TRX off in callback' );
177 $this->assertFalse( $db->getFlag( DBO_TRX
), 'DBO_TRX restored to default' );
179 $db->clearFlag( DBO_TRX
);
180 $db->onTransactionIdle(
181 function () use ( $db ) {
182 $db->setFlag( DBO_TRX
);
186 $this->assertFalse( $db->getFlag( DBO_TRX
), 'DBO_TRX restored to default' );
190 * @covers Wikimedia\Rdbms\Database::onTransactionPreCommitOrIdle
191 * @covers Wikimedia\Rdbms\Database::runOnTransactionPreCommitCallbacks
193 public function testTransactionPreCommitOrIdle() {
194 $db = $this->getMockDB( [ 'isOpen' ] );
195 $db->method( 'isOpen' )->willReturn( true );
196 $db->clearFlag( DBO_TRX
);
198 $this->assertFalse( $db->getFlag( DBO_TRX
), 'DBO_TRX is not set' );
201 $db->onTransactionPreCommitOrIdle(
202 function () use ( &$called ) {
207 $this->assertTrue( $called, 'Called when idle' );
209 $db->begin( __METHOD__
);
211 $db->onTransactionPreCommitOrIdle(
212 function () use ( &$called ) {
217 $this->assertFalse( $called, 'Not called when transaction is active' );
218 $db->commit( __METHOD__
);
219 $this->assertTrue( $called, 'Called when transaction is committed' );
223 * @covers Wikimedia\Rdbms\Database::onTransactionPreCommitOrIdle
224 * @covers Wikimedia\Rdbms\Database::runOnTransactionPreCommitCallbacks
226 public function testTransactionPreCommitOrIdle_TRX() {
227 $db = $this->getMockDB( [ 'isOpen' ] );
228 $db->method( 'isOpen' )->willReturn( true );
229 $db->setFlag( DBO_TRX
);
231 $lbFactory = LBFactorySingle
::newFromConnection( $db );
232 // Ask for the connectin so that LB sets internal state
233 // about this connection being the master connection
234 $lb = $lbFactory->getMainLB();
235 $conn = $lb->openConnection( $lb->getWriterIndex() );
236 $this->assertSame( $db, $conn, 'Same DB instance' );
237 $this->assertTrue( $db->getFlag( DBO_TRX
), 'DBO_TRX is set' );
240 $db->onTransactionPreCommitOrIdle(
241 function () use ( &$called ) {
245 $this->assertFalse( $called, 'Not called when idle if DBO_TRX is set' );
247 $lbFactory->beginMasterChanges( __METHOD__
);
248 $this->assertFalse( $called, 'Not called when lb-transaction is active' );
250 $lbFactory->commitMasterChanges( __METHOD__
);
251 $this->assertTrue( $called, 'Called when lb-transaction is committed' );
255 * @covers Wikimedia\Rdbms\Database::onTransactionResolution
256 * @covers Wikimedia\Rdbms\Database::runOnTransactionIdleCallbacks
258 public function testTransactionResolution() {
261 $db->clearFlag( DBO_TRX
);
262 $db->begin( __METHOD__
);
264 $db->onTransactionResolution( function () use ( $db, &$called ) {
266 $db->setFlag( DBO_TRX
);
268 $db->commit( __METHOD__
);
269 $this->assertFalse( $db->getFlag( DBO_TRX
), 'DBO_TRX restored to default' );
270 $this->assertTrue( $called, 'Callback reached' );
272 $db->clearFlag( DBO_TRX
);
273 $db->begin( __METHOD__
);
275 $db->onTransactionResolution( function () use ( $db, &$called ) {
277 $db->setFlag( DBO_TRX
);
279 $db->rollback( __METHOD__
, IDatabase
::FLUSHING_ALL_PEERS
);
280 $this->assertFalse( $db->getFlag( DBO_TRX
), 'DBO_TRX restored to default' );
281 $this->assertTrue( $called, 'Callback reached' );
285 * @covers Wikimedia\Rdbms\Database::setTransactionListener
287 public function testTransactionListener() {
290 $db->setTransactionListener( 'ping', function () use ( $db, &$called ) {
295 $db->begin( __METHOD__
);
296 $db->commit( __METHOD__
);
297 $this->assertTrue( $called, 'Callback reached' );
300 $db->begin( __METHOD__
);
301 $db->commit( __METHOD__
);
302 $this->assertTrue( $called, 'Callback still reached' );
305 $db->begin( __METHOD__
);
306 $db->rollback( __METHOD__
);
307 $this->assertTrue( $called, 'Callback reached' );
309 $db->setTransactionListener( 'ping', null );
311 $db->begin( __METHOD__
);
312 $db->commit( __METHOD__
);
313 $this->assertFalse( $called, 'Callback not reached' );
317 * Use this mock instead of DatabaseTestHelper for cases where
318 * DatabaseTestHelper is too inflexibile due to mocking too much
319 * or being too restrictive about fname matching (e.g. for tests
320 * that assert behaviour when the name is a mismatch, we need to
321 * catch the error here instead of there).
325 private function getMockDB( $methods = [] ) {
326 static $abstractMethods = [
327 'fetchAffectedRowCount',
331 'fetchObject', 'fetchRow',
332 'fieldInfo', 'fieldName',
333 'getSoftwareLink', 'getServerVersion',
337 'lastError', 'lastErrno',
338 'numFields', 'numRows',
342 $db = $this->getMockBuilder( Database
::class )
343 ->disableOriginalConstructor()
344 ->setMethods( array_values( array_unique( array_merge(
349 $wdb = TestingAccessWrapper
::newFromObject( $db );
350 $wdb->trxProfiler
= new TransactionProfiler();
351 $wdb->connLogger
= new \Psr\Log\
NullLogger();
352 $wdb->queryLogger
= new \Psr\Log\
NullLogger();
357 * @covers Wikimedia\Rdbms\Database::flushSnapshot
359 public function testFlushSnapshot() {
360 $db = $this->getMockDB( [ 'isOpen' ] );
361 $db->method( 'isOpen' )->willReturn( true );
363 $db->flushSnapshot( __METHOD__
); // ok
364 $db->flushSnapshot( __METHOD__
); // ok
366 $db->setFlag( DBO_TRX
, $db::REMEMBER_PRIOR
);
367 $db->query( 'SELECT 1', __METHOD__
);
368 $this->assertTrue( (bool)$db->trxLevel(), "Transaction started." );
369 $db->flushSnapshot( __METHOD__
); // ok
370 $db->restoreFlags( $db::RESTORE_PRIOR
);
372 $this->assertFalse( (bool)$db->trxLevel(), "Transaction cleared." );
376 * @covers Wikimedia\Rdbms\Database::getScopedLockAndFlush
377 * @covers Wikimedia\Rdbms\Database::lock
378 * @covers Wikimedia\Rdbms\Database::unlock
379 * @covers Wikimedia\Rdbms\Database::lockIsFree
381 public function testGetScopedLock() {
382 $db = $this->getMockDB( [ 'isOpen' ] );
383 $db->method( 'isOpen' )->willReturn( true );
385 $this->assertEquals( 0, $db->trxLevel() );
386 $this->assertEquals( true, $db->lockIsFree( 'x', __METHOD__
) );
387 $this->assertEquals( true, $db->lock( 'x', __METHOD__
) );
388 $this->assertEquals( false, $db->lockIsFree( 'x', __METHOD__
) );
389 $this->assertEquals( true, $db->unlock( 'x', __METHOD__
) );
390 $this->assertEquals( true, $db->lockIsFree( 'x', __METHOD__
) );
391 $this->assertEquals( 0, $db->trxLevel() );
393 $db->setFlag( DBO_TRX
);
394 $this->assertEquals( true, $db->lockIsFree( 'x', __METHOD__
) );
395 $this->assertEquals( true, $db->lock( 'x', __METHOD__
) );
396 $this->assertEquals( false, $db->lockIsFree( 'x', __METHOD__
) );
397 $this->assertEquals( true, $db->unlock( 'x', __METHOD__
) );
398 $this->assertEquals( true, $db->lockIsFree( 'x', __METHOD__
) );
399 $db->clearFlag( DBO_TRX
);
401 $this->assertEquals( 0, $db->trxLevel() );
403 $db->setFlag( DBO_TRX
);
405 $this->badLockingMethodImplicit( $db );
406 } catch ( RunTimeException
$e ) {
407 $this->assertTrue( $db->trxLevel() > 0, "Transaction not committed." );
409 $db->clearFlag( DBO_TRX
);
410 $db->rollback( __METHOD__
, IDatabase
::FLUSHING_ALL_PEERS
);
411 $this->assertTrue( $db->lockIsFree( 'meow', __METHOD__
) );
414 $this->badLockingMethodExplicit( $db );
415 } catch ( RunTimeException
$e ) {
416 $this->assertTrue( $db->trxLevel() > 0, "Transaction not committed." );
418 $db->rollback( __METHOD__
, IDatabase
::FLUSHING_ALL_PEERS
);
419 $this->assertTrue( $db->lockIsFree( 'meow', __METHOD__
) );
422 private function badLockingMethodImplicit( IDatabase
$db ) {
423 $lock = $db->getScopedLockAndFlush( 'meow', __METHOD__
, 1 );
424 $db->query( "SELECT 1" ); // trigger DBO_TRX
425 throw new RunTimeException( "Uh oh!" );
428 private function badLockingMethodExplicit( IDatabase
$db ) {
429 $lock = $db->getScopedLockAndFlush( 'meow', __METHOD__
, 1 );
430 $db->begin( __METHOD__
);
431 throw new RunTimeException( "Uh oh!" );
435 * @covers Wikimedia\Rdbms\Database::getFlag
436 * @covers Wikimedia\Rdbms\Database::setFlag
437 * @covers Wikimedia\Rdbms\Database::restoreFlags
439 public function testFlagSetting() {
441 $origTrx = $db->getFlag( DBO_TRX
);
442 $origSsl = $db->getFlag( DBO_SSL
);
445 ?
$db->clearFlag( DBO_TRX
, $db::REMEMBER_PRIOR
)
446 : $db->setFlag( DBO_TRX
, $db::REMEMBER_PRIOR
);
447 $this->assertEquals( !$origTrx, $db->getFlag( DBO_TRX
) );
450 ?
$db->clearFlag( DBO_SSL
, $db::REMEMBER_PRIOR
)
451 : $db->setFlag( DBO_SSL
, $db::REMEMBER_PRIOR
);
452 $this->assertEquals( !$origSsl, $db->getFlag( DBO_SSL
) );
454 $db->restoreFlags( $db::RESTORE_INITIAL
);
455 $this->assertEquals( $origTrx, $db->getFlag( DBO_TRX
) );
456 $this->assertEquals( $origSsl, $db->getFlag( DBO_SSL
) );
459 ?
$db->clearFlag( DBO_TRX
, $db::REMEMBER_PRIOR
)
460 : $db->setFlag( DBO_TRX
, $db::REMEMBER_PRIOR
);
462 ?
$db->clearFlag( DBO_SSL
, $db::REMEMBER_PRIOR
)
463 : $db->setFlag( DBO_SSL
, $db::REMEMBER_PRIOR
);
466 $this->assertEquals( $origSsl, $db->getFlag( DBO_SSL
) );
467 $this->assertEquals( !$origTrx, $db->getFlag( DBO_TRX
) );
470 $this->assertEquals( $origSsl, $db->getFlag( DBO_SSL
) );
471 $this->assertEquals( $origTrx, $db->getFlag( DBO_TRX
) );
475 * @expectedException UnexpectedValueException
476 * @covers Wikimedia\Rdbms\Database::setFlag
478 public function testDBOIgnoreSet() {
479 $db = $this->getMockBuilder( DatabaseMysqli
::class )
480 ->disableOriginalConstructor()
484 $db->setFlag( Database
::DBO_IGNORE
);
488 * @expectedException UnexpectedValueException
489 * @covers Wikimedia\Rdbms\Database::clearFlag
491 public function testDBOIgnoreClear() {
492 $db = $this->getMockBuilder( DatabaseMysqli
::class )
493 ->disableOriginalConstructor()
497 $db->clearFlag( Database
::DBO_IGNORE
);
501 * @covers Wikimedia\Rdbms\Database::tablePrefix
502 * @covers Wikimedia\Rdbms\Database::dbSchema
504 public function testMutators() {
505 $old = $this->db
->tablePrefix();
506 $this->assertInternalType( 'string', $old, 'Prefix is string' );
507 $this->assertEquals( $old, $this->db
->tablePrefix(), "Prefix unchanged" );
508 $this->assertEquals( $old, $this->db
->tablePrefix( 'xxx' ) );
509 $this->assertEquals( 'xxx', $this->db
->tablePrefix(), "Prefix set" );
510 $this->db
->tablePrefix( $old );
511 $this->assertNotEquals( 'xxx', $this->db
->tablePrefix() );
513 $old = $this->db
->dbSchema();
514 $this->assertInternalType( 'string', $old, 'Schema is string' );
515 $this->assertEquals( $old, $this->db
->dbSchema(), "Schema unchanged" );
516 $this->assertEquals( $old, $this->db
->dbSchema( 'xxx' ) );
517 $this->assertEquals( 'xxx', $this->db
->dbSchema(), "Schema set" );
518 $this->db
->dbSchema( $old );
519 $this->assertNotEquals( 'xxx', $this->db
->dbSchema() );