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 MediaWikiGroupValidator
;
27 use MediaWikiTestCaseTrait
;
28 use PHPUnit4And6Compat
;
31 * The original service locator. This is overridden during setUp().
33 * @var MediaWikiServices|null
35 private static $originalServices;
38 * The local service locator, created during setUp().
39 * @var MediaWikiServices
41 private $localServices;
44 * $called tracks whether the setUp and tearDown method has been called.
45 * class extending MediaWikiTestCase usually override setUp and tearDown
46 * but forget to call the parent.
48 * The array format takes a method name as key and anything as a value.
49 * By asserting the key exist, we know the child class has called the
52 * This property must be private, we do not want child to override it,
53 * they should call the appropriate parent method instead.
75 protected $tablesUsed = []; // tables with data
77 private static $useTemporaryTables = true;
78 private static $reuseDB = false;
79 private static $dbSetup = false;
80 private static $oldTablePrefix = '';
83 * Original value of PHP's error_reporting setting.
87 private $phpErrorLevel;
90 * Holds the paths of temporary files/directories created through getNewTempFile,
91 * and getNewTempDirectory
95 private $tmpFiles = [];
98 * Holds original values of MediaWiki configuration settings
99 * to be restored in tearDown().
100 * See also setMwGlobals().
103 private $mwGlobals = [];
106 * Holds list of MediaWiki configuration settings to be unset in tearDown().
107 * See also setMwGlobals().
110 private $mwGlobalsToUnset = [];
113 * Holds original values of ini settings to be restored
115 * @see setIniSettings()
118 private $iniSettings = [];
121 * Holds original loggers which have been replaced by setLogger()
122 * @var LoggerInterface[]
124 private $loggers = [];
127 * The CLI arguments passed through from phpunit.php
130 private $cliArgs = [];
133 * Holds a list of services that were overridden with setService(). Used for printing an error
134 * if overrideMwServices() overrides a service that was previously set.
137 private $overriddenServices = [];
142 const DB_PREFIX
= 'unittest_';
148 protected $supportedDBs = [
154 public function __construct( $name = null, array $data = [], $dataName = '' ) {
155 parent
::__construct( $name, $data, $dataName );
157 $this->backupGlobals
= false;
158 $this->backupStaticAttributes
= false;
161 public function __destruct() {
162 // Complain if self::setUp() was called, but not self::tearDown()
163 // $this->called['setUp'] will be checked by self::testMediaWikiTestCaseParentSetupCalled()
164 if ( isset( $this->called
['setUp'] ) && !isset( $this->called
['tearDown'] ) ) {
165 throw new MWException( static::class . "::tearDown() must call parent::tearDown()" );
169 private static function initializeForStandardPhpunitEntrypointIfNeeded() {
170 if ( function_exists( 'wfRequireOnceInGlobalScope' ) ) {
171 $IP = realpath( __DIR__
. '/../..' );
172 wfRequireOnceInGlobalScope( "$IP/includes/Defines.php" );
173 wfRequireOnceInGlobalScope( "$IP/includes/DefaultSettings.php" );
174 wfRequireOnceInGlobalScope( "$IP/includes/GlobalFunctions.php" );
175 wfRequireOnceInGlobalScope( "$IP/includes/Setup.php" );
176 wfRequireOnceInGlobalScope( "$IP/tests/common/TestsAutoLoader.php" );
177 TestSetup
::applyInitialConfig();
181 public static function setUpBeforeClass() {
183 parent
::setUpBeforeClass();
184 if ( !file_exists( "$IP/LocalSettings.php" ) ) {
185 echo "File \"$IP/LocalSettings.php\" could not be found. "
186 . "Test case " . static::class . " extends " . self
::class . " "
187 . "which requires a working MediaWiki installation.\n"
188 . ( new RuntimeException() )->getTraceAsString();
191 self
::initializeForStandardPhpunitEntrypointIfNeeded();
193 // Get the original service locator
194 if ( !self
::$originalServices ) {
195 self
::$originalServices = MediaWikiServices
::getInstance();
200 * Convenience method for getting an immutable test user
204 * @param string|string[] $groups Groups the test user should be in.
207 public static function getTestUser( $groups = [] ) {
208 return TestUserRegistry
::getImmutableTestUser( $groups );
212 * Convenience method for getting a mutable test user
216 * @param string|string[] $groups Groups the test user should be added in.
219 public static function getMutableTestUser( $groups = [] ) {
220 return TestUserRegistry
::getMutableTestUser( __CLASS__
, $groups );
224 * Convenience method for getting an immutable admin test user
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 ContentHandler
::makeContent( 'UTContent', $title ),
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 $reflection = new ReflectionClass( $this );
544 // TODO: Eventually we should assert for test presence in /integration/
545 if ( strpos( $reflection->getFilename(), '/unit/' ) !== false ) {
546 $this->fail( 'This integration test should not be in "tests/phpunit/unit" !' );
548 $this->called
['setUp'] = true;
550 $this->phpErrorLevel
= intval( ini_get( 'error_reporting' ) );
552 $this->overriddenServices
= [];
554 // Cleaning up temporary files
555 foreach ( $this->tmpFiles
as $fileName ) {
556 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
558 } elseif ( is_dir( $fileName ) ) {
559 wfRecursiveRemoveDir( $fileName );
563 if ( $this->needsDB() && $this->db
) {
564 // Clean up open transactions
565 while ( $this->db
->trxLevel() > 0 ) {
566 $this->db
->rollback( __METHOD__
, 'flush' );
568 // Check for unsafe queries
569 if ( $this->db
->getType() === 'mysql' ) {
570 $this->db
->query( "SET sql_mode = 'STRICT_ALL_TABLES'", __METHOD__
);
574 // Reset all caches between tests.
575 self
::resetNonServiceCaches();
577 // XXX: reset maintenance triggers
578 // Hook into period lag checks which often happen in long-running scripts
579 $lbFactory = $this->localServices
->getDBLoadBalancerFactory();
580 Maintenance
::setLBFactoryTriggers( $lbFactory, $this->localServices
->getMainConfig() );
582 ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
585 protected function addTmpFiles( $files ) {
586 $this->tmpFiles
= array_merge( $this->tmpFiles
, (array)$files );
589 protected function tearDown() {
590 global $wgRequest, $wgSQLMode;
592 $status = ob_get_status();
593 if ( isset( $status['name'] ) &&
594 $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier'
599 $this->called
['tearDown'] = true;
600 // Cleaning up temporary files
601 foreach ( $this->tmpFiles
as $fileName ) {
602 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
604 } elseif ( is_dir( $fileName ) ) {
605 wfRecursiveRemoveDir( $fileName );
609 if ( $this->needsDB() && $this->db
) {
610 // Clean up open transactions
611 while ( $this->db
->trxLevel() > 0 ) {
612 $this->db
->rollback( __METHOD__
, 'flush' );
614 if ( $this->db
->getType() === 'mysql' ) {
615 $this->db
->query( "SET sql_mode = " . $this->db
->addQuotes( $wgSQLMode ),
620 // Clear any cached test users so they don't retain references to old services
621 TestUserRegistry
::clear();
623 // Re-enable any disabled deprecation warnings
625 // Restore mw globals
626 foreach ( $this->mwGlobals
as $key => $value ) {
627 $GLOBALS[$key] = $value;
629 foreach ( $this->mwGlobalsToUnset
as $value ) {
630 unset( $GLOBALS[$value] );
632 foreach ( $this->iniSettings
as $name => $value ) {
633 ini_set( $name, $value );
635 $this->mwGlobals
= [];
636 $this->mwGlobalsToUnset
= [];
637 $this->restoreLoggers();
639 // TODO: move global state into MediaWikiServices
640 RequestContext
::resetMain();
641 if ( session_id() !== '' ) {
642 session_write_close();
645 $wgRequest = new FauxRequest();
646 MediaWiki\Session\SessionManager
::resetCache();
647 MediaWiki\Auth\AuthManager
::resetCache();
649 $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
651 if ( $phpErrorLevel !== $this->phpErrorLevel
) {
652 ini_set( 'error_reporting', $this->phpErrorLevel
);
654 $oldHex = strtoupper( dechex( $this->phpErrorLevel
) );
655 $newHex = strtoupper( dechex( $phpErrorLevel ) );
656 $message = "PHP error_reporting setting was left dirty: "
657 . "was 0x$oldHex before test, 0x$newHex after test!";
659 $this->fail( $message );
666 * Make sure MediaWikiTestCase extending classes have called their
667 * parent setUp method
669 * With strict coverage activated in PHP_CodeCoverage, this test would be
670 * marked as risky without the following annotation (T152923).
673 final public function testMediaWikiTestCaseParentSetupCalled() {
674 $this->assertArrayHasKey( 'setUp', $this->called
,
675 static::class . '::setUp() must call parent::setUp()'
680 * Sets a service, maintaining a stashed version of the previous service to be
681 * restored in tearDown.
683 * @note Tests must not call overrideMwServices() after calling setService(), since that would
684 * lose the new service instance. Since 1.34, resetServices() can be used instead, which
685 * would reset other services, but retain any services set using setService().
686 * This means that once a service is set using this method, it cannot be reverted to
687 * the original service within the same test method. The original service is restored
688 * in tearDown after the test method has terminated.
690 * @param string $name
691 * @param object $service The service instance, or a callable that returns the service instance.
696 protected function setService( $name, $service ) {
697 if ( !$this->localServices
) {
698 throw new Exception( __METHOD__
. ' must be called after MediaWikiTestCase::run()' );
701 if ( $this->localServices
!== MediaWikiServices
::getInstance() ) {
702 throw new Exception( __METHOD__
. ' will not work because the global MediaWikiServices '
703 . 'instance has been replaced by test code.' );
706 if ( is_callable( $service ) ) {
707 $instantiator = $service;
709 $instantiator = function () use ( $service ) {
714 $this->overriddenServices
[] = $name;
716 $this->localServices
->disableService( $name );
717 $this->localServices
->redefineService(
722 self
::resetLegacyGlobals();
726 * Sets a global, maintaining a stashed version of the previous global to be
727 * restored in tearDown
729 * The key is added to the array of globals that will be reset afterwards
734 * protected function setUp() {
735 * $this->setMwGlobals( 'wgRestrictStuff', true );
738 * function testFoo() {}
740 * function testBar() {}
741 * $this->assertTrue( self::getX()->doStuff() );
743 * $this->setMwGlobals( 'wgRestrictStuff', false );
744 * $this->assertTrue( self::getX()->doStuff() );
747 * function testQuux() {}
750 * @param array|string $pairs Key to the global variable, or an array
751 * of key/value pairs.
752 * @param mixed|null $value Value to set the global to (ignored
753 * if an array is given as first argument).
755 * @note This will call resetServices().
759 protected function setMwGlobals( $pairs, $value = null ) {
760 if ( is_string( $pairs ) ) {
761 $pairs = [ $pairs => $value ];
764 $this->doStashMwGlobals( array_keys( $pairs ) );
766 foreach ( $pairs as $key => $value ) {
767 $GLOBALS[$key] = $value;
770 $this->resetServices();
774 * Set an ini setting for the duration of the test
775 * @param string $name Name of the setting
776 * @param string $value Value to set
779 protected function setIniSetting( $name, $value ) {
780 $original = ini_get( $name );
781 $this->iniSettings
[$name] = $original;
782 ini_set( $name, $value );
786 * Check if we can back up a value by performing a shallow copy.
787 * Values which fail this test are copied recursively.
789 * @param mixed $value
790 * @return bool True if a shallow copy will do; false if a deep copy
793 private static function canShallowCopy( $value ) {
794 if ( is_scalar( $value ) ||
$value === null ) {
797 if ( is_array( $value ) ) {
798 foreach ( $value as $subValue ) {
799 if ( !is_scalar( $subValue ) && $subValue !== null ) {
808 private function doStashMwGlobals( $globalKeys ) {
809 if ( is_string( $globalKeys ) ) {
810 $globalKeys = [ $globalKeys ];
813 foreach ( $globalKeys as $globalKey ) {
814 // NOTE: make sure we only save the global once or a second call to
815 // setMwGlobals() on the same global would override the original
818 !array_key_exists( $globalKey, $this->mwGlobals
) &&
819 !array_key_exists( $globalKey, $this->mwGlobalsToUnset
)
821 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
822 $this->mwGlobalsToUnset
[$globalKey] = $globalKey;
825 // NOTE: we serialize then unserialize the value in case it is an object
826 // this stops any objects being passed by reference. We could use clone
827 // and if is_object but this does account for objects within objects!
828 if ( self
::canShallowCopy( $GLOBALS[$globalKey] ) ) {
829 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
831 // Many MediaWiki types are safe to clone. These are the
832 // ones that are most commonly stashed.
833 $GLOBALS[$globalKey] instanceof Language ||
834 $GLOBALS[$globalKey] instanceof User ||
835 $GLOBALS[$globalKey] instanceof FauxRequest
837 $this->mwGlobals
[$globalKey] = clone $GLOBALS[$globalKey];
838 } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
839 // Serializing Closure only gives a warning on HHVM while
840 // it throws an Exception on Zend.
841 // Workaround for https://github.com/facebook/hhvm/issues/6206
842 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
845 $this->mwGlobals
[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
846 } catch ( Exception
$e ) {
847 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
856 * @param int $maxDepth
860 private function containsClosure( $var, $maxDepth = 15 ) {
861 if ( $var instanceof Closure
) {
864 if ( !is_array( $var ) ||
$maxDepth === 0 ) {
868 foreach ( $var as $value ) {
869 if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
877 * Merges the given values into a MW global array variable.
878 * Useful for setting some entries in a configuration array, instead of
879 * setting the entire array.
881 * @param string $name The name of the global, as in wgFooBar
882 * @param array $values The array containing the entries to set in that global
884 * @throws MWException If the designated global is not an array.
886 * @note This will call resetServices().
890 protected function mergeMwGlobalArrayValue( $name, $values ) {
891 if ( !isset( $GLOBALS[$name] ) ) {
894 if ( !is_array( $GLOBALS[$name] ) ) {
895 throw new MWException( "MW global $name is not an array." );
898 // NOTE: do not use array_merge, it screws up for numeric keys.
899 $merged = $GLOBALS[$name];
900 foreach ( $values as $k => $v ) {
905 $this->setMwGlobals( $name, $merged );
909 * Resets service instances in the global instance of MediaWikiServices.
911 * In contrast to overrideMwServices(), this does not create a new MediaWikiServices instance,
912 * and it preserves any service instances set via setService().
914 * The primary use case for this method is to allow changes to global configuration variables
915 * to take effect on services that get initialized based on these global configuration
916 * variables. Similarly, it may be necessary to call resetServices() after calling setService(),
917 * so the newly set service gets picked up by any other service definitions that may use it.
919 * @see MediaWikiServices::resetServiceForTesting.
923 protected function resetServices() {
924 // Reset but don't destroy service instances supplied via setService().
925 foreach ( $this->overriddenServices
as $name ) {
926 $this->localServices
->resetServiceForTesting( $name, false );
929 // Reset all services with the destroy flag set.
930 // This will not have any effect on services that had already been reset above.
931 foreach ( $this->localServices
->getServiceNames() as $name ) {
932 $this->localServices
->resetServiceForTesting( $name, true );
935 self
::resetLegacyGlobals();
936 Language
::clearCaches();
940 * Installs a new global instance of MediaWikiServices, allowing test cases to override
941 * settings and services.
943 * This method can be used to set up specific services or configuration as a fixture.
944 * It should not be used to reset services in between stages of a test - instead, the test
945 * should either be split, or resetServices() should be used.
947 * If called with no parameters, this method restores all services to their default state.
948 * This is done automatically before each test to isolate tests from any modification
949 * to settings and services that may have been applied by previous tests.
950 * That means that the effect of calling overrideMwServices() is undone before the next
951 * call to a test method.
953 * @note Calling this after having called setService() in the same test method (or the
954 * associated setUp) will result in an MWException.
955 * Tests should use either overrideMwServices() or setService(), but not mix both.
956 * Since 1.34, resetServices() is available as an alternative compatible with setService().
960 * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
962 * @param callable[] $services An associative array of services to re-define. Keys are service
963 * names, values are callables.
965 * @return MediaWikiServices
966 * @throws MWException
968 protected function overrideMwServices(
969 Config
$configOverrides = null, array $services = []
971 if ( $this->overriddenServices
) {
972 throw new MWException(
973 'The following services were set and are now being unset by overrideMwServices: ' .
974 implode( ', ', $this->overriddenServices
)
977 $newInstance = self
::installMockMwServices( $configOverrides );
979 if ( $this->localServices
) {
980 $this->localServices
->destroy();
983 $this->localServices
= $newInstance;
985 foreach ( $services as $name => $callback ) {
986 $newInstance->redefineService( $name, $callback );
989 self
::resetLegacyGlobals();
995 * Creates a new "mock" MediaWikiServices instance, and installs it.
996 * This effectively resets all cached states in services, with the exception of
997 * the ConfigFactory and the DBLoadBalancerFactory service, which are inherited from
998 * the original MediaWikiServices.
1000 * @note The new original MediaWikiServices instance can later be restored by calling
1001 * restoreMwServices(). That original is determined by the first call to this method, or
1002 * by setUpBeforeClass, whichever is called first. The caller is responsible for managing
1003 * and, when appropriate, destroying any other MediaWikiServices instances that may get
1004 * replaced when calling this method.
1006 * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
1009 * @return MediaWikiServices the new mock service locator.
1011 public static function installMockMwServices( Config
$configOverrides = null ) {
1012 // Make sure we have the original service locator
1013 if ( !self
::$originalServices ) {
1014 self
::$originalServices = MediaWikiServices
::getInstance();
1017 if ( !$configOverrides ) {
1018 $configOverrides = new HashConfig();
1021 $oldConfigFactory = self
::$originalServices->getConfigFactory();
1022 $oldLoadBalancerFactory = self
::$originalServices->getDBLoadBalancerFactory();
1024 $testConfig = self
::makeTestConfig( null, $configOverrides );
1025 $newServices = new MediaWikiServices( $testConfig );
1027 // Load the default wiring from the specified files.
1028 // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
1029 $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
1030 $newServices->loadWiringFiles( $wiringFiles );
1032 // Provide a traditional hook point to allow extensions to configure services.
1033 Hooks
::run( 'MediaWikiServices', [ $newServices ] );
1035 // Use bootstrap config for all configuration.
1036 // This allows config overrides via global variables to take effect.
1037 $bootstrapConfig = $newServices->getBootstrapConfig();
1038 $newServices->resetServiceForTesting( 'ConfigFactory' );
1039 $newServices->redefineService(
1041 self
::makeTestConfigFactoryInstantiator(
1043 [ 'main' => $bootstrapConfig ]
1046 $newServices->resetServiceForTesting( 'DBLoadBalancerFactory' );
1047 $newServices->redefineService(
1048 'DBLoadBalancerFactory',
1049 function ( MediaWikiServices
$services ) use ( $oldLoadBalancerFactory ) {
1050 return $oldLoadBalancerFactory;
1054 MediaWikiServices
::forceGlobalInstance( $newServices );
1056 self
::resetLegacyGlobals();
1058 return $newServices;
1062 * Restores the original, non-mock MediaWikiServices instance.
1063 * The previously active MediaWikiServices instance is destroyed,
1064 * if it is different from the original that is to be restored.
1066 * @note this if for internal use by test framework code. It should never be
1067 * called from inside a test case, a data provider, or a setUp or tearDown method.
1069 * @return bool true if the original service locator was restored,
1070 * false if there was nothing too do.
1072 public static function restoreMwServices() {
1073 if ( !self
::$originalServices ) {
1077 $currentServices = MediaWikiServices
::getInstance();
1079 if ( self
::$originalServices === $currentServices ) {
1083 MediaWikiServices
::forceGlobalInstance( self
::$originalServices );
1084 $currentServices->destroy();
1086 self
::resetLegacyGlobals();
1092 * If legacy globals such as $wgParser or $wgContLang have been unstubbed, replace them with
1093 * fresh ones so they pick up any config changes. They're deprecated, but we still support them
1096 private static function resetLegacyGlobals() {
1097 // phpcs:ignore MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgParser
1098 global $wgParser, $wgContLang;
1099 if ( !( $wgParser instanceof StubObject
) ) {
1100 $wgParser = new StubObject( 'wgParser', function () {
1101 return MediaWikiServices
::getInstance()->getParser();
1104 if ( !( $wgContLang instanceof StubObject
) ) {
1105 $wgContlang = new StubObject( 'wgContLang', function () {
1106 return MediaWikiServices
::getInstance()->getContLang();
1113 * @param string|Language $lang
1115 public function setUserLang( $lang ) {
1116 RequestContext
::getMain()->setLanguage( $lang );
1117 $this->setMwGlobals( 'wgLang', RequestContext
::getMain()->getLanguage() );
1121 * @deprecated since 1.34, use setMwGlobals( 'wgLanguageCode' ) to set the code or
1122 * setService( 'ContentLanguage' ) to set an object
1124 * @param string|Language $lang
1126 public function setContentLang( $lang ) {
1127 if ( $lang instanceof Language
) {
1128 // Set to the exact object requested
1129 $this->setService( 'ContentLanguage', $lang );
1130 $this->setMwGlobals( 'wgLanguageCode', $lang->getCode() );
1132 $this->setMwGlobals( 'wgLanguageCode', $lang );
1137 * Alters $wgGroupPermissions for the duration of the test. Can be called
1138 * with an array, like
1139 * [ '*' => [ 'read' => false ], 'user' => [ 'read' => false ] ]
1140 * or three values to set a single permission, like
1141 * $this->setGroupPermissions( '*', 'read', false );
1143 * @note This will call resetServices().
1146 * @param array|string $newPerms Either an array of permissions to change,
1147 * in which case the next two parameters are ignored; or a single string
1148 * identifying a group, to use with the next two parameters.
1149 * @param string|null $newKey
1150 * @param mixed|null $newValue
1152 public function setGroupPermissions( $newPerms, $newKey = null, $newValue = null ) {
1153 global $wgGroupPermissions;
1155 if ( is_string( $newPerms ) ) {
1156 $newPerms = [ $newPerms => [ $newKey => $newValue ] ];
1159 $newPermissions = $wgGroupPermissions;
1160 foreach ( $newPerms as $group => $permissions ) {
1161 foreach ( $permissions as $key => $value ) {
1162 $newPermissions[$group][$key] = $value;
1166 $this->setMwGlobals( 'wgGroupPermissions', $newPermissions );
1170 * Overrides specific user permissions until services are reloaded
1175 * @param string[]|string $permissions
1179 public function overrideUserPermissions( $user, $permissions = [] ) {
1180 MediaWikiServices
::getInstance()->getPermissionManager()->overrideUserRightsForTesting(
1187 * Sets the logger for a specified channel, for the duration of the test.
1189 * @param string $channel
1190 * @param LoggerInterface $logger
1192 protected function setLogger( $channel, LoggerInterface
$logger ) {
1193 // TODO: Once loggers are managed by MediaWikiServices, use
1194 // resetServiceForTesting() to set loggers.
1196 $provider = LoggerFactory
::getProvider();
1197 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
1198 $singletons = $wrappedProvider->singletons
;
1199 if ( $provider instanceof MonologSpi
) {
1200 if ( !isset( $this->loggers
[$channel] ) ) {
1201 $this->loggers
[$channel] = $singletons['loggers'][$channel] ??
null;
1203 $singletons['loggers'][$channel] = $logger;
1204 } elseif ( $provider instanceof LegacySpi ||
$provider instanceof LogCapturingSpi
) {
1205 if ( !isset( $this->loggers
[$channel] ) ) {
1206 $this->loggers
[$channel] = $singletons[$channel] ??
null;
1208 $singletons[$channel] = $logger;
1210 throw new LogicException( __METHOD__
. ': setting a logger for ' . get_class( $provider )
1211 . ' is not implemented' );
1213 $wrappedProvider->singletons
= $singletons;
1217 * Restores loggers replaced by setLogger().
1220 private function restoreLoggers() {
1221 $provider = LoggerFactory
::getProvider();
1222 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
1223 $singletons = $wrappedProvider->singletons
;
1224 foreach ( $this->loggers
as $channel => $logger ) {
1225 if ( $provider instanceof MonologSpi
) {
1226 if ( $logger === null ) {
1227 unset( $singletons['loggers'][$channel] );
1229 $singletons['loggers'][$channel] = $logger;
1231 } elseif ( $provider instanceof LegacySpi ||
$provider instanceof LogCapturingSpi
) {
1232 if ( $logger === null ) {
1233 unset( $singletons[$channel] );
1235 $singletons[$channel] = $logger;
1239 $wrappedProvider->singletons
= $singletons;
1240 $this->loggers
= [];
1247 public function dbPrefix() {
1248 return self
::getTestPrefixFor( $this->db
);
1252 * @param IDatabase $db
1256 public static function getTestPrefixFor( IDatabase
$db ) {
1257 return self
::DB_PREFIX
;
1264 public function needsDB() {
1265 // If the test says it uses database tables, it needs the database
1266 return $this->tablesUsed ||
$this->isTestInDatabaseGroup();
1270 * Insert a new page.
1272 * Should be called from addDBData().
1274 * @since 1.25 ($namespace in 1.28)
1275 * @param string|Title $pageName Page name or title
1276 * @param string $text Page's content
1277 * @param int|null $namespace Namespace id (name cannot already contain namespace)
1278 * @param User|null $user If null, static::getTestSysop()->getUser() is used.
1279 * @return array Title object and page id
1280 * @throws MWException If this test cases's needsDB() method doesn't return true.
1281 * Test cases can use "@group Database" to enable database test support,
1282 * or list the tables under testing in $this->tablesUsed, or override the
1285 protected function insertPage(
1287 $text = 'Sample page for unit test.',
1291 if ( !$this->needsDB() ) {
1292 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
1293 ' method should return true. Use @group Database or $this->tablesUsed.' );
1296 if ( is_string( $pageName ) ) {
1297 $title = Title
::newFromText( $pageName, $namespace );
1303 $user = static::getTestSysop()->getUser();
1305 $comment = __METHOD__
. ': Sample page for unit test.';
1307 $page = WikiPage
::factory( $title );
1308 $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $comment, 0, false, $user );
1312 'id' => $page->getId(),
1317 * Stub. If a test suite needs to add additional data to the database, it should
1318 * implement this method and do so. This method is called once per test suite
1319 * (i.e. once per class).
1321 * Note data added by this method may be removed by resetDB() depending on
1322 * the contents of $tablesUsed.
1324 * To add additional data between test function runs, override prepareDB().
1331 public function addDBDataOnce() {
1335 * Stub. Subclasses may override this to prepare the database.
1336 * Called before every test run (test function or data set).
1338 * @see addDBDataOnce()
1343 public function addDBData() {
1349 protected function addCoreDBData() {
1350 SiteStatsInit
::doPlaceholderInit();
1352 User
::resetIdByNameCache();
1355 $user = static::getTestSysop()->getUser();
1357 // Make 1 page with 1 revision
1358 $page = WikiPage
::factory( Title
::newFromText( 'UTPage' ) );
1359 if ( $page->getId() == 0 ) {
1360 $page->doEditContent(
1361 new WikitextContent( 'UTContent' ),
1363 EDIT_NEW | EDIT_SUPPRESS_RC
,
1367 // an edit always attempt to purge backlink links such as history
1368 // pages. That is unnecessary.
1369 JobQueueGroup
::singleton()->get( 'htmlCacheUpdate' )->delete();
1370 // WikiPages::doEditUpdates randomly adds RC purges
1371 JobQueueGroup
::singleton()->get( 'recentChangesUpdate' )->delete();
1373 // doEditContent() probably started the session via
1374 // User::loadFromSession(). Close it now.
1375 if ( session_id() !== '' ) {
1376 session_write_close();
1383 * Restores MediaWiki to using the table set (table prefix) it was using before
1384 * setupTestDB() was called. Useful if we need to perform database operations
1385 * after the test run has finished (such as saving logs or profiling info).
1387 * This is called by phpunit/bootstrap.php after the last test.
1391 public static function teardownTestDB() {
1392 global $wgJobClasses;
1394 if ( !self
::$dbSetup ) {
1398 Hooks
::run( 'UnitTestsBeforeDatabaseTeardown' );
1400 foreach ( $wgJobClasses as $type => $class ) {
1401 // Delete any jobs under the clone DB (or old prefix in other stores)
1402 JobQueueGroup
::singleton()->get( $type )->delete();
1405 // T219673: close any connections from code that failed to call reuseConnection()
1406 // or is still holding onto a DBConnRef instance (e.g. in a singleton).
1407 MediaWikiServices
::getInstance()->getDBLoadBalancerFactory()->closeAll();
1408 CloneDatabase
::changePrefix( self
::$oldTablePrefix );
1410 self
::$oldTablePrefix = false;
1411 self
::$dbSetup = false;
1415 * Setups a database with cloned tables using the given prefix.
1417 * If reuseDB is true and certain conditions apply, it will just change the prefix.
1418 * Otherwise, it will clone the tables and change the prefix.
1420 * @param IMaintainableDatabase $db Database to use
1421 * @param string|null $prefix Prefix to use for test tables. If not given, the prefix is determined
1422 * automatically for $db.
1423 * @return bool True if tables were cloned, false if only the prefix was changed
1425 protected static function setupDatabaseWithTestPrefix(
1426 IMaintainableDatabase
$db,
1429 if ( $prefix === null ) {
1430 $prefix = self
::getTestPrefixFor( $db );
1433 if ( !self
::$useTemporaryTables && self
::$reuseDB ) {
1434 $db->tablePrefix( $prefix );
1438 if ( !isset( $db->_originalTablePrefix
) ) {
1439 $oldPrefix = $db->tablePrefix();
1440 if ( $oldPrefix === $prefix ) {
1441 // table already has the correct prefix, but presumably no cloned tables
1442 $oldPrefix = self
::$oldTablePrefix;
1445 $db->tablePrefix( $oldPrefix );
1446 $tablesCloned = self
::listTables( $db );
1447 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix, $oldPrefix );
1448 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1449 $dbClone->cloneTableStructure();
1451 $db->tablePrefix( $prefix );
1452 $db->_originalTablePrefix
= $oldPrefix;
1454 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
1455 $lb->setTempTablesOnlyMode( self
::$useTemporaryTables, $lb->getLocalDomainID() );
1462 * Set up all test DBs
1464 public function setupAllTestDBs() {
1467 self
::$oldTablePrefix = $wgDBprefix;
1469 $testPrefix = $this->dbPrefix();
1471 // switch to a temporary clone of the database
1472 self
::setupTestDB( $this->db
, $testPrefix );
1474 if ( self
::isUsingExternalStoreDB() ) {
1475 self
::setupExternalStoreTestDBs( $testPrefix );
1478 // NOTE: Change the prefix in the LBFactory and $wgDBprefix, to prevent
1479 // *any* database connections to operate on live data.
1480 CloneDatabase
::changePrefix( $testPrefix );
1484 * Creates an empty skeleton of the wiki database by cloning its structure
1485 * to equivalent tables using the given $prefix. Then sets MediaWiki to
1486 * use the new set of tables (aka schema) instead of the original set.
1488 * This is used to generate a dummy table set, typically consisting of temporary
1489 * tables, that will be used by tests instead of the original wiki database tables.
1493 * @note the original table prefix is stored in self::$oldTablePrefix. This is used
1494 * by teardownTestDB() to return the wiki to using the original table set.
1496 * @note this method only works when first called. Subsequent calls have no effect,
1497 * even if using different parameters.
1499 * @param IMaintainableDatabase $db The database connection
1500 * @param string $prefix The prefix to use for the new table set (aka schema).
1502 * @throws MWException If the database table prefix is already $prefix
1504 public static function setupTestDB( IMaintainableDatabase
$db, $prefix ) {
1505 if ( self
::$dbSetup ) {
1509 if ( $db->tablePrefix() === $prefix ) {
1510 throw new MWException(
1511 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
1514 // TODO: the below should be re-written as soon as LBFactory, LoadBalancer,
1515 // and Database no longer use global state.
1517 self
::$dbSetup = true;
1519 if ( !self
::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
1523 Hooks
::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
1527 * Clones the External Store database(s) for testing
1529 * @param string|null $testPrefix Prefix for test tables. Will be determined automatically
1532 protected static function setupExternalStoreTestDBs( $testPrefix = null ) {
1533 $connections = self
::getExternalStoreDatabaseConnections();
1534 foreach ( $connections as $dbw ) {
1535 self
::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
1540 * Gets master database connections for all of the ExternalStoreDB
1541 * stores configured in $wgDefaultExternalStore.
1543 * @return Database[] Array of Database master connections
1545 protected static function getExternalStoreDatabaseConnections() {
1546 global $wgDefaultExternalStore;
1548 /** @var ExternalStoreDB $externalStoreDB */
1549 $externalStoreDB = ExternalStore
::getStoreObject( 'DB' );
1550 $defaultArray = (array)$wgDefaultExternalStore;
1552 foreach ( $defaultArray as $url ) {
1553 if ( strpos( $url, 'DB://' ) === 0 ) {
1554 list( $proto, $cluster ) = explode( '://', $url, 2 );
1555 // Avoid getMaster() because setupDatabaseWithTestPrefix()
1556 // requires Database instead of plain DBConnRef/IDatabase
1557 $dbws[] = $externalStoreDB->getMaster( $cluster );
1565 * Check whether ExternalStoreDB is being used
1567 * @return bool True if it's being used
1569 protected static function isUsingExternalStoreDB() {
1570 global $wgDefaultExternalStore;
1571 if ( !$wgDefaultExternalStore ) {
1575 $defaultArray = (array)$wgDefaultExternalStore;
1576 foreach ( $defaultArray as $url ) {
1577 if ( strpos( $url, 'DB://' ) === 0 ) {
1586 * @throws LogicException if the given database connection is not a set up to use
1589 * @since 1.31 this is no longer private.
1591 protected function ensureMockDatabaseConnection( IDatabase
$db ) {
1592 if ( $db->tablePrefix() !== $this->dbPrefix() ) {
1593 throw new LogicException(
1594 'Trying to delete mock tables, but table prefix does not indicate a mock database.'
1599 private static $schemaOverrideDefaults = [
1607 * Stub. If a test suite needs to test against a specific database schema, it should
1608 * override this method and return the appropriate information from it.
1610 * 'create', 'drop' and 'alter' in the returned array should list all the tables affected
1611 * by the 'scripts', even if the test is only interested in a subset of them, otherwise
1612 * the overrides may not be fully cleaned up, leading to errors later.
1614 * @param IMaintainableDatabase $db The DB connection to use for the mock schema.
1615 * May be used to check the current state of the schema, to determine what
1616 * overrides are needed.
1618 * @return array An associative array with the following fields:
1619 * - 'scripts': any SQL scripts to run. If empty or not present, schema overrides are skipped.
1620 * - 'create': A list of tables created (may or may not exist in the original schema).
1621 * - 'drop': A list of tables dropped (expected to be present in the original schema).
1622 * - 'alter': A list of tables altered (expected to be present in the original schema).
1624 protected function getSchemaOverrides( IMaintainableDatabase
$db ) {
1629 * Undoes the specified schema overrides..
1630 * Called once per test class, just before addDataOnce().
1632 * @param IMaintainableDatabase $db
1633 * @param array $oldOverrides
1635 private function undoSchemaOverrides( IMaintainableDatabase
$db, $oldOverrides ) {
1636 $this->ensureMockDatabaseConnection( $db );
1638 $oldOverrides = $oldOverrides + self
::$schemaOverrideDefaults;
1639 $originalTables = $this->listOriginalTables( $db );
1641 // Drop tables that need to be restored or removed.
1642 $tablesToDrop = array_merge( $oldOverrides['create'], $oldOverrides['alter'] );
1644 // Restore tables that have been dropped or created or altered,
1645 // if they exist in the original schema.
1646 $tablesToRestore = array_merge( $tablesToDrop, $oldOverrides['drop'] );
1647 $tablesToRestore = array_intersect( $originalTables, $tablesToRestore );
1649 if ( $tablesToDrop ) {
1650 $this->dropMockTables( $db, $tablesToDrop );
1653 if ( $tablesToRestore ) {
1654 $this->recloneMockTables( $db, $tablesToRestore );
1656 // Reset the restored tables, mainly for the side effect of
1657 // re-calling $this->addCoreDBData() if necessary.
1658 $this->resetDB( $db, $tablesToRestore );
1663 * Applies the schema overrides returned by getSchemaOverrides(),
1664 * after undoing any previously applied schema overrides.
1665 * Called once per test class, just before addDataOnce().
1667 private function setUpSchema( IMaintainableDatabase
$db ) {
1668 // Undo any active overrides.
1669 $oldOverrides = $db->_schemaOverrides ?? self
::$schemaOverrideDefaults;
1671 if ( $oldOverrides['alter'] ||
$oldOverrides['create'] ||
$oldOverrides['drop'] ) {
1672 $this->undoSchemaOverrides( $db, $oldOverrides );
1673 unset( $db->_schemaOverrides
);
1676 // Determine new overrides.
1677 $overrides = $this->getSchemaOverrides( $db ) + self
::$schemaOverrideDefaults;
1679 $extraKeys = array_diff(
1680 array_keys( $overrides ),
1681 array_keys( self
::$schemaOverrideDefaults )
1685 throw new InvalidArgumentException(
1686 'Schema override contains extra keys: ' . var_export( $extraKeys, true )
1690 if ( !$overrides['scripts'] ) {
1691 // no scripts to run
1695 if ( !$overrides['create'] && !$overrides['drop'] && !$overrides['alter'] ) {
1696 throw new InvalidArgumentException(
1697 'Schema override scripts given, but no tables are declared to be '
1698 . 'created, dropped or altered.'
1702 $this->ensureMockDatabaseConnection( $db );
1704 // Drop the tables that will be created by the schema scripts.
1705 $originalTables = $this->listOriginalTables( $db );
1706 $tablesToDrop = array_intersect( $originalTables, $overrides['create'] );
1708 if ( $tablesToDrop ) {
1709 $this->dropMockTables( $db, $tablesToDrop );
1712 // Run schema override scripts.
1713 foreach ( $overrides['scripts'] as $script ) {
1720 return $this->mungeSchemaUpdateQuery( $cmd );
1725 $db->_schemaOverrides
= $overrides;
1728 private function mungeSchemaUpdateQuery( $cmd ) {
1729 return self
::$useTemporaryTables
1730 ?
preg_replace( '/\bCREATE\s+TABLE\b/i', 'CREATE TEMPORARY TABLE', $cmd )
1735 * Drops the given mock tables.
1737 * @param IMaintainableDatabase $db
1738 * @param array $tables
1740 private function dropMockTables( IMaintainableDatabase
$db, array $tables ) {
1741 $this->ensureMockDatabaseConnection( $db );
1743 foreach ( $tables as $tbl ) {
1744 $tbl = $db->tableName( $tbl );
1745 $db->query( "DROP TABLE IF EXISTS $tbl", __METHOD__
);
1750 * Lists all tables in the live database schema, without a prefix.
1752 * @param IMaintainableDatabase $db
1755 private function listOriginalTables( IMaintainableDatabase
$db ) {
1756 if ( !isset( $db->_originalTablePrefix
) ) {
1757 throw new LogicException( 'No original table prefix know, cannot list tables!' );
1760 $originalTables = $db->listTables( $db->_originalTablePrefix
, __METHOD__
);
1762 $unittestPrefixRegex = '/^' . preg_quote( $this->dbPrefix(), '/' ) . '/';
1763 $originalPrefixRegex = '/^' . preg_quote( $db->_originalTablePrefix
, '/' ) . '/';
1765 $originalTables = array_filter(
1767 function ( $pt ) use ( $unittestPrefixRegex ) {
1768 return !preg_match( $unittestPrefixRegex, $pt );
1772 $originalTables = array_map(
1773 function ( $pt ) use ( $originalPrefixRegex ) {
1774 return preg_replace( $originalPrefixRegex, '', $pt );
1779 return array_unique( $originalTables );
1783 * Re-clones the given mock tables to restore them based on the live database schema.
1784 * The tables listed in $tables are expected to currently not exist, so dropMockTables()
1785 * should be called first.
1787 * @param IMaintainableDatabase $db
1788 * @param array $tables
1790 private function recloneMockTables( IMaintainableDatabase
$db, array $tables ) {
1791 $this->ensureMockDatabaseConnection( $db );
1793 if ( !isset( $db->_originalTablePrefix
) ) {
1794 throw new LogicException( 'No original table prefix know, cannot restore tables!' );
1797 $originalTables = $this->listOriginalTables( $db );
1798 $tables = array_intersect( $tables, $originalTables );
1800 $dbClone = new CloneDatabase( $db, $tables, $db->tablePrefix(), $db->_originalTablePrefix
);
1801 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1802 $dbClone->cloneTableStructure();
1804 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
1805 $lb->setTempTablesOnlyMode( self
::$useTemporaryTables, $lb->getLocalDomainID() );
1809 * Empty all tables so they can be repopulated for tests
1811 * @param Database $db|null Database to reset
1812 * @param array $tablesUsed Tables to reset
1814 private function resetDB( $db, $tablesUsed ) {
1816 $userTables = [ 'user', 'user_groups', 'user_properties', 'actor' ];
1818 'page', 'revision', 'ip_changes', 'revision_comment_temp', 'comment', 'archive',
1819 'revision_actor_temp', 'slots', 'content', 'content_models', 'slot_roles',
1821 $coreDBDataTables = array_merge( $userTables, $pageTables );
1823 // If any of the user or page tables were marked as used, we should clear all of them.
1824 if ( array_intersect( $tablesUsed, $userTables ) ) {
1825 $tablesUsed = array_unique( array_merge( $tablesUsed, $userTables ) );
1826 TestUserRegistry
::clear();
1828 // Reset $wgUser, which is probably 127.0.0.1, as its loaded data is probably not valid
1829 // @todo Should we start setting $wgUser to something nondeterministic
1830 // to encourage tests to be updated to not depend on it?
1832 $wgUser->clearInstanceCache( $wgUser->mFrom
);
1834 if ( array_intersect( $tablesUsed, $pageTables ) ) {
1835 $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
1838 // Postgres uses mwuser/pagecontent
1839 // instead of user/text. But Postgres does not remap the
1840 // table name in tableExists(), so we mark the real table
1841 // names as being used.
1842 if ( $db->getType() === 'postgres' ) {
1843 if ( in_array( 'user', $tablesUsed ) ) {
1844 $tablesUsed[] = 'mwuser';
1846 if ( in_array( 'text', $tablesUsed ) ) {
1847 $tablesUsed[] = 'pagecontent';
1851 foreach ( $tablesUsed as $tbl ) {
1852 $this->truncateTable( $tbl, $db );
1855 if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
1856 // Reset services that may contain information relating to the truncated tables
1857 $this->overrideMwServices();
1858 // Re-add core DB data that was deleted
1859 $this->addCoreDBData();
1865 * Empties the given table and resets any auto-increment counters.
1866 * Will also purge caches associated with some well known tables.
1867 * If the table is not know, this method just returns.
1869 * @param string $tableName
1870 * @param IDatabase|null $db
1872 protected function truncateTable( $tableName, IDatabase
$db = null ) {
1877 if ( !$db->tableExists( $tableName ) ) {
1881 $truncate = in_array( $db->getType(), [ 'mysql' ] );
1884 $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tableName ), __METHOD__
);
1886 $db->delete( $tableName, '*', __METHOD__
);
1889 if ( $db instanceof DatabasePostgres ||
$db instanceof DatabaseSqlite
) {
1890 // Reset the table's sequence too.
1891 $db->resetSequenceForTable( $tableName, __METHOD__
);
1894 // re-initialize site_stats table
1895 if ( $tableName === 'site_stats' ) {
1896 SiteStatsInit
::doPlaceholderInit();
1900 private static function unprefixTable( &$tableName, $ind, $prefix ) {
1901 $tableName = substr( $tableName, strlen( $prefix ) );
1904 private static function isNotUnittest( $table ) {
1905 return strpos( $table, self
::DB_PREFIX
) !== 0;
1911 * @param IMaintainableDatabase $db
1915 public static function listTables( IMaintainableDatabase
$db ) {
1916 $prefix = $db->tablePrefix();
1917 $tables = $db->listTables( $prefix, __METHOD__
);
1919 if ( $db->getType() === 'mysql' ) {
1920 static $viewListCache = null;
1921 if ( $viewListCache === null ) {
1922 $viewListCache = $db->listViews( null, __METHOD__
);
1924 // T45571: cannot clone VIEWs under MySQL
1925 $tables = array_diff( $tables, $viewListCache );
1927 array_walk( $tables, [ __CLASS__
, 'unprefixTable' ], $prefix );
1929 // Don't duplicate test tables from the previous fataled run
1930 $tables = array_filter( $tables, [ __CLASS__
, 'isNotUnittest' ] );
1932 if ( $db->getType() == 'sqlite' ) {
1933 $tables = array_flip( $tables );
1934 // these are subtables of searchindex and don't need to be duped/dropped separately
1935 unset( $tables['searchindex_content'] );
1936 unset( $tables['searchindex_segdir'] );
1937 unset( $tables['searchindex_segments'] );
1938 $tables = array_flip( $tables );
1945 * Copy test data from one database connection to another.
1947 * This should only be used for small data sets.
1949 * @param IDatabase $source
1950 * @param IDatabase $target
1952 public function copyTestData( IDatabase
$source, IDatabase
$target ) {
1953 if ( $this->db
->getType() === 'sqlite' ) {
1954 // SQLite uses a non-temporary copy of the searchindex table for testing,
1955 // which gets deleted and re-created when setting up the secondary connection,
1956 // causing "Error 17" when trying to copy the data. See T191863#4130112.
1957 throw new RuntimeException(
1958 'Setting up a secondary database connection with test data is currently not'
1959 . 'with SQLite. You may want to use markTestSkippedIfDbType() to bypass this issue.'
1963 $tables = self
::listOriginalTables( $source );
1965 foreach ( $tables as $table ) {
1966 $res = $source->select( $table, '*', [], __METHOD__
);
1969 foreach ( $res as $row ) {
1970 $allRows[] = (array)$row;
1973 $target->insert( $table, $allRows, __METHOD__
, [ 'IGNORE' ] );
1978 * @throws MWException
1981 protected function checkDbIsSupported() {
1982 if ( !in_array( $this->db
->getType(), $this->supportedDBs
) ) {
1983 throw new MWException( $this->db
->getType() . " is not currently supported for unit testing." );
1989 * @param string $offset
1992 public function getCliArg( $offset ) {
1993 return $this->cliArgs
[$offset] ??
null;
1998 * @param string $offset
1999 * @param mixed $value
2001 public function setCliArg( $offset, $value ) {
2002 $this->cliArgs
[$offset] = $value;
2006 * Don't throw a warning if $function is deprecated and called later
2010 * @param string $function
2012 public function hideDeprecated( $function ) {
2013 Wikimedia\
suppressWarnings();
2014 wfDeprecated( $function );
2015 Wikimedia\restoreWarnings
();
2019 * Asserts that the given database query yields the rows given by $expectedRows.
2020 * The expected rows should be given as indexed (not associative) arrays, with
2021 * the values given in the order of the columns in the $fields parameter.
2022 * Note that the rows are sorted by the columns given in $fields.
2026 * @param string|array $table The table(s) to query
2027 * @param string|array $fields The columns to include in the result (and to sort by)
2028 * @param string|array $condition "where" condition(s)
2029 * @param array $expectedRows An array of arrays giving the expected rows.
2030 * @param array $options Options for the query
2031 * @param array $join_conds Join conditions for the query
2033 * @throws MWException If this test cases's needsDB() method doesn't return true.
2034 * Test cases can use "@group Database" to enable database test support,
2035 * or list the tables under testing in $this->tablesUsed, or override the
2038 protected function assertSelect(
2039 $table, $fields, $condition, array $expectedRows, array $options = [], array $join_conds = []
2041 if ( !$this->needsDB() ) {
2042 throw new MWException( 'When testing database state, the test cases\'s needDB()' .
2043 ' method should return true. Use @group Database or $this->tablesUsed.' );
2046 $db = wfGetDB( DB_REPLICA
);
2053 $options +
[ 'ORDER BY' => $fields ],
2056 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
2060 foreach ( $expectedRows as $expected ) {
2061 $r = $res->fetchRow();
2062 self
::stripStringKeys( $r );
2065 $this->assertNotEmpty( $r, "row #$i missing" );
2067 $this->assertEquals( $expected, $r, "row #$i mismatches" );
2070 $r = $res->fetchRow();
2071 self
::stripStringKeys( $r );
2073 $this->assertFalse( $r, "found extra row (after #$i)" );
2077 * Utility method taking an array of elements and wrapping
2078 * each element in its own array. Useful for data providers
2079 * that only return a single argument.
2083 * @param array $elements
2087 protected function arrayWrap( array $elements ) {
2089 function ( $element ) {
2090 return [ $element ];
2097 * Assert that two arrays are equal. By default this means that both arrays need to hold
2098 * the same set of values. Using additional arguments, order and associated key can also
2099 * be set as relevant.
2103 * @param array $expected
2104 * @param array $actual
2105 * @param bool $ordered If the order of the values should match
2106 * @param bool $named If the keys should match
2108 protected function assertArrayEquals( array $expected, array $actual,
2109 $ordered = false, $named = false
2112 $this->objectAssociativeSort( $expected );
2113 $this->objectAssociativeSort( $actual );
2117 $expected = array_values( $expected );
2118 $actual = array_values( $actual );
2121 call_user_func_array(
2122 [ $this, 'assertEquals' ],
2123 array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
2128 * Put each HTML element on its own line and then equals() the results
2130 * Use for nicely formatting of PHPUnit diff output when comparing very
2135 * @param string $expected HTML on oneline
2136 * @param string $actual HTML on oneline
2137 * @param string $msg Optional message
2139 protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
2140 $expected = str_replace( '>', ">\n", $expected );
2141 $actual = str_replace( '>', ">\n", $actual );
2143 $this->assertEquals( $expected, $actual, $msg );
2147 * Does an associative sort that works for objects.
2151 * @param array &$array
2153 protected function objectAssociativeSort( array &$array ) {
2156 function ( $a, $b ) {
2157 return serialize( $a ) <=> serialize( $b );
2163 * Utility function for eliminating all string keys from an array.
2164 * Useful to turn a database result row as returned by fetchRow() into
2165 * a pure indexed array.
2169 * @param mixed &$r The array to remove string keys from.
2171 protected static function stripStringKeys( &$r ) {
2172 if ( !is_array( $r ) ) {
2176 foreach ( $r as $k => $v ) {
2177 if ( is_string( $k ) ) {
2184 * Asserts that the provided variable is of the specified
2185 * internal type or equals the $value argument. This is useful
2186 * for testing return types of functions that return a certain
2187 * type or *value* when not set or on error.
2191 * @param string $type
2192 * @param mixed $actual
2193 * @param mixed $value
2194 * @param string $message
2196 protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
2197 if ( $actual === $value ) {
2198 $this->assertTrue( true, $message );
2200 $this->assertType( $type, $actual, $message );
2205 * Asserts the type of the provided value. This can be either
2206 * in internal type such as boolean or integer, or a class or
2207 * interface the value extends or implements.
2211 * @param string $type
2212 * @param mixed $actual
2213 * @param string $message
2215 protected function assertType( $type, $actual, $message = '' ) {
2216 if ( class_exists( $type ) ||
interface_exists( $type ) ) {
2217 $this->assertInstanceOf( $type, $actual, $message );
2219 $this->assertInternalType( $type, $actual, $message );
2224 * Returns true if the given namespace defaults to Wikitext
2225 * according to $wgNamespaceContentModels
2227 * @param int $ns The namespace ID to check
2232 protected function isWikitextNS( $ns ) {
2233 global $wgNamespaceContentModels;
2235 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
2236 return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
;
2243 * Returns the ID of a namespace that defaults to Wikitext.
2245 * @throws MWException If there is none.
2246 * @return int The ID of the wikitext Namespace
2249 protected function getDefaultWikitextNS() {
2250 global $wgNamespaceContentModels;
2252 static $wikitextNS = null; // this is not going to change
2253 if ( $wikitextNS !== null ) {
2257 // quickly short out on most common case:
2258 if ( !isset( $wgNamespaceContentModels[NS_MAIN
] ) ) {
2262 // NOTE: prefer content namespaces
2263 $nsInfo = MediaWikiServices
::getInstance()->getNamespaceInfo();
2264 $namespaces = array_unique( array_merge(
2265 $nsInfo->getContentNamespaces(),
2266 [ NS_MAIN
, NS_HELP
, NS_PROJECT
], // prefer these
2267 $nsInfo->getValidNamespaces()
2270 $namespaces = array_diff( $namespaces, [
2271 NS_FILE
, NS_CATEGORY
, NS_MEDIAWIKI
, NS_USER
// don't mess with magic namespaces
2274 $talk = array_filter( $namespaces, function ( $ns ) use ( $nsInfo ) {
2275 return $nsInfo->isTalk( $ns );
2278 // prefer non-talk pages
2279 $namespaces = array_diff( $namespaces, $talk );
2280 $namespaces = array_merge( $namespaces, $talk );
2282 // check default content model of each namespace
2283 foreach ( $namespaces as $ns ) {
2284 if ( !isset( $wgNamespaceContentModels[$ns] ) ||
2285 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
2294 // @todo Inside a test, we could skip the test as incomplete.
2295 // But frequently, this is used in fixture setup.
2296 throw new MWException( "No namespace defaults to wikitext!" );
2300 * Check, if $wgDiff3 is set and ready to merge
2301 * Will mark the calling test as skipped, if not ready
2305 protected function markTestSkippedIfNoDiff3() {
2308 # This check may also protect against code injection in
2309 # case of broken installations.
2310 Wikimedia\
suppressWarnings();
2311 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2312 Wikimedia\restoreWarnings
();
2314 if ( !$haveDiff3 ) {
2315 $this->markTestSkipped( "Skip test, since diff3 is not configured" );
2320 * Check if $extName is a loaded PHP extension, will skip the
2321 * test whenever it is not loaded.
2324 * @param string $extName
2327 protected function checkPHPExtension( $extName ) {
2328 $loaded = extension_loaded( $extName );
2330 $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
2337 * Skip the test if using the specified database type
2339 * @param string $type Database type
2342 protected function markTestSkippedIfDbType( $type ) {
2343 if ( $this->db
->getType() === $type ) {
2344 $this->markTestSkipped( "The $type database type isn't supported for this test" );
2349 * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
2350 * @param string $buffer
2353 public static function wfResetOutputBuffersBarrier( $buffer ) {
2358 * Create a temporary hook handler which will be reset by tearDown.
2359 * This replaces other handlers for the same hook.
2361 * @note This will call resetServices().
2363 * @param string $hookName Hook name
2364 * @param mixed $handler Value suitable for a hook handler
2367 protected function setTemporaryHook( $hookName, $handler ) {
2368 $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
2372 * Check whether file contains given data.
2373 * @param string $fileName
2374 * @param string $actualData
2375 * @param bool $createIfMissing If true, and file does not exist, create it with given data
2376 * and skip the test.
2377 * @param string $msg
2380 protected function assertFileContains(
2383 $createIfMissing = false,
2386 if ( $createIfMissing ) {
2387 if ( !file_exists( $fileName ) ) {
2388 file_put_contents( $fileName, $actualData );
2389 $this->markTestSkipped( "Data file $fileName does not exist" );
2392 self
::assertFileExists( $fileName );
2394 self
::assertEquals( file_get_contents( $fileName ), $actualData, $msg );
2398 * Edits or creates a page/revision
2399 * @param string $pageName Page title
2400 * @param string $text Content of the page
2401 * @param string $summary Optional summary string for the revision
2402 * @param int $defaultNs Optional namespace id
2403 * @param User|null $user If null, static::getTestSysop()->getUser() is used.
2404 * @return Status Object as returned by WikiPage::doEditContent()
2405 * @throws MWException If this test cases's needsDB() method doesn't return true.
2406 * Test cases can use "@group Database" to enable database test support,
2407 * or list the tables under testing in $this->tablesUsed, or override the
2410 protected function editPage(
2414 $defaultNs = NS_MAIN
,
2417 if ( !$this->needsDB() ) {
2418 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
2419 ' method should return true. Use @group Database or $this->tablesUsed.' );
2422 $title = Title
::newFromText( $pageName, $defaultNs );
2423 $page = WikiPage
::factory( $title );
2425 return $page->doEditContent(
2426 ContentHandler
::makeContent( $text, $title ),
2435 * Revision-deletes a revision.
2437 * @param Revision|int $rev Revision to delete
2438 * @param array $value Keys are Revision::DELETED_* flags. Values are 1 to set the bit, 0 to
2439 * clear, -1 to leave alone. (All other values also clear the bit.)
2440 * @param string $comment Deletion comment
2442 protected function revisionDelete(
2443 $rev, array $value = [ Revision
::DELETED_TEXT
=> 1 ], $comment = ''
2445 if ( is_int( $rev ) ) {
2446 $rev = Revision
::newFromId( $rev );
2448 RevisionDeleter
::createList(
2449 'revision', RequestContext
::getMain(), $rev->getTitle(), [ $rev->getId() ]
2452 'comment' => $comment,
2457 class_alias( 'MediaWikiIntegrationTestCase', 'MediaWikiTestCase' );