README.mediawiki export-ignore
Gemfile* export-ignore
vendor/pear/net_smtp/README.rst export-ignore
-
+phpunit.xml.dist export-ignore
node_modules/
/resources/lib/.foreign
/tests/phpunit/phpunit.phar
+phpunit.xml
/tests/selenium/log
.eslintcache
<!-- Skip violations in some tests for now -->
<exclude-pattern>*/tests/phpunit/includes/GlobalFunctions/*\.php</exclude-pattern>
<exclude-pattern>*/tests/phpunit/maintenance/*\.php</exclude-pattern>
+ <exclude-pattern>*/tests/phpunit/integration/includes/GlobalFunctions/*\.php</exclude-pattern>
</rule>
<rule ref="Generic.Files.OneObjectStructurePerFile.MultipleFound">
"test": [
"composer lint",
"composer phpcs"
- ]
+ ],
+ "phpunit": "vendor/bin/phpunit",
+ "phpunit:unit": "vendor/bin/phpunit --colors=always --testsuite=unit",
+ "phpunit:integration": "vendor/bin/phpunit --colors=always --testsuite=integration",
+ "phpunit:coverage": "php -d zend_extensions=xdebug.so vendor/bin/phpunit --testsuite=unit --exclude-group Dump,Broken,ParserFuzz,Stub"
},
"config": {
"optimize-autoloader": true,
/**
* Array mapping class names to filenames, for autoloading.
*/
-$wgAutoloadClasses = [];
+$wgAutoloadClasses = $wgAutoloadClasses ?? [];
/**
* Switch controlling legacy case-insensitive classloading.
// Useful debug output
if ( $wgCommandLineMode ) {
- wfDebug( "\n\nStart command line script $self\n" );
+ if ( isset( $self ) ) {
+ wfDebug( "\n\nStart command line script $self\n" );
+ }
} else {
$debug = "\n\nStart request {$wgRequest->getMethod()} {$wgRequest->getRequestURL()}\n";
"$IP/",
];
$extraFiles = [
- "$IP/tests/phpunit/MediaWikiTestCase.php",
+ "$IP/tests/phpunit/MediaWikiIntegrationTestCase.php",
];
foreach ( $recurseDirs as $dir ) {
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="tests/phpunit/bootstrap.php"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.8/phpunit.xsd"
+
+ colors="true"
+ backupGlobals="false"
+ convertErrorsToExceptions="true"
+ convertNoticesToExceptions="true"
+ convertWarningsToExceptions="true"
+ forceCoversAnnotation="true"
+ stopOnFailure="false"
+ timeoutForSmallTests="10"
+ timeoutForMediumTests="30"
+ timeoutForLargeTests="60"
+ beStrictAboutTestsThatDoNotTestAnything="true"
+ beStrictAboutOutputDuringTests="true"
+ beStrictAboutTestSize="true"
+ verbose="false">
+ <php>
+ <ini name="memory_limit" value="512M" />
+ </php>
+ <testsuites>
+ <testsuite name="unit">
+ <directory>tests/phpunit/unit</directory>
+ </testsuite>
+ <testsuite name="integration">
+ <directory>tests/phpunit/integration</directory>
+ </testsuite>
+ </testsuites>
+ <groups>
+ <exclude>
+ <group>Broken</group>
+ </exclude>
+ </groups>
+ <filter>
+ <whitelist addUncoveredFilesFromWhitelist="true">
+ <directory suffix=".php">includes</directory>
+ <directory suffix=".php">languages</directory>
+ <directory suffix=".php">maintenance</directory>
+ <exclude>
+ <directory suffix=".php">languages/messages</directory>
+ <file>languages/data/normalize-ar.php</file>
+ <file>languages/data/normalize-ml.php</file>
+ </exclude>
+ </whitelist>
+ </filter>
+ <listeners>
+ <listener class="JohnKary\PHPUnit\Listener\SpeedTrapListener">
+ <arguments>
+ <array>
+ <element key="slowThreshold">
+ <integer>50</integer>
+ </element>
+ <element key="reportLength">
+ <integer>50</integer>
+ </element>
+ </array>
+ </arguments>
+ </listener>
+ </listeners>
+</phpunit>
'MediaWikiPHPUnitCommand' => "$testDir/phpunit/MediaWikiPHPUnitCommand.php",
'MediaWikiPHPUnitResultPrinter' => "$testDir/phpunit/MediaWikiPHPUnitResultPrinter.php",
'MediaWikiPHPUnitTestListener' => "$testDir/phpunit/MediaWikiPHPUnitTestListener.php",
- 'MediaWikiTestCase' => "$testDir/phpunit/MediaWikiTestCase.php",
+ 'MediaWikiTestCase' => "$testDir/phpunit/MediaWikiIntegrationTestCase.php",
'MediaWikiUnitTestCase' => "$testDir/phpunit/MediaWikiUnitTestCase.php",
+ 'MediaWikiIntegrationTestCase' => "$testDir/phpunit/MediaWikiIntegrationTestCase.php",
'MediaWikiTestResult' => "$testDir/phpunit/MediaWikiTestResult.php",
'MediaWikiTestRunner' => "$testDir/phpunit/MediaWikiTestRunner.php",
'PHPUnit4And6Compat' => "$testDir/phpunit/PHPUnit4And6Compat.php",
--- /dev/null
+<?php
+
+use MediaWiki\Logger\LegacySpi;
+use MediaWiki\Logger\LoggerFactory;
+use MediaWiki\Logger\MonologSpi;
+use MediaWiki\Logger\LogCapturingSpi;
+use MediaWiki\MediaWikiServices;
+use Psr\Log\LoggerInterface;
+use Wikimedia\Rdbms\IDatabase;
+use Wikimedia\Rdbms\IMaintainableDatabase;
+use Wikimedia\Rdbms\Database;
+use Wikimedia\TestingAccessWrapper;
+
+/**
+ * @since 1.18
+ *
+ * Extend this class if you are testing classes which access global variables, methods, services
+ * or a storage backend.
+ *
+ * Consider using MediaWikiUnitTestCase and mocking dependencies if your code uses dependency
+ * injection and does not access any globals.
+ */
+abstract class MediaWikiIntegrationTestCase extends PHPUnit\Framework\TestCase {
+
+ use MediaWikiCoversValidator;
+ use PHPUnit4And6Compat;
+
+ /**
+ * The original service locator. This is overridden during setUp().
+ *
+ * @var MediaWikiServices|null
+ */
+ private static $originalServices;
+
+ /**
+ * The local service locator, created during setUp().
+ * @var MediaWikiServices
+ */
+ private $localServices;
+
+ /**
+ * $called tracks whether the setUp and tearDown method has been called.
+ * class extending MediaWikiTestCase usually override setUp and tearDown
+ * but forget to call the parent.
+ *
+ * The array format takes a method name as key and anything as a value.
+ * By asserting the key exist, we know the child class has called the
+ * parent.
+ *
+ * This property must be private, we do not want child to override it,
+ * they should call the appropriate parent method instead.
+ */
+ private $called = [];
+
+ /**
+ * @var TestUser[]
+ * @since 1.20
+ */
+ public static $users;
+
+ /**
+ * Primary database
+ *
+ * @var Database
+ * @since 1.18
+ */
+ protected $db;
+
+ /**
+ * @var array
+ * @since 1.19
+ */
+ protected $tablesUsed = []; // tables with data
+
+ private static $useTemporaryTables = true;
+ private static $reuseDB = false;
+ private static $dbSetup = false;
+ private static $oldTablePrefix = '';
+
+ /**
+ * Original value of PHP's error_reporting setting.
+ *
+ * @var int
+ */
+ private $phpErrorLevel;
+
+ /**
+ * Holds the paths of temporary files/directories created through getNewTempFile,
+ * and getNewTempDirectory
+ *
+ * @var array
+ */
+ private $tmpFiles = [];
+
+ /**
+ * Holds original values of MediaWiki configuration settings
+ * to be restored in tearDown().
+ * See also setMwGlobals().
+ * @var array
+ */
+ private $mwGlobals = [];
+
+ /**
+ * Holds list of MediaWiki configuration settings to be unset in tearDown().
+ * See also setMwGlobals().
+ * @var array
+ */
+ private $mwGlobalsToUnset = [];
+
+ /**
+ * Holds original values of ini settings to be restored
+ * in tearDown().
+ * @see setIniSettings()
+ * @var array
+ */
+ private $iniSettings = [];
+
+ /**
+ * Holds original loggers which have been replaced by setLogger()
+ * @var LoggerInterface[]
+ */
+ private $loggers = [];
+
+ /**
+ * The CLI arguments passed through from phpunit.php
+ * @var array
+ */
+ private $cliArgs = [];
+
+ /**
+ * Holds a list of services that were overridden with setService(). Used for printing an error
+ * if overrideMwServices() overrides a service that was previously set.
+ * @var string[]
+ */
+ private $overriddenServices = [];
+
+ /**
+ * Table name prefixes. Oracle likes it shorter.
+ */
+ const DB_PREFIX = 'unittest_';
+ const ORA_DB_PREFIX = 'ut_';
+
+ /**
+ * @var array
+ * @since 1.18
+ */
+ 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()" );
+ }
+ }
+
+ private static function initializeForStandardPhpunitEntrypointIfNeeded() {
+ if ( function_exists( 'wfRequireOnceInGlobalScope' ) ) {
+ $IP = realpath( __DIR__ . '/../..' );
+ wfRequireOnceInGlobalScope( "$IP/includes/Defines.php" );
+ wfRequireOnceInGlobalScope( "$IP/includes/DefaultSettings.php" );
+ wfRequireOnceInGlobalScope( "$IP/includes/GlobalFunctions.php" );
+ wfRequireOnceInGlobalScope( "$IP/includes/Setup.php" );
+ wfRequireOnceInGlobalScope( "$IP/tests/common/TestsAutoLoader.php" );
+ TestSetup::applyInitialConfig();
+ }
+ }
+
+ public static function setUpBeforeClass() {
+ parent::setUpBeforeClass();
+ \PHPUnit\Framework\Assert::assertFileExists( 'LocalSettings.php' );
+ self::initializeForStandardPhpunitEntrypointIfNeeded();
+
+ // Get the original service locator
+ if ( !self::$originalServices ) {
+ self::$originalServices = MediaWikiServices::getInstance();
+ }
+ }
+
+ /**
+ * Convenience method for getting an immutable test user
+ *
+ * @since 1.28
+ *
+ * @param string|string[] $groups Groups the test user should be in.
+ * @return TestUser
+ */
+ public static function getTestUser( $groups = [] ) {
+ return TestUserRegistry::getImmutableTestUser( $groups );
+ }
+
+ /**
+ * Convenience method for getting a mutable test user
+ *
+ * @since 1.28
+ *
+ * @param string|string[] $groups Groups the test user should be added in.
+ * @return TestUser
+ */
+ public static function getMutableTestUser( $groups = [] ) {
+ return TestUserRegistry::getMutableTestUser( __CLASS__, $groups );
+ }
+
+ /**
+ * Convenience method for getting an immutable admin test user
+ *
+ * @since 1.28
+ *
+ * @param string[] $groups Groups the test user should be added to.
+ * @return TestUser
+ */
+ public static function getTestSysop() {
+ return self::getTestUser( [ 'sysop', 'bureaucrat' ] );
+ }
+
+ /**
+ * Returns a WikiPage representing an existing page.
+ *
+ * @since 1.32
+ *
+ * @param Title|string|null $title
+ * @return WikiPage
+ * @throws MWException If this test cases's needsDB() method doesn't return true.
+ * Test cases can use "@group Database" to enable database test support,
+ * or list the tables under testing in $this->tablesUsed, or override the
+ * needsDB() method.
+ */
+ protected function getExistingTestPage( $title = null ) {
+ if ( !$this->needsDB() ) {
+ throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
+ ' method should return true. Use @group Database or $this->tablesUsed.' );
+ }
+
+ $title = ( $title === null ) ? 'UTPage' : $title;
+ $title = is_string( $title ) ? Title::newFromText( $title ) : $title;
+ $page = WikiPage::factory( $title );
+
+ if ( !$page->exists() ) {
+ $user = self::getTestSysop()->getUser();
+ $page->doEditContent(
+ new WikitextContent( 'UTContent' ),
+ 'UTPageSummary',
+ EDIT_NEW | EDIT_SUPPRESS_RC,
+ false,
+ $user
+ );
+ }
+
+ return $page;
+ }
+
+ /**
+ * Returns a WikiPage representing a non-existing page.
+ *
+ * @since 1.32
+ *
+ * @param Title|string|null $title
+ * @return WikiPage
+ * @throws MWException If this test cases's needsDB() method doesn't return true.
+ * Test cases can use "@group Database" to enable database test support,
+ * or list the tables under testing in $this->tablesUsed, or override the
+ * needsDB() method.
+ */
+ protected function getNonexistingTestPage( $title = null ) {
+ if ( !$this->needsDB() ) {
+ throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
+ ' method should return true. Use @group Database or $this->tablesUsed.' );
+ }
+
+ $title = ( $title === null ) ? 'UTPage-' . rand( 0, 100000 ) : $title;
+ $title = is_string( $title ) ? Title::newFromText( $title ) : $title;
+ $page = WikiPage::factory( $title );
+
+ if ( $page->exists() ) {
+ $page->doDeleteArticle( 'Testing' );
+ }
+
+ return $page;
+ }
+
+ /**
+ * @deprecated since 1.32
+ */
+ public static function prepareServices( Config $bootstrapConfig ) {
+ }
+
+ /**
+ * Create a config suitable for testing, based on a base config, default overrides,
+ * and custom overrides.
+ *
+ * @param Config|null $baseConfig
+ * @param Config|null $customOverrides
+ *
+ * @return Config
+ */
+ private static function makeTestConfig(
+ Config $baseConfig = null,
+ Config $customOverrides = null
+ ) {
+ $defaultOverrides = new HashConfig();
+
+ if ( !$baseConfig ) {
+ $baseConfig = self::$originalServices->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::class, 'reportDupes' => false ];
+ $objectCaches = [
+ CACHE_DB => $hashCache,
+ CACHE_ACCEL => $hashCache,
+ CACHE_MEMCACHED => $hashCache,
+ 'apc' => $hashCache,
+ 'apcu' => $hashCache,
+ 'wincache' => $hashCache,
+ ] + $baseConfig->get( 'ObjectCaches' );
+
+ $defaultOverrides->set( 'ObjectCaches', $objectCaches );
+ $defaultOverrides->set( 'MainCacheType', CACHE_NONE );
+ $defaultOverrides->set( 'JobTypeConf', [ 'default' => [ 'class' => JobQueueMemory::class ] ] );
+
+ // 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;
+ }
+
+ /**
+ * @param ConfigFactory $oldFactory
+ * @param Config[] $configurations
+ *
+ * @return Closure
+ */
+ 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;
+ };
+ }
+
+ /**
+ * Resets some non-service singleton instances and other static caches. It's not necessary to
+ * reset services here.
+ */
+ public static function resetNonServiceCaches() {
+ global $wgRequest, $wgJobClasses;
+
+ User::resetGetDefaultOptionsForTestsOnly();
+ foreach ( $wgJobClasses as $type => $class ) {
+ JobQueueGroup::singleton()->get( $type )->delete();
+ }
+ JobQueueGroup::destroySingletons();
+
+ ObjectCache::clear();
+ FileBackendGroup::destroySingleton();
+ DeferredUpdates::clearPendingUpdates();
+
+ // 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 ) {
+ if ( $result instanceof MediaWikiTestResult ) {
+ $this->cliArgs = $result->getMediaWikiCliArgs();
+ }
+ $this->overrideMwServices();
+
+ if ( $this->needsDB() && !$this->isTestInDatabaseGroup() ) {
+ throw new Exception(
+ get_class( $this ) . ' apparently needsDB but is not in the Database group'
+ );
+ }
+
+ $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' );
+
+ $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
+ $this->db = $lb->getConnection( DB_MASTER );
+
+ $this->checkDbIsSupported();
+
+ if ( !self::$dbSetup ) {
+ $this->setupAllTestDBs();
+ $this->addCoreDBData();
+ }
+
+ // 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->setUpSchema( $this->db );
+ $this->resetDB( $this->db, $this->tablesUsed );
+ $this->addDBDataOnce();
+ }
+
+ $this->addDBData();
+ $needsResetDB = true;
+ }
+
+ parent::run( $result );
+
+ // We don't mind if we override already-overridden services during cleanup
+ $this->overriddenServices = [];
+
+ if ( $needsResetDB ) {
+ $this->resetDB( $this->db, $this->tablesUsed );
+ }
+
+ self::restoreMwServices();
+ $this->localServices = null;
+ }
+
+ /**
+ * @return bool
+ */
+ 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;
+ }
+
+ /**
+ * @since 1.21
+ *
+ * @return bool
+ */
+ public function usesTemporaryTables() {
+ return self::$useTemporaryTables;
+ }
+
+ /**
+ * Obtains a new temporary file name
+ *
+ * The obtained filename is enlisted to be removed upon tearDown
+ *
+ * @since 1.20
+ *
+ * @return string Absolute name of the temporary file
+ */
+ protected function getNewTempFile() {
+ $fileName = tempnam(
+ wfTempDir(),
+ // Avoid backslashes here as they result in inconsistent results
+ // between Windows and other OS, as well as between functions
+ // that try to normalise these in one or both directions.
+ // For example, tempnam rejects directory separators in the prefix which
+ // means it rejects any namespaced class on Windows.
+ // And then there is, wfMkdirParents which normalises paths always
+ // whereas most other PHP and MW functions do not.
+ 'MW_PHPUnit_' . strtr( static::class, [ '\\' => '_' ] ) . '_'
+ );
+ $this->tmpFiles[] = $fileName;
+
+ return $fileName;
+ }
+
+ /**
+ * obtains a new temporary directory
+ *
+ * The obtained directory is enlisted to be removed (recursively with all its contained
+ * files) upon tearDown.
+ *
+ * @since 1.20
+ *
+ * @return string Absolute name of the temporary directory
+ */
+ 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 );
+ // If this fails for some reason, PHP will warn and fail the test.
+ mkdir( $fileName, 0777, /* recursive = */ true );
+
+ return $fileName;
+ }
+
+ protected function setUp() {
+ parent::setUp();
+ $this->called['setUp'] = true;
+
+ $this->phpErrorLevel = intval( ini_get( 'error_reporting' ) );
+
+ $this->overriddenServices = [];
+
+ // 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'", __METHOD__ );
+ }
+ }
+
+ // Reset all caches between tests.
+ self::resetNonServiceCaches();
+
+ // XXX: reset maintenance triggers
+ // Hook into period lag checks which often happen in long-running scripts
+ $lbFactory = $this->localServices->getDBLoadBalancerFactory();
+ Maintenance::setLBFactoryTriggers( $lbFactory, $this->localServices->getMainConfig() );
+
+ ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
+ }
+
+ protected function addTmpFiles( $files ) {
+ $this->tmpFiles = array_merge( $this->tmpFiles, (array)$files );
+ }
+
+ // @todo Make const when we no longer support HHVM (T192166)
+ private static $namespaceAffectingSettings = [
+ 'wgAllowImageMoving',
+ 'wgCanonicalNamespaceNames',
+ 'wgCapitalLinkOverrides',
+ 'wgCapitalLinks',
+ 'wgContentNamespaces',
+ 'wgExtensionMessagesFiles',
+ 'wgExtensionNamespaces',
+ 'wgExtraNamespaces',
+ 'wgExtraSignatureNamespaces',
+ 'wgNamespaceContentModels',
+ 'wgNamespaceProtection',
+ 'wgNamespacesWithSubpages',
+ 'wgNonincludableNamespaces',
+ 'wgRestrictionLevels',
+ ];
+
+ 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 ),
+ __METHOD__ );
+ }
+ }
+
+ // Re-enable any disabled deprecation warnings
+ MWDebug::clearLog();
+ // Restore mw globals
+ foreach ( $this->mwGlobals as $key => $value ) {
+ $GLOBALS[$key] = $value;
+ }
+ foreach ( $this->mwGlobalsToUnset as $value ) {
+ unset( $GLOBALS[$value] );
+ }
+ foreach ( $this->iniSettings as $name => $value ) {
+ ini_set( $name, $value );
+ }
+ if (
+ array_intersect( self::$namespaceAffectingSettings, array_keys( $this->mwGlobals ) ) ||
+ array_intersect( self::$namespaceAffectingSettings, $this->mwGlobalsToUnset )
+ ) {
+ $this->resetNamespaces();
+ }
+ $this->mwGlobals = [];
+ $this->mwGlobalsToUnset = [];
+ $this->restoreLoggers();
+
+ // 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();
+ }
+
+ /**
+ * Make sure MediaWikiTestCase extending classes have called their
+ * parent setUp method
+ *
+ * With strict coverage activated in PHP_CodeCoverage, this test would be
+ * marked as risky without the following annotation (T152923).
+ * @coversNothing
+ */
+ final public function testMediaWikiTestCaseParentSetupCalled() {
+ $this->assertArrayHasKey( 'setUp', $this->called,
+ static::class . '::setUp() must call parent::setUp()'
+ );
+ }
+
+ /**
+ * Sets a service, maintaining a stashed version of the previous service to be
+ * restored in tearDown.
+ *
+ * @note Tests must not call overrideMwServices() after calling setService(), since that would
+ * lose the new service instance. Since 1.34, resetServices() can be used instead, which
+ * would reset other services, but retain any services set using setService().
+ * This means that once a service is set using this method, it cannot be reverted to
+ * the original service within the same test method. The original service is restored
+ * in tearDown after the test method has terminated.
+ *
+ * @param string $name
+ * @param object $service The service instance, or a callable that returns the service instance.
+ *
+ * @since 1.27
+ *
+ */
+ protected function setService( $name, $service ) {
+ if ( !$this->localServices ) {
+ throw new Exception( __METHOD__ . ' must be called after MediaWikiTestCase::run()' );
+ }
+
+ if ( $this->localServices !== MediaWikiServices::getInstance() ) {
+ throw new Exception( __METHOD__ . ' will not work because the global MediaWikiServices '
+ . 'instance has been replaced by test code.' );
+ }
+
+ if ( is_callable( $service ) ) {
+ $instantiator = $service;
+ } else {
+ $instantiator = function () use ( $service ) {
+ return $service;
+ };
+ }
+
+ $this->overriddenServices[] = $name;
+
+ $this->localServices->disableService( $name );
+ $this->localServices->redefineService(
+ $name,
+ $instantiator
+ );
+
+ if ( $name === 'ContentLanguage' ) {
+ $this->doSetMwGlobals( [ 'wgContLang' => $this->localServices->getContentLanguage() ] );
+ }
+ }
+
+ /**
+ * Sets a global, maintaining a stashed version of the previous global to be
+ * restored in tearDown
+ *
+ * The key is added to the array of globals that will be reset afterwards
+ * in the tearDown().
+ *
+ * It may be necessary to call resetServices() to allow any changed configuration variables
+ * to take effect on services that get initialized based on these variables.
+ *
+ * @par Example
+ * @code
+ * protected function setUp() {
+ * $this->setMwGlobals( 'wgRestrictStuff', true );
+ * }
+ *
+ * function testFoo() {}
+ *
+ * function testBar() {}
+ * $this->assertTrue( self::getX()->doStuff() );
+ *
+ * $this->setMwGlobals( 'wgRestrictStuff', false );
+ * $this->assertTrue( self::getX()->doStuff() );
+ * }
+ *
+ * function testQuux() {}
+ * @endcode
+ *
+ * @param array|string $pairs Key to the global variable, or an array
+ * of key/value pairs.
+ * @param mixed|null $value Value to set the global to (ignored
+ * if an array is given as first argument).
+ *
+ * @note To allow changes to global variables to take effect on global service instances,
+ * call resetServices().
+ *
+ * @since 1.21
+ */
+ protected function setMwGlobals( $pairs, $value = null ) {
+ if ( is_string( $pairs ) ) {
+ $pairs = [ $pairs => $value ];
+ }
+
+ if ( isset( $pairs['wgContLang'] ) ) {
+ throw new MWException(
+ 'No setting $wgContLang, use setContentLang() or setService( \'ContentLanguage\' )'
+ );
+ }
+
+ $this->doSetMwGlobals( $pairs, $value );
+ }
+
+ /**
+ * An internal method that allows setService() to set globals that tests are not supposed to
+ * touch.
+ */
+ private function doSetMwGlobals( $pairs, $value = null ) {
+ $this->doStashMwGlobals( array_keys( $pairs ) );
+
+ foreach ( $pairs as $key => $value ) {
+ $GLOBALS[$key] = $value;
+ }
+
+ if ( array_intersect( self::$namespaceAffectingSettings, array_keys( $pairs ) ) ) {
+ $this->resetNamespaces();
+ }
+ }
+
+ /**
+ * Set an ini setting for the duration of the test
+ * @param string $name Name of the setting
+ * @param string $value Value to set
+ * @since 1.32
+ */
+ protected function setIniSetting( $name, $value ) {
+ $original = ini_get( $name );
+ $this->iniSettings[$name] = $original;
+ ini_set( $name, $value );
+ }
+
+ /**
+ * Must be called whenever namespaces are changed, e.g., $wgExtraNamespaces is altered.
+ * Otherwise old namespace data will lurk and cause bugs.
+ */
+ private function resetNamespaces() {
+ if ( !$this->localServices ) {
+ throw new Exception( __METHOD__ . ' must be called after MediaWikiTestCase::run()' );
+ }
+
+ if ( $this->localServices !== MediaWikiServices::getInstance() ) {
+ throw new Exception( __METHOD__ . ' will not work because the global MediaWikiServices '
+ . 'instance has been replaced by test code.' );
+ }
+
+ Language::clearCaches();
+ }
+
+ /**
+ * Check if we can back up a value by performing a shallow copy.
+ * Values which fail this test are copied recursively.
+ *
+ * @param mixed $value
+ * @return bool True if a shallow copy will do; false if a deep copy
+ * is required.
+ */
+ 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;
+ }
+
+ private function doStashMwGlobals( $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];
+ } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
+ // Serializing Closure only gives a warning on HHVM while
+ // it throws an Exception on Zend.
+ // Workaround for https://github.com/facebook/hhvm/issues/6206
+ $this->mwGlobals[$globalKey] = $GLOBALS[$globalKey];
+ } else {
+ try {
+ $this->mwGlobals[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
+ } catch ( Exception $e ) {
+ $this->mwGlobals[$globalKey] = $GLOBALS[$globalKey];
+ }
+ }
+ }
+ }
+ }
+
+ /**
+ * @param mixed $var
+ * @param int $maxDepth
+ *
+ * @return bool
+ */
+ private function containsClosure( $var, $maxDepth = 15 ) {
+ if ( $var instanceof Closure ) {
+ return true;
+ }
+ if ( !is_array( $var ) || $maxDepth === 0 ) {
+ return false;
+ }
+
+ foreach ( $var as $value ) {
+ if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Merges the given values into a MW global array variable.
+ * Useful for setting some entries in a configuration array, instead of
+ * setting the entire array.
+ *
+ * It may be necessary to call resetServices() to allow any changed configuration variables
+ * to take effect on services that get initialized based on these variables.
+ *
+ * @param string $name The name of the global, as in wgFooBar
+ * @param array $values The array containing the entries to set in that global
+ *
+ * @throws MWException If the designated global is not an array.
+ *
+ * @note To allow changes to global variables to take effect on global service instances,
+ * call resetServices().
+ *
+ * @since 1.21
+ */
+ 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 );
+ }
+
+ /**
+ * Resets service instances in the global instance of MediaWikiServices.
+ *
+ * In contrast to overrideMwServices(), this does not create a new MediaWikiServices instance,
+ * and it preserves any service instances set via setService().
+ *
+ * The primary use case for this method is to allow changes to global configuration variables
+ * to take effect on services that get initialized based on these global configuration
+ * variables. Similarly, it may be necessary to call resetServices() after calling setService(),
+ * so the newly set service gets picked up by any other service definitions that may use it.
+ *
+ * @see MediaWikiServices::resetServiceForTesting.
+ *
+ * @since 1.34
+ */
+ protected function resetServices() {
+ // Reset but don't destroy service instances supplied via setService().
+ foreach ( $this->overriddenServices as $name ) {
+ $this->localServices->resetServiceForTesting( $name, false );
+ }
+
+ // Reset all services with the destroy flag set.
+ // This will not have any effect on services that had already been reset above.
+ foreach ( $this->localServices->getServiceNames() as $name ) {
+ $this->localServices->resetServiceForTesting( $name, true );
+ }
+
+ self::resetGlobalParser();
+ }
+
+ /**
+ * Installs a new global instance of MediaWikiServices, allowing test cases to override
+ * settings and services.
+ *
+ * This method can be used to set up specific services or configuration as a fixture.
+ * It should not be used to reset services in between stages of a test - instead, the test
+ * should either be split, or resetServices() should be used.
+ *
+ * If called with no parameters, this method restores all services to their default state.
+ * This is done automatically before each test to isolate tests from any modification
+ * to settings and services that may have been applied by previous tests.
+ * That means that the effect of calling overrideMwServices() is undone before the next
+ * call to a test method.
+ *
+ * @note Calling this after having called setService() in the same test method (or the
+ * associated setUp) will result in an MWException.
+ * Tests should use either overrideMwServices() or setService(), but not mix both.
+ * Since 1.34, resetServices() is available as an alternative compatible with setService().
+ *
+ * @since 1.27
+ *
+ * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
+ * instance.
+ * @param callable[] $services An associative array of services to re-define. Keys are service
+ * names, values are callables.
+ *
+ * @return MediaWikiServices
+ * @throws MWException
+ */
+ protected function overrideMwServices(
+ Config $configOverrides = null, array $services = []
+ ) {
+ if ( $this->overriddenServices ) {
+ throw new MWException(
+ 'The following services were set and are now being unset by overrideMwServices: ' .
+ implode( ', ', $this->overriddenServices )
+ );
+ }
+ $newInstance = self::installMockMwServices( $configOverrides );
+
+ if ( $this->localServices ) {
+ $this->localServices->destroy();
+ }
+
+ $this->localServices = $newInstance;
+
+ foreach ( $services as $name => $callback ) {
+ $newInstance->redefineService( $name, $callback );
+ }
+
+ self::resetGlobalParser();
+
+ return $newInstance;
+ }
+
+ /**
+ * Creates a new "mock" MediaWikiServices instance, and installs it.
+ * This effectively resets all cached states in services, with the exception of
+ * the ConfigFactory and the DBLoadBalancerFactory service, which are inherited from
+ * the original MediaWikiServices.
+ *
+ * @note The new original MediaWikiServices instance can later be restored by calling
+ * restoreMwServices(). That original is determined by the first call to this method, or
+ * by setUpBeforeClass, whichever is called first. The caller is responsible for managing
+ * and, when appropriate, destroying any other MediaWikiServices instances that may get
+ * replaced when calling this method.
+ *
+ * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
+ * instance.
+ *
+ * @return MediaWikiServices the new mock service locator.
+ */
+ public static function installMockMwServices( Config $configOverrides = null ) {
+ // Make sure we have the original service locator
+ if ( !self::$originalServices ) {
+ self::$originalServices = MediaWikiServices::getInstance();
+ }
+
+ if ( !$configOverrides ) {
+ $configOverrides = new HashConfig();
+ }
+
+ $oldConfigFactory = self::$originalServices->getConfigFactory();
+ $oldLoadBalancerFactory = self::$originalServices->getDBLoadBalancerFactory();
+
+ $testConfig = self::makeTestConfig( null, $configOverrides );
+ $newServices = new MediaWikiServices( $testConfig );
+
+ // Load the default wiring from the specified files.
+ // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
+ $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
+ $newServices->loadWiringFiles( $wiringFiles );
+
+ // Provide a traditional hook point to allow extensions to configure services.
+ Hooks::run( '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 ]
+ )
+ );
+ $newServices->resetServiceForTesting( 'DBLoadBalancerFactory' );
+ $newServices->redefineService(
+ 'DBLoadBalancerFactory',
+ function ( MediaWikiServices $services ) use ( $oldLoadBalancerFactory ) {
+ return $oldLoadBalancerFactory;
+ }
+ );
+
+ MediaWikiServices::forceGlobalInstance( $newServices );
+
+ self::resetGlobalParser();
+
+ return $newServices;
+ }
+
+ /**
+ * Restores the original, non-mock MediaWikiServices instance.
+ * The previously active MediaWikiServices instance is destroyed,
+ * if it is different from the original that is to be restored.
+ *
+ * @note this if for internal use by test framework code. It should never be
+ * called from inside a test case, a data provider, or a setUp or tearDown method.
+ *
+ * @return bool true if the original service locator was restored,
+ * false if there was nothing too do.
+ */
+ public static function restoreMwServices() {
+ if ( !self::$originalServices ) {
+ return false;
+ }
+
+ $currentServices = MediaWikiServices::getInstance();
+
+ if ( self::$originalServices === $currentServices ) {
+ return false;
+ }
+
+ MediaWikiServices::forceGlobalInstance( self::$originalServices );
+ $currentServices->destroy();
+
+ self::resetGlobalParser();
+
+ return true;
+ }
+
+ /**
+ * If $wgParser has been unstubbed, replace it with a fresh one so it picks up any config
+ * changes. $wgParser is deprecated, but we still support it for now.
+ */
+ private static function resetGlobalParser() {
+ // phpcs:ignore MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgParser
+ global $wgParser;
+ if ( $wgParser instanceof StubObject ) {
+ return;
+ }
+ $wgParser = new StubObject( 'wgParser', function () {
+ return MediaWikiServices::getInstance()->getParser();
+ } );
+ }
+
+ /**
+ * @since 1.27
+ * @param string|Language $lang
+ */
+ public function setUserLang( $lang ) {
+ RequestContext::getMain()->setLanguage( $lang );
+ $this->setMwGlobals( 'wgLang', RequestContext::getMain()->getLanguage() );
+ }
+
+ /**
+ * @since 1.27
+ * @param string|Language $lang
+ */
+ public function setContentLang( $lang ) {
+ if ( $lang instanceof Language ) {
+ $this->setMwGlobals( 'wgLanguageCode', $lang->getCode() );
+ // Set to the exact object requested
+ $this->setService( 'ContentLanguage', $lang );
+ } else {
+ $this->setMwGlobals( 'wgLanguageCode', $lang );
+ // Let the service handler make up the object. Avoid calling setService(), because if
+ // we do, overrideMwServices() will complain if it's called later on.
+ $services = MediaWikiServices::getInstance();
+ $services->resetServiceForTesting( 'ContentLanguage' );
+ $this->doSetMwGlobals( [ 'wgContLang' => $services->getContentLanguage() ] );
+ }
+ }
+
+ /**
+ * Alters $wgGroupPermissions for the duration of the test. Can be called
+ * with an array, like
+ * [ '*' => [ 'read' => false ], 'user' => [ 'read' => false ] ]
+ * or three values to set a single permission, like
+ * $this->setGroupPermissions( '*', 'read', false );
+ *
+ * @since 1.31
+ * @param array|string $newPerms Either an array of permissions to change,
+ * in which case the next two parameters are ignored; or a single string
+ * identifying a group, to use with the next two parameters.
+ * @param string|null $newKey
+ * @param mixed|null $newValue
+ */
+ public function setGroupPermissions( $newPerms, $newKey = null, $newValue = null ) {
+ global $wgGroupPermissions;
+
+ if ( is_string( $newPerms ) ) {
+ $newPerms = [ $newPerms => [ $newKey => $newValue ] ];
+ }
+
+ $newPermissions = $wgGroupPermissions;
+ foreach ( $newPerms as $group => $permissions ) {
+ foreach ( $permissions as $key => $value ) {
+ $newPermissions[$group][$key] = $value;
+ }
+ }
+
+ $this->setMwGlobals( 'wgGroupPermissions', $newPermissions );
+
+ // Reset services so they pick up the new permissions.
+ // Resetting just PermissionManager is not sufficient, since other services may
+ // have the old instance of PermissionManager injected.
+ $this->resetServices();
+ }
+
+ /**
+ *
+ * @since 1.34
+ * Sets the logger for a specified channel, for the duration of the test.
+ * @since 1.27
+ * @param string $channel
+ * @param LoggerInterface $logger
+ */
+ protected function setLogger( $channel, LoggerInterface $logger ) {
+ // TODO: Once loggers are managed by MediaWikiServices, use
+ // resetServiceForTesting() 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] = $singletons['loggers'][$channel] ?? null;
+ }
+ $singletons['loggers'][$channel] = $logger;
+ } elseif ( $provider instanceof LegacySpi || $provider instanceof LogCapturingSpi ) {
+ if ( !isset( $this->loggers[$channel] ) ) {
+ $this->loggers[$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;
+ }
+
+ /**
+ * Restores loggers replaced by setLogger().
+ * @since 1.27
+ */
+ 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 || $provider instanceof LogCapturingSpi ) {
+ if ( $logger === null ) {
+ unset( $singletons[$channel] );
+ } else {
+ $singletons[$channel] = $logger;
+ }
+ }
+ }
+ $wrappedProvider->singletons = $singletons;
+ $this->loggers = [];
+ }
+
+ /**
+ * @return string
+ * @since 1.18
+ */
+ public function dbPrefix() {
+ return self::getTestPrefixFor( $this->db );
+ }
+
+ /**
+ * @param IDatabase $db
+ * @return string
+ * @since 1.32
+ */
+ public static function getTestPrefixFor( IDatabase $db ) {
+ return $db->getType() == 'oracle' ? self::ORA_DB_PREFIX : self::DB_PREFIX;
+ }
+
+ /**
+ * @return bool
+ * @since 1.18
+ */
+ public function needsDB() {
+ // If the test says it uses database tables, it needs the database
+ return $this->tablesUsed || $this->isTestInDatabaseGroup();
+ }
+
+ /**
+ * @return bool
+ * @since 1.32
+ */
+ protected function isTestInDatabaseGroup() {
+ // If the test class says it belongs to the Database group, it needs the database.
+ // NOTE: This ONLY checks for the group in the class level doc comment.
+ $rc = new ReflectionClass( $this );
+ return (bool)preg_match( '/@group +Database/im', $rc->getDocComment() );
+ }
+
+ /**
+ * Insert a new page.
+ *
+ * Should be called from addDBData().
+ *
+ * @since 1.25 ($namespace in 1.28)
+ * @param string|Title $pageName Page name or title
+ * @param string $text Page's content
+ * @param int|null $namespace Namespace id (name cannot already contain namespace)
+ * @param User|null $user If null, static::getTestSysop()->getUser() is used.
+ * @return array Title object and page id
+ * @throws MWException If this test cases's needsDB() method doesn't return true.
+ * Test cases can use "@group Database" to enable database test support,
+ * or list the tables under testing in $this->tablesUsed, or override the
+ * needsDB() method.
+ */
+ protected function insertPage(
+ $pageName,
+ $text = 'Sample page for unit test.',
+ $namespace = null,
+ User $user = null
+ ) {
+ if ( !$this->needsDB() ) {
+ throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
+ ' method should return true. Use @group Database or $this->tablesUsed.' );
+ }
+
+ if ( is_string( $pageName ) ) {
+ $title = Title::newFromText( $pageName, $namespace );
+ } else {
+ $title = $pageName;
+ }
+
+ if ( !$user ) {
+ $user = static::getTestSysop()->getUser();
+ }
+ $comment = __METHOD__ . ': Sample page for unit test.';
+
+ $page = WikiPage::factory( $title );
+ $page->doEditContent( ContentHandler::makeContent( $text, $title ), $comment, 0, false, $user );
+
+ return [
+ 'title' => $title,
+ 'id' => $page->getId(),
+ ];
+ }
+
+ /**
+ * Stub. If a test suite needs to add additional data to the database, it should
+ * implement this method and do so. This method is called once per test suite
+ * (i.e. once per class).
+ *
+ * Note data added by this method may be removed by resetDB() depending on
+ * the contents of $tablesUsed.
+ *
+ * To add additional data between test function runs, override prepareDB().
+ *
+ * @see addDBData()
+ * @see resetDB()
+ *
+ * @since 1.27
+ */
+ public function addDBDataOnce() {
+ }
+
+ /**
+ * Stub. Subclasses may override this to prepare the database.
+ * Called before every test run (test function or data set).
+ *
+ * @see addDBDataOnce()
+ * @see resetDB()
+ *
+ * @since 1.18
+ */
+ public function addDBData() {
+ }
+
+ /**
+ * @since 1.32
+ */
+ protected 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' ] );
+ }
+ }
+
+ SiteStatsInit::doPlaceholderInit();
+
+ 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 | EDIT_SUPPRESS_RC,
+ false,
+ $user
+ );
+ // an edit always attempt to purge backlink links such as history
+ // pages. That is unnecessary.
+ JobQueueGroup::singleton()->get( 'htmlCacheUpdate' )->delete();
+ // WikiPages::doEditUpdates randomly adds RC purges
+ JobQueueGroup::singleton()->get( 'recentChangesUpdate' )->delete();
+
+ // doEditContent() probably started the session via
+ // User::loadFromSession(). Close it now.
+ if ( session_id() !== '' ) {
+ session_write_close();
+ session_id( '' );
+ }
+ }
+ }
+
+ /**
+ * Restores MediaWiki to using the table set (table prefix) it was using before
+ * setupTestDB() was called. Useful if we need to perform database operations
+ * after the test run has finished (such as saving logs or profiling info).
+ *
+ * This is called by phpunit/bootstrap.php after the last test.
+ *
+ * @since 1.21
+ */
+ public static function teardownTestDB() {
+ global $wgJobClasses;
+
+ if ( !self::$dbSetup ) {
+ return;
+ }
+
+ Hooks::run( 'UnitTestsBeforeDatabaseTeardown' );
+
+ foreach ( $wgJobClasses as $type => $class ) {
+ // Delete any jobs under the clone DB (or old prefix in other stores)
+ JobQueueGroup::singleton()->get( $type )->delete();
+ }
+
+ // T219673: close any connections from code that failed to call reuseConnection()
+ // or is still holding onto a DBConnRef instance (e.g. in a singleton).
+ MediaWikiServices::getInstance()->getDBLoadBalancerFactory()->closeAll();
+ CloneDatabase::changePrefix( self::$oldTablePrefix );
+
+ self::$oldTablePrefix = false;
+ self::$dbSetup = false;
+ }
+
+ /**
+ * Setups a database with cloned tables using the given prefix.
+ *
+ * If reuseDB is true and certain conditions apply, it will just change the prefix.
+ * Otherwise, it will clone the tables and change the prefix.
+ *
+ * @param IMaintainableDatabase $db Database to use
+ * @param string|null $prefix Prefix to use for test tables. If not given, the prefix is determined
+ * automatically for $db.
+ * @return bool True if tables were cloned, false if only the prefix was changed
+ */
+ protected static function setupDatabaseWithTestPrefix(
+ IMaintainableDatabase $db,
+ $prefix = null
+ ) {
+ if ( $prefix === null ) {
+ $prefix = self::getTestPrefixFor( $db );
+ }
+
+ if ( ( $db->getType() == 'oracle' || !self::$useTemporaryTables ) && self::$reuseDB ) {
+ $db->tablePrefix( $prefix );
+ return false;
+ }
+
+ if ( !isset( $db->_originalTablePrefix ) ) {
+ $oldPrefix = $db->tablePrefix();
+
+ if ( $oldPrefix === $prefix ) {
+ // table already has the correct prefix, but presumably no cloned tables
+ $oldPrefix = self::$oldTablePrefix;
+ }
+
+ $db->tablePrefix( $oldPrefix );
+ $tablesCloned = self::listTables( $db );
+ $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix, $oldPrefix );
+ $dbClone->useTemporaryTables( self::$useTemporaryTables );
+
+ $dbClone->cloneTableStructure();
+
+ $db->tablePrefix( $prefix );
+ $db->_originalTablePrefix = $oldPrefix;
+ }
+
+ return true;
+ }
+
+ /**
+ * Set up all test DBs
+ */
+ 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 );
+ }
+
+ // NOTE: Change the prefix in the LBFactory and $wgDBprefix, to prevent
+ // *any* database connections to operate on live data.
+ CloneDatabase::changePrefix( $testPrefix );
+ }
+
+ /**
+ * Creates an empty skeleton of the wiki database by cloning its structure
+ * to equivalent tables using the given $prefix. Then sets MediaWiki to
+ * use the new set of tables (aka schema) instead of the original set.
+ *
+ * This is used to generate a dummy table set, typically consisting of temporary
+ * tables, that will be used by tests instead of the original wiki database tables.
+ *
+ * @since 1.21
+ *
+ * @note the original table prefix is stored in self::$oldTablePrefix. This is used
+ * by teardownTestDB() to return the wiki to using the original table set.
+ *
+ * @note this method only works when first called. Subsequent calls have no effect,
+ * even if using different parameters.
+ *
+ * @param IMaintainableDatabase $db The database connection
+ * @param string $prefix The prefix to use for the new table set (aka schema).
+ *
+ * @throws MWException If the database table prefix is already $prefix
+ */
+ public static function setupTestDB( IMaintainableDatabase $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;', __METHOD__ );
+ }
+
+ Hooks::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
+ }
+
+ /**
+ * Clones the External Store database(s) for testing
+ *
+ * @param string|null $testPrefix Prefix for test tables. Will be determined automatically
+ * if not given.
+ */
+ protected static function setupExternalStoreTestDBs( $testPrefix = null ) {
+ $connections = self::getExternalStoreDatabaseConnections();
+ foreach ( $connections as $dbw ) {
+ self::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
+ }
+ }
+
+ /**
+ * Gets master database connections for all of the ExternalStoreDB
+ * stores configured in $wgDefaultExternalStore.
+ *
+ * @return Database[] Array of Database master connections
+ */
+ protected static function getExternalStoreDatabaseConnections() {
+ global $wgDefaultExternalStore;
+
+ /** @var ExternalStoreDB $externalStoreDB */
+ $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;
+ }
+
+ /**
+ * Check whether ExternalStoreDB is being used
+ *
+ * @return bool True if it's being used
+ */
+ 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;
+ }
+
+ /**
+ * @throws LogicException if the given database connection is not a set up to use
+ * mock tables.
+ *
+ * @since 1.31 this is no longer private.
+ */
+ protected function ensureMockDatabaseConnection( IDatabase $db ) {
+ if ( $db->tablePrefix() !== $this->dbPrefix() ) {
+ throw new LogicException(
+ 'Trying to delete mock tables, but table prefix does not indicate a mock database.'
+ );
+ }
+ }
+
+ private static $schemaOverrideDefaults = [
+ 'scripts' => [],
+ 'create' => [],
+ 'drop' => [],
+ 'alter' => [],
+ ];
+
+ /**
+ * Stub. If a test suite needs to test against a specific database schema, it should
+ * override this method and return the appropriate information from it.
+ *
+ * 'create', 'drop' and 'alter' in the returned array should list all the tables affected
+ * by the 'scripts', even if the test is only interested in a subset of them, otherwise
+ * the overrides may not be fully cleaned up, leading to errors later.
+ *
+ * @param IMaintainableDatabase $db The DB connection to use for the mock schema.
+ * May be used to check the current state of the schema, to determine what
+ * overrides are needed.
+ *
+ * @return array An associative array with the following fields:
+ * - 'scripts': any SQL scripts to run. If empty or not present, schema overrides are skipped.
+ * - 'create': A list of tables created (may or may not exist in the original schema).
+ * - 'drop': A list of tables dropped (expected to be present in the original schema).
+ * - 'alter': A list of tables altered (expected to be present in the original schema).
+ */
+ protected function getSchemaOverrides( IMaintainableDatabase $db ) {
+ return [];
+ }
+
+ /**
+ * Undoes the specified schema overrides..
+ * Called once per test class, just before addDataOnce().
+ *
+ * @param IMaintainableDatabase $db
+ * @param array $oldOverrides
+ */
+ private function undoSchemaOverrides( IMaintainableDatabase $db, $oldOverrides ) {
+ $this->ensureMockDatabaseConnection( $db );
+
+ $oldOverrides = $oldOverrides + self::$schemaOverrideDefaults;
+ $originalTables = $this->listOriginalTables( $db );
+
+ // Drop tables that need to be restored or removed.
+ $tablesToDrop = array_merge( $oldOverrides['create'], $oldOverrides['alter'] );
+
+ // Restore tables that have been dropped or created or altered,
+ // if they exist in the original schema.
+ $tablesToRestore = array_merge( $tablesToDrop, $oldOverrides['drop'] );
+ $tablesToRestore = array_intersect( $originalTables, $tablesToRestore );
+
+ if ( $tablesToDrop ) {
+ $this->dropMockTables( $db, $tablesToDrop );
+ }
+
+ if ( $tablesToRestore ) {
+ $this->recloneMockTables( $db, $tablesToRestore );
+
+ // Reset the restored tables, mainly for the side effect of
+ // re-calling $this->addCoreDBData() if necessary.
+ $this->resetDB( $db, $tablesToRestore );
+ }
+ }
+
+ /**
+ * Applies the schema overrides returned by getSchemaOverrides(),
+ * after undoing any previously applied schema overrides.
+ * Called once per test class, just before addDataOnce().
+ */
+ private function setUpSchema( IMaintainableDatabase $db ) {
+ // Undo any active overrides.
+ $oldOverrides = $db->_schemaOverrides ?? self::$schemaOverrideDefaults;
+
+ if ( $oldOverrides['alter'] || $oldOverrides['create'] || $oldOverrides['drop'] ) {
+ $this->undoSchemaOverrides( $db, $oldOverrides );
+ unset( $db->_schemaOverrides );
+ }
+
+ // Determine new overrides.
+ $overrides = $this->getSchemaOverrides( $db ) + self::$schemaOverrideDefaults;
+
+ $extraKeys = array_diff(
+ array_keys( $overrides ),
+ array_keys( self::$schemaOverrideDefaults )
+ );
+
+ if ( $extraKeys ) {
+ throw new InvalidArgumentException(
+ 'Schema override contains extra keys: ' . var_export( $extraKeys, true )
+ );
+ }
+
+ if ( !$overrides['scripts'] ) {
+ // no scripts to run
+ return;
+ }
+
+ if ( !$overrides['create'] && !$overrides['drop'] && !$overrides['alter'] ) {
+ throw new InvalidArgumentException(
+ 'Schema override scripts given, but no tables are declared to be '
+ . 'created, dropped or altered.'
+ );
+ }
+
+ $this->ensureMockDatabaseConnection( $db );
+
+ // Drop the tables that will be created by the schema scripts.
+ $originalTables = $this->listOriginalTables( $db );
+ $tablesToDrop = array_intersect( $originalTables, $overrides['create'] );
+
+ if ( $tablesToDrop ) {
+ $this->dropMockTables( $db, $tablesToDrop );
+ }
+
+ // Run schema override scripts.
+ foreach ( $overrides['scripts'] as $script ) {
+ $db->sourceFile(
+ $script,
+ null,
+ null,
+ __METHOD__,
+ function ( $cmd ) {
+ return $this->mungeSchemaUpdateQuery( $cmd );
+ }
+ );
+ }
+
+ $db->_schemaOverrides = $overrides;
+ }
+
+ private function mungeSchemaUpdateQuery( $cmd ) {
+ return self::$useTemporaryTables
+ ? preg_replace( '/\bCREATE\s+TABLE\b/i', 'CREATE TEMPORARY TABLE', $cmd )
+ : $cmd;
+ }
+
+ /**
+ * Drops the given mock tables.
+ *
+ * @param IMaintainableDatabase $db
+ * @param array $tables
+ */
+ private function dropMockTables( IMaintainableDatabase $db, array $tables ) {
+ $this->ensureMockDatabaseConnection( $db );
+
+ foreach ( $tables as $tbl ) {
+ $tbl = $db->tableName( $tbl );
+ $db->query( "DROP TABLE IF EXISTS $tbl", __METHOD__ );
+ }
+ }
+
+ /**
+ * Lists all tables in the live database schema, without a prefix.
+ *
+ * @param IMaintainableDatabase $db
+ * @return array
+ */
+ private function listOriginalTables( IMaintainableDatabase $db ) {
+ if ( !isset( $db->_originalTablePrefix ) ) {
+ throw new LogicException( 'No original table prefix know, cannot list tables!' );
+ }
+
+ $originalTables = $db->listTables( $db->_originalTablePrefix, __METHOD__ );
+
+ $unittestPrefixRegex = '/^' . preg_quote( $this->dbPrefix(), '/' ) . '/';
+ $originalPrefixRegex = '/^' . preg_quote( $db->_originalTablePrefix, '/' ) . '/';
+
+ $originalTables = array_filter(
+ $originalTables,
+ function ( $pt ) use ( $unittestPrefixRegex ) {
+ return !preg_match( $unittestPrefixRegex, $pt );
+ }
+ );
+
+ $originalTables = array_map(
+ function ( $pt ) use ( $originalPrefixRegex ) {
+ return preg_replace( $originalPrefixRegex, '', $pt );
+ },
+ $originalTables
+ );
+
+ return array_unique( $originalTables );
+ }
+
+ /**
+ * Re-clones the given mock tables to restore them based on the live database schema.
+ * The tables listed in $tables are expected to currently not exist, so dropMockTables()
+ * should be called first.
+ *
+ * @param IMaintainableDatabase $db
+ * @param array $tables
+ */
+ private function recloneMockTables( IMaintainableDatabase $db, array $tables ) {
+ $this->ensureMockDatabaseConnection( $db );
+
+ if ( !isset( $db->_originalTablePrefix ) ) {
+ throw new LogicException( 'No original table prefix know, cannot restore tables!' );
+ }
+
+ $originalTables = $this->listOriginalTables( $db );
+ $tables = array_intersect( $tables, $originalTables );
+
+ $dbClone = new CloneDatabase( $db, $tables, $db->tablePrefix(), $db->_originalTablePrefix );
+ $dbClone->useTemporaryTables( self::$useTemporaryTables );
+
+ $dbClone->cloneTableStructure();
+ }
+
+ /**
+ * Empty all tables so they can be repopulated for tests
+ *
+ * @param Database $db|null Database to reset
+ * @param array $tablesUsed Tables to reset
+ */
+ private function resetDB( $db, $tablesUsed ) {
+ if ( $db ) {
+ $userTables = [ 'user', 'user_groups', 'user_properties', 'actor' ];
+ $pageTables = [
+ 'page', 'revision', 'ip_changes', 'revision_comment_temp', 'comment', 'archive',
+ 'revision_actor_temp', 'slots', 'content', 'content_models', 'slot_roles',
+ ];
+ $coreDBDataTables = array_merge( $userTables, $pageTables );
+
+ // If any of the user or page 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();
+
+ // Reset $wgUser, which is probably 127.0.0.1, as its loaded data is probably not valid
+ // @todo Should we start setting $wgUser to something nondeterministic
+ // to encourage tests to be updated to not depend on it?
+ global $wgUser;
+ $wgUser->clearInstanceCache( $wgUser->mFrom );
+ }
+ if ( array_intersect( $tablesUsed, $pageTables ) ) {
+ $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
+ }
+
+ // Postgres, Oracle, and MSSQL all use mwuser/pagecontent
+ // instead of user/text. But Postgres does not remap the
+ // table name in tableExists(), so we mark the real table
+ // names as being used.
+ if ( $db->getType() === 'postgres' ) {
+ if ( in_array( 'user', $tablesUsed ) ) {
+ $tablesUsed[] = 'mwuser';
+ }
+ if ( in_array( 'text', $tablesUsed ) ) {
+ $tablesUsed[] = 'pagecontent';
+ }
+ }
+
+ foreach ( $tablesUsed as $tbl ) {
+ $this->truncateTable( $tbl, $db );
+ }
+
+ if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
+ // Reset services that may contain information relating to the truncated tables
+ $this->overrideMwServices();
+ // Re-add core DB data that was deleted
+ $this->addCoreDBData();
+ }
+ }
+ }
+
+ /**
+ * Empties the given table and resets any auto-increment counters.
+ * Will also purge caches associated with some well known tables.
+ * If the table is not know, this method just returns.
+ *
+ * @param string $tableName
+ * @param IDatabase|null $db
+ */
+ protected function truncateTable( $tableName, IDatabase $db = null ) {
+ if ( !$db ) {
+ $db = $this->db;
+ }
+
+ if ( !$db->tableExists( $tableName ) ) {
+ return;
+ }
+
+ $truncate = in_array( $db->getType(), [ 'oracle', 'mysql' ] );
+
+ if ( $truncate ) {
+ $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tableName ), __METHOD__ );
+ } else {
+ $db->delete( $tableName, '*', __METHOD__ );
+ }
+
+ if ( $db instanceof DatabasePostgres || $db instanceof DatabaseSqlite ) {
+ // Reset the table's sequence too.
+ $db->resetSequenceForTable( $tableName, __METHOD__ );
+ }
+
+ // re-initialize site_stats table
+ if ( $tableName === 'site_stats' ) {
+ SiteStatsInit::doPlaceholderInit();
+ }
+ }
+
+ private static function unprefixTable( &$tableName, $ind, $prefix ) {
+ $tableName = substr( $tableName, strlen( $prefix ) );
+ }
+
+ private static function isNotUnittest( $table ) {
+ return strpos( $table, self::DB_PREFIX ) !== 0;
+ }
+
+ /**
+ * @since 1.18
+ *
+ * @param IMaintainableDatabase $db
+ *
+ * @return array
+ */
+ 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;
+ }
+
+ /**
+ * Copy test data from one database connection to another.
+ *
+ * This should only be used for small data sets.
+ *
+ * @param IDatabase $source
+ * @param IDatabase $target
+ */
+ public function copyTestData( IDatabase $source, IDatabase $target ) {
+ if ( $this->db->getType() === 'sqlite' ) {
+ // SQLite uses a non-temporary copy of the searchindex table for testing,
+ // which gets deleted and re-created when setting up the secondary connection,
+ // causing "Error 17" when trying to copy the data. See T191863#4130112.
+ throw new RuntimeException(
+ 'Setting up a secondary database connection with test data is currently not'
+ . 'with SQLite. You may want to use markTestSkippedIfDbType() to bypass this issue.'
+ );
+ }
+
+ $tables = self::listOriginalTables( $source );
+
+ foreach ( $tables as $table ) {
+ $res = $source->select( $table, '*', [], __METHOD__ );
+ $allRows = [];
+
+ foreach ( $res as $row ) {
+ $allRows[] = (array)$row;
+ }
+
+ $target->insert( $table, $allRows, __METHOD__, [ 'IGNORE' ] );
+ }
+ }
+
+ /**
+ * @throws MWException
+ * @since 1.18
+ */
+ protected function checkDbIsSupported() {
+ if ( !in_array( $this->db->getType(), $this->supportedDBs ) ) {
+ throw new MWException( $this->db->getType() . " is not currently supported for unit testing." );
+ }
+ }
+
+ /**
+ * @since 1.18
+ * @param string $offset
+ * @return mixed
+ */
+ public function getCliArg( $offset ) {
+ return $this->cliArgs[$offset] ?? null;
+ }
+
+ /**
+ * @since 1.18
+ * @param string $offset
+ * @param mixed $value
+ */
+ public function setCliArg( $offset, $value ) {
+ $this->cliArgs[$offset] = $value;
+ }
+
+ /**
+ * Don't throw a warning if $function is deprecated and called later
+ *
+ * @since 1.19
+ *
+ * @param string $function
+ */
+ public function hideDeprecated( $function ) {
+ Wikimedia\suppressWarnings();
+ wfDeprecated( $function );
+ Wikimedia\restoreWarnings();
+ }
+
+ /**
+ * Asserts that the given database query yields the rows given by $expectedRows.
+ * The expected rows should be given as indexed (not associative) arrays, with
+ * the values given in the order of the columns in the $fields parameter.
+ * Note that the rows are sorted by the columns given in $fields.
+ *
+ * @since 1.20
+ *
+ * @param string|array $table The table(s) to query
+ * @param string|array $fields The columns to include in the result (and to sort by)
+ * @param string|array $condition "where" condition(s)
+ * @param array $expectedRows An array of arrays giving the expected rows.
+ * @param array $options Options for the query
+ * @param array $join_conds Join conditions for the query
+ *
+ * @throws MWException If this test cases's needsDB() method doesn't return true.
+ * Test cases can use "@group Database" to enable database test support,
+ * or list the tables under testing in $this->tablesUsed, or override the
+ * needsDB() method.
+ */
+ protected function assertSelect(
+ $table, $fields, $condition, array $expectedRows, array $options = [], array $join_conds = []
+ ) {
+ 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_REPLICA );
+
+ $res = $db->select(
+ $table,
+ $fields,
+ $condition,
+ wfGetCaller(),
+ $options + [ 'ORDER BY' => $fields ],
+ $join_conds
+ );
+ $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)" );
+ }
+
+ /**
+ * Utility method taking an array of elements and wrapping
+ * each element in its own array. Useful for data providers
+ * that only return a single argument.
+ *
+ * @since 1.20
+ *
+ * @param array $elements
+ *
+ * @return array
+ */
+ protected function arrayWrap( array $elements ) {
+ return array_map(
+ function ( $element ) {
+ return [ $element ];
+ },
+ $elements
+ );
+ }
+
+ /**
+ * Assert that two arrays are equal. By default this means that both arrays need to hold
+ * the same set of values. Using additional arguments, order and associated key can also
+ * be set as relevant.
+ *
+ * @since 1.20
+ *
+ * @param array $expected
+ * @param array $actual
+ * @param bool $ordered If the order of the values should match
+ * @param bool $named If the keys should match
+ */
+ 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 ) )
+ );
+ }
+
+ /**
+ * Put each HTML element on its own line and then equals() the results
+ *
+ * Use for nicely formatting of PHPUnit diff output when comparing very
+ * simple HTML
+ *
+ * @since 1.20
+ *
+ * @param string $expected HTML on oneline
+ * @param string $actual HTML on oneline
+ * @param string $msg Optional message
+ */
+ protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
+ $expected = str_replace( '>', ">\n", $expected );
+ $actual = str_replace( '>', ">\n", $actual );
+
+ $this->assertEquals( $expected, $actual, $msg );
+ }
+
+ /**
+ * Does an associative sort that works for objects.
+ *
+ * @since 1.20
+ *
+ * @param array &$array
+ */
+ protected function objectAssociativeSort( array &$array ) {
+ uasort(
+ $array,
+ function ( $a, $b ) {
+ return serialize( $a ) <=> serialize( $b );
+ }
+ );
+ }
+
+ /**
+ * Utility function for eliminating all string keys from an array.
+ * Useful to turn a database result row as returned by fetchRow() into
+ * a pure indexed array.
+ *
+ * @since 1.20
+ *
+ * @param mixed &$r The array to remove string keys from.
+ */
+ protected static function stripStringKeys( &$r ) {
+ if ( !is_array( $r ) ) {
+ return;
+ }
+
+ foreach ( $r as $k => $v ) {
+ if ( is_string( $k ) ) {
+ unset( $r[$k] );
+ }
+ }
+ }
+
+ /**
+ * Asserts that the provided variable is of the specified
+ * internal type or equals the $value argument. This is useful
+ * for testing return types of functions that return a certain
+ * type or *value* when not set or on error.
+ *
+ * @since 1.20
+ *
+ * @param string $type
+ * @param mixed $actual
+ * @param mixed $value
+ * @param string $message
+ */
+ protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
+ if ( $actual === $value ) {
+ $this->assertTrue( true, $message );
+ } else {
+ $this->assertType( $type, $actual, $message );
+ }
+ }
+
+ /**
+ * Asserts the type of the provided value. This can be either
+ * in internal type such as boolean or integer, or a class or
+ * interface the value extends or implements.
+ *
+ * @since 1.20
+ *
+ * @param string $type
+ * @param mixed $actual
+ * @param string $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 );
+ }
+ }
+
+ /**
+ * Returns true if the given namespace defaults to Wikitext
+ * according to $wgNamespaceContentModels
+ *
+ * @param int $ns The namespace ID to check
+ *
+ * @return bool
+ * @since 1.21
+ */
+ protected function isWikitextNS( $ns ) {
+ global $wgNamespaceContentModels;
+
+ if ( isset( $wgNamespaceContentModels[$ns] ) ) {
+ return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT;
+ }
+
+ return true;
+ }
+
+ /**
+ * Returns the ID of a namespace that defaults to Wikitext.
+ *
+ * @throws MWException If there is none.
+ * @return int The ID of the wikitext Namespace
+ * @since 1.21
+ */
+ 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
+ $nsInfo = MediaWikiServices::getInstance()->getNamespaceInfo();
+ $namespaces = array_unique( array_merge(
+ $nsInfo->getContentNamespaces(),
+ [ NS_MAIN, NS_HELP, NS_PROJECT ], // prefer these
+ $nsInfo->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 ) use ( $nsInfo ) {
+ return $nsInfo->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!" );
+ }
+
+ /**
+ * Check, if $wgDiff3 is set and ready to merge
+ * Will mark the calling test as skipped, if not ready
+ *
+ * @since 1.21
+ */
+ protected function markTestSkippedIfNoDiff3() {
+ global $wgDiff3;
+
+ # This check may also protect against code injection in
+ # case of broken installations.
+ Wikimedia\suppressWarnings();
+ $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
+ Wikimedia\restoreWarnings();
+
+ if ( !$haveDiff3 ) {
+ $this->markTestSkipped( "Skip test, since diff3 is not configured" );
+ }
+ }
+
+ /**
+ * Check if $extName is a loaded PHP extension, will skip the
+ * test whenever it is not loaded.
+ *
+ * @since 1.21
+ * @param string $extName
+ * @return bool
+ */
+ protected function checkPHPExtension( $extName ) {
+ $loaded = extension_loaded( $extName );
+ if ( !$loaded ) {
+ $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
+ }
+
+ return $loaded;
+ }
+
+ /**
+ * Skip the test if using the specified database type
+ *
+ * @param string $type Database type
+ * @since 1.32
+ */
+ protected function markTestSkippedIfDbType( $type ) {
+ if ( $this->db->getType() === $type ) {
+ $this->markTestSkipped( "The $type database type isn't supported for this test" );
+ }
+ }
+
+ /**
+ * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
+ * @param string $buffer
+ * @return string
+ */
+ public static function wfResetOutputBuffersBarrier( $buffer ) {
+ return $buffer;
+ }
+
+ /**
+ * Create a temporary hook handler which will be reset by tearDown.
+ * This replaces other handlers for the same hook.
+ * @param string $hookName Hook name
+ * @param mixed $handler Value suitable for a hook handler
+ * @since 1.28
+ */
+ protected function setTemporaryHook( $hookName, $handler ) {
+ $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
+ }
+
+ /**
+ * Check whether file contains given data.
+ * @param string $fileName
+ * @param string $actualData
+ * @param bool $createIfMissing If true, and file does not exist, create it with given data
+ * and skip the test.
+ * @param string $msg
+ * @since 1.30
+ */
+ protected function assertFileContains(
+ $fileName,
+ $actualData,
+ $createIfMissing = false,
+ $msg = ''
+ ) {
+ if ( $createIfMissing ) {
+ if ( !file_exists( $fileName ) ) {
+ file_put_contents( $fileName, $actualData );
+ $this->markTestSkipped( "Data file $fileName does not exist" );
+ }
+ } else {
+ self::assertFileExists( $fileName );
+ }
+ self::assertEquals( file_get_contents( $fileName ), $actualData, $msg );
+ }
+
+ /**
+ * Edits or creates a page/revision
+ * @param string $pageName Page title
+ * @param string $text Content of the page
+ * @param string $summary Optional summary string for the revision
+ * @param int $defaultNs Optional namespace id
+ * @param User|null $user If null, static::getTestSysop()->getUser() is used.
+ * @return Status Object as returned by WikiPage::doEditContent()
+ * @throws MWException If this test cases's needsDB() method doesn't return true.
+ * Test cases can use "@group Database" to enable database test support,
+ * or list the tables under testing in $this->tablesUsed, or override the
+ * needsDB() method.
+ */
+ protected function editPage(
+ $pageName,
+ $text,
+ $summary = '',
+ $defaultNs = NS_MAIN,
+ User $user = null
+ ) {
+ if ( !$this->needsDB() ) {
+ throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
+ ' method should return true. Use @group Database or $this->tablesUsed.' );
+ }
+
+ $title = Title::newFromText( $pageName, $defaultNs );
+ $page = WikiPage::factory( $title );
+
+ return $page->doEditContent(
+ ContentHandler::makeContent( $text, $title ),
+ $summary,
+ 0,
+ false,
+ $user
+ );
+ }
+
+ /**
+ * Revision-deletes a revision.
+ *
+ * @param Revision|int $rev Revision to delete
+ * @param array $value Keys are Revision::DELETED_* flags. Values are 1 to set the bit, 0 to
+ * clear, -1 to leave alone. (All other values also clear the bit.)
+ * @param string $comment Deletion comment
+ */
+ protected function revisionDelete(
+ $rev, array $value = [ Revision::DELETED_TEXT => 1 ], $comment = ''
+ ) {
+ if ( is_int( $rev ) ) {
+ $rev = Revision::newFromId( $rev );
+ }
+ RevisionDeleter::createList(
+ 'revision', RequestContext::getMain(), $rev->getTitle(), [ $rev->getId() ]
+ )->setVisibility( [
+ 'value' => $value,
+ 'comment' => $comment,
+ ] );
+ }
+
+ /**
+ * Returns a PHPUnit constraint that matches anything other than a fixed set of values. This can
+ * be used to whitelist values, e.g.
+ * $mock->expects( $this->never() )->method( $this->anythingBut( 'foo', 'bar' ) );
+ * which will throw if any unexpected method is called.
+ *
+ * @param mixed ...$values Values that are not matched
+ */
+ protected function anythingBut( ...$values ) {
+ return $this->logicalNot( $this->logicalOr(
+ ...array_map( [ $this, 'matches' ], $values )
+ ) );
+ }
+}
+
+class_alias( 'MediaWikiIntegrationTestCase', 'MediaWikiTestCase' );
+++ /dev/null
-<?php
-
-use MediaWiki\Logger\LegacySpi;
-use MediaWiki\Logger\LoggerFactory;
-use MediaWiki\Logger\MonologSpi;
-use MediaWiki\Logger\LogCapturingSpi;
-use MediaWiki\MediaWikiServices;
-use Psr\Log\LoggerInterface;
-use Wikimedia\Rdbms\IDatabase;
-use Wikimedia\Rdbms\IMaintainableDatabase;
-use Wikimedia\Rdbms\Database;
-use Wikimedia\TestingAccessWrapper;
-
-/**
- * @since 1.18
- */
-abstract class MediaWikiTestCase extends PHPUnit\Framework\TestCase {
-
- use MediaWikiCoversValidator;
- use PHPUnit4And6Compat;
-
- /**
- * The original service locator. This is overridden during setUp().
- *
- * @var MediaWikiServices|null
- */
- private static $originalServices;
-
- /**
- * The local service locator, created during setUp().
- * @var MediaWikiServices
- */
- private $localServices;
-
- /**
- * $called tracks whether the setUp and tearDown method has been called.
- * class extending MediaWikiTestCase usually override setUp and tearDown
- * but forget to call the parent.
- *
- * The array format takes a method name as key and anything as a value.
- * By asserting the key exist, we know the child class has called the
- * parent.
- *
- * This property must be private, we do not want child to override it,
- * they should call the appropriate parent method instead.
- */
- private $called = [];
-
- /**
- * @var TestUser[]
- * @since 1.20
- */
- public static $users;
-
- /**
- * Primary database
- *
- * @var Database
- * @since 1.18
- */
- protected $db;
-
- /**
- * @var array
- * @since 1.19
- */
- protected $tablesUsed = []; // tables with data
-
- private static $useTemporaryTables = true;
- private static $reuseDB = false;
- private static $dbSetup = false;
- private static $oldTablePrefix = '';
-
- /**
- * Original value of PHP's error_reporting setting.
- *
- * @var int
- */
- private $phpErrorLevel;
-
- /**
- * Holds the paths of temporary files/directories created through getNewTempFile,
- * and getNewTempDirectory
- *
- * @var array
- */
- private $tmpFiles = [];
-
- /**
- * Holds original values of MediaWiki configuration settings
- * to be restored in tearDown().
- * See also setMwGlobals().
- * @var array
- */
- private $mwGlobals = [];
-
- /**
- * Holds list of MediaWiki configuration settings to be unset in tearDown().
- * See also setMwGlobals().
- * @var array
- */
- private $mwGlobalsToUnset = [];
-
- /**
- * Holds original values of ini settings to be restored
- * in tearDown().
- * @see setIniSettings()
- * @var array
- */
- private $iniSettings = [];
-
- /**
- * Holds original loggers which have been replaced by setLogger()
- * @var LoggerInterface[]
- */
- private $loggers = [];
-
- /**
- * The CLI arguments passed through from phpunit.php
- * @var array
- */
- private $cliArgs = [];
-
- /**
- * Holds a list of services that were overridden with setService(). Used for printing an error
- * if overrideMwServices() overrides a service that was previously set.
- * @var string[]
- */
- private $overriddenServices = [];
-
- /**
- * Table name prefixes. Oracle likes it shorter.
- */
- const DB_PREFIX = 'unittest_';
- const ORA_DB_PREFIX = 'ut_';
-
- /**
- * @var array
- * @since 1.18
- */
- 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 original service locator
- if ( !self::$originalServices ) {
- self::$originalServices = MediaWikiServices::getInstance();
- }
- }
-
- /**
- * Convenience method for getting an immutable test user
- *
- * @since 1.28
- *
- * @param string|string[] $groups Groups the test user should be in.
- * @return TestUser
- */
- public static function getTestUser( $groups = [] ) {
- return TestUserRegistry::getImmutableTestUser( $groups );
- }
-
- /**
- * Convenience method for getting a mutable test user
- *
- * @since 1.28
- *
- * @param string|string[] $groups Groups the test user should be added in.
- * @return TestUser
- */
- public static function getMutableTestUser( $groups = [] ) {
- return TestUserRegistry::getMutableTestUser( __CLASS__, $groups );
- }
-
- /**
- * Convenience method for getting an immutable admin test user
- *
- * @since 1.28
- *
- * @param string[] $groups Groups the test user should be added to.
- * @return TestUser
- */
- public static function getTestSysop() {
- return self::getTestUser( [ 'sysop', 'bureaucrat' ] );
- }
-
- /**
- * Returns a WikiPage representing an existing page.
- *
- * @since 1.32
- *
- * @param Title|string|null $title
- * @return WikiPage
- * @throws MWException If this test cases's needsDB() method doesn't return true.
- * Test cases can use "@group Database" to enable database test support,
- * or list the tables under testing in $this->tablesUsed, or override the
- * needsDB() method.
- */
- protected function getExistingTestPage( $title = null ) {
- if ( !$this->needsDB() ) {
- throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
- ' method should return true. Use @group Database or $this->tablesUsed.' );
- }
-
- $title = ( $title === null ) ? 'UTPage' : $title;
- $title = is_string( $title ) ? Title::newFromText( $title ) : $title;
- $page = WikiPage::factory( $title );
-
- if ( !$page->exists() ) {
- $user = self::getTestSysop()->getUser();
- $page->doEditContent(
- new WikitextContent( 'UTContent' ),
- 'UTPageSummary',
- EDIT_NEW | EDIT_SUPPRESS_RC,
- false,
- $user
- );
- }
-
- return $page;
- }
-
- /**
- * Returns a WikiPage representing a non-existing page.
- *
- * @since 1.32
- *
- * @param Title|string|null $title
- * @return WikiPage
- * @throws MWException If this test cases's needsDB() method doesn't return true.
- * Test cases can use "@group Database" to enable database test support,
- * or list the tables under testing in $this->tablesUsed, or override the
- * needsDB() method.
- */
- protected function getNonexistingTestPage( $title = null ) {
- if ( !$this->needsDB() ) {
- throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
- ' method should return true. Use @group Database or $this->tablesUsed.' );
- }
-
- $title = ( $title === null ) ? 'UTPage-' . rand( 0, 100000 ) : $title;
- $title = is_string( $title ) ? Title::newFromText( $title ) : $title;
- $page = WikiPage::factory( $title );
-
- if ( $page->exists() ) {
- $page->doDeleteArticle( 'Testing' );
- }
-
- return $page;
- }
-
- /**
- * @deprecated since 1.32
- */
- public static function prepareServices( Config $bootstrapConfig ) {
- }
-
- /**
- * Create a config suitable for testing, based on a base config, default overrides,
- * and custom overrides.
- *
- * @param Config|null $baseConfig
- * @param Config|null $customOverrides
- *
- * @return Config
- */
- private static function makeTestConfig(
- Config $baseConfig = null,
- Config $customOverrides = null
- ) {
- $defaultOverrides = new HashConfig();
-
- if ( !$baseConfig ) {
- $baseConfig = self::$originalServices->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::class, 'reportDupes' => false ];
- $objectCaches = [
- CACHE_DB => $hashCache,
- CACHE_ACCEL => $hashCache,
- CACHE_MEMCACHED => $hashCache,
- 'apc' => $hashCache,
- 'apcu' => $hashCache,
- 'wincache' => $hashCache,
- ] + $baseConfig->get( 'ObjectCaches' );
-
- $defaultOverrides->set( 'ObjectCaches', $objectCaches );
- $defaultOverrides->set( 'MainCacheType', CACHE_NONE );
- $defaultOverrides->set( 'JobTypeConf', [ 'default' => [ 'class' => JobQueueMemory::class ] ] );
-
- // 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;
- }
-
- /**
- * @param ConfigFactory $oldFactory
- * @param Config[] $configurations
- *
- * @return Closure
- */
- 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;
- };
- }
-
- /**
- * Resets some non-service singleton instances and other static caches. It's not necessary to
- * reset services here.
- */
- public static function resetNonServiceCaches() {
- global $wgRequest, $wgJobClasses;
-
- User::resetGetDefaultOptionsForTestsOnly();
- foreach ( $wgJobClasses as $type => $class ) {
- JobQueueGroup::singleton()->get( $type )->delete();
- }
- JobQueueGroup::destroySingletons();
-
- ObjectCache::clear();
- FileBackendGroup::destroySingleton();
- DeferredUpdates::clearPendingUpdates();
-
- // 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 ) {
- if ( $result instanceof MediaWikiTestResult ) {
- $this->cliArgs = $result->getMediaWikiCliArgs();
- }
- $this->overrideMwServices();
-
- if ( $this->needsDB() && !$this->isTestInDatabaseGroup() ) {
- throw new Exception(
- get_class( $this ) . ' apparently needsDB but is not in the Database group'
- );
- }
-
- $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' );
-
- $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
- $this->db = $lb->getConnection( DB_MASTER );
-
- $this->checkDbIsSupported();
-
- if ( !self::$dbSetup ) {
- $this->setupAllTestDBs();
- $this->addCoreDBData();
- }
-
- // 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->setUpSchema( $this->db );
- $this->resetDB( $this->db, $this->tablesUsed );
- $this->addDBDataOnce();
- }
-
- $this->addDBData();
- $needsResetDB = true;
- }
-
- parent::run( $result );
-
- // We don't mind if we override already-overridden services during cleanup
- $this->overriddenServices = [];
-
- if ( $needsResetDB ) {
- $this->resetDB( $this->db, $this->tablesUsed );
- }
-
- self::restoreMwServices();
- $this->localServices = null;
- }
-
- /**
- * @return bool
- */
- 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;
- }
-
- /**
- * @since 1.21
- *
- * @return bool
- */
- public function usesTemporaryTables() {
- return self::$useTemporaryTables;
- }
-
- /**
- * Obtains a new temporary file name
- *
- * The obtained filename is enlisted to be removed upon tearDown
- *
- * @since 1.20
- *
- * @return string Absolute name of the temporary file
- */
- protected function getNewTempFile() {
- $fileName = tempnam(
- wfTempDir(),
- // Avoid backslashes here as they result in inconsistent results
- // between Windows and other OS, as well as between functions
- // that try to normalise these in one or both directions.
- // For example, tempnam rejects directory separators in the prefix which
- // means it rejects any namespaced class on Windows.
- // And then there is, wfMkdirParents which normalises paths always
- // whereas most other PHP and MW functions do not.
- 'MW_PHPUnit_' . strtr( static::class, [ '\\' => '_' ] ) . '_'
- );
- $this->tmpFiles[] = $fileName;
-
- return $fileName;
- }
-
- /**
- * obtains a new temporary directory
- *
- * The obtained directory is enlisted to be removed (recursively with all its contained
- * files) upon tearDown.
- *
- * @since 1.20
- *
- * @return string Absolute name of the temporary directory
- */
- 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 );
- // If this fails for some reason, PHP will warn and fail the test.
- mkdir( $fileName, 0777, /* recursive = */ true );
-
- return $fileName;
- }
-
- protected function setUp() {
- parent::setUp();
- $this->called['setUp'] = true;
-
- $this->phpErrorLevel = intval( ini_get( 'error_reporting' ) );
-
- $this->overriddenServices = [];
-
- // 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'", __METHOD__ );
- }
- }
-
- // Reset all caches between tests.
- self::resetNonServiceCaches();
-
- // XXX: reset maintenance triggers
- // Hook into period lag checks which often happen in long-running scripts
- $lbFactory = $this->localServices->getDBLoadBalancerFactory();
- Maintenance::setLBFactoryTriggers( $lbFactory, $this->localServices->getMainConfig() );
-
- ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
- }
-
- protected function addTmpFiles( $files ) {
- $this->tmpFiles = array_merge( $this->tmpFiles, (array)$files );
- }
-
- // @todo Make const when we no longer support HHVM (T192166)
- private static $namespaceAffectingSettings = [
- 'wgAllowImageMoving',
- 'wgCanonicalNamespaceNames',
- 'wgCapitalLinkOverrides',
- 'wgCapitalLinks',
- 'wgContentNamespaces',
- 'wgExtensionMessagesFiles',
- 'wgExtensionNamespaces',
- 'wgExtraNamespaces',
- 'wgExtraSignatureNamespaces',
- 'wgNamespaceContentModels',
- 'wgNamespaceProtection',
- 'wgNamespacesWithSubpages',
- 'wgNonincludableNamespaces',
- 'wgRestrictionLevels',
- ];
-
- 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 ),
- __METHOD__ );
- }
- }
-
- // Re-enable any disabled deprecation warnings
- MWDebug::clearLog();
- // Restore mw globals
- foreach ( $this->mwGlobals as $key => $value ) {
- $GLOBALS[$key] = $value;
- }
- foreach ( $this->mwGlobalsToUnset as $value ) {
- unset( $GLOBALS[$value] );
- }
- foreach ( $this->iniSettings as $name => $value ) {
- ini_set( $name, $value );
- }
- if (
- array_intersect( self::$namespaceAffectingSettings, array_keys( $this->mwGlobals ) ) ||
- array_intersect( self::$namespaceAffectingSettings, $this->mwGlobalsToUnset )
- ) {
- $this->resetNamespaces();
- }
- $this->mwGlobals = [];
- $this->mwGlobalsToUnset = [];
- $this->restoreLoggers();
-
- // 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();
- }
-
- /**
- * Make sure MediaWikiTestCase extending classes have called their
- * parent setUp method
- *
- * With strict coverage activated in PHP_CodeCoverage, this test would be
- * marked as risky without the following annotation (T152923).
- * @coversNothing
- */
- final public function testMediaWikiTestCaseParentSetupCalled() {
- $this->assertArrayHasKey( 'setUp', $this->called,
- static::class . '::setUp() must call parent::setUp()'
- );
- }
-
- /**
- * Sets a service, maintaining a stashed version of the previous service to be
- * restored in tearDown.
- *
- * @note Tests must not call overrideMwServices() after calling setService(), since that would
- * lose the new service instance. Since 1.34, resetServices() can be used instead, which
- * would reset other services, but retain any services set using setService().
- * This means that once a service is set using this method, it cannot be reverted to
- * the original service within the same test method. The original service is restored
- * in tearDown after the test method has terminated.
- *
- * @param string $name
- * @param object $service The service instance, or a callable that returns the service instance.
- *
- * @since 1.27
- *
- */
- protected function setService( $name, $service ) {
- if ( !$this->localServices ) {
- throw new Exception( __METHOD__ . ' must be called after MediaWikiTestCase::run()' );
- }
-
- if ( $this->localServices !== MediaWikiServices::getInstance() ) {
- throw new Exception( __METHOD__ . ' will not work because the global MediaWikiServices '
- . 'instance has been replaced by test code.' );
- }
-
- if ( is_callable( $service ) ) {
- $instantiator = $service;
- } else {
- $instantiator = function () use ( $service ) {
- return $service;
- };
- }
-
- $this->overriddenServices[] = $name;
-
- $this->localServices->disableService( $name );
- $this->localServices->redefineService(
- $name,
- $instantiator
- );
-
- if ( $name === 'ContentLanguage' ) {
- $this->doSetMwGlobals( [ 'wgContLang' => $this->localServices->getContentLanguage() ] );
- }
- }
-
- /**
- * Sets a global, maintaining a stashed version of the previous global to be
- * restored in tearDown
- *
- * The key is added to the array of globals that will be reset afterwards
- * in the tearDown().
- *
- * It may be necessary to call resetServices() to allow any changed configuration variables
- * to take effect on services that get initialized based on these variables.
- *
- * @par Example
- * @code
- * protected function setUp() {
- * $this->setMwGlobals( 'wgRestrictStuff', true );
- * }
- *
- * function testFoo() {}
- *
- * function testBar() {}
- * $this->assertTrue( self::getX()->doStuff() );
- *
- * $this->setMwGlobals( 'wgRestrictStuff', false );
- * $this->assertTrue( self::getX()->doStuff() );
- * }
- *
- * function testQuux() {}
- * @endcode
- *
- * @param array|string $pairs Key to the global variable, or an array
- * of key/value pairs.
- * @param mixed|null $value Value to set the global to (ignored
- * if an array is given as first argument).
- *
- * @note To allow changes to global variables to take effect on global service instances,
- * call resetServices().
- *
- * @since 1.21
- */
- protected function setMwGlobals( $pairs, $value = null ) {
- if ( is_string( $pairs ) ) {
- $pairs = [ $pairs => $value ];
- }
-
- if ( isset( $pairs['wgContLang'] ) ) {
- throw new MWException(
- 'No setting $wgContLang, use setContentLang() or setService( \'ContentLanguage\' )'
- );
- }
-
- $this->doSetMwGlobals( $pairs, $value );
- }
-
- /**
- * An internal method that allows setService() to set globals that tests are not supposed to
- * touch.
- */
- private function doSetMwGlobals( $pairs, $value = null ) {
- $this->doStashMwGlobals( array_keys( $pairs ) );
-
- foreach ( $pairs as $key => $value ) {
- $GLOBALS[$key] = $value;
- }
-
- if ( array_intersect( self::$namespaceAffectingSettings, array_keys( $pairs ) ) ) {
- $this->resetNamespaces();
- }
- }
-
- /**
- * Set an ini setting for the duration of the test
- * @param string $name Name of the setting
- * @param string $value Value to set
- * @since 1.32
- */
- protected function setIniSetting( $name, $value ) {
- $original = ini_get( $name );
- $this->iniSettings[$name] = $original;
- ini_set( $name, $value );
- }
-
- /**
- * Must be called whenever namespaces are changed, e.g., $wgExtraNamespaces is altered.
- * Otherwise old namespace data will lurk and cause bugs.
- */
- private function resetNamespaces() {
- if ( !$this->localServices ) {
- throw new Exception( __METHOD__ . ' must be called after MediaWikiTestCase::run()' );
- }
-
- if ( $this->localServices !== MediaWikiServices::getInstance() ) {
- throw new Exception( __METHOD__ . ' will not work because the global MediaWikiServices '
- . 'instance has been replaced by test code.' );
- }
-
- Language::clearCaches();
- }
-
- /**
- * Check if we can back up a value by performing a shallow copy.
- * Values which fail this test are copied recursively.
- *
- * @param mixed $value
- * @return bool True if a shallow copy will do; false if a deep copy
- * is required.
- */
- 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;
- }
-
- private function doStashMwGlobals( $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];
- } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
- // Serializing Closure only gives a warning on HHVM while
- // it throws an Exception on Zend.
- // Workaround for https://github.com/facebook/hhvm/issues/6206
- $this->mwGlobals[$globalKey] = $GLOBALS[$globalKey];
- } else {
- try {
- $this->mwGlobals[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
- } catch ( Exception $e ) {
- $this->mwGlobals[$globalKey] = $GLOBALS[$globalKey];
- }
- }
- }
- }
- }
-
- /**
- * @param mixed $var
- * @param int $maxDepth
- *
- * @return bool
- */
- private function containsClosure( $var, $maxDepth = 15 ) {
- if ( $var instanceof Closure ) {
- return true;
- }
- if ( !is_array( $var ) || $maxDepth === 0 ) {
- return false;
- }
-
- foreach ( $var as $value ) {
- if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Merges the given values into a MW global array variable.
- * Useful for setting some entries in a configuration array, instead of
- * setting the entire array.
- *
- * It may be necessary to call resetServices() to allow any changed configuration variables
- * to take effect on services that get initialized based on these variables.
- *
- * @param string $name The name of the global, as in wgFooBar
- * @param array $values The array containing the entries to set in that global
- *
- * @throws MWException If the designated global is not an array.
- *
- * @note To allow changes to global variables to take effect on global service instances,
- * call resetServices().
- *
- * @since 1.21
- */
- 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 );
- }
-
- /**
- * Resets service instances in the global instance of MediaWikiServices.
- *
- * In contrast to overrideMwServices(), this does not create a new MediaWikiServices instance,
- * and it preserves any service instances set via setService().
- *
- * The primary use case for this method is to allow changes to global configuration variables
- * to take effect on services that get initialized based on these global configuration
- * variables. Similarly, it may be necessary to call resetServices() after calling setService(),
- * so the newly set service gets picked up by any other service definitions that may use it.
- *
- * @see MediaWikiServices::resetServiceForTesting.
- *
- * @since 1.34
- */
- protected function resetServices() {
- // Reset but don't destroy service instances supplied via setService().
- foreach ( $this->overriddenServices as $name ) {
- $this->localServices->resetServiceForTesting( $name, false );
- }
-
- // Reset all services with the destroy flag set.
- // This will not have any effect on services that had already been reset above.
- foreach ( $this->localServices->getServiceNames() as $name ) {
- $this->localServices->resetServiceForTesting( $name, true );
- }
-
- self::resetGlobalParser();
- }
-
- /**
- * Installs a new global instance of MediaWikiServices, allowing test cases to override
- * settings and services.
- *
- * This method can be used to set up specific services or configuration as a fixture.
- * It should not be used to reset services in between stages of a test - instead, the test
- * should either be split, or resetServices() should be used.
- *
- * If called with no parameters, this method restores all services to their default state.
- * This is done automatically before each test to isolate tests from any modification
- * to settings and services that may have been applied by previous tests.
- * That means that the effect of calling overrideMwServices() is undone before the next
- * call to a test method.
- *
- * @note Calling this after having called setService() in the same test method (or the
- * associated setUp) will result in an MWException.
- * Tests should use either overrideMwServices() or setService(), but not mix both.
- * Since 1.34, resetServices() is available as an alternative compatible with setService().
- *
- * @since 1.27
- *
- * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
- * instance.
- * @param callable[] $services An associative array of services to re-define. Keys are service
- * names, values are callables.
- *
- * @return MediaWikiServices
- * @throws MWException
- */
- protected function overrideMwServices(
- Config $configOverrides = null, array $services = []
- ) {
- if ( $this->overriddenServices ) {
- throw new MWException(
- 'The following services were set and are now being unset by overrideMwServices: ' .
- implode( ', ', $this->overriddenServices )
- );
- }
- $newInstance = self::installMockMwServices( $configOverrides );
-
- if ( $this->localServices ) {
- $this->localServices->destroy();
- }
-
- $this->localServices = $newInstance;
-
- foreach ( $services as $name => $callback ) {
- $newInstance->redefineService( $name, $callback );
- }
-
- self::resetGlobalParser();
-
- return $newInstance;
- }
-
- /**
- * Creates a new "mock" MediaWikiServices instance, and installs it.
- * This effectively resets all cached states in services, with the exception of
- * the ConfigFactory and the DBLoadBalancerFactory service, which are inherited from
- * the original MediaWikiServices.
- *
- * @note The new original MediaWikiServices instance can later be restored by calling
- * restoreMwServices(). That original is determined by the first call to this method, or
- * by setUpBeforeClass, whichever is called first. The caller is responsible for managing
- * and, when appropriate, destroying any other MediaWikiServices instances that may get
- * replaced when calling this method.
- *
- * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
- * instance.
- *
- * @return MediaWikiServices the new mock service locator.
- */
- public static function installMockMwServices( Config $configOverrides = null ) {
- // Make sure we have the original service locator
- if ( !self::$originalServices ) {
- self::$originalServices = MediaWikiServices::getInstance();
- }
-
- if ( !$configOverrides ) {
- $configOverrides = new HashConfig();
- }
-
- $oldConfigFactory = self::$originalServices->getConfigFactory();
- $oldLoadBalancerFactory = self::$originalServices->getDBLoadBalancerFactory();
-
- $testConfig = self::makeTestConfig( null, $configOverrides );
- $newServices = new MediaWikiServices( $testConfig );
-
- // Load the default wiring from the specified files.
- // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
- $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
- $newServices->loadWiringFiles( $wiringFiles );
-
- // Provide a traditional hook point to allow extensions to configure services.
- Hooks::run( '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 ]
- )
- );
- $newServices->resetServiceForTesting( 'DBLoadBalancerFactory' );
- $newServices->redefineService(
- 'DBLoadBalancerFactory',
- function ( MediaWikiServices $services ) use ( $oldLoadBalancerFactory ) {
- return $oldLoadBalancerFactory;
- }
- );
-
- MediaWikiServices::forceGlobalInstance( $newServices );
-
- self::resetGlobalParser();
-
- return $newServices;
- }
-
- /**
- * Restores the original, non-mock MediaWikiServices instance.
- * The previously active MediaWikiServices instance is destroyed,
- * if it is different from the original that is to be restored.
- *
- * @note this if for internal use by test framework code. It should never be
- * called from inside a test case, a data provider, or a setUp or tearDown method.
- *
- * @return bool true if the original service locator was restored,
- * false if there was nothing too do.
- */
- public static function restoreMwServices() {
- if ( !self::$originalServices ) {
- return false;
- }
-
- $currentServices = MediaWikiServices::getInstance();
-
- if ( self::$originalServices === $currentServices ) {
- return false;
- }
-
- MediaWikiServices::forceGlobalInstance( self::$originalServices );
- $currentServices->destroy();
-
- self::resetGlobalParser();
-
- return true;
- }
-
- /**
- * If $wgParser has been unstubbed, replace it with a fresh one so it picks up any config
- * changes. $wgParser is deprecated, but we still support it for now.
- */
- private static function resetGlobalParser() {
- // phpcs:ignore MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgParser
- global $wgParser;
- if ( $wgParser instanceof StubObject ) {
- return;
- }
- $wgParser = new StubObject( 'wgParser', function () {
- return MediaWikiServices::getInstance()->getParser();
- } );
- }
-
- /**
- * @since 1.27
- * @param string|Language $lang
- */
- public function setUserLang( $lang ) {
- RequestContext::getMain()->setLanguage( $lang );
- $this->setMwGlobals( 'wgLang', RequestContext::getMain()->getLanguage() );
- }
-
- /**
- * @since 1.27
- * @param string|Language $lang
- */
- public function setContentLang( $lang ) {
- if ( $lang instanceof Language ) {
- $this->setMwGlobals( 'wgLanguageCode', $lang->getCode() );
- // Set to the exact object requested
- $this->setService( 'ContentLanguage', $lang );
- } else {
- $this->setMwGlobals( 'wgLanguageCode', $lang );
- // Let the service handler make up the object. Avoid calling setService(), because if
- // we do, overrideMwServices() will complain if it's called later on.
- $services = MediaWikiServices::getInstance();
- $services->resetServiceForTesting( 'ContentLanguage' );
- $this->doSetMwGlobals( [ 'wgContLang' => $services->getContentLanguage() ] );
- }
- }
-
- /**
- * Alters $wgGroupPermissions for the duration of the test. Can be called
- * with an array, like
- * [ '*' => [ 'read' => false ], 'user' => [ 'read' => false ] ]
- * or three values to set a single permission, like
- * $this->setGroupPermissions( '*', 'read', false );
- *
- * @since 1.31
- * @param array|string $newPerms Either an array of permissions to change,
- * in which case the next two parameters are ignored; or a single string
- * identifying a group, to use with the next two parameters.
- * @param string|null $newKey
- * @param mixed|null $newValue
- */
- public function setGroupPermissions( $newPerms, $newKey = null, $newValue = null ) {
- global $wgGroupPermissions;
-
- if ( is_string( $newPerms ) ) {
- $newPerms = [ $newPerms => [ $newKey => $newValue ] ];
- }
-
- $newPermissions = $wgGroupPermissions;
- foreach ( $newPerms as $group => $permissions ) {
- foreach ( $permissions as $key => $value ) {
- $newPermissions[$group][$key] = $value;
- }
- }
-
- $this->setMwGlobals( 'wgGroupPermissions', $newPermissions );
-
- // Reset services so they pick up the new permissions.
- // Resetting just PermissionManager is not sufficient, since other services may
- // have the old instance of PermissionManager injected.
- $this->resetServices();
- }
-
- /**
- *
- * @since 1.34
- * Sets the logger for a specified channel, for the duration of the test.
- * @since 1.27
- * @param string $channel
- * @param LoggerInterface $logger
- */
- protected function setLogger( $channel, LoggerInterface $logger ) {
- // TODO: Once loggers are managed by MediaWikiServices, use
- // resetServiceForTesting() 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] = $singletons['loggers'][$channel] ?? null;
- }
- $singletons['loggers'][$channel] = $logger;
- } elseif ( $provider instanceof LegacySpi || $provider instanceof LogCapturingSpi ) {
- if ( !isset( $this->loggers[$channel] ) ) {
- $this->loggers[$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;
- }
-
- /**
- * Restores loggers replaced by setLogger().
- * @since 1.27
- */
- 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 || $provider instanceof LogCapturingSpi ) {
- if ( $logger === null ) {
- unset( $singletons[$channel] );
- } else {
- $singletons[$channel] = $logger;
- }
- }
- }
- $wrappedProvider->singletons = $singletons;
- $this->loggers = [];
- }
-
- /**
- * @return string
- * @since 1.18
- */
- public function dbPrefix() {
- return self::getTestPrefixFor( $this->db );
- }
-
- /**
- * @param IDatabase $db
- * @return string
- * @since 1.32
- */
- public static function getTestPrefixFor( IDatabase $db ) {
- return $db->getType() == 'oracle' ? self::ORA_DB_PREFIX : self::DB_PREFIX;
- }
-
- /**
- * @return bool
- * @since 1.18
- */
- public function needsDB() {
- // If the test says it uses database tables, it needs the database
- return $this->tablesUsed || $this->isTestInDatabaseGroup();
- }
-
- /**
- * @return bool
- * @since 1.32
- */
- protected function isTestInDatabaseGroup() {
- // If the test class says it belongs to the Database group, it needs the database.
- // NOTE: This ONLY checks for the group in the class level doc comment.
- $rc = new ReflectionClass( $this );
- return (bool)preg_match( '/@group +Database/im', $rc->getDocComment() );
- }
-
- /**
- * Insert a new page.
- *
- * Should be called from addDBData().
- *
- * @since 1.25 ($namespace in 1.28)
- * @param string|Title $pageName Page name or title
- * @param string $text Page's content
- * @param int|null $namespace Namespace id (name cannot already contain namespace)
- * @param User|null $user If null, static::getTestSysop()->getUser() is used.
- * @return array Title object and page id
- * @throws MWException If this test cases's needsDB() method doesn't return true.
- * Test cases can use "@group Database" to enable database test support,
- * or list the tables under testing in $this->tablesUsed, or override the
- * needsDB() method.
- */
- protected function insertPage(
- $pageName,
- $text = 'Sample page for unit test.',
- $namespace = null,
- User $user = null
- ) {
- if ( !$this->needsDB() ) {
- throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
- ' method should return true. Use @group Database or $this->tablesUsed.' );
- }
-
- if ( is_string( $pageName ) ) {
- $title = Title::newFromText( $pageName, $namespace );
- } else {
- $title = $pageName;
- }
-
- if ( !$user ) {
- $user = static::getTestSysop()->getUser();
- }
- $comment = __METHOD__ . ': Sample page for unit test.';
-
- $page = WikiPage::factory( $title );
- $page->doEditContent( ContentHandler::makeContent( $text, $title ), $comment, 0, false, $user );
-
- return [
- 'title' => $title,
- 'id' => $page->getId(),
- ];
- }
-
- /**
- * Stub. If a test suite needs to add additional data to the database, it should
- * implement this method and do so. This method is called once per test suite
- * (i.e. once per class).
- *
- * Note data added by this method may be removed by resetDB() depending on
- * the contents of $tablesUsed.
- *
- * To add additional data between test function runs, override prepareDB().
- *
- * @see addDBData()
- * @see resetDB()
- *
- * @since 1.27
- */
- public function addDBDataOnce() {
- }
-
- /**
- * Stub. Subclasses may override this to prepare the database.
- * Called before every test run (test function or data set).
- *
- * @see addDBDataOnce()
- * @see resetDB()
- *
- * @since 1.18
- */
- public function addDBData() {
- }
-
- /**
- * @since 1.32
- */
- protected 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' ] );
- }
- }
-
- SiteStatsInit::doPlaceholderInit();
-
- 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 | EDIT_SUPPRESS_RC,
- false,
- $user
- );
- // an edit always attempt to purge backlink links such as history
- // pages. That is unnecessary.
- JobQueueGroup::singleton()->get( 'htmlCacheUpdate' )->delete();
- // WikiPages::doEditUpdates randomly adds RC purges
- JobQueueGroup::singleton()->get( 'recentChangesUpdate' )->delete();
-
- // doEditContent() probably started the session via
- // User::loadFromSession(). Close it now.
- if ( session_id() !== '' ) {
- session_write_close();
- session_id( '' );
- }
- }
- }
-
- /**
- * Restores MediaWiki to using the table set (table prefix) it was using before
- * setupTestDB() was called. Useful if we need to perform database operations
- * after the test run has finished (such as saving logs or profiling info).
- *
- * This is called by phpunit/bootstrap.php after the last test.
- *
- * @since 1.21
- */
- public static function teardownTestDB() {
- global $wgJobClasses;
-
- if ( !self::$dbSetup ) {
- return;
- }
-
- Hooks::run( 'UnitTestsBeforeDatabaseTeardown' );
-
- foreach ( $wgJobClasses as $type => $class ) {
- // Delete any jobs under the clone DB (or old prefix in other stores)
- JobQueueGroup::singleton()->get( $type )->delete();
- }
-
- // T219673: close any connections from code that failed to call reuseConnection()
- // or is still holding onto a DBConnRef instance (e.g. in a singleton).
- MediaWikiServices::getInstance()->getDBLoadBalancerFactory()->closeAll();
- CloneDatabase::changePrefix( self::$oldTablePrefix );
-
- self::$oldTablePrefix = false;
- self::$dbSetup = false;
- }
-
- /**
- * Setups a database with cloned tables using the given prefix.
- *
- * If reuseDB is true and certain conditions apply, it will just change the prefix.
- * Otherwise, it will clone the tables and change the prefix.
- *
- * @param IMaintainableDatabase $db Database to use
- * @param string|null $prefix Prefix to use for test tables. If not given, the prefix is determined
- * automatically for $db.
- * @return bool True if tables were cloned, false if only the prefix was changed
- */
- protected static function setupDatabaseWithTestPrefix(
- IMaintainableDatabase $db,
- $prefix = null
- ) {
- if ( $prefix === null ) {
- $prefix = self::getTestPrefixFor( $db );
- }
-
- if ( ( $db->getType() == 'oracle' || !self::$useTemporaryTables ) && self::$reuseDB ) {
- $db->tablePrefix( $prefix );
- return false;
- }
-
- if ( !isset( $db->_originalTablePrefix ) ) {
- $oldPrefix = $db->tablePrefix();
-
- if ( $oldPrefix === $prefix ) {
- // table already has the correct prefix, but presumably no cloned tables
- $oldPrefix = self::$oldTablePrefix;
- }
-
- $db->tablePrefix( $oldPrefix );
- $tablesCloned = self::listTables( $db );
- $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix, $oldPrefix );
- $dbClone->useTemporaryTables( self::$useTemporaryTables );
-
- $dbClone->cloneTableStructure();
-
- $db->tablePrefix( $prefix );
- $db->_originalTablePrefix = $oldPrefix;
- }
-
- return true;
- }
-
- /**
- * Set up all test DBs
- */
- 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 );
- }
-
- // NOTE: Change the prefix in the LBFactory and $wgDBprefix, to prevent
- // *any* database connections to operate on live data.
- CloneDatabase::changePrefix( $testPrefix );
- }
-
- /**
- * Creates an empty skeleton of the wiki database by cloning its structure
- * to equivalent tables using the given $prefix. Then sets MediaWiki to
- * use the new set of tables (aka schema) instead of the original set.
- *
- * This is used to generate a dummy table set, typically consisting of temporary
- * tables, that will be used by tests instead of the original wiki database tables.
- *
- * @since 1.21
- *
- * @note the original table prefix is stored in self::$oldTablePrefix. This is used
- * by teardownTestDB() to return the wiki to using the original table set.
- *
- * @note this method only works when first called. Subsequent calls have no effect,
- * even if using different parameters.
- *
- * @param IMaintainableDatabase $db The database connection
- * @param string $prefix The prefix to use for the new table set (aka schema).
- *
- * @throws MWException If the database table prefix is already $prefix
- */
- public static function setupTestDB( IMaintainableDatabase $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;', __METHOD__ );
- }
-
- Hooks::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
- }
-
- /**
- * Clones the External Store database(s) for testing
- *
- * @param string|null $testPrefix Prefix for test tables. Will be determined automatically
- * if not given.
- */
- protected static function setupExternalStoreTestDBs( $testPrefix = null ) {
- $connections = self::getExternalStoreDatabaseConnections();
- foreach ( $connections as $dbw ) {
- self::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
- }
- }
-
- /**
- * Gets master database connections for all of the ExternalStoreDB
- * stores configured in $wgDefaultExternalStore.
- *
- * @return Database[] Array of Database master connections
- */
- protected static function getExternalStoreDatabaseConnections() {
- global $wgDefaultExternalStore;
-
- /** @var ExternalStoreDB $externalStoreDB */
- $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;
- }
-
- /**
- * Check whether ExternalStoreDB is being used
- *
- * @return bool True if it's being used
- */
- 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;
- }
-
- /**
- * @throws LogicException if the given database connection is not a set up to use
- * mock tables.
- *
- * @since 1.31 this is no longer private.
- */
- protected function ensureMockDatabaseConnection( IDatabase $db ) {
- if ( $db->tablePrefix() !== $this->dbPrefix() ) {
- throw new LogicException(
- 'Trying to delete mock tables, but table prefix does not indicate a mock database.'
- );
- }
- }
-
- private static $schemaOverrideDefaults = [
- 'scripts' => [],
- 'create' => [],
- 'drop' => [],
- 'alter' => [],
- ];
-
- /**
- * Stub. If a test suite needs to test against a specific database schema, it should
- * override this method and return the appropriate information from it.
- *
- * 'create', 'drop' and 'alter' in the returned array should list all the tables affected
- * by the 'scripts', even if the test is only interested in a subset of them, otherwise
- * the overrides may not be fully cleaned up, leading to errors later.
- *
- * @param IMaintainableDatabase $db The DB connection to use for the mock schema.
- * May be used to check the current state of the schema, to determine what
- * overrides are needed.
- *
- * @return array An associative array with the following fields:
- * - 'scripts': any SQL scripts to run. If empty or not present, schema overrides are skipped.
- * - 'create': A list of tables created (may or may not exist in the original schema).
- * - 'drop': A list of tables dropped (expected to be present in the original schema).
- * - 'alter': A list of tables altered (expected to be present in the original schema).
- */
- protected function getSchemaOverrides( IMaintainableDatabase $db ) {
- return [];
- }
-
- /**
- * Undoes the specified schema overrides..
- * Called once per test class, just before addDataOnce().
- *
- * @param IMaintainableDatabase $db
- * @param array $oldOverrides
- */
- private function undoSchemaOverrides( IMaintainableDatabase $db, $oldOverrides ) {
- $this->ensureMockDatabaseConnection( $db );
-
- $oldOverrides = $oldOverrides + self::$schemaOverrideDefaults;
- $originalTables = $this->listOriginalTables( $db );
-
- // Drop tables that need to be restored or removed.
- $tablesToDrop = array_merge( $oldOverrides['create'], $oldOverrides['alter'] );
-
- // Restore tables that have been dropped or created or altered,
- // if they exist in the original schema.
- $tablesToRestore = array_merge( $tablesToDrop, $oldOverrides['drop'] );
- $tablesToRestore = array_intersect( $originalTables, $tablesToRestore );
-
- if ( $tablesToDrop ) {
- $this->dropMockTables( $db, $tablesToDrop );
- }
-
- if ( $tablesToRestore ) {
- $this->recloneMockTables( $db, $tablesToRestore );
-
- // Reset the restored tables, mainly for the side effect of
- // re-calling $this->addCoreDBData() if necessary.
- $this->resetDB( $db, $tablesToRestore );
- }
- }
-
- /**
- * Applies the schema overrides returned by getSchemaOverrides(),
- * after undoing any previously applied schema overrides.
- * Called once per test class, just before addDataOnce().
- */
- private function setUpSchema( IMaintainableDatabase $db ) {
- // Undo any active overrides.
- $oldOverrides = $db->_schemaOverrides ?? self::$schemaOverrideDefaults;
-
- if ( $oldOverrides['alter'] || $oldOverrides['create'] || $oldOverrides['drop'] ) {
- $this->undoSchemaOverrides( $db, $oldOverrides );
- unset( $db->_schemaOverrides );
- }
-
- // Determine new overrides.
- $overrides = $this->getSchemaOverrides( $db ) + self::$schemaOverrideDefaults;
-
- $extraKeys = array_diff(
- array_keys( $overrides ),
- array_keys( self::$schemaOverrideDefaults )
- );
-
- if ( $extraKeys ) {
- throw new InvalidArgumentException(
- 'Schema override contains extra keys: ' . var_export( $extraKeys, true )
- );
- }
-
- if ( !$overrides['scripts'] ) {
- // no scripts to run
- return;
- }
-
- if ( !$overrides['create'] && !$overrides['drop'] && !$overrides['alter'] ) {
- throw new InvalidArgumentException(
- 'Schema override scripts given, but no tables are declared to be '
- . 'created, dropped or altered.'
- );
- }
-
- $this->ensureMockDatabaseConnection( $db );
-
- // Drop the tables that will be created by the schema scripts.
- $originalTables = $this->listOriginalTables( $db );
- $tablesToDrop = array_intersect( $originalTables, $overrides['create'] );
-
- if ( $tablesToDrop ) {
- $this->dropMockTables( $db, $tablesToDrop );
- }
-
- // Run schema override scripts.
- foreach ( $overrides['scripts'] as $script ) {
- $db->sourceFile(
- $script,
- null,
- null,
- __METHOD__,
- function ( $cmd ) {
- return $this->mungeSchemaUpdateQuery( $cmd );
- }
- );
- }
-
- $db->_schemaOverrides = $overrides;
- }
-
- private function mungeSchemaUpdateQuery( $cmd ) {
- return self::$useTemporaryTables
- ? preg_replace( '/\bCREATE\s+TABLE\b/i', 'CREATE TEMPORARY TABLE', $cmd )
- : $cmd;
- }
-
- /**
- * Drops the given mock tables.
- *
- * @param IMaintainableDatabase $db
- * @param array $tables
- */
- private function dropMockTables( IMaintainableDatabase $db, array $tables ) {
- $this->ensureMockDatabaseConnection( $db );
-
- foreach ( $tables as $tbl ) {
- $tbl = $db->tableName( $tbl );
- $db->query( "DROP TABLE IF EXISTS $tbl", __METHOD__ );
- }
- }
-
- /**
- * Lists all tables in the live database schema, without a prefix.
- *
- * @param IMaintainableDatabase $db
- * @return array
- */
- private function listOriginalTables( IMaintainableDatabase $db ) {
- if ( !isset( $db->_originalTablePrefix ) ) {
- throw new LogicException( 'No original table prefix know, cannot list tables!' );
- }
-
- $originalTables = $db->listTables( $db->_originalTablePrefix, __METHOD__ );
-
- $unittestPrefixRegex = '/^' . preg_quote( $this->dbPrefix(), '/' ) . '/';
- $originalPrefixRegex = '/^' . preg_quote( $db->_originalTablePrefix, '/' ) . '/';
-
- $originalTables = array_filter(
- $originalTables,
- function ( $pt ) use ( $unittestPrefixRegex ) {
- return !preg_match( $unittestPrefixRegex, $pt );
- }
- );
-
- $originalTables = array_map(
- function ( $pt ) use ( $originalPrefixRegex ) {
- return preg_replace( $originalPrefixRegex, '', $pt );
- },
- $originalTables
- );
-
- return array_unique( $originalTables );
- }
-
- /**
- * Re-clones the given mock tables to restore them based on the live database schema.
- * The tables listed in $tables are expected to currently not exist, so dropMockTables()
- * should be called first.
- *
- * @param IMaintainableDatabase $db
- * @param array $tables
- */
- private function recloneMockTables( IMaintainableDatabase $db, array $tables ) {
- $this->ensureMockDatabaseConnection( $db );
-
- if ( !isset( $db->_originalTablePrefix ) ) {
- throw new LogicException( 'No original table prefix know, cannot restore tables!' );
- }
-
- $originalTables = $this->listOriginalTables( $db );
- $tables = array_intersect( $tables, $originalTables );
-
- $dbClone = new CloneDatabase( $db, $tables, $db->tablePrefix(), $db->_originalTablePrefix );
- $dbClone->useTemporaryTables( self::$useTemporaryTables );
-
- $dbClone->cloneTableStructure();
- }
-
- /**
- * Empty all tables so they can be repopulated for tests
- *
- * @param Database $db|null Database to reset
- * @param array $tablesUsed Tables to reset
- */
- private function resetDB( $db, $tablesUsed ) {
- if ( $db ) {
- $userTables = [ 'user', 'user_groups', 'user_properties', 'actor' ];
- $pageTables = [
- 'page', 'revision', 'ip_changes', 'revision_comment_temp', 'comment', 'archive',
- 'revision_actor_temp', 'slots', 'content', 'content_models', 'slot_roles',
- ];
- $coreDBDataTables = array_merge( $userTables, $pageTables );
-
- // If any of the user or page 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();
-
- // Reset $wgUser, which is probably 127.0.0.1, as its loaded data is probably not valid
- // @todo Should we start setting $wgUser to something nondeterministic
- // to encourage tests to be updated to not depend on it?
- global $wgUser;
- $wgUser->clearInstanceCache( $wgUser->mFrom );
- }
- if ( array_intersect( $tablesUsed, $pageTables ) ) {
- $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
- }
-
- // Postgres, Oracle, and MSSQL all use mwuser/pagecontent
- // instead of user/text. But Postgres does not remap the
- // table name in tableExists(), so we mark the real table
- // names as being used.
- if ( $db->getType() === 'postgres' ) {
- if ( in_array( 'user', $tablesUsed ) ) {
- $tablesUsed[] = 'mwuser';
- }
- if ( in_array( 'text', $tablesUsed ) ) {
- $tablesUsed[] = 'pagecontent';
- }
- }
-
- foreach ( $tablesUsed as $tbl ) {
- $this->truncateTable( $tbl, $db );
- }
-
- if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
- // Reset services that may contain information relating to the truncated tables
- $this->overrideMwServices();
- // Re-add core DB data that was deleted
- $this->addCoreDBData();
- }
- }
- }
-
- /**
- * Empties the given table and resets any auto-increment counters.
- * Will also purge caches associated with some well known tables.
- * If the table is not know, this method just returns.
- *
- * @param string $tableName
- * @param IDatabase|null $db
- */
- protected function truncateTable( $tableName, IDatabase $db = null ) {
- if ( !$db ) {
- $db = $this->db;
- }
-
- if ( !$db->tableExists( $tableName ) ) {
- return;
- }
-
- $truncate = in_array( $db->getType(), [ 'oracle', 'mysql' ] );
-
- if ( $truncate ) {
- $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tableName ), __METHOD__ );
- } else {
- $db->delete( $tableName, '*', __METHOD__ );
- }
-
- if ( $db instanceof DatabasePostgres || $db instanceof DatabaseSqlite ) {
- // Reset the table's sequence too.
- $db->resetSequenceForTable( $tableName, __METHOD__ );
- }
-
- // re-initialize site_stats table
- if ( $tableName === 'site_stats' ) {
- SiteStatsInit::doPlaceholderInit();
- }
- }
-
- private static function unprefixTable( &$tableName, $ind, $prefix ) {
- $tableName = substr( $tableName, strlen( $prefix ) );
- }
-
- private static function isNotUnittest( $table ) {
- return strpos( $table, self::DB_PREFIX ) !== 0;
- }
-
- /**
- * @since 1.18
- *
- * @param IMaintainableDatabase $db
- *
- * @return array
- */
- 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;
- }
-
- /**
- * Copy test data from one database connection to another.
- *
- * This should only be used for small data sets.
- *
- * @param IDatabase $source
- * @param IDatabase $target
- */
- public function copyTestData( IDatabase $source, IDatabase $target ) {
- if ( $this->db->getType() === 'sqlite' ) {
- // SQLite uses a non-temporary copy of the searchindex table for testing,
- // which gets deleted and re-created when setting up the secondary connection,
- // causing "Error 17" when trying to copy the data. See T191863#4130112.
- throw new RuntimeException(
- 'Setting up a secondary database connection with test data is currently not'
- . 'with SQLite. You may want to use markTestSkippedIfDbType() to bypass this issue.'
- );
- }
-
- $tables = self::listOriginalTables( $source );
-
- foreach ( $tables as $table ) {
- $res = $source->select( $table, '*', [], __METHOD__ );
- $allRows = [];
-
- foreach ( $res as $row ) {
- $allRows[] = (array)$row;
- }
-
- $target->insert( $table, $allRows, __METHOD__, [ 'IGNORE' ] );
- }
- }
-
- /**
- * @throws MWException
- * @since 1.18
- */
- protected function checkDbIsSupported() {
- if ( !in_array( $this->db->getType(), $this->supportedDBs ) ) {
- throw new MWException( $this->db->getType() . " is not currently supported for unit testing." );
- }
- }
-
- /**
- * @since 1.18
- * @param string $offset
- * @return mixed
- */
- public function getCliArg( $offset ) {
- return $this->cliArgs[$offset] ?? null;
- }
-
- /**
- * @since 1.18
- * @param string $offset
- * @param mixed $value
- */
- public function setCliArg( $offset, $value ) {
- $this->cliArgs[$offset] = $value;
- }
-
- /**
- * Don't throw a warning if $function is deprecated and called later
- *
- * @since 1.19
- *
- * @param string $function
- */
- public function hideDeprecated( $function ) {
- Wikimedia\suppressWarnings();
- wfDeprecated( $function );
- Wikimedia\restoreWarnings();
- }
-
- /**
- * Asserts that the given database query yields the rows given by $expectedRows.
- * The expected rows should be given as indexed (not associative) arrays, with
- * the values given in the order of the columns in the $fields parameter.
- * Note that the rows are sorted by the columns given in $fields.
- *
- * @since 1.20
- *
- * @param string|array $table The table(s) to query
- * @param string|array $fields The columns to include in the result (and to sort by)
- * @param string|array $condition "where" condition(s)
- * @param array $expectedRows An array of arrays giving the expected rows.
- * @param array $options Options for the query
- * @param array $join_conds Join conditions for the query
- *
- * @throws MWException If this test cases's needsDB() method doesn't return true.
- * Test cases can use "@group Database" to enable database test support,
- * or list the tables under testing in $this->tablesUsed, or override the
- * needsDB() method.
- */
- protected function assertSelect(
- $table, $fields, $condition, array $expectedRows, array $options = [], array $join_conds = []
- ) {
- 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_REPLICA );
-
- $res = $db->select(
- $table,
- $fields,
- $condition,
- wfGetCaller(),
- $options + [ 'ORDER BY' => $fields ],
- $join_conds
- );
- $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)" );
- }
-
- /**
- * Utility method taking an array of elements and wrapping
- * each element in its own array. Useful for data providers
- * that only return a single argument.
- *
- * @since 1.20
- *
- * @param array $elements
- *
- * @return array
- */
- protected function arrayWrap( array $elements ) {
- return array_map(
- function ( $element ) {
- return [ $element ];
- },
- $elements
- );
- }
-
- /**
- * Assert that two arrays are equal. By default this means that both arrays need to hold
- * the same set of values. Using additional arguments, order and associated key can also
- * be set as relevant.
- *
- * @since 1.20
- *
- * @param array $expected
- * @param array $actual
- * @param bool $ordered If the order of the values should match
- * @param bool $named If the keys should match
- */
- 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 ) )
- );
- }
-
- /**
- * Put each HTML element on its own line and then equals() the results
- *
- * Use for nicely formatting of PHPUnit diff output when comparing very
- * simple HTML
- *
- * @since 1.20
- *
- * @param string $expected HTML on oneline
- * @param string $actual HTML on oneline
- * @param string $msg Optional message
- */
- protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
- $expected = str_replace( '>', ">\n", $expected );
- $actual = str_replace( '>', ">\n", $actual );
-
- $this->assertEquals( $expected, $actual, $msg );
- }
-
- /**
- * Does an associative sort that works for objects.
- *
- * @since 1.20
- *
- * @param array &$array
- */
- protected function objectAssociativeSort( array &$array ) {
- uasort(
- $array,
- function ( $a, $b ) {
- return serialize( $a ) <=> serialize( $b );
- }
- );
- }
-
- /**
- * Utility function for eliminating all string keys from an array.
- * Useful to turn a database result row as returned by fetchRow() into
- * a pure indexed array.
- *
- * @since 1.20
- *
- * @param mixed &$r The array to remove string keys from.
- */
- protected static function stripStringKeys( &$r ) {
- if ( !is_array( $r ) ) {
- return;
- }
-
- foreach ( $r as $k => $v ) {
- if ( is_string( $k ) ) {
- unset( $r[$k] );
- }
- }
- }
-
- /**
- * Asserts that the provided variable is of the specified
- * internal type or equals the $value argument. This is useful
- * for testing return types of functions that return a certain
- * type or *value* when not set or on error.
- *
- * @since 1.20
- *
- * @param string $type
- * @param mixed $actual
- * @param mixed $value
- * @param string $message
- */
- protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
- if ( $actual === $value ) {
- $this->assertTrue( true, $message );
- } else {
- $this->assertType( $type, $actual, $message );
- }
- }
-
- /**
- * Asserts the type of the provided value. This can be either
- * in internal type such as boolean or integer, or a class or
- * interface the value extends or implements.
- *
- * @since 1.20
- *
- * @param string $type
- * @param mixed $actual
- * @param string $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 );
- }
- }
-
- /**
- * Returns true if the given namespace defaults to Wikitext
- * according to $wgNamespaceContentModels
- *
- * @param int $ns The namespace ID to check
- *
- * @return bool
- * @since 1.21
- */
- protected function isWikitextNS( $ns ) {
- global $wgNamespaceContentModels;
-
- if ( isset( $wgNamespaceContentModels[$ns] ) ) {
- return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT;
- }
-
- return true;
- }
-
- /**
- * Returns the ID of a namespace that defaults to Wikitext.
- *
- * @throws MWException If there is none.
- * @return int The ID of the wikitext Namespace
- * @since 1.21
- */
- 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
- $nsInfo = MediaWikiServices::getInstance()->getNamespaceInfo();
- $namespaces = array_unique( array_merge(
- $nsInfo->getContentNamespaces(),
- [ NS_MAIN, NS_HELP, NS_PROJECT ], // prefer these
- $nsInfo->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 ) use ( $nsInfo ) {
- return $nsInfo->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!" );
- }
-
- /**
- * Check, if $wgDiff3 is set and ready to merge
- * Will mark the calling test as skipped, if not ready
- *
- * @since 1.21
- */
- protected function markTestSkippedIfNoDiff3() {
- global $wgDiff3;
-
- # This check may also protect against code injection in
- # case of broken installations.
- Wikimedia\suppressWarnings();
- $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
- Wikimedia\restoreWarnings();
-
- if ( !$haveDiff3 ) {
- $this->markTestSkipped( "Skip test, since diff3 is not configured" );
- }
- }
-
- /**
- * Check if $extName is a loaded PHP extension, will skip the
- * test whenever it is not loaded.
- *
- * @since 1.21
- * @param string $extName
- * @return bool
- */
- protected function checkPHPExtension( $extName ) {
- $loaded = extension_loaded( $extName );
- if ( !$loaded ) {
- $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
- }
-
- return $loaded;
- }
-
- /**
- * Skip the test if using the specified database type
- *
- * @param string $type Database type
- * @since 1.32
- */
- protected function markTestSkippedIfDbType( $type ) {
- if ( $this->db->getType() === $type ) {
- $this->markTestSkipped( "The $type database type isn't supported for this test" );
- }
- }
-
- /**
- * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
- * @param string $buffer
- * @return string
- */
- public static function wfResetOutputBuffersBarrier( $buffer ) {
- return $buffer;
- }
-
- /**
- * Create a temporary hook handler which will be reset by tearDown.
- * This replaces other handlers for the same hook.
- * @param string $hookName Hook name
- * @param mixed $handler Value suitable for a hook handler
- * @since 1.28
- */
- protected function setTemporaryHook( $hookName, $handler ) {
- $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
- }
-
- /**
- * Check whether file contains given data.
- * @param string $fileName
- * @param string $actualData
- * @param bool $createIfMissing If true, and file does not exist, create it with given data
- * and skip the test.
- * @param string $msg
- * @since 1.30
- */
- protected function assertFileContains(
- $fileName,
- $actualData,
- $createIfMissing = false,
- $msg = ''
- ) {
- if ( $createIfMissing ) {
- if ( !file_exists( $fileName ) ) {
- file_put_contents( $fileName, $actualData );
- $this->markTestSkipped( "Data file $fileName does not exist" );
- }
- } else {
- self::assertFileExists( $fileName );
- }
- self::assertEquals( file_get_contents( $fileName ), $actualData, $msg );
- }
-
- /**
- * Edits or creates a page/revision
- * @param string $pageName Page title
- * @param string $text Content of the page
- * @param string $summary Optional summary string for the revision
- * @param int $defaultNs Optional namespace id
- * @param User|null $user If null, static::getTestSysop()->getUser() is used.
- * @return Status Object as returned by WikiPage::doEditContent()
- * @throws MWException If this test cases's needsDB() method doesn't return true.
- * Test cases can use "@group Database" to enable database test support,
- * or list the tables under testing in $this->tablesUsed, or override the
- * needsDB() method.
- */
- protected function editPage(
- $pageName,
- $text,
- $summary = '',
- $defaultNs = NS_MAIN,
- User $user = null
- ) {
- if ( !$this->needsDB() ) {
- throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
- ' method should return true. Use @group Database or $this->tablesUsed.' );
- }
-
- $title = Title::newFromText( $pageName, $defaultNs );
- $page = WikiPage::factory( $title );
-
- return $page->doEditContent(
- ContentHandler::makeContent( $text, $title ),
- $summary,
- 0,
- false,
- $user
- );
- }
-
- /**
- * Revision-deletes a revision.
- *
- * @param Revision|int $rev Revision to delete
- * @param array $value Keys are Revision::DELETED_* flags. Values are 1 to set the bit, 0 to
- * clear, -1 to leave alone. (All other values also clear the bit.)
- * @param string $comment Deletion comment
- */
- protected function revisionDelete(
- $rev, array $value = [ Revision::DELETED_TEXT => 1 ], $comment = ''
- ) {
- if ( is_int( $rev ) ) {
- $rev = Revision::newFromId( $rev );
- }
- RevisionDeleter::createList(
- 'revision', RequestContext::getMain(), $rev->getTitle(), [ $rev->getId() ]
- )->setVisibility( [
- 'value' => $value,
- 'comment' => $comment,
- ] );
- }
-
- /**
- * Returns a PHPUnit constraint that matches anything other than a fixed set of values. This can
- * be used to whitelist values, e.g.
- * $mock->expects( $this->never() )->method( $this->anythingBut( 'foo', 'bar' ) );
- * which will throw if any unexpected method is called.
- *
- * @param mixed ...$values Values that are not matched
- */
- protected function anythingBut( ...$values ) {
- return $this->logicalNot( $this->logicalOr(
- ...array_map( [ $this, 'matches' ], $values )
- ) );
- }
-}
<?php
/**
- * Base class for MediaWiki unit tests.
- *
* 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
use PHPUnit\Framework\TestCase;
+/**
+ * Base class for unit tests.
+ *
+ * Extend this class if you are testing classes which use dependency injection and do not access
+ * global functions, variables, services or a storage backend.
+ */
abstract class MediaWikiUnitTestCase extends TestCase {
use PHPUnit4And6Compat;
use MediaWikiCoversValidator;
--- /dev/null
+<?php
+/**
+ * Bootstrapping for MediaWiki PHPUnit tests when called via the maintenance class tests runner.
+ * This file is included by phpunit and is NOT in the global scope.
+ *
+ * @file
+ */
+
+if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
+ echo <<<EOF
+You are running these tests directly from phpunit. You may not have all globals correctly set.
+Running phpunit.php instead is recommended.
+EOF;
+ require_once __DIR__ . "/phpunit.php";
+}
+
+// The PHPUnit_TextUI_TestRunner class will run each test suite and may call
+// exit() with an exit status code. As such, we cannot run code "after the last test"
+// by adding statements to PHPUnitMaintClass::execute or MediaWikiPHPUnitCommand::run.
+// Instead, we work around it by registering a shutdown callback from the bootstrap
+// file, which runs before PHPUnit starts.
+// @todo Once we use PHPUnit 8 or higher, use the 'AfterLastTestHook' feature.
+// https://phpunit.readthedocs.io/en/8.0/extending-phpunit.html#available-hook-interfaces
+register_shutdown_function( function () {
+ // This will:
+ // - clear the temporary job queue.
+ // - allow extensions to delete any temporary tables they created.
+ // - restore ability to connect to the real database,
+ // (for logging profiling data).
+ MediaWikiTestCase::teardownTestDB();
+
+ // Log profiling data, e.g. in the database or UDP
+ wfLogProfilingData();
+} );
<?php
+
/**
- * Bootstrapping for MediaWiki PHPUnit tests
- * This file is included by phpunit and is NOT in the global scope.
+ * PHPUnit bootstrap file.
+ *
+ * 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
+ * @ingroup Testing
+ */
+
+if ( PHP_SAPI !== 'cli' ) {
+ die( 'This file is only meant to be executed indirectly by PHPUnit\'s bootstrap process!' );
+}
+
+/**
+ * PHPUnit includes the bootstrap file inside a method body, while most MediaWiki startup files
+ * assume to be included in the global scope.
+ * This utility provides a way to include these files: it makes all globals available in the
+ * inclusion scope before including the file, then exports all new or changed globals.
+ *
+ * @param string $fileName the file to include
*/
+function wfRequireOnceInGlobalScope( $fileName ) {
+ // phpcs:disable MediaWiki.Usage.ForbiddenFunctions.extract
+ extract( $GLOBALS, EXTR_REFS | EXTR_SKIP );
+ // phpcs:enable
-if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
- echo <<<EOF
-You are running these tests directly from phpunit. You may not have all globals correctly set.
-Running phpunit.php instead is recommended.
-EOF;
- require_once __DIR__ . "/phpunit.php";
+ require_once $fileName;
+
+ foreach ( get_defined_vars() as $varName => $value ) {
+ $GLOBALS[$varName] = $value;
+ }
}
-// The PHPUnit_TextUI_TestRunner class will run each test suite and may call
-// exit() with an exit status code. As such, we cannot run code "after the last test"
-// by adding statements to PHPUnitMaintClass::execute or MediaWikiPHPUnitCommand::run.
-// Instead, we work around it by registering a shutdown callback from the bootstrap
-// file, which runs before PHPUnit starts.
-// @todo Once we use PHPUnit 8 or higher, use the 'AfterLastTestHook' feature.
-// https://phpunit.readthedocs.io/en/8.0/extending-phpunit.html#available-hook-interfaces
-register_shutdown_function( function () {
- // This will:
- // - clear the temporary job queue.
- // - allow extensions to delete any temporary tables they created.
- // - restore ability to connect to the real database,
- // (for logging profiling data).
- MediaWikiTestCase::teardownTestDB();
-
- // Log profiling data, e.g. in the database or UDP
- wfLogProfilingData();
-} );
+define( 'MEDIAWIKI', true );
+define( 'MW_PHPUNIT_TEST', true );
+
+// We don't use a settings file here but some code still assumes that one exists
+define( 'MW_CONFIG_FILE', 'LocalSettings.php' );
+
+$IP = realpath( __DIR__ . '/../../' );
+
+// these variables must be defined before setup runs
+$GLOBALS['IP'] = $IP;
+// Faking for Setup.php
+$GLOBALS['wgScopeTest'] = 'MediaWiki Setup.php scope test';
+$GLOBALS['wgCommandLineMode'] = true;
+$GLOBALS['wgAutoloadClasses'] = [];
+
+require_once "$IP/tests/common/TestSetup.php";
+
+wfRequireOnceInGlobalScope( "$IP/includes/AutoLoader.php" );
+wfRequireOnceInGlobalScope( "$IP/tests/common/TestsAutoLoader.php" );
+++ /dev/null
-<?php
-
-use Psr\Log\NullLogger;
-use Wikimedia\Rdbms\Blob;
-use Wikimedia\Rdbms\Database;
-use Wikimedia\Rdbms\DatabaseSqlite;
-use Wikimedia\Rdbms\ResultWrapper;
-use Wikimedia\Rdbms\TransactionProfiler;
-use Wikimedia\TestingAccessWrapper;
-
-/**
- * @group sqlite
- * @group Database
- * @group medium
- */
-class DatabaseSqliteTest extends MediaWikiTestCase {
- /** @var DatabaseSqlite */
- protected $db;
-
- protected function setUp() {
- parent::setUp();
-
- if ( !Sqlite::isPresent() ) {
- $this->markTestSkipped( 'No SQLite support detected' );
- }
- $this->db = $this->getMockBuilder( DatabaseSqlite::class )
- ->setConstructorArgs( [ [
- 'dbFilePath' => ':memory:',
- 'schema' => false,
- 'host' => false,
- 'user' => false,
- 'password' => false,
- 'tablePrefix' => '',
- 'cliMode' => true,
- 'agent' => 'unit-tests',
- 'flags' => DBO_DEFAULT,
- 'variables' => [],
- 'profiler' => null,
- 'trxProfiler' => new TransactionProfiler(),
- 'connLogger' => new NullLogger(),
- 'queryLogger' => new NullLogger(),
- 'errorLogger' => null,
- 'deprecationLogger' => null,
- ] ] )->setMethods( [ 'query' ] )
- ->getMock();
- $this->db->initConnection();
- $this->db->method( 'query' )->willReturn( true );
- if ( version_compare( $this->db->getServerVersion(), '3.6.0', '<' ) ) {
- $this->markTestSkipped( "SQLite at least 3.6 required, {$this->db->getServerVersion()} found" );
- }
- }
-
- /**
- * @param $sql
- * @return string|string[]|null
- */
- private function replaceVars( $sql ) {
- $wrapper = TestingAccessWrapper::newFromObject( $this->db );
- // normalize spacing to hide implementation details
- return preg_replace( '/\s+/', ' ', $wrapper->replaceVars( $sql ) );
- }
-
- private function assertResultIs( $expected, $res ) {
- $this->assertNotNull( $res );
- $i = 0;
- foreach ( $res as $row ) {
- foreach ( $expected[$i] as $key => $value ) {
- $this->assertTrue( isset( $row->$key ) );
- $this->assertEquals( $value, $row->$key );
- }
- $i++;
- }
- $this->assertEquals( count( $expected ), $i, 'Unexpected number of rows' );
- }
-
- public static function provideAddQuotes() {
- return [
- [ // #0: empty
- '', "''"
- ],
- [ // #1: simple
- 'foo bar', "'foo bar'"
- ],
- [ // #2: including quote
- 'foo\'bar', "'foo''bar'"
- ],
- // #3: including \0 (must be represented as hex, per https://bugs.php.net/bug.php?id=63419)
- [
- "x\0y",
- "x'780079'",
- ],
- [ // #4: blob object (must be represented as hex)
- new Blob( "hello" ),
- "x'68656c6c6f'",
- ],
- [ // #5: null
- null,
- "''",
- ],
- ];
- }
-
- /**
- * @dataProvider provideAddQuotes()
- * @covers DatabaseSqlite::addQuotes
- */
- public function testAddQuotes( $value, $expected ) {
- // check quoting
- $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
- $this->assertEquals( $expected, $db->addQuotes( $value ), 'string not quoted as expected' );
-
- // ok, quoting works as expected, now try a round trip.
- $re = $db->query( 'select ' . $db->addQuotes( $value ) );
-
- $this->assertTrue( $re !== false, 'query failed' );
-
- $row = $re->fetchRow();
- if ( $row ) {
- if ( $value instanceof Blob ) {
- $value = $value->fetch();
- }
-
- $this->assertEquals( $value, $row[0], 'string mangled by the database' );
- } else {
- $this->fail( 'query returned no result' );
- }
- }
-
- /**
- * @covers DatabaseSqlite::replaceVars
- */
- public function testReplaceVars() {
- $this->assertEquals( 'foo', $this->replaceVars( 'foo' ), "Don't break anything accidentally" );
-
- $this->assertEquals(
- "CREATE TABLE /**/foo (foo_key INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT, "
- . "foo_bar TEXT, foo_name TEXT NOT NULL DEFAULT '', foo_int INTEGER, foo_int2 INTEGER );",
- $this->replaceVars(
- "CREATE TABLE /**/foo (foo_key int unsigned NOT NULL PRIMARY KEY AUTO_INCREMENT, "
- . "foo_bar char(13), foo_name varchar(255) binary NOT NULL DEFAULT '', "
- . "foo_int tinyint ( 8 ), foo_int2 int(16) ) ENGINE=MyISAM;"
- )
- );
-
- $this->assertEquals(
- "CREATE TABLE foo ( foo1 REAL, foo2 REAL, foo3 REAL );",
- $this->replaceVars(
- "CREATE TABLE foo ( foo1 FLOAT, foo2 DOUBLE( 1,10), foo3 DOUBLE PRECISION );"
- )
- );
-
- $this->assertEquals( "CREATE TABLE foo ( foo_binary1 BLOB, foo_binary2 BLOB );",
- $this->replaceVars( "CREATE TABLE foo ( foo_binary1 binary(16), foo_binary2 varbinary(32) );" )
- );
-
- $this->assertEquals( "CREATE TABLE text ( text_foo TEXT );",
- $this->replaceVars( "CREATE TABLE text ( text_foo tinytext );" ),
- 'Table name changed'
- );
-
- $this->assertEquals( "CREATE TABLE foo ( foobar INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL );",
- $this->replaceVars( "CREATE TABLE foo ( foobar INT PRIMARY KEY NOT NULL AUTO_INCREMENT );" )
- );
- $this->assertEquals( "CREATE TABLE foo ( foobar INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL );",
- $this->replaceVars( "CREATE TABLE foo ( foobar INT PRIMARY KEY AUTO_INCREMENT NOT NULL );" )
- );
-
- $this->assertEquals( "CREATE TABLE enums( enum1 TEXT, myenum TEXT)",
- $this->replaceVars( "CREATE TABLE enums( enum1 ENUM('A', 'B'), myenum ENUM ('X', 'Y'))" )
- );
-
- $this->assertEquals( "ALTER TABLE foo ADD COLUMN foo_bar INTEGER DEFAULT 42",
- $this->replaceVars( "ALTER TABLE foo\nADD COLUMN foo_bar int(10) unsigned DEFAULT 42" )
- );
-
- $this->assertEquals( "DROP INDEX foo",
- $this->replaceVars( "DROP INDEX /*i*/foo ON /*_*/bar" )
- );
-
- $this->assertEquals( "DROP INDEX foo -- dropping index",
- $this->replaceVars( "DROP INDEX /*i*/foo ON /*_*/bar -- dropping index" )
- );
- $this->assertEquals( "INSERT OR IGNORE INTO foo VALUES ('bar')",
- $this->replaceVars( "INSERT OR IGNORE INTO foo VALUES ('bar')" )
- );
- }
-
- /**
- * @covers DatabaseSqlite::tableName
- */
- public function testTableName() {
- // @todo Moar!
- $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
- $this->assertEquals( 'foo', $db->tableName( 'foo' ) );
- $this->assertEquals( 'sqlite_master', $db->tableName( 'sqlite_master' ) );
- $db->tablePrefix( 'foo_' );
- $this->assertEquals( 'sqlite_master', $db->tableName( 'sqlite_master' ) );
- $this->assertEquals( 'foo_bar', $db->tableName( 'bar' ) );
- }
-
- /**
- * @covers DatabaseSqlite::duplicateTableStructure
- */
- public function testDuplicateTableStructure() {
- $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
- $db->query( 'CREATE TABLE foo(foo, barfoo)' );
- $db->query( 'CREATE INDEX index1 ON foo(foo)' );
- $db->query( 'CREATE UNIQUE INDEX index2 ON foo(barfoo)' );
-
- $db->duplicateTableStructure( 'foo', 'bar' );
- $this->assertEquals( 'CREATE TABLE "bar"(foo, barfoo)',
- $db->selectField( 'sqlite_master', 'sql', [ 'name' => 'bar' ] ),
- 'Normal table duplication'
- );
- $indexList = $db->query( 'PRAGMA INDEX_LIST("bar")' );
- $index = $indexList->next();
- $this->assertEquals( 'bar_index1', $index->name );
- $this->assertEquals( '0', $index->unique );
- $index = $indexList->next();
- $this->assertEquals( 'bar_index2', $index->name );
- $this->assertEquals( '1', $index->unique );
-
- $db->duplicateTableStructure( 'foo', 'baz', true );
- $this->assertEquals( 'CREATE TABLE "baz"(foo, barfoo)',
- $db->selectField( 'sqlite_temp_master', 'sql', [ 'name' => 'baz' ] ),
- 'Creation of temporary duplicate'
- );
- $indexList = $db->query( 'PRAGMA INDEX_LIST("baz")' );
- $index = $indexList->next();
- $this->assertEquals( 'baz_index1', $index->name );
- $this->assertEquals( '0', $index->unique );
- $index = $indexList->next();
- $this->assertEquals( 'baz_index2', $index->name );
- $this->assertEquals( '1', $index->unique );
- $this->assertEquals( 0,
- $db->selectField( 'sqlite_master', 'COUNT(*)', [ 'name' => 'baz' ] ),
- 'Create a temporary duplicate only'
- );
- }
-
- /**
- * @covers DatabaseSqlite::duplicateTableStructure
- */
- public function testDuplicateTableStructureVirtual() {
- $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
- if ( $db->getFulltextSearchModule() != 'FTS3' ) {
- $this->markTestSkipped( 'FTS3 not supported, cannot create virtual tables' );
- }
- $db->query( 'CREATE VIRTUAL TABLE "foo" USING FTS3(foobar)' );
-
- $db->duplicateTableStructure( 'foo', 'bar' );
- $this->assertEquals( 'CREATE VIRTUAL TABLE "bar" USING FTS3(foobar)',
- $db->selectField( 'sqlite_master', 'sql', [ 'name' => 'bar' ] ),
- 'Duplication of virtual tables'
- );
-
- $db->duplicateTableStructure( 'foo', 'baz', true );
- $this->assertEquals( 'CREATE VIRTUAL TABLE "baz" USING FTS3(foobar)',
- $db->selectField( 'sqlite_master', 'sql', [ 'name' => 'baz' ] ),
- "Can't create temporary virtual tables, should fall back to non-temporary duplication"
- );
- }
-
- /**
- * @covers DatabaseSqlite::deleteJoin
- */
- public function testDeleteJoin() {
- $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
- $db->query( 'CREATE TABLE a (a_1)', __METHOD__ );
- $db->query( 'CREATE TABLE b (b_1, b_2)', __METHOD__ );
- $db->insert( 'a', [
- [ 'a_1' => 1 ],
- [ 'a_1' => 2 ],
- [ 'a_1' => 3 ],
- ],
- __METHOD__
- );
- $db->insert( 'b', [
- [ 'b_1' => 2, 'b_2' => 'a' ],
- [ 'b_1' => 3, 'b_2' => 'b' ],
- ],
- __METHOD__
- );
- $db->deleteJoin( 'a', 'b', 'a_1', 'b_1', [ 'b_2' => 'a' ], __METHOD__ );
- $res = $db->query( "SELECT * FROM a", __METHOD__ );
- $this->assertResultIs( [
- [ 'a_1' => 1 ],
- [ 'a_1' => 3 ],
- ],
- $res
- );
- }
-
- /**
- * @coversNothing
- */
- public function testEntireSchema() {
- global $IP;
-
- $result = Sqlite::checkSqlSyntax( "$IP/maintenance/tables.sql" );
- if ( $result !== true ) {
- $this->fail( $result );
- }
- $this->assertTrue( true ); // avoid test being marked as incomplete due to lack of assertions
- }
-
- /**
- * Runs upgrades of older databases and compares results with current schema
- * @todo Currently only checks list of tables
- * @coversNothing
- */
- public function testUpgrades() {
- global $IP, $wgVersion, $wgProfiler;
-
- // Versions tested
- $versions = [
- // '1.13', disabled for now, was totally screwed up
- // SQLite wasn't included in 1.14
- '1.15',
- '1.16',
- '1.17',
- '1.18',
- '1.19',
- '1.20',
- '1.21',
- '1.22',
- '1.23',
- ];
-
- // Mismatches for these columns we can safely ignore
- $ignoredColumns = [
- 'user_newtalk.user_last_timestamp', // r84185
- ];
-
- $currentDB = DatabaseSqlite::newStandaloneInstance( ':memory:' );
- $currentDB->sourceFile( "$IP/maintenance/tables.sql" );
-
- $profileToDb = false;
- if ( isset( $wgProfiler['output'] ) ) {
- $out = $wgProfiler['output'];
- if ( $out === 'db' ) {
- $profileToDb = true;
- } elseif ( is_array( $out ) && in_array( 'db', $out ) ) {
- $profileToDb = true;
- }
- }
-
- if ( $profileToDb ) {
- $currentDB->sourceFile( "$IP/maintenance/sqlite/archives/patch-profiling.sql" );
- }
- $currentTables = $this->getTables( $currentDB );
- sort( $currentTables );
-
- foreach ( $versions as $version ) {
- $versions = "upgrading from $version to $wgVersion";
- $db = $this->prepareTestDB( $version );
- $tables = $this->getTables( $db );
- $this->assertEquals( $currentTables, $tables, "Different tables $versions" );
- foreach ( $tables as $table ) {
- $currentCols = $this->getColumns( $currentDB, $table );
- $cols = $this->getColumns( $db, $table );
- $this->assertEquals(
- array_keys( $currentCols ),
- array_keys( $cols ),
- "Mismatching columns for table \"$table\" $versions"
- );
- foreach ( $currentCols as $name => $column ) {
- $fullName = "$table.$name";
- $this->assertEquals(
- (bool)$column->pk,
- (bool)$cols[$name]->pk,
- "PRIMARY KEY status does not match for column $fullName $versions"
- );
- if ( !in_array( $fullName, $ignoredColumns ) ) {
- $this->assertEquals(
- (bool)$column->notnull,
- (bool)$cols[$name]->notnull,
- "NOT NULL status does not match for column $fullName $versions"
- );
- $this->assertEquals(
- $column->dflt_value,
- $cols[$name]->dflt_value,
- "Default values does not match for column $fullName $versions"
- );
- }
- }
- $currentIndexes = $this->getIndexes( $currentDB, $table );
- $indexes = $this->getIndexes( $db, $table );
- $this->assertEquals(
- array_keys( $currentIndexes ),
- array_keys( $indexes ),
- "mismatching indexes for table \"$table\" $versions"
- );
- }
- $db->close();
- }
- }
-
- /**
- * @covers DatabaseSqlite::insertId
- */
- public function testInsertIdType() {
- $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
-
- $databaseCreation = $db->query( 'CREATE TABLE a ( a_1 )', __METHOD__ );
- $this->assertInstanceOf( ResultWrapper::class, $databaseCreation, "Database creation" );
-
- $insertion = $db->insert( 'a', [ 'a_1' => 10 ], __METHOD__ );
- $this->assertTrue( $insertion, "Insertion worked" );
-
- $this->assertInternalType( 'integer', $db->insertId(), "Actual typecheck" );
- $this->assertTrue( $db->close(), "closing database" );
- }
-
- /**
- * @covers DatabaseSqlite::insert
- */
- public function testInsertAffectedRows() {
- $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
- $db->query( 'CREATE TABLE testInsertAffectedRows ( foo )', __METHOD__ );
-
- $insertion = $db->insert(
- 'testInsertAffectedRows',
- [
- [ 'foo' => 10 ],
- [ 'foo' => 12 ],
- [ 'foo' => 1555 ],
- ],
- __METHOD__
- );
- $this->assertTrue( $insertion, "Insertion worked" );
-
- $this->assertSame( 3, $db->affectedRows() );
- $this->assertTrue( $db->close(), "closing database" );
- }
-
- private function prepareTestDB( $version ) {
- static $maint = null;
- if ( $maint === null ) {
- $maint = new FakeMaintenance();
- $maint->loadParamsAndArgs( null, [ 'quiet' => 1 ] );
- }
-
- global $IP;
- $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
- $db->sourceFile( "$IP/tests/phpunit/data/db/sqlite/tables-$version.sql" );
- $updater = DatabaseUpdater::newForDB( $db, false, $maint );
- $updater->doUpdates( [ 'core' ] );
-
- return $db;
- }
-
- private function getTables( $db ) {
- $list = array_flip( $db->listTables() );
- $excluded = [
- 'external_user', // removed from core in 1.22
- 'math', // moved out of core in 1.18
- 'trackbacks', // removed from core in 1.19
- 'searchindex',
- 'searchindex_content',
- 'searchindex_segments',
- 'searchindex_segdir',
- // FTS4 ready!!1
- 'searchindex_docsize',
- 'searchindex_stat',
- ];
- foreach ( $excluded as $t ) {
- unset( $list[$t] );
- }
- $list = array_flip( $list );
- sort( $list );
-
- return $list;
- }
-
- private function getColumns( $db, $table ) {
- $cols = [];
- $res = $db->query( "PRAGMA table_info($table)" );
- $this->assertNotNull( $res );
- foreach ( $res as $col ) {
- $cols[$col->name] = $col;
- }
- ksort( $cols );
-
- return $cols;
- }
-
- private function getIndexes( $db, $table ) {
- $indexes = [];
- $res = $db->query( "PRAGMA index_list($table)" );
- $this->assertNotNull( $res );
- foreach ( $res as $index ) {
- $res2 = $db->query( "PRAGMA index_info({$index->name})" );
- $this->assertNotNull( $res2 );
- $index->columns = [];
- foreach ( $res2 as $col ) {
- $index->columns[] = $col;
- }
- $indexes[$index->name] = $index;
- }
- ksort( $indexes );
-
- return $indexes;
- }
-
- /**
- * @coversNothing
- */
- public function testCaseInsensitiveLike() {
- // TODO: Test this for all databases
- $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
- $res = $db->query( 'SELECT "a" LIKE "A" AS a' );
- $row = $res->fetchRow();
- $this->assertFalse( (bool)$row['a'] );
- }
-
- /**
- * @covers DatabaseSqlite::numFields
- */
- public function testNumFields() {
- $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
-
- $databaseCreation = $db->query( 'CREATE TABLE a ( a_1 )', __METHOD__ );
- $this->assertInstanceOf( ResultWrapper::class, $databaseCreation, "Failed to create table a" );
- $res = $db->select( 'a', '*' );
- $this->assertEquals( 0, $db->numFields( $res ), "expects to get 0 fields for an empty table" );
- $insertion = $db->insert( 'a', [ 'a_1' => 10 ], __METHOD__ );
- $this->assertTrue( $insertion, "Insertion failed" );
- $res = $db->select( 'a', '*' );
- $this->assertEquals( 1, $db->numFields( $res ), "wrong number of fields" );
-
- $this->assertTrue( $db->close(), "closing database" );
- }
-
- /**
- * @covers \Wikimedia\Rdbms\DatabaseSqlite::__toString
- */
- public function testToString() {
- $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
-
- $toString = (string)$db;
-
- $this->assertContains( 'sqlite object', $toString );
- }
-
- /**
- * @covers \Wikimedia\Rdbms\DatabaseSqlite::getAttributes()
- */
- public function testsAttributes() {
- $attributes = Database::attributesFromType( 'sqlite' );
- $this->assertTrue( $attributes[Database::ATTR_DB_LEVEL_LOCKING] );
- }
-}
--- /dev/null
+<?php
+
+use Psr\Log\NullLogger;
+use Wikimedia\Rdbms\Blob;
+use Wikimedia\Rdbms\Database;
+use Wikimedia\Rdbms\DatabaseSqlite;
+use Wikimedia\Rdbms\ResultWrapper;
+use Wikimedia\Rdbms\TransactionProfiler;
+use Wikimedia\TestingAccessWrapper;
+
+/**
+ * @group sqlite
+ * @group Database
+ * @group medium
+ */
+class DatabaseSqliteTest extends \MediaWikiIntegrationTestCase {
+ /** @var DatabaseSqlite */
+ protected $db;
+
+ protected function setUp() {
+ parent::setUp();
+
+ if ( !Sqlite::isPresent() ) {
+ $this->markTestSkipped( 'No SQLite support detected' );
+ }
+ $this->db = $this->getMockBuilder( DatabaseSqlite::class )
+ ->setConstructorArgs( [ [
+ 'dbFilePath' => ':memory:',
+ 'schema' => false,
+ 'host' => false,
+ 'user' => false,
+ 'password' => false,
+ 'tablePrefix' => '',
+ 'cliMode' => true,
+ 'agent' => 'unit-tests',
+ 'flags' => DBO_DEFAULT,
+ 'variables' => [],
+ 'profiler' => null,
+ 'trxProfiler' => new TransactionProfiler(),
+ 'connLogger' => new NullLogger(),
+ 'queryLogger' => new NullLogger(),
+ 'errorLogger' => null,
+ 'deprecationLogger' => null,
+ ] ] )->setMethods( [ 'query' ] )
+ ->getMock();
+ $this->db->initConnection();
+ $this->db->method( 'query' )->willReturn( true );
+ if ( version_compare( $this->db->getServerVersion(), '3.6.0', '<' ) ) {
+ $this->markTestSkipped( "SQLite at least 3.6 required, {$this->db->getServerVersion()} found" );
+ }
+ }
+
+ /**
+ * @param $sql
+ * @return string|string[]|null
+ */
+ private function replaceVars( $sql ) {
+ $wrapper = TestingAccessWrapper::newFromObject( $this->db );
+ // normalize spacing to hide implementation details
+ return preg_replace( '/\s+/', ' ', $wrapper->replaceVars( $sql ) );
+ }
+
+ private function assertResultIs( $expected, $res ) {
+ $this->assertNotNull( $res );
+ $i = 0;
+ foreach ( $res as $row ) {
+ foreach ( $expected[$i] as $key => $value ) {
+ $this->assertTrue( isset( $row->$key ) );
+ $this->assertEquals( $value, $row->$key );
+ }
+ $i++;
+ }
+ $this->assertEquals( count( $expected ), $i, 'Unexpected number of rows' );
+ }
+
+ public static function provideAddQuotes() {
+ return [
+ [ // #0: empty
+ '', "''"
+ ],
+ [ // #1: simple
+ 'foo bar', "'foo bar'"
+ ],
+ [ // #2: including quote
+ 'foo\'bar', "'foo''bar'"
+ ],
+ // #3: including \0 (must be represented as hex, per https://bugs.php.net/bug.php?id=63419)
+ [
+ "x\0y",
+ "x'780079'",
+ ],
+ [ // #4: blob object (must be represented as hex)
+ new Blob( "hello" ),
+ "x'68656c6c6f'",
+ ],
+ [ // #5: null
+ null,
+ "''",
+ ],
+ ];
+ }
+
+ /**
+ * @dataProvider provideAddQuotes()
+ * @covers DatabaseSqlite::addQuotes
+ */
+ public function testAddQuotes( $value, $expected ) {
+ // check quoting
+ $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
+ $this->assertEquals( $expected, $db->addQuotes( $value ), 'string not quoted as expected' );
+
+ // ok, quoting works as expected, now try a round trip.
+ $re = $db->query( 'select ' . $db->addQuotes( $value ) );
+
+ $this->assertTrue( $re !== false, 'query failed' );
+
+ $row = $re->fetchRow();
+ if ( $row ) {
+ if ( $value instanceof Blob ) {
+ $value = $value->fetch();
+ }
+
+ $this->assertEquals( $value, $row[0], 'string mangled by the database' );
+ } else {
+ $this->fail( 'query returned no result' );
+ }
+ }
+
+ /**
+ * @covers DatabaseSqlite::replaceVars
+ */
+ public function testReplaceVars() {
+ $this->assertEquals( 'foo', $this->replaceVars( 'foo' ), "Don't break anything accidentally" );
+
+ $this->assertEquals(
+ "CREATE TABLE /**/foo (foo_key INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT, "
+ . "foo_bar TEXT, foo_name TEXT NOT NULL DEFAULT '', foo_int INTEGER, foo_int2 INTEGER );",
+ $this->replaceVars(
+ "CREATE TABLE /**/foo (foo_key int unsigned NOT NULL PRIMARY KEY AUTO_INCREMENT, "
+ . "foo_bar char(13), foo_name varchar(255) binary NOT NULL DEFAULT '', "
+ . "foo_int tinyint ( 8 ), foo_int2 int(16) ) ENGINE=MyISAM;"
+ )
+ );
+
+ $this->assertEquals(
+ "CREATE TABLE foo ( foo1 REAL, foo2 REAL, foo3 REAL );",
+ $this->replaceVars(
+ "CREATE TABLE foo ( foo1 FLOAT, foo2 DOUBLE( 1,10), foo3 DOUBLE PRECISION );"
+ )
+ );
+
+ $this->assertEquals( "CREATE TABLE foo ( foo_binary1 BLOB, foo_binary2 BLOB );",
+ $this->replaceVars( "CREATE TABLE foo ( foo_binary1 binary(16), foo_binary2 varbinary(32) );" )
+ );
+
+ $this->assertEquals( "CREATE TABLE text ( text_foo TEXT );",
+ $this->replaceVars( "CREATE TABLE text ( text_foo tinytext );" ),
+ 'Table name changed'
+ );
+
+ $this->assertEquals( "CREATE TABLE foo ( foobar INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL );",
+ $this->replaceVars( "CREATE TABLE foo ( foobar INT PRIMARY KEY NOT NULL AUTO_INCREMENT );" )
+ );
+ $this->assertEquals( "CREATE TABLE foo ( foobar INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL );",
+ $this->replaceVars( "CREATE TABLE foo ( foobar INT PRIMARY KEY AUTO_INCREMENT NOT NULL );" )
+ );
+
+ $this->assertEquals( "CREATE TABLE enums( enum1 TEXT, myenum TEXT)",
+ $this->replaceVars( "CREATE TABLE enums( enum1 ENUM('A', 'B'), myenum ENUM ('X', 'Y'))" )
+ );
+
+ $this->assertEquals( "ALTER TABLE foo ADD COLUMN foo_bar INTEGER DEFAULT 42",
+ $this->replaceVars( "ALTER TABLE foo\nADD COLUMN foo_bar int(10) unsigned DEFAULT 42" )
+ );
+
+ $this->assertEquals( "DROP INDEX foo",
+ $this->replaceVars( "DROP INDEX /*i*/foo ON /*_*/bar" )
+ );
+
+ $this->assertEquals( "DROP INDEX foo -- dropping index",
+ $this->replaceVars( "DROP INDEX /*i*/foo ON /*_*/bar -- dropping index" )
+ );
+ $this->assertEquals( "INSERT OR IGNORE INTO foo VALUES ('bar')",
+ $this->replaceVars( "INSERT OR IGNORE INTO foo VALUES ('bar')" )
+ );
+ }
+
+ /**
+ * @covers DatabaseSqlite::tableName
+ */
+ public function testTableName() {
+ // @todo Moar!
+ $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
+ $this->assertEquals( 'foo', $db->tableName( 'foo' ) );
+ $this->assertEquals( 'sqlite_master', $db->tableName( 'sqlite_master' ) );
+ $db->tablePrefix( 'foo_' );
+ $this->assertEquals( 'sqlite_master', $db->tableName( 'sqlite_master' ) );
+ $this->assertEquals( 'foo_bar', $db->tableName( 'bar' ) );
+ }
+
+ /**
+ * @covers DatabaseSqlite::duplicateTableStructure
+ */
+ public function testDuplicateTableStructure() {
+ $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
+ $db->query( 'CREATE TABLE foo(foo, barfoo)' );
+ $db->query( 'CREATE INDEX index1 ON foo(foo)' );
+ $db->query( 'CREATE UNIQUE INDEX index2 ON foo(barfoo)' );
+
+ $db->duplicateTableStructure( 'foo', 'bar' );
+ $this->assertEquals( 'CREATE TABLE "bar"(foo, barfoo)',
+ $db->selectField( 'sqlite_master', 'sql', [ 'name' => 'bar' ] ),
+ 'Normal table duplication'
+ );
+ $indexList = $db->query( 'PRAGMA INDEX_LIST("bar")' );
+ $index = $indexList->next();
+ $this->assertEquals( 'bar_index1', $index->name );
+ $this->assertEquals( '0', $index->unique );
+ $index = $indexList->next();
+ $this->assertEquals( 'bar_index2', $index->name );
+ $this->assertEquals( '1', $index->unique );
+
+ $db->duplicateTableStructure( 'foo', 'baz', true );
+ $this->assertEquals( 'CREATE TABLE "baz"(foo, barfoo)',
+ $db->selectField( 'sqlite_temp_master', 'sql', [ 'name' => 'baz' ] ),
+ 'Creation of temporary duplicate'
+ );
+ $indexList = $db->query( 'PRAGMA INDEX_LIST("baz")' );
+ $index = $indexList->next();
+ $this->assertEquals( 'baz_index1', $index->name );
+ $this->assertEquals( '0', $index->unique );
+ $index = $indexList->next();
+ $this->assertEquals( 'baz_index2', $index->name );
+ $this->assertEquals( '1', $index->unique );
+ $this->assertEquals( 0,
+ $db->selectField( 'sqlite_master', 'COUNT(*)', [ 'name' => 'baz' ] ),
+ 'Create a temporary duplicate only'
+ );
+ }
+
+ /**
+ * @covers DatabaseSqlite::duplicateTableStructure
+ */
+ public function testDuplicateTableStructureVirtual() {
+ $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
+ if ( $db->getFulltextSearchModule() != 'FTS3' ) {
+ $this->markTestSkipped( 'FTS3 not supported, cannot create virtual tables' );
+ }
+ $db->query( 'CREATE VIRTUAL TABLE "foo" USING FTS3(foobar)' );
+
+ $db->duplicateTableStructure( 'foo', 'bar' );
+ $this->assertEquals( 'CREATE VIRTUAL TABLE "bar" USING FTS3(foobar)',
+ $db->selectField( 'sqlite_master', 'sql', [ 'name' => 'bar' ] ),
+ 'Duplication of virtual tables'
+ );
+
+ $db->duplicateTableStructure( 'foo', 'baz', true );
+ $this->assertEquals( 'CREATE VIRTUAL TABLE "baz" USING FTS3(foobar)',
+ $db->selectField( 'sqlite_master', 'sql', [ 'name' => 'baz' ] ),
+ "Can't create temporary virtual tables, should fall back to non-temporary duplication"
+ );
+ }
+
+ /**
+ * @covers DatabaseSqlite::deleteJoin
+ */
+ public function testDeleteJoin() {
+ $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
+ $db->query( 'CREATE TABLE a (a_1)', __METHOD__ );
+ $db->query( 'CREATE TABLE b (b_1, b_2)', __METHOD__ );
+ $db->insert( 'a', [
+ [ 'a_1' => 1 ],
+ [ 'a_1' => 2 ],
+ [ 'a_1' => 3 ],
+ ],
+ __METHOD__
+ );
+ $db->insert( 'b', [
+ [ 'b_1' => 2, 'b_2' => 'a' ],
+ [ 'b_1' => 3, 'b_2' => 'b' ],
+ ],
+ __METHOD__
+ );
+ $db->deleteJoin( 'a', 'b', 'a_1', 'b_1', [ 'b_2' => 'a' ], __METHOD__ );
+ $res = $db->query( "SELECT * FROM a", __METHOD__ );
+ $this->assertResultIs( [
+ [ 'a_1' => 1 ],
+ [ 'a_1' => 3 ],
+ ],
+ $res
+ );
+ }
+
+ /**
+ * @coversNothing
+ */
+ public function testEntireSchema() {
+ global $IP;
+
+ $result = Sqlite::checkSqlSyntax( "$IP/maintenance/tables.sql" );
+ if ( $result !== true ) {
+ $this->fail( $result );
+ }
+ $this->assertTrue( true ); // avoid test being marked as incomplete due to lack of assertions
+ }
+
+ /**
+ * Runs upgrades of older databases and compares results with current schema
+ * @todo Currently only checks list of tables
+ * @coversNothing
+ */
+ public function testUpgrades() {
+ global $IP, $wgVersion, $wgProfiler;
+
+ // Versions tested
+ $versions = [
+ // '1.13', disabled for now, was totally screwed up
+ // SQLite wasn't included in 1.14
+ '1.15',
+ '1.16',
+ '1.17',
+ '1.18',
+ '1.19',
+ '1.20',
+ '1.21',
+ '1.22',
+ '1.23',
+ ];
+
+ // Mismatches for these columns we can safely ignore
+ $ignoredColumns = [
+ 'user_newtalk.user_last_timestamp', // r84185
+ ];
+
+ $currentDB = DatabaseSqlite::newStandaloneInstance( ':memory:' );
+ $currentDB->sourceFile( "$IP/maintenance/tables.sql" );
+
+ $profileToDb = false;
+ if ( isset( $wgProfiler['output'] ) ) {
+ $out = $wgProfiler['output'];
+ if ( $out === 'db' ) {
+ $profileToDb = true;
+ } elseif ( is_array( $out ) && in_array( 'db', $out ) ) {
+ $profileToDb = true;
+ }
+ }
+
+ if ( $profileToDb ) {
+ $currentDB->sourceFile( "$IP/maintenance/sqlite/archives/patch-profiling.sql" );
+ }
+ $currentTables = $this->getTables( $currentDB );
+ sort( $currentTables );
+
+ foreach ( $versions as $version ) {
+ $versions = "upgrading from $version to $wgVersion";
+ $db = $this->prepareTestDB( $version );
+ $tables = $this->getTables( $db );
+ $this->assertEquals( $currentTables, $tables, "Different tables $versions" );
+ foreach ( $tables as $table ) {
+ $currentCols = $this->getColumns( $currentDB, $table );
+ $cols = $this->getColumns( $db, $table );
+ $this->assertEquals(
+ array_keys( $currentCols ),
+ array_keys( $cols ),
+ "Mismatching columns for table \"$table\" $versions"
+ );
+ foreach ( $currentCols as $name => $column ) {
+ $fullName = "$table.$name";
+ $this->assertEquals(
+ (bool)$column->pk,
+ (bool)$cols[$name]->pk,
+ "PRIMARY KEY status does not match for column $fullName $versions"
+ );
+ if ( !in_array( $fullName, $ignoredColumns ) ) {
+ $this->assertEquals(
+ (bool)$column->notnull,
+ (bool)$cols[$name]->notnull,
+ "NOT NULL status does not match for column $fullName $versions"
+ );
+ $this->assertEquals(
+ $column->dflt_value,
+ $cols[$name]->dflt_value,
+ "Default values does not match for column $fullName $versions"
+ );
+ }
+ }
+ $currentIndexes = $this->getIndexes( $currentDB, $table );
+ $indexes = $this->getIndexes( $db, $table );
+ $this->assertEquals(
+ array_keys( $currentIndexes ),
+ array_keys( $indexes ),
+ "mismatching indexes for table \"$table\" $versions"
+ );
+ }
+ $db->close();
+ }
+ }
+
+ /**
+ * @covers DatabaseSqlite::insertId
+ */
+ public function testInsertIdType() {
+ $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
+
+ $databaseCreation = $db->query( 'CREATE TABLE a ( a_1 )', __METHOD__ );
+ $this->assertInstanceOf( ResultWrapper::class, $databaseCreation, "Database creation" );
+
+ $insertion = $db->insert( 'a', [ 'a_1' => 10 ], __METHOD__ );
+ $this->assertTrue( $insertion, "Insertion worked" );
+
+ $this->assertInternalType( 'integer', $db->insertId(), "Actual typecheck" );
+ $this->assertTrue( $db->close(), "closing database" );
+ }
+
+ /**
+ * @covers DatabaseSqlite::insert
+ */
+ public function testInsertAffectedRows() {
+ $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
+ $db->query( 'CREATE TABLE testInsertAffectedRows ( foo )', __METHOD__ );
+
+ $insertion = $db->insert(
+ 'testInsertAffectedRows',
+ [
+ [ 'foo' => 10 ],
+ [ 'foo' => 12 ],
+ [ 'foo' => 1555 ],
+ ],
+ __METHOD__
+ );
+ $this->assertTrue( $insertion, "Insertion worked" );
+
+ $this->assertSame( 3, $db->affectedRows() );
+ $this->assertTrue( $db->close(), "closing database" );
+ }
+
+ private function prepareTestDB( $version ) {
+ static $maint = null;
+ if ( $maint === null ) {
+ $maint = new FakeMaintenance();
+ $maint->loadParamsAndArgs( null, [ 'quiet' => 1 ] );
+ }
+
+ global $IP;
+ $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
+ $db->sourceFile( "$IP/tests/phpunit/data/db/sqlite/tables-$version.sql" );
+ $updater = DatabaseUpdater::newForDB( $db, false, $maint );
+ $updater->doUpdates( [ 'core' ] );
+
+ return $db;
+ }
+
+ private function getTables( $db ) {
+ $list = array_flip( $db->listTables() );
+ $excluded = [
+ 'external_user', // removed from core in 1.22
+ 'math', // moved out of core in 1.18
+ 'trackbacks', // removed from core in 1.19
+ 'searchindex',
+ 'searchindex_content',
+ 'searchindex_segments',
+ 'searchindex_segdir',
+ // FTS4 ready!!1
+ 'searchindex_docsize',
+ 'searchindex_stat',
+ ];
+ foreach ( $excluded as $t ) {
+ unset( $list[$t] );
+ }
+ $list = array_flip( $list );
+ sort( $list );
+
+ return $list;
+ }
+
+ private function getColumns( $db, $table ) {
+ $cols = [];
+ $res = $db->query( "PRAGMA table_info($table)" );
+ $this->assertNotNull( $res );
+ foreach ( $res as $col ) {
+ $cols[$col->name] = $col;
+ }
+ ksort( $cols );
+
+ return $cols;
+ }
+
+ private function getIndexes( $db, $table ) {
+ $indexes = [];
+ $res = $db->query( "PRAGMA index_list($table)" );
+ $this->assertNotNull( $res );
+ foreach ( $res as $index ) {
+ $res2 = $db->query( "PRAGMA index_info({$index->name})" );
+ $this->assertNotNull( $res2 );
+ $index->columns = [];
+ foreach ( $res2 as $col ) {
+ $index->columns[] = $col;
+ }
+ $indexes[$index->name] = $index;
+ }
+ ksort( $indexes );
+
+ return $indexes;
+ }
+
+ /**
+ * @coversNothing
+ */
+ public function testCaseInsensitiveLike() {
+ // TODO: Test this for all databases
+ $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
+ $res = $db->query( 'SELECT "a" LIKE "A" AS a' );
+ $row = $res->fetchRow();
+ $this->assertFalse( (bool)$row['a'] );
+ }
+
+ /**
+ * @covers DatabaseSqlite::numFields
+ */
+ public function testNumFields() {
+ $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
+
+ $databaseCreation = $db->query( 'CREATE TABLE a ( a_1 )', __METHOD__ );
+ $this->assertInstanceOf( ResultWrapper::class, $databaseCreation, "Failed to create table a" );
+ $res = $db->select( 'a', '*' );
+ $this->assertEquals( 0, $db->numFields( $res ), "expects to get 0 fields for an empty table" );
+ $insertion = $db->insert( 'a', [ 'a_1' => 10 ], __METHOD__ );
+ $this->assertTrue( $insertion, "Insertion failed" );
+ $res = $db->select( 'a', '*' );
+ $this->assertEquals( 1, $db->numFields( $res ), "wrong number of fields" );
+
+ $this->assertTrue( $db->close(), "closing database" );
+ }
+
+ /**
+ * @covers \Wikimedia\Rdbms\DatabaseSqlite::__toString
+ */
+ public function testToString() {
+ $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
+
+ $toString = (string)$db;
+
+ $this->assertContains( 'sqlite object', $toString );
+ }
+
+ /**
+ * @covers \Wikimedia\Rdbms\DatabaseSqlite::getAttributes()
+ */
+ public function testsAttributes() {
+ $attributes = Database::attributesFromType( 'sqlite' );
+ $this->assertTrue( $attributes[Database::ATTR_DB_LEVEL_LOCKING] );
+ }
+}
<?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./bootstrap.php"
+<phpunit bootstrap="./bootstrap.maintenance.php"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.8/phpunit.xsd"
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="unit/initUnitTests.php"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.8/phpunit.xsd"
-
- colors="true"
- backupGlobals="false"
- convertErrorsToExceptions="true"
- convertNoticesToExceptions="true"
- convertWarningsToExceptions="true"
- forceCoversAnnotation="true"
- stopOnFailure="false"
- timeoutForSmallTests="10"
- timeoutForMediumTests="30"
- timeoutForLargeTests="60"
- beStrictAboutTestsThatDoNotTestAnything="true"
- beStrictAboutOutputDuringTests="true"
- beStrictAboutTestSize="true"
- verbose="false">
- <testsuites>
- <testsuite name="tests">
- <directory>unit</directory>
- </testsuite>
- </testsuites>
- <groups>
- <exclude>
- <group>Broken</group>
- </exclude>
- </groups>
- <filter>
- <whitelist addUncoveredFilesFromWhitelist="true">
- <directory suffix=".php">../../includes</directory>
- <directory suffix=".php">../../languages</directory>
- <directory suffix=".php">../../maintenance</directory>
- <exclude>
- <directory suffix=".php">../../languages/messages</directory>
- <file>../../languages/data/normalize-ar.php</file>
- <file>../../languages/data/normalize-ml.php</file>
- </exclude>
- </whitelist>
- </filter>
-</phpunit>
+++ /dev/null
-<?php
-/**
- * PHPUnit bootstrap file for the unit test suite.
- *
- * 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
- * @ingroup Testing
- */
-
-if ( PHP_SAPI !== 'cli' ) {
- die( 'This file is only meant to be executed indirectly by PHPUnit\'s bootstrap process!' );
-}
-
-/**
- * PHPUnit includes the bootstrap file inside a method body, while most MediaWiki startup files
- * assume to be included in the global scope.
- * This utility provides a way to include these files: it makes all globals available in the
- * inclusion scope before including the file, then exports all new or changed globals.
- *
- * @param string $fileName the file to include
- */
-function wfRequireOnceInGlobalScope( $fileName ) {
- // phpcs:disable MediaWiki.Usage.ForbiddenFunctions.extract
- extract( $GLOBALS, EXTR_REFS | EXTR_SKIP );
- // phpcs:enable
-
- require_once $fileName;
-
- foreach ( get_defined_vars() as $varName => $value ) {
- $GLOBALS[$varName] = $value;
- }
-}
-
-define( 'MEDIAWIKI', true );
-define( 'MW_PHPUNIT_TEST', true );
-
-// We don't use a settings file here but some code still assumes that one exists
-define( 'MW_CONFIG_FILE', 'LocalSettings.php' );
-
-$IP = realpath( __DIR__ . '/../../..' );
-
-// these variables must be defined before setup runs
-$GLOBALS['IP'] = $IP;
-$GLOBALS['wgCommandLineMode'] = true;
-
-require_once "$IP/tests/common/TestSetup.php";
-
-wfRequireOnceInGlobalScope( "$IP/includes/AutoLoader.php" );
-wfRequireOnceInGlobalScope( "$IP/includes/Defines.php" );
-wfRequireOnceInGlobalScope( "$IP/includes/DefaultSettings.php" );
-wfRequireOnceInGlobalScope( "$IP/includes/GlobalFunctions.php" );
-
-require_once "$IP/tests/common/TestsAutoLoader.php";
-
-TestSetup::applyInitialConfig();
dépôts / lhc / web / wiklou.git / commitdiff