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 loggers which have been replaced by setLogger()
102 * @var LoggerInterface[]
104 private $loggers = [];
107 * Table name prefixes. Oracle likes it shorter.
109 const DB_PREFIX
= 'unittest_';
110 const ORA_DB_PREFIX
= 'ut_';
116 protected $supportedDBs = [
123 public function __construct( $name = null, array $data = [], $dataName = '' ) {
124 parent
::__construct( $name, $data, $dataName );
126 $this->backupGlobals
= false;
127 $this->backupStaticAttributes
= false;
130 public function __destruct() {
131 // Complain if self::setUp() was called, but not self::tearDown()
132 // $this->called['setUp'] will be checked by self::testMediaWikiTestCaseParentSetupCalled()
133 if ( isset( $this->called
['setUp'] ) && !isset( $this->called
['tearDown'] ) ) {
134 throw new MWException( static::class . "::tearDown() must call parent::tearDown()" );
138 public static function setUpBeforeClass() {
139 parent
::setUpBeforeClass();
141 // Get the service locator, and reset services if it's not done already
142 self
::$serviceLocator = self
::prepareServices( new GlobalVarConfig() );
146 * Convenience method for getting an immutable test user
150 * @param string[] $groups Groups the test user should be in.
153 public static function getTestUser( $groups = [] ) {
154 return TestUserRegistry
::getImmutableTestUser( $groups );
158 * Convenience method for getting a mutable test user
162 * @param string[] $groups Groups the test user should be added in.
165 public static function getMutableTestUser( $groups = [] ) {
166 return TestUserRegistry
::getMutableTestUser( __CLASS__
, $groups );
170 * Convenience method for getting an immutable admin test user
174 * @param string[] $groups Groups the test user should be added to.
177 public static function getTestSysop() {
178 return self
::getTestUser( [ 'sysop', 'bureaucrat' ] );
182 * Prepare service configuration for unit testing.
184 * This calls MediaWikiServices::resetGlobalInstance() to allow some critical services
185 * to be overridden for testing.
187 * prepareServices() only needs to be called once, but should be called as early as possible,
188 * before any class has a chance to grab a reference to any of the global services
189 * instances that get discarded by prepareServices(). Only the first call has any effect,
190 * later calls are ignored.
192 * @note This is called by PHPUnitMaintClass::finalSetup.
194 * @see MediaWikiServices::resetGlobalInstance()
196 * @param Config $bootstrapConfig The bootstrap config to use with the new
197 * MediaWikiServices. Only used for the first call to this method.
198 * @return MediaWikiServices
200 public static function prepareServices( Config
$bootstrapConfig ) {
201 static $services = null;
204 $services = self
::resetGlobalServices( $bootstrapConfig );
210 * Reset global services, and install testing environment.
211 * This is the testing equivalent of MediaWikiServices::resetGlobalInstance().
212 * This should only be used to set up the testing environment, not when
213 * running unit tests. Use MediaWikiTestCase::overrideMwServices() for that.
215 * @see MediaWikiServices::resetGlobalInstance()
216 * @see prepareServices()
217 * @see MediaWikiTestCase::overrideMwServices()
219 * @param Config|null $bootstrapConfig The bootstrap config to use with the new
221 * @return MediaWikiServices
223 protected static function resetGlobalServices( Config
$bootstrapConfig = null ) {
224 $oldServices = MediaWikiServices
::getInstance();
225 $oldConfigFactory = $oldServices->getConfigFactory();
226 $oldLoadBalancerFactory = $oldServices->getDBLoadBalancerFactory();
228 $testConfig = self
::makeTestConfig( $bootstrapConfig );
230 MediaWikiServices
::resetGlobalInstance( $testConfig );
232 $serviceLocator = MediaWikiServices
::getInstance();
233 self
::installTestServices(
235 $oldLoadBalancerFactory,
238 return $serviceLocator;
242 * Create a config suitable for testing, based on a base config, default overrides,
243 * and custom overrides.
245 * @param Config|null $baseConfig
246 * @param Config|null $customOverrides
250 private static function makeTestConfig(
251 Config
$baseConfig = null,
252 Config
$customOverrides = null
254 $defaultOverrides = new HashConfig();
256 if ( !$baseConfig ) {
257 $baseConfig = MediaWikiServices
::getInstance()->getBootstrapConfig();
260 /* Some functions require some kind of caching, and will end up using the db,
261 * which we can't allow, as that would open a new connection for mysql.
262 * Replace with a HashBag. They would not be going to persist anyway.
264 $hashCache = [ 'class' => HashBagOStuff
::class, 'reportDupes' => false ];
266 CACHE_DB
=> $hashCache,
267 CACHE_ACCEL
=> $hashCache,
268 CACHE_MEMCACHED
=> $hashCache,
270 'apcu' => $hashCache,
271 'wincache' => $hashCache,
272 ] +
$baseConfig->get( 'ObjectCaches' );
274 $defaultOverrides->set( 'ObjectCaches', $objectCaches );
275 $defaultOverrides->set( 'MainCacheType', CACHE_NONE
);
276 $defaultOverrides->set( 'JobTypeConf', [ 'default' => [ 'class' => JobQueueMemory
::class ] ] );
278 // Use a fast hash algorithm to hash passwords.
279 $defaultOverrides->set( 'PasswordDefault', 'A' );
281 $testConfig = $customOverrides
282 ?
new MultiConfig( [ $customOverrides, $defaultOverrides, $baseConfig ] )
283 : new MultiConfig( [ $defaultOverrides, $baseConfig ] );
289 * @param ConfigFactory $oldConfigFactory
290 * @param LBFactory $oldLoadBalancerFactory
291 * @param MediaWikiServices $newServices
293 * @throws MWException
295 private static function installTestServices(
296 ConfigFactory
$oldConfigFactory,
297 LBFactory
$oldLoadBalancerFactory,
298 MediaWikiServices
$newServices
300 // Use bootstrap config for all configuration.
301 // This allows config overrides via global variables to take effect.
302 $bootstrapConfig = $newServices->getBootstrapConfig();
303 $newServices->resetServiceForTesting( 'ConfigFactory' );
304 $newServices->redefineService(
306 self
::makeTestConfigFactoryInstantiator(
308 [ 'main' => $bootstrapConfig ]
311 $newServices->resetServiceForTesting( 'DBLoadBalancerFactory' );
312 $newServices->redefineService(
313 'DBLoadBalancerFactory',
314 function ( MediaWikiServices
$services ) use ( $oldLoadBalancerFactory ) {
315 return $oldLoadBalancerFactory;
321 * @param ConfigFactory $oldFactory
322 * @param Config[] $configurations
326 private static function makeTestConfigFactoryInstantiator(
327 ConfigFactory
$oldFactory,
328 array $configurations
330 return function ( MediaWikiServices
$services ) use ( $oldFactory, $configurations ) {
331 $factory = new ConfigFactory();
333 // clone configurations from $oldFactory that are not overwritten by $configurations
334 $namesToClone = array_diff(
335 $oldFactory->getConfigNames(),
336 array_keys( $configurations )
339 foreach ( $namesToClone as $name ) {
340 $factory->register( $name, $oldFactory->makeConfig( $name ) );
343 foreach ( $configurations as $name => $config ) {
344 $factory->register( $name, $config );
352 * Resets some well known services that typically have state that may interfere with unit tests.
353 * This is a lightweight alternative to resetGlobalServices().
355 * @note There is no guarantee that no references remain to stale service instances destroyed
356 * by a call to doLightweightServiceReset().
358 * @throws MWException if called outside of PHPUnit tests.
360 * @see resetGlobalServices()
362 private function doLightweightServiceReset() {
363 global $wgRequest, $wgJobClasses;
365 foreach ( $wgJobClasses as $type => $class ) {
366 JobQueueGroup
::singleton()->get( $type )->delete();
368 JobQueueGroup
::destroySingletons();
370 ObjectCache
::clear();
371 $services = MediaWikiServices
::getInstance();
372 $services->resetServiceForTesting( 'MainObjectStash' );
373 $services->resetServiceForTesting( 'LocalServerObjectCache' );
374 $services->getMainWANObjectCache()->clearProcessCache();
375 FileBackendGroup
::destroySingleton();
376 DeferredUpdates
::clearPendingUpdates();
378 // TODO: move global state into MediaWikiServices
379 RequestContext
::resetMain();
380 if ( session_id() !== '' ) {
381 session_write_close();
385 $wgRequest = new FauxRequest();
386 MediaWiki\Session\SessionManager
::resetCache();
389 public function run( PHPUnit_Framework_TestResult
$result = null ) {
390 $needsResetDB = false;
392 if ( !self
::$dbSetup ||
$this->needsDB() ) {
393 // set up a DB connection for this test to use
395 self
::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
396 self
::$reuseDB = $this->getCliArg( 'reuse-db' );
398 $this->db
= wfGetDB( DB_MASTER
);
400 $this->checkDbIsSupported();
402 if ( !self
::$dbSetup ) {
403 $this->setupAllTestDBs();
404 $this->addCoreDBData();
406 if ( ( $this->db
->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
407 $this->resetDB( $this->db
, $this->tablesUsed
);
411 // TODO: the DB setup should be done in setUpBeforeClass(), so the test DB
412 // is available in subclass's setUpBeforeClass() and setUp() methods.
413 // This would also remove the need for the HACK that is oncePerClass().
414 if ( $this->oncePerClass() ) {
415 $this->setUpSchema( $this->db
);
416 $this->addDBDataOnce();
420 $needsResetDB = true;
423 parent
::run( $result );
425 if ( $needsResetDB ) {
426 $this->resetDB( $this->db
, $this->tablesUsed
);
433 private function oncePerClass() {
434 // Remember current test class in the database connection,
435 // so we know when we need to run addData.
437 $class = static::class;
439 $first = !isset( $this->db
->_hasDataForTestClass
)
440 ||
$this->db
->_hasDataForTestClass
!== $class;
442 $this->db
->_hasDataForTestClass
= $class;
451 public function usesTemporaryTables() {
452 return self
::$useTemporaryTables;
456 * Obtains a new temporary file name
458 * The obtained filename is enlisted to be removed upon tearDown
462 * @return string Absolute name of the temporary file
464 protected function getNewTempFile() {
465 $fileName = tempnam( wfTempDir(), 'MW_PHPUnit_' . static::class . '_' );
466 $this->tmpFiles
[] = $fileName;
472 * obtains a new temporary directory
474 * The obtained directory is enlisted to be removed (recursively with all its contained
475 * files) upon tearDown.
479 * @return string Absolute name of the temporary directory
481 protected function getNewTempDirectory() {
482 // Starting of with a temporary /file/.
483 $fileName = $this->getNewTempFile();
485 // Converting the temporary /file/ to a /directory/
486 // The following is not atomic, but at least we now have a single place,
487 // where temporary directory creation is bundled and can be improved
489 $this->assertTrue( wfMkdirParents( $fileName ) );
494 protected function setUp() {
496 $this->called
['setUp'] = true;
498 $this->phpErrorLevel
= intval( ini_get( 'error_reporting' ) );
500 // Cleaning up temporary files
501 foreach ( $this->tmpFiles
as $fileName ) {
502 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
504 } elseif ( is_dir( $fileName ) ) {
505 wfRecursiveRemoveDir( $fileName );
509 if ( $this->needsDB() && $this->db
) {
510 // Clean up open transactions
511 while ( $this->db
->trxLevel() > 0 ) {
512 $this->db
->rollback( __METHOD__
, 'flush' );
514 // Check for unsafe queries
515 if ( $this->db
->getType() === 'mysql' ) {
516 $this->db
->query( "SET sql_mode = 'STRICT_ALL_TABLES'" );
520 // Reset all caches between tests.
521 $this->doLightweightServiceReset();
523 // XXX: reset maintenance triggers
524 // Hook into period lag checks which often happen in long-running scripts
525 $services = MediaWikiServices
::getInstance();
526 $lbFactory = $services->getDBLoadBalancerFactory();
527 Maintenance
::setLBFactoryTriggers( $lbFactory, $services->getMainConfig() );
529 ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
532 protected function addTmpFiles( $files ) {
533 $this->tmpFiles
= array_merge( $this->tmpFiles
, (array)$files );
536 protected function tearDown() {
537 global $wgRequest, $wgSQLMode;
539 $status = ob_get_status();
540 if ( isset( $status['name'] ) &&
541 $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier'
546 $this->called
['tearDown'] = true;
547 // Cleaning up temporary files
548 foreach ( $this->tmpFiles
as $fileName ) {
549 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
551 } elseif ( is_dir( $fileName ) ) {
552 wfRecursiveRemoveDir( $fileName );
556 if ( $this->needsDB() && $this->db
) {
557 // Clean up open transactions
558 while ( $this->db
->trxLevel() > 0 ) {
559 $this->db
->rollback( __METHOD__
, 'flush' );
561 if ( $this->db
->getType() === 'mysql' ) {
562 $this->db
->query( "SET sql_mode = " . $this->db
->addQuotes( $wgSQLMode ) );
566 // Restore mw globals
567 foreach ( $this->mwGlobals
as $key => $value ) {
568 $GLOBALS[$key] = $value;
570 foreach ( $this->mwGlobalsToUnset
as $value ) {
571 unset( $GLOBALS[$value] );
573 $this->mwGlobals
= [];
574 $this->mwGlobalsToUnset
= [];
575 $this->restoreLoggers();
577 if ( self
::$serviceLocator && MediaWikiServices
::getInstance() !== self
::$serviceLocator ) {
578 MediaWikiServices
::forceGlobalInstance( self
::$serviceLocator );
581 // TODO: move global state into MediaWikiServices
582 RequestContext
::resetMain();
583 if ( session_id() !== '' ) {
584 session_write_close();
587 $wgRequest = new FauxRequest();
588 MediaWiki\Session\SessionManager
::resetCache();
589 MediaWiki\Auth\AuthManager
::resetCache();
591 $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
593 if ( $phpErrorLevel !== $this->phpErrorLevel
) {
594 ini_set( 'error_reporting', $this->phpErrorLevel
);
596 $oldHex = strtoupper( dechex( $this->phpErrorLevel
) );
597 $newHex = strtoupper( dechex( $phpErrorLevel ) );
598 $message = "PHP error_reporting setting was left dirty: "
599 . "was 0x$oldHex before test, 0x$newHex after test!";
601 $this->fail( $message );
608 * Make sure MediaWikiTestCase extending classes have called their
609 * parent setUp method
611 * With strict coverage activated in PHP_CodeCoverage, this test would be
612 * marked as risky without the following annotation (T152923).
615 final public function testMediaWikiTestCaseParentSetupCalled() {
616 $this->assertArrayHasKey( 'setUp', $this->called
,
617 static::class . '::setUp() must call parent::setUp()'
622 * Sets a service, maintaining a stashed version of the previous service to be
623 * restored in tearDown
627 * @param string $name
628 * @param object $object
630 protected function setService( $name, $object ) {
631 // If we did not yet override the service locator, so so now.
632 if ( MediaWikiServices
::getInstance() === self
::$serviceLocator ) {
633 $this->overrideMwServices();
636 MediaWikiServices
::getInstance()->disableService( $name );
637 MediaWikiServices
::getInstance()->redefineService(
639 function () use ( $object ) {
646 * Sets a global, maintaining a stashed version of the previous global to be
647 * restored in tearDown
649 * The key is added to the array of globals that will be reset afterwards
654 * protected function setUp() {
655 * $this->setMwGlobals( 'wgRestrictStuff', true );
658 * function testFoo() {}
660 * function testBar() {}
661 * $this->assertTrue( self::getX()->doStuff() );
663 * $this->setMwGlobals( 'wgRestrictStuff', false );
664 * $this->assertTrue( self::getX()->doStuff() );
667 * function testQuux() {}
670 * @param array|string $pairs Key to the global variable, or an array
671 * of key/value pairs.
672 * @param mixed $value Value to set the global to (ignored
673 * if an array is given as first argument).
675 * @note To allow changes to global variables to take effect on global service instances,
676 * call overrideMwServices().
680 protected function setMwGlobals( $pairs, $value = null ) {
681 if ( is_string( $pairs ) ) {
682 $pairs = [ $pairs => $value ];
685 $this->stashMwGlobals( array_keys( $pairs ) );
687 foreach ( $pairs as $key => $value ) {
688 $GLOBALS[$key] = $value;
693 * Check if we can back up a value by performing a shallow copy.
694 * Values which fail this test are copied recursively.
696 * @param mixed $value
697 * @return bool True if a shallow copy will do; false if a deep copy
700 private static function canShallowCopy( $value ) {
701 if ( is_scalar( $value ) ||
$value === null ) {
704 if ( is_array( $value ) ) {
705 foreach ( $value as $subValue ) {
706 if ( !is_scalar( $subValue ) && $subValue !== null ) {
716 * Stashes the global, will be restored in tearDown()
718 * Individual test functions may override globals through the setMwGlobals() function
719 * or directly. When directly overriding globals their keys should first be passed to this
720 * method in setUp to avoid breaking global state for other tests
722 * That way all other tests are executed with the same settings (instead of using the
723 * unreliable local settings for most tests and fix it only for some tests).
725 * @param array|string $globalKeys Key to the global variable, or an array of keys.
727 * @note To allow changes to global variables to take effect on global service instances,
728 * call overrideMwServices().
732 protected function stashMwGlobals( $globalKeys ) {
733 if ( is_string( $globalKeys ) ) {
734 $globalKeys = [ $globalKeys ];
737 foreach ( $globalKeys as $globalKey ) {
738 // NOTE: make sure we only save the global once or a second call to
739 // setMwGlobals() on the same global would override the original
742 !array_key_exists( $globalKey, $this->mwGlobals
) &&
743 !array_key_exists( $globalKey, $this->mwGlobalsToUnset
)
745 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
746 $this->mwGlobalsToUnset
[$globalKey] = $globalKey;
749 // NOTE: we serialize then unserialize the value in case it is an object
750 // this stops any objects being passed by reference. We could use clone
751 // and if is_object but this does account for objects within objects!
752 if ( self
::canShallowCopy( $GLOBALS[$globalKey] ) ) {
753 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
755 // Many MediaWiki types are safe to clone. These are the
756 // ones that are most commonly stashed.
757 $GLOBALS[$globalKey] instanceof Language ||
758 $GLOBALS[$globalKey] instanceof User ||
759 $GLOBALS[$globalKey] instanceof FauxRequest
761 $this->mwGlobals
[$globalKey] = clone $GLOBALS[$globalKey];
762 } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
763 // Serializing Closure only gives a warning on HHVM while
764 // it throws an Exception on Zend.
765 // Workaround for https://github.com/facebook/hhvm/issues/6206
766 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
769 $this->mwGlobals
[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
770 } catch ( Exception
$e ) {
771 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
780 * @param int $maxDepth
784 private function containsClosure( $var, $maxDepth = 15 ) {
785 if ( $var instanceof Closure
) {
788 if ( !is_array( $var ) ||
$maxDepth === 0 ) {
792 foreach ( $var as $value ) {
793 if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
801 * Merges the given values into a MW global array variable.
802 * Useful for setting some entries in a configuration array, instead of
803 * setting the entire array.
805 * @param string $name The name of the global, as in wgFooBar
806 * @param array $values The array containing the entries to set in that global
808 * @throws MWException If the designated global is not an array.
810 * @note To allow changes to global variables to take effect on global service instances,
811 * call overrideMwServices().
815 protected function mergeMwGlobalArrayValue( $name, $values ) {
816 if ( !isset( $GLOBALS[$name] ) ) {
819 if ( !is_array( $GLOBALS[$name] ) ) {
820 throw new MWException( "MW global $name is not an array." );
823 // NOTE: do not use array_merge, it screws up for numeric keys.
824 $merged = $GLOBALS[$name];
825 foreach ( $values as $k => $v ) {
830 $this->setMwGlobals( $name, $merged );
834 * Stashes the global instance of MediaWikiServices, and installs a new one,
835 * allowing test cases to override settings and services.
836 * The previous instance of MediaWikiServices will be restored on tearDown.
840 * @param Config $configOverrides Configuration overrides for the new MediaWikiServices instance.
841 * @param callable[] $services An associative array of services to re-define. Keys are service
842 * names, values are callables.
844 * @return MediaWikiServices
845 * @throws MWException
847 protected function overrideMwServices( Config
$configOverrides = null, array $services = [] ) {
848 if ( !$configOverrides ) {
849 $configOverrides = new HashConfig();
852 $oldInstance = MediaWikiServices
::getInstance();
853 $oldConfigFactory = $oldInstance->getConfigFactory();
854 $oldLoadBalancerFactory = $oldInstance->getDBLoadBalancerFactory();
856 $testConfig = self
::makeTestConfig( null, $configOverrides );
857 $newInstance = new MediaWikiServices( $testConfig );
859 // Load the default wiring from the specified files.
860 // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
861 $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
862 $newInstance->loadWiringFiles( $wiringFiles );
864 // Provide a traditional hook point to allow extensions to configure services.
865 Hooks
::run( 'MediaWikiServices', [ $newInstance ] );
867 foreach ( $services as $name => $callback ) {
868 $newInstance->redefineService( $name, $callback );
871 self
::installTestServices(
873 $oldLoadBalancerFactory,
876 MediaWikiServices
::forceGlobalInstance( $newInstance );
883 * @param string|Language $lang
885 public function setUserLang( $lang ) {
886 RequestContext
::getMain()->setLanguage( $lang );
887 $this->setMwGlobals( 'wgLang', RequestContext
::getMain()->getLanguage() );
892 * @param string|Language $lang
894 public function setContentLang( $lang ) {
895 if ( $lang instanceof Language
) {
896 $langCode = $lang->getCode();
900 $langObj = Language
::factory( $langCode );
902 $this->setMwGlobals( [
903 'wgLanguageCode' => $langCode,
904 'wgContLang' => $langObj,
909 * Alters $wgGroupPermissions for the duration of the test. Can be called
910 * with an array, like
911 * [ '*' => [ 'read' => false ], 'user' => [ 'read' => false ] ]
912 * or three values to set a single permission, like
913 * $this->setGroupPermissions( '*', 'read', false );
916 * @param array|string $newPerms Either an array of permissions to change,
917 * in which case the next two parameters are ignored; or a single string
918 * identifying a group, to use with the next two parameters.
919 * @param string|null $newKey
920 * @param mixed $newValue
922 public function setGroupPermissions( $newPerms, $newKey = null, $newValue = null ) {
923 global $wgGroupPermissions;
925 $this->stashMwGlobals( 'wgGroupPermissions' );
927 if ( is_string( $newPerms ) ) {
928 $newPerms = [ $newPerms => [ $newKey => $newValue ] ];
931 foreach ( $newPerms as $group => $permissions ) {
932 foreach ( $permissions as $key => $value ) {
933 $wgGroupPermissions[$group][$key] = $value;
939 * Sets the logger for a specified channel, for the duration of the test.
941 * @param string $channel
942 * @param LoggerInterface $logger
944 protected function setLogger( $channel, LoggerInterface
$logger ) {
945 // TODO: Once loggers are managed by MediaWikiServices, use
946 // overrideMwServices() to set loggers.
948 $provider = LoggerFactory
::getProvider();
949 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
950 $singletons = $wrappedProvider->singletons
;
951 if ( $provider instanceof MonologSpi
) {
952 if ( !isset( $this->loggers
[$channel] ) ) {
953 $this->loggers
[$channel] = $singletons['loggers'][$channel] ??
null;
955 $singletons['loggers'][$channel] = $logger;
956 } elseif ( $provider instanceof LegacySpi
) {
957 if ( !isset( $this->loggers
[$channel] ) ) {
958 $this->loggers
[$channel] = $singletons[$channel] ??
null;
960 $singletons[$channel] = $logger;
962 throw new LogicException( __METHOD__
. ': setting a logger for ' . get_class( $provider )
963 . ' is not implemented' );
965 $wrappedProvider->singletons
= $singletons;
969 * Restores loggers replaced by setLogger().
972 private function restoreLoggers() {
973 $provider = LoggerFactory
::getProvider();
974 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
975 $singletons = $wrappedProvider->singletons
;
976 foreach ( $this->loggers
as $channel => $logger ) {
977 if ( $provider instanceof MonologSpi
) {
978 if ( $logger === null ) {
979 unset( $singletons['loggers'][$channel] );
981 $singletons['loggers'][$channel] = $logger;
983 } elseif ( $provider instanceof LegacySpi
) {
984 if ( $logger === null ) {
985 unset( $singletons[$channel] );
987 $singletons[$channel] = $logger;
991 $wrappedProvider->singletons
= $singletons;
999 public function dbPrefix() {
1000 return $this->db
->getType() == 'oracle' ? self
::ORA_DB_PREFIX
: self
::DB_PREFIX
;
1007 public function needsDB() {
1008 // If the test says it uses database tables, it needs the database
1009 if ( $this->tablesUsed
) {
1013 // If the test class says it belongs to the Database group, it needs the database.
1014 // NOTE: This ONLY checks for the group in the class level doc comment.
1015 $rc = new ReflectionClass( $this );
1016 if ( preg_match( '/@group +Database/im', $rc->getDocComment() ) ) {
1024 * Insert a new page.
1026 * Should be called from addDBData().
1028 * @since 1.25 ($namespace in 1.28)
1029 * @param string|title $pageName Page name or title
1030 * @param string $text Page's content
1031 * @param int $namespace Namespace id (name cannot already contain namespace)
1032 * @return array Title object and page id
1034 protected function insertPage(
1036 $text = 'Sample page for unit test.',
1039 if ( is_string( $pageName ) ) {
1040 $title = Title
::newFromText( $pageName, $namespace );
1045 $user = static::getTestSysop()->getUser();
1046 $comment = __METHOD__
. ': Sample page for unit test.';
1048 $page = WikiPage
::factory( $title );
1049 $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $comment, 0, false, $user );
1053 'id' => $page->getId(),
1058 * Stub. If a test suite needs to add additional data to the database, it should
1059 * implement this method and do so. This method is called once per test suite
1060 * (i.e. once per class).
1062 * Note data added by this method may be removed by resetDB() depending on
1063 * the contents of $tablesUsed.
1065 * To add additional data between test function runs, override prepareDB().
1072 public function addDBDataOnce() {
1076 * Stub. Subclasses may override this to prepare the database.
1077 * Called before every test run (test function or data set).
1079 * @see addDBDataOnce()
1084 public function addDBData() {
1087 private function addCoreDBData() {
1088 if ( $this->db
->getType() == 'oracle' ) {
1089 # Insert 0 user to prevent FK violations
1091 if ( !$this->db
->selectField( 'user', '1', [ 'user_id' => 0 ] ) ) {
1092 $this->db
->insert( 'user', [
1094 'user_name' => 'Anonymous' ], __METHOD__
, [ 'IGNORE' ] );
1097 # Insert 0 page to prevent FK violations
1099 if ( !$this->db
->selectField( 'page', '1', [ 'page_id' => 0 ] ) ) {
1100 $this->db
->insert( 'page', [
1102 'page_namespace' => 0,
1103 'page_title' => ' ',
1104 'page_restrictions' => null,
1105 'page_is_redirect' => 0,
1108 'page_touched' => $this->db
->timestamp(),
1110 'page_len' => 0 ], __METHOD__
, [ 'IGNORE' ] );
1114 SiteStatsInit
::doPlaceholderInit();
1116 User
::resetIdByNameCache();
1119 $user = static::getTestSysop()->getUser();
1121 // Make 1 page with 1 revision
1122 $page = WikiPage
::factory( Title
::newFromText( 'UTPage' ) );
1123 if ( $page->getId() == 0 ) {
1124 $page->doEditContent(
1125 new WikitextContent( 'UTContent' ),
1127 EDIT_NEW | EDIT_SUPPRESS_RC
,
1131 // an edit always attempt to purge backlink links such as history
1132 // pages. That is unneccessary.
1133 JobQueueGroup
::singleton()->get( 'htmlCacheUpdate' )->delete();
1134 // WikiPages::doEditUpdates randomly adds RC purges
1135 JobQueueGroup
::singleton()->get( 'recentChangesUpdate' )->delete();
1137 // doEditContent() probably started the session via
1138 // User::loadFromSession(). Close it now.
1139 if ( session_id() !== '' ) {
1140 session_write_close();
1147 * Restores MediaWiki to using the table set (table prefix) it was using before
1148 * setupTestDB() was called. Useful if we need to perform database operations
1149 * after the test run has finished (such as saving logs or profiling info).
1151 * This is called by phpunit/bootstrap.php after the last test.
1155 public static function teardownTestDB() {
1156 global $wgJobClasses;
1158 if ( !self
::$dbSetup ) {
1162 Hooks
::run( 'UnitTestsBeforeDatabaseTeardown' );
1164 foreach ( $wgJobClasses as $type => $class ) {
1165 // Delete any jobs under the clone DB (or old prefix in other stores)
1166 JobQueueGroup
::singleton()->get( $type )->delete();
1169 CloneDatabase
::changePrefix( self
::$oldTablePrefix );
1171 self
::$oldTablePrefix = false;
1172 self
::$dbSetup = false;
1176 * Setups a database with the given prefix.
1178 * If reuseDB is true and certain conditions apply, it will just change the prefix.
1179 * Otherwise, it will clone the tables and change the prefix.
1181 * Clones all tables in the given database (whatever database that connection has
1182 * open), to versions with the test prefix.
1184 * @param IMaintainableDatabase $db Database to use
1185 * @param string $prefix Prefix to use for test tables
1186 * @return bool True if tables were cloned, false if only the prefix was changed
1188 protected static function setupDatabaseWithTestPrefix( IMaintainableDatabase
$db, $prefix ) {
1189 $tablesCloned = self
::listTables( $db );
1190 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix );
1191 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1193 $db->_originalTablePrefix
= $db->tablePrefix();
1195 if ( ( $db->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
1196 CloneDatabase
::changePrefix( $prefix );
1200 $dbClone->cloneTableStructure();
1206 * Set up all test DBs
1208 public function setupAllTestDBs() {
1211 self
::$oldTablePrefix = $wgDBprefix;
1213 $testPrefix = $this->dbPrefix();
1215 // switch to a temporary clone of the database
1216 self
::setupTestDB( $this->db
, $testPrefix );
1218 if ( self
::isUsingExternalStoreDB() ) {
1219 self
::setupExternalStoreTestDBs( $testPrefix );
1224 * Creates an empty skeleton of the wiki database by cloning its structure
1225 * to equivalent tables using the given $prefix. Then sets MediaWiki to
1226 * use the new set of tables (aka schema) instead of the original set.
1228 * This is used to generate a dummy table set, typically consisting of temporary
1229 * tables, that will be used by tests instead of the original wiki database tables.
1233 * @note the original table prefix is stored in self::$oldTablePrefix. This is used
1234 * by teardownTestDB() to return the wiki to using the original table set.
1236 * @note this method only works when first called. Subsequent calls have no effect,
1237 * even if using different parameters.
1239 * @param Database $db The database connection
1240 * @param string $prefix The prefix to use for the new table set (aka schema).
1242 * @throws MWException If the database table prefix is already $prefix
1244 public static function setupTestDB( Database
$db, $prefix ) {
1245 if ( self
::$dbSetup ) {
1249 if ( $db->tablePrefix() === $prefix ) {
1250 throw new MWException(
1251 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
1254 // TODO: the below should be re-written as soon as LBFactory, LoadBalancer,
1255 // and Database no longer use global state.
1257 self
::$dbSetup = true;
1259 if ( !self
::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
1263 // Assuming this isn't needed for External Store database, and not sure if the procedure
1264 // would be available there.
1265 if ( $db->getType() == 'oracle' ) {
1266 $db->query( 'BEGIN FILL_WIKI_INFO; END;' );
1269 Hooks
::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
1273 * Clones the External Store database(s) for testing
1275 * @param string $testPrefix Prefix for test tables
1277 protected static function setupExternalStoreTestDBs( $testPrefix ) {
1278 $connections = self
::getExternalStoreDatabaseConnections();
1279 foreach ( $connections as $dbw ) {
1280 // Hack: cloneTableStructure sets $wgDBprefix to the unit test
1281 // prefix,. Even though listTables now uses tablePrefix, that
1282 // itself is populated from $wgDBprefix by default.
1284 // We have to set it back, or we won't find the original 'blobs'
1287 $dbw->tablePrefix( self
::$oldTablePrefix );
1288 self
::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
1293 * Gets master database connections for all of the ExternalStoreDB
1294 * stores configured in $wgDefaultExternalStore.
1296 * @return Database[] Array of Database master connections
1298 protected static function getExternalStoreDatabaseConnections() {
1299 global $wgDefaultExternalStore;
1301 /** @var ExternalStoreDB $externalStoreDB */
1302 $externalStoreDB = ExternalStore
::getStoreObject( 'DB' );
1303 $defaultArray = (array)$wgDefaultExternalStore;
1305 foreach ( $defaultArray as $url ) {
1306 if ( strpos( $url, 'DB://' ) === 0 ) {
1307 list( $proto, $cluster ) = explode( '://', $url, 2 );
1308 // Avoid getMaster() because setupDatabaseWithTestPrefix()
1309 // requires Database instead of plain DBConnRef/IDatabase
1310 $dbws[] = $externalStoreDB->getMaster( $cluster );
1318 * Check whether ExternalStoreDB is being used
1320 * @return bool True if it's being used
1322 protected static function isUsingExternalStoreDB() {
1323 global $wgDefaultExternalStore;
1324 if ( !$wgDefaultExternalStore ) {
1328 $defaultArray = (array)$wgDefaultExternalStore;
1329 foreach ( $defaultArray as $url ) {
1330 if ( strpos( $url, 'DB://' ) === 0 ) {
1339 * @throws LogicException if the given database connection is not a set up to use
1342 private function ensureMockDatabaseConnection( IDatabase
$db ) {
1343 if ( $db->tablePrefix() !== $this->dbPrefix() ) {
1344 throw new LogicException(
1345 'Trying to delete mock tables, but table prefix does not indicate a mock database.'
1350 private static $schemaOverrideDefaults = [
1358 * Stub. If a test suite needs to test against a specific database schema, it should
1359 * override this method and return the appropriate information from it.
1361 * @param IMaintainableDatabase $db The DB connection to use for the mock schema.
1362 * May be used to check the current state of the schema, to determine what
1363 * overrides are needed.
1365 * @return array An associative array with the following fields:
1366 * - 'scripts': any SQL scripts to run. If empty or not present, schema overrides are skipped.
1367 * - 'create': A list of tables created (may or may not exist in the original schema).
1368 * - 'drop': A list of tables dropped (expected to be present in the original schema).
1369 * - 'alter': A list of tables altered (expected to be present in the original schema).
1371 protected function getSchemaOverrides( IMaintainableDatabase
$db ) {
1376 * Undoes the dpecified schema overrides..
1377 * Called once per test class, just before addDataOnce().
1379 * @param IMaintainableDatabase $db
1380 * @param array $oldOverrides
1382 private function undoSchemaOverrides( IMaintainableDatabase
$db, $oldOverrides ) {
1383 $this->ensureMockDatabaseConnection( $db );
1385 $oldOverrides = $oldOverrides + self
::$schemaOverrideDefaults;
1386 $originalTables = $this->listOriginalTables( $db );
1388 // Drop tables that need to be restored or removed.
1389 $tablesToDrop = array_merge( $oldOverrides['create'], $oldOverrides['alter'] );
1391 // Restore tables that have been dropped or created or altered,
1392 // if they exist in the original schema.
1393 $tablesToRestore = array_merge( $tablesToDrop, $oldOverrides['drop'] );
1394 $tablesToRestore = array_intersect( $originalTables, $tablesToRestore );
1396 if ( $tablesToDrop ) {
1397 $this->dropMockTables( $db, $tablesToDrop );
1400 if ( $tablesToRestore ) {
1401 $this->recloneMockTables( $db, $tablesToRestore );
1406 * Applies the schema overrides returned by getSchemaOverrides(),
1407 * after undoing any previously applied schema overrides.
1408 * Called once per test class, just before addDataOnce().
1410 private function setUpSchema( IMaintainableDatabase
$db ) {
1411 // Undo any active overrides.
1412 $oldOverrides = $db->_schemaOverrides ?? self
::$schemaOverrideDefaults;
1414 if ( $oldOverrides['alter'] ||
$oldOverrides['create'] ||
$oldOverrides['drop'] ) {
1415 $this->undoSchemaOverrides( $db, $oldOverrides );
1418 // Determine new overrides.
1419 $overrides = $this->getSchemaOverrides( $db ) + self
::$schemaOverrideDefaults;
1421 $extraKeys = array_diff(
1422 array_keys( $overrides ),
1423 array_keys( self
::$schemaOverrideDefaults )
1427 throw new InvalidArgumentException(
1428 'Schema override contains extra keys: ' . var_export( $extraKeys, true )
1432 if ( !$overrides['scripts'] ) {
1433 // no scripts to run
1437 if ( !$overrides['create'] && !$overrides['drop'] && !$overrides['alter'] ) {
1438 throw new InvalidArgumentException(
1439 'Schema override scripts given, but no tables are declared to be '
1440 . 'created, dropped or altered.'
1444 $this->ensureMockDatabaseConnection( $db );
1446 // Drop the tables that will be created by the schema scripts.
1447 $originalTables = $this->listOriginalTables( $db );
1448 $tablesToDrop = array_intersect( $originalTables, $overrides['create'] );
1450 if ( $tablesToDrop ) {
1451 $this->dropMockTables( $db, $tablesToDrop );
1454 // Run schema override scripts.
1455 foreach ( $overrides['scripts'] as $script ) {
1462 return $this->mungeSchemaUpdateQuery( $cmd );
1467 $db->_schemaOverrides
= $overrides;
1470 private function mungeSchemaUpdateQuery( $cmd ) {
1471 return self
::$useTemporaryTables
1472 ?
preg_replace( '/\bCREATE\s+TABLE\b/i', 'CREATE TEMPORARY TABLE', $cmd )
1477 * Drops the given mock tables.
1479 * @param IMaintainableDatabase $db
1480 * @param array $tables
1482 private function dropMockTables( IMaintainableDatabase
$db, array $tables ) {
1483 $this->ensureMockDatabaseConnection( $db );
1485 foreach ( $tables as $tbl ) {
1486 $tbl = $db->tableName( $tbl );
1487 $db->query( "DROP TABLE IF EXISTS $tbl", __METHOD__
);
1489 if ( $tbl === 'page' ) {
1490 // Forget about the pages since they don't
1492 LinkCache
::singleton()->clear();
1498 * Lists all tables in the live database schema.
1500 * @param IMaintainableDatabase $db
1503 private function listOriginalTables( IMaintainableDatabase
$db ) {
1504 if ( !isset( $db->_originalTablePrefix
) ) {
1505 throw new LogicException( 'No original table prefix know, cannot list tables!' );
1508 $originalTables = $db->listTables( $db->_originalTablePrefix
, __METHOD__
);
1509 return $originalTables;
1513 * Re-clones the given mock tables to restore them based on the live database schema.
1514 * The tables listed in $tables are expected to currently not exist, so dropMockTables()
1515 * should be called first.
1517 * @param IMaintainableDatabase $db
1518 * @param array $tables
1520 private function recloneMockTables( IMaintainableDatabase
$db, array $tables ) {
1521 $this->ensureMockDatabaseConnection( $db );
1523 if ( !isset( $db->_originalTablePrefix
) ) {
1524 throw new LogicException( 'No original table prefix know, cannot restore tables!' );
1527 $originalTables = $this->listOriginalTables( $db );
1528 $tables = array_intersect( $tables, $originalTables );
1530 $dbClone = new CloneDatabase( $db, $tables, $db->tablePrefix(), $db->_originalTablePrefix
);
1531 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1533 $dbClone->cloneTableStructure();
1537 * Empty all tables so they can be repopulated for tests
1539 * @param Database $db|null Database to reset
1540 * @param array $tablesUsed Tables to reset
1542 private function resetDB( $db, $tablesUsed ) {
1544 $userTables = [ 'user', 'user_groups', 'user_properties', 'actor' ];
1545 $pageTables = [ 'page', 'revision', 'ip_changes', 'revision_comment_temp',
1546 'revision_actor_temp', 'comment', 'archive' ];
1547 $coreDBDataTables = array_merge( $userTables, $pageTables );
1549 // If any of the user or page tables were marked as used, we should clear all of them.
1550 if ( array_intersect( $tablesUsed, $userTables ) ) {
1551 $tablesUsed = array_unique( array_merge( $tablesUsed, $userTables ) );
1552 TestUserRegistry
::clear();
1554 if ( array_intersect( $tablesUsed, $pageTables ) ) {
1555 $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
1558 $truncate = in_array( $db->getType(), [ 'oracle', 'mysql' ] );
1559 foreach ( $tablesUsed as $tbl ) {
1560 // TODO: reset interwiki table to its original content.
1561 if ( $tbl == 'interwiki' ) {
1565 if ( !$db->tableExists( $tbl ) ) {
1570 $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tbl ), __METHOD__
);
1572 $db->delete( $tbl, '*', __METHOD__
);
1575 if ( in_array( $db->getType(), [ 'postgres', 'sqlite' ], true ) ) {
1576 // Reset the table's sequence too.
1577 $db->resetSequenceForTable( $tbl, __METHOD__
);
1580 if ( $tbl === 'page' ) {
1581 // Forget about the pages since they don't
1583 LinkCache
::singleton()->clear();
1587 if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
1588 // Re-add core DB data that was deleted
1589 $this->addCoreDBData();
1594 private static function unprefixTable( &$tableName, $ind, $prefix ) {
1595 $tableName = substr( $tableName, strlen( $prefix ) );
1598 private static function isNotUnittest( $table ) {
1599 return strpos( $table, self
::DB_PREFIX
) !== 0;
1605 * @param IMaintainableDatabase $db
1609 public static function listTables( IMaintainableDatabase
$db ) {
1610 $prefix = $db->tablePrefix();
1611 $tables = $db->listTables( $prefix, __METHOD__
);
1613 if ( $db->getType() === 'mysql' ) {
1614 static $viewListCache = null;
1615 if ( $viewListCache === null ) {
1616 $viewListCache = $db->listViews( null, __METHOD__
);
1618 // T45571: cannot clone VIEWs under MySQL
1619 $tables = array_diff( $tables, $viewListCache );
1621 array_walk( $tables, [ __CLASS__
, 'unprefixTable' ], $prefix );
1623 // Don't duplicate test tables from the previous fataled run
1624 $tables = array_filter( $tables, [ __CLASS__
, 'isNotUnittest' ] );
1626 if ( $db->getType() == 'sqlite' ) {
1627 $tables = array_flip( $tables );
1628 // these are subtables of searchindex and don't need to be duped/dropped separately
1629 unset( $tables['searchindex_content'] );
1630 unset( $tables['searchindex_segdir'] );
1631 unset( $tables['searchindex_segments'] );
1632 $tables = array_flip( $tables );
1639 * @throws MWException
1642 protected function checkDbIsSupported() {
1643 if ( !in_array( $this->db
->getType(), $this->supportedDBs
) ) {
1644 throw new MWException( $this->db
->getType() . " is not currently supported for unit testing." );
1650 * @param string $offset
1653 public function getCliArg( $offset ) {
1654 if ( isset( PHPUnitMaintClass
::$additionalOptions[$offset] ) ) {
1655 return PHPUnitMaintClass
::$additionalOptions[$offset];
1663 * @param string $offset
1664 * @param mixed $value
1666 public function setCliArg( $offset, $value ) {
1667 PHPUnitMaintClass
::$additionalOptions[$offset] = $value;
1671 * Don't throw a warning if $function is deprecated and called later
1675 * @param string $function
1677 public function hideDeprecated( $function ) {
1678 Wikimedia\
suppressWarnings();
1679 wfDeprecated( $function );
1680 Wikimedia\restoreWarnings
();
1684 * Asserts that the given database query yields the rows given by $expectedRows.
1685 * The expected rows should be given as indexed (not associative) arrays, with
1686 * the values given in the order of the columns in the $fields parameter.
1687 * Note that the rows are sorted by the columns given in $fields.
1691 * @param string|array $table The table(s) to query
1692 * @param string|array $fields The columns to include in the result (and to sort by)
1693 * @param string|array $condition "where" condition(s)
1694 * @param array $expectedRows An array of arrays giving the expected rows.
1695 * @param array $options Options for the query
1696 * @param array $join_conds Join conditions for the query
1698 * @throws MWException If this test cases's needsDB() method doesn't return true.
1699 * Test cases can use "@group Database" to enable database test support,
1700 * or list the tables under testing in $this->tablesUsed, or override the
1703 protected function assertSelect(
1704 $table, $fields, $condition, array $expectedRows, array $options = [], array $join_conds = []
1706 if ( !$this->needsDB() ) {
1707 throw new MWException( 'When testing database state, the test cases\'s needDB()' .
1708 ' method should return true. Use @group Database or $this->tablesUsed.' );
1711 $db = wfGetDB( DB_REPLICA
);
1718 $options +
[ 'ORDER BY' => $fields ],
1721 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
1725 foreach ( $expectedRows as $expected ) {
1726 $r = $res->fetchRow();
1727 self
::stripStringKeys( $r );
1730 $this->assertNotEmpty( $r, "row #$i missing" );
1732 $this->assertEquals( $expected, $r, "row #$i mismatches" );
1735 $r = $res->fetchRow();
1736 self
::stripStringKeys( $r );
1738 $this->assertFalse( $r, "found extra row (after #$i)" );
1742 * Utility method taking an array of elements and wrapping
1743 * each element in its own array. Useful for data providers
1744 * that only return a single argument.
1748 * @param array $elements
1752 protected function arrayWrap( array $elements ) {
1754 function ( $element ) {
1755 return [ $element ];
1762 * Assert that two arrays are equal. By default this means that both arrays need to hold
1763 * the same set of values. Using additional arguments, order and associated key can also
1764 * be set as relevant.
1768 * @param array $expected
1769 * @param array $actual
1770 * @param bool $ordered If the order of the values should match
1771 * @param bool $named If the keys should match
1773 protected function assertArrayEquals( array $expected, array $actual,
1774 $ordered = false, $named = false
1777 $this->objectAssociativeSort( $expected );
1778 $this->objectAssociativeSort( $actual );
1782 $expected = array_values( $expected );
1783 $actual = array_values( $actual );
1786 call_user_func_array(
1787 [ $this, 'assertEquals' ],
1788 array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
1793 * Put each HTML element on its own line and then equals() the results
1795 * Use for nicely formatting of PHPUnit diff output when comparing very
1800 * @param string $expected HTML on oneline
1801 * @param string $actual HTML on oneline
1802 * @param string $msg Optional message
1804 protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
1805 $expected = str_replace( '>', ">\n", $expected );
1806 $actual = str_replace( '>', ">\n", $actual );
1808 $this->assertEquals( $expected, $actual, $msg );
1812 * Does an associative sort that works for objects.
1816 * @param array &$array
1818 protected function objectAssociativeSort( array &$array ) {
1821 function ( $a, $b ) {
1822 return serialize( $a ) <=> serialize( $b );
1828 * Utility function for eliminating all string keys from an array.
1829 * Useful to turn a database result row as returned by fetchRow() into
1830 * a pure indexed array.
1834 * @param mixed &$r The array to remove string keys from.
1836 protected static function stripStringKeys( &$r ) {
1837 if ( !is_array( $r ) ) {
1841 foreach ( $r as $k => $v ) {
1842 if ( is_string( $k ) ) {
1849 * Asserts that the provided variable is of the specified
1850 * internal type or equals the $value argument. This is useful
1851 * for testing return types of functions that return a certain
1852 * type or *value* when not set or on error.
1856 * @param string $type
1857 * @param mixed $actual
1858 * @param mixed $value
1859 * @param string $message
1861 protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
1862 if ( $actual === $value ) {
1863 $this->assertTrue( true, $message );
1865 $this->assertType( $type, $actual, $message );
1870 * Asserts the type of the provided value. This can be either
1871 * in internal type such as boolean or integer, or a class or
1872 * interface the value extends or implements.
1876 * @param string $type
1877 * @param mixed $actual
1878 * @param string $message
1880 protected function assertType( $type, $actual, $message = '' ) {
1881 if ( class_exists( $type ) ||
interface_exists( $type ) ) {
1882 $this->assertInstanceOf( $type, $actual, $message );
1884 $this->assertInternalType( $type, $actual, $message );
1889 * Returns true if the given namespace defaults to Wikitext
1890 * according to $wgNamespaceContentModels
1892 * @param int $ns The namespace ID to check
1897 protected function isWikitextNS( $ns ) {
1898 global $wgNamespaceContentModels;
1900 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
1901 return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
;
1908 * Returns the ID of a namespace that defaults to Wikitext.
1910 * @throws MWException If there is none.
1911 * @return int The ID of the wikitext Namespace
1914 protected function getDefaultWikitextNS() {
1915 global $wgNamespaceContentModels;
1917 static $wikitextNS = null; // this is not going to change
1918 if ( $wikitextNS !== null ) {
1922 // quickly short out on most common case:
1923 if ( !isset( $wgNamespaceContentModels[NS_MAIN
] ) ) {
1927 // NOTE: prefer content namespaces
1928 $namespaces = array_unique( array_merge(
1929 MWNamespace
::getContentNamespaces(),
1930 [ NS_MAIN
, NS_HELP
, NS_PROJECT
], // prefer these
1931 MWNamespace
::getValidNamespaces()
1934 $namespaces = array_diff( $namespaces, [
1935 NS_FILE
, NS_CATEGORY
, NS_MEDIAWIKI
, NS_USER
// don't mess with magic namespaces
1938 $talk = array_filter( $namespaces, function ( $ns ) {
1939 return MWNamespace
::isTalk( $ns );
1942 // prefer non-talk pages
1943 $namespaces = array_diff( $namespaces, $talk );
1944 $namespaces = array_merge( $namespaces, $talk );
1946 // check default content model of each namespace
1947 foreach ( $namespaces as $ns ) {
1948 if ( !isset( $wgNamespaceContentModels[$ns] ) ||
1949 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
1958 // @todo Inside a test, we could skip the test as incomplete.
1959 // But frequently, this is used in fixture setup.
1960 throw new MWException( "No namespace defaults to wikitext!" );
1964 * Check, if $wgDiff3 is set and ready to merge
1965 * Will mark the calling test as skipped, if not ready
1969 protected function markTestSkippedIfNoDiff3() {
1972 # This check may also protect against code injection in
1973 # case of broken installations.
1974 Wikimedia\
suppressWarnings();
1975 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
1976 Wikimedia\restoreWarnings
();
1978 if ( !$haveDiff3 ) {
1979 $this->markTestSkipped( "Skip test, since diff3 is not configured" );
1984 * Check if $extName is a loaded PHP extension, will skip the
1985 * test whenever it is not loaded.
1988 * @param string $extName
1991 protected function checkPHPExtension( $extName ) {
1992 $loaded = extension_loaded( $extName );
1994 $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
2001 * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
2002 * @param string $buffer
2005 public static function wfResetOutputBuffersBarrier( $buffer ) {
2010 * Create a temporary hook handler which will be reset by tearDown.
2011 * This replaces other handlers for the same hook.
2012 * @param string $hookName Hook name
2013 * @param mixed $handler Value suitable for a hook handler
2016 protected function setTemporaryHook( $hookName, $handler ) {
2017 $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
2021 * Check whether file contains given data.
2022 * @param string $fileName
2023 * @param string $actualData
2024 * @param bool $createIfMissing If true, and file does not exist, create it with given data
2025 * and skip the test.
2026 * @param string $msg
2029 protected function assertFileContains(
2032 $createIfMissing = true,
2035 if ( $createIfMissing ) {
2036 if ( !file_exists( $fileName ) ) {
2037 file_put_contents( $fileName, $actualData );
2038 $this->markTestSkipped( 'Data file $fileName does not exist' );
2041 self
::assertFileExists( $fileName );
2043 self
::assertEquals( file_get_contents( $fileName ), $actualData, $msg );