3 use MediaWiki\Logger\LegacySpi
;
4 use MediaWiki\Logger\LoggerFactory
;
5 use MediaWiki\Logger\MonologSpi
;
6 use MediaWiki\Logger\LogCapturingSpi
;
7 use MediaWiki\MediaWikiServices
;
8 use Psr\Log\LoggerInterface
;
9 use Wikimedia\Rdbms\IDatabase
;
10 use Wikimedia\Rdbms\IMaintainableDatabase
;
11 use Wikimedia\Rdbms\Database
;
12 use Wikimedia\TestingAccessWrapper
;
17 * Extend this class if you are testing classes which access global variables, methods, services
18 * or a storage backend.
20 * Consider using MediaWikiUnitTestCase and mocking dependencies if your code uses dependency
21 * injection and does not access any globals.
23 abstract class MediaWikiIntegrationTestCase
extends PHPUnit\Framework\TestCase
{
25 use MediaWikiCoversValidator
;
26 use PHPUnit4And6Compat
;
27 use MediaWikiGroupValidator
;
30 * The original service locator. This is overridden during setUp().
32 * @var MediaWikiServices|null
34 private static $originalServices;
37 * The local service locator, created during setUp().
38 * @var MediaWikiServices
40 private $localServices;
43 * $called tracks whether the setUp and tearDown method has been called.
44 * class extending MediaWikiTestCase usually override setUp and tearDown
45 * but forget to call the parent.
47 * The array format takes a method name as key and anything as a value.
48 * By asserting the key exist, we know the child class has called the
51 * This property must be private, we do not want child to override it,
52 * they should call the appropriate parent method instead.
74 protected $tablesUsed = []; // tables with data
76 private static $useTemporaryTables = true;
77 private static $reuseDB = false;
78 private static $dbSetup = false;
79 private static $oldTablePrefix = '';
82 * Original value of PHP's error_reporting setting.
86 private $phpErrorLevel;
89 * Holds the paths of temporary files/directories created through getNewTempFile,
90 * and getNewTempDirectory
94 private $tmpFiles = [];
97 * Holds original values of MediaWiki configuration settings
98 * to be restored in tearDown().
99 * See also setMwGlobals().
102 private $mwGlobals = [];
105 * Holds list of MediaWiki configuration settings to be unset in tearDown().
106 * See also setMwGlobals().
109 private $mwGlobalsToUnset = [];
112 * Holds original values of ini settings to be restored
114 * @see setIniSettings()
117 private $iniSettings = [];
120 * Holds original loggers which have been replaced by setLogger()
121 * @var LoggerInterface[]
123 private $loggers = [];
126 * The CLI arguments passed through from phpunit.php
129 private $cliArgs = [];
132 * Holds a list of services that were overridden with setService(). Used for printing an error
133 * if overrideMwServices() overrides a service that was previously set.
136 private $overriddenServices = [];
139 * Table name prefixes. Oracle likes it shorter.
141 const DB_PREFIX
= 'unittest_';
142 const ORA_DB_PREFIX
= 'ut_';
148 protected $supportedDBs = [
155 public function __construct( $name = null, array $data = [], $dataName = '' ) {
156 parent
::__construct( $name, $data, $dataName );
158 $this->backupGlobals
= false;
159 $this->backupStaticAttributes
= false;
162 public function __destruct() {
163 // Complain if self::setUp() was called, but not self::tearDown()
164 // $this->called['setUp'] will be checked by self::testMediaWikiTestCaseParentSetupCalled()
165 if ( isset( $this->called
['setUp'] ) && !isset( $this->called
['tearDown'] ) ) {
166 throw new MWException( static::class . "::tearDown() must call parent::tearDown()" );
170 private static function initializeForStandardPhpunitEntrypointIfNeeded() {
171 if ( function_exists( 'wfRequireOnceInGlobalScope' ) ) {
172 $IP = realpath( __DIR__
. '/../..' );
173 wfRequireOnceInGlobalScope( "$IP/includes/Defines.php" );
174 wfRequireOnceInGlobalScope( "$IP/includes/DefaultSettings.php" );
175 wfRequireOnceInGlobalScope( "$IP/includes/GlobalFunctions.php" );
176 wfRequireOnceInGlobalScope( "$IP/includes/Setup.php" );
177 wfRequireOnceInGlobalScope( "$IP/tests/common/TestsAutoLoader.php" );
178 TestSetup
::applyInitialConfig();
182 public static function setUpBeforeClass() {
184 parent
::setUpBeforeClass();
185 if ( !file_exists( "$IP/LocalSettings.php" ) ) {
186 echo 'A working MediaWiki installation with a configured LocalSettings.php file is'
187 . ' required for tests that extend ' . self
::class;
190 self
::initializeForStandardPhpunitEntrypointIfNeeded();
192 // Get the original service locator
193 if ( !self
::$originalServices ) {
194 self
::$originalServices = MediaWikiServices
::getInstance();
199 * Convenience method for getting an immutable test user
203 * @param string|string[] $groups Groups the test user should be in.
206 public static function getTestUser( $groups = [] ) {
207 return TestUserRegistry
::getImmutableTestUser( $groups );
211 * Convenience method for getting a mutable test user
215 * @param string|string[] $groups Groups the test user should be added in.
218 public static function getMutableTestUser( $groups = [] ) {
219 return TestUserRegistry
::getMutableTestUser( __CLASS__
, $groups );
223 * Convenience method for getting an immutable admin test user
227 * @param string[] $groups Groups the test user should be added to.
230 public static function getTestSysop() {
231 return self
::getTestUser( [ 'sysop', 'bureaucrat' ] );
235 * Returns a WikiPage representing an existing page.
239 * @param Title|string|null $title
241 * @throws MWException If this test cases's needsDB() method doesn't return true.
242 * Test cases can use "@group Database" to enable database test support,
243 * or list the tables under testing in $this->tablesUsed, or override the
246 protected function getExistingTestPage( $title = null ) {
247 if ( !$this->needsDB() ) {
248 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
249 ' method should return true. Use @group Database or $this->tablesUsed.' );
252 $title = ( $title === null ) ?
'UTPage' : $title;
253 $title = is_string( $title ) ? Title
::newFromText( $title ) : $title;
254 $page = WikiPage
::factory( $title );
256 if ( !$page->exists() ) {
257 $user = self
::getTestSysop()->getUser();
258 $page->doEditContent(
259 new WikitextContent( 'UTContent' ),
261 EDIT_NEW | EDIT_SUPPRESS_RC
,
271 * Returns a WikiPage representing a non-existing page.
275 * @param Title|string|null $title
277 * @throws MWException If this test cases's needsDB() method doesn't return true.
278 * Test cases can use "@group Database" to enable database test support,
279 * or list the tables under testing in $this->tablesUsed, or override the
282 protected function getNonexistingTestPage( $title = null ) {
283 if ( !$this->needsDB() ) {
284 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
285 ' method should return true. Use @group Database or $this->tablesUsed.' );
288 $title = ( $title === null ) ?
'UTPage-' . rand( 0, 100000 ) : $title;
289 $title = is_string( $title ) ? Title
::newFromText( $title ) : $title;
290 $page = WikiPage
::factory( $title );
292 if ( $page->exists() ) {
293 $page->doDeleteArticle( 'Testing' );
300 * @deprecated since 1.32
302 public static function prepareServices( Config
$bootstrapConfig ) {
306 * Create a config suitable for testing, based on a base config, default overrides,
307 * and custom overrides.
309 * @param Config|null $baseConfig
310 * @param Config|null $customOverrides
314 private static function makeTestConfig(
315 Config
$baseConfig = null,
316 Config
$customOverrides = null
318 $defaultOverrides = new HashConfig();
320 if ( !$baseConfig ) {
321 $baseConfig = self
::$originalServices->getBootstrapConfig();
324 /* Some functions require some kind of caching, and will end up using the db,
325 * which we can't allow, as that would open a new connection for mysql.
326 * Replace with a HashBag. They would not be going to persist anyway.
328 $hashCache = [ 'class' => HashBagOStuff
::class, 'reportDupes' => false ];
330 CACHE_DB
=> $hashCache,
331 CACHE_ACCEL
=> $hashCache,
332 CACHE_MEMCACHED
=> $hashCache,
334 'apcu' => $hashCache,
335 'wincache' => $hashCache,
336 ] +
$baseConfig->get( 'ObjectCaches' );
338 $defaultOverrides->set( 'ObjectCaches', $objectCaches );
339 $defaultOverrides->set( 'MainCacheType', CACHE_NONE
);
340 $defaultOverrides->set( 'JobTypeConf', [ 'default' => [ 'class' => JobQueueMemory
::class ] ] );
342 // Use a fast hash algorithm to hash passwords.
343 $defaultOverrides->set( 'PasswordDefault', 'A' );
345 $testConfig = $customOverrides
346 ?
new MultiConfig( [ $customOverrides, $defaultOverrides, $baseConfig ] )
347 : new MultiConfig( [ $defaultOverrides, $baseConfig ] );
353 * @param ConfigFactory $oldFactory
354 * @param Config[] $configurations
358 private static function makeTestConfigFactoryInstantiator(
359 ConfigFactory
$oldFactory,
360 array $configurations
362 return function ( MediaWikiServices
$services ) use ( $oldFactory, $configurations ) {
363 $factory = new ConfigFactory();
365 // clone configurations from $oldFactory that are not overwritten by $configurations
366 $namesToClone = array_diff(
367 $oldFactory->getConfigNames(),
368 array_keys( $configurations )
371 foreach ( $namesToClone as $name ) {
372 $factory->register( $name, $oldFactory->makeConfig( $name ) );
375 foreach ( $configurations as $name => $config ) {
376 $factory->register( $name, $config );
384 * Resets some non-service singleton instances and other static caches. It's not necessary to
385 * reset services here.
387 public static function resetNonServiceCaches() {
388 global $wgRequest, $wgJobClasses;
390 User
::resetGetDefaultOptionsForTestsOnly();
391 foreach ( $wgJobClasses as $type => $class ) {
392 JobQueueGroup
::singleton()->get( $type )->delete();
394 JobQueueGroup
::destroySingletons();
396 ObjectCache
::clear();
397 FileBackendGroup
::destroySingleton();
398 DeferredUpdates
::clearPendingUpdates();
400 // TODO: move global state into MediaWikiServices
401 RequestContext
::resetMain();
402 if ( session_id() !== '' ) {
403 session_write_close();
407 $wgRequest = new FauxRequest();
408 MediaWiki\Session\SessionManager
::resetCache();
411 public function run( PHPUnit_Framework_TestResult
$result = null ) {
412 if ( $result instanceof MediaWikiTestResult
) {
413 $this->cliArgs
= $result->getMediaWikiCliArgs();
415 $this->overrideMwServices();
417 if ( $this->needsDB() && !$this->isTestInDatabaseGroup() ) {
419 get_class( $this ) . ' apparently needsDB but is not in the Database group'
423 $needsResetDB = false;
424 if ( !self
::$dbSetup ||
$this->needsDB() ) {
425 // set up a DB connection for this test to use
427 self
::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
428 self
::$reuseDB = $this->getCliArg( 'reuse-db' );
430 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
431 $this->db
= $lb->getConnection( DB_MASTER
);
433 $this->checkDbIsSupported();
435 if ( !self
::$dbSetup ) {
436 $this->setupAllTestDBs();
437 $this->addCoreDBData();
440 // TODO: the DB setup should be done in setUpBeforeClass(), so the test DB
441 // is available in subclass's setUpBeforeClass() and setUp() methods.
442 // This would also remove the need for the HACK that is oncePerClass().
443 if ( $this->oncePerClass() ) {
444 $this->setUpSchema( $this->db
);
445 $this->resetDB( $this->db
, $this->tablesUsed
);
446 $this->addDBDataOnce();
450 $needsResetDB = true;
453 parent
::run( $result );
455 // We don't mind if we override already-overridden services during cleanup
456 $this->overriddenServices
= [];
458 if ( $needsResetDB ) {
459 $this->resetDB( $this->db
, $this->tablesUsed
);
462 self
::restoreMwServices();
463 $this->localServices
= null;
469 private function oncePerClass() {
470 // Remember current test class in the database connection,
471 // so we know when we need to run addData.
473 $class = static::class;
475 $first = !isset( $this->db
->_hasDataForTestClass
)
476 ||
$this->db
->_hasDataForTestClass
!== $class;
478 $this->db
->_hasDataForTestClass
= $class;
487 public function usesTemporaryTables() {
488 return self
::$useTemporaryTables;
492 * Obtains a new temporary file name
494 * The obtained filename is enlisted to be removed upon tearDown
498 * @return string Absolute name of the temporary file
500 protected function getNewTempFile() {
503 // Avoid backslashes here as they result in inconsistent results
504 // between Windows and other OS, as well as between functions
505 // that try to normalise these in one or both directions.
506 // For example, tempnam rejects directory separators in the prefix which
507 // means it rejects any namespaced class on Windows.
508 // And then there is, wfMkdirParents which normalises paths always
509 // whereas most other PHP and MW functions do not.
510 'MW_PHPUnit_' . strtr( static::class, [ '\\' => '_' ] ) . '_'
512 $this->tmpFiles
[] = $fileName;
518 * obtains a new temporary directory
520 * The obtained directory is enlisted to be removed (recursively with all its contained
521 * files) upon tearDown.
525 * @return string Absolute name of the temporary directory
527 protected function getNewTempDirectory() {
528 // Starting of with a temporary *file*.
529 $fileName = $this->getNewTempFile();
531 // Converting the temporary file to a *directory*.
532 // The following is not atomic, but at least we now have a single place,
533 // where temporary directory creation is bundled and can be improved.
535 // If this fails for some reason, PHP will warn and fail the test.
536 mkdir( $fileName, 0777, /* recursive = */ true );
541 protected function setUp() {
543 $this->called
['setUp'] = true;
545 $this->phpErrorLevel
= intval( ini_get( 'error_reporting' ) );
547 $this->overriddenServices
= [];
549 // Cleaning up temporary files
550 foreach ( $this->tmpFiles
as $fileName ) {
551 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
553 } elseif ( is_dir( $fileName ) ) {
554 wfRecursiveRemoveDir( $fileName );
558 if ( $this->needsDB() && $this->db
) {
559 // Clean up open transactions
560 while ( $this->db
->trxLevel() > 0 ) {
561 $this->db
->rollback( __METHOD__
, 'flush' );
563 // Check for unsafe queries
564 if ( $this->db
->getType() === 'mysql' ) {
565 $this->db
->query( "SET sql_mode = 'STRICT_ALL_TABLES'", __METHOD__
);
569 // Reset all caches between tests.
570 self
::resetNonServiceCaches();
572 // XXX: reset maintenance triggers
573 // Hook into period lag checks which often happen in long-running scripts
574 $lbFactory = $this->localServices
->getDBLoadBalancerFactory();
575 Maintenance
::setLBFactoryTriggers( $lbFactory, $this->localServices
->getMainConfig() );
577 ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
580 protected function addTmpFiles( $files ) {
581 $this->tmpFiles
= array_merge( $this->tmpFiles
, (array)$files );
584 // @todo Make const when we no longer support HHVM (T192166)
585 private static $namespaceAffectingSettings = [
586 'wgAllowImageMoving',
587 'wgCanonicalNamespaceNames',
588 'wgCapitalLinkOverrides',
590 'wgContentNamespaces',
591 'wgExtensionMessagesFiles',
592 'wgExtensionNamespaces',
594 'wgExtraSignatureNamespaces',
595 'wgNamespaceContentModels',
596 'wgNamespaceProtection',
597 'wgNamespacesWithSubpages',
598 'wgNonincludableNamespaces',
599 'wgRestrictionLevels',
602 protected function tearDown() {
603 global $wgRequest, $wgSQLMode;
605 $status = ob_get_status();
606 if ( isset( $status['name'] ) &&
607 $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier'
612 $this->called
['tearDown'] = true;
613 // Cleaning up temporary files
614 foreach ( $this->tmpFiles
as $fileName ) {
615 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
617 } elseif ( is_dir( $fileName ) ) {
618 wfRecursiveRemoveDir( $fileName );
622 if ( $this->needsDB() && $this->db
) {
623 // Clean up open transactions
624 while ( $this->db
->trxLevel() > 0 ) {
625 $this->db
->rollback( __METHOD__
, 'flush' );
627 if ( $this->db
->getType() === 'mysql' ) {
628 $this->db
->query( "SET sql_mode = " . $this->db
->addQuotes( $wgSQLMode ),
633 // Re-enable any disabled deprecation warnings
635 // Restore mw globals
636 foreach ( $this->mwGlobals
as $key => $value ) {
637 $GLOBALS[$key] = $value;
639 foreach ( $this->mwGlobalsToUnset
as $value ) {
640 unset( $GLOBALS[$value] );
642 foreach ( $this->iniSettings
as $name => $value ) {
643 ini_set( $name, $value );
646 array_intersect( self
::$namespaceAffectingSettings, array_keys( $this->mwGlobals
) ) ||
647 array_intersect( self
::$namespaceAffectingSettings, $this->mwGlobalsToUnset
)
649 $this->resetNamespaces();
651 $this->mwGlobals
= [];
652 $this->mwGlobalsToUnset
= [];
653 $this->restoreLoggers();
655 // TODO: move global state into MediaWikiServices
656 RequestContext
::resetMain();
657 if ( session_id() !== '' ) {
658 session_write_close();
661 $wgRequest = new FauxRequest();
662 MediaWiki\Session\SessionManager
::resetCache();
663 MediaWiki\Auth\AuthManager
::resetCache();
665 $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
667 if ( $phpErrorLevel !== $this->phpErrorLevel
) {
668 ini_set( 'error_reporting', $this->phpErrorLevel
);
670 $oldHex = strtoupper( dechex( $this->phpErrorLevel
) );
671 $newHex = strtoupper( dechex( $phpErrorLevel ) );
672 $message = "PHP error_reporting setting was left dirty: "
673 . "was 0x$oldHex before test, 0x$newHex after test!";
675 $this->fail( $message );
682 * Make sure MediaWikiTestCase extending classes have called their
683 * parent setUp method
685 * With strict coverage activated in PHP_CodeCoverage, this test would be
686 * marked as risky without the following annotation (T152923).
689 final public function testMediaWikiTestCaseParentSetupCalled() {
690 $this->assertArrayHasKey( 'setUp', $this->called
,
691 static::class . '::setUp() must call parent::setUp()'
696 * Sets a service, maintaining a stashed version of the previous service to be
697 * restored in tearDown.
699 * @note Tests must not call overrideMwServices() after calling setService(), since that would
700 * lose the new service instance. Since 1.34, resetServices() can be used instead, which
701 * would reset other services, but retain any services set using setService().
702 * This means that once a service is set using this method, it cannot be reverted to
703 * the original service within the same test method. The original service is restored
704 * in tearDown after the test method has terminated.
706 * @param string $name
707 * @param object $service The service instance, or a callable that returns the service instance.
712 protected function setService( $name, $service ) {
713 if ( !$this->localServices
) {
714 throw new Exception( __METHOD__
. ' must be called after MediaWikiTestCase::run()' );
717 if ( $this->localServices
!== MediaWikiServices
::getInstance() ) {
718 throw new Exception( __METHOD__
. ' will not work because the global MediaWikiServices '
719 . 'instance has been replaced by test code.' );
722 if ( is_callable( $service ) ) {
723 $instantiator = $service;
725 $instantiator = function () use ( $service ) {
730 $this->overriddenServices
[] = $name;
732 $this->localServices
->disableService( $name );
733 $this->localServices
->redefineService(
738 if ( $name === 'ContentLanguage' ) {
739 $this->doSetMwGlobals( [ 'wgContLang' => $this->localServices
->getContentLanguage() ] );
744 * Sets a global, maintaining a stashed version of the previous global to be
745 * restored in tearDown
747 * The key is added to the array of globals that will be reset afterwards
750 * It may be necessary to call resetServices() to allow any changed configuration variables
751 * to take effect on services that get initialized based on these variables.
755 * protected function setUp() {
756 * $this->setMwGlobals( 'wgRestrictStuff', true );
759 * function testFoo() {}
761 * function testBar() {}
762 * $this->assertTrue( self::getX()->doStuff() );
764 * $this->setMwGlobals( 'wgRestrictStuff', false );
765 * $this->assertTrue( self::getX()->doStuff() );
768 * function testQuux() {}
771 * @param array|string $pairs Key to the global variable, or an array
772 * of key/value pairs.
773 * @param mixed|null $value Value to set the global to (ignored
774 * if an array is given as first argument).
776 * @note To allow changes to global variables to take effect on global service instances,
777 * call resetServices().
781 protected function setMwGlobals( $pairs, $value = null ) {
782 if ( is_string( $pairs ) ) {
783 $pairs = [ $pairs => $value ];
786 if ( isset( $pairs['wgContLang'] ) ) {
787 throw new MWException(
788 'No setting $wgContLang, use setContentLang() or setService( \'ContentLanguage\' )'
792 $this->doSetMwGlobals( $pairs, $value );
796 * An internal method that allows setService() to set globals that tests are not supposed to
799 private function doSetMwGlobals( $pairs, $value = null ) {
800 $this->doStashMwGlobals( array_keys( $pairs ) );
802 foreach ( $pairs as $key => $value ) {
803 $GLOBALS[$key] = $value;
806 if ( array_intersect( self
::$namespaceAffectingSettings, array_keys( $pairs ) ) ) {
807 $this->resetNamespaces();
812 * Set an ini setting for the duration of the test
813 * @param string $name Name of the setting
814 * @param string $value Value to set
817 protected function setIniSetting( $name, $value ) {
818 $original = ini_get( $name );
819 $this->iniSettings
[$name] = $original;
820 ini_set( $name, $value );
824 * Must be called whenever namespaces are changed, e.g., $wgExtraNamespaces is altered.
825 * Otherwise old namespace data will lurk and cause bugs.
827 private function resetNamespaces() {
828 if ( !$this->localServices
) {
829 throw new Exception( __METHOD__
. ' must be called after MediaWikiTestCase::run()' );
832 if ( $this->localServices
!== MediaWikiServices
::getInstance() ) {
833 throw new Exception( __METHOD__
. ' will not work because the global MediaWikiServices '
834 . 'instance has been replaced by test code.' );
837 Language
::clearCaches();
841 * Check if we can back up a value by performing a shallow copy.
842 * Values which fail this test are copied recursively.
844 * @param mixed $value
845 * @return bool True if a shallow copy will do; false if a deep copy
848 private static function canShallowCopy( $value ) {
849 if ( is_scalar( $value ) ||
$value === null ) {
852 if ( is_array( $value ) ) {
853 foreach ( $value as $subValue ) {
854 if ( !is_scalar( $subValue ) && $subValue !== null ) {
863 private function doStashMwGlobals( $globalKeys ) {
864 if ( is_string( $globalKeys ) ) {
865 $globalKeys = [ $globalKeys ];
868 foreach ( $globalKeys as $globalKey ) {
869 // NOTE: make sure we only save the global once or a second call to
870 // setMwGlobals() on the same global would override the original
873 !array_key_exists( $globalKey, $this->mwGlobals
) &&
874 !array_key_exists( $globalKey, $this->mwGlobalsToUnset
)
876 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
877 $this->mwGlobalsToUnset
[$globalKey] = $globalKey;
880 // NOTE: we serialize then unserialize the value in case it is an object
881 // this stops any objects being passed by reference. We could use clone
882 // and if is_object but this does account for objects within objects!
883 if ( self
::canShallowCopy( $GLOBALS[$globalKey] ) ) {
884 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
886 // Many MediaWiki types are safe to clone. These are the
887 // ones that are most commonly stashed.
888 $GLOBALS[$globalKey] instanceof Language ||
889 $GLOBALS[$globalKey] instanceof User ||
890 $GLOBALS[$globalKey] instanceof FauxRequest
892 $this->mwGlobals
[$globalKey] = clone $GLOBALS[$globalKey];
893 } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
894 // Serializing Closure only gives a warning on HHVM while
895 // it throws an Exception on Zend.
896 // Workaround for https://github.com/facebook/hhvm/issues/6206
897 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
900 $this->mwGlobals
[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
901 } catch ( Exception
$e ) {
902 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
911 * @param int $maxDepth
915 private function containsClosure( $var, $maxDepth = 15 ) {
916 if ( $var instanceof Closure
) {
919 if ( !is_array( $var ) ||
$maxDepth === 0 ) {
923 foreach ( $var as $value ) {
924 if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
932 * Merges the given values into a MW global array variable.
933 * Useful for setting some entries in a configuration array, instead of
934 * setting the entire array.
936 * It may be necessary to call resetServices() to allow any changed configuration variables
937 * to take effect on services that get initialized based on these variables.
939 * @param string $name The name of the global, as in wgFooBar
940 * @param array $values The array containing the entries to set in that global
942 * @throws MWException If the designated global is not an array.
944 * @note To allow changes to global variables to take effect on global service instances,
945 * call resetServices().
949 protected function mergeMwGlobalArrayValue( $name, $values ) {
950 if ( !isset( $GLOBALS[$name] ) ) {
953 if ( !is_array( $GLOBALS[$name] ) ) {
954 throw new MWException( "MW global $name is not an array." );
957 // NOTE: do not use array_merge, it screws up for numeric keys.
958 $merged = $GLOBALS[$name];
959 foreach ( $values as $k => $v ) {
964 $this->setMwGlobals( $name, $merged );
968 * Resets service instances in the global instance of MediaWikiServices.
970 * In contrast to overrideMwServices(), this does not create a new MediaWikiServices instance,
971 * and it preserves any service instances set via setService().
973 * The primary use case for this method is to allow changes to global configuration variables
974 * to take effect on services that get initialized based on these global configuration
975 * variables. Similarly, it may be necessary to call resetServices() after calling setService(),
976 * so the newly set service gets picked up by any other service definitions that may use it.
978 * @see MediaWikiServices::resetServiceForTesting.
982 protected function resetServices() {
983 // Reset but don't destroy service instances supplied via setService().
984 foreach ( $this->overriddenServices
as $name ) {
985 $this->localServices
->resetServiceForTesting( $name, false );
988 // Reset all services with the destroy flag set.
989 // This will not have any effect on services that had already been reset above.
990 foreach ( $this->localServices
->getServiceNames() as $name ) {
991 $this->localServices
->resetServiceForTesting( $name, true );
994 self
::resetGlobalParser();
998 * Installs a new global instance of MediaWikiServices, allowing test cases to override
999 * settings and services.
1001 * This method can be used to set up specific services or configuration as a fixture.
1002 * It should not be used to reset services in between stages of a test - instead, the test
1003 * should either be split, or resetServices() should be used.
1005 * If called with no parameters, this method restores all services to their default state.
1006 * This is done automatically before each test to isolate tests from any modification
1007 * to settings and services that may have been applied by previous tests.
1008 * That means that the effect of calling overrideMwServices() is undone before the next
1009 * call to a test method.
1011 * @note Calling this after having called setService() in the same test method (or the
1012 * associated setUp) will result in an MWException.
1013 * Tests should use either overrideMwServices() or setService(), but not mix both.
1014 * Since 1.34, resetServices() is available as an alternative compatible with setService().
1018 * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
1020 * @param callable[] $services An associative array of services to re-define. Keys are service
1021 * names, values are callables.
1023 * @return MediaWikiServices
1024 * @throws MWException
1026 protected function overrideMwServices(
1027 Config
$configOverrides = null, array $services = []
1029 if ( $this->overriddenServices
) {
1030 throw new MWException(
1031 'The following services were set and are now being unset by overrideMwServices: ' .
1032 implode( ', ', $this->overriddenServices
)
1035 $newInstance = self
::installMockMwServices( $configOverrides );
1037 if ( $this->localServices
) {
1038 $this->localServices
->destroy();
1041 $this->localServices
= $newInstance;
1043 foreach ( $services as $name => $callback ) {
1044 $newInstance->redefineService( $name, $callback );
1047 self
::resetGlobalParser();
1049 return $newInstance;
1053 * Creates a new "mock" MediaWikiServices instance, and installs it.
1054 * This effectively resets all cached states in services, with the exception of
1055 * the ConfigFactory and the DBLoadBalancerFactory service, which are inherited from
1056 * the original MediaWikiServices.
1058 * @note The new original MediaWikiServices instance can later be restored by calling
1059 * restoreMwServices(). That original is determined by the first call to this method, or
1060 * by setUpBeforeClass, whichever is called first. The caller is responsible for managing
1061 * and, when appropriate, destroying any other MediaWikiServices instances that may get
1062 * replaced when calling this method.
1064 * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
1067 * @return MediaWikiServices the new mock service locator.
1069 public static function installMockMwServices( Config
$configOverrides = null ) {
1070 // Make sure we have the original service locator
1071 if ( !self
::$originalServices ) {
1072 self
::$originalServices = MediaWikiServices
::getInstance();
1075 if ( !$configOverrides ) {
1076 $configOverrides = new HashConfig();
1079 $oldConfigFactory = self
::$originalServices->getConfigFactory();
1080 $oldLoadBalancerFactory = self
::$originalServices->getDBLoadBalancerFactory();
1082 $testConfig = self
::makeTestConfig( null, $configOverrides );
1083 $newServices = new MediaWikiServices( $testConfig );
1085 // Load the default wiring from the specified files.
1086 // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
1087 $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
1088 $newServices->loadWiringFiles( $wiringFiles );
1090 // Provide a traditional hook point to allow extensions to configure services.
1091 Hooks
::run( 'MediaWikiServices', [ $newServices ] );
1093 // Use bootstrap config for all configuration.
1094 // This allows config overrides via global variables to take effect.
1095 $bootstrapConfig = $newServices->getBootstrapConfig();
1096 $newServices->resetServiceForTesting( 'ConfigFactory' );
1097 $newServices->redefineService(
1099 self
::makeTestConfigFactoryInstantiator(
1101 [ 'main' => $bootstrapConfig ]
1104 $newServices->resetServiceForTesting( 'DBLoadBalancerFactory' );
1105 $newServices->redefineService(
1106 'DBLoadBalancerFactory',
1107 function ( MediaWikiServices
$services ) use ( $oldLoadBalancerFactory ) {
1108 return $oldLoadBalancerFactory;
1112 MediaWikiServices
::forceGlobalInstance( $newServices );
1114 self
::resetGlobalParser();
1116 return $newServices;
1120 * Restores the original, non-mock MediaWikiServices instance.
1121 * The previously active MediaWikiServices instance is destroyed,
1122 * if it is different from the original that is to be restored.
1124 * @note this if for internal use by test framework code. It should never be
1125 * called from inside a test case, a data provider, or a setUp or tearDown method.
1127 * @return bool true if the original service locator was restored,
1128 * false if there was nothing too do.
1130 public static function restoreMwServices() {
1131 if ( !self
::$originalServices ) {
1135 $currentServices = MediaWikiServices
::getInstance();
1137 if ( self
::$originalServices === $currentServices ) {
1141 MediaWikiServices
::forceGlobalInstance( self
::$originalServices );
1142 $currentServices->destroy();
1144 self
::resetGlobalParser();
1150 * If $wgParser has been unstubbed, replace it with a fresh one so it picks up any config
1151 * changes. $wgParser is deprecated, but we still support it for now.
1153 private static function resetGlobalParser() {
1154 // phpcs:ignore MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgParser
1156 if ( $wgParser instanceof StubObject
) {
1159 $wgParser = new StubObject( 'wgParser', function () {
1160 return MediaWikiServices
::getInstance()->getParser();
1166 * @param string|Language $lang
1168 public function setUserLang( $lang ) {
1169 RequestContext
::getMain()->setLanguage( $lang );
1170 $this->setMwGlobals( 'wgLang', RequestContext
::getMain()->getLanguage() );
1175 * @param string|Language $lang
1177 public function setContentLang( $lang ) {
1178 if ( $lang instanceof Language
) {
1179 $this->setMwGlobals( 'wgLanguageCode', $lang->getCode() );
1180 // Set to the exact object requested
1181 $this->setService( 'ContentLanguage', $lang );
1183 $this->setMwGlobals( 'wgLanguageCode', $lang );
1184 // Let the service handler make up the object. Avoid calling setService(), because if
1185 // we do, overrideMwServices() will complain if it's called later on.
1186 $services = MediaWikiServices
::getInstance();
1187 $services->resetServiceForTesting( 'ContentLanguage' );
1188 $this->doSetMwGlobals( [ 'wgContLang' => $services->getContentLanguage() ] );
1193 * Alters $wgGroupPermissions for the duration of the test. Can be called
1194 * with an array, like
1195 * [ '*' => [ 'read' => false ], 'user' => [ 'read' => false ] ]
1196 * or three values to set a single permission, like
1197 * $this->setGroupPermissions( '*', 'read', false );
1200 * @param array|string $newPerms Either an array of permissions to change,
1201 * in which case the next two parameters are ignored; or a single string
1202 * identifying a group, to use with the next two parameters.
1203 * @param string|null $newKey
1204 * @param mixed|null $newValue
1206 public function setGroupPermissions( $newPerms, $newKey = null, $newValue = null ) {
1207 global $wgGroupPermissions;
1209 if ( is_string( $newPerms ) ) {
1210 $newPerms = [ $newPerms => [ $newKey => $newValue ] ];
1213 $newPermissions = $wgGroupPermissions;
1214 foreach ( $newPerms as $group => $permissions ) {
1215 foreach ( $permissions as $key => $value ) {
1216 $newPermissions[$group][$key] = $value;
1220 $this->setMwGlobals( 'wgGroupPermissions', $newPermissions );
1222 // Reset services so they pick up the new permissions.
1223 // Resetting just PermissionManager is not sufficient, since other services may
1224 // have the old instance of PermissionManager injected.
1225 $this->resetServices();
1229 * Overrides specific user permissions until services are reloaded
1234 * @param string[]|string $permissions
1238 public function overrideUserPermissions( $user, $permissions = [] ) {
1239 MediaWikiServices
::getInstance()->getPermissionManager()->overrideUserRightsForTesting(
1246 * Sets the logger for a specified channel, for the duration of the test.
1248 * @param string $channel
1249 * @param LoggerInterface $logger
1251 protected function setLogger( $channel, LoggerInterface
$logger ) {
1252 // TODO: Once loggers are managed by MediaWikiServices, use
1253 // resetServiceForTesting() to set loggers.
1255 $provider = LoggerFactory
::getProvider();
1256 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
1257 $singletons = $wrappedProvider->singletons
;
1258 if ( $provider instanceof MonologSpi
) {
1259 if ( !isset( $this->loggers
[$channel] ) ) {
1260 $this->loggers
[$channel] = $singletons['loggers'][$channel] ??
null;
1262 $singletons['loggers'][$channel] = $logger;
1263 } elseif ( $provider instanceof LegacySpi ||
$provider instanceof LogCapturingSpi
) {
1264 if ( !isset( $this->loggers
[$channel] ) ) {
1265 $this->loggers
[$channel] = $singletons[$channel] ??
null;
1267 $singletons[$channel] = $logger;
1269 throw new LogicException( __METHOD__
. ': setting a logger for ' . get_class( $provider )
1270 . ' is not implemented' );
1272 $wrappedProvider->singletons
= $singletons;
1276 * Restores loggers replaced by setLogger().
1279 private function restoreLoggers() {
1280 $provider = LoggerFactory
::getProvider();
1281 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
1282 $singletons = $wrappedProvider->singletons
;
1283 foreach ( $this->loggers
as $channel => $logger ) {
1284 if ( $provider instanceof MonologSpi
) {
1285 if ( $logger === null ) {
1286 unset( $singletons['loggers'][$channel] );
1288 $singletons['loggers'][$channel] = $logger;
1290 } elseif ( $provider instanceof LegacySpi ||
$provider instanceof LogCapturingSpi
) {
1291 if ( $logger === null ) {
1292 unset( $singletons[$channel] );
1294 $singletons[$channel] = $logger;
1298 $wrappedProvider->singletons
= $singletons;
1299 $this->loggers
= [];
1306 public function dbPrefix() {
1307 return self
::getTestPrefixFor( $this->db
);
1311 * @param IDatabase $db
1315 public static function getTestPrefixFor( IDatabase
$db ) {
1316 return $db->getType() == 'oracle' ? self
::ORA_DB_PREFIX
: self
::DB_PREFIX
;
1323 public function needsDB() {
1324 // If the test says it uses database tables, it needs the database
1325 return $this->tablesUsed ||
$this->isTestInDatabaseGroup();
1329 * Insert a new page.
1331 * Should be called from addDBData().
1333 * @since 1.25 ($namespace in 1.28)
1334 * @param string|Title $pageName Page name or title
1335 * @param string $text Page's content
1336 * @param int|null $namespace Namespace id (name cannot already contain namespace)
1337 * @param User|null $user If null, static::getTestSysop()->getUser() is used.
1338 * @return array Title object and page id
1339 * @throws MWException If this test cases's needsDB() method doesn't return true.
1340 * Test cases can use "@group Database" to enable database test support,
1341 * or list the tables under testing in $this->tablesUsed, or override the
1344 protected function insertPage(
1346 $text = 'Sample page for unit test.',
1350 if ( !$this->needsDB() ) {
1351 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
1352 ' method should return true. Use @group Database or $this->tablesUsed.' );
1355 if ( is_string( $pageName ) ) {
1356 $title = Title
::newFromText( $pageName, $namespace );
1362 $user = static::getTestSysop()->getUser();
1364 $comment = __METHOD__
. ': Sample page for unit test.';
1366 $page = WikiPage
::factory( $title );
1367 $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $comment, 0, false, $user );
1371 'id' => $page->getId(),
1376 * Stub. If a test suite needs to add additional data to the database, it should
1377 * implement this method and do so. This method is called once per test suite
1378 * (i.e. once per class).
1380 * Note data added by this method may be removed by resetDB() depending on
1381 * the contents of $tablesUsed.
1383 * To add additional data between test function runs, override prepareDB().
1390 public function addDBDataOnce() {
1394 * Stub. Subclasses may override this to prepare the database.
1395 * Called before every test run (test function or data set).
1397 * @see addDBDataOnce()
1402 public function addDBData() {
1408 protected function addCoreDBData() {
1409 if ( $this->db
->getType() == 'oracle' ) {
1410 # Insert 0 user to prevent FK violations
1412 if ( !$this->db
->selectField( 'user', '1', [ 'user_id' => 0 ] ) ) {
1413 $this->db
->insert( 'user', [
1415 'user_name' => 'Anonymous' ], __METHOD__
, [ 'IGNORE' ] );
1418 # Insert 0 page to prevent FK violations
1420 if ( !$this->db
->selectField( 'page', '1', [ 'page_id' => 0 ] ) ) {
1421 $this->db
->insert( 'page', [
1423 'page_namespace' => 0,
1424 'page_title' => ' ',
1425 'page_restrictions' => null,
1426 'page_is_redirect' => 0,
1429 'page_touched' => $this->db
->timestamp(),
1431 'page_len' => 0 ], __METHOD__
, [ 'IGNORE' ] );
1435 SiteStatsInit
::doPlaceholderInit();
1437 User
::resetIdByNameCache();
1440 $user = static::getTestSysop()->getUser();
1442 // Make 1 page with 1 revision
1443 $page = WikiPage
::factory( Title
::newFromText( 'UTPage' ) );
1444 if ( $page->getId() == 0 ) {
1445 $page->doEditContent(
1446 new WikitextContent( 'UTContent' ),
1448 EDIT_NEW | EDIT_SUPPRESS_RC
,
1452 // an edit always attempt to purge backlink links such as history
1453 // pages. That is unnecessary.
1454 JobQueueGroup
::singleton()->get( 'htmlCacheUpdate' )->delete();
1455 // WikiPages::doEditUpdates randomly adds RC purges
1456 JobQueueGroup
::singleton()->get( 'recentChangesUpdate' )->delete();
1458 // doEditContent() probably started the session via
1459 // User::loadFromSession(). Close it now.
1460 if ( session_id() !== '' ) {
1461 session_write_close();
1468 * Restores MediaWiki to using the table set (table prefix) it was using before
1469 * setupTestDB() was called. Useful if we need to perform database operations
1470 * after the test run has finished (such as saving logs or profiling info).
1472 * This is called by phpunit/bootstrap.php after the last test.
1476 public static function teardownTestDB() {
1477 global $wgJobClasses;
1479 if ( !self
::$dbSetup ) {
1483 Hooks
::run( 'UnitTestsBeforeDatabaseTeardown' );
1485 foreach ( $wgJobClasses as $type => $class ) {
1486 // Delete any jobs under the clone DB (or old prefix in other stores)
1487 JobQueueGroup
::singleton()->get( $type )->delete();
1490 // T219673: close any connections from code that failed to call reuseConnection()
1491 // or is still holding onto a DBConnRef instance (e.g. in a singleton).
1492 MediaWikiServices
::getInstance()->getDBLoadBalancerFactory()->closeAll();
1493 CloneDatabase
::changePrefix( self
::$oldTablePrefix );
1495 self
::$oldTablePrefix = false;
1496 self
::$dbSetup = false;
1500 * Setups a database with cloned tables using the given prefix.
1502 * If reuseDB is true and certain conditions apply, it will just change the prefix.
1503 * Otherwise, it will clone the tables and change the prefix.
1505 * @param IMaintainableDatabase $db Database to use
1506 * @param string|null $prefix Prefix to use for test tables. If not given, the prefix is determined
1507 * automatically for $db.
1508 * @return bool True if tables were cloned, false if only the prefix was changed
1510 protected static function setupDatabaseWithTestPrefix(
1511 IMaintainableDatabase
$db,
1514 if ( $prefix === null ) {
1515 $prefix = self
::getTestPrefixFor( $db );
1518 if ( ( $db->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
1519 $db->tablePrefix( $prefix );
1523 if ( !isset( $db->_originalTablePrefix
) ) {
1524 $oldPrefix = $db->tablePrefix();
1526 if ( $oldPrefix === $prefix ) {
1527 // table already has the correct prefix, but presumably no cloned tables
1528 $oldPrefix = self
::$oldTablePrefix;
1531 $db->tablePrefix( $oldPrefix );
1532 $tablesCloned = self
::listTables( $db );
1533 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix, $oldPrefix );
1534 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1536 $dbClone->cloneTableStructure();
1538 $db->tablePrefix( $prefix );
1539 $db->_originalTablePrefix
= $oldPrefix;
1546 * Set up all test DBs
1548 public function setupAllTestDBs() {
1551 self
::$oldTablePrefix = $wgDBprefix;
1553 $testPrefix = $this->dbPrefix();
1555 // switch to a temporary clone of the database
1556 self
::setupTestDB( $this->db
, $testPrefix );
1558 if ( self
::isUsingExternalStoreDB() ) {
1559 self
::setupExternalStoreTestDBs( $testPrefix );
1562 // NOTE: Change the prefix in the LBFactory and $wgDBprefix, to prevent
1563 // *any* database connections to operate on live data.
1564 CloneDatabase
::changePrefix( $testPrefix );
1568 * Creates an empty skeleton of the wiki database by cloning its structure
1569 * to equivalent tables using the given $prefix. Then sets MediaWiki to
1570 * use the new set of tables (aka schema) instead of the original set.
1572 * This is used to generate a dummy table set, typically consisting of temporary
1573 * tables, that will be used by tests instead of the original wiki database tables.
1577 * @note the original table prefix is stored in self::$oldTablePrefix. This is used
1578 * by teardownTestDB() to return the wiki to using the original table set.
1580 * @note this method only works when first called. Subsequent calls have no effect,
1581 * even if using different parameters.
1583 * @param IMaintainableDatabase $db The database connection
1584 * @param string $prefix The prefix to use for the new table set (aka schema).
1586 * @throws MWException If the database table prefix is already $prefix
1588 public static function setupTestDB( IMaintainableDatabase
$db, $prefix ) {
1589 if ( self
::$dbSetup ) {
1593 if ( $db->tablePrefix() === $prefix ) {
1594 throw new MWException(
1595 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
1598 // TODO: the below should be re-written as soon as LBFactory, LoadBalancer,
1599 // and Database no longer use global state.
1601 self
::$dbSetup = true;
1603 if ( !self
::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
1607 // Assuming this isn't needed for External Store database, and not sure if the procedure
1608 // would be available there.
1609 if ( $db->getType() == 'oracle' ) {
1610 $db->query( 'BEGIN FILL_WIKI_INFO; END;', __METHOD__
);
1613 Hooks
::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
1617 * Clones the External Store database(s) for testing
1619 * @param string|null $testPrefix Prefix for test tables. Will be determined automatically
1622 protected static function setupExternalStoreTestDBs( $testPrefix = null ) {
1623 $connections = self
::getExternalStoreDatabaseConnections();
1624 foreach ( $connections as $dbw ) {
1625 self
::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
1630 * Gets master database connections for all of the ExternalStoreDB
1631 * stores configured in $wgDefaultExternalStore.
1633 * @return Database[] Array of Database master connections
1635 protected static function getExternalStoreDatabaseConnections() {
1636 global $wgDefaultExternalStore;
1638 /** @var ExternalStoreDB $externalStoreDB */
1639 $externalStoreDB = ExternalStore
::getStoreObject( 'DB' );
1640 $defaultArray = (array)$wgDefaultExternalStore;
1642 foreach ( $defaultArray as $url ) {
1643 if ( strpos( $url, 'DB://' ) === 0 ) {
1644 list( $proto, $cluster ) = explode( '://', $url, 2 );
1645 // Avoid getMaster() because setupDatabaseWithTestPrefix()
1646 // requires Database instead of plain DBConnRef/IDatabase
1647 $dbws[] = $externalStoreDB->getMaster( $cluster );
1655 * Check whether ExternalStoreDB is being used
1657 * @return bool True if it's being used
1659 protected static function isUsingExternalStoreDB() {
1660 global $wgDefaultExternalStore;
1661 if ( !$wgDefaultExternalStore ) {
1665 $defaultArray = (array)$wgDefaultExternalStore;
1666 foreach ( $defaultArray as $url ) {
1667 if ( strpos( $url, 'DB://' ) === 0 ) {
1676 * @throws LogicException if the given database connection is not a set up to use
1679 * @since 1.31 this is no longer private.
1681 protected function ensureMockDatabaseConnection( IDatabase
$db ) {
1682 if ( $db->tablePrefix() !== $this->dbPrefix() ) {
1683 throw new LogicException(
1684 'Trying to delete mock tables, but table prefix does not indicate a mock database.'
1689 private static $schemaOverrideDefaults = [
1697 * Stub. If a test suite needs to test against a specific database schema, it should
1698 * override this method and return the appropriate information from it.
1700 * 'create', 'drop' and 'alter' in the returned array should list all the tables affected
1701 * by the 'scripts', even if the test is only interested in a subset of them, otherwise
1702 * the overrides may not be fully cleaned up, leading to errors later.
1704 * @param IMaintainableDatabase $db The DB connection to use for the mock schema.
1705 * May be used to check the current state of the schema, to determine what
1706 * overrides are needed.
1708 * @return array An associative array with the following fields:
1709 * - 'scripts': any SQL scripts to run. If empty or not present, schema overrides are skipped.
1710 * - 'create': A list of tables created (may or may not exist in the original schema).
1711 * - 'drop': A list of tables dropped (expected to be present in the original schema).
1712 * - 'alter': A list of tables altered (expected to be present in the original schema).
1714 protected function getSchemaOverrides( IMaintainableDatabase
$db ) {
1719 * Undoes the specified schema overrides..
1720 * Called once per test class, just before addDataOnce().
1722 * @param IMaintainableDatabase $db
1723 * @param array $oldOverrides
1725 private function undoSchemaOverrides( IMaintainableDatabase
$db, $oldOverrides ) {
1726 $this->ensureMockDatabaseConnection( $db );
1728 $oldOverrides = $oldOverrides + self
::$schemaOverrideDefaults;
1729 $originalTables = $this->listOriginalTables( $db );
1731 // Drop tables that need to be restored or removed.
1732 $tablesToDrop = array_merge( $oldOverrides['create'], $oldOverrides['alter'] );
1734 // Restore tables that have been dropped or created or altered,
1735 // if they exist in the original schema.
1736 $tablesToRestore = array_merge( $tablesToDrop, $oldOverrides['drop'] );
1737 $tablesToRestore = array_intersect( $originalTables, $tablesToRestore );
1739 if ( $tablesToDrop ) {
1740 $this->dropMockTables( $db, $tablesToDrop );
1743 if ( $tablesToRestore ) {
1744 $this->recloneMockTables( $db, $tablesToRestore );
1746 // Reset the restored tables, mainly for the side effect of
1747 // re-calling $this->addCoreDBData() if necessary.
1748 $this->resetDB( $db, $tablesToRestore );
1753 * Applies the schema overrides returned by getSchemaOverrides(),
1754 * after undoing any previously applied schema overrides.
1755 * Called once per test class, just before addDataOnce().
1757 private function setUpSchema( IMaintainableDatabase
$db ) {
1758 // Undo any active overrides.
1759 $oldOverrides = $db->_schemaOverrides ?? self
::$schemaOverrideDefaults;
1761 if ( $oldOverrides['alter'] ||
$oldOverrides['create'] ||
$oldOverrides['drop'] ) {
1762 $this->undoSchemaOverrides( $db, $oldOverrides );
1763 unset( $db->_schemaOverrides
);
1766 // Determine new overrides.
1767 $overrides = $this->getSchemaOverrides( $db ) + self
::$schemaOverrideDefaults;
1769 $extraKeys = array_diff(
1770 array_keys( $overrides ),
1771 array_keys( self
::$schemaOverrideDefaults )
1775 throw new InvalidArgumentException(
1776 'Schema override contains extra keys: ' . var_export( $extraKeys, true )
1780 if ( !$overrides['scripts'] ) {
1781 // no scripts to run
1785 if ( !$overrides['create'] && !$overrides['drop'] && !$overrides['alter'] ) {
1786 throw new InvalidArgumentException(
1787 'Schema override scripts given, but no tables are declared to be '
1788 . 'created, dropped or altered.'
1792 $this->ensureMockDatabaseConnection( $db );
1794 // Drop the tables that will be created by the schema scripts.
1795 $originalTables = $this->listOriginalTables( $db );
1796 $tablesToDrop = array_intersect( $originalTables, $overrides['create'] );
1798 if ( $tablesToDrop ) {
1799 $this->dropMockTables( $db, $tablesToDrop );
1802 // Run schema override scripts.
1803 foreach ( $overrides['scripts'] as $script ) {
1810 return $this->mungeSchemaUpdateQuery( $cmd );
1815 $db->_schemaOverrides
= $overrides;
1818 private function mungeSchemaUpdateQuery( $cmd ) {
1819 return self
::$useTemporaryTables
1820 ?
preg_replace( '/\bCREATE\s+TABLE\b/i', 'CREATE TEMPORARY TABLE', $cmd )
1825 * Drops the given mock tables.
1827 * @param IMaintainableDatabase $db
1828 * @param array $tables
1830 private function dropMockTables( IMaintainableDatabase
$db, array $tables ) {
1831 $this->ensureMockDatabaseConnection( $db );
1833 foreach ( $tables as $tbl ) {
1834 $tbl = $db->tableName( $tbl );
1835 $db->query( "DROP TABLE IF EXISTS $tbl", __METHOD__
);
1840 * Lists all tables in the live database schema, without a prefix.
1842 * @param IMaintainableDatabase $db
1845 private function listOriginalTables( IMaintainableDatabase
$db ) {
1846 if ( !isset( $db->_originalTablePrefix
) ) {
1847 throw new LogicException( 'No original table prefix know, cannot list tables!' );
1850 $originalTables = $db->listTables( $db->_originalTablePrefix
, __METHOD__
);
1852 $unittestPrefixRegex = '/^' . preg_quote( $this->dbPrefix(), '/' ) . '/';
1853 $originalPrefixRegex = '/^' . preg_quote( $db->_originalTablePrefix
, '/' ) . '/';
1855 $originalTables = array_filter(
1857 function ( $pt ) use ( $unittestPrefixRegex ) {
1858 return !preg_match( $unittestPrefixRegex, $pt );
1862 $originalTables = array_map(
1863 function ( $pt ) use ( $originalPrefixRegex ) {
1864 return preg_replace( $originalPrefixRegex, '', $pt );
1869 return array_unique( $originalTables );
1873 * Re-clones the given mock tables to restore them based on the live database schema.
1874 * The tables listed in $tables are expected to currently not exist, so dropMockTables()
1875 * should be called first.
1877 * @param IMaintainableDatabase $db
1878 * @param array $tables
1880 private function recloneMockTables( IMaintainableDatabase
$db, array $tables ) {
1881 $this->ensureMockDatabaseConnection( $db );
1883 if ( !isset( $db->_originalTablePrefix
) ) {
1884 throw new LogicException( 'No original table prefix know, cannot restore tables!' );
1887 $originalTables = $this->listOriginalTables( $db );
1888 $tables = array_intersect( $tables, $originalTables );
1890 $dbClone = new CloneDatabase( $db, $tables, $db->tablePrefix(), $db->_originalTablePrefix
);
1891 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1893 $dbClone->cloneTableStructure();
1897 * Empty all tables so they can be repopulated for tests
1899 * @param Database $db|null Database to reset
1900 * @param array $tablesUsed Tables to reset
1902 private function resetDB( $db, $tablesUsed ) {
1904 $userTables = [ 'user', 'user_groups', 'user_properties', 'actor' ];
1906 'page', 'revision', 'ip_changes', 'revision_comment_temp', 'comment', 'archive',
1907 'revision_actor_temp', 'slots', 'content', 'content_models', 'slot_roles',
1909 $coreDBDataTables = array_merge( $userTables, $pageTables );
1911 // If any of the user or page tables were marked as used, we should clear all of them.
1912 if ( array_intersect( $tablesUsed, $userTables ) ) {
1913 $tablesUsed = array_unique( array_merge( $tablesUsed, $userTables ) );
1914 TestUserRegistry
::clear();
1916 // Reset $wgUser, which is probably 127.0.0.1, as its loaded data is probably not valid
1917 // @todo Should we start setting $wgUser to something nondeterministic
1918 // to encourage tests to be updated to not depend on it?
1920 $wgUser->clearInstanceCache( $wgUser->mFrom
);
1922 if ( array_intersect( $tablesUsed, $pageTables ) ) {
1923 $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
1926 // Postgres, Oracle, and MSSQL all use mwuser/pagecontent
1927 // instead of user/text. But Postgres does not remap the
1928 // table name in tableExists(), so we mark the real table
1929 // names as being used.
1930 if ( $db->getType() === 'postgres' ) {
1931 if ( in_array( 'user', $tablesUsed ) ) {
1932 $tablesUsed[] = 'mwuser';
1934 if ( in_array( 'text', $tablesUsed ) ) {
1935 $tablesUsed[] = 'pagecontent';
1939 foreach ( $tablesUsed as $tbl ) {
1940 $this->truncateTable( $tbl, $db );
1943 if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
1944 // Reset services that may contain information relating to the truncated tables
1945 $this->overrideMwServices();
1946 // Re-add core DB data that was deleted
1947 $this->addCoreDBData();
1953 * Empties the given table and resets any auto-increment counters.
1954 * Will also purge caches associated with some well known tables.
1955 * If the table is not know, this method just returns.
1957 * @param string $tableName
1958 * @param IDatabase|null $db
1960 protected function truncateTable( $tableName, IDatabase
$db = null ) {
1965 if ( !$db->tableExists( $tableName ) ) {
1969 $truncate = in_array( $db->getType(), [ 'oracle', 'mysql' ] );
1972 $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tableName ), __METHOD__
);
1974 $db->delete( $tableName, '*', __METHOD__
);
1977 if ( $db instanceof DatabasePostgres ||
$db instanceof DatabaseSqlite
) {
1978 // Reset the table's sequence too.
1979 $db->resetSequenceForTable( $tableName, __METHOD__
);
1982 // re-initialize site_stats table
1983 if ( $tableName === 'site_stats' ) {
1984 SiteStatsInit
::doPlaceholderInit();
1988 private static function unprefixTable( &$tableName, $ind, $prefix ) {
1989 $tableName = substr( $tableName, strlen( $prefix ) );
1992 private static function isNotUnittest( $table ) {
1993 return strpos( $table, self
::DB_PREFIX
) !== 0;
1999 * @param IMaintainableDatabase $db
2003 public static function listTables( IMaintainableDatabase
$db ) {
2004 $prefix = $db->tablePrefix();
2005 $tables = $db->listTables( $prefix, __METHOD__
);
2007 if ( $db->getType() === 'mysql' ) {
2008 static $viewListCache = null;
2009 if ( $viewListCache === null ) {
2010 $viewListCache = $db->listViews( null, __METHOD__
);
2012 // T45571: cannot clone VIEWs under MySQL
2013 $tables = array_diff( $tables, $viewListCache );
2015 array_walk( $tables, [ __CLASS__
, 'unprefixTable' ], $prefix );
2017 // Don't duplicate test tables from the previous fataled run
2018 $tables = array_filter( $tables, [ __CLASS__
, 'isNotUnittest' ] );
2020 if ( $db->getType() == 'sqlite' ) {
2021 $tables = array_flip( $tables );
2022 // these are subtables of searchindex and don't need to be duped/dropped separately
2023 unset( $tables['searchindex_content'] );
2024 unset( $tables['searchindex_segdir'] );
2025 unset( $tables['searchindex_segments'] );
2026 $tables = array_flip( $tables );
2033 * Copy test data from one database connection to another.
2035 * This should only be used for small data sets.
2037 * @param IDatabase $source
2038 * @param IDatabase $target
2040 public function copyTestData( IDatabase
$source, IDatabase
$target ) {
2041 if ( $this->db
->getType() === 'sqlite' ) {
2042 // SQLite uses a non-temporary copy of the searchindex table for testing,
2043 // which gets deleted and re-created when setting up the secondary connection,
2044 // causing "Error 17" when trying to copy the data. See T191863#4130112.
2045 throw new RuntimeException(
2046 'Setting up a secondary database connection with test data is currently not'
2047 . 'with SQLite. You may want to use markTestSkippedIfDbType() to bypass this issue.'
2051 $tables = self
::listOriginalTables( $source );
2053 foreach ( $tables as $table ) {
2054 $res = $source->select( $table, '*', [], __METHOD__
);
2057 foreach ( $res as $row ) {
2058 $allRows[] = (array)$row;
2061 $target->insert( $table, $allRows, __METHOD__
, [ 'IGNORE' ] );
2066 * @throws MWException
2069 protected function checkDbIsSupported() {
2070 if ( !in_array( $this->db
->getType(), $this->supportedDBs
) ) {
2071 throw new MWException( $this->db
->getType() . " is not currently supported for unit testing." );
2077 * @param string $offset
2080 public function getCliArg( $offset ) {
2081 return $this->cliArgs
[$offset] ??
null;
2086 * @param string $offset
2087 * @param mixed $value
2089 public function setCliArg( $offset, $value ) {
2090 $this->cliArgs
[$offset] = $value;
2094 * Don't throw a warning if $function is deprecated and called later
2098 * @param string $function
2100 public function hideDeprecated( $function ) {
2101 Wikimedia\
suppressWarnings();
2102 wfDeprecated( $function );
2103 Wikimedia\restoreWarnings
();
2107 * Asserts that the given database query yields the rows given by $expectedRows.
2108 * The expected rows should be given as indexed (not associative) arrays, with
2109 * the values given in the order of the columns in the $fields parameter.
2110 * Note that the rows are sorted by the columns given in $fields.
2114 * @param string|array $table The table(s) to query
2115 * @param string|array $fields The columns to include in the result (and to sort by)
2116 * @param string|array $condition "where" condition(s)
2117 * @param array $expectedRows An array of arrays giving the expected rows.
2118 * @param array $options Options for the query
2119 * @param array $join_conds Join conditions for the query
2121 * @throws MWException If this test cases's needsDB() method doesn't return true.
2122 * Test cases can use "@group Database" to enable database test support,
2123 * or list the tables under testing in $this->tablesUsed, or override the
2126 protected function assertSelect(
2127 $table, $fields, $condition, array $expectedRows, array $options = [], array $join_conds = []
2129 if ( !$this->needsDB() ) {
2130 throw new MWException( 'When testing database state, the test cases\'s needDB()' .
2131 ' method should return true. Use @group Database or $this->tablesUsed.' );
2134 $db = wfGetDB( DB_REPLICA
);
2141 $options +
[ 'ORDER BY' => $fields ],
2144 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
2148 foreach ( $expectedRows as $expected ) {
2149 $r = $res->fetchRow();
2150 self
::stripStringKeys( $r );
2153 $this->assertNotEmpty( $r, "row #$i missing" );
2155 $this->assertEquals( $expected, $r, "row #$i mismatches" );
2158 $r = $res->fetchRow();
2159 self
::stripStringKeys( $r );
2161 $this->assertFalse( $r, "found extra row (after #$i)" );
2165 * Utility method taking an array of elements and wrapping
2166 * each element in its own array. Useful for data providers
2167 * that only return a single argument.
2171 * @param array $elements
2175 protected function arrayWrap( array $elements ) {
2177 function ( $element ) {
2178 return [ $element ];
2185 * Assert that two arrays are equal. By default this means that both arrays need to hold
2186 * the same set of values. Using additional arguments, order and associated key can also
2187 * be set as relevant.
2191 * @param array $expected
2192 * @param array $actual
2193 * @param bool $ordered If the order of the values should match
2194 * @param bool $named If the keys should match
2196 protected function assertArrayEquals( array $expected, array $actual,
2197 $ordered = false, $named = false
2200 $this->objectAssociativeSort( $expected );
2201 $this->objectAssociativeSort( $actual );
2205 $expected = array_values( $expected );
2206 $actual = array_values( $actual );
2209 call_user_func_array(
2210 [ $this, 'assertEquals' ],
2211 array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
2216 * Put each HTML element on its own line and then equals() the results
2218 * Use for nicely formatting of PHPUnit diff output when comparing very
2223 * @param string $expected HTML on oneline
2224 * @param string $actual HTML on oneline
2225 * @param string $msg Optional message
2227 protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
2228 $expected = str_replace( '>', ">\n", $expected );
2229 $actual = str_replace( '>', ">\n", $actual );
2231 $this->assertEquals( $expected, $actual, $msg );
2235 * Does an associative sort that works for objects.
2239 * @param array &$array
2241 protected function objectAssociativeSort( array &$array ) {
2244 function ( $a, $b ) {
2245 return serialize( $a ) <=> serialize( $b );
2251 * Utility function for eliminating all string keys from an array.
2252 * Useful to turn a database result row as returned by fetchRow() into
2253 * a pure indexed array.
2257 * @param mixed &$r The array to remove string keys from.
2259 protected static function stripStringKeys( &$r ) {
2260 if ( !is_array( $r ) ) {
2264 foreach ( $r as $k => $v ) {
2265 if ( is_string( $k ) ) {
2272 * Asserts that the provided variable is of the specified
2273 * internal type or equals the $value argument. This is useful
2274 * for testing return types of functions that return a certain
2275 * type or *value* when not set or on error.
2279 * @param string $type
2280 * @param mixed $actual
2281 * @param mixed $value
2282 * @param string $message
2284 protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
2285 if ( $actual === $value ) {
2286 $this->assertTrue( true, $message );
2288 $this->assertType( $type, $actual, $message );
2293 * Asserts the type of the provided value. This can be either
2294 * in internal type such as boolean or integer, or a class or
2295 * interface the value extends or implements.
2299 * @param string $type
2300 * @param mixed $actual
2301 * @param string $message
2303 protected function assertType( $type, $actual, $message = '' ) {
2304 if ( class_exists( $type ) ||
interface_exists( $type ) ) {
2305 $this->assertInstanceOf( $type, $actual, $message );
2307 $this->assertInternalType( $type, $actual, $message );
2312 * Returns true if the given namespace defaults to Wikitext
2313 * according to $wgNamespaceContentModels
2315 * @param int $ns The namespace ID to check
2320 protected function isWikitextNS( $ns ) {
2321 global $wgNamespaceContentModels;
2323 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
2324 return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
;
2331 * Returns the ID of a namespace that defaults to Wikitext.
2333 * @throws MWException If there is none.
2334 * @return int The ID of the wikitext Namespace
2337 protected function getDefaultWikitextNS() {
2338 global $wgNamespaceContentModels;
2340 static $wikitextNS = null; // this is not going to change
2341 if ( $wikitextNS !== null ) {
2345 // quickly short out on most common case:
2346 if ( !isset( $wgNamespaceContentModels[NS_MAIN
] ) ) {
2350 // NOTE: prefer content namespaces
2351 $nsInfo = MediaWikiServices
::getInstance()->getNamespaceInfo();
2352 $namespaces = array_unique( array_merge(
2353 $nsInfo->getContentNamespaces(),
2354 [ NS_MAIN
, NS_HELP
, NS_PROJECT
], // prefer these
2355 $nsInfo->getValidNamespaces()
2358 $namespaces = array_diff( $namespaces, [
2359 NS_FILE
, NS_CATEGORY
, NS_MEDIAWIKI
, NS_USER
// don't mess with magic namespaces
2362 $talk = array_filter( $namespaces, function ( $ns ) use ( $nsInfo ) {
2363 return $nsInfo->isTalk( $ns );
2366 // prefer non-talk pages
2367 $namespaces = array_diff( $namespaces, $talk );
2368 $namespaces = array_merge( $namespaces, $talk );
2370 // check default content model of each namespace
2371 foreach ( $namespaces as $ns ) {
2372 if ( !isset( $wgNamespaceContentModels[$ns] ) ||
2373 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
2382 // @todo Inside a test, we could skip the test as incomplete.
2383 // But frequently, this is used in fixture setup.
2384 throw new MWException( "No namespace defaults to wikitext!" );
2388 * Check, if $wgDiff3 is set and ready to merge
2389 * Will mark the calling test as skipped, if not ready
2393 protected function markTestSkippedIfNoDiff3() {
2396 # This check may also protect against code injection in
2397 # case of broken installations.
2398 Wikimedia\
suppressWarnings();
2399 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2400 Wikimedia\restoreWarnings
();
2402 if ( !$haveDiff3 ) {
2403 $this->markTestSkipped( "Skip test, since diff3 is not configured" );
2408 * Check if $extName is a loaded PHP extension, will skip the
2409 * test whenever it is not loaded.
2412 * @param string $extName
2415 protected function checkPHPExtension( $extName ) {
2416 $loaded = extension_loaded( $extName );
2418 $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
2425 * Skip the test if using the specified database type
2427 * @param string $type Database type
2430 protected function markTestSkippedIfDbType( $type ) {
2431 if ( $this->db
->getType() === $type ) {
2432 $this->markTestSkipped( "The $type database type isn't supported for this test" );
2437 * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
2438 * @param string $buffer
2441 public static function wfResetOutputBuffersBarrier( $buffer ) {
2446 * Create a temporary hook handler which will be reset by tearDown.
2447 * This replaces other handlers for the same hook.
2448 * @param string $hookName Hook name
2449 * @param mixed $handler Value suitable for a hook handler
2452 protected function setTemporaryHook( $hookName, $handler ) {
2453 $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
2457 * Check whether file contains given data.
2458 * @param string $fileName
2459 * @param string $actualData
2460 * @param bool $createIfMissing If true, and file does not exist, create it with given data
2461 * and skip the test.
2462 * @param string $msg
2465 protected function assertFileContains(
2468 $createIfMissing = false,
2471 if ( $createIfMissing ) {
2472 if ( !file_exists( $fileName ) ) {
2473 file_put_contents( $fileName, $actualData );
2474 $this->markTestSkipped( "Data file $fileName does not exist" );
2477 self
::assertFileExists( $fileName );
2479 self
::assertEquals( file_get_contents( $fileName ), $actualData, $msg );
2483 * Edits or creates a page/revision
2484 * @param string $pageName Page title
2485 * @param string $text Content of the page
2486 * @param string $summary Optional summary string for the revision
2487 * @param int $defaultNs Optional namespace id
2488 * @param User|null $user If null, static::getTestSysop()->getUser() is used.
2489 * @return Status Object as returned by WikiPage::doEditContent()
2490 * @throws MWException If this test cases's needsDB() method doesn't return true.
2491 * Test cases can use "@group Database" to enable database test support,
2492 * or list the tables under testing in $this->tablesUsed, or override the
2495 protected function editPage(
2499 $defaultNs = NS_MAIN
,
2502 if ( !$this->needsDB() ) {
2503 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
2504 ' method should return true. Use @group Database or $this->tablesUsed.' );
2507 $title = Title
::newFromText( $pageName, $defaultNs );
2508 $page = WikiPage
::factory( $title );
2510 return $page->doEditContent(
2511 ContentHandler
::makeContent( $text, $title ),
2520 * Revision-deletes a revision.
2522 * @param Revision|int $rev Revision to delete
2523 * @param array $value Keys are Revision::DELETED_* flags. Values are 1 to set the bit, 0 to
2524 * clear, -1 to leave alone. (All other values also clear the bit.)
2525 * @param string $comment Deletion comment
2527 protected function revisionDelete(
2528 $rev, array $value = [ Revision
::DELETED_TEXT
=> 1 ], $comment = ''
2530 if ( is_int( $rev ) ) {
2531 $rev = Revision
::newFromId( $rev );
2533 RevisionDeleter
::createList(
2534 'revision', RequestContext
::getMain(), $rev->getTitle(), [ $rev->getId() ]
2537 'comment' => $comment,
2542 * Returns a PHPUnit constraint that matches anything other than a fixed set of values. This can
2543 * be used to whitelist values, e.g.
2544 * $mock->expects( $this->never() )->method( $this->anythingBut( 'foo', 'bar' ) );
2545 * which will throw if any unexpected method is called.
2547 * @param mixed ...$values Values that are not matched
2549 protected function anythingBut( ...$values ) {
2550 return $this->logicalNot( $this->logicalOr(
2551 ...array_map( [ $this, 'matches' ], $values )
2556 class_alias( 'MediaWikiIntegrationTestCase', 'MediaWikiTestCase' );