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\IMaintainableDatabase
;
9 use Wikimedia\Rdbms\Database
;
10 use Wikimedia\TestingAccessWrapper
;
15 abstract class MediaWikiTestCase
extends PHPUnit_Framework_TestCase
{
18 * The service locator created by prepareServices(). This service locator will
19 * be restored after each test. Tests that pollute the global service locator
20 * instance should use overrideMwServices() to isolate the test.
22 * @var MediaWikiServices|null
24 private static $serviceLocator = null;
27 * $called tracks whether the setUp and tearDown method has been called.
28 * class extending MediaWikiTestCase usually override setUp and tearDown
29 * but forget to call the parent.
31 * The array format takes a method name as key and anything as a value.
32 * By asserting the key exist, we know the child class has called the
35 * This property must be private, we do not want child to override it,
36 * they should call the appropriate parent method instead.
58 protected $tablesUsed = []; // tables with data
60 private static $useTemporaryTables = true;
61 private static $reuseDB = false;
62 private static $dbSetup = false;
63 private static $oldTablePrefix = '';
66 * Original value of PHP's error_reporting setting.
70 private $phpErrorLevel;
73 * Holds the paths of temporary files/directories created through getNewTempFile,
74 * and getNewTempDirectory
78 private $tmpFiles = [];
81 * Holds original values of MediaWiki configuration settings
82 * to be restored in tearDown().
83 * See also setMwGlobals().
86 private $mwGlobals = [];
89 * Holds list of MediaWiki configuration settings to be unset in tearDown().
90 * See also setMwGlobals().
93 private $mwGlobalsToUnset = [];
96 * Holds original loggers which have been replaced by setLogger()
97 * @var LoggerInterface[]
99 private $loggers = [];
102 * Table name prefixes. Oracle likes it shorter.
104 const DB_PREFIX
= 'unittest_';
105 const ORA_DB_PREFIX
= 'ut_';
111 protected $supportedDBs = [
118 public function __construct( $name = null, array $data = [], $dataName = '' ) {
119 parent
::__construct( $name, $data, $dataName );
121 $this->backupGlobals
= false;
122 $this->backupStaticAttributes
= false;
125 public function __destruct() {
126 // Complain if self::setUp() was called, but not self::tearDown()
127 // $this->called['setUp'] will be checked by self::testMediaWikiTestCaseParentSetupCalled()
128 if ( isset( $this->called
['setUp'] ) && !isset( $this->called
['tearDown'] ) ) {
129 throw new MWException( static::class . "::tearDown() must call parent::tearDown()" );
133 public static function setUpBeforeClass() {
134 parent
::setUpBeforeClass();
136 // Get the service locator, and reset services if it's not done already
137 self
::$serviceLocator = self
::prepareServices( new GlobalVarConfig() );
141 * Convenience method for getting an immutable test user
145 * @param string[] $groups Groups the test user should be in.
148 public static function getTestUser( $groups = [] ) {
149 return TestUserRegistry
::getImmutableTestUser( $groups );
153 * Convenience method for getting a mutable test user
157 * @param string[] $groups Groups the test user should be added in.
160 public static function getMutableTestUser( $groups = [] ) {
161 return TestUserRegistry
::getMutableTestUser( __CLASS__
, $groups );
165 * Convenience method for getting an immutable admin test user
169 * @param string[] $groups Groups the test user should be added to.
172 public static function getTestSysop() {
173 return self
::getTestUser( [ 'sysop', 'bureaucrat' ] );
177 * Prepare service configuration for unit testing.
179 * This calls MediaWikiServices::resetGlobalInstance() to allow some critical services
180 * to be overridden for testing.
182 * prepareServices() only needs to be called once, but should be called as early as possible,
183 * before any class has a chance to grab a reference to any of the global services
184 * instances that get discarded by prepareServices(). Only the first call has any effect,
185 * later calls are ignored.
187 * @note This is called by PHPUnitMaintClass::finalSetup.
189 * @see MediaWikiServices::resetGlobalInstance()
191 * @param Config $bootstrapConfig The bootstrap config to use with the new
192 * MediaWikiServices. Only used for the first call to this method.
193 * @return MediaWikiServices
195 public static function prepareServices( Config
$bootstrapConfig ) {
196 static $services = null;
199 $services = self
::resetGlobalServices( $bootstrapConfig );
205 * Reset global services, and install testing environment.
206 * This is the testing equivalent of MediaWikiServices::resetGlobalInstance().
207 * This should only be used to set up the testing environment, not when
208 * running unit tests. Use MediaWikiTestCase::overrideMwServices() for that.
210 * @see MediaWikiServices::resetGlobalInstance()
211 * @see prepareServices()
212 * @see MediaWikiTestCase::overrideMwServices()
214 * @param Config|null $bootstrapConfig The bootstrap config to use with the new
216 * @return MediaWikiServices
218 protected static function resetGlobalServices( Config
$bootstrapConfig = null ) {
219 $oldServices = MediaWikiServices
::getInstance();
220 $oldConfigFactory = $oldServices->getConfigFactory();
221 $oldLoadBalancerFactory = $oldServices->getDBLoadBalancerFactory();
223 $testConfig = self
::makeTestConfig( $bootstrapConfig );
225 MediaWikiServices
::resetGlobalInstance( $testConfig );
227 $serviceLocator = MediaWikiServices
::getInstance();
228 self
::installTestServices(
230 $oldLoadBalancerFactory,
233 return $serviceLocator;
237 * Create a config suitable for testing, based on a base config, default overrides,
238 * and custom overrides.
240 * @param Config|null $baseConfig
241 * @param Config|null $customOverrides
245 private static function makeTestConfig(
246 Config
$baseConfig = null,
247 Config
$customOverrides = null
249 $defaultOverrides = new HashConfig();
251 if ( !$baseConfig ) {
252 $baseConfig = MediaWikiServices
::getInstance()->getBootstrapConfig();
255 /* Some functions require some kind of caching, and will end up using the db,
256 * which we can't allow, as that would open a new connection for mysql.
257 * Replace with a HashBag. They would not be going to persist anyway.
259 $hashCache = [ 'class' => 'HashBagOStuff', 'reportDupes' => false ];
261 CACHE_DB
=> $hashCache,
262 CACHE_ACCEL
=> $hashCache,
263 CACHE_MEMCACHED
=> $hashCache,
265 'apcu' => $hashCache,
266 'xcache' => $hashCache,
267 'wincache' => $hashCache,
268 ] +
$baseConfig->get( 'ObjectCaches' );
270 $defaultOverrides->set( 'ObjectCaches', $objectCaches );
271 $defaultOverrides->set( 'MainCacheType', CACHE_NONE
);
272 $defaultOverrides->set( 'JobTypeConf', [ 'default' => [ 'class' => 'JobQueueMemory' ] ] );
274 // Use a fast hash algorithm to hash passwords.
275 $defaultOverrides->set( 'PasswordDefault', 'A' );
277 $testConfig = $customOverrides
278 ?
new MultiConfig( [ $customOverrides, $defaultOverrides, $baseConfig ] )
279 : new MultiConfig( [ $defaultOverrides, $baseConfig ] );
285 * @param ConfigFactory $oldConfigFactory
286 * @param LBFactory $oldLoadBalancerFactory
287 * @param MediaWikiServices $newServices
289 * @throws MWException
291 private static function installTestServices(
292 ConfigFactory
$oldConfigFactory,
293 LBFactory
$oldLoadBalancerFactory,
294 MediaWikiServices
$newServices
296 // Use bootstrap config for all configuration.
297 // This allows config overrides via global variables to take effect.
298 $bootstrapConfig = $newServices->getBootstrapConfig();
299 $newServices->resetServiceForTesting( 'ConfigFactory' );
300 $newServices->redefineService(
302 self
::makeTestConfigFactoryInstantiator(
304 [ 'main' => $bootstrapConfig ]
307 $newServices->resetServiceForTesting( 'DBLoadBalancerFactory' );
308 $newServices->redefineService(
309 'DBLoadBalancerFactory',
310 function ( MediaWikiServices
$services ) use ( $oldLoadBalancerFactory ) {
311 return $oldLoadBalancerFactory;
317 * @param ConfigFactory $oldFactory
318 * @param Config[] $configurations
322 private static function makeTestConfigFactoryInstantiator(
323 ConfigFactory
$oldFactory,
324 array $configurations
326 return function ( MediaWikiServices
$services ) use ( $oldFactory, $configurations ) {
327 $factory = new ConfigFactory();
329 // clone configurations from $oldFactory that are not overwritten by $configurations
330 $namesToClone = array_diff(
331 $oldFactory->getConfigNames(),
332 array_keys( $configurations )
335 foreach ( $namesToClone as $name ) {
336 $factory->register( $name, $oldFactory->makeConfig( $name ) );
339 foreach ( $configurations as $name => $config ) {
340 $factory->register( $name, $config );
348 * Resets some well known services that typically have state that may interfere with unit tests.
349 * This is a lightweight alternative to resetGlobalServices().
351 * @note There is no guarantee that no references remain to stale service instances destroyed
352 * by a call to doLightweightServiceReset().
354 * @throws MWException if called outside of PHPUnit tests.
356 * @see resetGlobalServices()
358 private function doLightweightServiceReset() {
361 JobQueueGroup
::destroySingletons();
362 ObjectCache
::clear();
363 $services = MediaWikiServices
::getInstance();
364 $services->resetServiceForTesting( 'MainObjectStash' );
365 $services->resetServiceForTesting( 'LocalServerObjectCache' );
366 $services->getMainWANObjectCache()->clearProcessCache();
367 FileBackendGroup
::destroySingleton();
369 // TODO: move global state into MediaWikiServices
370 RequestContext
::resetMain();
371 if ( session_id() !== '' ) {
372 session_write_close();
376 $wgRequest = new FauxRequest();
377 MediaWiki\Session\SessionManager
::resetCache();
380 public function run( PHPUnit_Framework_TestResult
$result = null ) {
381 // Reset all caches between tests.
382 $this->doLightweightServiceReset();
384 $needsResetDB = false;
386 if ( !self
::$dbSetup ||
$this->needsDB() ) {
387 // set up a DB connection for this test to use
389 self
::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
390 self
::$reuseDB = $this->getCliArg( 'reuse-db' );
392 $this->db
= wfGetDB( DB_MASTER
);
394 $this->checkDbIsSupported();
396 if ( !self
::$dbSetup ) {
397 $this->setupAllTestDBs();
398 $this->addCoreDBData();
400 if ( ( $this->db
->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
401 $this->resetDB( $this->db
, $this->tablesUsed
);
405 // TODO: the DB setup should be done in setUpBeforeClass(), so the test DB
406 // is available in subclass's setUpBeforeClass() and setUp() methods.
407 // This would also remove the need for the HACK that is oncePerClass().
408 if ( $this->oncePerClass() ) {
409 $this->addDBDataOnce();
413 $needsResetDB = true;
416 parent
::run( $result );
418 if ( $needsResetDB ) {
419 $this->resetDB( $this->db
, $this->tablesUsed
);
426 private function oncePerClass() {
427 // Remember current test class in the database connection,
428 // so we know when we need to run addData.
430 $class = static::class;
432 $first = !isset( $this->db
->_hasDataForTestClass
)
433 ||
$this->db
->_hasDataForTestClass
!== $class;
435 $this->db
->_hasDataForTestClass
= $class;
444 public function usesTemporaryTables() {
445 return self
::$useTemporaryTables;
449 * Obtains a new temporary file name
451 * The obtained filename is enlisted to be removed upon tearDown
455 * @return string Absolute name of the temporary file
457 protected function getNewTempFile() {
458 $fileName = tempnam( wfTempDir(), 'MW_PHPUnit_' . static::class . '_' );
459 $this->tmpFiles
[] = $fileName;
465 * obtains a new temporary directory
467 * The obtained directory is enlisted to be removed (recursively with all its contained
468 * files) upon tearDown.
472 * @return string Absolute name of the temporary directory
474 protected function getNewTempDirectory() {
475 // Starting of with a temporary /file/.
476 $fileName = $this->getNewTempFile();
478 // Converting the temporary /file/ to a /directory/
479 // The following is not atomic, but at least we now have a single place,
480 // where temporary directory creation is bundled and can be improved
482 $this->assertTrue( wfMkdirParents( $fileName ) );
487 protected function setUp() {
489 $this->called
['setUp'] = true;
491 $this->phpErrorLevel
= intval( ini_get( 'error_reporting' ) );
493 // Cleaning up temporary files
494 foreach ( $this->tmpFiles
as $fileName ) {
495 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
497 } elseif ( is_dir( $fileName ) ) {
498 wfRecursiveRemoveDir( $fileName );
502 if ( $this->needsDB() && $this->db
) {
503 // Clean up open transactions
504 while ( $this->db
->trxLevel() > 0 ) {
505 $this->db
->rollback( __METHOD__
, 'flush' );
507 // Check for unsafe queries
508 if ( $this->db
->getType() === 'mysql' ) {
509 $this->db
->query( "SET sql_mode = 'STRICT_ALL_TABLES'" );
513 DeferredUpdates
::clearPendingUpdates();
514 ObjectCache
::getMainWANInstance()->clearProcessCache();
516 // XXX: reset maintenance triggers
517 // Hook into period lag checks which often happen in long-running scripts
518 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
519 Maintenance
::setLBFactoryTriggers( $lbFactory );
521 ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
524 protected function addTmpFiles( $files ) {
525 $this->tmpFiles
= array_merge( $this->tmpFiles
, (array)$files );
528 protected function tearDown() {
529 global $wgRequest, $wgSQLMode;
531 $status = ob_get_status();
532 if ( isset( $status['name'] ) &&
533 $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier'
538 $this->called
['tearDown'] = true;
539 // Cleaning up temporary files
540 foreach ( $this->tmpFiles
as $fileName ) {
541 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
543 } elseif ( is_dir( $fileName ) ) {
544 wfRecursiveRemoveDir( $fileName );
548 if ( $this->needsDB() && $this->db
) {
549 // Clean up open transactions
550 while ( $this->db
->trxLevel() > 0 ) {
551 $this->db
->rollback( __METHOD__
, 'flush' );
553 if ( $this->db
->getType() === 'mysql' ) {
554 $this->db
->query( "SET sql_mode = " . $this->db
->addQuotes( $wgSQLMode ) );
558 // Restore mw globals
559 foreach ( $this->mwGlobals
as $key => $value ) {
560 $GLOBALS[$key] = $value;
562 foreach ( $this->mwGlobalsToUnset
as $value ) {
563 unset( $GLOBALS[$value] );
565 $this->mwGlobals
= [];
566 $this->mwGlobalsToUnset
= [];
567 $this->restoreLoggers();
569 if ( self
::$serviceLocator && MediaWikiServices
::getInstance() !== self
::$serviceLocator ) {
570 MediaWikiServices
::forceGlobalInstance( self
::$serviceLocator );
573 // TODO: move global state into MediaWikiServices
574 RequestContext
::resetMain();
575 if ( session_id() !== '' ) {
576 session_write_close();
579 $wgRequest = new FauxRequest();
580 MediaWiki\Session\SessionManager
::resetCache();
581 MediaWiki\Auth\AuthManager
::resetCache();
583 $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
585 if ( $phpErrorLevel !== $this->phpErrorLevel
) {
586 ini_set( 'error_reporting', $this->phpErrorLevel
);
588 $oldHex = strtoupper( dechex( $this->phpErrorLevel
) );
589 $newHex = strtoupper( dechex( $phpErrorLevel ) );
590 $message = "PHP error_reporting setting was left dirty: "
591 . "was 0x$oldHex before test, 0x$newHex after test!";
593 $this->fail( $message );
600 * Make sure MediaWikiTestCase extending classes have called their
601 * parent setUp method
603 * With strict coverage activated in PHP_CodeCoverage, this test would be
604 * marked as risky without the following annotation (T152923).
607 final public function testMediaWikiTestCaseParentSetupCalled() {
608 $this->assertArrayHasKey( 'setUp', $this->called
,
609 static::class . '::setUp() must call parent::setUp()'
614 * Sets a service, maintaining a stashed version of the previous service to be
615 * restored in tearDown
619 * @param string $name
620 * @param object $object
622 protected function setService( $name, $object ) {
623 // If we did not yet override the service locator, so so now.
624 if ( MediaWikiServices
::getInstance() === self
::$serviceLocator ) {
625 $this->overrideMwServices();
628 MediaWikiServices
::getInstance()->disableService( $name );
629 MediaWikiServices
::getInstance()->redefineService(
631 function () use ( $object ) {
638 * Sets a global, maintaining a stashed version of the previous global to be
639 * restored in tearDown
641 * The key is added to the array of globals that will be reset afterwards
646 * protected function setUp() {
647 * $this->setMwGlobals( 'wgRestrictStuff', true );
650 * function testFoo() {}
652 * function testBar() {}
653 * $this->assertTrue( self::getX()->doStuff() );
655 * $this->setMwGlobals( 'wgRestrictStuff', false );
656 * $this->assertTrue( self::getX()->doStuff() );
659 * function testQuux() {}
662 * @param array|string $pairs Key to the global variable, or an array
663 * of key/value pairs.
664 * @param mixed $value Value to set the global to (ignored
665 * if an array is given as first argument).
667 * @note To allow changes to global variables to take effect on global service instances,
668 * call overrideMwServices().
672 protected function setMwGlobals( $pairs, $value = null ) {
673 if ( is_string( $pairs ) ) {
674 $pairs = [ $pairs => $value ];
677 $this->stashMwGlobals( array_keys( $pairs ) );
679 foreach ( $pairs as $key => $value ) {
680 $GLOBALS[$key] = $value;
685 * Check if we can back up a value by performing a shallow copy.
686 * Values which fail this test are copied recursively.
688 * @param mixed $value
689 * @return bool True if a shallow copy will do; false if a deep copy
692 private static function canShallowCopy( $value ) {
693 if ( is_scalar( $value ) ||
$value === null ) {
696 if ( is_array( $value ) ) {
697 foreach ( $value as $subValue ) {
698 if ( !is_scalar( $subValue ) && $subValue !== null ) {
708 * Stashes the global, will be restored in tearDown()
710 * Individual test functions may override globals through the setMwGlobals() function
711 * or directly. When directly overriding globals their keys should first be passed to this
712 * method in setUp to avoid breaking global state for other tests
714 * That way all other tests are executed with the same settings (instead of using the
715 * unreliable local settings for most tests and fix it only for some tests).
717 * @param array|string $globalKeys Key to the global variable, or an array of keys.
719 * @note To allow changes to global variables to take effect on global service instances,
720 * call overrideMwServices().
724 protected function stashMwGlobals( $globalKeys ) {
725 if ( is_string( $globalKeys ) ) {
726 $globalKeys = [ $globalKeys ];
729 foreach ( $globalKeys as $globalKey ) {
730 // NOTE: make sure we only save the global once or a second call to
731 // setMwGlobals() on the same global would override the original
734 !array_key_exists( $globalKey, $this->mwGlobals
) &&
735 !array_key_exists( $globalKey, $this->mwGlobalsToUnset
)
737 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
738 $this->mwGlobalsToUnset
[$globalKey] = $globalKey;
741 // NOTE: we serialize then unserialize the value in case it is an object
742 // this stops any objects being passed by reference. We could use clone
743 // and if is_object but this does account for objects within objects!
744 if ( self
::canShallowCopy( $GLOBALS[$globalKey] ) ) {
745 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
747 // Many MediaWiki types are safe to clone. These are the
748 // ones that are most commonly stashed.
749 $GLOBALS[$globalKey] instanceof Language ||
750 $GLOBALS[$globalKey] instanceof User ||
751 $GLOBALS[$globalKey] instanceof FauxRequest
753 $this->mwGlobals
[$globalKey] = clone $GLOBALS[$globalKey];
754 } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
755 // Serializing Closure only gives a warning on HHVM while
756 // it throws an Exception on Zend.
757 // Workaround for https://github.com/facebook/hhvm/issues/6206
758 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
761 $this->mwGlobals
[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
762 } catch ( Exception
$e ) {
763 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
772 * @param int $maxDepth
776 private function containsClosure( $var, $maxDepth = 15 ) {
777 if ( $var instanceof Closure
) {
780 if ( !is_array( $var ) ||
$maxDepth === 0 ) {
784 foreach ( $var as $value ) {
785 if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
793 * Merges the given values into a MW global array variable.
794 * Useful for setting some entries in a configuration array, instead of
795 * setting the entire array.
797 * @param string $name The name of the global, as in wgFooBar
798 * @param array $values The array containing the entries to set in that global
800 * @throws MWException If the designated global is not an array.
802 * @note To allow changes to global variables to take effect on global service instances,
803 * call overrideMwServices().
807 protected function mergeMwGlobalArrayValue( $name, $values ) {
808 if ( !isset( $GLOBALS[$name] ) ) {
811 if ( !is_array( $GLOBALS[$name] ) ) {
812 throw new MWException( "MW global $name is not an array." );
815 // NOTE: do not use array_merge, it screws up for numeric keys.
816 $merged = $GLOBALS[$name];
817 foreach ( $values as $k => $v ) {
822 $this->setMwGlobals( $name, $merged );
826 * Stashes the global instance of MediaWikiServices, and installs a new one,
827 * allowing test cases to override settings and services.
828 * The previous instance of MediaWikiServices will be restored on tearDown.
832 * @param Config $configOverrides Configuration overrides for the new MediaWikiServices instance.
833 * @param callable[] $services An associative array of services to re-define. Keys are service
834 * names, values are callables.
836 * @return MediaWikiServices
837 * @throws MWException
839 protected function overrideMwServices( Config
$configOverrides = null, array $services = [] ) {
840 if ( !$configOverrides ) {
841 $configOverrides = new HashConfig();
844 $oldInstance = MediaWikiServices
::getInstance();
845 $oldConfigFactory = $oldInstance->getConfigFactory();
846 $oldLoadBalancerFactory = $oldInstance->getDBLoadBalancerFactory();
848 $testConfig = self
::makeTestConfig( null, $configOverrides );
849 $newInstance = new MediaWikiServices( $testConfig );
851 // Load the default wiring from the specified files.
852 // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
853 $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
854 $newInstance->loadWiringFiles( $wiringFiles );
856 // Provide a traditional hook point to allow extensions to configure services.
857 Hooks
::run( 'MediaWikiServices', [ $newInstance ] );
859 foreach ( $services as $name => $callback ) {
860 $newInstance->redefineService( $name, $callback );
863 self
::installTestServices(
865 $oldLoadBalancerFactory,
868 MediaWikiServices
::forceGlobalInstance( $newInstance );
875 * @param string|Language $lang
877 public function setUserLang( $lang ) {
878 RequestContext
::getMain()->setLanguage( $lang );
879 $this->setMwGlobals( 'wgLang', RequestContext
::getMain()->getLanguage() );
884 * @param string|Language $lang
886 public function setContentLang( $lang ) {
887 if ( $lang instanceof Language
) {
888 $langCode = $lang->getCode();
892 $langObj = Language
::factory( $langCode );
894 $this->setMwGlobals( [
895 'wgLanguageCode' => $langCode,
896 'wgContLang' => $langObj,
901 * Sets the logger for a specified channel, for the duration of the test.
903 * @param string $channel
904 * @param LoggerInterface $logger
906 protected function setLogger( $channel, LoggerInterface
$logger ) {
907 // TODO: Once loggers are managed by MediaWikiServices, use
908 // overrideMwServices() to set loggers.
910 $provider = LoggerFactory
::getProvider();
911 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
912 $singletons = $wrappedProvider->singletons
;
913 if ( $provider instanceof MonologSpi
) {
914 if ( !isset( $this->loggers
[$channel] ) ) {
915 $this->loggers
[$channel] = isset( $singletons['loggers'][$channel] )
916 ?
$singletons['loggers'][$channel] : null;
918 $singletons['loggers'][$channel] = $logger;
919 } elseif ( $provider instanceof LegacySpi
) {
920 if ( !isset( $this->loggers
[$channel] ) ) {
921 $this->loggers
[$channel] = isset( $singletons[$channel] ) ?
$singletons[$channel] : null;
923 $singletons[$channel] = $logger;
925 throw new LogicException( __METHOD__
. ': setting a logger for ' . get_class( $provider )
926 . ' is not implemented' );
928 $wrappedProvider->singletons
= $singletons;
932 * Restores loggers replaced by setLogger().
935 private function restoreLoggers() {
936 $provider = LoggerFactory
::getProvider();
937 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
938 $singletons = $wrappedProvider->singletons
;
939 foreach ( $this->loggers
as $channel => $logger ) {
940 if ( $provider instanceof MonologSpi
) {
941 if ( $logger === null ) {
942 unset( $singletons['loggers'][$channel] );
944 $singletons['loggers'][$channel] = $logger;
946 } elseif ( $provider instanceof LegacySpi
) {
947 if ( $logger === null ) {
948 unset( $singletons[$channel] );
950 $singletons[$channel] = $logger;
954 $wrappedProvider->singletons
= $singletons;
962 public function dbPrefix() {
963 return $this->db
->getType() == 'oracle' ? self
::ORA_DB_PREFIX
: self
::DB_PREFIX
;
970 public function needsDB() {
971 // If the test says it uses database tables, it needs the database
972 if ( $this->tablesUsed
) {
976 // If the test class says it belongs to the Database group, it needs the database.
977 // NOTE: This ONLY checks for the group in the class level doc comment.
978 $rc = new ReflectionClass( $this );
979 if ( preg_match( '/@group +Database/im', $rc->getDocComment() ) ) {
989 * Should be called from addDBData().
991 * @since 1.25 ($namespace in 1.28)
992 * @param string|title $pageName Page name or title
993 * @param string $text Page's content
994 * @param int $namespace Namespace id (name cannot already contain namespace)
995 * @return array Title object and page id
997 protected function insertPage(
999 $text = 'Sample page for unit test.',
1002 if ( is_string( $pageName ) ) {
1003 $title = Title
::newFromText( $pageName, $namespace );
1008 $user = static::getTestSysop()->getUser();
1009 $comment = __METHOD__
. ': Sample page for unit test.';
1011 // Avoid memory leak...?
1012 // LinkCache::singleton()->clear();
1013 // Maybe. But doing this absolutely breaks $title->isRedirect() when called during unit tests....
1015 $page = WikiPage
::factory( $title );
1016 $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $comment, 0, false, $user );
1020 'id' => $page->getId(),
1025 * Stub. If a test suite needs to add additional data to the database, it should
1026 * implement this method and do so. This method is called once per test suite
1027 * (i.e. once per class).
1029 * Note data added by this method may be removed by resetDB() depending on
1030 * the contents of $tablesUsed.
1032 * To add additional data between test function runs, override prepareDB().
1039 public function addDBDataOnce() {
1043 * Stub. Subclasses may override this to prepare the database.
1044 * Called before every test run (test function or data set).
1046 * @see addDBDataOnce()
1051 public function addDBData() {
1054 private function addCoreDBData() {
1055 if ( $this->db
->getType() == 'oracle' ) {
1056 # Insert 0 user to prevent FK violations
1058 if ( !$this->db
->selectField( 'user', '1', [ 'user_id' => 0 ] ) ) {
1059 $this->db
->insert( 'user', [
1061 'user_name' => 'Anonymous' ], __METHOD__
, [ 'IGNORE' ] );
1064 # Insert 0 page to prevent FK violations
1066 if ( !$this->db
->selectField( 'page', '1', [ 'page_id' => 0 ] ) ) {
1067 $this->db
->insert( 'page', [
1069 'page_namespace' => 0,
1070 'page_title' => ' ',
1071 'page_restrictions' => null,
1072 'page_is_redirect' => 0,
1075 'page_touched' => $this->db
->timestamp(),
1077 'page_len' => 0 ], __METHOD__
, [ 'IGNORE' ] );
1081 User
::resetIdByNameCache();
1084 $user = static::getTestSysop()->getUser();
1086 // Make 1 page with 1 revision
1087 $page = WikiPage
::factory( Title
::newFromText( 'UTPage' ) );
1088 if ( $page->getId() == 0 ) {
1089 $page->doEditContent(
1090 new WikitextContent( 'UTContent' ),
1092 EDIT_NEW | EDIT_SUPPRESS_RC
,
1096 // an edit always attempt to purge backlink links such as history
1097 // pages. That is unneccessary.
1098 JobQueueGroup
::singleton()->get( 'htmlCacheUpdate' )->delete();
1099 // WikiPages::doEditUpdates randomly adds RC purges
1100 JobQueueGroup
::singleton()->get( 'recentChangesUpdate' )->delete();
1102 // doEditContent() probably started the session via
1103 // User::loadFromSession(). Close it now.
1104 if ( session_id() !== '' ) {
1105 session_write_close();
1112 * Restores MediaWiki to using the table set (table prefix) it was using before
1113 * setupTestDB() was called. Useful if we need to perform database operations
1114 * after the test run has finished (such as saving logs or profiling info).
1118 public static function teardownTestDB() {
1119 global $wgJobClasses;
1121 if ( !self
::$dbSetup ) {
1125 Hooks
::run( 'UnitTestsBeforeDatabaseTeardown' );
1127 foreach ( $wgJobClasses as $type => $class ) {
1128 // Delete any jobs under the clone DB (or old prefix in other stores)
1129 JobQueueGroup
::singleton()->get( $type )->delete();
1132 CloneDatabase
::changePrefix( self
::$oldTablePrefix );
1134 self
::$oldTablePrefix = false;
1135 self
::$dbSetup = false;
1139 * Setups a database with the given prefix.
1141 * If reuseDB is true and certain conditions apply, it will just change the prefix.
1142 * Otherwise, it will clone the tables and change the prefix.
1144 * Clones all tables in the given database (whatever database that connection has
1145 * open), to versions with the test prefix.
1147 * @param IMaintainableDatabase $db Database to use
1148 * @param string $prefix Prefix to use for test tables
1149 * @return bool True if tables were cloned, false if only the prefix was changed
1151 protected static function setupDatabaseWithTestPrefix( IMaintainableDatabase
$db, $prefix ) {
1152 $tablesCloned = self
::listTables( $db );
1153 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix );
1154 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1156 if ( ( $db->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
1157 CloneDatabase
::changePrefix( $prefix );
1161 $dbClone->cloneTableStructure();
1167 * Set up all test DBs
1169 public function setupAllTestDBs() {
1172 self
::$oldTablePrefix = $wgDBprefix;
1174 $testPrefix = $this->dbPrefix();
1176 // switch to a temporary clone of the database
1177 self
::setupTestDB( $this->db
, $testPrefix );
1179 if ( self
::isUsingExternalStoreDB() ) {
1180 self
::setupExternalStoreTestDBs( $testPrefix );
1185 * Creates an empty skeleton of the wiki database by cloning its structure
1186 * to equivalent tables using the given $prefix. Then sets MediaWiki to
1187 * use the new set of tables (aka schema) instead of the original set.
1189 * This is used to generate a dummy table set, typically consisting of temporary
1190 * tables, that will be used by tests instead of the original wiki database tables.
1194 * @note the original table prefix is stored in self::$oldTablePrefix. This is used
1195 * by teardownTestDB() to return the wiki to using the original table set.
1197 * @note this method only works when first called. Subsequent calls have no effect,
1198 * even if using different parameters.
1200 * @param Database $db The database connection
1201 * @param string $prefix The prefix to use for the new table set (aka schema).
1203 * @throws MWException If the database table prefix is already $prefix
1205 public static function setupTestDB( Database
$db, $prefix ) {
1206 if ( self
::$dbSetup ) {
1210 if ( $db->tablePrefix() === $prefix ) {
1211 throw new MWException(
1212 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
1215 // TODO: the below should be re-written as soon as LBFactory, LoadBalancer,
1216 // and Database no longer use global state.
1218 self
::$dbSetup = true;
1220 if ( !self
::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
1224 // Assuming this isn't needed for External Store database, and not sure if the procedure
1225 // would be available there.
1226 if ( $db->getType() == 'oracle' ) {
1227 $db->query( 'BEGIN FILL_WIKI_INFO; END;' );
1230 Hooks
::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
1234 * Clones the External Store database(s) for testing
1236 * @param string $testPrefix Prefix for test tables
1238 protected static function setupExternalStoreTestDBs( $testPrefix ) {
1239 $connections = self
::getExternalStoreDatabaseConnections();
1240 foreach ( $connections as $dbw ) {
1241 // Hack: cloneTableStructure sets $wgDBprefix to the unit test
1242 // prefix,. Even though listTables now uses tablePrefix, that
1243 // itself is populated from $wgDBprefix by default.
1245 // We have to set it back, or we won't find the original 'blobs'
1248 $dbw->tablePrefix( self
::$oldTablePrefix );
1249 self
::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
1254 * Gets master database connections for all of the ExternalStoreDB
1255 * stores configured in $wgDefaultExternalStore.
1257 * @return Database[] Array of Database master connections
1259 protected static function getExternalStoreDatabaseConnections() {
1260 global $wgDefaultExternalStore;
1262 /** @var ExternalStoreDB $externalStoreDB */
1263 $externalStoreDB = ExternalStore
::getStoreObject( 'DB' );
1264 $defaultArray = (array)$wgDefaultExternalStore;
1266 foreach ( $defaultArray as $url ) {
1267 if ( strpos( $url, 'DB://' ) === 0 ) {
1268 list( $proto, $cluster ) = explode( '://', $url, 2 );
1269 // Avoid getMaster() because setupDatabaseWithTestPrefix()
1270 // requires Database instead of plain DBConnRef/IDatabase
1271 $dbws[] = $externalStoreDB->getMaster( $cluster );
1279 * Check whether ExternalStoreDB is being used
1281 * @return bool True if it's being used
1283 protected static function isUsingExternalStoreDB() {
1284 global $wgDefaultExternalStore;
1285 if ( !$wgDefaultExternalStore ) {
1289 $defaultArray = (array)$wgDefaultExternalStore;
1290 foreach ( $defaultArray as $url ) {
1291 if ( strpos( $url, 'DB://' ) === 0 ) {
1300 * Empty all tables so they can be repopulated for tests
1302 * @param Database $db|null Database to reset
1303 * @param array $tablesUsed Tables to reset
1305 private function resetDB( $db, $tablesUsed ) {
1307 $userTables = [ 'user', 'user_groups', 'user_properties' ];
1308 $pageTables = [ 'page', 'revision', 'ip_changes', 'revision_comment_temp', 'comment' ];
1309 $coreDBDataTables = array_merge( $userTables, $pageTables );
1311 // If any of the user or page tables were marked as used, we should clear all of them.
1312 if ( array_intersect( $tablesUsed, $userTables ) ) {
1313 $tablesUsed = array_unique( array_merge( $tablesUsed, $userTables ) );
1314 TestUserRegistry
::clear();
1316 if ( array_intersect( $tablesUsed, $pageTables ) ) {
1317 $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
1320 $truncate = in_array( $db->getType(), [ 'oracle', 'mysql' ] );
1321 foreach ( $tablesUsed as $tbl ) {
1322 // TODO: reset interwiki table to its original content.
1323 if ( $tbl == 'interwiki' ) {
1328 $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tbl ), __METHOD__
);
1330 $db->delete( $tbl, '*', __METHOD__
);
1333 if ( $tbl === 'page' ) {
1334 // Forget about the pages since they don't
1336 LinkCache
::singleton()->clear();
1340 if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
1341 // Re-add core DB data that was deleted
1342 $this->addCoreDBData();
1350 * @param string $func
1351 * @param array $args
1354 * @throws MWException
1356 public function __call( $func, $args ) {
1357 static $compatibility = [
1358 'createMock' => 'createMock2',
1361 if ( isset( $compatibility[$func] ) ) {
1362 return call_user_func_array( [ $this, $compatibility[$func] ], $args );
1364 throw new MWException( "Called non-existent $func method on " . static::class );
1369 * Return a test double for the specified class.
1371 * @param string $originalClassName
1372 * @return PHPUnit_Framework_MockObject_MockObject
1375 private function createMock2( $originalClassName ) {
1376 return $this->getMockBuilder( $originalClassName )
1377 ->disableOriginalConstructor()
1378 ->disableOriginalClone()
1379 ->disableArgumentCloning()
1380 // New in phpunit-mock-objects 3.2 (phpunit 5.4.0)
1381 // ->disallowMockingUnknownTypes()
1385 private static function unprefixTable( &$tableName, $ind, $prefix ) {
1386 $tableName = substr( $tableName, strlen( $prefix ) );
1389 private static function isNotUnittest( $table ) {
1390 return strpos( $table, 'unittest_' ) !== 0;
1396 * @param IMaintainableDatabase $db
1400 public static function listTables( IMaintainableDatabase
$db ) {
1401 $prefix = $db->tablePrefix();
1402 $tables = $db->listTables( $prefix, __METHOD__
);
1404 if ( $db->getType() === 'mysql' ) {
1405 static $viewListCache = null;
1406 if ( $viewListCache === null ) {
1407 $viewListCache = $db->listViews( null, __METHOD__
);
1409 // T45571: cannot clone VIEWs under MySQL
1410 $tables = array_diff( $tables, $viewListCache );
1412 array_walk( $tables, [ __CLASS__
, 'unprefixTable' ], $prefix );
1414 // Don't duplicate test tables from the previous fataled run
1415 $tables = array_filter( $tables, [ __CLASS__
, 'isNotUnittest' ] );
1417 if ( $db->getType() == 'sqlite' ) {
1418 $tables = array_flip( $tables );
1419 // these are subtables of searchindex and don't need to be duped/dropped separately
1420 unset( $tables['searchindex_content'] );
1421 unset( $tables['searchindex_segdir'] );
1422 unset( $tables['searchindex_segments'] );
1423 $tables = array_flip( $tables );
1430 * @throws MWException
1433 protected function checkDbIsSupported() {
1434 if ( !in_array( $this->db
->getType(), $this->supportedDBs
) ) {
1435 throw new MWException( $this->db
->getType() . " is not currently supported for unit testing." );
1441 * @param string $offset
1444 public function getCliArg( $offset ) {
1445 if ( isset( PHPUnitMaintClass
::$additionalOptions[$offset] ) ) {
1446 return PHPUnitMaintClass
::$additionalOptions[$offset];
1454 * @param string $offset
1455 * @param mixed $value
1457 public function setCliArg( $offset, $value ) {
1458 PHPUnitMaintClass
::$additionalOptions[$offset] = $value;
1462 * Don't throw a warning if $function is deprecated and called later
1466 * @param string $function
1468 public function hideDeprecated( $function ) {
1469 MediaWiki\
suppressWarnings();
1470 wfDeprecated( $function );
1471 MediaWiki\restoreWarnings
();
1475 * Asserts that the given database query yields the rows given by $expectedRows.
1476 * The expected rows should be given as indexed (not associative) arrays, with
1477 * the values given in the order of the columns in the $fields parameter.
1478 * Note that the rows are sorted by the columns given in $fields.
1482 * @param string|array $table The table(s) to query
1483 * @param string|array $fields The columns to include in the result (and to sort by)
1484 * @param string|array $condition "where" condition(s)
1485 * @param array $expectedRows An array of arrays giving the expected rows.
1487 * @throws MWException If this test cases's needsDB() method doesn't return true.
1488 * Test cases can use "@group Database" to enable database test support,
1489 * or list the tables under testing in $this->tablesUsed, or override the
1492 protected function assertSelect( $table, $fields, $condition, array $expectedRows ) {
1493 if ( !$this->needsDB() ) {
1494 throw new MWException( 'When testing database state, the test cases\'s needDB()' .
1495 ' method should return true. Use @group Database or $this->tablesUsed.' );
1498 $db = wfGetDB( DB_REPLICA
);
1500 $res = $db->select( $table, $fields, $condition, wfGetCaller(), [ 'ORDER BY' => $fields ] );
1501 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
1505 foreach ( $expectedRows as $expected ) {
1506 $r = $res->fetchRow();
1507 self
::stripStringKeys( $r );
1510 $this->assertNotEmpty( $r, "row #$i missing" );
1512 $this->assertEquals( $expected, $r, "row #$i mismatches" );
1515 $r = $res->fetchRow();
1516 self
::stripStringKeys( $r );
1518 $this->assertFalse( $r, "found extra row (after #$i)" );
1522 * Utility method taking an array of elements and wrapping
1523 * each element in its own array. Useful for data providers
1524 * that only return a single argument.
1528 * @param array $elements
1532 protected function arrayWrap( array $elements ) {
1534 function ( $element ) {
1535 return [ $element ];
1542 * Assert that two arrays are equal. By default this means that both arrays need to hold
1543 * the same set of values. Using additional arguments, order and associated key can also
1544 * be set as relevant.
1548 * @param array $expected
1549 * @param array $actual
1550 * @param bool $ordered If the order of the values should match
1551 * @param bool $named If the keys should match
1553 protected function assertArrayEquals( array $expected, array $actual,
1554 $ordered = false, $named = false
1557 $this->objectAssociativeSort( $expected );
1558 $this->objectAssociativeSort( $actual );
1562 $expected = array_values( $expected );
1563 $actual = array_values( $actual );
1566 call_user_func_array(
1567 [ $this, 'assertEquals' ],
1568 array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
1573 * Put each HTML element on its own line and then equals() the results
1575 * Use for nicely formatting of PHPUnit diff output when comparing very
1580 * @param string $expected HTML on oneline
1581 * @param string $actual HTML on oneline
1582 * @param string $msg Optional message
1584 protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
1585 $expected = str_replace( '>', ">\n", $expected );
1586 $actual = str_replace( '>', ">\n", $actual );
1588 $this->assertEquals( $expected, $actual, $msg );
1592 * Does an associative sort that works for objects.
1596 * @param array &$array
1598 protected function objectAssociativeSort( array &$array ) {
1601 function ( $a, $b ) {
1602 return serialize( $a ) > serialize( $b ) ?
1 : -1;
1608 * Utility function for eliminating all string keys from an array.
1609 * Useful to turn a database result row as returned by fetchRow() into
1610 * a pure indexed array.
1614 * @param mixed &$r The array to remove string keys from.
1616 protected static function stripStringKeys( &$r ) {
1617 if ( !is_array( $r ) ) {
1621 foreach ( $r as $k => $v ) {
1622 if ( is_string( $k ) ) {
1629 * Asserts that the provided variable is of the specified
1630 * internal type or equals the $value argument. This is useful
1631 * for testing return types of functions that return a certain
1632 * type or *value* when not set or on error.
1636 * @param string $type
1637 * @param mixed $actual
1638 * @param mixed $value
1639 * @param string $message
1641 protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
1642 if ( $actual === $value ) {
1643 $this->assertTrue( true, $message );
1645 $this->assertType( $type, $actual, $message );
1650 * Asserts the type of the provided value. This can be either
1651 * in internal type such as boolean or integer, or a class or
1652 * interface the value extends or implements.
1656 * @param string $type
1657 * @param mixed $actual
1658 * @param string $message
1660 protected function assertType( $type, $actual, $message = '' ) {
1661 if ( class_exists( $type ) ||
interface_exists( $type ) ) {
1662 $this->assertInstanceOf( $type, $actual, $message );
1664 $this->assertInternalType( $type, $actual, $message );
1669 * Returns true if the given namespace defaults to Wikitext
1670 * according to $wgNamespaceContentModels
1672 * @param int $ns The namespace ID to check
1677 protected function isWikitextNS( $ns ) {
1678 global $wgNamespaceContentModels;
1680 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
1681 return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
;
1688 * Returns the ID of a namespace that defaults to Wikitext.
1690 * @throws MWException If there is none.
1691 * @return int The ID of the wikitext Namespace
1694 protected function getDefaultWikitextNS() {
1695 global $wgNamespaceContentModels;
1697 static $wikitextNS = null; // this is not going to change
1698 if ( $wikitextNS !== null ) {
1702 // quickly short out on most common case:
1703 if ( !isset( $wgNamespaceContentModels[NS_MAIN
] ) ) {
1707 // NOTE: prefer content namespaces
1708 $namespaces = array_unique( array_merge(
1709 MWNamespace
::getContentNamespaces(),
1710 [ NS_MAIN
, NS_HELP
, NS_PROJECT
], // prefer these
1711 MWNamespace
::getValidNamespaces()
1714 $namespaces = array_diff( $namespaces, [
1715 NS_FILE
, NS_CATEGORY
, NS_MEDIAWIKI
, NS_USER
// don't mess with magic namespaces
1718 $talk = array_filter( $namespaces, function ( $ns ) {
1719 return MWNamespace
::isTalk( $ns );
1722 // prefer non-talk pages
1723 $namespaces = array_diff( $namespaces, $talk );
1724 $namespaces = array_merge( $namespaces, $talk );
1726 // check default content model of each namespace
1727 foreach ( $namespaces as $ns ) {
1728 if ( !isset( $wgNamespaceContentModels[$ns] ) ||
1729 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
1738 // @todo Inside a test, we could skip the test as incomplete.
1739 // But frequently, this is used in fixture setup.
1740 throw new MWException( "No namespace defaults to wikitext!" );
1744 * Check, if $wgDiff3 is set and ready to merge
1745 * Will mark the calling test as skipped, if not ready
1749 protected function markTestSkippedIfNoDiff3() {
1752 # This check may also protect against code injection in
1753 # case of broken installations.
1754 MediaWiki\
suppressWarnings();
1755 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
1756 MediaWiki\restoreWarnings
();
1758 if ( !$haveDiff3 ) {
1759 $this->markTestSkipped( "Skip test, since diff3 is not configured" );
1764 * Check if $extName is a loaded PHP extension, will skip the
1765 * test whenever it is not loaded.
1768 * @param string $extName
1771 protected function checkPHPExtension( $extName ) {
1772 $loaded = extension_loaded( $extName );
1774 $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
1781 * Asserts that the given string is a valid HTML snippet.
1782 * Wraps the given string in the required top level tags and
1783 * then calls assertValidHtmlDocument().
1784 * The snippet is expected to be HTML 5.
1788 * @note Will mark the test as skipped if the "tidy" module is not installed.
1789 * @note This ignores $wgUseTidy, so we can check for valid HTML even (and especially)
1790 * when automatic tidying is disabled.
1792 * @param string $html An HTML snippet (treated as the contents of the body tag).
1794 protected function assertValidHtmlSnippet( $html ) {
1795 $html = '<!DOCTYPE html><html><head><title>test</title></head><body>' . $html . '</body></html>';
1796 $this->assertValidHtmlDocument( $html );
1800 * Asserts that the given string is valid HTML document.
1804 * @note Will mark the test as skipped if the "tidy" module is not installed.
1805 * @note This ignores $wgUseTidy, so we can check for valid HTML even (and especially)
1806 * when automatic tidying is disabled.
1808 * @param string $html A complete HTML document
1810 protected function assertValidHtmlDocument( $html ) {
1811 // Note: we only validate if the tidy PHP extension is available.
1812 // In case wgTidyInternal is false, MWTidy would fall back to the command line version
1813 // of tidy. In that case however, we can not reliably detect whether a failing validation
1814 // is due to malformed HTML, or caused by tidy not being installed as a command line tool.
1815 // That would cause all HTML assertions to fail on a system that has no tidy installed.
1816 if ( !$GLOBALS['wgTidyInternal'] ||
!MWTidy
::isEnabled() ) {
1817 $this->markTestSkipped( 'Tidy extension not installed' );
1821 MWTidy
::checkErrors( $html, $errorBuffer );
1822 $allErrors = preg_split( '/[\r\n]+/', $errorBuffer );
1824 // Filter Tidy warnings which aren't useful for us.
1825 // Tidy eg. often cries about parameters missing which have actually
1826 // been deprecated since HTML4, thus we should not care about them.
1827 $errors = preg_grep(
1828 '/^(.*Warning: (trimming empty|.* lacks ".*?" attribute).*|\s*)$/m',
1829 $allErrors, PREG_GREP_INVERT
1832 $this->assertEmpty( $errors, implode( "\n", $errors ) );
1836 * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
1837 * @param string $buffer
1840 public static function wfResetOutputBuffersBarrier( $buffer ) {
1845 * Create a temporary hook handler which will be reset by tearDown.
1846 * This replaces other handlers for the same hook.
1847 * @param string $hookName Hook name
1848 * @param mixed $handler Value suitable for a hook handler
1851 protected function setTemporaryHook( $hookName, $handler ) {
1852 $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
1856 * Check whether file contains given data.
1857 * @param string $fileName
1858 * @param string $actualData
1859 * @param bool $createIfMissing If true, and file does not exist, create it with given data
1860 * and skip the test.
1861 * @param string $msg
1864 protected function assertFileContains(
1867 $createIfMissing = true,
1870 if ( $createIfMissing ) {
1871 if ( !file_exists( $fileName ) ) {
1872 file_put_contents( $fileName, $actualData );
1873 $this->markTestSkipped( 'Data file $fileName does not exist' );
1876 self
::assertFileExists( $fileName );
1878 self
::assertEquals( file_get_contents( $fileName ), $actualData, $msg );