3 use MediaWiki\Logger\LegacySpi
;
4 use MediaWiki\Logger\LoggerFactory
;
5 use MediaWiki\Logger\MonologSpi
;
6 use MediaWiki\MediaWikiServices
;
7 use Psr\Log\LoggerInterface
;
8 use Wikimedia\Rdbms\IDatabase
;
9 use Wikimedia\Rdbms\IMaintainableDatabase
;
10 use Wikimedia\Rdbms\Database
;
11 use Wikimedia\Rdbms\LBFactory
;
12 use Wikimedia\TestingAccessWrapper
;
17 abstract class MediaWikiTestCase
extends PHPUnit\Framework\TestCase
{
19 use MediaWikiCoversValidator
;
20 use PHPUnit4And6Compat
;
23 * The service locator created by prepareServices(). This service locator will
24 * be restored after each test. Tests that pollute the global service locator
25 * instance should use overrideMwServices() to isolate the test.
27 * @var MediaWikiServices|null
29 private static $serviceLocator = null;
32 * $called tracks whether the setUp and tearDown method has been called.
33 * class extending MediaWikiTestCase usually override setUp and tearDown
34 * but forget to call the parent.
36 * The array format takes a method name as key and anything as a value.
37 * By asserting the key exist, we know the child class has called the
40 * This property must be private, we do not want child to override it,
41 * they should call the appropriate parent method instead.
63 protected $tablesUsed = []; // tables with data
65 private static $useTemporaryTables = true;
66 private static $reuseDB = false;
67 private static $dbSetup = false;
68 private static $oldTablePrefix = '';
71 * Original value of PHP's error_reporting setting.
75 private $phpErrorLevel;
78 * Holds the paths of temporary files/directories created through getNewTempFile,
79 * and getNewTempDirectory
83 private $tmpFiles = [];
86 * Holds original values of MediaWiki configuration settings
87 * to be restored in tearDown().
88 * See also setMwGlobals().
91 private $mwGlobals = [];
94 * Holds list of MediaWiki configuration settings to be unset in tearDown().
95 * See also setMwGlobals().
98 private $mwGlobalsToUnset = [];
101 * Holds original contents of interwiki table
102 * @var IResultWrapper
104 private $interwikiTable = null;
107 * Holds original loggers which have been replaced by setLogger()
108 * @var LoggerInterface[]
110 private $loggers = [];
113 * Table name prefixes. Oracle likes it shorter.
115 const DB_PREFIX
= 'unittest_';
116 const ORA_DB_PREFIX
= 'ut_';
122 protected $supportedDBs = [
129 public function __construct( $name = null, array $data = [], $dataName = '' ) {
130 parent
::__construct( $name, $data, $dataName );
132 $this->backupGlobals
= false;
133 $this->backupStaticAttributes
= false;
136 public function __destruct() {
137 // Complain if self::setUp() was called, but not self::tearDown()
138 // $this->called['setUp'] will be checked by self::testMediaWikiTestCaseParentSetupCalled()
139 if ( isset( $this->called
['setUp'] ) && !isset( $this->called
['tearDown'] ) ) {
140 throw new MWException( static::class . "::tearDown() must call parent::tearDown()" );
144 public static function setUpBeforeClass() {
145 parent
::setUpBeforeClass();
147 // Get the service locator, and reset services if it's not done already
148 self
::$serviceLocator = self
::prepareServices( new GlobalVarConfig() );
152 * Convenience method for getting an immutable test user
156 * @param string[] $groups Groups the test user should be in.
159 public static function getTestUser( $groups = [] ) {
160 return TestUserRegistry
::getImmutableTestUser( $groups );
164 * Convenience method for getting a mutable test user
168 * @param string[] $groups Groups the test user should be added in.
171 public static function getMutableTestUser( $groups = [] ) {
172 return TestUserRegistry
::getMutableTestUser( __CLASS__
, $groups );
176 * Convenience method for getting an immutable admin test user
180 * @param string[] $groups Groups the test user should be added to.
183 public static function getTestSysop() {
184 return self
::getTestUser( [ 'sysop', 'bureaucrat' ] );
188 * Returns a WikiPage representing an existing page.
192 * @param Title|string|null $title
194 * @throws MWException
196 protected function getExistingTestPage( $title = null ) {
197 $title = ( $title === null ) ?
'UTPage' : $title;
198 $title = is_string( $title ) ? Title
::newFromText( $title ) : $title;
199 $page = WikiPage
::factory( $title );
201 if ( !$page->exists() ) {
202 $user = self
::getTestSysop()->getUser();
203 $page->doEditContent(
204 new WikitextContent( 'UTContent' ),
206 EDIT_NEW | EDIT_SUPPRESS_RC
,
216 * Returns a WikiPage representing a non-existing page.
220 * @param Title|string|null $title
222 * @throws MWException
224 protected function getNonexistingTestPage( $title = null ) {
225 $title = ( $title === null ) ?
'UTPage-' . rand( 0, 100000 ) : $title;
226 $title = is_string( $title ) ? Title
::newFromText( $title ) : $title;
227 $page = WikiPage
::factory( $title );
229 if ( $page->exists() ) {
230 $page->doDeleteArticle( 'Testing' );
237 * Prepare service configuration for unit testing.
239 * This calls MediaWikiServices::resetGlobalInstance() to allow some critical services
240 * to be overridden for testing.
242 * prepareServices() only needs to be called once, but should be called as early as possible,
243 * before any class has a chance to grab a reference to any of the global services
244 * instances that get discarded by prepareServices(). Only the first call has any effect,
245 * later calls are ignored.
247 * @note This is called by PHPUnitMaintClass::finalSetup.
249 * @see MediaWikiServices::resetGlobalInstance()
251 * @param Config $bootstrapConfig The bootstrap config to use with the new
252 * MediaWikiServices. Only used for the first call to this method.
253 * @return MediaWikiServices
255 public static function prepareServices( Config
$bootstrapConfig ) {
256 static $services = null;
259 $services = self
::resetGlobalServices( $bootstrapConfig );
265 * Reset global services, and install testing environment.
266 * This is the testing equivalent of MediaWikiServices::resetGlobalInstance().
267 * This should only be used to set up the testing environment, not when
268 * running unit tests. Use MediaWikiTestCase::overrideMwServices() for that.
270 * @see MediaWikiServices::resetGlobalInstance()
271 * @see prepareServices()
272 * @see MediaWikiTestCase::overrideMwServices()
274 * @param Config|null $bootstrapConfig The bootstrap config to use with the new
276 * @return MediaWikiServices
278 protected static function resetGlobalServices( Config
$bootstrapConfig = null ) {
279 $oldServices = MediaWikiServices
::getInstance();
280 $oldConfigFactory = $oldServices->getConfigFactory();
281 $oldLoadBalancerFactory = $oldServices->getDBLoadBalancerFactory();
283 $testConfig = self
::makeTestConfig( $bootstrapConfig );
285 MediaWikiServices
::resetGlobalInstance( $testConfig );
287 $serviceLocator = MediaWikiServices
::getInstance();
288 self
::installTestServices(
290 $oldLoadBalancerFactory,
293 return $serviceLocator;
297 * Create a config suitable for testing, based on a base config, default overrides,
298 * and custom overrides.
300 * @param Config|null $baseConfig
301 * @param Config|null $customOverrides
305 private static function makeTestConfig(
306 Config
$baseConfig = null,
307 Config
$customOverrides = null
309 $defaultOverrides = new HashConfig();
311 if ( !$baseConfig ) {
312 $baseConfig = MediaWikiServices
::getInstance()->getBootstrapConfig();
315 /* Some functions require some kind of caching, and will end up using the db,
316 * which we can't allow, as that would open a new connection for mysql.
317 * Replace with a HashBag. They would not be going to persist anyway.
319 $hashCache = [ 'class' => HashBagOStuff
::class, 'reportDupes' => false ];
321 CACHE_DB
=> $hashCache,
322 CACHE_ACCEL
=> $hashCache,
323 CACHE_MEMCACHED
=> $hashCache,
325 'apcu' => $hashCache,
326 'wincache' => $hashCache,
327 ] +
$baseConfig->get( 'ObjectCaches' );
329 $defaultOverrides->set( 'ObjectCaches', $objectCaches );
330 $defaultOverrides->set( 'MainCacheType', CACHE_NONE
);
331 $defaultOverrides->set( 'JobTypeConf', [ 'default' => [ 'class' => JobQueueMemory
::class ] ] );
333 // Use a fast hash algorithm to hash passwords.
334 $defaultOverrides->set( 'PasswordDefault', 'A' );
336 $testConfig = $customOverrides
337 ?
new MultiConfig( [ $customOverrides, $defaultOverrides, $baseConfig ] )
338 : new MultiConfig( [ $defaultOverrides, $baseConfig ] );
344 * @param ConfigFactory $oldConfigFactory
345 * @param LBFactory $oldLoadBalancerFactory
346 * @param MediaWikiServices $newServices
348 * @throws MWException
350 private static function installTestServices(
351 ConfigFactory
$oldConfigFactory,
352 LBFactory
$oldLoadBalancerFactory,
353 MediaWikiServices
$newServices
355 // Use bootstrap config for all configuration.
356 // This allows config overrides via global variables to take effect.
357 $bootstrapConfig = $newServices->getBootstrapConfig();
358 $newServices->resetServiceForTesting( 'ConfigFactory' );
359 $newServices->redefineService(
361 self
::makeTestConfigFactoryInstantiator(
363 [ 'main' => $bootstrapConfig ]
366 $newServices->resetServiceForTesting( 'DBLoadBalancerFactory' );
367 $newServices->redefineService(
368 'DBLoadBalancerFactory',
369 function ( MediaWikiServices
$services ) use ( $oldLoadBalancerFactory ) {
370 return $oldLoadBalancerFactory;
376 * @param ConfigFactory $oldFactory
377 * @param Config[] $configurations
381 private static function makeTestConfigFactoryInstantiator(
382 ConfigFactory
$oldFactory,
383 array $configurations
385 return function ( MediaWikiServices
$services ) use ( $oldFactory, $configurations ) {
386 $factory = new ConfigFactory();
388 // clone configurations from $oldFactory that are not overwritten by $configurations
389 $namesToClone = array_diff(
390 $oldFactory->getConfigNames(),
391 array_keys( $configurations )
394 foreach ( $namesToClone as $name ) {
395 $factory->register( $name, $oldFactory->makeConfig( $name ) );
398 foreach ( $configurations as $name => $config ) {
399 $factory->register( $name, $config );
407 * Resets some well known services that typically have state that may interfere with unit tests.
408 * This is a lightweight alternative to resetGlobalServices().
410 * @note There is no guarantee that no references remain to stale service instances destroyed
411 * by a call to doLightweightServiceReset().
413 * @throws MWException if called outside of PHPUnit tests.
415 * @see resetGlobalServices()
417 private function doLightweightServiceReset() {
418 global $wgRequest, $wgJobClasses;
420 foreach ( $wgJobClasses as $type => $class ) {
421 JobQueueGroup
::singleton()->get( $type )->delete();
423 JobQueueGroup
::destroySingletons();
425 ObjectCache
::clear();
426 $services = MediaWikiServices
::getInstance();
427 $services->resetServiceForTesting( 'MainObjectStash' );
428 $services->resetServiceForTesting( 'LocalServerObjectCache' );
429 $services->getMainWANObjectCache()->clearProcessCache();
430 FileBackendGroup
::destroySingleton();
431 DeferredUpdates
::clearPendingUpdates();
433 // TODO: move global state into MediaWikiServices
434 RequestContext
::resetMain();
435 if ( session_id() !== '' ) {
436 session_write_close();
440 $wgRequest = new FauxRequest();
441 MediaWiki\Session\SessionManager
::resetCache();
444 public function run( PHPUnit_Framework_TestResult
$result = null ) {
445 $needsResetDB = false;
447 if ( !self
::$dbSetup ||
$this->needsDB() ) {
448 // set up a DB connection for this test to use
450 self
::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
451 self
::$reuseDB = $this->getCliArg( 'reuse-db' );
453 $this->db
= wfGetDB( DB_MASTER
);
455 $this->checkDbIsSupported();
457 if ( !self
::$dbSetup ) {
458 $this->setupAllTestDBs();
459 $this->addCoreDBData();
462 // TODO: the DB setup should be done in setUpBeforeClass(), so the test DB
463 // is available in subclass's setUpBeforeClass() and setUp() methods.
464 // This would also remove the need for the HACK that is oncePerClass().
465 if ( $this->oncePerClass() ) {
466 $this->setUpSchema( $this->db
);
467 $this->resetDB( $this->db
, $this->tablesUsed
);
468 $this->addDBDataOnce();
472 $needsResetDB = true;
475 parent
::run( $result );
477 if ( $needsResetDB ) {
478 $this->resetDB( $this->db
, $this->tablesUsed
);
485 private function oncePerClass() {
486 // Remember current test class in the database connection,
487 // so we know when we need to run addData.
489 $class = static::class;
491 $first = !isset( $this->db
->_hasDataForTestClass
)
492 ||
$this->db
->_hasDataForTestClass
!== $class;
494 $this->db
->_hasDataForTestClass
= $class;
503 public function usesTemporaryTables() {
504 return self
::$useTemporaryTables;
508 * Obtains a new temporary file name
510 * The obtained filename is enlisted to be removed upon tearDown
514 * @return string Absolute name of the temporary file
516 protected function getNewTempFile() {
517 $fileName = tempnam( wfTempDir(), 'MW_PHPUnit_' . static::class . '_' );
518 $this->tmpFiles
[] = $fileName;
524 * obtains a new temporary directory
526 * The obtained directory is enlisted to be removed (recursively with all its contained
527 * files) upon tearDown.
531 * @return string Absolute name of the temporary directory
533 protected function getNewTempDirectory() {
534 // Starting of with a temporary /file/.
535 $fileName = $this->getNewTempFile();
537 // Converting the temporary /file/ to a /directory/
538 // The following is not atomic, but at least we now have a single place,
539 // where temporary directory creation is bundled and can be improved
541 $this->assertTrue( wfMkdirParents( $fileName ) );
546 protected function setUp() {
548 $this->called
['setUp'] = true;
550 $this->phpErrorLevel
= intval( ini_get( 'error_reporting' ) );
552 // Cleaning up temporary files
553 foreach ( $this->tmpFiles
as $fileName ) {
554 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
556 } elseif ( is_dir( $fileName ) ) {
557 wfRecursiveRemoveDir( $fileName );
561 if ( $this->needsDB() && $this->db
) {
562 // Clean up open transactions
563 while ( $this->db
->trxLevel() > 0 ) {
564 $this->db
->rollback( __METHOD__
, 'flush' );
566 // Check for unsafe queries
567 if ( $this->db
->getType() === 'mysql' ) {
568 $this->db
->query( "SET sql_mode = 'STRICT_ALL_TABLES'" );
572 // Store contents of interwiki table in case it changes. Unfortunately, we seem to have no
573 // way to do this only when needed, because tablesUsed can be changed mid-test.
575 $this->interwikiTable
= $this->db
->select( 'interwiki', '*', '', __METHOD__
);
578 // Reset all caches between tests.
579 $this->doLightweightServiceReset();
581 // XXX: reset maintenance triggers
582 // Hook into period lag checks which often happen in long-running scripts
583 $services = MediaWikiServices
::getInstance();
584 $lbFactory = $services->getDBLoadBalancerFactory();
585 Maintenance
::setLBFactoryTriggers( $lbFactory, $services->getMainConfig() );
587 ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
590 protected function addTmpFiles( $files ) {
591 $this->tmpFiles
= array_merge( $this->tmpFiles
, (array)$files );
594 protected function tearDown() {
595 global $wgRequest, $wgSQLMode;
597 $status = ob_get_status();
598 if ( isset( $status['name'] ) &&
599 $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier'
604 $this->called
['tearDown'] = true;
605 // Cleaning up temporary files
606 foreach ( $this->tmpFiles
as $fileName ) {
607 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
609 } elseif ( is_dir( $fileName ) ) {
610 wfRecursiveRemoveDir( $fileName );
614 if ( $this->needsDB() && $this->db
) {
615 // Clean up open transactions
616 while ( $this->db
->trxLevel() > 0 ) {
617 $this->db
->rollback( __METHOD__
, 'flush' );
619 if ( $this->db
->getType() === 'mysql' ) {
620 $this->db
->query( "SET sql_mode = " . $this->db
->addQuotes( $wgSQLMode ) );
624 // Restore mw globals
625 foreach ( $this->mwGlobals
as $key => $value ) {
626 $GLOBALS[$key] = $value;
628 foreach ( $this->mwGlobalsToUnset
as $value ) {
629 unset( $GLOBALS[$value] );
631 $this->mwGlobals
= [];
632 $this->mwGlobalsToUnset
= [];
633 $this->restoreLoggers();
635 if ( self
::$serviceLocator && MediaWikiServices
::getInstance() !== self
::$serviceLocator ) {
636 MediaWikiServices
::forceGlobalInstance( self
::$serviceLocator );
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
685 * @param string $name
686 * @param object $object
688 protected function setService( $name, $object ) {
689 // If we did not yet override the service locator, so so now.
690 if ( MediaWikiServices
::getInstance() === self
::$serviceLocator ) {
691 $this->overrideMwServices();
694 MediaWikiServices
::getInstance()->disableService( $name );
695 MediaWikiServices
::getInstance()->redefineService(
697 function () use ( $object ) {
704 * Sets a global, maintaining a stashed version of the previous global to be
705 * restored in tearDown
707 * The key is added to the array of globals that will be reset afterwards
712 * protected function setUp() {
713 * $this->setMwGlobals( 'wgRestrictStuff', true );
716 * function testFoo() {}
718 * function testBar() {}
719 * $this->assertTrue( self::getX()->doStuff() );
721 * $this->setMwGlobals( 'wgRestrictStuff', false );
722 * $this->assertTrue( self::getX()->doStuff() );
725 * function testQuux() {}
728 * @param array|string $pairs Key to the global variable, or an array
729 * of key/value pairs.
730 * @param mixed|null $value Value to set the global to (ignored
731 * if an array is given as first argument).
733 * @note To allow changes to global variables to take effect on global service instances,
734 * call overrideMwServices().
738 protected function setMwGlobals( $pairs, $value = null ) {
739 if ( is_string( $pairs ) ) {
740 $pairs = [ $pairs => $value ];
743 $this->stashMwGlobals( array_keys( $pairs ) );
745 foreach ( $pairs as $key => $value ) {
746 $GLOBALS[$key] = $value;
751 * Check if we can back up a value by performing a shallow copy.
752 * Values which fail this test are copied recursively.
754 * @param mixed $value
755 * @return bool True if a shallow copy will do; false if a deep copy
758 private static function canShallowCopy( $value ) {
759 if ( is_scalar( $value ) ||
$value === null ) {
762 if ( is_array( $value ) ) {
763 foreach ( $value as $subValue ) {
764 if ( !is_scalar( $subValue ) && $subValue !== null ) {
774 * Stashes the global, will be restored in tearDown()
776 * Individual test functions may override globals through the setMwGlobals() function
777 * or directly. When directly overriding globals their keys should first be passed to this
778 * method in setUp to avoid breaking global state for other tests
780 * That way all other tests are executed with the same settings (instead of using the
781 * unreliable local settings for most tests and fix it only for some tests).
783 * @param array|string $globalKeys Key to the global variable, or an array of keys.
785 * @note To allow changes to global variables to take effect on global service instances,
786 * call overrideMwServices().
790 protected function stashMwGlobals( $globalKeys ) {
791 if ( is_string( $globalKeys ) ) {
792 $globalKeys = [ $globalKeys ];
795 foreach ( $globalKeys as $globalKey ) {
796 // NOTE: make sure we only save the global once or a second call to
797 // setMwGlobals() on the same global would override the original
800 !array_key_exists( $globalKey, $this->mwGlobals
) &&
801 !array_key_exists( $globalKey, $this->mwGlobalsToUnset
)
803 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
804 $this->mwGlobalsToUnset
[$globalKey] = $globalKey;
807 // NOTE: we serialize then unserialize the value in case it is an object
808 // this stops any objects being passed by reference. We could use clone
809 // and if is_object but this does account for objects within objects!
810 if ( self
::canShallowCopy( $GLOBALS[$globalKey] ) ) {
811 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
813 // Many MediaWiki types are safe to clone. These are the
814 // ones that are most commonly stashed.
815 $GLOBALS[$globalKey] instanceof Language ||
816 $GLOBALS[$globalKey] instanceof User ||
817 $GLOBALS[$globalKey] instanceof FauxRequest
819 $this->mwGlobals
[$globalKey] = clone $GLOBALS[$globalKey];
820 } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
821 // Serializing Closure only gives a warning on HHVM while
822 // it throws an Exception on Zend.
823 // Workaround for https://github.com/facebook/hhvm/issues/6206
824 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
827 $this->mwGlobals
[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
828 } catch ( Exception
$e ) {
829 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
838 * @param int $maxDepth
842 private function containsClosure( $var, $maxDepth = 15 ) {
843 if ( $var instanceof Closure
) {
846 if ( !is_array( $var ) ||
$maxDepth === 0 ) {
850 foreach ( $var as $value ) {
851 if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
859 * Merges the given values into a MW global array variable.
860 * Useful for setting some entries in a configuration array, instead of
861 * setting the entire array.
863 * @param string $name The name of the global, as in wgFooBar
864 * @param array $values The array containing the entries to set in that global
866 * @throws MWException If the designated global is not an array.
868 * @note To allow changes to global variables to take effect on global service instances,
869 * call overrideMwServices().
873 protected function mergeMwGlobalArrayValue( $name, $values ) {
874 if ( !isset( $GLOBALS[$name] ) ) {
877 if ( !is_array( $GLOBALS[$name] ) ) {
878 throw new MWException( "MW global $name is not an array." );
881 // NOTE: do not use array_merge, it screws up for numeric keys.
882 $merged = $GLOBALS[$name];
883 foreach ( $values as $k => $v ) {
888 $this->setMwGlobals( $name, $merged );
892 * Stashes the global instance of MediaWikiServices, and installs a new one,
893 * allowing test cases to override settings and services.
894 * The previous instance of MediaWikiServices will be restored on tearDown.
898 * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
900 * @param callable[] $services An associative array of services to re-define. Keys are service
901 * names, values are callables.
903 * @return MediaWikiServices
904 * @throws MWException
906 protected function overrideMwServices( Config
$configOverrides = null, array $services = [] ) {
907 if ( !$configOverrides ) {
908 $configOverrides = new HashConfig();
911 $oldInstance = MediaWikiServices
::getInstance();
912 $oldConfigFactory = $oldInstance->getConfigFactory();
913 $oldLoadBalancerFactory = $oldInstance->getDBLoadBalancerFactory();
915 $testConfig = self
::makeTestConfig( null, $configOverrides );
916 $newInstance = new MediaWikiServices( $testConfig );
918 // Load the default wiring from the specified files.
919 // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
920 $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
921 $newInstance->loadWiringFiles( $wiringFiles );
923 // Provide a traditional hook point to allow extensions to configure services.
924 Hooks
::run( 'MediaWikiServices', [ $newInstance ] );
926 foreach ( $services as $name => $callback ) {
927 $newInstance->redefineService( $name, $callback );
930 self
::installTestServices(
932 $oldLoadBalancerFactory,
935 MediaWikiServices
::forceGlobalInstance( $newInstance );
942 * @param string|Language $lang
944 public function setUserLang( $lang ) {
945 RequestContext
::getMain()->setLanguage( $lang );
946 $this->setMwGlobals( 'wgLang', RequestContext
::getMain()->getLanguage() );
951 * @param string|Language $lang
953 public function setContentLang( $lang ) {
954 if ( $lang instanceof Language
) {
955 $langCode = $lang->getCode();
959 $langObj = Language
::factory( $langCode );
961 $this->setMwGlobals( [
962 'wgLanguageCode' => $langCode,
963 'wgContLang' => $langObj,
968 * Alters $wgGroupPermissions for the duration of the test. Can be called
969 * with an array, like
970 * [ '*' => [ 'read' => false ], 'user' => [ 'read' => false ] ]
971 * or three values to set a single permission, like
972 * $this->setGroupPermissions( '*', 'read', false );
975 * @param array|string $newPerms Either an array of permissions to change,
976 * in which case the next two parameters are ignored; or a single string
977 * identifying a group, to use with the next two parameters.
978 * @param string|null $newKey
979 * @param mixed|null $newValue
981 public function setGroupPermissions( $newPerms, $newKey = null, $newValue = null ) {
982 global $wgGroupPermissions;
984 $this->stashMwGlobals( 'wgGroupPermissions' );
986 if ( is_string( $newPerms ) ) {
987 $newPerms = [ $newPerms => [ $newKey => $newValue ] ];
990 foreach ( $newPerms as $group => $permissions ) {
991 foreach ( $permissions as $key => $value ) {
992 $wgGroupPermissions[$group][$key] = $value;
998 * Sets the logger for a specified channel, for the duration of the test.
1000 * @param string $channel
1001 * @param LoggerInterface $logger
1003 protected function setLogger( $channel, LoggerInterface
$logger ) {
1004 // TODO: Once loggers are managed by MediaWikiServices, use
1005 // overrideMwServices() to set loggers.
1007 $provider = LoggerFactory
::getProvider();
1008 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
1009 $singletons = $wrappedProvider->singletons
;
1010 if ( $provider instanceof MonologSpi
) {
1011 if ( !isset( $this->loggers
[$channel] ) ) {
1012 $this->loggers
[$channel] = $singletons['loggers'][$channel] ??
null;
1014 $singletons['loggers'][$channel] = $logger;
1015 } elseif ( $provider instanceof LegacySpi
) {
1016 if ( !isset( $this->loggers
[$channel] ) ) {
1017 $this->loggers
[$channel] = $singletons[$channel] ??
null;
1019 $singletons[$channel] = $logger;
1021 throw new LogicException( __METHOD__
. ': setting a logger for ' . get_class( $provider )
1022 . ' is not implemented' );
1024 $wrappedProvider->singletons
= $singletons;
1028 * Restores loggers replaced by setLogger().
1031 private function restoreLoggers() {
1032 $provider = LoggerFactory
::getProvider();
1033 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
1034 $singletons = $wrappedProvider->singletons
;
1035 foreach ( $this->loggers
as $channel => $logger ) {
1036 if ( $provider instanceof MonologSpi
) {
1037 if ( $logger === null ) {
1038 unset( $singletons['loggers'][$channel] );
1040 $singletons['loggers'][$channel] = $logger;
1042 } elseif ( $provider instanceof LegacySpi
) {
1043 if ( $logger === null ) {
1044 unset( $singletons[$channel] );
1046 $singletons[$channel] = $logger;
1050 $wrappedProvider->singletons
= $singletons;
1051 $this->loggers
= [];
1058 public function dbPrefix() {
1059 return self
::getTestPrefixFor( $this->db
);
1063 * @param IDatabase $db
1067 public static function getTestPrefixFor( IDatabase
$db ) {
1068 return $db->getType() == 'oracle' ? self
::ORA_DB_PREFIX
: self
::DB_PREFIX
;
1075 public function needsDB() {
1076 // If the test says it uses database tables, it needs the database
1077 if ( $this->tablesUsed
) {
1081 // If the test class says it belongs to the Database group, it needs the database.
1082 // NOTE: This ONLY checks for the group in the class level doc comment.
1083 $rc = new ReflectionClass( $this );
1084 if ( preg_match( '/@group +Database/im', $rc->getDocComment() ) ) {
1092 * Insert a new page.
1094 * Should be called from addDBData().
1096 * @since 1.25 ($namespace in 1.28)
1097 * @param string|Title $pageName Page name or title
1098 * @param string $text Page's content
1099 * @param int|null $namespace Namespace id (name cannot already contain namespace)
1100 * @param User|null $user If null, static::getTestSysop()->getUser() is used.
1101 * @return array Title object and page id
1103 protected function insertPage(
1105 $text = 'Sample page for unit test.',
1109 if ( is_string( $pageName ) ) {
1110 $title = Title
::newFromText( $pageName, $namespace );
1116 $user = static::getTestSysop()->getUser();
1118 $comment = __METHOD__
. ': Sample page for unit test.';
1120 $page = WikiPage
::factory( $title );
1121 $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $comment, 0, false, $user );
1125 'id' => $page->getId(),
1130 * Stub. If a test suite needs to add additional data to the database, it should
1131 * implement this method and do so. This method is called once per test suite
1132 * (i.e. once per class).
1134 * Note data added by this method may be removed by resetDB() depending on
1135 * the contents of $tablesUsed.
1137 * To add additional data between test function runs, override prepareDB().
1144 public function addDBDataOnce() {
1148 * Stub. Subclasses may override this to prepare the database.
1149 * Called before every test run (test function or data set).
1151 * @see addDBDataOnce()
1156 public function addDBData() {
1162 protected function addCoreDBData() {
1163 if ( $this->db
->getType() == 'oracle' ) {
1164 # Insert 0 user to prevent FK violations
1166 if ( !$this->db
->selectField( 'user', '1', [ 'user_id' => 0 ] ) ) {
1167 $this->db
->insert( 'user', [
1169 'user_name' => 'Anonymous' ], __METHOD__
, [ 'IGNORE' ] );
1172 # Insert 0 page to prevent FK violations
1174 if ( !$this->db
->selectField( 'page', '1', [ 'page_id' => 0 ] ) ) {
1175 $this->db
->insert( 'page', [
1177 'page_namespace' => 0,
1178 'page_title' => ' ',
1179 'page_restrictions' => null,
1180 'page_is_redirect' => 0,
1183 'page_touched' => $this->db
->timestamp(),
1185 'page_len' => 0 ], __METHOD__
, [ 'IGNORE' ] );
1189 SiteStatsInit
::doPlaceholderInit();
1191 User
::resetIdByNameCache();
1194 $user = static::getTestSysop()->getUser();
1196 // Make 1 page with 1 revision
1197 $page = WikiPage
::factory( Title
::newFromText( 'UTPage' ) );
1198 if ( $page->getId() == 0 ) {
1199 $page->doEditContent(
1200 new WikitextContent( 'UTContent' ),
1202 EDIT_NEW | EDIT_SUPPRESS_RC
,
1206 // an edit always attempt to purge backlink links such as history
1207 // pages. That is unneccessary.
1208 JobQueueGroup
::singleton()->get( 'htmlCacheUpdate' )->delete();
1209 // WikiPages::doEditUpdates randomly adds RC purges
1210 JobQueueGroup
::singleton()->get( 'recentChangesUpdate' )->delete();
1212 // doEditContent() probably started the session via
1213 // User::loadFromSession(). Close it now.
1214 if ( session_id() !== '' ) {
1215 session_write_close();
1222 * Restores MediaWiki to using the table set (table prefix) it was using before
1223 * setupTestDB() was called. Useful if we need to perform database operations
1224 * after the test run has finished (such as saving logs or profiling info).
1226 * This is called by phpunit/bootstrap.php after the last test.
1230 public static function teardownTestDB() {
1231 global $wgJobClasses;
1233 if ( !self
::$dbSetup ) {
1237 Hooks
::run( 'UnitTestsBeforeDatabaseTeardown' );
1239 foreach ( $wgJobClasses as $type => $class ) {
1240 // Delete any jobs under the clone DB (or old prefix in other stores)
1241 JobQueueGroup
::singleton()->get( $type )->delete();
1244 CloneDatabase
::changePrefix( self
::$oldTablePrefix );
1246 self
::$oldTablePrefix = false;
1247 self
::$dbSetup = false;
1251 * Prepares the given database connection for usage in the context of usage tests.
1252 * This sets up clones database tables and changes the table prefix as appropriate.
1253 * If the database connection already has cloned tables, calling this method has no
1254 * effect. The tables are not re-cloned or reset in that case.
1256 * @param IMaintainableDatabase $db
1258 protected function prepareConnectionForTesting( IMaintainableDatabase
$db ) {
1259 if ( !self
::$dbSetup ) {
1260 throw new LogicException(
1261 'Cannot use prepareConnectionForTesting()'
1262 . ' if the test case is not defined to use the database!'
1266 if ( isset( $db->_originalTablePrefix
) ) {
1267 // The DB connection was already prepared for testing.
1271 $testPrefix = self
::getTestPrefixFor( $db );
1272 $oldPrefix = $db->tablePrefix();
1274 $tablesCloned = self
::listTables( $db );
1276 if ( $oldPrefix === $testPrefix ) {
1277 // The database connection already has the test prefix, but presumably not
1278 // the cloned tables. This is the typical case, since the LBFactory will
1279 // have the prefix set during testing, but LoadBalancers will still return
1280 // connections that don't have the cloned table structure.
1281 $oldPrefix = self
::$oldTablePrefix;
1284 $dbClone = new CloneDatabase( $db, $tablesCloned, $testPrefix, $oldPrefix );
1285 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1287 $db->_originalTablePrefix
= $oldPrefix;
1289 if ( ( $db->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
1290 throw new LogicException( 'Cannot clone database tables' );
1292 $dbClone->cloneTableStructure();
1297 * Setups a database with cloned tables using the given prefix.
1299 * If reuseDB is true and certain conditions apply, it will just change the prefix.
1300 * Otherwise, it will clone the tables and change the prefix.
1302 * @param IMaintainableDatabase $db Database to use
1303 * @param string|null $prefix Prefix to use for test tables. If not given, the prefix is determined
1304 * automatically for $db.
1305 * @return bool True if tables were cloned, false if only the prefix was changed
1307 protected static function setupDatabaseWithTestPrefix(
1308 IMaintainableDatabase
$db,
1311 if ( $prefix === null ) {
1312 $prefix = self
::getTestPrefixFor( $db );
1315 if ( ( $db->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
1316 $db->tablePrefix( $prefix );
1320 if ( !isset( $db->_originalTablePrefix
) ) {
1321 $oldPrefix = $db->tablePrefix();
1323 if ( $oldPrefix === $prefix ) {
1324 // table already has the correct prefix, but presumably no cloned tables
1325 $oldPrefix = self
::$oldTablePrefix;
1328 $db->tablePrefix( $oldPrefix );
1329 $tablesCloned = self
::listTables( $db );
1330 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix, $oldPrefix );
1331 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1333 $dbClone->cloneTableStructure();
1335 $db->tablePrefix( $prefix );
1336 $db->_originalTablePrefix
= $oldPrefix;
1343 * Set up all test DBs
1345 public function setupAllTestDBs() {
1348 self
::$oldTablePrefix = $wgDBprefix;
1350 $testPrefix = $this->dbPrefix();
1352 // switch to a temporary clone of the database
1353 self
::setupTestDB( $this->db
, $testPrefix );
1355 if ( self
::isUsingExternalStoreDB() ) {
1356 self
::setupExternalStoreTestDBs( $testPrefix );
1359 // NOTE: Change the prefix in the LBFactory and $wgDBprefix, to prevent
1360 // *any* database connections to operate on live data.
1361 CloneDatabase
::changePrefix( $testPrefix );
1365 * Creates an empty skeleton of the wiki database by cloning its structure
1366 * to equivalent tables using the given $prefix. Then sets MediaWiki to
1367 * use the new set of tables (aka schema) instead of the original set.
1369 * This is used to generate a dummy table set, typically consisting of temporary
1370 * tables, that will be used by tests instead of the original wiki database tables.
1374 * @note the original table prefix is stored in self::$oldTablePrefix. This is used
1375 * by teardownTestDB() to return the wiki to using the original table set.
1377 * @note this method only works when first called. Subsequent calls have no effect,
1378 * even if using different parameters.
1380 * @param Database $db The database connection
1381 * @param string $prefix The prefix to use for the new table set (aka schema).
1383 * @throws MWException If the database table prefix is already $prefix
1385 public static function setupTestDB( Database
$db, $prefix ) {
1386 if ( self
::$dbSetup ) {
1390 if ( $db->tablePrefix() === $prefix ) {
1391 throw new MWException(
1392 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
1395 // TODO: the below should be re-written as soon as LBFactory, LoadBalancer,
1396 // and Database no longer use global state.
1398 self
::$dbSetup = true;
1400 if ( !self
::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
1404 // Assuming this isn't needed for External Store database, and not sure if the procedure
1405 // would be available there.
1406 if ( $db->getType() == 'oracle' ) {
1407 $db->query( 'BEGIN FILL_WIKI_INFO; END;' );
1410 Hooks
::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
1414 * Clones the External Store database(s) for testing
1416 * @param string|null $testPrefix Prefix for test tables. Will be determined automatically
1419 protected static function setupExternalStoreTestDBs( $testPrefix = null ) {
1420 $connections = self
::getExternalStoreDatabaseConnections();
1421 foreach ( $connections as $dbw ) {
1422 self
::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
1427 * Gets master database connections for all of the ExternalStoreDB
1428 * stores configured in $wgDefaultExternalStore.
1430 * @return Database[] Array of Database master connections
1432 protected static function getExternalStoreDatabaseConnections() {
1433 global $wgDefaultExternalStore;
1435 /** @var ExternalStoreDB $externalStoreDB */
1436 $externalStoreDB = ExternalStore
::getStoreObject( 'DB' );
1437 $defaultArray = (array)$wgDefaultExternalStore;
1439 foreach ( $defaultArray as $url ) {
1440 if ( strpos( $url, 'DB://' ) === 0 ) {
1441 list( $proto, $cluster ) = explode( '://', $url, 2 );
1442 // Avoid getMaster() because setupDatabaseWithTestPrefix()
1443 // requires Database instead of plain DBConnRef/IDatabase
1444 $dbws[] = $externalStoreDB->getMaster( $cluster );
1452 * Check whether ExternalStoreDB is being used
1454 * @return bool True if it's being used
1456 protected static function isUsingExternalStoreDB() {
1457 global $wgDefaultExternalStore;
1458 if ( !$wgDefaultExternalStore ) {
1462 $defaultArray = (array)$wgDefaultExternalStore;
1463 foreach ( $defaultArray as $url ) {
1464 if ( strpos( $url, 'DB://' ) === 0 ) {
1473 * @throws LogicException if the given database connection is not a set up to use
1476 * @since 1.31 this is no longer private.
1478 protected function ensureMockDatabaseConnection( IDatabase
$db ) {
1479 if ( $db->tablePrefix() !== $this->dbPrefix() ) {
1480 throw new LogicException(
1481 'Trying to delete mock tables, but table prefix does not indicate a mock database.'
1486 private static $schemaOverrideDefaults = [
1494 * Stub. If a test suite needs to test against a specific database schema, it should
1495 * override this method and return the appropriate information from it.
1497 * @param IMaintainableDatabase $db The DB connection to use for the mock schema.
1498 * May be used to check the current state of the schema, to determine what
1499 * overrides are needed.
1501 * @return array An associative array with the following fields:
1502 * - 'scripts': any SQL scripts to run. If empty or not present, schema overrides are skipped.
1503 * - 'create': A list of tables created (may or may not exist in the original schema).
1504 * - 'drop': A list of tables dropped (expected to be present in the original schema).
1505 * - 'alter': A list of tables altered (expected to be present in the original schema).
1507 protected function getSchemaOverrides( IMaintainableDatabase
$db ) {
1512 * Undoes the specified schema overrides..
1513 * Called once per test class, just before addDataOnce().
1515 * @param IMaintainableDatabase $db
1516 * @param array $oldOverrides
1518 private function undoSchemaOverrides( IMaintainableDatabase
$db, $oldOverrides ) {
1519 $this->ensureMockDatabaseConnection( $db );
1521 $oldOverrides = $oldOverrides + self
::$schemaOverrideDefaults;
1522 $originalTables = $this->listOriginalTables( $db, 'unprefixed' );
1524 // Drop tables that need to be restored or removed.
1525 $tablesToDrop = array_merge( $oldOverrides['create'], $oldOverrides['alter'] );
1527 // Restore tables that have been dropped or created or altered,
1528 // if they exist in the original schema.
1529 $tablesToRestore = array_merge( $tablesToDrop, $oldOverrides['drop'] );
1530 $tablesToRestore = array_intersect( $originalTables, $tablesToRestore );
1532 if ( $tablesToDrop ) {
1533 $this->dropMockTables( $db, $tablesToDrop );
1536 if ( $tablesToRestore ) {
1537 $this->recloneMockTables( $db, $tablesToRestore );
1542 * Applies the schema overrides returned by getSchemaOverrides(),
1543 * after undoing any previously applied schema overrides.
1544 * Called once per test class, just before addDataOnce().
1546 private function setUpSchema( IMaintainableDatabase
$db ) {
1547 // Undo any active overrides.
1548 $oldOverrides = $db->_schemaOverrides ?? self
::$schemaOverrideDefaults;
1550 if ( $oldOverrides['alter'] ||
$oldOverrides['create'] ||
$oldOverrides['drop'] ) {
1551 $this->undoSchemaOverrides( $db, $oldOverrides );
1554 // Determine new overrides.
1555 $overrides = $this->getSchemaOverrides( $db ) + self
::$schemaOverrideDefaults;
1557 $extraKeys = array_diff(
1558 array_keys( $overrides ),
1559 array_keys( self
::$schemaOverrideDefaults )
1563 throw new InvalidArgumentException(
1564 'Schema override contains extra keys: ' . var_export( $extraKeys, true )
1568 if ( !$overrides['scripts'] ) {
1569 // no scripts to run
1573 if ( !$overrides['create'] && !$overrides['drop'] && !$overrides['alter'] ) {
1574 throw new InvalidArgumentException(
1575 'Schema override scripts given, but no tables are declared to be '
1576 . 'created, dropped or altered.'
1580 $this->ensureMockDatabaseConnection( $db );
1582 // Drop the tables that will be created by the schema scripts.
1583 $originalTables = $this->listOriginalTables( $db, 'unprefixed' );
1584 $tablesToDrop = array_intersect( $originalTables, $overrides['create'] );
1586 if ( $tablesToDrop ) {
1587 $this->dropMockTables( $db, $tablesToDrop );
1590 // Run schema override scripts.
1591 foreach ( $overrides['scripts'] as $script ) {
1598 return $this->mungeSchemaUpdateQuery( $cmd );
1603 $db->_schemaOverrides
= $overrides;
1606 private function mungeSchemaUpdateQuery( $cmd ) {
1607 return self
::$useTemporaryTables
1608 ?
preg_replace( '/\bCREATE\s+TABLE\b/i', 'CREATE TEMPORARY TABLE', $cmd )
1613 * Drops the given mock tables.
1615 * @param IMaintainableDatabase $db
1616 * @param array $tables
1618 private function dropMockTables( IMaintainableDatabase
$db, array $tables ) {
1619 $this->ensureMockDatabaseConnection( $db );
1621 foreach ( $tables as $tbl ) {
1622 $tbl = $db->tableName( $tbl );
1623 $db->query( "DROP TABLE IF EXISTS $tbl", __METHOD__
);
1625 if ( $tbl === 'page' ) {
1626 // Forget about the pages since they don't
1628 MediaWikiServices
::getInstance()->getLinkCache()->clear();
1634 * Lists all tables in the live database schema.
1636 * @param IMaintainableDatabase $db
1637 * @param string $prefix Either 'prefixed' or 'unprefixed'
1640 private function listOriginalTables( IMaintainableDatabase
$db, $prefix = 'prefixed' ) {
1641 if ( !isset( $db->_originalTablePrefix
) ) {
1642 throw new LogicException( 'No original table prefix know, cannot list tables!' );
1645 $originalTables = $db->listTables( $db->_originalTablePrefix
, __METHOD__
);
1646 if ( $prefix === 'unprefixed' ) {
1647 $originalPrefixRegex = '/^' . preg_quote( $db->_originalTablePrefix
) . '/';
1648 $originalTables = array_map(
1649 function ( $pt ) use ( $originalPrefixRegex ) {
1650 return preg_replace( $originalPrefixRegex, '', $pt );
1656 return $originalTables;
1660 * Re-clones the given mock tables to restore them based on the live database schema.
1661 * The tables listed in $tables are expected to currently not exist, so dropMockTables()
1662 * should be called first.
1664 * @param IMaintainableDatabase $db
1665 * @param array $tables
1667 private function recloneMockTables( IMaintainableDatabase
$db, array $tables ) {
1668 $this->ensureMockDatabaseConnection( $db );
1670 if ( !isset( $db->_originalTablePrefix
) ) {
1671 throw new LogicException( 'No original table prefix know, cannot restore tables!' );
1674 $originalTables = $this->listOriginalTables( $db, 'unprefixed' );
1675 $tables = array_intersect( $tables, $originalTables );
1677 $dbClone = new CloneDatabase( $db, $tables, $db->tablePrefix(), $db->_originalTablePrefix
);
1678 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1680 $dbClone->cloneTableStructure();
1684 * Empty all tables so they can be repopulated for tests
1686 * @param Database $db|null Database to reset
1687 * @param array $tablesUsed Tables to reset
1689 private function resetDB( $db, $tablesUsed ) {
1691 $userTables = [ 'user', 'user_groups', 'user_properties', 'actor' ];
1693 'page', 'revision', 'ip_changes', 'revision_comment_temp', 'comment', 'archive',
1694 'revision_actor_temp', 'slots', 'content', 'content_models', 'slot_roles',
1696 $coreDBDataTables = array_merge( $userTables, $pageTables );
1698 // If any of the user or page tables were marked as used, we should clear all of them.
1699 if ( array_intersect( $tablesUsed, $userTables ) ) {
1700 $tablesUsed = array_unique( array_merge( $tablesUsed, $userTables ) );
1701 TestUserRegistry
::clear();
1703 if ( array_intersect( $tablesUsed, $pageTables ) ) {
1704 $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
1707 // Postgres, Oracle, and MSSQL all use mwuser/pagecontent
1708 // instead of user/text. But Postgres does not remap the
1709 // table name in tableExists(), so we mark the real table
1710 // names as being used.
1711 if ( $db->getType() === 'postgres' ) {
1712 if ( in_array( 'user', $tablesUsed ) ) {
1713 $tablesUsed[] = 'mwuser';
1715 if ( in_array( 'text', $tablesUsed ) ) {
1716 $tablesUsed[] = 'pagecontent';
1720 $truncate = in_array( $db->getType(), [ 'oracle', 'mysql' ] );
1721 foreach ( $tablesUsed as $tbl ) {
1722 if ( !$db->tableExists( $tbl ) ) {
1727 $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tbl ), __METHOD__
);
1729 $db->delete( $tbl, '*', __METHOD__
);
1732 if ( in_array( $db->getType(), [ 'postgres', 'sqlite' ], true ) ) {
1733 // Reset the table's sequence too.
1734 $db->resetSequenceForTable( $tbl, __METHOD__
);
1737 if ( $tbl === 'interwiki' ) {
1738 if ( !$this->interwikiTable
) {
1739 // @todo We should probably throw here, but this causes test failures that I
1740 // can't figure out, so for now we silently continue.
1745 array_map( 'get_object_vars', iterator_to_array( $this->interwikiTable
) ),
1750 if ( $tbl === 'page' ) {
1751 // Forget about the pages since they don't
1753 MediaWikiServices
::getInstance()->getLinkCache()->clear();
1757 if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
1758 // Re-add core DB data that was deleted
1759 $this->addCoreDBData();
1764 private static function unprefixTable( &$tableName, $ind, $prefix ) {
1765 $tableName = substr( $tableName, strlen( $prefix ) );
1768 private static function isNotUnittest( $table ) {
1769 return strpos( $table, self
::DB_PREFIX
) !== 0;
1775 * @param IMaintainableDatabase $db
1779 public static function listTables( IMaintainableDatabase
$db ) {
1780 $prefix = $db->tablePrefix();
1781 $tables = $db->listTables( $prefix, __METHOD__
);
1783 if ( $db->getType() === 'mysql' ) {
1784 static $viewListCache = null;
1785 if ( $viewListCache === null ) {
1786 $viewListCache = $db->listViews( null, __METHOD__
);
1788 // T45571: cannot clone VIEWs under MySQL
1789 $tables = array_diff( $tables, $viewListCache );
1791 array_walk( $tables, [ __CLASS__
, 'unprefixTable' ], $prefix );
1793 // Don't duplicate test tables from the previous fataled run
1794 $tables = array_filter( $tables, [ __CLASS__
, 'isNotUnittest' ] );
1796 if ( $db->getType() == 'sqlite' ) {
1797 $tables = array_flip( $tables );
1798 // these are subtables of searchindex and don't need to be duped/dropped separately
1799 unset( $tables['searchindex_content'] );
1800 unset( $tables['searchindex_segdir'] );
1801 unset( $tables['searchindex_segments'] );
1802 $tables = array_flip( $tables );
1809 * Copy test data from one database connection to another.
1811 * This should only be used for small data sets.
1813 * @param IDatabase $source
1814 * @param IDatabase $target
1816 public function copyTestData( IDatabase
$source, IDatabase
$target ) {
1817 $tables = self
::listOriginalTables( $source, 'unprefixed' );
1819 foreach ( $tables as $table ) {
1820 $res = $source->select( $table, '*', [], __METHOD__
);
1823 foreach ( $res as $row ) {
1824 $allRows[] = (array)$row;
1827 $target->insert( $table, $allRows, __METHOD__
, [ 'IGNORE' ] );
1832 * @throws MWException
1835 protected function checkDbIsSupported() {
1836 if ( !in_array( $this->db
->getType(), $this->supportedDBs
) ) {
1837 throw new MWException( $this->db
->getType() . " is not currently supported for unit testing." );
1843 * @param string $offset
1846 public function getCliArg( $offset ) {
1847 if ( isset( PHPUnitMaintClass
::$additionalOptions[$offset] ) ) {
1848 return PHPUnitMaintClass
::$additionalOptions[$offset];
1856 * @param string $offset
1857 * @param mixed $value
1859 public function setCliArg( $offset, $value ) {
1860 PHPUnitMaintClass
::$additionalOptions[$offset] = $value;
1864 * Don't throw a warning if $function is deprecated and called later
1868 * @param string $function
1870 public function hideDeprecated( $function ) {
1871 Wikimedia\
suppressWarnings();
1872 wfDeprecated( $function );
1873 Wikimedia\restoreWarnings
();
1877 * Asserts that the given database query yields the rows given by $expectedRows.
1878 * The expected rows should be given as indexed (not associative) arrays, with
1879 * the values given in the order of the columns in the $fields parameter.
1880 * Note that the rows are sorted by the columns given in $fields.
1884 * @param string|array $table The table(s) to query
1885 * @param string|array $fields The columns to include in the result (and to sort by)
1886 * @param string|array $condition "where" condition(s)
1887 * @param array $expectedRows An array of arrays giving the expected rows.
1888 * @param array $options Options for the query
1889 * @param array $join_conds Join conditions for the query
1891 * @throws MWException If this test cases's needsDB() method doesn't return true.
1892 * Test cases can use "@group Database" to enable database test support,
1893 * or list the tables under testing in $this->tablesUsed, or override the
1896 protected function assertSelect(
1897 $table, $fields, $condition, array $expectedRows, array $options = [], array $join_conds = []
1899 if ( !$this->needsDB() ) {
1900 throw new MWException( 'When testing database state, the test cases\'s needDB()' .
1901 ' method should return true. Use @group Database or $this->tablesUsed.' );
1904 $db = wfGetDB( DB_REPLICA
);
1911 $options +
[ 'ORDER BY' => $fields ],
1914 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
1918 foreach ( $expectedRows as $expected ) {
1919 $r = $res->fetchRow();
1920 self
::stripStringKeys( $r );
1923 $this->assertNotEmpty( $r, "row #$i missing" );
1925 $this->assertEquals( $expected, $r, "row #$i mismatches" );
1928 $r = $res->fetchRow();
1929 self
::stripStringKeys( $r );
1931 $this->assertFalse( $r, "found extra row (after #$i)" );
1935 * Utility method taking an array of elements and wrapping
1936 * each element in its own array. Useful for data providers
1937 * that only return a single argument.
1941 * @param array $elements
1945 protected function arrayWrap( array $elements ) {
1947 function ( $element ) {
1948 return [ $element ];
1955 * Assert that two arrays are equal. By default this means that both arrays need to hold
1956 * the same set of values. Using additional arguments, order and associated key can also
1957 * be set as relevant.
1961 * @param array $expected
1962 * @param array $actual
1963 * @param bool $ordered If the order of the values should match
1964 * @param bool $named If the keys should match
1966 protected function assertArrayEquals( array $expected, array $actual,
1967 $ordered = false, $named = false
1970 $this->objectAssociativeSort( $expected );
1971 $this->objectAssociativeSort( $actual );
1975 $expected = array_values( $expected );
1976 $actual = array_values( $actual );
1979 call_user_func_array(
1980 [ $this, 'assertEquals' ],
1981 array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
1986 * Put each HTML element on its own line and then equals() the results
1988 * Use for nicely formatting of PHPUnit diff output when comparing very
1993 * @param string $expected HTML on oneline
1994 * @param string $actual HTML on oneline
1995 * @param string $msg Optional message
1997 protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
1998 $expected = str_replace( '>', ">\n", $expected );
1999 $actual = str_replace( '>', ">\n", $actual );
2001 $this->assertEquals( $expected, $actual, $msg );
2005 * Does an associative sort that works for objects.
2009 * @param array &$array
2011 protected function objectAssociativeSort( array &$array ) {
2014 function ( $a, $b ) {
2015 return serialize( $a ) <=> serialize( $b );
2021 * Utility function for eliminating all string keys from an array.
2022 * Useful to turn a database result row as returned by fetchRow() into
2023 * a pure indexed array.
2027 * @param mixed &$r The array to remove string keys from.
2029 protected static function stripStringKeys( &$r ) {
2030 if ( !is_array( $r ) ) {
2034 foreach ( $r as $k => $v ) {
2035 if ( is_string( $k ) ) {
2042 * Asserts that the provided variable is of the specified
2043 * internal type or equals the $value argument. This is useful
2044 * for testing return types of functions that return a certain
2045 * type or *value* when not set or on error.
2049 * @param string $type
2050 * @param mixed $actual
2051 * @param mixed $value
2052 * @param string $message
2054 protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
2055 if ( $actual === $value ) {
2056 $this->assertTrue( true, $message );
2058 $this->assertType( $type, $actual, $message );
2063 * Asserts the type of the provided value. This can be either
2064 * in internal type such as boolean or integer, or a class or
2065 * interface the value extends or implements.
2069 * @param string $type
2070 * @param mixed $actual
2071 * @param string $message
2073 protected function assertType( $type, $actual, $message = '' ) {
2074 if ( class_exists( $type ) ||
interface_exists( $type ) ) {
2075 $this->assertInstanceOf( $type, $actual, $message );
2077 $this->assertInternalType( $type, $actual, $message );
2082 * Returns true if the given namespace defaults to Wikitext
2083 * according to $wgNamespaceContentModels
2085 * @param int $ns The namespace ID to check
2090 protected function isWikitextNS( $ns ) {
2091 global $wgNamespaceContentModels;
2093 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
2094 return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
;
2101 * Returns the ID of a namespace that defaults to Wikitext.
2103 * @throws MWException If there is none.
2104 * @return int The ID of the wikitext Namespace
2107 protected function getDefaultWikitextNS() {
2108 global $wgNamespaceContentModels;
2110 static $wikitextNS = null; // this is not going to change
2111 if ( $wikitextNS !== null ) {
2115 // quickly short out on most common case:
2116 if ( !isset( $wgNamespaceContentModels[NS_MAIN
] ) ) {
2120 // NOTE: prefer content namespaces
2121 $namespaces = array_unique( array_merge(
2122 MWNamespace
::getContentNamespaces(),
2123 [ NS_MAIN
, NS_HELP
, NS_PROJECT
], // prefer these
2124 MWNamespace
::getValidNamespaces()
2127 $namespaces = array_diff( $namespaces, [
2128 NS_FILE
, NS_CATEGORY
, NS_MEDIAWIKI
, NS_USER
// don't mess with magic namespaces
2131 $talk = array_filter( $namespaces, function ( $ns ) {
2132 return MWNamespace
::isTalk( $ns );
2135 // prefer non-talk pages
2136 $namespaces = array_diff( $namespaces, $talk );
2137 $namespaces = array_merge( $namespaces, $talk );
2139 // check default content model of each namespace
2140 foreach ( $namespaces as $ns ) {
2141 if ( !isset( $wgNamespaceContentModels[$ns] ) ||
2142 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
2151 // @todo Inside a test, we could skip the test as incomplete.
2152 // But frequently, this is used in fixture setup.
2153 throw new MWException( "No namespace defaults to wikitext!" );
2157 * Check, if $wgDiff3 is set and ready to merge
2158 * Will mark the calling test as skipped, if not ready
2162 protected function markTestSkippedIfNoDiff3() {
2165 # This check may also protect against code injection in
2166 # case of broken installations.
2167 Wikimedia\
suppressWarnings();
2168 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2169 Wikimedia\restoreWarnings
();
2171 if ( !$haveDiff3 ) {
2172 $this->markTestSkipped( "Skip test, since diff3 is not configured" );
2177 * Check if $extName is a loaded PHP extension, will skip the
2178 * test whenever it is not loaded.
2181 * @param string $extName
2184 protected function checkPHPExtension( $extName ) {
2185 $loaded = extension_loaded( $extName );
2187 $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
2194 * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
2195 * @param string $buffer
2198 public static function wfResetOutputBuffersBarrier( $buffer ) {
2203 * Create a temporary hook handler which will be reset by tearDown.
2204 * This replaces other handlers for the same hook.
2205 * @param string $hookName Hook name
2206 * @param mixed $handler Value suitable for a hook handler
2209 protected function setTemporaryHook( $hookName, $handler ) {
2210 $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
2214 * Check whether file contains given data.
2215 * @param string $fileName
2216 * @param string $actualData
2217 * @param bool $createIfMissing If true, and file does not exist, create it with given data
2218 * and skip the test.
2219 * @param string $msg
2222 protected function assertFileContains(
2225 $createIfMissing = true,
2228 if ( $createIfMissing ) {
2229 if ( !file_exists( $fileName ) ) {
2230 file_put_contents( $fileName, $actualData );
2231 $this->markTestSkipped( 'Data file $fileName does not exist' );
2234 self
::assertFileExists( $fileName );
2236 self
::assertEquals( file_get_contents( $fileName ), $actualData, $msg );
2240 * Edits or creates a page/revision
2241 * @param string $pageName Page title
2242 * @param string $text Content of the page
2243 * @param string $summary Optional summary string for the revision
2244 * @param int $defaultNs Optional namespace id
2245 * @return array Array as returned by WikiPage::doEditContent()
2247 protected function editPage( $pageName, $text, $summary = '', $defaultNs = NS_MAIN
) {
2248 $title = Title
::newFromText( $pageName, $defaultNs );
2249 $page = WikiPage
::factory( $title );
2251 return $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $summary );
2255 * Revision-deletes a revision.
2257 * @param Revision|int $rev Revision to delete
2258 * @param array $value Keys are Revision::DELETED_* flags. Values are 1 to set the bit, 0 to
2259 * clear, -1 to leave alone. (All other values also clear the bit.)
2260 * @param string $comment Deletion comment
2262 protected function revisionDelete(
2263 $rev, array $value = [ Revision
::DELETED_TEXT
=> 1 ], $comment = ''
2265 if ( is_int( $rev ) ) {
2266 $rev = Revision
::newFromId( $rev );
2268 RevisionDeleter
::createList(
2269 'revision', RequestContext
::getMain(), $rev->getTitle(), [ $rev->getId() ]
2272 'comment' => $comment,