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
;
22 * The service locator created by prepareServices(). This service locator will
23 * be restored after each test. Tests that pollute the global service locator
24 * instance should use overrideMwServices() to isolate the test.
26 * @var MediaWikiServices|null
28 private static $serviceLocator = null;
31 * $called tracks whether the setUp and tearDown method has been called.
32 * class extending MediaWikiTestCase usually override setUp and tearDown
33 * but forget to call the parent.
35 * The array format takes a method name as key and anything as a value.
36 * By asserting the key exist, we know the child class has called the
39 * This property must be private, we do not want child to override it,
40 * they should call the appropriate parent method instead.
62 protected $tablesUsed = []; // tables with data
64 private static $useTemporaryTables = true;
65 private static $reuseDB = false;
66 private static $dbSetup = false;
67 private static $oldTablePrefix = '';
70 * Original value of PHP's error_reporting setting.
74 private $phpErrorLevel;
77 * Holds the paths of temporary files/directories created through getNewTempFile,
78 * and getNewTempDirectory
82 private $tmpFiles = [];
85 * Holds original values of MediaWiki configuration settings
86 * to be restored in tearDown().
87 * See also setMwGlobals().
90 private $mwGlobals = [];
93 * Holds list of MediaWiki configuration settings to be unset in tearDown().
94 * See also setMwGlobals().
97 private $mwGlobalsToUnset = [];
100 * Holds original loggers which have been replaced by setLogger()
101 * @var LoggerInterface[]
103 private $loggers = [];
106 * Table name prefixes. Oracle likes it shorter.
108 const DB_PREFIX
= 'unittest_';
109 const ORA_DB_PREFIX
= 'ut_';
115 protected $supportedDBs = [
122 public function __construct( $name = null, array $data = [], $dataName = '' ) {
123 parent
::__construct( $name, $data, $dataName );
125 $this->backupGlobals
= false;
126 $this->backupStaticAttributes
= false;
129 public function __destruct() {
130 // Complain if self::setUp() was called, but not self::tearDown()
131 // $this->called['setUp'] will be checked by self::testMediaWikiTestCaseParentSetupCalled()
132 if ( isset( $this->called
['setUp'] ) && !isset( $this->called
['tearDown'] ) ) {
133 throw new MWException( static::class . "::tearDown() must call parent::tearDown()" );
137 public static function setUpBeforeClass() {
138 parent
::setUpBeforeClass();
140 // Get the service locator, and reset services if it's not done already
141 self
::$serviceLocator = self
::prepareServices( new GlobalVarConfig() );
145 * Convenience method for getting an immutable test user
149 * @param string[] $groups Groups the test user should be in.
152 public static function getTestUser( $groups = [] ) {
153 return TestUserRegistry
::getImmutableTestUser( $groups );
157 * Convenience method for getting a mutable test user
161 * @param string[] $groups Groups the test user should be added in.
164 public static function getMutableTestUser( $groups = [] ) {
165 return TestUserRegistry
::getMutableTestUser( __CLASS__
, $groups );
169 * Convenience method for getting an immutable admin test user
173 * @param string[] $groups Groups the test user should be added to.
176 public static function getTestSysop() {
177 return self
::getTestUser( [ 'sysop', 'bureaucrat' ] );
181 * Prepare service configuration for unit testing.
183 * This calls MediaWikiServices::resetGlobalInstance() to allow some critical services
184 * to be overridden for testing.
186 * prepareServices() only needs to be called once, but should be called as early as possible,
187 * before any class has a chance to grab a reference to any of the global services
188 * instances that get discarded by prepareServices(). Only the first call has any effect,
189 * later calls are ignored.
191 * @note This is called by PHPUnitMaintClass::finalSetup.
193 * @see MediaWikiServices::resetGlobalInstance()
195 * @param Config $bootstrapConfig The bootstrap config to use with the new
196 * MediaWikiServices. Only used for the first call to this method.
197 * @return MediaWikiServices
199 public static function prepareServices( Config
$bootstrapConfig ) {
200 static $services = null;
203 $services = self
::resetGlobalServices( $bootstrapConfig );
209 * Reset global services, and install testing environment.
210 * This is the testing equivalent of MediaWikiServices::resetGlobalInstance().
211 * This should only be used to set up the testing environment, not when
212 * running unit tests. Use MediaWikiTestCase::overrideMwServices() for that.
214 * @see MediaWikiServices::resetGlobalInstance()
215 * @see prepareServices()
216 * @see MediaWikiTestCase::overrideMwServices()
218 * @param Config|null $bootstrapConfig The bootstrap config to use with the new
220 * @return MediaWikiServices
222 protected static function resetGlobalServices( Config
$bootstrapConfig = null ) {
223 $oldServices = MediaWikiServices
::getInstance();
224 $oldConfigFactory = $oldServices->getConfigFactory();
225 $oldLoadBalancerFactory = $oldServices->getDBLoadBalancerFactory();
227 $testConfig = self
::makeTestConfig( $bootstrapConfig );
229 MediaWikiServices
::resetGlobalInstance( $testConfig );
231 $serviceLocator = MediaWikiServices
::getInstance();
232 self
::installTestServices(
234 $oldLoadBalancerFactory,
237 return $serviceLocator;
241 * Create a config suitable for testing, based on a base config, default overrides,
242 * and custom overrides.
244 * @param Config|null $baseConfig
245 * @param Config|null $customOverrides
249 private static function makeTestConfig(
250 Config
$baseConfig = null,
251 Config
$customOverrides = null
253 $defaultOverrides = new HashConfig();
255 if ( !$baseConfig ) {
256 $baseConfig = MediaWikiServices
::getInstance()->getBootstrapConfig();
259 /* Some functions require some kind of caching, and will end up using the db,
260 * which we can't allow, as that would open a new connection for mysql.
261 * Replace with a HashBag. They would not be going to persist anyway.
263 $hashCache = [ 'class' => HashBagOStuff
::class, 'reportDupes' => false ];
265 CACHE_DB
=> $hashCache,
266 CACHE_ACCEL
=> $hashCache,
267 CACHE_MEMCACHED
=> $hashCache,
269 'apcu' => $hashCache,
270 'xcache' => $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() {
365 JobQueueGroup
::destroySingletons();
366 ObjectCache
::clear();
367 $services = MediaWikiServices
::getInstance();
368 $services->resetServiceForTesting( 'MainObjectStash' );
369 $services->resetServiceForTesting( 'LocalServerObjectCache' );
370 $services->getMainWANObjectCache()->clearProcessCache();
371 FileBackendGroup
::destroySingleton();
373 // TODO: move global state into MediaWikiServices
374 RequestContext
::resetMain();
375 if ( session_id() !== '' ) {
376 session_write_close();
380 $wgRequest = new FauxRequest();
381 MediaWiki\Session\SessionManager
::resetCache();
384 public function run( PHPUnit_Framework_TestResult
$result = null ) {
385 // Reset all caches between tests.
386 $this->doLightweightServiceReset();
388 $needsResetDB = false;
390 if ( !self
::$dbSetup ||
$this->needsDB() ) {
391 // set up a DB connection for this test to use
393 self
::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
394 self
::$reuseDB = $this->getCliArg( 'reuse-db' );
396 $this->db
= wfGetDB( DB_MASTER
);
398 $this->checkDbIsSupported();
400 if ( !self
::$dbSetup ) {
401 $this->setupAllTestDBs();
402 $this->addCoreDBData();
404 if ( ( $this->db
->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
405 $this->resetDB( $this->db
, $this->tablesUsed
);
409 // TODO: the DB setup should be done in setUpBeforeClass(), so the test DB
410 // is available in subclass's setUpBeforeClass() and setUp() methods.
411 // This would also remove the need for the HACK that is oncePerClass().
412 if ( $this->oncePerClass() ) {
413 $this->setUpSchema( $this->db
);
414 $this->addDBDataOnce();
418 $needsResetDB = true;
421 parent
::run( $result );
423 if ( $needsResetDB ) {
424 $this->resetDB( $this->db
, $this->tablesUsed
);
431 private function oncePerClass() {
432 // Remember current test class in the database connection,
433 // so we know when we need to run addData.
435 $class = static::class;
437 $first = !isset( $this->db
->_hasDataForTestClass
)
438 ||
$this->db
->_hasDataForTestClass
!== $class;
440 $this->db
->_hasDataForTestClass
= $class;
449 public function usesTemporaryTables() {
450 return self
::$useTemporaryTables;
454 * Obtains a new temporary file name
456 * The obtained filename is enlisted to be removed upon tearDown
460 * @return string Absolute name of the temporary file
462 protected function getNewTempFile() {
463 $fileName = tempnam( wfTempDir(), 'MW_PHPUnit_' . static::class . '_' );
464 $this->tmpFiles
[] = $fileName;
470 * obtains a new temporary directory
472 * The obtained directory is enlisted to be removed (recursively with all its contained
473 * files) upon tearDown.
477 * @return string Absolute name of the temporary directory
479 protected function getNewTempDirectory() {
480 // Starting of with a temporary /file/.
481 $fileName = $this->getNewTempFile();
483 // Converting the temporary /file/ to a /directory/
484 // The following is not atomic, but at least we now have a single place,
485 // where temporary directory creation is bundled and can be improved
487 $this->assertTrue( wfMkdirParents( $fileName ) );
492 protected function setUp() {
494 $this->called
['setUp'] = true;
496 $this->phpErrorLevel
= intval( ini_get( 'error_reporting' ) );
498 // Cleaning up temporary files
499 foreach ( $this->tmpFiles
as $fileName ) {
500 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
502 } elseif ( is_dir( $fileName ) ) {
503 wfRecursiveRemoveDir( $fileName );
507 if ( $this->needsDB() && $this->db
) {
508 // Clean up open transactions
509 while ( $this->db
->trxLevel() > 0 ) {
510 $this->db
->rollback( __METHOD__
, 'flush' );
512 // Check for unsafe queries
513 if ( $this->db
->getType() === 'mysql' ) {
514 $this->db
->query( "SET sql_mode = 'STRICT_ALL_TABLES'" );
518 DeferredUpdates
::clearPendingUpdates();
519 ObjectCache
::getMainWANInstance()->clearProcessCache();
521 // XXX: reset maintenance triggers
522 // Hook into period lag checks which often happen in long-running scripts
523 $services = MediaWikiServices
::getInstance();
524 $lbFactory = $services->getDBLoadBalancerFactory();
525 Maintenance
::setLBFactoryTriggers( $lbFactory, $services->getMainConfig() );
527 ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
530 protected function addTmpFiles( $files ) {
531 $this->tmpFiles
= array_merge( $this->tmpFiles
, (array)$files );
534 protected function tearDown() {
535 global $wgRequest, $wgSQLMode;
537 $status = ob_get_status();
538 if ( isset( $status['name'] ) &&
539 $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier'
544 $this->called
['tearDown'] = true;
545 // Cleaning up temporary files
546 foreach ( $this->tmpFiles
as $fileName ) {
547 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
549 } elseif ( is_dir( $fileName ) ) {
550 wfRecursiveRemoveDir( $fileName );
554 if ( $this->needsDB() && $this->db
) {
555 // Clean up open transactions
556 while ( $this->db
->trxLevel() > 0 ) {
557 $this->db
->rollback( __METHOD__
, 'flush' );
559 if ( $this->db
->getType() === 'mysql' ) {
560 $this->db
->query( "SET sql_mode = " . $this->db
->addQuotes( $wgSQLMode ) );
564 // Restore mw globals
565 foreach ( $this->mwGlobals
as $key => $value ) {
566 $GLOBALS[$key] = $value;
568 foreach ( $this->mwGlobalsToUnset
as $value ) {
569 unset( $GLOBALS[$value] );
571 $this->mwGlobals
= [];
572 $this->mwGlobalsToUnset
= [];
573 $this->restoreLoggers();
575 if ( self
::$serviceLocator && MediaWikiServices
::getInstance() !== self
::$serviceLocator ) {
576 MediaWikiServices
::forceGlobalInstance( self
::$serviceLocator );
579 // TODO: move global state into MediaWikiServices
580 RequestContext
::resetMain();
581 if ( session_id() !== '' ) {
582 session_write_close();
585 $wgRequest = new FauxRequest();
586 MediaWiki\Session\SessionManager
::resetCache();
587 MediaWiki\Auth\AuthManager
::resetCache();
589 $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
591 if ( $phpErrorLevel !== $this->phpErrorLevel
) {
592 ini_set( 'error_reporting', $this->phpErrorLevel
);
594 $oldHex = strtoupper( dechex( $this->phpErrorLevel
) );
595 $newHex = strtoupper( dechex( $phpErrorLevel ) );
596 $message = "PHP error_reporting setting was left dirty: "
597 . "was 0x$oldHex before test, 0x$newHex after test!";
599 $this->fail( $message );
606 * Make sure MediaWikiTestCase extending classes have called their
607 * parent setUp method
609 * With strict coverage activated in PHP_CodeCoverage, this test would be
610 * marked as risky without the following annotation (T152923).
613 final public function testMediaWikiTestCaseParentSetupCalled() {
614 $this->assertArrayHasKey( 'setUp', $this->called
,
615 static::class . '::setUp() must call parent::setUp()'
620 * Sets a service, maintaining a stashed version of the previous service to be
621 * restored in tearDown
625 * @param string $name
626 * @param object $object
628 protected function setService( $name, $object ) {
629 // If we did not yet override the service locator, so so now.
630 if ( MediaWikiServices
::getInstance() === self
::$serviceLocator ) {
631 $this->overrideMwServices();
634 MediaWikiServices
::getInstance()->disableService( $name );
635 MediaWikiServices
::getInstance()->redefineService(
637 function () use ( $object ) {
644 * Sets a global, maintaining a stashed version of the previous global to be
645 * restored in tearDown
647 * The key is added to the array of globals that will be reset afterwards
652 * protected function setUp() {
653 * $this->setMwGlobals( 'wgRestrictStuff', true );
656 * function testFoo() {}
658 * function testBar() {}
659 * $this->assertTrue( self::getX()->doStuff() );
661 * $this->setMwGlobals( 'wgRestrictStuff', false );
662 * $this->assertTrue( self::getX()->doStuff() );
665 * function testQuux() {}
668 * @param array|string $pairs Key to the global variable, or an array
669 * of key/value pairs.
670 * @param mixed $value Value to set the global to (ignored
671 * if an array is given as first argument).
673 * @note To allow changes to global variables to take effect on global service instances,
674 * call overrideMwServices().
678 protected function setMwGlobals( $pairs, $value = null ) {
679 if ( is_string( $pairs ) ) {
680 $pairs = [ $pairs => $value ];
683 $this->stashMwGlobals( array_keys( $pairs ) );
685 foreach ( $pairs as $key => $value ) {
686 $GLOBALS[$key] = $value;
691 * Check if we can back up a value by performing a shallow copy.
692 * Values which fail this test are copied recursively.
694 * @param mixed $value
695 * @return bool True if a shallow copy will do; false if a deep copy
698 private static function canShallowCopy( $value ) {
699 if ( is_scalar( $value ) ||
$value === null ) {
702 if ( is_array( $value ) ) {
703 foreach ( $value as $subValue ) {
704 if ( !is_scalar( $subValue ) && $subValue !== null ) {
714 * Stashes the global, will be restored in tearDown()
716 * Individual test functions may override globals through the setMwGlobals() function
717 * or directly. When directly overriding globals their keys should first be passed to this
718 * method in setUp to avoid breaking global state for other tests
720 * That way all other tests are executed with the same settings (instead of using the
721 * unreliable local settings for most tests and fix it only for some tests).
723 * @param array|string $globalKeys Key to the global variable, or an array of keys.
725 * @note To allow changes to global variables to take effect on global service instances,
726 * call overrideMwServices().
730 protected function stashMwGlobals( $globalKeys ) {
731 if ( is_string( $globalKeys ) ) {
732 $globalKeys = [ $globalKeys ];
735 foreach ( $globalKeys as $globalKey ) {
736 // NOTE: make sure we only save the global once or a second call to
737 // setMwGlobals() on the same global would override the original
740 !array_key_exists( $globalKey, $this->mwGlobals
) &&
741 !array_key_exists( $globalKey, $this->mwGlobalsToUnset
)
743 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
744 $this->mwGlobalsToUnset
[$globalKey] = $globalKey;
747 // NOTE: we serialize then unserialize the value in case it is an object
748 // this stops any objects being passed by reference. We could use clone
749 // and if is_object but this does account for objects within objects!
750 if ( self
::canShallowCopy( $GLOBALS[$globalKey] ) ) {
751 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
753 // Many MediaWiki types are safe to clone. These are the
754 // ones that are most commonly stashed.
755 $GLOBALS[$globalKey] instanceof Language ||
756 $GLOBALS[$globalKey] instanceof User ||
757 $GLOBALS[$globalKey] instanceof FauxRequest
759 $this->mwGlobals
[$globalKey] = clone $GLOBALS[$globalKey];
760 } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
761 // Serializing Closure only gives a warning on HHVM while
762 // it throws an Exception on Zend.
763 // Workaround for https://github.com/facebook/hhvm/issues/6206
764 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
767 $this->mwGlobals
[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
768 } catch ( Exception
$e ) {
769 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
778 * @param int $maxDepth
782 private function containsClosure( $var, $maxDepth = 15 ) {
783 if ( $var instanceof Closure
) {
786 if ( !is_array( $var ) ||
$maxDepth === 0 ) {
790 foreach ( $var as $value ) {
791 if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
799 * Merges the given values into a MW global array variable.
800 * Useful for setting some entries in a configuration array, instead of
801 * setting the entire array.
803 * @param string $name The name of the global, as in wgFooBar
804 * @param array $values The array containing the entries to set in that global
806 * @throws MWException If the designated global is not an array.
808 * @note To allow changes to global variables to take effect on global service instances,
809 * call overrideMwServices().
813 protected function mergeMwGlobalArrayValue( $name, $values ) {
814 if ( !isset( $GLOBALS[$name] ) ) {
817 if ( !is_array( $GLOBALS[$name] ) ) {
818 throw new MWException( "MW global $name is not an array." );
821 // NOTE: do not use array_merge, it screws up for numeric keys.
822 $merged = $GLOBALS[$name];
823 foreach ( $values as $k => $v ) {
828 $this->setMwGlobals( $name, $merged );
832 * Stashes the global instance of MediaWikiServices, and installs a new one,
833 * allowing test cases to override settings and services.
834 * The previous instance of MediaWikiServices will be restored on tearDown.
838 * @param Config $configOverrides Configuration overrides for the new MediaWikiServices instance.
839 * @param callable[] $services An associative array of services to re-define. Keys are service
840 * names, values are callables.
842 * @return MediaWikiServices
843 * @throws MWException
845 protected function overrideMwServices( Config
$configOverrides = null, array $services = [] ) {
846 if ( !$configOverrides ) {
847 $configOverrides = new HashConfig();
850 $oldInstance = MediaWikiServices
::getInstance();
851 $oldConfigFactory = $oldInstance->getConfigFactory();
852 $oldLoadBalancerFactory = $oldInstance->getDBLoadBalancerFactory();
854 $testConfig = self
::makeTestConfig( null, $configOverrides );
855 $newInstance = new MediaWikiServices( $testConfig );
857 // Load the default wiring from the specified files.
858 // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
859 $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
860 $newInstance->loadWiringFiles( $wiringFiles );
862 // Provide a traditional hook point to allow extensions to configure services.
863 Hooks
::run( 'MediaWikiServices', [ $newInstance ] );
865 foreach ( $services as $name => $callback ) {
866 $newInstance->redefineService( $name, $callback );
869 self
::installTestServices(
871 $oldLoadBalancerFactory,
874 MediaWikiServices
::forceGlobalInstance( $newInstance );
881 * @param string|Language $lang
883 public function setUserLang( $lang ) {
884 RequestContext
::getMain()->setLanguage( $lang );
885 $this->setMwGlobals( 'wgLang', RequestContext
::getMain()->getLanguage() );
890 * @param string|Language $lang
892 public function setContentLang( $lang ) {
893 if ( $lang instanceof Language
) {
894 $langCode = $lang->getCode();
898 $langObj = Language
::factory( $langCode );
900 $this->setMwGlobals( [
901 'wgLanguageCode' => $langCode,
902 'wgContLang' => $langObj,
907 * Sets the logger for a specified channel, for the duration of the test.
909 * @param string $channel
910 * @param LoggerInterface $logger
912 protected function setLogger( $channel, LoggerInterface
$logger ) {
913 // TODO: Once loggers are managed by MediaWikiServices, use
914 // overrideMwServices() to set loggers.
916 $provider = LoggerFactory
::getProvider();
917 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
918 $singletons = $wrappedProvider->singletons
;
919 if ( $provider instanceof MonologSpi
) {
920 if ( !isset( $this->loggers
[$channel] ) ) {
921 $this->loggers
[$channel] = isset( $singletons['loggers'][$channel] )
922 ?
$singletons['loggers'][$channel] : null;
924 $singletons['loggers'][$channel] = $logger;
925 } elseif ( $provider instanceof LegacySpi
) {
926 if ( !isset( $this->loggers
[$channel] ) ) {
927 $this->loggers
[$channel] = isset( $singletons[$channel] ) ?
$singletons[$channel] : null;
929 $singletons[$channel] = $logger;
931 throw new LogicException( __METHOD__
. ': setting a logger for ' . get_class( $provider )
932 . ' is not implemented' );
934 $wrappedProvider->singletons
= $singletons;
938 * Restores loggers replaced by setLogger().
941 private function restoreLoggers() {
942 $provider = LoggerFactory
::getProvider();
943 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
944 $singletons = $wrappedProvider->singletons
;
945 foreach ( $this->loggers
as $channel => $logger ) {
946 if ( $provider instanceof MonologSpi
) {
947 if ( $logger === null ) {
948 unset( $singletons['loggers'][$channel] );
950 $singletons['loggers'][$channel] = $logger;
952 } elseif ( $provider instanceof LegacySpi
) {
953 if ( $logger === null ) {
954 unset( $singletons[$channel] );
956 $singletons[$channel] = $logger;
960 $wrappedProvider->singletons
= $singletons;
968 public function dbPrefix() {
969 return $this->db
->getType() == 'oracle' ? self
::ORA_DB_PREFIX
: self
::DB_PREFIX
;
976 public function needsDB() {
977 // If the test says it uses database tables, it needs the database
978 if ( $this->tablesUsed
) {
982 // If the test class says it belongs to the Database group, it needs the database.
983 // NOTE: This ONLY checks for the group in the class level doc comment.
984 $rc = new ReflectionClass( $this );
985 if ( preg_match( '/@group +Database/im', $rc->getDocComment() ) ) {
995 * Should be called from addDBData().
997 * @since 1.25 ($namespace in 1.28)
998 * @param string|title $pageName Page name or title
999 * @param string $text Page's content
1000 * @param int $namespace Namespace id (name cannot already contain namespace)
1001 * @return array Title object and page id
1003 protected function insertPage(
1005 $text = 'Sample page for unit test.',
1008 if ( is_string( $pageName ) ) {
1009 $title = Title
::newFromText( $pageName, $namespace );
1014 $user = static::getTestSysop()->getUser();
1015 $comment = __METHOD__
. ': Sample page for unit test.';
1017 $page = WikiPage
::factory( $title );
1018 $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $comment, 0, false, $user );
1022 'id' => $page->getId(),
1027 * Stub. If a test suite needs to add additional data to the database, it should
1028 * implement this method and do so. This method is called once per test suite
1029 * (i.e. once per class).
1031 * Note data added by this method may be removed by resetDB() depending on
1032 * the contents of $tablesUsed.
1034 * To add additional data between test function runs, override prepareDB().
1041 public function addDBDataOnce() {
1045 * Stub. Subclasses may override this to prepare the database.
1046 * Called before every test run (test function or data set).
1048 * @see addDBDataOnce()
1053 public function addDBData() {
1056 private function addCoreDBData() {
1057 if ( $this->db
->getType() == 'oracle' ) {
1058 # Insert 0 user to prevent FK violations
1060 if ( !$this->db
->selectField( 'user', '1', [ 'user_id' => 0 ] ) ) {
1061 $this->db
->insert( 'user', [
1063 'user_name' => 'Anonymous' ], __METHOD__
, [ 'IGNORE' ] );
1066 # Insert 0 page to prevent FK violations
1068 if ( !$this->db
->selectField( 'page', '1', [ 'page_id' => 0 ] ) ) {
1069 $this->db
->insert( 'page', [
1071 'page_namespace' => 0,
1072 'page_title' => ' ',
1073 'page_restrictions' => null,
1074 'page_is_redirect' => 0,
1077 'page_touched' => $this->db
->timestamp(),
1079 'page_len' => 0 ], __METHOD__
, [ 'IGNORE' ] );
1083 User
::resetIdByNameCache();
1086 $user = static::getTestSysop()->getUser();
1088 // Make 1 page with 1 revision
1089 $page = WikiPage
::factory( Title
::newFromText( 'UTPage' ) );
1090 if ( $page->getId() == 0 ) {
1091 $page->doEditContent(
1092 new WikitextContent( 'UTContent' ),
1094 EDIT_NEW | EDIT_SUPPRESS_RC
,
1098 // an edit always attempt to purge backlink links such as history
1099 // pages. That is unneccessary.
1100 JobQueueGroup
::singleton()->get( 'htmlCacheUpdate' )->delete();
1101 // WikiPages::doEditUpdates randomly adds RC purges
1102 JobQueueGroup
::singleton()->get( 'recentChangesUpdate' )->delete();
1104 // doEditContent() probably started the session via
1105 // User::loadFromSession(). Close it now.
1106 if ( session_id() !== '' ) {
1107 session_write_close();
1114 * Restores MediaWiki to using the table set (table prefix) it was using before
1115 * setupTestDB() was called. Useful if we need to perform database operations
1116 * after the test run has finished (such as saving logs or profiling info).
1120 public static function teardownTestDB() {
1121 global $wgJobClasses;
1123 if ( !self
::$dbSetup ) {
1127 Hooks
::run( 'UnitTestsBeforeDatabaseTeardown' );
1129 foreach ( $wgJobClasses as $type => $class ) {
1130 // Delete any jobs under the clone DB (or old prefix in other stores)
1131 JobQueueGroup
::singleton()->get( $type )->delete();
1134 CloneDatabase
::changePrefix( self
::$oldTablePrefix );
1136 self
::$oldTablePrefix = false;
1137 self
::$dbSetup = false;
1141 * Setups a database with the given prefix.
1143 * If reuseDB is true and certain conditions apply, it will just change the prefix.
1144 * Otherwise, it will clone the tables and change the prefix.
1146 * Clones all tables in the given database (whatever database that connection has
1147 * open), to versions with the test prefix.
1149 * @param IMaintainableDatabase $db Database to use
1150 * @param string $prefix Prefix to use for test tables
1151 * @return bool True if tables were cloned, false if only the prefix was changed
1153 protected static function setupDatabaseWithTestPrefix( IMaintainableDatabase
$db, $prefix ) {
1154 $tablesCloned = self
::listTables( $db );
1155 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix );
1156 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1158 $db->_originalTablePrefix
= $db->tablePrefix();
1160 if ( ( $db->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
1161 CloneDatabase
::changePrefix( $prefix );
1165 $dbClone->cloneTableStructure();
1171 * Set up all test DBs
1173 public function setupAllTestDBs() {
1176 self
::$oldTablePrefix = $wgDBprefix;
1178 $testPrefix = $this->dbPrefix();
1180 // switch to a temporary clone of the database
1181 self
::setupTestDB( $this->db
, $testPrefix );
1183 if ( self
::isUsingExternalStoreDB() ) {
1184 self
::setupExternalStoreTestDBs( $testPrefix );
1189 * Creates an empty skeleton of the wiki database by cloning its structure
1190 * to equivalent tables using the given $prefix. Then sets MediaWiki to
1191 * use the new set of tables (aka schema) instead of the original set.
1193 * This is used to generate a dummy table set, typically consisting of temporary
1194 * tables, that will be used by tests instead of the original wiki database tables.
1198 * @note the original table prefix is stored in self::$oldTablePrefix. This is used
1199 * by teardownTestDB() to return the wiki to using the original table set.
1201 * @note this method only works when first called. Subsequent calls have no effect,
1202 * even if using different parameters.
1204 * @param Database $db The database connection
1205 * @param string $prefix The prefix to use for the new table set (aka schema).
1207 * @throws MWException If the database table prefix is already $prefix
1209 public static function setupTestDB( Database
$db, $prefix ) {
1210 if ( self
::$dbSetup ) {
1214 if ( $db->tablePrefix() === $prefix ) {
1215 throw new MWException(
1216 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
1219 // TODO: the below should be re-written as soon as LBFactory, LoadBalancer,
1220 // and Database no longer use global state.
1222 self
::$dbSetup = true;
1224 if ( !self
::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
1228 // Assuming this isn't needed for External Store database, and not sure if the procedure
1229 // would be available there.
1230 if ( $db->getType() == 'oracle' ) {
1231 $db->query( 'BEGIN FILL_WIKI_INFO; END;' );
1234 Hooks
::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
1238 * Clones the External Store database(s) for testing
1240 * @param string $testPrefix Prefix for test tables
1242 protected static function setupExternalStoreTestDBs( $testPrefix ) {
1243 $connections = self
::getExternalStoreDatabaseConnections();
1244 foreach ( $connections as $dbw ) {
1245 // Hack: cloneTableStructure sets $wgDBprefix to the unit test
1246 // prefix,. Even though listTables now uses tablePrefix, that
1247 // itself is populated from $wgDBprefix by default.
1249 // We have to set it back, or we won't find the original 'blobs'
1252 $dbw->tablePrefix( self
::$oldTablePrefix );
1253 self
::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
1258 * Gets master database connections for all of the ExternalStoreDB
1259 * stores configured in $wgDefaultExternalStore.
1261 * @return Database[] Array of Database master connections
1263 protected static function getExternalStoreDatabaseConnections() {
1264 global $wgDefaultExternalStore;
1266 /** @var ExternalStoreDB $externalStoreDB */
1267 $externalStoreDB = ExternalStore
::getStoreObject( 'DB' );
1268 $defaultArray = (array)$wgDefaultExternalStore;
1270 foreach ( $defaultArray as $url ) {
1271 if ( strpos( $url, 'DB://' ) === 0 ) {
1272 list( $proto, $cluster ) = explode( '://', $url, 2 );
1273 // Avoid getMaster() because setupDatabaseWithTestPrefix()
1274 // requires Database instead of plain DBConnRef/IDatabase
1275 $dbws[] = $externalStoreDB->getMaster( $cluster );
1283 * Check whether ExternalStoreDB is being used
1285 * @return bool True if it's being used
1287 protected static function isUsingExternalStoreDB() {
1288 global $wgDefaultExternalStore;
1289 if ( !$wgDefaultExternalStore ) {
1293 $defaultArray = (array)$wgDefaultExternalStore;
1294 foreach ( $defaultArray as $url ) {
1295 if ( strpos( $url, 'DB://' ) === 0 ) {
1304 * @throws LogicException if the given database connection is not a set up to use
1307 private function ensureMockDatabaseConnection( IDatabase
$db ) {
1308 if ( $db->tablePrefix() !== $this->dbPrefix() ) {
1309 throw new LogicException(
1310 'Trying to delete mock tables, but table prefix does not indicate a mock database.'
1316 * Stub. If a test suite needs to test against a specific database schema, it should
1317 * override this method and return the appropriate information from it.
1319 * @return [ $tables, $scripts ] A tuple of two lists, with $tables being a list of tables
1320 * that will be re-created by the scripts, and $scripts being a list of SQL script
1321 * files for creating the tables listed.
1323 protected function getSchemaOverrides() {
1328 * Applies any schema changes requested by calling setDbSchema().
1329 * Called once per test class, just before addDataOnce().
1331 private function setUpSchema( IMaintainableDatabase
$db ) {
1332 list( $tablesToAlter, $scriptsToRun ) = $this->getSchemaOverrides();
1334 if ( $tablesToAlter && !$scriptsToRun ) {
1335 throw new InvalidArgumentException(
1336 'No scripts supplied for applying the database schema.'
1340 if ( !$tablesToAlter && $scriptsToRun ) {
1341 throw new InvalidArgumentException(
1342 'No tables declared to be altered by schema scripts.'
1346 $this->ensureMockDatabaseConnection( $db );
1348 $previouslyAlteredTables = isset( $db->_alteredMockTables
) ?
$db->_alteredMockTables
: [];
1350 if ( !$tablesToAlter && !$previouslyAlteredTables ) {
1351 return; // nothing to do
1354 $tablesToDrop = array_merge( $previouslyAlteredTables, $tablesToAlter );
1355 $tablesToRestore = array_diff( $previouslyAlteredTables, $tablesToAlter );
1357 if ( $tablesToDrop ) {
1358 $this->dropMockTables( $db, $tablesToDrop );
1361 if ( $tablesToRestore ) {
1362 $this->recloneMockTables( $db, $tablesToRestore );
1365 foreach ( $scriptsToRun as $script ) {
1372 return $this->mungeSchemaUpdateQuery( $cmd );
1377 $db->_alteredMockTables
= $tablesToAlter;
1380 private function mungeSchemaUpdateQuery( $cmd ) {
1381 return self
::$useTemporaryTables
1382 ?
preg_replace( '/\bCREATE\s+TABLE\b/i', 'CREATE TEMPORARY TABLE', $cmd )
1387 * Drops the given mock tables.
1389 * @param IMaintainableDatabase $db
1390 * @param array $tables
1392 private function dropMockTables( IMaintainableDatabase
$db, array $tables ) {
1393 $this->ensureMockDatabaseConnection( $db );
1395 foreach ( $tables as $tbl ) {
1396 $tbl = $db->tableName( $tbl );
1397 $db->query( "DROP TABLE IF EXISTS $tbl", __METHOD__
);
1399 if ( $tbl === 'page' ) {
1400 // Forget about the pages since they don't
1402 LinkCache
::singleton()->clear();
1408 * Re-clones the given mock tables to restore them based on the live database schema.
1410 * @param IMaintainableDatabase $db
1411 * @param array $tables
1413 private function recloneMockTables( IMaintainableDatabase
$db, array $tables ) {
1414 $this->ensureMockDatabaseConnection( $db );
1416 if ( !isset( $db->_originalTablePrefix
) ) {
1417 throw new LogicException( 'No original table prefix know, cannot restore tables!' );
1420 $originalTables = $db->listTables( $db->_originalTablePrefix
, __METHOD__
);
1421 $tables = array_intersect( $tables, $originalTables );
1423 $dbClone = new CloneDatabase( $db, $tables, $db->tablePrefix(), $db->_originalTablePrefix
);
1424 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1426 $dbClone->cloneTableStructure();
1430 * Empty all tables so they can be repopulated for tests
1432 * @param Database $db|null Database to reset
1433 * @param array $tablesUsed Tables to reset
1435 private function resetDB( $db, $tablesUsed ) {
1437 $userTables = [ 'user', 'user_groups', 'user_properties' ];
1438 $pageTables = [ 'page', 'revision', 'ip_changes', 'revision_comment_temp', 'comment' ];
1439 $coreDBDataTables = array_merge( $userTables, $pageTables );
1441 // If any of the user or page tables were marked as used, we should clear all of them.
1442 if ( array_intersect( $tablesUsed, $userTables ) ) {
1443 $tablesUsed = array_unique( array_merge( $tablesUsed, $userTables ) );
1444 TestUserRegistry
::clear();
1446 if ( array_intersect( $tablesUsed, $pageTables ) ) {
1447 $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
1450 $truncate = in_array( $db->getType(), [ 'oracle', 'mysql' ] );
1451 foreach ( $tablesUsed as $tbl ) {
1452 // TODO: reset interwiki table to its original content.
1453 if ( $tbl == 'interwiki' ) {
1458 $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tbl ), __METHOD__
);
1460 $db->delete( $tbl, '*', __METHOD__
);
1463 if ( $tbl === 'page' ) {
1464 // Forget about the pages since they don't
1466 LinkCache
::singleton()->clear();
1470 if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
1471 // Re-add core DB data that was deleted
1472 $this->addCoreDBData();
1480 * @param string $func
1481 * @param array $args
1484 * @throws MWException
1486 public function __call( $func, $args ) {
1487 static $compatibility = [
1488 'createMock' => 'createMock2',
1491 if ( isset( $compatibility[$func] ) ) {
1492 return call_user_func_array( [ $this, $compatibility[$func] ], $args );
1494 throw new MWException( "Called non-existent $func method on " . static::class );
1499 * Return a test double for the specified class.
1501 * @param string $originalClassName
1502 * @return PHPUnit_Framework_MockObject_MockObject
1505 private function createMock2( $originalClassName ) {
1506 return $this->getMockBuilder( $originalClassName )
1507 ->disableOriginalConstructor()
1508 ->disableOriginalClone()
1509 ->disableArgumentCloning()
1510 // New in phpunit-mock-objects 3.2 (phpunit 5.4.0)
1511 // ->disallowMockingUnknownTypes()
1515 private static function unprefixTable( &$tableName, $ind, $prefix ) {
1516 $tableName = substr( $tableName, strlen( $prefix ) );
1519 private static function isNotUnittest( $table ) {
1520 return strpos( $table, self
::DB_PREFIX
) !== 0;
1526 * @param IMaintainableDatabase $db
1530 public static function listTables( IMaintainableDatabase
$db ) {
1531 $prefix = $db->tablePrefix();
1532 $tables = $db->listTables( $prefix, __METHOD__
);
1534 if ( $db->getType() === 'mysql' ) {
1535 static $viewListCache = null;
1536 if ( $viewListCache === null ) {
1537 $viewListCache = $db->listViews( null, __METHOD__
);
1539 // T45571: cannot clone VIEWs under MySQL
1540 $tables = array_diff( $tables, $viewListCache );
1542 array_walk( $tables, [ __CLASS__
, 'unprefixTable' ], $prefix );
1544 // Don't duplicate test tables from the previous fataled run
1545 $tables = array_filter( $tables, [ __CLASS__
, 'isNotUnittest' ] );
1547 if ( $db->getType() == 'sqlite' ) {
1548 $tables = array_flip( $tables );
1549 // these are subtables of searchindex and don't need to be duped/dropped separately
1550 unset( $tables['searchindex_content'] );
1551 unset( $tables['searchindex_segdir'] );
1552 unset( $tables['searchindex_segments'] );
1553 $tables = array_flip( $tables );
1560 * @throws MWException
1563 protected function checkDbIsSupported() {
1564 if ( !in_array( $this->db
->getType(), $this->supportedDBs
) ) {
1565 throw new MWException( $this->db
->getType() . " is not currently supported for unit testing." );
1571 * @param string $offset
1574 public function getCliArg( $offset ) {
1575 if ( isset( PHPUnitMaintClass
::$additionalOptions[$offset] ) ) {
1576 return PHPUnitMaintClass
::$additionalOptions[$offset];
1584 * @param string $offset
1585 * @param mixed $value
1587 public function setCliArg( $offset, $value ) {
1588 PHPUnitMaintClass
::$additionalOptions[$offset] = $value;
1592 * Don't throw a warning if $function is deprecated and called later
1596 * @param string $function
1598 public function hideDeprecated( $function ) {
1599 MediaWiki\
suppressWarnings();
1600 wfDeprecated( $function );
1601 MediaWiki\restoreWarnings
();
1605 * Asserts that the given database query yields the rows given by $expectedRows.
1606 * The expected rows should be given as indexed (not associative) arrays, with
1607 * the values given in the order of the columns in the $fields parameter.
1608 * Note that the rows are sorted by the columns given in $fields.
1612 * @param string|array $table The table(s) to query
1613 * @param string|array $fields The columns to include in the result (and to sort by)
1614 * @param string|array $condition "where" condition(s)
1615 * @param array $expectedRows An array of arrays giving the expected rows.
1616 * @param array $options Options for the query
1617 * @param array $join_conds Join conditions for the query
1619 * @throws MWException If this test cases's needsDB() method doesn't return true.
1620 * Test cases can use "@group Database" to enable database test support,
1621 * or list the tables under testing in $this->tablesUsed, or override the
1624 protected function assertSelect(
1625 $table, $fields, $condition, array $expectedRows, array $options = [], array $join_conds = []
1627 if ( !$this->needsDB() ) {
1628 throw new MWException( 'When testing database state, the test cases\'s needDB()' .
1629 ' method should return true. Use @group Database or $this->tablesUsed.' );
1632 $db = wfGetDB( DB_REPLICA
);
1639 $options +
[ 'ORDER BY' => $fields ],
1642 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
1646 foreach ( $expectedRows as $expected ) {
1647 $r = $res->fetchRow();
1648 self
::stripStringKeys( $r );
1651 $this->assertNotEmpty( $r, "row #$i missing" );
1653 $this->assertEquals( $expected, $r, "row #$i mismatches" );
1656 $r = $res->fetchRow();
1657 self
::stripStringKeys( $r );
1659 $this->assertFalse( $r, "found extra row (after #$i)" );
1663 * Utility method taking an array of elements and wrapping
1664 * each element in its own array. Useful for data providers
1665 * that only return a single argument.
1669 * @param array $elements
1673 protected function arrayWrap( array $elements ) {
1675 function ( $element ) {
1676 return [ $element ];
1683 * Assert that two arrays are equal. By default this means that both arrays need to hold
1684 * the same set of values. Using additional arguments, order and associated key can also
1685 * be set as relevant.
1689 * @param array $expected
1690 * @param array $actual
1691 * @param bool $ordered If the order of the values should match
1692 * @param bool $named If the keys should match
1694 protected function assertArrayEquals( array $expected, array $actual,
1695 $ordered = false, $named = false
1698 $this->objectAssociativeSort( $expected );
1699 $this->objectAssociativeSort( $actual );
1703 $expected = array_values( $expected );
1704 $actual = array_values( $actual );
1707 call_user_func_array(
1708 [ $this, 'assertEquals' ],
1709 array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
1714 * Put each HTML element on its own line and then equals() the results
1716 * Use for nicely formatting of PHPUnit diff output when comparing very
1721 * @param string $expected HTML on oneline
1722 * @param string $actual HTML on oneline
1723 * @param string $msg Optional message
1725 protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
1726 $expected = str_replace( '>', ">\n", $expected );
1727 $actual = str_replace( '>', ">\n", $actual );
1729 $this->assertEquals( $expected, $actual, $msg );
1733 * Does an associative sort that works for objects.
1737 * @param array &$array
1739 protected function objectAssociativeSort( array &$array ) {
1742 function ( $a, $b ) {
1743 return serialize( $a ) > serialize( $b ) ?
1 : -1;
1749 * Utility function for eliminating all string keys from an array.
1750 * Useful to turn a database result row as returned by fetchRow() into
1751 * a pure indexed array.
1755 * @param mixed &$r The array to remove string keys from.
1757 protected static function stripStringKeys( &$r ) {
1758 if ( !is_array( $r ) ) {
1762 foreach ( $r as $k => $v ) {
1763 if ( is_string( $k ) ) {
1770 * Asserts that the provided variable is of the specified
1771 * internal type or equals the $value argument. This is useful
1772 * for testing return types of functions that return a certain
1773 * type or *value* when not set or on error.
1777 * @param string $type
1778 * @param mixed $actual
1779 * @param mixed $value
1780 * @param string $message
1782 protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
1783 if ( $actual === $value ) {
1784 $this->assertTrue( true, $message );
1786 $this->assertType( $type, $actual, $message );
1791 * Asserts the type of the provided value. This can be either
1792 * in internal type such as boolean or integer, or a class or
1793 * interface the value extends or implements.
1797 * @param string $type
1798 * @param mixed $actual
1799 * @param string $message
1801 protected function assertType( $type, $actual, $message = '' ) {
1802 if ( class_exists( $type ) ||
interface_exists( $type ) ) {
1803 $this->assertInstanceOf( $type, $actual, $message );
1805 $this->assertInternalType( $type, $actual, $message );
1810 * Returns true if the given namespace defaults to Wikitext
1811 * according to $wgNamespaceContentModels
1813 * @param int $ns The namespace ID to check
1818 protected function isWikitextNS( $ns ) {
1819 global $wgNamespaceContentModels;
1821 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
1822 return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
;
1829 * Returns the ID of a namespace that defaults to Wikitext.
1831 * @throws MWException If there is none.
1832 * @return int The ID of the wikitext Namespace
1835 protected function getDefaultWikitextNS() {
1836 global $wgNamespaceContentModels;
1838 static $wikitextNS = null; // this is not going to change
1839 if ( $wikitextNS !== null ) {
1843 // quickly short out on most common case:
1844 if ( !isset( $wgNamespaceContentModels[NS_MAIN
] ) ) {
1848 // NOTE: prefer content namespaces
1849 $namespaces = array_unique( array_merge(
1850 MWNamespace
::getContentNamespaces(),
1851 [ NS_MAIN
, NS_HELP
, NS_PROJECT
], // prefer these
1852 MWNamespace
::getValidNamespaces()
1855 $namespaces = array_diff( $namespaces, [
1856 NS_FILE
, NS_CATEGORY
, NS_MEDIAWIKI
, NS_USER
// don't mess with magic namespaces
1859 $talk = array_filter( $namespaces, function ( $ns ) {
1860 return MWNamespace
::isTalk( $ns );
1863 // prefer non-talk pages
1864 $namespaces = array_diff( $namespaces, $talk );
1865 $namespaces = array_merge( $namespaces, $talk );
1867 // check default content model of each namespace
1868 foreach ( $namespaces as $ns ) {
1869 if ( !isset( $wgNamespaceContentModels[$ns] ) ||
1870 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
1879 // @todo Inside a test, we could skip the test as incomplete.
1880 // But frequently, this is used in fixture setup.
1881 throw new MWException( "No namespace defaults to wikitext!" );
1885 * Check, if $wgDiff3 is set and ready to merge
1886 * Will mark the calling test as skipped, if not ready
1890 protected function markTestSkippedIfNoDiff3() {
1893 # This check may also protect against code injection in
1894 # case of broken installations.
1895 MediaWiki\
suppressWarnings();
1896 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
1897 MediaWiki\restoreWarnings
();
1899 if ( !$haveDiff3 ) {
1900 $this->markTestSkipped( "Skip test, since diff3 is not configured" );
1905 * Check if $extName is a loaded PHP extension, will skip the
1906 * test whenever it is not loaded.
1909 * @param string $extName
1912 protected function checkPHPExtension( $extName ) {
1913 $loaded = extension_loaded( $extName );
1915 $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
1922 * Asserts that the given string is a valid HTML snippet.
1923 * Wraps the given string in the required top level tags and
1924 * then calls assertValidHtmlDocument().
1925 * The snippet is expected to be HTML 5.
1929 * @note Will mark the test as skipped if the "tidy" module is not installed.
1930 * @note This ignores $wgUseTidy, so we can check for valid HTML even (and especially)
1931 * when automatic tidying is disabled.
1933 * @param string $html An HTML snippet (treated as the contents of the body tag).
1935 protected function assertValidHtmlSnippet( $html ) {
1936 $html = '<!DOCTYPE html><html><head><title>test</title></head><body>' . $html . '</body></html>';
1937 $this->assertValidHtmlDocument( $html );
1941 * Asserts that the given string is valid HTML document.
1945 * @note Will mark the test as skipped if the "tidy" module is not installed.
1946 * @note This ignores $wgUseTidy, so we can check for valid HTML even (and especially)
1947 * when automatic tidying is disabled.
1949 * @param string $html A complete HTML document
1951 protected function assertValidHtmlDocument( $html ) {
1952 // Note: we only validate if the tidy PHP extension is available.
1953 // In case wgTidyInternal is false, MWTidy would fall back to the command line version
1954 // of tidy. In that case however, we can not reliably detect whether a failing validation
1955 // is due to malformed HTML, or caused by tidy not being installed as a command line tool.
1956 // That would cause all HTML assertions to fail on a system that has no tidy installed.
1957 if ( !$GLOBALS['wgTidyInternal'] ||
!MWTidy
::isEnabled() ) {
1958 $this->markTestSkipped( 'Tidy extension not installed' );
1962 MWTidy
::checkErrors( $html, $errorBuffer );
1963 $allErrors = preg_split( '/[\r\n]+/', $errorBuffer );
1965 // Filter Tidy warnings which aren't useful for us.
1966 // Tidy eg. often cries about parameters missing which have actually
1967 // been deprecated since HTML4, thus we should not care about them.
1968 $errors = preg_grep(
1969 '/^(.*Warning: (trimming empty|.* lacks ".*?" attribute).*|\s*)$/m',
1970 $allErrors, PREG_GREP_INVERT
1973 $this->assertEmpty( $errors, implode( "\n", $errors ) );
1977 * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
1978 * @param string $buffer
1981 public static function wfResetOutputBuffersBarrier( $buffer ) {
1986 * Create a temporary hook handler which will be reset by tearDown.
1987 * This replaces other handlers for the same hook.
1988 * @param string $hookName Hook name
1989 * @param mixed $handler Value suitable for a hook handler
1992 protected function setTemporaryHook( $hookName, $handler ) {
1993 $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
1997 * Check whether file contains given data.
1998 * @param string $fileName
1999 * @param string $actualData
2000 * @param bool $createIfMissing If true, and file does not exist, create it with given data
2001 * and skip the test.
2002 * @param string $msg
2005 protected function assertFileContains(
2008 $createIfMissing = true,
2011 if ( $createIfMissing ) {
2012 if ( !file_exists( $fileName ) ) {
2013 file_put_contents( $fileName, $actualData );
2014 $this->markTestSkipped( 'Data file $fileName does not exist' );
2017 self
::assertFileExists( $fileName );
2019 self
::assertEquals( file_get_contents( $fileName ), $actualData, $msg );