1 files changed, 530 insertions, 0 deletions
diff --git a/www/wiki/tests/phpunit/includes/db/LBFactoryTest.php b/www/wiki/tests/phpunit/includes/db/LBFactoryTest.php
new file mode 100644
index 00000000..ed4c977f
--- /dev/null
+++ b/www/wiki/tests/phpunit/includes/db/LBFactoryTest.php
@@ -0,0 +1,530 @@
+<?php
+/**
+ * Holds tests for LBFactory abstract MediaWiki class.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @author Antoine Musso
+ * @copyright © 2013 Antoine Musso
+ * @copyright © 2013 Wikimedia Foundation Inc.
+ */
+
+use Wikimedia\Rdbms\LBFactorySimple;
+use Wikimedia\Rdbms\LBFactoryMulti;
+use Wikimedia\Rdbms\LoadBalancer;
+use Wikimedia\Rdbms\ChronologyProtector;
+use Wikimedia\Rdbms\DatabaseMysqli;
+use Wikimedia\Rdbms\MySQLMasterPos;
+use Wikimedia\Rdbms\DatabaseDomain;
+
+/**
+ * @group Database
+ * @covers \Wikimedia\Rdbms\LBFactorySimple
+ * @covers \Wikimedia\Rdbms\LBFactoryMulti
+ */
+class LBFactoryTest extends MediaWikiTestCase {
+
+	/**
+	 * @covers MWLBFactory::getLBFactoryClass
+	 * @dataProvider getLBFactoryClassProvider
+	 */
+	public function testGetLBFactoryClass( $expected, $deprecated ) {
+		$mockDB = $this->getMockBuilder( DatabaseMysqli::class )
+			->disableOriginalConstructor()
+			->getMock();
+
+		$config = [
+			'class'          => $deprecated,
+			'connection'     => $mockDB,
+			# Various other parameters required:
+			'sectionsByDB'   => [],
+			'sectionLoads'   => [],
+			'serverTemplate' => [],
+		];
+
+		$this->hideDeprecated( '$wgLBFactoryConf must be updated. See RELEASE-NOTES for details' );
+		$result = MWLBFactory::getLBFactoryClass( $config );
+
+		$this->assertEquals( $expected, $result );
+	}
+
+	public function getLBFactoryClassProvider() {
+		return [
+			# Format: new class, old class
+			[ Wikimedia\Rdbms\LBFactorySimple::class, 'LBFactory_Simple' ],
+			[ Wikimedia\Rdbms\LBFactorySingle::class, 'LBFactory_Single' ],
+			[ Wikimedia\Rdbms\LBFactoryMulti::class, 'LBFactory_Multi' ],
+			[ Wikimedia\Rdbms\LBFactorySimple::class, 'LBFactorySimple' ],
+			[ Wikimedia\Rdbms\LBFactorySingle::class, 'LBFactorySingle' ],
+			[ Wikimedia\Rdbms\LBFactoryMulti::class, 'LBFactoryMulti' ],
+		];
+	}
+
+	public function testLBFactorySimpleServer() {
+		global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
+
+		$servers = [
+			[
+				'host'        => $wgDBserver,
+				'dbname'      => $wgDBname,
+				'user'        => $wgDBuser,
+				'password'    => $wgDBpassword,
+				'type'        => $wgDBtype,
+				'dbDirectory' => $wgSQLiteDataDir,
+				'load'        => 0,
+				'flags'       => DBO_TRX // REPEATABLE-READ for consistency
+			],
+		];
+
+		$factory = new LBFactorySimple( [ 'servers' => $servers ] );
+		$lb = $factory->getMainLB();
+
+		$dbw = $lb->getConnection( DB_MASTER );
+		$this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
+
+		$dbr = $lb->getConnection( DB_REPLICA );
+		$this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
+
+		$factory->shutdown();
+		$lb->closeAll();
+	}
+
+	public function testLBFactorySimpleServers() {
+		global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
+
+		$servers = [
+			[ // master
+				'host'        => $wgDBserver,
+				'dbname'      => $wgDBname,
+				'user'        => $wgDBuser,
+				'password'    => $wgDBpassword,
+				'type'        => $wgDBtype,
+				'dbDirectory' => $wgSQLiteDataDir,
+				'load'        => 0,
+				'flags'       => DBO_TRX // REPEATABLE-READ for consistency
+			],
+			[ // emulated slave
+				'host'        => $wgDBserver,
+				'dbname'      => $wgDBname,
+				'user'        => $wgDBuser,
+				'password'    => $wgDBpassword,
+				'type'        => $wgDBtype,
+				'dbDirectory' => $wgSQLiteDataDir,
+				'load'        => 100,
+				'flags'       => DBO_TRX // REPEATABLE-READ for consistency
+			]
+		];
+
+		$factory = new LBFactorySimple( [
+			'servers' => $servers,
+			'loadMonitorClass' => LoadMonitorNull::class
+		] );
+		$lb = $factory->getMainLB();
+
+		$dbw = $lb->getConnection( DB_MASTER );
+		$this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
+		$this->assertEquals(
+			( $wgDBserver != '' ) ? $wgDBserver : 'localhost',
+			$dbw->getLBInfo( 'clusterMasterHost' ),
+			'cluster master set' );
+
+		$dbr = $lb->getConnection( DB_REPLICA );
+		$this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
+		$this->assertEquals(
+			( $wgDBserver != '' ) ? $wgDBserver : 'localhost',
+			$dbr->getLBInfo( 'clusterMasterHost' ),
+			'cluster master set' );
+
+		$factory->shutdown();
+		$lb->closeAll();
+	}
+
+	public function testLBFactoryMulti() {
+		global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
+
+		$factory = new LBFactoryMulti( [
+			'sectionsByDB' => [],
+			'sectionLoads' => [
+				'DEFAULT' => [
+					'test-db1' => 0,
+					'test-db2' => 100,
+				],
+			],
+			'serverTemplate' => [
+				'dbname'      => $wgDBname,
+				'user'        => $wgDBuser,
+				'password'    => $wgDBpassword,
+				'type'        => $wgDBtype,
+				'dbDirectory' => $wgSQLiteDataDir,
+				'flags'       => DBO_DEFAULT
+			],
+			'hostsByName' => [
+				'test-db1'  => $wgDBserver,
+				'test-db2'  => $wgDBserver
+			],
+			'loadMonitorClass' => LoadMonitorNull::class
+		] );
+		$lb = $factory->getMainLB();
+
+		$dbw = $lb->getConnection( DB_MASTER );
+		$this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
+
+		$dbr = $lb->getConnection( DB_REPLICA );
+		$this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
+
+		$factory->shutdown();
+		$lb->closeAll();
+	}
+
+	/**
+	 * @covers \Wikimedia\Rdbms\ChronologyProtector
+	 */
+	public function testChronologyProtector() {
+		$now = microtime( true );
+
+		// (a) First HTTP request
+		$m1Pos = new MySQLMasterPos( 'db1034-bin.000976/843431247', $now );
+		$m2Pos = new MySQLMasterPos( 'db1064-bin.002400/794074907', $now );
+
+		// Master DB 1
+		$mockDB1 = $this->getMockBuilder( DatabaseMysqli::class )
+			->disableOriginalConstructor()
+			->getMock();
+		$mockDB1->method( 'writesOrCallbacksPending' )->willReturn( true );
+		$mockDB1->method( 'lastDoneWrites' )->willReturn( $now );
+		$mockDB1->method( 'getMasterPos' )->willReturn( $m1Pos );
+		// Load balancer for master DB 1
+		$lb1 = $this->getMockBuilder( LoadBalancer::class )
+			->disableOriginalConstructor()
+			->getMock();
+		$lb1->method( 'getConnection' )->willReturn( $mockDB1 );
+		$lb1->method( 'getServerCount' )->willReturn( 2 );
+		$lb1->method( 'getAnyOpenConnection' )->willReturn( $mockDB1 );
+		$lb1->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
+				function () use ( $mockDB1 ) {
+					$p = 0;
+					$p |= call_user_func( [ $mockDB1, 'writesOrCallbacksPending' ] );
+					$p |= call_user_func( [ $mockDB1, 'lastDoneWrites' ] );
+
+					return (bool)$p;
+				}
+			) );
+		$lb1->method( 'getMasterPos' )->willReturn( $m1Pos );
+		$lb1->method( 'getServerName' )->with( 0 )->willReturn( 'master1' );
+		// Master DB 2
+		$mockDB2 = $this->getMockBuilder( DatabaseMysqli::class )
+			->disableOriginalConstructor()
+			->getMock();
+		$mockDB2->method( 'writesOrCallbacksPending' )->willReturn( true );
+		$mockDB2->method( 'lastDoneWrites' )->willReturn( $now );
+		$mockDB2->method( 'getMasterPos' )->willReturn( $m2Pos );
+		// Load balancer for master DB 2
+		$lb2 = $this->getMockBuilder( LoadBalancer::class )
+			->disableOriginalConstructor()
+			->getMock();
+		$lb2->method( 'getConnection' )->willReturn( $mockDB2 );
+		$lb2->method( 'getServerCount' )->willReturn( 2 );
+		$lb2->method( 'getAnyOpenConnection' )->willReturn( $mockDB2 );
+		$lb2->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
+			function () use ( $mockDB2 ) {
+				$p = 0;
+				$p |= call_user_func( [ $mockDB2, 'writesOrCallbacksPending' ] );
+				$p |= call_user_func( [ $mockDB2, 'lastDoneWrites' ] );
+
+				return (bool)$p;
+			}
+		) );
+		$lb2->method( 'getMasterPos' )->willReturn( $m2Pos );
+		$lb2->method( 'getServerName' )->with( 0 )->willReturn( 'master2' );
+
+		$bag = new HashBagOStuff();
+		$cp = new ChronologyProtector(
+			$bag,
+			[
+				'ip' => '127.0.0.1',
+				'agent' => "Totally-Not-FireFox"
+			]
+		);
+
+		$mockDB1->expects( $this->exactly( 1 ) )->method( 'writesOrCallbacksPending' );
+		$mockDB1->expects( $this->exactly( 1 ) )->method( 'lastDoneWrites' );
+		$mockDB2->expects( $this->exactly( 1 ) )->method( 'writesOrCallbacksPending' );
+		$mockDB2->expects( $this->exactly( 1 ) )->method( 'lastDoneWrites' );
+
+		// Nothing to wait for on first HTTP request start
+		$cp->initLB( $lb1 );
+		$cp->initLB( $lb2 );
+		// Record positions in stash on first HTTP request end
+		$cp->shutdownLB( $lb1 );
+		$cp->shutdownLB( $lb2 );
+		$cpIndex = null;
+		$cp->shutdown( null, 'sync', $cpIndex );
+
+		$this->assertEquals( 1, $cpIndex, "CP write index set" );
+
+		// (b) Second HTTP request
+
+		// Load balancer for master DB 1
+		$lb1 = $this->getMockBuilder( LoadBalancer::class )
+			->disableOriginalConstructor()
+			->getMock();
+		$lb1->method( 'getServerCount' )->willReturn( 2 );
+		$lb1->method( 'getServerName' )->with( 0 )->willReturn( 'master1' );
+		$lb1->expects( $this->once() )
+			->method( 'waitFor' )->with( $this->equalTo( $m1Pos ) );
+		// Load balancer for master DB 2
+		$lb2 = $this->getMockBuilder( LoadBalancer::class )
+			->disableOriginalConstructor()
+			->getMock();
+		$lb2->method( 'getServerCount' )->willReturn( 2 );
+		$lb2->method( 'getServerName' )->with( 0 )->willReturn( 'master2' );
+		$lb2->expects( $this->once() )
+			->method( 'waitFor' )->with( $this->equalTo( $m2Pos ) );
+
+		$cp = new ChronologyProtector(
+			$bag,
+			[
+				'ip' => '127.0.0.1',
+				'agent' => "Totally-Not-FireFox"
+			],
+			$cpIndex
+		);
+
+		// Wait for last positions to be reached on second HTTP request start
+		$cp->initLB( $lb1 );
+		$cp->initLB( $lb2 );
+		// Shutdown (nothing to record)
+		$cp->shutdownLB( $lb1 );
+		$cp->shutdownLB( $lb2 );
+		$cpIndex = null;
+		$cp->shutdown( null, 'sync', $cpIndex );
+
+		$this->assertEquals( null, $cpIndex, "CP write index retained" );
+	}
+
+	private function newLBFactoryMulti( array $baseOverride = [], array $serverOverride = [] ) {
+		global $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, $wgDBprefix, $wgDBtype;
+		global $wgSQLiteDataDir;
+
+		return new LBFactoryMulti( $baseOverride + [
+			'sectionsByDB' => [],
+			'sectionLoads' => [
+				'DEFAULT' => [
+					'test-db1' => 1,
+				],
+			],
+			'serverTemplate' => $serverOverride + [
+				'dbname' => $wgDBname,
+				'tablePrefix' => $wgDBprefix,
+				'user' => $wgDBuser,
+				'password' => $wgDBpassword,
+				'type' => $wgDBtype,
+				'dbDirectory' => $wgSQLiteDataDir,
+				'flags' => DBO_DEFAULT
+			],
+			'hostsByName' => [
+				'test-db1' => $wgDBserver,
+			],
+			'loadMonitorClass' => LoadMonitorNull::class,
+			'localDomain' => new DatabaseDomain( $wgDBname, null, $wgDBprefix )
+		] );
+	}
+
+	public function testNiceDomains() {
+		global $wgDBname;
+
+		if ( wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
+			self::markTestSkipped( "Skipping tests about selecting DBs: not applicable" );
+			return;
+		}
+
+		$factory = $this->newLBFactoryMulti(
+			[],
+			[]
+		);
+		$lb = $factory->getMainLB();
+
+		$db = $lb->getConnectionRef( DB_MASTER );
+		$this->assertEquals(
+			wfWikiID(),
+			$db->getDomainID()
+		);
+		unset( $db );
+
+		/** @var Database $db */
+		$db = $lb->getConnection( DB_MASTER, [], '' );
+
+		$this->assertEquals(
+			'',
+			$db->getDomainId(),
+			'Null domain ID handle used'
+		);
+		$this->assertEquals(
+			'',
+			$db->getDBname(),
+			'Null domain ID handle used'
+		);
+		$this->assertEquals(
+			'',
+			$db->tablePrefix(),
+			'Main domain ID handle used; prefix is empty though'
+		);
+		$this->assertEquals(
+			$this->quoteTable( $db, 'page' ),
+			$db->tableName( 'page' ),
+			"Correct full table name"
+		);
+		$this->assertEquals(
+			$this->quoteTable( $db, $wgDBname ) . '.' . $this->quoteTable( $db, 'page' ),
+			$db->tableName( "$wgDBname.page" ),
+			"Correct full table name"
+		);
+		$this->assertEquals(
+			$this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
+			$db->tableName( 'nice_db.page' ),
+			"Correct full table name"
+		);
+
+		$lb->reuseConnection( $db ); // don't care
+
+		$db = $lb->getConnection( DB_MASTER ); // local domain connection
+		$factory->setDomainPrefix( 'my_' );
+
+		$this->assertEquals( $wgDBname, $db->getDBname() );
+		$this->assertEquals(
+			"$wgDBname-my_",
+			$db->getDomainID()
+		);
+		$this->assertEquals(
+			$this->quoteTable( $db, 'my_page' ),
+			$db->tableName( 'page' ),
+			"Correct full table name"
+		);
+		$this->assertEquals(
+			$this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
+			$db->tableName( 'other_nice_db.page' ),
+			"Correct full table name"
+		);
+
+		$factory->closeAll();
+		$factory->destroy();
+	}
+
+	public function testTrickyDomain() {
+		global $wgDBname;
+
+		if ( wfGetDB( DB_MASTER )->databasesAreIndependent() ) {
+			self::markTestSkipped( "Skipping tests about selecting DBs: not applicable" );
+			return;
+		}
+
+		$dbname = 'unittest-domain'; // explodes if DB is selected
+		$factory = $this->newLBFactoryMulti(
+			[ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
+			[
+				'dbName' => 'do_not_select_me' // explodes if DB is selected
+			]
+		);
+		$lb = $factory->getMainLB();
+		/** @var Database $db */
+		$db = $lb->getConnection( DB_MASTER, [], '' );
+
+		$this->assertEquals( '', $db->getDomainID(), "Null domain used" );
+
+		$this->assertEquals(
+			$this->quoteTable( $db, 'page' ),
+			$db->tableName( 'page' ),
+			"Correct full table name"
+		);
+
+		$this->assertEquals(
+			$this->quoteTable( $db, $dbname ) . '.' . $this->quoteTable( $db, 'page' ),
+			$db->tableName( "$dbname.page" ),
+			"Correct full table name"
+		);
+
+		$this->assertEquals(
+			$this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
+			$db->tableName( 'nice_db.page' ),
+			"Correct full table name"
+		);
+
+		$lb->reuseConnection( $db ); // don't care
+
+		$factory->setDomainPrefix( 'my_' );
+		$db = $lb->getConnection( DB_MASTER, [], "$wgDBname-my_" );
+
+		$this->assertEquals(
+			$this->quoteTable( $db, 'my_page' ),
+			$db->tableName( 'page' ),
+			"Correct full table name"
+		);
+		$this->assertEquals(
+			$this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
+			$db->tableName( 'other_nice_db.page' ),
+			"Correct full table name"
+		);
+		$this->assertEquals(
+			$this->quoteTable( $db, 'garbage-db' ) . '.' . $this->quoteTable( $db, 'page' ),
+			$db->tableName( 'garbage-db.page' ),
+			"Correct full table name"
+		);
+
+		$lb->reuseConnection( $db ); // don't care
+
+		$factory->closeAll();
+		$factory->destroy();
+	}
+
+	public function testInvalidSelectDB() {
+		$dbname = 'unittest-domain'; // explodes if DB is selected
+		$factory = $this->newLBFactoryMulti(
+			[ 'localDomain' => ( new DatabaseDomain( $dbname, null, '' ) )->getId() ],
+			[
+				'dbName' => 'do_not_select_me' // explodes if DB is selected
+			]
+		);
+		$lb = $factory->getMainLB();
+		/** @var Database $db */
+		$db = $lb->getConnection( DB_MASTER, [], '' );
+
+		if ( $db->getType() === 'sqlite' ) {
+			$this->assertFalse( $db->selectDB( 'garbage-db' ) );
+		} elseif ( $db->databasesAreIndependent() ) {
+			try {
+				$e = null;
+				$db->selectDB( 'garbage-db' );
+			} catch ( \Wikimedia\Rdbms\DBConnectionError $e ) {
+				// expected
+			}
+			$this->assertInstanceOf( \Wikimedia\Rdbms\DBConnectionError::class, $e );
+			$this->assertFalse( $db->isOpen() );
+		} else {
+			\Wikimedia\suppressWarnings();
+			$this->assertFalse( $db->selectDB( 'garbage-db' ) );
+			\Wikimedia\restoreWarnings();
+		}
+	}
+
+	private function quoteTable( Database $db, $table ) {
+		if ( $db->getType() === 'sqlite' ) {
+			return $table;
+		} else {
+			return $db->addIdentifierQuotes( $table );
+		}
+	}
+}