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 'A working MediaWiki installation with a configured LocalSettings.php file is'
186 . ' required for tests that extend ' . self
::class;
189 self
::initializeForStandardPhpunitEntrypointIfNeeded();
191 // Get the original service locator
192 if ( !self
::$originalServices ) {
193 self
::$originalServices = MediaWikiServices
::getInstance();
198 * Convenience method for getting an immutable test user
202 * @param string|string[] $groups Groups the test user should be in.
205 public static function getTestUser( $groups = [] ) {
206 return TestUserRegistry
::getImmutableTestUser( $groups );
210 * Convenience method for getting a mutable test user
214 * @param string|string[] $groups Groups the test user should be added in.
217 public static function getMutableTestUser( $groups = [] ) {
218 return TestUserRegistry
::getMutableTestUser( __CLASS__
, $groups );
222 * Convenience method for getting an immutable admin test user
228 public static function getTestSysop() {
229 return self
::getTestUser( [ 'sysop', 'bureaucrat' ] );
233 * Returns a WikiPage representing an existing page.
237 * @param Title|string|null $title
239 * @throws MWException If this test cases's needsDB() method doesn't return true.
240 * Test cases can use "@group Database" to enable database test support,
241 * or list the tables under testing in $this->tablesUsed, or override the
244 protected function getExistingTestPage( $title = null ) {
245 if ( !$this->needsDB() ) {
246 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
247 ' method should return true. Use @group Database or $this->tablesUsed.' );
250 $title = ( $title === null ) ?
'UTPage' : $title;
251 $title = is_string( $title ) ? Title
::newFromText( $title ) : $title;
252 $page = WikiPage
::factory( $title );
254 if ( !$page->exists() ) {
255 $user = self
::getTestSysop()->getUser();
256 $page->doEditContent(
257 ContentHandler
::makeContent( 'UTContent', $title ),
259 EDIT_NEW | EDIT_SUPPRESS_RC
,
269 * Returns a WikiPage representing a non-existing page.
273 * @param Title|string|null $title
275 * @throws MWException If this test cases's needsDB() method doesn't return true.
276 * Test cases can use "@group Database" to enable database test support,
277 * or list the tables under testing in $this->tablesUsed, or override the
280 protected function getNonexistingTestPage( $title = null ) {
281 if ( !$this->needsDB() ) {
282 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
283 ' method should return true. Use @group Database or $this->tablesUsed.' );
286 $title = ( $title === null ) ?
'UTPage-' . rand( 0, 100000 ) : $title;
287 $title = is_string( $title ) ? Title
::newFromText( $title ) : $title;
288 $page = WikiPage
::factory( $title );
290 if ( $page->exists() ) {
291 $page->doDeleteArticle( 'Testing' );
298 * @deprecated since 1.32
300 public static function prepareServices( Config
$bootstrapConfig ) {
304 * Create a config suitable for testing, based on a base config, default overrides,
305 * and custom overrides.
307 * @param Config|null $baseConfig
308 * @param Config|null $customOverrides
312 private static function makeTestConfig(
313 Config
$baseConfig = null,
314 Config
$customOverrides = null
316 $defaultOverrides = new HashConfig();
318 if ( !$baseConfig ) {
319 $baseConfig = self
::$originalServices->getBootstrapConfig();
322 /* Some functions require some kind of caching, and will end up using the db,
323 * which we can't allow, as that would open a new connection for mysql.
324 * Replace with a HashBag. They would not be going to persist anyway.
326 $hashCache = [ 'class' => HashBagOStuff
::class, 'reportDupes' => false ];
328 CACHE_DB
=> $hashCache,
329 CACHE_ACCEL
=> $hashCache,
330 CACHE_MEMCACHED
=> $hashCache,
332 'apcu' => $hashCache,
333 'wincache' => $hashCache,
334 ] +
$baseConfig->get( 'ObjectCaches' );
336 $defaultOverrides->set( 'ObjectCaches', $objectCaches );
337 $defaultOverrides->set( 'MainCacheType', CACHE_NONE
);
338 $defaultOverrides->set( 'JobTypeConf', [ 'default' => [ 'class' => JobQueueMemory
::class ] ] );
340 // Use a fast hash algorithm to hash passwords.
341 $defaultOverrides->set( 'PasswordDefault', 'A' );
343 $testConfig = $customOverrides
344 ?
new MultiConfig( [ $customOverrides, $defaultOverrides, $baseConfig ] )
345 : new MultiConfig( [ $defaultOverrides, $baseConfig ] );
351 * @param ConfigFactory $oldFactory
352 * @param Config[] $configurations
356 private static function makeTestConfigFactoryInstantiator(
357 ConfigFactory
$oldFactory,
358 array $configurations
360 return function ( MediaWikiServices
$services ) use ( $oldFactory, $configurations ) {
361 $factory = new ConfigFactory();
363 // clone configurations from $oldFactory that are not overwritten by $configurations
364 $namesToClone = array_diff(
365 $oldFactory->getConfigNames(),
366 array_keys( $configurations )
369 foreach ( $namesToClone as $name ) {
370 $factory->register( $name, $oldFactory->makeConfig( $name ) );
373 foreach ( $configurations as $name => $config ) {
374 $factory->register( $name, $config );
382 * Resets some non-service singleton instances and other static caches. It's not necessary to
383 * reset services here.
385 public static function resetNonServiceCaches() {
386 global $wgRequest, $wgJobClasses;
388 User
::resetGetDefaultOptionsForTestsOnly();
389 foreach ( $wgJobClasses as $type => $class ) {
390 JobQueueGroup
::singleton()->get( $type )->delete();
392 JobQueueGroup
::destroySingletons();
394 ObjectCache
::clear();
395 FileBackendGroup
::destroySingleton();
396 DeferredUpdates
::clearPendingUpdates();
398 // TODO: move global state into MediaWikiServices
399 RequestContext
::resetMain();
400 if ( session_id() !== '' ) {
401 session_write_close();
405 $wgRequest = new FauxRequest();
406 MediaWiki\Session\SessionManager
::resetCache();
407 Language
::clearCaches();
410 public function run( PHPUnit_Framework_TestResult
$result = null ) {
411 if ( $result instanceof MediaWikiTestResult
) {
412 $this->cliArgs
= $result->getMediaWikiCliArgs();
414 $this->overrideMwServices();
416 if ( $this->needsDB() && !$this->isTestInDatabaseGroup() ) {
418 get_class( $this ) . ' apparently needsDB but is not in the Database group'
422 $needsResetDB = false;
423 if ( !self
::$dbSetup ||
$this->needsDB() ) {
424 // set up a DB connection for this test to use
426 self
::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
427 self
::$reuseDB = $this->getCliArg( 'reuse-db' );
429 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
430 $this->db
= $lb->getConnection( DB_MASTER
);
432 $this->checkDbIsSupported();
434 if ( !self
::$dbSetup ) {
435 $this->setupAllTestDBs();
436 $this->addCoreDBData();
439 // TODO: the DB setup should be done in setUpBeforeClass(), so the test DB
440 // is available in subclass's setUpBeforeClass() and setUp() methods.
441 // This would also remove the need for the HACK that is oncePerClass().
442 if ( $this->oncePerClass() ) {
443 $this->setUpSchema( $this->db
);
444 $this->resetDB( $this->db
, $this->tablesUsed
);
445 $this->addDBDataOnce();
449 $needsResetDB = true;
452 parent
::run( $result );
454 // We don't mind if we override already-overridden services during cleanup
455 $this->overriddenServices
= [];
457 if ( $needsResetDB ) {
458 $this->resetDB( $this->db
, $this->tablesUsed
);
461 self
::restoreMwServices();
462 $this->localServices
= null;
468 private function oncePerClass() {
469 // Remember current test class in the database connection,
470 // so we know when we need to run addData.
472 $class = static::class;
474 $first = !isset( $this->db
->_hasDataForTestClass
)
475 ||
$this->db
->_hasDataForTestClass
!== $class;
477 $this->db
->_hasDataForTestClass
= $class;
486 public function usesTemporaryTables() {
487 return self
::$useTemporaryTables;
491 * Obtains a new temporary file name
493 * The obtained filename is enlisted to be removed upon tearDown
497 * @return string Absolute name of the temporary file
499 protected function getNewTempFile() {
502 // Avoid backslashes here as they result in inconsistent results
503 // between Windows and other OS, as well as between functions
504 // that try to normalise these in one or both directions.
505 // For example, tempnam rejects directory separators in the prefix which
506 // means it rejects any namespaced class on Windows.
507 // And then there is, wfMkdirParents which normalises paths always
508 // whereas most other PHP and MW functions do not.
509 'MW_PHPUnit_' . strtr( static::class, [ '\\' => '_' ] ) . '_'
511 $this->tmpFiles
[] = $fileName;
517 * obtains a new temporary directory
519 * The obtained directory is enlisted to be removed (recursively with all its contained
520 * files) upon tearDown.
524 * @return string Absolute name of the temporary directory
526 protected function getNewTempDirectory() {
527 // Starting of with a temporary *file*.
528 $fileName = $this->getNewTempFile();
530 // Converting the temporary file to a *directory*.
531 // The following is not atomic, but at least we now have a single place,
532 // where temporary directory creation is bundled and can be improved.
534 // If this fails for some reason, PHP will warn and fail the test.
535 mkdir( $fileName, 0777, /* recursive = */ true );
540 protected function setUp() {
542 $reflection = new ReflectionClass( $this );
543 // TODO: Eventually we should assert for test presence in /integration/
544 if ( strpos( $reflection->getFilename(), '/unit/' ) !== false ) {
545 $this->fail( 'This integration test should not be in "tests/phpunit/unit" !' );
547 $this->called
['setUp'] = true;
549 $this->phpErrorLevel
= intval( ini_get( 'error_reporting' ) );
551 $this->overriddenServices
= [];
553 // Cleaning up temporary files
554 foreach ( $this->tmpFiles
as $fileName ) {
555 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
557 } elseif ( is_dir( $fileName ) ) {
558 wfRecursiveRemoveDir( $fileName );
562 if ( $this->needsDB() && $this->db
) {
563 // Clean up open transactions
564 while ( $this->db
->trxLevel() > 0 ) {
565 $this->db
->rollback( __METHOD__
, 'flush' );
567 // Check for unsafe queries
568 if ( $this->db
->getType() === 'mysql' ) {
569 $this->db
->query( "SET sql_mode = 'STRICT_ALL_TABLES'", __METHOD__
);
573 // Reset all caches between tests.
574 self
::resetNonServiceCaches();
576 // XXX: reset maintenance triggers
577 // Hook into period lag checks which often happen in long-running scripts
578 $lbFactory = $this->localServices
->getDBLoadBalancerFactory();
579 Maintenance
::setLBFactoryTriggers( $lbFactory, $this->localServices
->getMainConfig() );
581 ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
584 protected function addTmpFiles( $files ) {
585 $this->tmpFiles
= array_merge( $this->tmpFiles
, (array)$files );
588 // @todo Make const when we no longer support HHVM (T192166)
589 private static $namespaceAffectingSettings = [
590 'wgAllowImageMoving',
591 'wgCanonicalNamespaceNames',
592 'wgCapitalLinkOverrides',
594 'wgContentNamespaces',
595 'wgExtensionMessagesFiles',
596 'wgExtensionNamespaces',
598 'wgExtraSignatureNamespaces',
599 'wgNamespaceContentModels',
600 'wgNamespaceProtection',
601 'wgNamespacesWithSubpages',
602 'wgNonincludableNamespaces',
603 'wgRestrictionLevels',
606 protected function tearDown() {
607 global $wgRequest, $wgSQLMode;
609 $status = ob_get_status();
610 if ( isset( $status['name'] ) &&
611 $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier'
616 $this->called
['tearDown'] = true;
617 // Cleaning up temporary files
618 foreach ( $this->tmpFiles
as $fileName ) {
619 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
621 } elseif ( is_dir( $fileName ) ) {
622 wfRecursiveRemoveDir( $fileName );
626 if ( $this->needsDB() && $this->db
) {
627 // Clean up open transactions
628 while ( $this->db
->trxLevel() > 0 ) {
629 $this->db
->rollback( __METHOD__
, 'flush' );
631 if ( $this->db
->getType() === 'mysql' ) {
632 $this->db
->query( "SET sql_mode = " . $this->db
->addQuotes( $wgSQLMode ),
637 // Clear any cached test users so they don't retain references to old services
638 TestUserRegistry
::clear();
640 // Re-enable any disabled deprecation warnings
642 // Restore mw globals
643 foreach ( $this->mwGlobals
as $key => $value ) {
644 $GLOBALS[$key] = $value;
646 foreach ( $this->mwGlobalsToUnset
as $value ) {
647 unset( $GLOBALS[$value] );
649 foreach ( $this->iniSettings
as $name => $value ) {
650 ini_set( $name, $value );
653 array_intersect( self
::$namespaceAffectingSettings, array_keys( $this->mwGlobals
) ) ||
654 array_intersect( self
::$namespaceAffectingSettings, $this->mwGlobalsToUnset
)
656 $this->resetNamespaces();
658 $this->mwGlobals
= [];
659 $this->mwGlobalsToUnset
= [];
660 $this->restoreLoggers();
662 // TODO: move global state into MediaWikiServices
663 RequestContext
::resetMain();
664 if ( session_id() !== '' ) {
665 session_write_close();
668 $wgRequest = new FauxRequest();
669 MediaWiki\Session\SessionManager
::resetCache();
670 MediaWiki\Auth\AuthManager
::resetCache();
672 $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
674 if ( $phpErrorLevel !== $this->phpErrorLevel
) {
675 ini_set( 'error_reporting', $this->phpErrorLevel
);
677 $oldHex = strtoupper( dechex( $this->phpErrorLevel
) );
678 $newHex = strtoupper( dechex( $phpErrorLevel ) );
679 $message = "PHP error_reporting setting was left dirty: "
680 . "was 0x$oldHex before test, 0x$newHex after test!";
682 $this->fail( $message );
689 * Make sure MediaWikiTestCase extending classes have called their
690 * parent setUp method
692 * With strict coverage activated in PHP_CodeCoverage, this test would be
693 * marked as risky without the following annotation (T152923).
696 final public function testMediaWikiTestCaseParentSetupCalled() {
697 $this->assertArrayHasKey( 'setUp', $this->called
,
698 static::class . '::setUp() must call parent::setUp()'
703 * Sets a service, maintaining a stashed version of the previous service to be
704 * restored in tearDown.
706 * @note Tests must not call overrideMwServices() after calling setService(), since that would
707 * lose the new service instance. Since 1.34, resetServices() can be used instead, which
708 * would reset other services, but retain any services set using setService().
709 * This means that once a service is set using this method, it cannot be reverted to
710 * the original service within the same test method. The original service is restored
711 * in tearDown after the test method has terminated.
713 * @param string $name
714 * @param object $service The service instance, or a callable that returns the service instance.
719 protected function setService( $name, $service ) {
720 if ( !$this->localServices
) {
721 throw new Exception( __METHOD__
. ' must be called after MediaWikiTestCase::run()' );
724 if ( $this->localServices
!== MediaWikiServices
::getInstance() ) {
725 throw new Exception( __METHOD__
. ' will not work because the global MediaWikiServices '
726 . 'instance has been replaced by test code.' );
729 if ( is_callable( $service ) ) {
730 $instantiator = $service;
732 $instantiator = function () use ( $service ) {
737 $this->overriddenServices
[] = $name;
739 $this->localServices
->disableService( $name );
740 $this->localServices
->redefineService(
745 if ( $name === 'ContentLanguage' ) {
746 $this->doSetMwGlobals( [ 'wgContLang' => $this->localServices
->getContentLanguage() ] );
751 * Sets a global, maintaining a stashed version of the previous global to be
752 * restored in tearDown
754 * The key is added to the array of globals that will be reset afterwards
757 * It may be necessary to call resetServices() to allow any changed configuration variables
758 * to take effect on services that get initialized based on these variables.
762 * protected function setUp() {
763 * $this->setMwGlobals( 'wgRestrictStuff', true );
766 * function testFoo() {}
768 * function testBar() {}
769 * $this->assertTrue( self::getX()->doStuff() );
771 * $this->setMwGlobals( 'wgRestrictStuff', false );
772 * $this->assertTrue( self::getX()->doStuff() );
775 * function testQuux() {}
778 * @param array|string $pairs Key to the global variable, or an array
779 * of key/value pairs.
780 * @param mixed|null $value Value to set the global to (ignored
781 * if an array is given as first argument).
783 * @note To allow changes to global variables to take effect on global service instances,
784 * call resetServices().
788 protected function setMwGlobals( $pairs, $value = null ) {
789 if ( is_string( $pairs ) ) {
790 $pairs = [ $pairs => $value ];
793 if ( isset( $pairs['wgContLang'] ) ) {
794 throw new MWException(
795 'No setting $wgContLang, use setContentLang() or setService( \'ContentLanguage\' )'
799 $this->doSetMwGlobals( $pairs, $value );
803 * An internal method that allows setService() to set globals that tests are not supposed to
806 private function doSetMwGlobals( $pairs, $value = null ) {
807 $this->doStashMwGlobals( array_keys( $pairs ) );
809 foreach ( $pairs as $key => $value ) {
810 $GLOBALS[$key] = $value;
813 if ( array_intersect( self
::$namespaceAffectingSettings, array_keys( $pairs ) ) ) {
814 $this->resetNamespaces();
819 * Set an ini setting for the duration of the test
820 * @param string $name Name of the setting
821 * @param string $value Value to set
824 protected function setIniSetting( $name, $value ) {
825 $original = ini_get( $name );
826 $this->iniSettings
[$name] = $original;
827 ini_set( $name, $value );
831 * Must be called whenever namespaces are changed, e.g., $wgExtraNamespaces is altered.
832 * Otherwise old namespace data will lurk and cause bugs.
834 private function resetNamespaces() {
835 if ( !$this->localServices
) {
836 throw new Exception( __METHOD__
. ' must be called after MediaWikiTestCase::run()' );
839 if ( $this->localServices
!== MediaWikiServices
::getInstance() ) {
840 throw new Exception( __METHOD__
. ' will not work because the global MediaWikiServices '
841 . 'instance has been replaced by test code.' );
844 Language
::clearCaches();
848 * Check if we can back up a value by performing a shallow copy.
849 * Values which fail this test are copied recursively.
851 * @param mixed $value
852 * @return bool True if a shallow copy will do; false if a deep copy
855 private static function canShallowCopy( $value ) {
856 if ( is_scalar( $value ) ||
$value === null ) {
859 if ( is_array( $value ) ) {
860 foreach ( $value as $subValue ) {
861 if ( !is_scalar( $subValue ) && $subValue !== null ) {
870 private function doStashMwGlobals( $globalKeys ) {
871 if ( is_string( $globalKeys ) ) {
872 $globalKeys = [ $globalKeys ];
875 foreach ( $globalKeys as $globalKey ) {
876 // NOTE: make sure we only save the global once or a second call to
877 // setMwGlobals() on the same global would override the original
880 !array_key_exists( $globalKey, $this->mwGlobals
) &&
881 !array_key_exists( $globalKey, $this->mwGlobalsToUnset
)
883 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
884 $this->mwGlobalsToUnset
[$globalKey] = $globalKey;
887 // NOTE: we serialize then unserialize the value in case it is an object
888 // this stops any objects being passed by reference. We could use clone
889 // and if is_object but this does account for objects within objects!
890 if ( self
::canShallowCopy( $GLOBALS[$globalKey] ) ) {
891 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
893 // Many MediaWiki types are safe to clone. These are the
894 // ones that are most commonly stashed.
895 $GLOBALS[$globalKey] instanceof Language ||
896 $GLOBALS[$globalKey] instanceof User ||
897 $GLOBALS[$globalKey] instanceof FauxRequest
899 $this->mwGlobals
[$globalKey] = clone $GLOBALS[$globalKey];
900 } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
901 // Serializing Closure only gives a warning on HHVM while
902 // it throws an Exception on Zend.
903 // Workaround for https://github.com/facebook/hhvm/issues/6206
904 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
907 $this->mwGlobals
[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
908 } catch ( Exception
$e ) {
909 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
918 * @param int $maxDepth
922 private function containsClosure( $var, $maxDepth = 15 ) {
923 if ( $var instanceof Closure
) {
926 if ( !is_array( $var ) ||
$maxDepth === 0 ) {
930 foreach ( $var as $value ) {
931 if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
939 * Merges the given values into a MW global array variable.
940 * Useful for setting some entries in a configuration array, instead of
941 * setting the entire array.
943 * It may be necessary to call resetServices() to allow any changed configuration variables
944 * to take effect on services that get initialized based on these variables.
946 * @param string $name The name of the global, as in wgFooBar
947 * @param array $values The array containing the entries to set in that global
949 * @throws MWException If the designated global is not an array.
951 * @note To allow changes to global variables to take effect on global service instances,
952 * call resetServices().
956 protected function mergeMwGlobalArrayValue( $name, $values ) {
957 if ( !isset( $GLOBALS[$name] ) ) {
960 if ( !is_array( $GLOBALS[$name] ) ) {
961 throw new MWException( "MW global $name is not an array." );
964 // NOTE: do not use array_merge, it screws up for numeric keys.
965 $merged = $GLOBALS[$name];
966 foreach ( $values as $k => $v ) {
971 $this->setMwGlobals( $name, $merged );
975 * Resets service instances in the global instance of MediaWikiServices.
977 * In contrast to overrideMwServices(), this does not create a new MediaWikiServices instance,
978 * and it preserves any service instances set via setService().
980 * The primary use case for this method is to allow changes to global configuration variables
981 * to take effect on services that get initialized based on these global configuration
982 * variables. Similarly, it may be necessary to call resetServices() after calling setService(),
983 * so the newly set service gets picked up by any other service definitions that may use it.
985 * @see MediaWikiServices::resetServiceForTesting.
989 protected function resetServices() {
990 // Reset but don't destroy service instances supplied via setService().
991 foreach ( $this->overriddenServices
as $name ) {
992 $this->localServices
->resetServiceForTesting( $name, false );
995 // Reset all services with the destroy flag set.
996 // This will not have any effect on services that had already been reset above.
997 foreach ( $this->localServices
->getServiceNames() as $name ) {
998 $this->localServices
->resetServiceForTesting( $name, true );
1001 self
::resetGlobalParser();
1005 * Installs a new global instance of MediaWikiServices, allowing test cases to override
1006 * settings and services.
1008 * This method can be used to set up specific services or configuration as a fixture.
1009 * It should not be used to reset services in between stages of a test - instead, the test
1010 * should either be split, or resetServices() should be used.
1012 * If called with no parameters, this method restores all services to their default state.
1013 * This is done automatically before each test to isolate tests from any modification
1014 * to settings and services that may have been applied by previous tests.
1015 * That means that the effect of calling overrideMwServices() is undone before the next
1016 * call to a test method.
1018 * @note Calling this after having called setService() in the same test method (or the
1019 * associated setUp) will result in an MWException.
1020 * Tests should use either overrideMwServices() or setService(), but not mix both.
1021 * Since 1.34, resetServices() is available as an alternative compatible with setService().
1025 * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
1027 * @param callable[] $services An associative array of services to re-define. Keys are service
1028 * names, values are callables.
1030 * @return MediaWikiServices
1031 * @throws MWException
1033 protected function overrideMwServices(
1034 Config
$configOverrides = null, array $services = []
1036 if ( $this->overriddenServices
) {
1037 throw new MWException(
1038 'The following services were set and are now being unset by overrideMwServices: ' .
1039 implode( ', ', $this->overriddenServices
)
1042 $newInstance = self
::installMockMwServices( $configOverrides );
1044 if ( $this->localServices
) {
1045 $this->localServices
->destroy();
1048 $this->localServices
= $newInstance;
1050 foreach ( $services as $name => $callback ) {
1051 $newInstance->redefineService( $name, $callback );
1054 self
::resetGlobalParser();
1056 return $newInstance;
1060 * Creates a new "mock" MediaWikiServices instance, and installs it.
1061 * This effectively resets all cached states in services, with the exception of
1062 * the ConfigFactory and the DBLoadBalancerFactory service, which are inherited from
1063 * the original MediaWikiServices.
1065 * @note The new original MediaWikiServices instance can later be restored by calling
1066 * restoreMwServices(). That original is determined by the first call to this method, or
1067 * by setUpBeforeClass, whichever is called first. The caller is responsible for managing
1068 * and, when appropriate, destroying any other MediaWikiServices instances that may get
1069 * replaced when calling this method.
1071 * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
1074 * @return MediaWikiServices the new mock service locator.
1076 public static function installMockMwServices( Config
$configOverrides = null ) {
1077 // Make sure we have the original service locator
1078 if ( !self
::$originalServices ) {
1079 self
::$originalServices = MediaWikiServices
::getInstance();
1082 if ( !$configOverrides ) {
1083 $configOverrides = new HashConfig();
1086 $oldConfigFactory = self
::$originalServices->getConfigFactory();
1087 $oldLoadBalancerFactory = self
::$originalServices->getDBLoadBalancerFactory();
1089 $testConfig = self
::makeTestConfig( null, $configOverrides );
1090 $newServices = new MediaWikiServices( $testConfig );
1092 // Load the default wiring from the specified files.
1093 // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
1094 $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
1095 $newServices->loadWiringFiles( $wiringFiles );
1097 // Provide a traditional hook point to allow extensions to configure services.
1098 Hooks
::run( 'MediaWikiServices', [ $newServices ] );
1100 // Use bootstrap config for all configuration.
1101 // This allows config overrides via global variables to take effect.
1102 $bootstrapConfig = $newServices->getBootstrapConfig();
1103 $newServices->resetServiceForTesting( 'ConfigFactory' );
1104 $newServices->redefineService(
1106 self
::makeTestConfigFactoryInstantiator(
1108 [ 'main' => $bootstrapConfig ]
1111 $newServices->resetServiceForTesting( 'DBLoadBalancerFactory' );
1112 $newServices->redefineService(
1113 'DBLoadBalancerFactory',
1114 function ( MediaWikiServices
$services ) use ( $oldLoadBalancerFactory ) {
1115 return $oldLoadBalancerFactory;
1119 MediaWikiServices
::forceGlobalInstance( $newServices );
1121 self
::resetGlobalParser();
1123 return $newServices;
1127 * Restores the original, non-mock MediaWikiServices instance.
1128 * The previously active MediaWikiServices instance is destroyed,
1129 * if it is different from the original that is to be restored.
1131 * @note this if for internal use by test framework code. It should never be
1132 * called from inside a test case, a data provider, or a setUp or tearDown method.
1134 * @return bool true if the original service locator was restored,
1135 * false if there was nothing too do.
1137 public static function restoreMwServices() {
1138 if ( !self
::$originalServices ) {
1142 $currentServices = MediaWikiServices
::getInstance();
1144 if ( self
::$originalServices === $currentServices ) {
1148 MediaWikiServices
::forceGlobalInstance( self
::$originalServices );
1149 $currentServices->destroy();
1151 self
::resetGlobalParser();
1157 * If $wgParser has been unstubbed, replace it with a fresh one so it picks up any config
1158 * changes. $wgParser is deprecated, but we still support it for now.
1160 private static function resetGlobalParser() {
1161 // phpcs:ignore MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgParser
1163 if ( $wgParser instanceof StubObject
) {
1166 $wgParser = new StubObject( 'wgParser', function () {
1167 return MediaWikiServices
::getInstance()->getParser();
1173 * @param string|Language $lang
1175 public function setUserLang( $lang ) {
1176 RequestContext
::getMain()->setLanguage( $lang );
1177 $this->setMwGlobals( 'wgLang', RequestContext
::getMain()->getLanguage() );
1182 * @param string|Language $lang
1184 public function setContentLang( $lang ) {
1185 if ( $lang instanceof Language
) {
1186 $this->setMwGlobals( 'wgLanguageCode', $lang->getCode() );
1187 // Set to the exact object requested
1188 $this->setService( 'ContentLanguage', $lang );
1190 $this->setMwGlobals( 'wgLanguageCode', $lang );
1191 // Let the service handler make up the object. Avoid calling setService(), because if
1192 // we do, overrideMwServices() will complain if it's called later on.
1193 $services = MediaWikiServices
::getInstance();
1194 $services->resetServiceForTesting( 'ContentLanguage' );
1195 $this->doSetMwGlobals( [ 'wgContLang' => $services->getContentLanguage() ] );
1200 * Alters $wgGroupPermissions for the duration of the test. Can be called
1201 * with an array, like
1202 * [ '*' => [ 'read' => false ], 'user' => [ 'read' => false ] ]
1203 * or three values to set a single permission, like
1204 * $this->setGroupPermissions( '*', 'read', false );
1207 * @param array|string $newPerms Either an array of permissions to change,
1208 * in which case the next two parameters are ignored; or a single string
1209 * identifying a group, to use with the next two parameters.
1210 * @param string|null $newKey
1211 * @param mixed|null $newValue
1213 public function setGroupPermissions( $newPerms, $newKey = null, $newValue = null ) {
1214 global $wgGroupPermissions;
1216 if ( is_string( $newPerms ) ) {
1217 $newPerms = [ $newPerms => [ $newKey => $newValue ] ];
1220 $newPermissions = $wgGroupPermissions;
1221 foreach ( $newPerms as $group => $permissions ) {
1222 foreach ( $permissions as $key => $value ) {
1223 $newPermissions[$group][$key] = $value;
1227 $this->setMwGlobals( 'wgGroupPermissions', $newPermissions );
1229 // Reset services so they pick up the new permissions.
1230 // Resetting just PermissionManager is not sufficient, since other services may
1231 // have the old instance of PermissionManager injected.
1232 $this->resetServices();
1236 * Overrides specific user permissions until services are reloaded
1241 * @param string[]|string $permissions
1245 public function overrideUserPermissions( $user, $permissions = [] ) {
1246 MediaWikiServices
::getInstance()->getPermissionManager()->overrideUserRightsForTesting(
1253 * Sets the logger for a specified channel, for the duration of the test.
1255 * @param string $channel
1256 * @param LoggerInterface $logger
1258 protected function setLogger( $channel, LoggerInterface
$logger ) {
1259 // TODO: Once loggers are managed by MediaWikiServices, use
1260 // resetServiceForTesting() to set loggers.
1262 $provider = LoggerFactory
::getProvider();
1263 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
1264 $singletons = $wrappedProvider->singletons
;
1265 if ( $provider instanceof MonologSpi
) {
1266 if ( !isset( $this->loggers
[$channel] ) ) {
1267 $this->loggers
[$channel] = $singletons['loggers'][$channel] ??
null;
1269 $singletons['loggers'][$channel] = $logger;
1270 } elseif ( $provider instanceof LegacySpi ||
$provider instanceof LogCapturingSpi
) {
1271 if ( !isset( $this->loggers
[$channel] ) ) {
1272 $this->loggers
[$channel] = $singletons[$channel] ??
null;
1274 $singletons[$channel] = $logger;
1276 throw new LogicException( __METHOD__
. ': setting a logger for ' . get_class( $provider )
1277 . ' is not implemented' );
1279 $wrappedProvider->singletons
= $singletons;
1283 * Restores loggers replaced by setLogger().
1286 private function restoreLoggers() {
1287 $provider = LoggerFactory
::getProvider();
1288 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
1289 $singletons = $wrappedProvider->singletons
;
1290 foreach ( $this->loggers
as $channel => $logger ) {
1291 if ( $provider instanceof MonologSpi
) {
1292 if ( $logger === null ) {
1293 unset( $singletons['loggers'][$channel] );
1295 $singletons['loggers'][$channel] = $logger;
1297 } elseif ( $provider instanceof LegacySpi ||
$provider instanceof LogCapturingSpi
) {
1298 if ( $logger === null ) {
1299 unset( $singletons[$channel] );
1301 $singletons[$channel] = $logger;
1305 $wrappedProvider->singletons
= $singletons;
1306 $this->loggers
= [];
1313 public function dbPrefix() {
1314 return self
::getTestPrefixFor( $this->db
);
1318 * @param IDatabase $db
1322 public static function getTestPrefixFor( IDatabase
$db ) {
1323 return self
::DB_PREFIX
;
1330 public function needsDB() {
1331 // If the test says it uses database tables, it needs the database
1332 return $this->tablesUsed ||
$this->isTestInDatabaseGroup();
1336 * Insert a new page.
1338 * Should be called from addDBData().
1340 * @since 1.25 ($namespace in 1.28)
1341 * @param string|Title $pageName Page name or title
1342 * @param string $text Page's content
1343 * @param int|null $namespace Namespace id (name cannot already contain namespace)
1344 * @param User|null $user If null, static::getTestSysop()->getUser() is used.
1345 * @return array Title object and page id
1346 * @throws MWException If this test cases's needsDB() method doesn't return true.
1347 * Test cases can use "@group Database" to enable database test support,
1348 * or list the tables under testing in $this->tablesUsed, or override the
1351 protected function insertPage(
1353 $text = 'Sample page for unit test.',
1357 if ( !$this->needsDB() ) {
1358 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
1359 ' method should return true. Use @group Database or $this->tablesUsed.' );
1362 if ( is_string( $pageName ) ) {
1363 $title = Title
::newFromText( $pageName, $namespace );
1369 $user = static::getTestSysop()->getUser();
1371 $comment = __METHOD__
. ': Sample page for unit test.';
1373 $page = WikiPage
::factory( $title );
1374 $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $comment, 0, false, $user );
1378 'id' => $page->getId(),
1383 * Stub. If a test suite needs to add additional data to the database, it should
1384 * implement this method and do so. This method is called once per test suite
1385 * (i.e. once per class).
1387 * Note data added by this method may be removed by resetDB() depending on
1388 * the contents of $tablesUsed.
1390 * To add additional data between test function runs, override prepareDB().
1397 public function addDBDataOnce() {
1401 * Stub. Subclasses may override this to prepare the database.
1402 * Called before every test run (test function or data set).
1404 * @see addDBDataOnce()
1409 public function addDBData() {
1415 protected function addCoreDBData() {
1416 SiteStatsInit
::doPlaceholderInit();
1418 User
::resetIdByNameCache();
1421 $user = static::getTestSysop()->getUser();
1423 // Make 1 page with 1 revision
1424 $page = WikiPage
::factory( Title
::newFromText( 'UTPage' ) );
1425 if ( $page->getId() == 0 ) {
1426 $page->doEditContent(
1427 new WikitextContent( 'UTContent' ),
1429 EDIT_NEW | EDIT_SUPPRESS_RC
,
1433 // an edit always attempt to purge backlink links such as history
1434 // pages. That is unnecessary.
1435 JobQueueGroup
::singleton()->get( 'htmlCacheUpdate' )->delete();
1436 // WikiPages::doEditUpdates randomly adds RC purges
1437 JobQueueGroup
::singleton()->get( 'recentChangesUpdate' )->delete();
1439 // doEditContent() probably started the session via
1440 // User::loadFromSession(). Close it now.
1441 if ( session_id() !== '' ) {
1442 session_write_close();
1449 * Restores MediaWiki to using the table set (table prefix) it was using before
1450 * setupTestDB() was called. Useful if we need to perform database operations
1451 * after the test run has finished (such as saving logs or profiling info).
1453 * This is called by phpunit/bootstrap.php after the last test.
1457 public static function teardownTestDB() {
1458 global $wgJobClasses;
1460 if ( !self
::$dbSetup ) {
1464 Hooks
::run( 'UnitTestsBeforeDatabaseTeardown' );
1466 foreach ( $wgJobClasses as $type => $class ) {
1467 // Delete any jobs under the clone DB (or old prefix in other stores)
1468 JobQueueGroup
::singleton()->get( $type )->delete();
1471 // T219673: close any connections from code that failed to call reuseConnection()
1472 // or is still holding onto a DBConnRef instance (e.g. in a singleton).
1473 MediaWikiServices
::getInstance()->getDBLoadBalancerFactory()->closeAll();
1474 CloneDatabase
::changePrefix( self
::$oldTablePrefix );
1476 self
::$oldTablePrefix = false;
1477 self
::$dbSetup = false;
1481 * Setups a database with cloned tables using the given prefix.
1483 * If reuseDB is true and certain conditions apply, it will just change the prefix.
1484 * Otherwise, it will clone the tables and change the prefix.
1486 * @param IMaintainableDatabase $db Database to use
1487 * @param string|null $prefix Prefix to use for test tables. If not given, the prefix is determined
1488 * automatically for $db.
1489 * @return bool True if tables were cloned, false if only the prefix was changed
1491 protected static function setupDatabaseWithTestPrefix(
1492 IMaintainableDatabase
$db,
1495 if ( $prefix === null ) {
1496 $prefix = self
::getTestPrefixFor( $db );
1499 if ( !self
::$useTemporaryTables && self
::$reuseDB ) {
1500 $db->tablePrefix( $prefix );
1504 if ( !isset( $db->_originalTablePrefix
) ) {
1505 $oldPrefix = $db->tablePrefix();
1506 if ( $oldPrefix === $prefix ) {
1507 // table already has the correct prefix, but presumably no cloned tables
1508 $oldPrefix = self
::$oldTablePrefix;
1511 $db->tablePrefix( $oldPrefix );
1512 $tablesCloned = self
::listTables( $db );
1513 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix, $oldPrefix );
1514 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1515 $dbClone->cloneTableStructure();
1517 $db->tablePrefix( $prefix );
1518 $db->_originalTablePrefix
= $oldPrefix;
1520 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
1521 $lb->setTempTablesOnlyMode( self
::$useTemporaryTables, $lb->getLocalDomainID() );
1528 * Set up all test DBs
1530 public function setupAllTestDBs() {
1533 self
::$oldTablePrefix = $wgDBprefix;
1535 $testPrefix = $this->dbPrefix();
1537 // switch to a temporary clone of the database
1538 self
::setupTestDB( $this->db
, $testPrefix );
1540 if ( self
::isUsingExternalStoreDB() ) {
1541 self
::setupExternalStoreTestDBs( $testPrefix );
1544 // NOTE: Change the prefix in the LBFactory and $wgDBprefix, to prevent
1545 // *any* database connections to operate on live data.
1546 CloneDatabase
::changePrefix( $testPrefix );
1550 * Creates an empty skeleton of the wiki database by cloning its structure
1551 * to equivalent tables using the given $prefix. Then sets MediaWiki to
1552 * use the new set of tables (aka schema) instead of the original set.
1554 * This is used to generate a dummy table set, typically consisting of temporary
1555 * tables, that will be used by tests instead of the original wiki database tables.
1559 * @note the original table prefix is stored in self::$oldTablePrefix. This is used
1560 * by teardownTestDB() to return the wiki to using the original table set.
1562 * @note this method only works when first called. Subsequent calls have no effect,
1563 * even if using different parameters.
1565 * @param IMaintainableDatabase $db The database connection
1566 * @param string $prefix The prefix to use for the new table set (aka schema).
1568 * @throws MWException If the database table prefix is already $prefix
1570 public static function setupTestDB( IMaintainableDatabase
$db, $prefix ) {
1571 if ( self
::$dbSetup ) {
1575 if ( $db->tablePrefix() === $prefix ) {
1576 throw new MWException(
1577 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
1580 // TODO: the below should be re-written as soon as LBFactory, LoadBalancer,
1581 // and Database no longer use global state.
1583 self
::$dbSetup = true;
1585 if ( !self
::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
1589 Hooks
::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
1593 * Clones the External Store database(s) for testing
1595 * @param string|null $testPrefix Prefix for test tables. Will be determined automatically
1598 protected static function setupExternalStoreTestDBs( $testPrefix = null ) {
1599 $connections = self
::getExternalStoreDatabaseConnections();
1600 foreach ( $connections as $dbw ) {
1601 self
::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
1606 * Gets master database connections for all of the ExternalStoreDB
1607 * stores configured in $wgDefaultExternalStore.
1609 * @return Database[] Array of Database master connections
1611 protected static function getExternalStoreDatabaseConnections() {
1612 global $wgDefaultExternalStore;
1614 /** @var ExternalStoreDB $externalStoreDB */
1615 $externalStoreDB = ExternalStore
::getStoreObject( 'DB' );
1616 $defaultArray = (array)$wgDefaultExternalStore;
1618 foreach ( $defaultArray as $url ) {
1619 if ( strpos( $url, 'DB://' ) === 0 ) {
1620 list( $proto, $cluster ) = explode( '://', $url, 2 );
1621 // Avoid getMaster() because setupDatabaseWithTestPrefix()
1622 // requires Database instead of plain DBConnRef/IDatabase
1623 $dbws[] = $externalStoreDB->getMaster( $cluster );
1631 * Check whether ExternalStoreDB is being used
1633 * @return bool True if it's being used
1635 protected static function isUsingExternalStoreDB() {
1636 global $wgDefaultExternalStore;
1637 if ( !$wgDefaultExternalStore ) {
1641 $defaultArray = (array)$wgDefaultExternalStore;
1642 foreach ( $defaultArray as $url ) {
1643 if ( strpos( $url, 'DB://' ) === 0 ) {
1652 * @throws LogicException if the given database connection is not a set up to use
1655 * @since 1.31 this is no longer private.
1657 protected function ensureMockDatabaseConnection( IDatabase
$db ) {
1658 if ( $db->tablePrefix() !== $this->dbPrefix() ) {
1659 throw new LogicException(
1660 'Trying to delete mock tables, but table prefix does not indicate a mock database.'
1665 private static $schemaOverrideDefaults = [
1673 * Stub. If a test suite needs to test against a specific database schema, it should
1674 * override this method and return the appropriate information from it.
1676 * 'create', 'drop' and 'alter' in the returned array should list all the tables affected
1677 * by the 'scripts', even if the test is only interested in a subset of them, otherwise
1678 * the overrides may not be fully cleaned up, leading to errors later.
1680 * @param IMaintainableDatabase $db The DB connection to use for the mock schema.
1681 * May be used to check the current state of the schema, to determine what
1682 * overrides are needed.
1684 * @return array An associative array with the following fields:
1685 * - 'scripts': any SQL scripts to run. If empty or not present, schema overrides are skipped.
1686 * - 'create': A list of tables created (may or may not exist in the original schema).
1687 * - 'drop': A list of tables dropped (expected to be present in the original schema).
1688 * - 'alter': A list of tables altered (expected to be present in the original schema).
1690 protected function getSchemaOverrides( IMaintainableDatabase
$db ) {
1695 * Undoes the specified schema overrides..
1696 * Called once per test class, just before addDataOnce().
1698 * @param IMaintainableDatabase $db
1699 * @param array $oldOverrides
1701 private function undoSchemaOverrides( IMaintainableDatabase
$db, $oldOverrides ) {
1702 $this->ensureMockDatabaseConnection( $db );
1704 $oldOverrides = $oldOverrides + self
::$schemaOverrideDefaults;
1705 $originalTables = $this->listOriginalTables( $db );
1707 // Drop tables that need to be restored or removed.
1708 $tablesToDrop = array_merge( $oldOverrides['create'], $oldOverrides['alter'] );
1710 // Restore tables that have been dropped or created or altered,
1711 // if they exist in the original schema.
1712 $tablesToRestore = array_merge( $tablesToDrop, $oldOverrides['drop'] );
1713 $tablesToRestore = array_intersect( $originalTables, $tablesToRestore );
1715 if ( $tablesToDrop ) {
1716 $this->dropMockTables( $db, $tablesToDrop );
1719 if ( $tablesToRestore ) {
1720 $this->recloneMockTables( $db, $tablesToRestore );
1722 // Reset the restored tables, mainly for the side effect of
1723 // re-calling $this->addCoreDBData() if necessary.
1724 $this->resetDB( $db, $tablesToRestore );
1729 * Applies the schema overrides returned by getSchemaOverrides(),
1730 * after undoing any previously applied schema overrides.
1731 * Called once per test class, just before addDataOnce().
1733 private function setUpSchema( IMaintainableDatabase
$db ) {
1734 // Undo any active overrides.
1735 $oldOverrides = $db->_schemaOverrides ?? self
::$schemaOverrideDefaults;
1737 if ( $oldOverrides['alter'] ||
$oldOverrides['create'] ||
$oldOverrides['drop'] ) {
1738 $this->undoSchemaOverrides( $db, $oldOverrides );
1739 unset( $db->_schemaOverrides
);
1742 // Determine new overrides.
1743 $overrides = $this->getSchemaOverrides( $db ) + self
::$schemaOverrideDefaults;
1745 $extraKeys = array_diff(
1746 array_keys( $overrides ),
1747 array_keys( self
::$schemaOverrideDefaults )
1751 throw new InvalidArgumentException(
1752 'Schema override contains extra keys: ' . var_export( $extraKeys, true )
1756 if ( !$overrides['scripts'] ) {
1757 // no scripts to run
1761 if ( !$overrides['create'] && !$overrides['drop'] && !$overrides['alter'] ) {
1762 throw new InvalidArgumentException(
1763 'Schema override scripts given, but no tables are declared to be '
1764 . 'created, dropped or altered.'
1768 $this->ensureMockDatabaseConnection( $db );
1770 // Drop the tables that will be created by the schema scripts.
1771 $originalTables = $this->listOriginalTables( $db );
1772 $tablesToDrop = array_intersect( $originalTables, $overrides['create'] );
1774 if ( $tablesToDrop ) {
1775 $this->dropMockTables( $db, $tablesToDrop );
1778 // Run schema override scripts.
1779 foreach ( $overrides['scripts'] as $script ) {
1786 return $this->mungeSchemaUpdateQuery( $cmd );
1791 $db->_schemaOverrides
= $overrides;
1794 private function mungeSchemaUpdateQuery( $cmd ) {
1795 return self
::$useTemporaryTables
1796 ?
preg_replace( '/\bCREATE\s+TABLE\b/i', 'CREATE TEMPORARY TABLE', $cmd )
1801 * Drops the given mock tables.
1803 * @param IMaintainableDatabase $db
1804 * @param array $tables
1806 private function dropMockTables( IMaintainableDatabase
$db, array $tables ) {
1807 $this->ensureMockDatabaseConnection( $db );
1809 foreach ( $tables as $tbl ) {
1810 $tbl = $db->tableName( $tbl );
1811 $db->query( "DROP TABLE IF EXISTS $tbl", __METHOD__
);
1816 * Lists all tables in the live database schema, without a prefix.
1818 * @param IMaintainableDatabase $db
1821 private function listOriginalTables( IMaintainableDatabase
$db ) {
1822 if ( !isset( $db->_originalTablePrefix
) ) {
1823 throw new LogicException( 'No original table prefix know, cannot list tables!' );
1826 $originalTables = $db->listTables( $db->_originalTablePrefix
, __METHOD__
);
1828 $unittestPrefixRegex = '/^' . preg_quote( $this->dbPrefix(), '/' ) . '/';
1829 $originalPrefixRegex = '/^' . preg_quote( $db->_originalTablePrefix
, '/' ) . '/';
1831 $originalTables = array_filter(
1833 function ( $pt ) use ( $unittestPrefixRegex ) {
1834 return !preg_match( $unittestPrefixRegex, $pt );
1838 $originalTables = array_map(
1839 function ( $pt ) use ( $originalPrefixRegex ) {
1840 return preg_replace( $originalPrefixRegex, '', $pt );
1845 return array_unique( $originalTables );
1849 * Re-clones the given mock tables to restore them based on the live database schema.
1850 * The tables listed in $tables are expected to currently not exist, so dropMockTables()
1851 * should be called first.
1853 * @param IMaintainableDatabase $db
1854 * @param array $tables
1856 private function recloneMockTables( IMaintainableDatabase
$db, array $tables ) {
1857 $this->ensureMockDatabaseConnection( $db );
1859 if ( !isset( $db->_originalTablePrefix
) ) {
1860 throw new LogicException( 'No original table prefix know, cannot restore tables!' );
1863 $originalTables = $this->listOriginalTables( $db );
1864 $tables = array_intersect( $tables, $originalTables );
1866 $dbClone = new CloneDatabase( $db, $tables, $db->tablePrefix(), $db->_originalTablePrefix
);
1867 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1868 $dbClone->cloneTableStructure();
1870 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
1871 $lb->setTempTablesOnlyMode( self
::$useTemporaryTables, $lb->getLocalDomainID() );
1875 * Empty all tables so they can be repopulated for tests
1877 * @param Database $db|null Database to reset
1878 * @param array $tablesUsed Tables to reset
1880 private function resetDB( $db, $tablesUsed ) {
1882 $userTables = [ 'user', 'user_groups', 'user_properties', 'actor' ];
1884 'page', 'revision', 'ip_changes', 'revision_comment_temp', 'comment', 'archive',
1885 'revision_actor_temp', 'slots', 'content', 'content_models', 'slot_roles',
1887 $coreDBDataTables = array_merge( $userTables, $pageTables );
1889 // If any of the user or page tables were marked as used, we should clear all of them.
1890 if ( array_intersect( $tablesUsed, $userTables ) ) {
1891 $tablesUsed = array_unique( array_merge( $tablesUsed, $userTables ) );
1892 TestUserRegistry
::clear();
1894 // Reset $wgUser, which is probably 127.0.0.1, as its loaded data is probably not valid
1895 // @todo Should we start setting $wgUser to something nondeterministic
1896 // to encourage tests to be updated to not depend on it?
1898 $wgUser->clearInstanceCache( $wgUser->mFrom
);
1900 if ( array_intersect( $tablesUsed, $pageTables ) ) {
1901 $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
1904 // Postgres uses mwuser/pagecontent
1905 // instead of user/text. But Postgres does not remap the
1906 // table name in tableExists(), so we mark the real table
1907 // names as being used.
1908 if ( $db->getType() === 'postgres' ) {
1909 if ( in_array( 'user', $tablesUsed ) ) {
1910 $tablesUsed[] = 'mwuser';
1912 if ( in_array( 'text', $tablesUsed ) ) {
1913 $tablesUsed[] = 'pagecontent';
1917 foreach ( $tablesUsed as $tbl ) {
1918 $this->truncateTable( $tbl, $db );
1921 if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
1922 // Reset services that may contain information relating to the truncated tables
1923 $this->overrideMwServices();
1924 // Re-add core DB data that was deleted
1925 $this->addCoreDBData();
1931 * Empties the given table and resets any auto-increment counters.
1932 * Will also purge caches associated with some well known tables.
1933 * If the table is not know, this method just returns.
1935 * @param string $tableName
1936 * @param IDatabase|null $db
1938 protected function truncateTable( $tableName, IDatabase
$db = null ) {
1943 if ( !$db->tableExists( $tableName ) ) {
1947 $truncate = in_array( $db->getType(), [ 'mysql' ] );
1950 $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tableName ), __METHOD__
);
1952 $db->delete( $tableName, '*', __METHOD__
);
1955 if ( $db instanceof DatabasePostgres ||
$db instanceof DatabaseSqlite
) {
1956 // Reset the table's sequence too.
1957 $db->resetSequenceForTable( $tableName, __METHOD__
);
1960 // re-initialize site_stats table
1961 if ( $tableName === 'site_stats' ) {
1962 SiteStatsInit
::doPlaceholderInit();
1966 private static function unprefixTable( &$tableName, $ind, $prefix ) {
1967 $tableName = substr( $tableName, strlen( $prefix ) );
1970 private static function isNotUnittest( $table ) {
1971 return strpos( $table, self
::DB_PREFIX
) !== 0;
1977 * @param IMaintainableDatabase $db
1981 public static function listTables( IMaintainableDatabase
$db ) {
1982 $prefix = $db->tablePrefix();
1983 $tables = $db->listTables( $prefix, __METHOD__
);
1985 if ( $db->getType() === 'mysql' ) {
1986 static $viewListCache = null;
1987 if ( $viewListCache === null ) {
1988 $viewListCache = $db->listViews( null, __METHOD__
);
1990 // T45571: cannot clone VIEWs under MySQL
1991 $tables = array_diff( $tables, $viewListCache );
1993 array_walk( $tables, [ __CLASS__
, 'unprefixTable' ], $prefix );
1995 // Don't duplicate test tables from the previous fataled run
1996 $tables = array_filter( $tables, [ __CLASS__
, 'isNotUnittest' ] );
1998 if ( $db->getType() == 'sqlite' ) {
1999 $tables = array_flip( $tables );
2000 // these are subtables of searchindex and don't need to be duped/dropped separately
2001 unset( $tables['searchindex_content'] );
2002 unset( $tables['searchindex_segdir'] );
2003 unset( $tables['searchindex_segments'] );
2004 $tables = array_flip( $tables );
2011 * Copy test data from one database connection to another.
2013 * This should only be used for small data sets.
2015 * @param IDatabase $source
2016 * @param IDatabase $target
2018 public function copyTestData( IDatabase
$source, IDatabase
$target ) {
2019 if ( $this->db
->getType() === 'sqlite' ) {
2020 // SQLite uses a non-temporary copy of the searchindex table for testing,
2021 // which gets deleted and re-created when setting up the secondary connection,
2022 // causing "Error 17" when trying to copy the data. See T191863#4130112.
2023 throw new RuntimeException(
2024 'Setting up a secondary database connection with test data is currently not'
2025 . 'with SQLite. You may want to use markTestSkippedIfDbType() to bypass this issue.'
2029 $tables = self
::listOriginalTables( $source );
2031 foreach ( $tables as $table ) {
2032 $res = $source->select( $table, '*', [], __METHOD__
);
2035 foreach ( $res as $row ) {
2036 $allRows[] = (array)$row;
2039 $target->insert( $table, $allRows, __METHOD__
, [ 'IGNORE' ] );
2044 * @throws MWException
2047 protected function checkDbIsSupported() {
2048 if ( !in_array( $this->db
->getType(), $this->supportedDBs
) ) {
2049 throw new MWException( $this->db
->getType() . " is not currently supported for unit testing." );
2055 * @param string $offset
2058 public function getCliArg( $offset ) {
2059 return $this->cliArgs
[$offset] ??
null;
2064 * @param string $offset
2065 * @param mixed $value
2067 public function setCliArg( $offset, $value ) {
2068 $this->cliArgs
[$offset] = $value;
2072 * Don't throw a warning if $function is deprecated and called later
2076 * @param string $function
2078 public function hideDeprecated( $function ) {
2079 Wikimedia\
suppressWarnings();
2080 wfDeprecated( $function );
2081 Wikimedia\restoreWarnings
();
2085 * Asserts that the given database query yields the rows given by $expectedRows.
2086 * The expected rows should be given as indexed (not associative) arrays, with
2087 * the values given in the order of the columns in the $fields parameter.
2088 * Note that the rows are sorted by the columns given in $fields.
2092 * @param string|array $table The table(s) to query
2093 * @param string|array $fields The columns to include in the result (and to sort by)
2094 * @param string|array $condition "where" condition(s)
2095 * @param array $expectedRows An array of arrays giving the expected rows.
2096 * @param array $options Options for the query
2097 * @param array $join_conds Join conditions for the query
2099 * @throws MWException If this test cases's needsDB() method doesn't return true.
2100 * Test cases can use "@group Database" to enable database test support,
2101 * or list the tables under testing in $this->tablesUsed, or override the
2104 protected function assertSelect(
2105 $table, $fields, $condition, array $expectedRows, array $options = [], array $join_conds = []
2107 if ( !$this->needsDB() ) {
2108 throw new MWException( 'When testing database state, the test cases\'s needDB()' .
2109 ' method should return true. Use @group Database or $this->tablesUsed.' );
2112 $db = wfGetDB( DB_REPLICA
);
2119 $options +
[ 'ORDER BY' => $fields ],
2122 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
2126 foreach ( $expectedRows as $expected ) {
2127 $r = $res->fetchRow();
2128 self
::stripStringKeys( $r );
2131 $this->assertNotEmpty( $r, "row #$i missing" );
2133 $this->assertEquals( $expected, $r, "row #$i mismatches" );
2136 $r = $res->fetchRow();
2137 self
::stripStringKeys( $r );
2139 $this->assertFalse( $r, "found extra row (after #$i)" );
2143 * Utility method taking an array of elements and wrapping
2144 * each element in its own array. Useful for data providers
2145 * that only return a single argument.
2149 * @param array $elements
2153 protected function arrayWrap( array $elements ) {
2155 function ( $element ) {
2156 return [ $element ];
2163 * Assert that two arrays are equal. By default this means that both arrays need to hold
2164 * the same set of values. Using additional arguments, order and associated key can also
2165 * be set as relevant.
2169 * @param array $expected
2170 * @param array $actual
2171 * @param bool $ordered If the order of the values should match
2172 * @param bool $named If the keys should match
2174 protected function assertArrayEquals( array $expected, array $actual,
2175 $ordered = false, $named = false
2178 $this->objectAssociativeSort( $expected );
2179 $this->objectAssociativeSort( $actual );
2183 $expected = array_values( $expected );
2184 $actual = array_values( $actual );
2187 call_user_func_array(
2188 [ $this, 'assertEquals' ],
2189 array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
2194 * Put each HTML element on its own line and then equals() the results
2196 * Use for nicely formatting of PHPUnit diff output when comparing very
2201 * @param string $expected HTML on oneline
2202 * @param string $actual HTML on oneline
2203 * @param string $msg Optional message
2205 protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
2206 $expected = str_replace( '>', ">\n", $expected );
2207 $actual = str_replace( '>', ">\n", $actual );
2209 $this->assertEquals( $expected, $actual, $msg );
2213 * Does an associative sort that works for objects.
2217 * @param array &$array
2219 protected function objectAssociativeSort( array &$array ) {
2222 function ( $a, $b ) {
2223 return serialize( $a ) <=> serialize( $b );
2229 * Utility function for eliminating all string keys from an array.
2230 * Useful to turn a database result row as returned by fetchRow() into
2231 * a pure indexed array.
2235 * @param mixed &$r The array to remove string keys from.
2237 protected static function stripStringKeys( &$r ) {
2238 if ( !is_array( $r ) ) {
2242 foreach ( $r as $k => $v ) {
2243 if ( is_string( $k ) ) {
2250 * Asserts that the provided variable is of the specified
2251 * internal type or equals the $value argument. This is useful
2252 * for testing return types of functions that return a certain
2253 * type or *value* when not set or on error.
2257 * @param string $type
2258 * @param mixed $actual
2259 * @param mixed $value
2260 * @param string $message
2262 protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
2263 if ( $actual === $value ) {
2264 $this->assertTrue( true, $message );
2266 $this->assertType( $type, $actual, $message );
2271 * Asserts the type of the provided value. This can be either
2272 * in internal type such as boolean or integer, or a class or
2273 * interface the value extends or implements.
2277 * @param string $type
2278 * @param mixed $actual
2279 * @param string $message
2281 protected function assertType( $type, $actual, $message = '' ) {
2282 if ( class_exists( $type ) ||
interface_exists( $type ) ) {
2283 $this->assertInstanceOf( $type, $actual, $message );
2285 $this->assertInternalType( $type, $actual, $message );
2290 * Returns true if the given namespace defaults to Wikitext
2291 * according to $wgNamespaceContentModels
2293 * @param int $ns The namespace ID to check
2298 protected function isWikitextNS( $ns ) {
2299 global $wgNamespaceContentModels;
2301 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
2302 return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
;
2309 * Returns the ID of a namespace that defaults to Wikitext.
2311 * @throws MWException If there is none.
2312 * @return int The ID of the wikitext Namespace
2315 protected function getDefaultWikitextNS() {
2316 global $wgNamespaceContentModels;
2318 static $wikitextNS = null; // this is not going to change
2319 if ( $wikitextNS !== null ) {
2323 // quickly short out on most common case:
2324 if ( !isset( $wgNamespaceContentModels[NS_MAIN
] ) ) {
2328 // NOTE: prefer content namespaces
2329 $nsInfo = MediaWikiServices
::getInstance()->getNamespaceInfo();
2330 $namespaces = array_unique( array_merge(
2331 $nsInfo->getContentNamespaces(),
2332 [ NS_MAIN
, NS_HELP
, NS_PROJECT
], // prefer these
2333 $nsInfo->getValidNamespaces()
2336 $namespaces = array_diff( $namespaces, [
2337 NS_FILE
, NS_CATEGORY
, NS_MEDIAWIKI
, NS_USER
// don't mess with magic namespaces
2340 $talk = array_filter( $namespaces, function ( $ns ) use ( $nsInfo ) {
2341 return $nsInfo->isTalk( $ns );
2344 // prefer non-talk pages
2345 $namespaces = array_diff( $namespaces, $talk );
2346 $namespaces = array_merge( $namespaces, $talk );
2348 // check default content model of each namespace
2349 foreach ( $namespaces as $ns ) {
2350 if ( !isset( $wgNamespaceContentModels[$ns] ) ||
2351 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
2360 // @todo Inside a test, we could skip the test as incomplete.
2361 // But frequently, this is used in fixture setup.
2362 throw new MWException( "No namespace defaults to wikitext!" );
2366 * Check, if $wgDiff3 is set and ready to merge
2367 * Will mark the calling test as skipped, if not ready
2371 protected function markTestSkippedIfNoDiff3() {
2374 # This check may also protect against code injection in
2375 # case of broken installations.
2376 Wikimedia\
suppressWarnings();
2377 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2378 Wikimedia\restoreWarnings
();
2380 if ( !$haveDiff3 ) {
2381 $this->markTestSkipped( "Skip test, since diff3 is not configured" );
2386 * Check if $extName is a loaded PHP extension, will skip the
2387 * test whenever it is not loaded.
2390 * @param string $extName
2393 protected function checkPHPExtension( $extName ) {
2394 $loaded = extension_loaded( $extName );
2396 $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
2403 * Skip the test if using the specified database type
2405 * @param string $type Database type
2408 protected function markTestSkippedIfDbType( $type ) {
2409 if ( $this->db
->getType() === $type ) {
2410 $this->markTestSkipped( "The $type database type isn't supported for this test" );
2415 * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
2416 * @param string $buffer
2419 public static function wfResetOutputBuffersBarrier( $buffer ) {
2424 * Create a temporary hook handler which will be reset by tearDown.
2425 * This replaces other handlers for the same hook.
2426 * @param string $hookName Hook name
2427 * @param mixed $handler Value suitable for a hook handler
2430 protected function setTemporaryHook( $hookName, $handler ) {
2431 $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
2435 * Check whether file contains given data.
2436 * @param string $fileName
2437 * @param string $actualData
2438 * @param bool $createIfMissing If true, and file does not exist, create it with given data
2439 * and skip the test.
2440 * @param string $msg
2443 protected function assertFileContains(
2446 $createIfMissing = false,
2449 if ( $createIfMissing ) {
2450 if ( !file_exists( $fileName ) ) {
2451 file_put_contents( $fileName, $actualData );
2452 $this->markTestSkipped( "Data file $fileName does not exist" );
2455 self
::assertFileExists( $fileName );
2457 self
::assertEquals( file_get_contents( $fileName ), $actualData, $msg );
2461 * Edits or creates a page/revision
2462 * @param string $pageName Page title
2463 * @param string $text Content of the page
2464 * @param string $summary Optional summary string for the revision
2465 * @param int $defaultNs Optional namespace id
2466 * @param User|null $user If null, static::getTestSysop()->getUser() is used.
2467 * @return Status Object as returned by WikiPage::doEditContent()
2468 * @throws MWException If this test cases's needsDB() method doesn't return true.
2469 * Test cases can use "@group Database" to enable database test support,
2470 * or list the tables under testing in $this->tablesUsed, or override the
2473 protected function editPage(
2477 $defaultNs = NS_MAIN
,
2480 if ( !$this->needsDB() ) {
2481 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
2482 ' method should return true. Use @group Database or $this->tablesUsed.' );
2485 $title = Title
::newFromText( $pageName, $defaultNs );
2486 $page = WikiPage
::factory( $title );
2488 return $page->doEditContent(
2489 ContentHandler
::makeContent( $text, $title ),
2498 * Revision-deletes a revision.
2500 * @param Revision|int $rev Revision to delete
2501 * @param array $value Keys are Revision::DELETED_* flags. Values are 1 to set the bit, 0 to
2502 * clear, -1 to leave alone. (All other values also clear the bit.)
2503 * @param string $comment Deletion comment
2505 protected function revisionDelete(
2506 $rev, array $value = [ Revision
::DELETED_TEXT
=> 1 ], $comment = ''
2508 if ( is_int( $rev ) ) {
2509 $rev = Revision
::newFromId( $rev );
2511 RevisionDeleter
::createList(
2512 'revision', RequestContext
::getMain(), $rev->getTitle(), [ $rev->getId() ]
2515 'comment' => $comment,
2520 class_alias( 'MediaWikiIntegrationTestCase', 'MediaWikiTestCase' );