LBFactoryTest.php

Go to the documentation of this file.

<?php
class LBFactoryTest extends MediaWikiTestCase {

    public function testGetLBFactoryClass( $expected, $deprecated ) {
        $mockDB = $this->getMockBuilder( 'DatabaseMysql' )
            ->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 = LBFactory::getLBFactoryClass( $config );

        $this->assertEquals( $expected, $result );
    }

    public function getLBFactoryClassProvider() {
        return [
            # Format: new class, old class
            [ 'LBFactorySimple', 'LBFactory_Simple' ],
            [ 'LBFactorySingle', 'LBFactory_Single' ],
            [ 'LBFactoryMulti', 'LBFactory_Multi' ],
            [ 'LBFactoryFake', 'LBFactory_Fake' ],
        ];
    }

    public function testLBFactorySimpleServer() {
        $this->setMwGlobals( 'wgDBservers', false );

        $factory = new LBFactorySimple( [] );
        $lb = $factory->getMainLB();

        $dbw = $lb->getConnection( DB_MASTER );
        $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );

        $dbr = $lb->getConnection( DB_SLAVE );
        $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_SLAVE also gets the master' );

        $factory->shutdown();
        $lb->closeAll();
    }

    public function testLBFactorySimpleServers() {
        global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype;

        $this->setMwGlobals( 'wgDBservers', [
            [ // master
                'host'      => $wgDBserver,
                'dbname'    => $wgDBname,
                'user'      => $wgDBuser,
                'password'  => $wgDBpassword,
                'type'      => $wgDBtype,
                'load'      => 0,
                'flags'     => DBO_TRX // REPEATABLE-READ for consistency
            ],
            [ // emulated slave
                'host'      => $wgDBserver,
                'dbname'    => $wgDBname,
                'user'      => $wgDBuser,
                'password'  => $wgDBpassword,
                'type'      => $wgDBtype,
                'load'      => 100,
                'flags'     => DBO_TRX // REPEATABLE-READ for consistency
            ]
        ] );

        $factory = new LBFactorySimple( [ 'loadMonitorClass' => 'LoadMonitorNull' ] );
        $lb = $factory->getMainLB();

        $dbw = $lb->getConnection( DB_MASTER );
        $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
        $this->assertEquals(
            $wgDBserver, $dbw->getLBInfo( 'clusterMasterHost' ), 'cluster master set' );

        $dbr = $lb->getConnection( DB_SLAVE );
        $this->assertTrue( $dbr->getLBInfo( 'slave' ), 'slave shows as slave' );
        $this->assertEquals(
            $wgDBserver, $dbr->getLBInfo( 'clusterMasterHost' ), 'cluster master set' );

        $factory->shutdown();
        $lb->closeAll();
    }

    public function testLBFactoryMulti() {
        global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype;

        $factory = new LBFactoryMulti( [
            'sectionsByDB' => [],
            'sectionLoads' => [
                'DEFAULT' => [
                    'test-db1' => 0,
                    'test-db2' => 100,
                ],
            ],
            'serverTemplate' => [
                'dbname'      => $wgDBname,
                'user'        => $wgDBuser,
                'password'    => $wgDBpassword,
                'type'        => $wgDBtype,
                'flags'       => DBO_DEFAULT
            ],
            'hostsByName' => [
                'test-db1'  => $wgDBserver,
                'test-db2'  => $wgDBserver
            ],
            'loadMonitorClass' => 'LoadMonitorNull'
        ] );
        $lb = $factory->getMainLB();

        $dbw = $lb->getConnection( DB_MASTER );
        $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );

        $dbr = $lb->getConnection( DB_SLAVE );
        $this->assertTrue( $dbr->getLBInfo( 'slave' ), 'slave shows as slave' );

        $factory->shutdown();
        $lb->closeAll();
    }

    public function testChronologyProtector() {
        // (a) First HTTP request
        $mPos = new MySQLMasterPos( 'db1034-bin.000976', '843431247' );

        $mockDB = $this->getMockBuilder( 'DatabaseMysql' )
            ->disableOriginalConstructor()
            ->getMock();
        $mockDB->expects( $this->any() )
            ->method( 'doneWrites' )->will( $this->returnValue( true ) );
        $mockDB->expects( $this->any() )
            ->method( 'getMasterPos' )->will( $this->returnValue( $mPos ) );

        $lb = $this->getMockBuilder( 'LoadBalancer' )
            ->disableOriginalConstructor()
            ->getMock();
        $lb->expects( $this->any() )
            ->method( 'getConnection' )->will( $this->returnValue( $mockDB ) );
        $lb->expects( $this->any() )
            ->method( 'getServerCount' )->will( $this->returnValue( 2 ) );
        $lb->expects( $this->any() )
            ->method( 'parentInfo' )->will( $this->returnValue( [ 'id' => "main-DEFAULT" ] ) );
        $lb->expects( $this->any() )
            ->method( 'getAnyOpenConnection' )->will( $this->returnValue( $mockDB ) );

        $bag = new HashBagOStuff();
        $cp = new ChronologyProtector(
            $bag,
            [
                'ip' => '127.0.0.1',
                'agent' => "Totally-Not-FireFox"
            ]
        );

        $mockDB->expects( $this->exactly( 2 ) )->method( 'doneWrites' );

        // Nothing to wait for
        $cp->initLB( $lb );
        // Record in stash
        $cp->shutdownLB( $lb );
        $cp->shutdown();

        // (b) Second HTTP request
        $cp = new ChronologyProtector(
            $bag,
            [
                'ip' => '127.0.0.1',
                'agent' => "Totally-Not-FireFox"
            ]
        );

        $lb->expects( $this->once() )
            ->method( 'waitFor' )->with( $this->equalTo( $mPos ) );

        // Wait
        $cp->initLB( $lb );
        // Record in stash
        $cp->shutdownLB( $lb );
        $cp->shutdown();
    }
}