MediaWikiTestCase.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Logger\LegacySpi;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Logger\MonologSpi;
use MediaWiki\MediaWikiServices;
use Psr\Log\LoggerInterface;
use Wikimedia\TestingAccessWrapper;
 
abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase {
 
    private static $serviceLocator = null;
 
    private $called = [];
 
    public static $users;
 
    protected $db;
 
    protected $tablesUsed = []; // tables with data
 
    private static $useTemporaryTables = true;
    private static $reuseDB = false;
    private static $dbSetup = false;
    private static $oldTablePrefix = '';
 
    private $phpErrorLevel;
 
    private $tmpFiles = [];
 
    private $mwGlobals = [];
 
    private $mwGlobalsToUnset = [];
 
    private $loggers = [];
 
    const DB_PREFIX = 'unittest_';
    const ORA_DB_PREFIX = 'ut_';
 
    protected $supportedDBs = [
        'mysql',
        'sqlite',
        'postgres',
        'oracle'
    ];
 
    public function __construct( $name = null, array $data = [], $dataName = '' ) {
        parent::__construct( $name, $data, $dataName );
 
        $this->backupGlobals = false;
        $this->backupStaticAttributes = false;
    }
 
    public function __destruct() {
        // Complain if self::setUp() was called, but not self::tearDown()
        // $this->called['setUp'] will be checked by self::testMediaWikiTestCaseParentSetupCalled()
        if ( isset( $this->called['setUp'] ) && !isset( $this->called['tearDown'] ) ) {
            throw new MWException( static::class . "::tearDown() must call parent::tearDown()" );
        }
    }
 
    public static function setUpBeforeClass() {
        parent::setUpBeforeClass();
 
        // Get the service locator, and reset services if it's not done already
        self::$serviceLocator = self::prepareServices( new GlobalVarConfig() );
    }
 
    public static function getTestUser( $groups = [] ) {
        return TestUserRegistry::getImmutableTestUser( $groups );
    }
 
    public static function getMutableTestUser( $groups = [] ) {
        return TestUserRegistry::getMutableTestUser( __CLASS__, $groups );
    }
 
    public static function getTestSysop() {
        return self::getTestUser( [ 'sysop', 'bureaucrat' ] );
    }
 
    public static function prepareServices( Config $bootstrapConfig ) {
        static $services = null;
 
        if ( !$services ) {
            $services = self::resetGlobalServices( $bootstrapConfig );
        }
        return $services;
    }
 
    protected static function resetGlobalServices( Config $bootstrapConfig = null ) {
        $oldServices = MediaWikiServices::getInstance();
        $oldConfigFactory = $oldServices->getConfigFactory();
 
        $testConfig = self::makeTestConfig( $bootstrapConfig );
 
        MediaWikiServices::resetGlobalInstance( $testConfig );
 
        $serviceLocator = MediaWikiServices::getInstance();
        self::installTestServices(
            $oldConfigFactory,
            $serviceLocator
        );
        return $serviceLocator;
    }
 
    private static function makeTestConfig(
        Config $baseConfig = null,
        Config $customOverrides = null
    ) {
        $defaultOverrides = new HashConfig();
 
        if ( !$baseConfig ) {
            $baseConfig = MediaWikiServices::getInstance()->getBootstrapConfig();
        }
 
        /* Some functions require some kind of caching, and will end up using the db,
         * which we can't allow, as that would open a new connection for mysql.
         * Replace with a HashBag. They would not be going to persist anyway.
         */
        $hashCache = [ 'class' => 'HashBagOStuff', 'reportDupes' => false ];
        $objectCaches = [
                CACHE_DB => $hashCache,
                CACHE_ACCEL => $hashCache,
                CACHE_MEMCACHED => $hashCache,
                'apc' => $hashCache,
                'apcu' => $hashCache,
                'xcache' => $hashCache,
                'wincache' => $hashCache,
            ] + $baseConfig->get( 'ObjectCaches' );
 
        $defaultOverrides->set( 'ObjectCaches', $objectCaches );
        $defaultOverrides->set( 'MainCacheType', CACHE_NONE );
        $defaultOverrides->set( 'JobTypeConf', [ 'default' => [ 'class' => 'JobQueueMemory' ] ] );
 
        // Use a fast hash algorithm to hash passwords.
        $defaultOverrides->set( 'PasswordDefault', 'A' );
 
        $testConfig = $customOverrides
            ? new MultiConfig( [ $customOverrides, $defaultOverrides, $baseConfig ] )
            : new MultiConfig( [ $defaultOverrides, $baseConfig ] );
 
        return $testConfig;
    }
 
    private static function installTestServices(
        ConfigFactory $oldConfigFactory,
        MediaWikiServices $newServices
    ) {
        // Use bootstrap config for all configuration.
        // This allows config overrides via global variables to take effect.
        $bootstrapConfig = $newServices->getBootstrapConfig();
        $newServices->resetServiceForTesting( 'ConfigFactory' );
        $newServices->redefineService(
            'ConfigFactory',
            self::makeTestConfigFactoryInstantiator(
                $oldConfigFactory,
                [ 'main' =>  $bootstrapConfig ]
            )
        );
    }
 
    private static function makeTestConfigFactoryInstantiator(
        ConfigFactory $oldFactory,
        array $configurations
    ) {
        return function( MediaWikiServices $services ) use ( $oldFactory, $configurations ) {
            $factory = new ConfigFactory();
 
            // clone configurations from $oldFactory that are not overwritten by $configurations
            $namesToClone = array_diff(
                $oldFactory->getConfigNames(),
                array_keys( $configurations )
            );
 
            foreach ( $namesToClone as $name ) {
                $factory->register( $name, $oldFactory->makeConfig( $name ) );
            }
 
            foreach ( $configurations as $name => $config ) {
                $factory->register( $name, $config );
            }
 
            return $factory;
        };
    }
 
    private function doLightweightServiceReset() {
        global $wgRequest;
 
        JobQueueGroup::destroySingletons();
        ObjectCache::clear();
        $services = MediaWikiServices::getInstance();
        $services->resetServiceForTesting( 'MainObjectStash' );
        $services->resetServiceForTesting( 'LocalServerObjectCache' );
        $services->getMainWANObjectCache()->clearProcessCache();
        FileBackendGroup::destroySingleton();
 
        // TODO: move global state into MediaWikiServices
        RequestContext::resetMain();
        if ( session_id() !== '' ) {
            session_write_close();
            session_id( '' );
        }
 
        $wgRequest = new FauxRequest();
        MediaWiki\Session\SessionManager::resetCache();
    }
 
    public function run( PHPUnit_Framework_TestResult $result = null ) {
        // Reset all caches between tests.
        $this->doLightweightServiceReset();
 
        $needsResetDB = false;
 
        if ( !self::$dbSetup || $this->needsDB() ) {
            // set up a DB connection for this test to use
 
            self::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
            self::$reuseDB = $this->getCliArg( 'reuse-db' );
 
            $this->db = wfGetDB( DB_MASTER );
 
            $this->checkDbIsSupported();
 
            if ( !self::$dbSetup ) {
                $this->setupAllTestDBs();
                $this->addCoreDBData();
 
                if ( ( $this->db->getType() == 'oracle' || !self::$useTemporaryTables ) && self::$reuseDB ) {
                    $this->resetDB( $this->db, $this->tablesUsed );
                }
            }
 
            // TODO: the DB setup should be done in setUpBeforeClass(), so the test DB
            // is available in subclass's setUpBeforeClass() and setUp() methods.
            // This would also remove the need for the HACK that is oncePerClass().
            if ( $this->oncePerClass() ) {
                $this->addDBDataOnce();
            }
 
            $this->addDBData();
            $needsResetDB = true;
        }
 
        parent::run( $result );
 
        if ( $needsResetDB ) {
            $this->resetDB( $this->db, $this->tablesUsed );
        }
    }
 
    private function oncePerClass() {
        // Remember current test class in the database connection,
        // so we know when we need to run addData.
 
        $class = static::class;
 
        $first = !isset( $this->db->_hasDataForTestClass )
            || $this->db->_hasDataForTestClass !== $class;
 
        $this->db->_hasDataForTestClass = $class;
        return $first;
    }
 
    public function usesTemporaryTables() {
        return self::$useTemporaryTables;
    }
 
    protected function getNewTempFile() {
        $fileName = tempnam( wfTempDir(), 'MW_PHPUnit_' . static::class . '_' );
        $this->tmpFiles[] = $fileName;
 
        return $fileName;
    }
 
    protected function getNewTempDirectory() {
        // Starting of with a temporary /file/.
        $fileName = $this->getNewTempFile();
 
        // Converting the temporary /file/ to a /directory/
        // The following is not atomic, but at least we now have a single place,
        // where temporary directory creation is bundled and can be improved
        unlink( $fileName );
        $this->assertTrue( wfMkdirParents( $fileName ) );
 
        return $fileName;
    }
 
    protected function setUp() {
        parent::setUp();
        $this->called['setUp'] = true;
 
        $this->phpErrorLevel = intval( ini_get( 'error_reporting' ) );
 
        // Cleaning up temporary files
        foreach ( $this->tmpFiles as $fileName ) {
            if ( is_file( $fileName ) || ( is_link( $fileName ) ) ) {
                unlink( $fileName );
            } elseif ( is_dir( $fileName ) ) {
                wfRecursiveRemoveDir( $fileName );
            }
        }
 
        if ( $this->needsDB() && $this->db ) {
            // Clean up open transactions
            while ( $this->db->trxLevel() > 0 ) {
                $this->db->rollback( __METHOD__, 'flush' );
            }
            // Check for unsafe queries
            if ( $this->db->getType() === 'mysql' ) {
                $this->db->query( "SET sql_mode = 'STRICT_ALL_TABLES'" );
            }
        }
 
        DeferredUpdates::clearPendingUpdates();
        ObjectCache::getMainWANInstance()->clearProcessCache();
 
        // XXX: reset maintenance triggers
        // Hook into period lag checks which often happen in long-running scripts
        $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
        Maintenance::setLBFactoryTriggers( $lbFactory );
 
        ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
    }
 
    protected function addTmpFiles( $files ) {
        $this->tmpFiles = array_merge( $this->tmpFiles, (array)$files );
    }
 
    protected function tearDown() {
        global $wgRequest, $wgSQLMode;
 
        $status = ob_get_status();
        if ( isset( $status['name'] ) &&
            $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier'
        ) {
            ob_end_flush();
        }
 
        $this->called['tearDown'] = true;
        // Cleaning up temporary files
        foreach ( $this->tmpFiles as $fileName ) {
            if ( is_file( $fileName ) || ( is_link( $fileName ) ) ) {
                unlink( $fileName );
            } elseif ( is_dir( $fileName ) ) {
                wfRecursiveRemoveDir( $fileName );
            }
        }
 
        if ( $this->needsDB() && $this->db ) {
            // Clean up open transactions
            while ( $this->db->trxLevel() > 0 ) {
                $this->db->rollback( __METHOD__, 'flush' );
            }
            if ( $this->db->getType() === 'mysql' ) {
                $this->db->query( "SET sql_mode = " . $this->db->addQuotes( $wgSQLMode ) );
            }
        }
 
        // Restore mw globals
        foreach ( $this->mwGlobals as $key => $value ) {
            $GLOBALS[$key] = $value;
        }
        foreach ( $this->mwGlobalsToUnset as $value ) {
            unset( $GLOBALS[$value] );
        }
        $this->mwGlobals = [];
        $this->mwGlobalsToUnset = [];
        $this->restoreLoggers();
 
        if ( self::$serviceLocator && MediaWikiServices::getInstance() !== self::$serviceLocator ) {
            MediaWikiServices::forceGlobalInstance( self::$serviceLocator );
        }
 
        // TODO: move global state into MediaWikiServices
        RequestContext::resetMain();
        if ( session_id() !== '' ) {
            session_write_close();
            session_id( '' );
        }
        $wgRequest = new FauxRequest();
        MediaWiki\Session\SessionManager::resetCache();
        MediaWiki\Auth\AuthManager::resetCache();
 
        $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
 
        if ( $phpErrorLevel !== $this->phpErrorLevel ) {
            ini_set( 'error_reporting', $this->phpErrorLevel );
 
            $oldHex = strtoupper( dechex( $this->phpErrorLevel ) );
            $newHex = strtoupper( dechex( $phpErrorLevel ) );
            $message = "PHP error_reporting setting was left dirty: "
                . "was 0x$oldHex before test, 0x$newHex after test!";
 
            $this->fail( $message );
        }
 
        parent::tearDown();
    }
 
    final public function testMediaWikiTestCaseParentSetupCalled() {
        $this->assertArrayHasKey( 'setUp', $this->called,
            static::class . '::setUp() must call parent::setUp()'
        );
    }
 
    protected function setService( $name, $object ) {
        // If we did not yet override the service locator, so so now.
        if ( MediaWikiServices::getInstance() === self::$serviceLocator ) {
            $this->overrideMwServices();
        }
 
        MediaWikiServices::getInstance()->disableService( $name );
        MediaWikiServices::getInstance()->redefineService(
            $name,
            function () use ( $object ) {
                return $object;
            }
        );
    }
 
    protected function setMwGlobals( $pairs, $value = null ) {
        if ( is_string( $pairs ) ) {
            $pairs = [ $pairs => $value ];
        }
 
        $this->stashMwGlobals( array_keys( $pairs ) );
 
        foreach ( $pairs as $key => $value ) {
            $GLOBALS[$key] = $value;
        }
    }
 
    private static function canShallowCopy( $value ) {
        if ( is_scalar( $value ) || $value === null ) {
            return true;
        }
        if ( is_array( $value ) ) {
            foreach ( $value as $subValue ) {
                if ( !is_scalar( $subValue ) && $subValue !== null ) {
                    return false;
                }
            }
            return true;
        }
        return false;
    }
 
    protected function stashMwGlobals( $globalKeys ) {
        if ( is_string( $globalKeys ) ) {
            $globalKeys = [ $globalKeys ];
        }
 
        foreach ( $globalKeys as $globalKey ) {
            // NOTE: make sure we only save the global once or a second call to
            // setMwGlobals() on the same global would override the original
            // value.
            if (
                !array_key_exists( $globalKey, $this->mwGlobals ) &&
                !array_key_exists( $globalKey, $this->mwGlobalsToUnset )
            ) {
                if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
                    $this->mwGlobalsToUnset[$globalKey] = $globalKey;
                    continue;
                }
                // NOTE: we serialize then unserialize the value in case it is an object
                // this stops any objects being passed by reference. We could use clone
                // and if is_object but this does account for objects within objects!
                if ( self::canShallowCopy( $GLOBALS[$globalKey] ) ) {
                    $this->mwGlobals[$globalKey] = $GLOBALS[$globalKey];
                } elseif (
                    // Many MediaWiki types are safe to clone. These are the
                    // ones that are most commonly stashed.
                    $GLOBALS[$globalKey] instanceof Language ||
                    $GLOBALS[$globalKey] instanceof User ||
                    $GLOBALS[$globalKey] instanceof FauxRequest
                ) {
                    $this->mwGlobals[$globalKey] = clone $GLOBALS[$globalKey];
                } else {
                    try {
                        $this->mwGlobals[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
                    } catch ( Exception $e ) {
                        $this->mwGlobals[$globalKey] = $GLOBALS[$globalKey];
                    }
                }
            }
        }
    }
 
    protected function mergeMwGlobalArrayValue( $name, $values ) {
        if ( !isset( $GLOBALS[$name] ) ) {
            $merged = $values;
        } else {
            if ( !is_array( $GLOBALS[$name] ) ) {
                throw new MWException( "MW global $name is not an array." );
            }
 
            // NOTE: do not use array_merge, it screws up for numeric keys.
            $merged = $GLOBALS[$name];
            foreach ( $values as $k => $v ) {
                $merged[$k] = $v;
            }
        }
 
        $this->setMwGlobals( $name, $merged );
    }
 
    protected function overrideMwServices( Config $configOverrides = null, array $services = [] ) {
        if ( !$configOverrides ) {
            $configOverrides = new HashConfig();
        }
 
        $oldInstance = MediaWikiServices::getInstance();
        $oldConfigFactory = $oldInstance->getConfigFactory();
 
        $testConfig = self::makeTestConfig( null, $configOverrides );
        $newInstance = new MediaWikiServices( $testConfig );
 
        // Load the default wiring from the specified files.
        // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
        $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
        $newInstance->loadWiringFiles( $wiringFiles );
 
        // Provide a traditional hook point to allow extensions to configure services.
        Hooks::run( 'MediaWikiServices', [ $newInstance ] );
 
        foreach ( $services as $name => $callback ) {
            $newInstance->redefineService( $name, $callback );
        }
 
        self::installTestServices(
            $oldConfigFactory,
            $newInstance
        );
        MediaWikiServices::forceGlobalInstance( $newInstance );
 
        return $newInstance;
    }
 
    public function setUserLang( $lang ) {
        RequestContext::getMain()->setLanguage( $lang );
        $this->setMwGlobals( 'wgLang', RequestContext::getMain()->getLanguage() );
    }
 
    public function setContentLang( $lang ) {
        if ( $lang instanceof Language ) {
            $langCode = $lang->getCode();
            $langObj = $lang;
        } else {
            $langCode = $lang;
            $langObj = Language::factory( $langCode );
        }
        $this->setMwGlobals( [
            'wgLanguageCode' => $langCode,
            'wgContLang' => $langObj,
        ] );
    }
 
    protected function setLogger( $channel, LoggerInterface $logger ) {
        // TODO: Once loggers are managed by MediaWikiServices, use
        //       overrideMwServices() to set loggers.
 
        $provider = LoggerFactory::getProvider();
        $wrappedProvider = TestingAccessWrapper::newFromObject( $provider );
        $singletons = $wrappedProvider->singletons;
        if ( $provider instanceof MonologSpi ) {
            if ( !isset( $this->loggers[$channel] ) ) {
                $this->loggers[$channel] = isset( $singletons['loggers'][$channel] )
                    ? $singletons['loggers'][$channel] : null;
            }
            $singletons['loggers'][$channel] = $logger;
        } elseif ( $provider instanceof LegacySpi ) {
            if ( !isset( $this->loggers[$channel] ) ) {
                $this->loggers[$channel] = isset( $singletons[$channel] ) ? $singletons[$channel] : null;
            }
            $singletons[$channel] = $logger;
        } else {
            throw new LogicException( __METHOD__ . ': setting a logger for ' . get_class( $provider )
                . ' is not implemented' );
        }
        $wrappedProvider->singletons = $singletons;
    }
 
    private function restoreLoggers() {
        $provider = LoggerFactory::getProvider();
        $wrappedProvider = TestingAccessWrapper::newFromObject( $provider );
        $singletons = $wrappedProvider->singletons;
        foreach ( $this->loggers as $channel => $logger ) {
            if ( $provider instanceof MonologSpi ) {
                if ( $logger === null ) {
                    unset( $singletons['loggers'][$channel] );
                } else {
                    $singletons['loggers'][$channel] = $logger;
                }
            } elseif ( $provider instanceof LegacySpi ) {
                if ( $logger === null ) {
                    unset( $singletons[$channel] );
                } else {
                    $singletons[$channel] = $logger;
                }
            }
        }
        $wrappedProvider->singletons = $singletons;
        $this->loggers = [];
    }
 
    public function dbPrefix() {
        return $this->db->getType() == 'oracle' ? self::ORA_DB_PREFIX : self::DB_PREFIX;
    }
 
    public function needsDB() {
        # if the test says it uses database tables, it needs the database
        if ( $this->tablesUsed ) {
            return true;
        }
 
        # if the test says it belongs to the Database group, it needs the database
        $rc = new ReflectionClass( $this );
        if ( preg_match( '/@group +Database/im', $rc->getDocComment() ) ) {
            return true;
        }
 
        return false;
    }
 
    protected function insertPage(
        $pageName,
        $text = 'Sample page for unit test.',
        $namespace = null
    ) {
        if ( is_string( $pageName ) ) {
            $title = Title::newFromText( $pageName, $namespace );
        } else {
            $title = $pageName;
        }
 
        $user = static::getTestSysop()->getUser();
        $comment = __METHOD__ . ': Sample page for unit test.';
 
        // Avoid memory leak...?
        // LinkCache::singleton()->clear();
        // Maybe.  But doing this absolutely breaks $title->isRedirect() when called during unit tests....
 
        $page = WikiPage::factory( $title );
        $page->doEditContent( ContentHandler::makeContent( $text, $title ), $comment, 0, false, $user );
 
        return [
            'title' => $title,
            'id' => $page->getId(),
        ];
    }
 
    public function addDBDataOnce() {
    }
 
    public function addDBData() {
    }
 
    private function addCoreDBData() {
        if ( $this->db->getType() == 'oracle' ) {
 
            # Insert 0 user to prevent FK violations
            # Anonymous user
            if ( !$this->db->selectField( 'user', '1', [ 'user_id' => 0 ] ) ) {
                $this->db->insert( 'user', [
                    'user_id' => 0,
                    'user_name' => 'Anonymous' ], __METHOD__, [ 'IGNORE' ] );
            }
 
            # Insert 0 page to prevent FK violations
            # Blank page
            if ( !$this->db->selectField( 'page', '1', [ 'page_id' => 0 ] ) ) {
                $this->db->insert( 'page', [
                    'page_id' => 0,
                    'page_namespace' => 0,
                    'page_title' => ' ',
                    'page_restrictions' => null,
                    'page_is_redirect' => 0,
                    'page_is_new' => 0,
                    'page_random' => 0,
                    'page_touched' => $this->db->timestamp(),
                    'page_latest' => 0,
                    'page_len' => 0 ], __METHOD__, [ 'IGNORE' ] );
            }
        }
 
        User::resetIdByNameCache();
 
        // Make sysop user
        $user = static::getTestSysop()->getUser();
 
        // Make 1 page with 1 revision
        $page = WikiPage::factory( Title::newFromText( 'UTPage' ) );
        if ( $page->getId() == 0 ) {
            $page->doEditContent(
                new WikitextContent( 'UTContent' ),
                'UTPageSummary',
                EDIT_NEW,
                false,
                $user
            );
 
            // doEditContent() probably started the session via
            // User::loadFromSession(). Close it now.
            if ( session_id() !== '' ) {
                session_write_close();
                session_id( '' );
            }
        }
    }
 
    public static function teardownTestDB() {
        global $wgJobClasses;
 
        if ( !self::$dbSetup ) {
            return;
        }
 
        foreach ( $wgJobClasses as $type => $class ) {
            // Delete any jobs under the clone DB (or old prefix in other stores)
            JobQueueGroup::singleton()->get( $type )->delete();
        }
 
        CloneDatabase::changePrefix( self::$oldTablePrefix );
 
        self::$oldTablePrefix = false;
        self::$dbSetup = false;
    }
 
    protected static function setupDatabaseWithTestPrefix( IMaintainableDatabase $db, $prefix ) {
        $tablesCloned = self::listTables( $db );
        $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix );
        $dbClone->useTemporaryTables( self::$useTemporaryTables );
 
        if ( ( $db->getType() == 'oracle' || !self::$useTemporaryTables ) && self::$reuseDB ) {
            CloneDatabase::changePrefix( $prefix );
 
            return false;
        } else {
            $dbClone->cloneTableStructure();
            return true;
        }
    }
 
    public function setupAllTestDBs() {
        global $wgDBprefix;
 
        self::$oldTablePrefix = $wgDBprefix;
 
        $testPrefix = $this->dbPrefix();
 
        // switch to a temporary clone of the database
        self::setupTestDB( $this->db, $testPrefix );
 
        if ( self::isUsingExternalStoreDB() ) {
            self::setupExternalStoreTestDBs( $testPrefix );
        }
    }
 
    public static function setupTestDB( Database $db, $prefix ) {
        if ( self::$dbSetup ) {
            return;
        }
 
        if ( $db->tablePrefix() === $prefix ) {
            throw new MWException(
                'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
        }
 
        // TODO: the below should be re-written as soon as LBFactory, LoadBalancer,
        // and Database no longer use global state.
 
        self::$dbSetup = true;
 
        if ( !self::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
            return;
        }
 
        // Assuming this isn't needed for External Store database, and not sure if the procedure
        // would be available there.
        if ( $db->getType() == 'oracle' ) {
            $db->query( 'BEGIN FILL_WIKI_INFO; END;' );
        }
    }
 
    protected static function setupExternalStoreTestDBs( $testPrefix ) {
        $connections = self::getExternalStoreDatabaseConnections();
        foreach ( $connections as $dbw ) {
            // Hack: cloneTableStructure sets $wgDBprefix to the unit test
            // prefix,.  Even though listTables now uses tablePrefix, that
            // itself is populated from $wgDBprefix by default.
 
            // We have to set it back, or we won't find the original 'blobs'
            // table to copy.
 
            $dbw->tablePrefix( self::$oldTablePrefix );
            self::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
        }
    }
 
    protected static function getExternalStoreDatabaseConnections() {
        global $wgDefaultExternalStore;
 
        $externalStoreDB = ExternalStore::getStoreObject( 'DB' );
        $defaultArray = (array)$wgDefaultExternalStore;
        $dbws = [];
        foreach ( $defaultArray as $url ) {
            if ( strpos( $url, 'DB://' ) === 0 ) {
                list( $proto, $cluster ) = explode( '://', $url, 2 );
                // Avoid getMaster() because setupDatabaseWithTestPrefix()
                // requires Database instead of plain DBConnRef/IDatabase
                $dbws[] = $externalStoreDB->getMaster( $cluster );
            }
        }
 
        return $dbws;
    }
 
    protected static function isUsingExternalStoreDB() {
        global $wgDefaultExternalStore;
        if ( !$wgDefaultExternalStore ) {
            return false;
        }
 
        $defaultArray = (array)$wgDefaultExternalStore;
        foreach ( $defaultArray as $url ) {
            if ( strpos( $url, 'DB://' ) === 0 ) {
                return true;
            }
        }
 
        return false;
    }
 
    private function resetDB( $db, $tablesUsed ) {
        if ( $db ) {
            $userTables = [ 'user', 'user_groups', 'user_properties' ];
            $coreDBDataTables = array_merge( $userTables, [ 'page', 'revision' ] );
 
            // If any of the user tables were marked as used, we should clear all of them.
            if ( array_intersect( $tablesUsed, $userTables ) ) {
                $tablesUsed = array_unique( array_merge( $tablesUsed, $userTables ) );
                TestUserRegistry::clear();
            }
 
            $truncate = in_array( $db->getType(), [ 'oracle', 'mysql' ] );
            foreach ( $tablesUsed as $tbl ) {
                // TODO: reset interwiki table to its original content.
                if ( $tbl == 'interwiki' ) {
                    continue;
                }
 
                if ( $truncate ) {
                    $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tbl ), __METHOD__ );
                } else {
                    $db->delete( $tbl, '*', __METHOD__ );
                }
 
                if ( $tbl === 'page' ) {
                    // Forget about the pages since they don't
                    // exist in the DB.
                    LinkCache::singleton()->clear();
                }
            }
 
            if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
                // Re-add core DB data that was deleted
                $this->addCoreDBData();
            }
        }
    }
 
    public function __call( $func, $args ) {
        static $compatibility = [
            'createMock' => 'createMock2',
        ];
 
        if ( isset( $compatibility[$func] ) ) {
            return call_user_func_array( [ $this, $compatibility[$func] ], $args );
        } else {
            throw new MWException( "Called non-existent $func method on " . static::class );
        }
    }
 
    private function createMock2( $originalClassName ) {
        return $this->getMockBuilder( $originalClassName )
            ->disableOriginalConstructor()
            ->disableOriginalClone()
            ->disableArgumentCloning()
            // New in phpunit-mock-objects 3.2 (phpunit 5.4.0)
            // ->disallowMockingUnknownTypes()
            ->getMock();
    }
 
    private static function unprefixTable( &$tableName, $ind, $prefix ) {
        $tableName = substr( $tableName, strlen( $prefix ) );
    }
 
    private static function isNotUnittest( $table ) {
        return strpos( $table, 'unittest_' ) !== 0;
    }
 
    public static function listTables( IMaintainableDatabase $db ) {
        $prefix = $db->tablePrefix();
        $tables = $db->listTables( $prefix, __METHOD__ );
 
        if ( $db->getType() === 'mysql' ) {
            static $viewListCache = null;
            if ( $viewListCache === null ) {
                $viewListCache = $db->listViews( null, __METHOD__ );
            }
            // T45571: cannot clone VIEWs under MySQL
            $tables = array_diff( $tables, $viewListCache );
        }
        array_walk( $tables, [ __CLASS__, 'unprefixTable' ], $prefix );
 
        // Don't duplicate test tables from the previous fataled run
        $tables = array_filter( $tables, [ __CLASS__, 'isNotUnittest' ] );
 
        if ( $db->getType() == 'sqlite' ) {
            $tables = array_flip( $tables );
            // these are subtables of searchindex and don't need to be duped/dropped separately
            unset( $tables['searchindex_content'] );
            unset( $tables['searchindex_segdir'] );
            unset( $tables['searchindex_segments'] );
            $tables = array_flip( $tables );
        }
 
        return $tables;
    }
 
    protected function checkDbIsSupported() {
        if ( !in_array( $this->db->getType(), $this->supportedDBs ) ) {
            throw new MWException( $this->db->getType() . " is not currently supported for unit testing." );
        }
    }
 
    public function getCliArg( $offset ) {
        if ( isset( PHPUnitMaintClass::$additionalOptions[$offset] ) ) {
            return PHPUnitMaintClass::$additionalOptions[$offset];
        }
 
        return null;
    }
 
    public function setCliArg( $offset, $value ) {
        PHPUnitMaintClass::$additionalOptions[$offset] = $value;
    }
 
    public function hideDeprecated( $function ) {
        MediaWiki\suppressWarnings();
        wfDeprecated( $function );
        MediaWiki\restoreWarnings();
    }
 
    protected function assertSelect( $table, $fields, $condition, array $expectedRows ) {
        if ( !$this->needsDB() ) {
            throw new MWException( 'When testing database state, the test cases\'s needDB()' .
                ' method should return true. Use @group Database or $this->tablesUsed.' );
        }
 
        $db = wfGetDB( DB_SLAVE );
 
        $res = $db->select( $table, $fields, $condition, wfGetCaller(), [ 'ORDER BY' => $fields ] );
        $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
 
        $i = 0;
 
        foreach ( $expectedRows as $expected ) {
            $r = $res->fetchRow();
            self::stripStringKeys( $r );
 
            $i += 1;
            $this->assertNotEmpty( $r, "row #$i missing" );
 
            $this->assertEquals( $expected, $r, "row #$i mismatches" );
        }
 
        $r = $res->fetchRow();
        self::stripStringKeys( $r );
 
        $this->assertFalse( $r, "found extra row (after #$i)" );
    }
 
    protected function arrayWrap( array $elements ) {
        return array_map(
            function ( $element ) {
                return [ $element ];
            },
            $elements
        );
    }
 
    protected function assertArrayEquals( array $expected, array $actual,
        $ordered = false, $named = false
    ) {
        if ( !$ordered ) {
            $this->objectAssociativeSort( $expected );
            $this->objectAssociativeSort( $actual );
        }
 
        if ( !$named ) {
            $expected = array_values( $expected );
            $actual = array_values( $actual );
        }
 
        call_user_func_array(
            [ $this, 'assertEquals' ],
            array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
        );
    }
 
    protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
        $expected = str_replace( '>', ">\n", $expected );
        $actual = str_replace( '>', ">\n", $actual );
 
        $this->assertEquals( $expected, $actual, $msg );
    }
 
    protected function objectAssociativeSort( array &$array ) {
        uasort(
            $array,
            function ( $a, $b ) {
                return serialize( $a ) > serialize( $b ) ? 1 : -1;
            }
        );
    }
 
    protected static function stripStringKeys( &$r ) {
        if ( !is_array( $r ) ) {
            return;
        }
 
        foreach ( $r as $k => $v ) {
            if ( is_string( $k ) ) {
                unset( $r[$k] );
            }
        }
    }
 
    protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
        if ( $actual === $value ) {
            $this->assertTrue( true, $message );
        } else {
            $this->assertType( $type, $actual, $message );
        }
    }
 
    protected function assertType( $type, $actual, $message = '' ) {
        if ( class_exists( $type ) || interface_exists( $type ) ) {
            $this->assertInstanceOf( $type, $actual, $message );
        } else {
            $this->assertInternalType( $type, $actual, $message );
        }
    }
 
    protected function isWikitextNS( $ns ) {
        global $wgNamespaceContentModels;
 
        if ( isset( $wgNamespaceContentModels[$ns] ) ) {
            return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT;
        }
 
        return true;
    }
 
    protected function getDefaultWikitextNS() {
        global $wgNamespaceContentModels;
 
        static $wikitextNS = null; // this is not going to change
        if ( $wikitextNS !== null ) {
            return $wikitextNS;
        }
 
        // quickly short out on most common case:
        if ( !isset( $wgNamespaceContentModels[NS_MAIN] ) ) {
            return NS_MAIN;
        }
 
        // NOTE: prefer content namespaces
        $namespaces = array_unique( array_merge(
            MWNamespace::getContentNamespaces(),
            [ NS_MAIN, NS_HELP, NS_PROJECT ], // prefer these
            MWNamespace::getValidNamespaces()
        ) );
 
        $namespaces = array_diff( $namespaces, [
            NS_FILE, NS_CATEGORY, NS_MEDIAWIKI, NS_USER // don't mess with magic namespaces
        ] );
 
        $talk = array_filter( $namespaces, function ( $ns ) {
            return MWNamespace::isTalk( $ns );
        } );
 
        // prefer non-talk pages
        $namespaces = array_diff( $namespaces, $talk );
        $namespaces = array_merge( $namespaces, $talk );
 
        // check default content model of each namespace
        foreach ( $namespaces as $ns ) {
            if ( !isset( $wgNamespaceContentModels[$ns] ) ||
                $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
            ) {
 
                $wikitextNS = $ns;
 
                return $wikitextNS;
            }
        }
 
        // give up
        // @todo Inside a test, we could skip the test as incomplete.
        //        But frequently, this is used in fixture setup.
        throw new MWException( "No namespace defaults to wikitext!" );
    }
 
    protected function markTestSkippedIfNoDiff3() {
        global $wgDiff3;
 
        # This check may also protect against code injection in
        # case of broken installations.
        MediaWiki\suppressWarnings();
        $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
        MediaWiki\restoreWarnings();
 
        if ( !$haveDiff3 ) {
            $this->markTestSkipped( "Skip test, since diff3 is not configured" );
        }
    }
 
    protected function checkPHPExtension( $extName ) {
        $loaded = extension_loaded( $extName );
        if ( !$loaded ) {
            $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
        }
 
        return $loaded;
    }
 
    protected function assertValidHtmlSnippet( $html ) {
        $html = '<!DOCTYPE html><html><head><title>test</title></head><body>' . $html . '</body></html>';
        $this->assertValidHtmlDocument( $html );
    }
 
    protected function assertValidHtmlDocument( $html ) {
        // Note: we only validate if the tidy PHP extension is available.
        // In case wgTidyInternal is false, MWTidy would fall back to the command line version
        // of tidy. In that case however, we can not reliably detect whether a failing validation
        // is due to malformed HTML, or caused by tidy not being installed as a command line tool.
        // That would cause all HTML assertions to fail on a system that has no tidy installed.
        if ( !$GLOBALS['wgTidyInternal'] || !MWTidy::isEnabled() ) {
            $this->markTestSkipped( 'Tidy extension not installed' );
        }
 
        $errorBuffer = '';
        MWTidy::checkErrors( $html, $errorBuffer );
        $allErrors = preg_split( '/[\r\n]+/', $errorBuffer );
 
        // Filter Tidy warnings which aren't useful for us.
        // Tidy eg. often cries about parameters missing which have actually
        // been deprecated since HTML4, thus we should not care about them.
        $errors = preg_grep(
            '/^(.*Warning: (trimming empty|.* lacks ".*?" attribute).*|\s*)$/m',
            $allErrors, PREG_GREP_INVERT
        );
 
        $this->assertEmpty( $errors, implode( "\n", $errors ) );
    }
 
    public static function wfResetOutputBuffersBarrier( $buffer ) {
        return $buffer;
    }
 
    protected function setTemporaryHook( $hookName, $handler ) {
        $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
    }
 
}