3 use MediaWiki\Logger\LegacySpi
;
4 use MediaWiki\Logger\LoggerFactory
;
5 use MediaWiki\Logger\MonologSpi
;
6 use MediaWiki\MediaWikiServices
;
7 use Psr\Log\LoggerInterface
;
8 use Wikimedia\Rdbms\IDatabase
;
9 use Wikimedia\Rdbms\IMaintainableDatabase
;
10 use Wikimedia\Rdbms\Database
;
11 use Wikimedia\Rdbms\LBFactory
;
12 use Wikimedia\TestingAccessWrapper
;
17 abstract class MediaWikiTestCase
extends PHPUnit\Framework\TestCase
{
19 use MediaWikiCoversValidator
;
20 use PHPUnit4And6Compat
;
23 * The service locator created by prepareServices(). This service locator will
24 * be restored after each test. Tests that pollute the global service locator
25 * instance should use overrideMwServices() to isolate the test.
27 * @var MediaWikiServices|null
29 private static $serviceLocator = null;
32 * $called tracks whether the setUp and tearDown method has been called.
33 * class extending MediaWikiTestCase usually override setUp and tearDown
34 * but forget to call the parent.
36 * The array format takes a method name as key and anything as a value.
37 * By asserting the key exist, we know the child class has called the
40 * This property must be private, we do not want child to override it,
41 * they should call the appropriate parent method instead.
63 protected $tablesUsed = []; // tables with data
65 private static $useTemporaryTables = true;
66 private static $reuseDB = false;
67 private static $dbSetup = false;
68 private static $oldTablePrefix = '';
71 * Original value of PHP's error_reporting setting.
75 private $phpErrorLevel;
78 * Holds the paths of temporary files/directories created through getNewTempFile,
79 * and getNewTempDirectory
83 private $tmpFiles = [];
86 * Holds original values of MediaWiki configuration settings
87 * to be restored in tearDown().
88 * See also setMwGlobals().
91 private $mwGlobals = [];
94 * Holds list of MediaWiki configuration settings to be unset in tearDown().
95 * See also setMwGlobals().
98 private $mwGlobalsToUnset = [];
101 * Holds original contents of interwiki table
102 * @var IResultWrapper
104 private $interwikiTable = null;
107 * Holds original loggers which have been replaced by setLogger()
108 * @var LoggerInterface[]
110 private $loggers = [];
113 * Table name prefixes. Oracle likes it shorter.
115 const DB_PREFIX
= 'unittest_';
116 const ORA_DB_PREFIX
= 'ut_';
122 protected $supportedDBs = [
129 public function __construct( $name = null, array $data = [], $dataName = '' ) {
130 parent
::__construct( $name, $data, $dataName );
132 $this->backupGlobals
= false;
133 $this->backupStaticAttributes
= false;
136 public function __destruct() {
137 // Complain if self::setUp() was called, but not self::tearDown()
138 // $this->called['setUp'] will be checked by self::testMediaWikiTestCaseParentSetupCalled()
139 if ( isset( $this->called
['setUp'] ) && !isset( $this->called
['tearDown'] ) ) {
140 throw new MWException( static::class . "::tearDown() must call parent::tearDown()" );
144 public static function setUpBeforeClass() {
145 parent
::setUpBeforeClass();
147 // Get the service locator, and reset services if it's not done already
148 self
::$serviceLocator = self
::prepareServices( new GlobalVarConfig() );
152 * Convenience method for getting an immutable test user
156 * @param string[] $groups Groups the test user should be in.
159 public static function getTestUser( $groups = [] ) {
160 return TestUserRegistry
::getImmutableTestUser( $groups );
164 * Convenience method for getting a mutable test user
168 * @param string[] $groups Groups the test user should be added in.
171 public static function getMutableTestUser( $groups = [] ) {
172 return TestUserRegistry
::getMutableTestUser( __CLASS__
, $groups );
176 * Convenience method for getting an immutable admin test user
180 * @param string[] $groups Groups the test user should be added to.
183 public static function getTestSysop() {
184 return self
::getTestUser( [ 'sysop', 'bureaucrat' ] );
188 * Returns a WikiPage representing an existing page.
192 * @param Title|string|null $title
194 * @throws MWException
196 protected function getExistingTestPage( $title = null ) {
197 $title = ( $title === null ) ?
'UTPage' : $title;
198 $title = is_string( $title ) ? Title
::newFromText( $title ) : $title;
199 $page = WikiPage
::factory( $title );
201 if ( !$page->exists() ) {
202 $user = self
::getTestSysop()->getUser();
203 $page->doEditContent(
204 new WikitextContent( 'UTContent' ),
206 EDIT_NEW | EDIT_SUPPRESS_RC
,
216 * Returns a WikiPage representing a non-existing page.
220 * @param Title|string|null $title
222 * @throws MWException
224 protected function getNonexistingTestPage( $title = null ) {
225 $title = ( $title === null ) ?
'UTPage-' . rand( 0, 100000 ) : $title;
226 $title = is_string( $title ) ? Title
::newFromText( $title ) : $title;
227 $page = WikiPage
::factory( $title );
229 if ( $page->exists() ) {
230 $page->doDeleteArticle( 'Testing' );
237 * Prepare service configuration for unit testing.
239 * This calls MediaWikiServices::resetGlobalInstance() to allow some critical services
240 * to be overridden for testing.
242 * prepareServices() only needs to be called once, but should be called as early as possible,
243 * before any class has a chance to grab a reference to any of the global services
244 * instances that get discarded by prepareServices(). Only the first call has any effect,
245 * later calls are ignored.
247 * @note This is called by PHPUnitMaintClass::finalSetup.
249 * @see MediaWikiServices::resetGlobalInstance()
251 * @param Config $bootstrapConfig The bootstrap config to use with the new
252 * MediaWikiServices. Only used for the first call to this method.
253 * @return MediaWikiServices
255 public static function prepareServices( Config
$bootstrapConfig ) {
256 static $services = null;
259 $services = self
::resetGlobalServices( $bootstrapConfig );
265 * Reset global services, and install testing environment.
266 * This is the testing equivalent of MediaWikiServices::resetGlobalInstance().
267 * This should only be used to set up the testing environment, not when
268 * running unit tests. Use MediaWikiTestCase::overrideMwServices() for that.
270 * @see MediaWikiServices::resetGlobalInstance()
271 * @see prepareServices()
272 * @see MediaWikiTestCase::overrideMwServices()
274 * @param Config|null $bootstrapConfig The bootstrap config to use with the new
276 * @return MediaWikiServices
278 protected static function resetGlobalServices( Config
$bootstrapConfig = null ) {
279 $oldServices = MediaWikiServices
::getInstance();
280 $oldConfigFactory = $oldServices->getConfigFactory();
281 $oldLoadBalancerFactory = $oldServices->getDBLoadBalancerFactory();
283 $testConfig = self
::makeTestConfig( $bootstrapConfig );
285 MediaWikiServices
::resetGlobalInstance( $testConfig );
287 $serviceLocator = MediaWikiServices
::getInstance();
288 self
::installTestServices(
290 $oldLoadBalancerFactory,
293 return $serviceLocator;
297 * Create a config suitable for testing, based on a base config, default overrides,
298 * and custom overrides.
300 * @param Config|null $baseConfig
301 * @param Config|null $customOverrides
305 private static function makeTestConfig(
306 Config
$baseConfig = null,
307 Config
$customOverrides = null
309 $defaultOverrides = new HashConfig();
311 if ( !$baseConfig ) {
312 $baseConfig = MediaWikiServices
::getInstance()->getBootstrapConfig();
315 /* Some functions require some kind of caching, and will end up using the db,
316 * which we can't allow, as that would open a new connection for mysql.
317 * Replace with a HashBag. They would not be going to persist anyway.
319 $hashCache = [ 'class' => HashBagOStuff
::class, 'reportDupes' => false ];
321 CACHE_DB
=> $hashCache,
322 CACHE_ACCEL
=> $hashCache,
323 CACHE_MEMCACHED
=> $hashCache,
325 'apcu' => $hashCache,
326 'wincache' => $hashCache,
327 ] +
$baseConfig->get( 'ObjectCaches' );
329 $defaultOverrides->set( 'ObjectCaches', $objectCaches );
330 $defaultOverrides->set( 'MainCacheType', CACHE_NONE
);
331 $defaultOverrides->set( 'JobTypeConf', [ 'default' => [ 'class' => JobQueueMemory
::class ] ] );
333 // Use a fast hash algorithm to hash passwords.
334 $defaultOverrides->set( 'PasswordDefault', 'A' );
336 $testConfig = $customOverrides
337 ?
new MultiConfig( [ $customOverrides, $defaultOverrides, $baseConfig ] )
338 : new MultiConfig( [ $defaultOverrides, $baseConfig ] );
344 * @param ConfigFactory $oldConfigFactory
345 * @param LBFactory $oldLoadBalancerFactory
346 * @param MediaWikiServices $newServices
348 * @throws MWException
350 private static function installTestServices(
351 ConfigFactory
$oldConfigFactory,
352 LBFactory
$oldLoadBalancerFactory,
353 MediaWikiServices
$newServices
355 // Use bootstrap config for all configuration.
356 // This allows config overrides via global variables to take effect.
357 $bootstrapConfig = $newServices->getBootstrapConfig();
358 $newServices->resetServiceForTesting( 'ConfigFactory' );
359 $newServices->redefineService(
361 self
::makeTestConfigFactoryInstantiator(
363 [ 'main' => $bootstrapConfig ]
366 $newServices->resetServiceForTesting( 'DBLoadBalancerFactory' );
367 $newServices->redefineService(
368 'DBLoadBalancerFactory',
369 function ( MediaWikiServices
$services ) use ( $oldLoadBalancerFactory ) {
370 return $oldLoadBalancerFactory;
376 * @param ConfigFactory $oldFactory
377 * @param Config[] $configurations
381 private static function makeTestConfigFactoryInstantiator(
382 ConfigFactory
$oldFactory,
383 array $configurations
385 return function ( MediaWikiServices
$services ) use ( $oldFactory, $configurations ) {
386 $factory = new ConfigFactory();
388 // clone configurations from $oldFactory that are not overwritten by $configurations
389 $namesToClone = array_diff(
390 $oldFactory->getConfigNames(),
391 array_keys( $configurations )
394 foreach ( $namesToClone as $name ) {
395 $factory->register( $name, $oldFactory->makeConfig( $name ) );
398 foreach ( $configurations as $name => $config ) {
399 $factory->register( $name, $config );
407 * Resets some well known services that typically have state that may interfere with unit tests.
408 * This is a lightweight alternative to resetGlobalServices().
410 * @note There is no guarantee that no references remain to stale service instances destroyed
411 * by a call to doLightweightServiceReset().
413 * @throws MWException if called outside of PHPUnit tests.
415 * @see resetGlobalServices()
417 private function doLightweightServiceReset() {
418 global $wgRequest, $wgJobClasses;
420 foreach ( $wgJobClasses as $type => $class ) {
421 JobQueueGroup
::singleton()->get( $type )->delete();
423 JobQueueGroup
::destroySingletons();
425 ObjectCache
::clear();
426 $services = MediaWikiServices
::getInstance();
427 $services->resetServiceForTesting( 'MainObjectStash' );
428 $services->resetServiceForTesting( 'LocalServerObjectCache' );
429 $services->getMainWANObjectCache()->clearProcessCache();
430 FileBackendGroup
::destroySingleton();
431 DeferredUpdates
::clearPendingUpdates();
433 // TODO: move global state into MediaWikiServices
434 RequestContext
::resetMain();
435 if ( session_id() !== '' ) {
436 session_write_close();
440 $wgRequest = new FauxRequest();
441 MediaWiki\Session\SessionManager
::resetCache();
444 public function run( PHPUnit_Framework_TestResult
$result = null ) {
445 $needsResetDB = false;
447 if ( !self
::$dbSetup ||
$this->needsDB() ) {
448 // set up a DB connection for this test to use
450 self
::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
451 self
::$reuseDB = $this->getCliArg( 'reuse-db' );
453 $this->db
= wfGetDB( DB_MASTER
);
455 $this->checkDbIsSupported();
457 if ( !self
::$dbSetup ) {
458 $this->setupAllTestDBs();
459 $this->addCoreDBData();
462 // TODO: the DB setup should be done in setUpBeforeClass(), so the test DB
463 // is available in subclass's setUpBeforeClass() and setUp() methods.
464 // This would also remove the need for the HACK that is oncePerClass().
465 if ( $this->oncePerClass() ) {
466 $this->setUpSchema( $this->db
);
467 $this->resetDB( $this->db
, $this->tablesUsed
);
468 $this->addDBDataOnce();
472 $needsResetDB = true;
475 parent
::run( $result );
477 if ( $needsResetDB ) {
478 $this->resetDB( $this->db
, $this->tablesUsed
);
485 private function oncePerClass() {
486 // Remember current test class in the database connection,
487 // so we know when we need to run addData.
489 $class = static::class;
491 $first = !isset( $this->db
->_hasDataForTestClass
)
492 ||
$this->db
->_hasDataForTestClass
!== $class;
494 $this->db
->_hasDataForTestClass
= $class;
503 public function usesTemporaryTables() {
504 return self
::$useTemporaryTables;
508 * Obtains a new temporary file name
510 * The obtained filename is enlisted to be removed upon tearDown
514 * @return string Absolute name of the temporary file
516 protected function getNewTempFile() {
517 $fileName = tempnam( wfTempDir(), 'MW_PHPUnit_' . static::class . '_' );
518 $this->tmpFiles
[] = $fileName;
524 * obtains a new temporary directory
526 * The obtained directory is enlisted to be removed (recursively with all its contained
527 * files) upon tearDown.
531 * @return string Absolute name of the temporary directory
533 protected function getNewTempDirectory() {
534 // Starting of with a temporary /file/.
535 $fileName = $this->getNewTempFile();
537 // Converting the temporary /file/ to a /directory/
538 // The following is not atomic, but at least we now have a single place,
539 // where temporary directory creation is bundled and can be improved
541 $this->assertTrue( wfMkdirParents( $fileName ) );
546 protected function setUp() {
548 $this->called
['setUp'] = true;
550 $this->phpErrorLevel
= intval( ini_get( 'error_reporting' ) );
552 // Cleaning up temporary files
553 foreach ( $this->tmpFiles
as $fileName ) {
554 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
556 } elseif ( is_dir( $fileName ) ) {
557 wfRecursiveRemoveDir( $fileName );
561 if ( $this->needsDB() && $this->db
) {
562 // Clean up open transactions
563 while ( $this->db
->trxLevel() > 0 ) {
564 $this->db
->rollback( __METHOD__
, 'flush' );
566 // Check for unsafe queries
567 if ( $this->db
->getType() === 'mysql' ) {
568 $this->db
->query( "SET sql_mode = 'STRICT_ALL_TABLES'" );
572 // Store contents of interwiki table in case it changes. Unfortunately, we seem to have no
573 // way to do this only when needed, because tablesUsed can be changed mid-test.
575 $this->interwikiTable
= $this->db
->select( 'interwiki', '*', '', __METHOD__
);
578 // Reset all caches between tests.
579 $this->doLightweightServiceReset();
581 // XXX: reset maintenance triggers
582 // Hook into period lag checks which often happen in long-running scripts
583 $services = MediaWikiServices
::getInstance();
584 $lbFactory = $services->getDBLoadBalancerFactory();
585 Maintenance
::setLBFactoryTriggers( $lbFactory, $services->getMainConfig() );
587 ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
590 protected function addTmpFiles( $files ) {
591 $this->tmpFiles
= array_merge( $this->tmpFiles
, (array)$files );
594 protected function tearDown() {
595 global $wgRequest, $wgSQLMode;
597 $status = ob_get_status();
598 if ( isset( $status['name'] ) &&
599 $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier'
604 $this->called
['tearDown'] = true;
605 // Cleaning up temporary files
606 foreach ( $this->tmpFiles
as $fileName ) {
607 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
609 } elseif ( is_dir( $fileName ) ) {
610 wfRecursiveRemoveDir( $fileName );
614 if ( $this->needsDB() && $this->db
) {
615 // Clean up open transactions
616 while ( $this->db
->trxLevel() > 0 ) {
617 $this->db
->rollback( __METHOD__
, 'flush' );
619 if ( $this->db
->getType() === 'mysql' ) {
620 $this->db
->query( "SET sql_mode = " . $this->db
->addQuotes( $wgSQLMode ) );
624 // Restore mw globals
625 foreach ( $this->mwGlobals
as $key => $value ) {
626 $GLOBALS[$key] = $value;
628 foreach ( $this->mwGlobalsToUnset
as $value ) {
629 unset( $GLOBALS[$value] );
632 array_key_exists( 'wgExtraNamespaces', $this->mwGlobals
) ||
633 in_array( 'wgExtraNamespaces', $this->mwGlobalsToUnset
)
635 $this->resetNamespaces();
637 $this->mwGlobals
= [];
638 $this->mwGlobalsToUnset
= [];
639 $this->restoreLoggers();
641 if ( self
::$serviceLocator && MediaWikiServices
::getInstance() !== self
::$serviceLocator ) {
642 MediaWikiServices
::forceGlobalInstance( self
::$serviceLocator );
645 // TODO: move global state into MediaWikiServices
646 RequestContext
::resetMain();
647 if ( session_id() !== '' ) {
648 session_write_close();
651 $wgRequest = new FauxRequest();
652 MediaWiki\Session\SessionManager
::resetCache();
653 MediaWiki\Auth\AuthManager
::resetCache();
655 $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
657 if ( $phpErrorLevel !== $this->phpErrorLevel
) {
658 ini_set( 'error_reporting', $this->phpErrorLevel
);
660 $oldHex = strtoupper( dechex( $this->phpErrorLevel
) );
661 $newHex = strtoupper( dechex( $phpErrorLevel ) );
662 $message = "PHP error_reporting setting was left dirty: "
663 . "was 0x$oldHex before test, 0x$newHex after test!";
665 $this->fail( $message );
672 * Make sure MediaWikiTestCase extending classes have called their
673 * parent setUp method
675 * With strict coverage activated in PHP_CodeCoverage, this test would be
676 * marked as risky without the following annotation (T152923).
679 final public function testMediaWikiTestCaseParentSetupCalled() {
680 $this->assertArrayHasKey( 'setUp', $this->called
,
681 static::class . '::setUp() must call parent::setUp()'
686 * Sets a service, maintaining a stashed version of the previous service to be
687 * restored in tearDown
691 * @param string $name
692 * @param object $object
694 protected function setService( $name, $object ) {
695 // If we did not yet override the service locator, so so now.
696 if ( MediaWikiServices
::getInstance() === self
::$serviceLocator ) {
697 $this->overrideMwServices();
700 MediaWikiServices
::getInstance()->disableService( $name );
701 MediaWikiServices
::getInstance()->redefineService(
703 function () use ( $object ) {
710 * Sets a global, maintaining a stashed version of the previous global to be
711 * restored in tearDown
713 * The key is added to the array of globals that will be reset afterwards
718 * protected function setUp() {
719 * $this->setMwGlobals( 'wgRestrictStuff', true );
722 * function testFoo() {}
724 * function testBar() {}
725 * $this->assertTrue( self::getX()->doStuff() );
727 * $this->setMwGlobals( 'wgRestrictStuff', false );
728 * $this->assertTrue( self::getX()->doStuff() );
731 * function testQuux() {}
734 * @param array|string $pairs Key to the global variable, or an array
735 * of key/value pairs.
736 * @param mixed|null $value Value to set the global to (ignored
737 * if an array is given as first argument).
739 * @note To allow changes to global variables to take effect on global service instances,
740 * call overrideMwServices().
744 protected function setMwGlobals( $pairs, $value = null ) {
745 if ( is_string( $pairs ) ) {
746 $pairs = [ $pairs => $value ];
749 $this->stashMwGlobals( array_keys( $pairs ) );
751 foreach ( $pairs as $key => $value ) {
752 $GLOBALS[$key] = $value;
755 if ( array_key_exists( 'wgExtraNamespaces', $pairs ) ) {
756 $this->resetNamespaces();
761 * Must be called whenever namespaces are changed, e.g., $wgExtraNamespaces is altered.
762 * Otherwise old namespace data will lurk and cause bugs.
764 private function resetNamespaces() {
765 MWNamespace
::clearCaches();
766 Language
::clearCaches();
768 // We can't have the TitleFormatter holding on to an old Language object either
769 // @todo We shouldn't need to reset all the aliases here.
770 $services = MediaWikiServices
::getInstance();
771 $services->resetServiceForTesting( 'TitleFormatter' );
772 $services->resetServiceForTesting( 'TitleParser' );
773 $services->resetServiceForTesting( '_MediaWikiTitleCodec' );
777 * Check if we can back up a value by performing a shallow copy.
778 * Values which fail this test are copied recursively.
780 * @param mixed $value
781 * @return bool True if a shallow copy will do; false if a deep copy
784 private static function canShallowCopy( $value ) {
785 if ( is_scalar( $value ) ||
$value === null ) {
788 if ( is_array( $value ) ) {
789 foreach ( $value as $subValue ) {
790 if ( !is_scalar( $subValue ) && $subValue !== null ) {
800 * Stashes the global, will be restored in tearDown()
802 * Individual test functions may override globals through the setMwGlobals() function
803 * or directly. When directly overriding globals their keys should first be passed to this
804 * method in setUp to avoid breaking global state for other tests
806 * That way all other tests are executed with the same settings (instead of using the
807 * unreliable local settings for most tests and fix it only for some tests).
809 * @param array|string $globalKeys Key to the global variable, or an array of keys.
811 * @note To allow changes to global variables to take effect on global service instances,
812 * call overrideMwServices().
816 protected function stashMwGlobals( $globalKeys ) {
817 if ( is_string( $globalKeys ) ) {
818 $globalKeys = [ $globalKeys ];
821 foreach ( $globalKeys as $globalKey ) {
822 // NOTE: make sure we only save the global once or a second call to
823 // setMwGlobals() on the same global would override the original
826 !array_key_exists( $globalKey, $this->mwGlobals
) &&
827 !array_key_exists( $globalKey, $this->mwGlobalsToUnset
)
829 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
830 $this->mwGlobalsToUnset
[$globalKey] = $globalKey;
833 // NOTE: we serialize then unserialize the value in case it is an object
834 // this stops any objects being passed by reference. We could use clone
835 // and if is_object but this does account for objects within objects!
836 if ( self
::canShallowCopy( $GLOBALS[$globalKey] ) ) {
837 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
839 // Many MediaWiki types are safe to clone. These are the
840 // ones that are most commonly stashed.
841 $GLOBALS[$globalKey] instanceof Language ||
842 $GLOBALS[$globalKey] instanceof User ||
843 $GLOBALS[$globalKey] instanceof FauxRequest
845 $this->mwGlobals
[$globalKey] = clone $GLOBALS[$globalKey];
846 } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
847 // Serializing Closure only gives a warning on HHVM while
848 // it throws an Exception on Zend.
849 // Workaround for https://github.com/facebook/hhvm/issues/6206
850 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
853 $this->mwGlobals
[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
854 } catch ( Exception
$e ) {
855 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
864 * @param int $maxDepth
868 private function containsClosure( $var, $maxDepth = 15 ) {
869 if ( $var instanceof Closure
) {
872 if ( !is_array( $var ) ||
$maxDepth === 0 ) {
876 foreach ( $var as $value ) {
877 if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
885 * Merges the given values into a MW global array variable.
886 * Useful for setting some entries in a configuration array, instead of
887 * setting the entire array.
889 * @param string $name The name of the global, as in wgFooBar
890 * @param array $values The array containing the entries to set in that global
892 * @throws MWException If the designated global is not an array.
894 * @note To allow changes to global variables to take effect on global service instances,
895 * call overrideMwServices().
899 protected function mergeMwGlobalArrayValue( $name, $values ) {
900 if ( !isset( $GLOBALS[$name] ) ) {
903 if ( !is_array( $GLOBALS[$name] ) ) {
904 throw new MWException( "MW global $name is not an array." );
907 // NOTE: do not use array_merge, it screws up for numeric keys.
908 $merged = $GLOBALS[$name];
909 foreach ( $values as $k => $v ) {
914 $this->setMwGlobals( $name, $merged );
918 * Stashes the global instance of MediaWikiServices, and installs a new one,
919 * allowing test cases to override settings and services.
920 * The previous instance of MediaWikiServices will be restored on tearDown.
924 * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
926 * @param callable[] $services An associative array of services to re-define. Keys are service
927 * names, values are callables.
929 * @return MediaWikiServices
930 * @throws MWException
932 protected function overrideMwServices( Config
$configOverrides = null, array $services = [] ) {
933 if ( !$configOverrides ) {
934 $configOverrides = new HashConfig();
937 $oldInstance = MediaWikiServices
::getInstance();
938 $oldConfigFactory = $oldInstance->getConfigFactory();
939 $oldLoadBalancerFactory = $oldInstance->getDBLoadBalancerFactory();
941 $testConfig = self
::makeTestConfig( null, $configOverrides );
942 $newInstance = new MediaWikiServices( $testConfig );
944 // Load the default wiring from the specified files.
945 // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
946 $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
947 $newInstance->loadWiringFiles( $wiringFiles );
949 // Provide a traditional hook point to allow extensions to configure services.
950 Hooks
::run( 'MediaWikiServices', [ $newInstance ] );
952 foreach ( $services as $name => $callback ) {
953 $newInstance->redefineService( $name, $callback );
956 self
::installTestServices(
958 $oldLoadBalancerFactory,
961 MediaWikiServices
::forceGlobalInstance( $newInstance );
968 * @param string|Language $lang
970 public function setUserLang( $lang ) {
971 RequestContext
::getMain()->setLanguage( $lang );
972 $this->setMwGlobals( 'wgLang', RequestContext
::getMain()->getLanguage() );
977 * @param string|Language $lang
979 public function setContentLang( $lang ) {
980 if ( $lang instanceof Language
) {
981 $langCode = $lang->getCode();
985 $langObj = Language
::factory( $langCode );
987 $this->setMwGlobals( [
988 'wgLanguageCode' => $langCode,
989 'wgContLang' => $langObj,
994 * Alters $wgGroupPermissions for the duration of the test. Can be called
995 * with an array, like
996 * [ '*' => [ 'read' => false ], 'user' => [ 'read' => false ] ]
997 * or three values to set a single permission, like
998 * $this->setGroupPermissions( '*', 'read', false );
1001 * @param array|string $newPerms Either an array of permissions to change,
1002 * in which case the next two parameters are ignored; or a single string
1003 * identifying a group, to use with the next two parameters.
1004 * @param string|null $newKey
1005 * @param mixed|null $newValue
1007 public function setGroupPermissions( $newPerms, $newKey = null, $newValue = null ) {
1008 global $wgGroupPermissions;
1010 $this->stashMwGlobals( 'wgGroupPermissions' );
1012 if ( is_string( $newPerms ) ) {
1013 $newPerms = [ $newPerms => [ $newKey => $newValue ] ];
1016 foreach ( $newPerms as $group => $permissions ) {
1017 foreach ( $permissions as $key => $value ) {
1018 $wgGroupPermissions[$group][$key] = $value;
1024 * Sets the logger for a specified channel, for the duration of the test.
1026 * @param string $channel
1027 * @param LoggerInterface $logger
1029 protected function setLogger( $channel, LoggerInterface
$logger ) {
1030 // TODO: Once loggers are managed by MediaWikiServices, use
1031 // overrideMwServices() to set loggers.
1033 $provider = LoggerFactory
::getProvider();
1034 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
1035 $singletons = $wrappedProvider->singletons
;
1036 if ( $provider instanceof MonologSpi
) {
1037 if ( !isset( $this->loggers
[$channel] ) ) {
1038 $this->loggers
[$channel] = $singletons['loggers'][$channel] ??
null;
1040 $singletons['loggers'][$channel] = $logger;
1041 } elseif ( $provider instanceof LegacySpi
) {
1042 if ( !isset( $this->loggers
[$channel] ) ) {
1043 $this->loggers
[$channel] = $singletons[$channel] ??
null;
1045 $singletons[$channel] = $logger;
1047 throw new LogicException( __METHOD__
. ': setting a logger for ' . get_class( $provider )
1048 . ' is not implemented' );
1050 $wrappedProvider->singletons
= $singletons;
1054 * Restores loggers replaced by setLogger().
1057 private function restoreLoggers() {
1058 $provider = LoggerFactory
::getProvider();
1059 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
1060 $singletons = $wrappedProvider->singletons
;
1061 foreach ( $this->loggers
as $channel => $logger ) {
1062 if ( $provider instanceof MonologSpi
) {
1063 if ( $logger === null ) {
1064 unset( $singletons['loggers'][$channel] );
1066 $singletons['loggers'][$channel] = $logger;
1068 } elseif ( $provider instanceof LegacySpi
) {
1069 if ( $logger === null ) {
1070 unset( $singletons[$channel] );
1072 $singletons[$channel] = $logger;
1076 $wrappedProvider->singletons
= $singletons;
1077 $this->loggers
= [];
1084 public function dbPrefix() {
1085 return self
::getTestPrefixFor( $this->db
);
1089 * @param IDatabase $db
1093 public static function getTestPrefixFor( IDatabase
$db ) {
1094 return $db->getType() == 'oracle' ? self
::ORA_DB_PREFIX
: self
::DB_PREFIX
;
1101 public function needsDB() {
1102 // If the test says it uses database tables, it needs the database
1103 if ( $this->tablesUsed
) {
1107 // If the test class says it belongs to the Database group, it needs the database.
1108 // NOTE: This ONLY checks for the group in the class level doc comment.
1109 $rc = new ReflectionClass( $this );
1110 if ( preg_match( '/@group +Database/im', $rc->getDocComment() ) ) {
1118 * Insert a new page.
1120 * Should be called from addDBData().
1122 * @since 1.25 ($namespace in 1.28)
1123 * @param string|Title $pageName Page name or title
1124 * @param string $text Page's content
1125 * @param int|null $namespace Namespace id (name cannot already contain namespace)
1126 * @param User|null $user If null, static::getTestSysop()->getUser() is used.
1127 * @return array Title object and page id
1129 protected function insertPage(
1131 $text = 'Sample page for unit test.',
1135 if ( is_string( $pageName ) ) {
1136 $title = Title
::newFromText( $pageName, $namespace );
1142 $user = static::getTestSysop()->getUser();
1144 $comment = __METHOD__
. ': Sample page for unit test.';
1146 $page = WikiPage
::factory( $title );
1147 $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $comment, 0, false, $user );
1151 'id' => $page->getId(),
1156 * Stub. If a test suite needs to add additional data to the database, it should
1157 * implement this method and do so. This method is called once per test suite
1158 * (i.e. once per class).
1160 * Note data added by this method may be removed by resetDB() depending on
1161 * the contents of $tablesUsed.
1163 * To add additional data between test function runs, override prepareDB().
1170 public function addDBDataOnce() {
1174 * Stub. Subclasses may override this to prepare the database.
1175 * Called before every test run (test function or data set).
1177 * @see addDBDataOnce()
1182 public function addDBData() {
1188 protected function addCoreDBData() {
1189 if ( $this->db
->getType() == 'oracle' ) {
1190 # Insert 0 user to prevent FK violations
1192 if ( !$this->db
->selectField( 'user', '1', [ 'user_id' => 0 ] ) ) {
1193 $this->db
->insert( 'user', [
1195 'user_name' => 'Anonymous' ], __METHOD__
, [ 'IGNORE' ] );
1198 # Insert 0 page to prevent FK violations
1200 if ( !$this->db
->selectField( 'page', '1', [ 'page_id' => 0 ] ) ) {
1201 $this->db
->insert( 'page', [
1203 'page_namespace' => 0,
1204 'page_title' => ' ',
1205 'page_restrictions' => null,
1206 'page_is_redirect' => 0,
1209 'page_touched' => $this->db
->timestamp(),
1211 'page_len' => 0 ], __METHOD__
, [ 'IGNORE' ] );
1215 SiteStatsInit
::doPlaceholderInit();
1217 User
::resetIdByNameCache();
1220 $user = static::getTestSysop()->getUser();
1222 // Make 1 page with 1 revision
1223 $page = WikiPage
::factory( Title
::newFromText( 'UTPage' ) );
1224 if ( $page->getId() == 0 ) {
1225 $page->doEditContent(
1226 new WikitextContent( 'UTContent' ),
1228 EDIT_NEW | EDIT_SUPPRESS_RC
,
1232 // an edit always attempt to purge backlink links such as history
1233 // pages. That is unneccessary.
1234 JobQueueGroup
::singleton()->get( 'htmlCacheUpdate' )->delete();
1235 // WikiPages::doEditUpdates randomly adds RC purges
1236 JobQueueGroup
::singleton()->get( 'recentChangesUpdate' )->delete();
1238 // doEditContent() probably started the session via
1239 // User::loadFromSession(). Close it now.
1240 if ( session_id() !== '' ) {
1241 session_write_close();
1248 * Restores MediaWiki to using the table set (table prefix) it was using before
1249 * setupTestDB() was called. Useful if we need to perform database operations
1250 * after the test run has finished (such as saving logs or profiling info).
1252 * This is called by phpunit/bootstrap.php after the last test.
1256 public static function teardownTestDB() {
1257 global $wgJobClasses;
1259 if ( !self
::$dbSetup ) {
1263 Hooks
::run( 'UnitTestsBeforeDatabaseTeardown' );
1265 foreach ( $wgJobClasses as $type => $class ) {
1266 // Delete any jobs under the clone DB (or old prefix in other stores)
1267 JobQueueGroup
::singleton()->get( $type )->delete();
1270 CloneDatabase
::changePrefix( self
::$oldTablePrefix );
1272 self
::$oldTablePrefix = false;
1273 self
::$dbSetup = false;
1277 * Prepares the given database connection for usage in the context of usage tests.
1278 * This sets up clones database tables and changes the table prefix as appropriate.
1279 * If the database connection already has cloned tables, calling this method has no
1280 * effect. The tables are not re-cloned or reset in that case.
1282 * @param IMaintainableDatabase $db
1284 protected function prepareConnectionForTesting( IMaintainableDatabase
$db ) {
1285 if ( !self
::$dbSetup ) {
1286 throw new LogicException(
1287 'Cannot use prepareConnectionForTesting()'
1288 . ' if the test case is not defined to use the database!'
1292 if ( isset( $db->_originalTablePrefix
) ) {
1293 // The DB connection was already prepared for testing.
1297 $testPrefix = self
::getTestPrefixFor( $db );
1298 $oldPrefix = $db->tablePrefix();
1300 $tablesCloned = self
::listTables( $db );
1302 if ( $oldPrefix === $testPrefix ) {
1303 // The database connection already has the test prefix, but presumably not
1304 // the cloned tables. This is the typical case, since the LBFactory will
1305 // have the prefix set during testing, but LoadBalancers will still return
1306 // connections that don't have the cloned table structure.
1307 $oldPrefix = self
::$oldTablePrefix;
1310 $dbClone = new CloneDatabase( $db, $tablesCloned, $testPrefix, $oldPrefix );
1311 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1313 $db->_originalTablePrefix
= $oldPrefix;
1315 if ( ( $db->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
1316 throw new LogicException( 'Cannot clone database tables' );
1318 $dbClone->cloneTableStructure();
1323 * Setups a database with cloned tables using the given prefix.
1325 * If reuseDB is true and certain conditions apply, it will just change the prefix.
1326 * Otherwise, it will clone the tables and change the prefix.
1328 * @param IMaintainableDatabase $db Database to use
1329 * @param string|null $prefix Prefix to use for test tables. If not given, the prefix is determined
1330 * automatically for $db.
1331 * @return bool True if tables were cloned, false if only the prefix was changed
1333 protected static function setupDatabaseWithTestPrefix(
1334 IMaintainableDatabase
$db,
1337 if ( $prefix === null ) {
1338 $prefix = self
::getTestPrefixFor( $db );
1341 if ( ( $db->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
1342 $db->tablePrefix( $prefix );
1346 if ( !isset( $db->_originalTablePrefix
) ) {
1347 $oldPrefix = $db->tablePrefix();
1349 if ( $oldPrefix === $prefix ) {
1350 // table already has the correct prefix, but presumably no cloned tables
1351 $oldPrefix = self
::$oldTablePrefix;
1354 $db->tablePrefix( $oldPrefix );
1355 $tablesCloned = self
::listTables( $db );
1356 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix, $oldPrefix );
1357 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1359 $dbClone->cloneTableStructure();
1361 $db->tablePrefix( $prefix );
1362 $db->_originalTablePrefix
= $oldPrefix;
1369 * Set up all test DBs
1371 public function setupAllTestDBs() {
1374 self
::$oldTablePrefix = $wgDBprefix;
1376 $testPrefix = $this->dbPrefix();
1378 // switch to a temporary clone of the database
1379 self
::setupTestDB( $this->db
, $testPrefix );
1381 if ( self
::isUsingExternalStoreDB() ) {
1382 self
::setupExternalStoreTestDBs( $testPrefix );
1385 // NOTE: Change the prefix in the LBFactory and $wgDBprefix, to prevent
1386 // *any* database connections to operate on live data.
1387 CloneDatabase
::changePrefix( $testPrefix );
1391 * Creates an empty skeleton of the wiki database by cloning its structure
1392 * to equivalent tables using the given $prefix. Then sets MediaWiki to
1393 * use the new set of tables (aka schema) instead of the original set.
1395 * This is used to generate a dummy table set, typically consisting of temporary
1396 * tables, that will be used by tests instead of the original wiki database tables.
1400 * @note the original table prefix is stored in self::$oldTablePrefix. This is used
1401 * by teardownTestDB() to return the wiki to using the original table set.
1403 * @note this method only works when first called. Subsequent calls have no effect,
1404 * even if using different parameters.
1406 * @param Database $db The database connection
1407 * @param string $prefix The prefix to use for the new table set (aka schema).
1409 * @throws MWException If the database table prefix is already $prefix
1411 public static function setupTestDB( Database
$db, $prefix ) {
1412 if ( self
::$dbSetup ) {
1416 if ( $db->tablePrefix() === $prefix ) {
1417 throw new MWException(
1418 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
1421 // TODO: the below should be re-written as soon as LBFactory, LoadBalancer,
1422 // and Database no longer use global state.
1424 self
::$dbSetup = true;
1426 if ( !self
::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
1430 // Assuming this isn't needed for External Store database, and not sure if the procedure
1431 // would be available there.
1432 if ( $db->getType() == 'oracle' ) {
1433 $db->query( 'BEGIN FILL_WIKI_INFO; END;' );
1436 Hooks
::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
1440 * Clones the External Store database(s) for testing
1442 * @param string|null $testPrefix Prefix for test tables. Will be determined automatically
1445 protected static function setupExternalStoreTestDBs( $testPrefix = null ) {
1446 $connections = self
::getExternalStoreDatabaseConnections();
1447 foreach ( $connections as $dbw ) {
1448 self
::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
1453 * Gets master database connections for all of the ExternalStoreDB
1454 * stores configured in $wgDefaultExternalStore.
1456 * @return Database[] Array of Database master connections
1458 protected static function getExternalStoreDatabaseConnections() {
1459 global $wgDefaultExternalStore;
1461 /** @var ExternalStoreDB $externalStoreDB */
1462 $externalStoreDB = ExternalStore
::getStoreObject( 'DB' );
1463 $defaultArray = (array)$wgDefaultExternalStore;
1465 foreach ( $defaultArray as $url ) {
1466 if ( strpos( $url, 'DB://' ) === 0 ) {
1467 list( $proto, $cluster ) = explode( '://', $url, 2 );
1468 // Avoid getMaster() because setupDatabaseWithTestPrefix()
1469 // requires Database instead of plain DBConnRef/IDatabase
1470 $dbws[] = $externalStoreDB->getMaster( $cluster );
1478 * Check whether ExternalStoreDB is being used
1480 * @return bool True if it's being used
1482 protected static function isUsingExternalStoreDB() {
1483 global $wgDefaultExternalStore;
1484 if ( !$wgDefaultExternalStore ) {
1488 $defaultArray = (array)$wgDefaultExternalStore;
1489 foreach ( $defaultArray as $url ) {
1490 if ( strpos( $url, 'DB://' ) === 0 ) {
1499 * @throws LogicException if the given database connection is not a set up to use
1502 * @since 1.31 this is no longer private.
1504 protected function ensureMockDatabaseConnection( IDatabase
$db ) {
1505 if ( $db->tablePrefix() !== $this->dbPrefix() ) {
1506 throw new LogicException(
1507 'Trying to delete mock tables, but table prefix does not indicate a mock database.'
1512 private static $schemaOverrideDefaults = [
1520 * Stub. If a test suite needs to test against a specific database schema, it should
1521 * override this method and return the appropriate information from it.
1523 * @param IMaintainableDatabase $db The DB connection to use for the mock schema.
1524 * May be used to check the current state of the schema, to determine what
1525 * overrides are needed.
1527 * @return array An associative array with the following fields:
1528 * - 'scripts': any SQL scripts to run. If empty or not present, schema overrides are skipped.
1529 * - 'create': A list of tables created (may or may not exist in the original schema).
1530 * - 'drop': A list of tables dropped (expected to be present in the original schema).
1531 * - 'alter': A list of tables altered (expected to be present in the original schema).
1533 protected function getSchemaOverrides( IMaintainableDatabase
$db ) {
1538 * Undoes the specified schema overrides..
1539 * Called once per test class, just before addDataOnce().
1541 * @param IMaintainableDatabase $db
1542 * @param array $oldOverrides
1544 private function undoSchemaOverrides( IMaintainableDatabase
$db, $oldOverrides ) {
1545 $this->ensureMockDatabaseConnection( $db );
1547 $oldOverrides = $oldOverrides + self
::$schemaOverrideDefaults;
1548 $originalTables = $this->listOriginalTables( $db, 'unprefixed' );
1550 // Drop tables that need to be restored or removed.
1551 $tablesToDrop = array_merge( $oldOverrides['create'], $oldOverrides['alter'] );
1553 // Restore tables that have been dropped or created or altered,
1554 // if they exist in the original schema.
1555 $tablesToRestore = array_merge( $tablesToDrop, $oldOverrides['drop'] );
1556 $tablesToRestore = array_intersect( $originalTables, $tablesToRestore );
1558 if ( $tablesToDrop ) {
1559 $this->dropMockTables( $db, $tablesToDrop );
1562 if ( $tablesToRestore ) {
1563 $this->recloneMockTables( $db, $tablesToRestore );
1568 * Applies the schema overrides returned by getSchemaOverrides(),
1569 * after undoing any previously applied schema overrides.
1570 * Called once per test class, just before addDataOnce().
1572 private function setUpSchema( IMaintainableDatabase
$db ) {
1573 // Undo any active overrides.
1574 $oldOverrides = $db->_schemaOverrides ?? self
::$schemaOverrideDefaults;
1576 if ( $oldOverrides['alter'] ||
$oldOverrides['create'] ||
$oldOverrides['drop'] ) {
1577 $this->undoSchemaOverrides( $db, $oldOverrides );
1580 // Determine new overrides.
1581 $overrides = $this->getSchemaOverrides( $db ) + self
::$schemaOverrideDefaults;
1583 $extraKeys = array_diff(
1584 array_keys( $overrides ),
1585 array_keys( self
::$schemaOverrideDefaults )
1589 throw new InvalidArgumentException(
1590 'Schema override contains extra keys: ' . var_export( $extraKeys, true )
1594 if ( !$overrides['scripts'] ) {
1595 // no scripts to run
1599 if ( !$overrides['create'] && !$overrides['drop'] && !$overrides['alter'] ) {
1600 throw new InvalidArgumentException(
1601 'Schema override scripts given, but no tables are declared to be '
1602 . 'created, dropped or altered.'
1606 $this->ensureMockDatabaseConnection( $db );
1608 // Drop the tables that will be created by the schema scripts.
1609 $originalTables = $this->listOriginalTables( $db, 'unprefixed' );
1610 $tablesToDrop = array_intersect( $originalTables, $overrides['create'] );
1612 if ( $tablesToDrop ) {
1613 $this->dropMockTables( $db, $tablesToDrop );
1616 // Run schema override scripts.
1617 foreach ( $overrides['scripts'] as $script ) {
1624 return $this->mungeSchemaUpdateQuery( $cmd );
1629 $db->_schemaOverrides
= $overrides;
1632 private function mungeSchemaUpdateQuery( $cmd ) {
1633 return self
::$useTemporaryTables
1634 ?
preg_replace( '/\bCREATE\s+TABLE\b/i', 'CREATE TEMPORARY TABLE', $cmd )
1639 * Drops the given mock tables.
1641 * @param IMaintainableDatabase $db
1642 * @param array $tables
1644 private function dropMockTables( IMaintainableDatabase
$db, array $tables ) {
1645 $this->ensureMockDatabaseConnection( $db );
1647 foreach ( $tables as $tbl ) {
1648 $tbl = $db->tableName( $tbl );
1649 $db->query( "DROP TABLE IF EXISTS $tbl", __METHOD__
);
1651 if ( $tbl === 'page' ) {
1652 // Forget about the pages since they don't
1654 MediaWikiServices
::getInstance()->getLinkCache()->clear();
1660 * Lists all tables in the live database schema.
1662 * @param IMaintainableDatabase $db
1663 * @param string $prefix Either 'prefixed' or 'unprefixed'
1666 private function listOriginalTables( IMaintainableDatabase
$db, $prefix = 'prefixed' ) {
1667 if ( !isset( $db->_originalTablePrefix
) ) {
1668 throw new LogicException( 'No original table prefix know, cannot list tables!' );
1671 $originalTables = $db->listTables( $db->_originalTablePrefix
, __METHOD__
);
1672 if ( $prefix === 'unprefixed' ) {
1673 $originalPrefixRegex = '/^' . preg_quote( $db->_originalTablePrefix
) . '/';
1674 $originalTables = array_map(
1675 function ( $pt ) use ( $originalPrefixRegex ) {
1676 return preg_replace( $originalPrefixRegex, '', $pt );
1682 return $originalTables;
1686 * Re-clones the given mock tables to restore them based on the live database schema.
1687 * The tables listed in $tables are expected to currently not exist, so dropMockTables()
1688 * should be called first.
1690 * @param IMaintainableDatabase $db
1691 * @param array $tables
1693 private function recloneMockTables( IMaintainableDatabase
$db, array $tables ) {
1694 $this->ensureMockDatabaseConnection( $db );
1696 if ( !isset( $db->_originalTablePrefix
) ) {
1697 throw new LogicException( 'No original table prefix know, cannot restore tables!' );
1700 $originalTables = $this->listOriginalTables( $db, 'unprefixed' );
1701 $tables = array_intersect( $tables, $originalTables );
1703 $dbClone = new CloneDatabase( $db, $tables, $db->tablePrefix(), $db->_originalTablePrefix
);
1704 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1706 $dbClone->cloneTableStructure();
1710 * Empty all tables so they can be repopulated for tests
1712 * @param Database $db|null Database to reset
1713 * @param array $tablesUsed Tables to reset
1715 private function resetDB( $db, $tablesUsed ) {
1717 $userTables = [ 'user', 'user_groups', 'user_properties', 'actor' ];
1719 'page', 'revision', 'ip_changes', 'revision_comment_temp', 'comment', 'archive',
1720 'revision_actor_temp', 'slots', 'content', 'content_models', 'slot_roles',
1722 $coreDBDataTables = array_merge( $userTables, $pageTables );
1724 // If any of the user or page tables were marked as used, we should clear all of them.
1725 if ( array_intersect( $tablesUsed, $userTables ) ) {
1726 $tablesUsed = array_unique( array_merge( $tablesUsed, $userTables ) );
1727 TestUserRegistry
::clear();
1729 if ( array_intersect( $tablesUsed, $pageTables ) ) {
1730 $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
1733 // Postgres, Oracle, and MSSQL all use mwuser/pagecontent
1734 // instead of user/text. But Postgres does not remap the
1735 // table name in tableExists(), so we mark the real table
1736 // names as being used.
1737 if ( $db->getType() === 'postgres' ) {
1738 if ( in_array( 'user', $tablesUsed ) ) {
1739 $tablesUsed[] = 'mwuser';
1741 if ( in_array( 'text', $tablesUsed ) ) {
1742 $tablesUsed[] = 'pagecontent';
1746 $truncate = in_array( $db->getType(), [ 'oracle', 'mysql' ] );
1747 foreach ( $tablesUsed as $tbl ) {
1748 if ( !$db->tableExists( $tbl ) ) {
1753 $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tbl ), __METHOD__
);
1755 $db->delete( $tbl, '*', __METHOD__
);
1758 if ( in_array( $db->getType(), [ 'postgres', 'sqlite' ], true ) ) {
1759 // Reset the table's sequence too.
1760 $db->resetSequenceForTable( $tbl, __METHOD__
);
1763 if ( $tbl === 'interwiki' ) {
1764 if ( !$this->interwikiTable
) {
1765 // @todo We should probably throw here, but this causes test failures that I
1766 // can't figure out, so for now we silently continue.
1771 array_map( 'get_object_vars', iterator_to_array( $this->interwikiTable
) ),
1776 if ( $tbl === 'page' ) {
1777 // Forget about the pages since they don't
1779 MediaWikiServices
::getInstance()->getLinkCache()->clear();
1783 if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
1784 // Re-add core DB data that was deleted
1785 $this->addCoreDBData();
1790 private static function unprefixTable( &$tableName, $ind, $prefix ) {
1791 $tableName = substr( $tableName, strlen( $prefix ) );
1794 private static function isNotUnittest( $table ) {
1795 return strpos( $table, self
::DB_PREFIX
) !== 0;
1801 * @param IMaintainableDatabase $db
1805 public static function listTables( IMaintainableDatabase
$db ) {
1806 $prefix = $db->tablePrefix();
1807 $tables = $db->listTables( $prefix, __METHOD__
);
1809 if ( $db->getType() === 'mysql' ) {
1810 static $viewListCache = null;
1811 if ( $viewListCache === null ) {
1812 $viewListCache = $db->listViews( null, __METHOD__
);
1814 // T45571: cannot clone VIEWs under MySQL
1815 $tables = array_diff( $tables, $viewListCache );
1817 array_walk( $tables, [ __CLASS__
, 'unprefixTable' ], $prefix );
1819 // Don't duplicate test tables from the previous fataled run
1820 $tables = array_filter( $tables, [ __CLASS__
, 'isNotUnittest' ] );
1822 if ( $db->getType() == 'sqlite' ) {
1823 $tables = array_flip( $tables );
1824 // these are subtables of searchindex and don't need to be duped/dropped separately
1825 unset( $tables['searchindex_content'] );
1826 unset( $tables['searchindex_segdir'] );
1827 unset( $tables['searchindex_segments'] );
1828 $tables = array_flip( $tables );
1835 * Copy test data from one database connection to another.
1837 * This should only be used for small data sets.
1839 * @param IDatabase $source
1840 * @param IDatabase $target
1842 public function copyTestData( IDatabase
$source, IDatabase
$target ) {
1843 $tables = self
::listOriginalTables( $source, 'unprefixed' );
1845 foreach ( $tables as $table ) {
1846 $res = $source->select( $table, '*', [], __METHOD__
);
1849 foreach ( $res as $row ) {
1850 $allRows[] = (array)$row;
1853 $target->insert( $table, $allRows, __METHOD__
, [ 'IGNORE' ] );
1858 * @throws MWException
1861 protected function checkDbIsSupported() {
1862 if ( !in_array( $this->db
->getType(), $this->supportedDBs
) ) {
1863 throw new MWException( $this->db
->getType() . " is not currently supported for unit testing." );
1869 * @param string $offset
1872 public function getCliArg( $offset ) {
1873 if ( isset( PHPUnitMaintClass
::$additionalOptions[$offset] ) ) {
1874 return PHPUnitMaintClass
::$additionalOptions[$offset];
1882 * @param string $offset
1883 * @param mixed $value
1885 public function setCliArg( $offset, $value ) {
1886 PHPUnitMaintClass
::$additionalOptions[$offset] = $value;
1890 * Don't throw a warning if $function is deprecated and called later
1894 * @param string $function
1896 public function hideDeprecated( $function ) {
1897 Wikimedia\
suppressWarnings();
1898 wfDeprecated( $function );
1899 Wikimedia\restoreWarnings
();
1903 * Asserts that the given database query yields the rows given by $expectedRows.
1904 * The expected rows should be given as indexed (not associative) arrays, with
1905 * the values given in the order of the columns in the $fields parameter.
1906 * Note that the rows are sorted by the columns given in $fields.
1910 * @param string|array $table The table(s) to query
1911 * @param string|array $fields The columns to include in the result (and to sort by)
1912 * @param string|array $condition "where" condition(s)
1913 * @param array $expectedRows An array of arrays giving the expected rows.
1914 * @param array $options Options for the query
1915 * @param array $join_conds Join conditions for the query
1917 * @throws MWException If this test cases's needsDB() method doesn't return true.
1918 * Test cases can use "@group Database" to enable database test support,
1919 * or list the tables under testing in $this->tablesUsed, or override the
1922 protected function assertSelect(
1923 $table, $fields, $condition, array $expectedRows, array $options = [], array $join_conds = []
1925 if ( !$this->needsDB() ) {
1926 throw new MWException( 'When testing database state, the test cases\'s needDB()' .
1927 ' method should return true. Use @group Database or $this->tablesUsed.' );
1930 $db = wfGetDB( DB_REPLICA
);
1937 $options +
[ 'ORDER BY' => $fields ],
1940 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
1944 foreach ( $expectedRows as $expected ) {
1945 $r = $res->fetchRow();
1946 self
::stripStringKeys( $r );
1949 $this->assertNotEmpty( $r, "row #$i missing" );
1951 $this->assertEquals( $expected, $r, "row #$i mismatches" );
1954 $r = $res->fetchRow();
1955 self
::stripStringKeys( $r );
1957 $this->assertFalse( $r, "found extra row (after #$i)" );
1961 * Utility method taking an array of elements and wrapping
1962 * each element in its own array. Useful for data providers
1963 * that only return a single argument.
1967 * @param array $elements
1971 protected function arrayWrap( array $elements ) {
1973 function ( $element ) {
1974 return [ $element ];
1981 * Assert that two arrays are equal. By default this means that both arrays need to hold
1982 * the same set of values. Using additional arguments, order and associated key can also
1983 * be set as relevant.
1987 * @param array $expected
1988 * @param array $actual
1989 * @param bool $ordered If the order of the values should match
1990 * @param bool $named If the keys should match
1992 protected function assertArrayEquals( array $expected, array $actual,
1993 $ordered = false, $named = false
1996 $this->objectAssociativeSort( $expected );
1997 $this->objectAssociativeSort( $actual );
2001 $expected = array_values( $expected );
2002 $actual = array_values( $actual );
2005 call_user_func_array(
2006 [ $this, 'assertEquals' ],
2007 array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
2012 * Put each HTML element on its own line and then equals() the results
2014 * Use for nicely formatting of PHPUnit diff output when comparing very
2019 * @param string $expected HTML on oneline
2020 * @param string $actual HTML on oneline
2021 * @param string $msg Optional message
2023 protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
2024 $expected = str_replace( '>', ">\n", $expected );
2025 $actual = str_replace( '>', ">\n", $actual );
2027 $this->assertEquals( $expected, $actual, $msg );
2031 * Does an associative sort that works for objects.
2035 * @param array &$array
2037 protected function objectAssociativeSort( array &$array ) {
2040 function ( $a, $b ) {
2041 return serialize( $a ) <=> serialize( $b );
2047 * Utility function for eliminating all string keys from an array.
2048 * Useful to turn a database result row as returned by fetchRow() into
2049 * a pure indexed array.
2053 * @param mixed &$r The array to remove string keys from.
2055 protected static function stripStringKeys( &$r ) {
2056 if ( !is_array( $r ) ) {
2060 foreach ( $r as $k => $v ) {
2061 if ( is_string( $k ) ) {
2068 * Asserts that the provided variable is of the specified
2069 * internal type or equals the $value argument. This is useful
2070 * for testing return types of functions that return a certain
2071 * type or *value* when not set or on error.
2075 * @param string $type
2076 * @param mixed $actual
2077 * @param mixed $value
2078 * @param string $message
2080 protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
2081 if ( $actual === $value ) {
2082 $this->assertTrue( true, $message );
2084 $this->assertType( $type, $actual, $message );
2089 * Asserts the type of the provided value. This can be either
2090 * in internal type such as boolean or integer, or a class or
2091 * interface the value extends or implements.
2095 * @param string $type
2096 * @param mixed $actual
2097 * @param string $message
2099 protected function assertType( $type, $actual, $message = '' ) {
2100 if ( class_exists( $type ) ||
interface_exists( $type ) ) {
2101 $this->assertInstanceOf( $type, $actual, $message );
2103 $this->assertInternalType( $type, $actual, $message );
2108 * Returns true if the given namespace defaults to Wikitext
2109 * according to $wgNamespaceContentModels
2111 * @param int $ns The namespace ID to check
2116 protected function isWikitextNS( $ns ) {
2117 global $wgNamespaceContentModels;
2119 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
2120 return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
;
2127 * Returns the ID of a namespace that defaults to Wikitext.
2129 * @throws MWException If there is none.
2130 * @return int The ID of the wikitext Namespace
2133 protected function getDefaultWikitextNS() {
2134 global $wgNamespaceContentModels;
2136 static $wikitextNS = null; // this is not going to change
2137 if ( $wikitextNS !== null ) {
2141 // quickly short out on most common case:
2142 if ( !isset( $wgNamespaceContentModels[NS_MAIN
] ) ) {
2146 // NOTE: prefer content namespaces
2147 $namespaces = array_unique( array_merge(
2148 MWNamespace
::getContentNamespaces(),
2149 [ NS_MAIN
, NS_HELP
, NS_PROJECT
], // prefer these
2150 MWNamespace
::getValidNamespaces()
2153 $namespaces = array_diff( $namespaces, [
2154 NS_FILE
, NS_CATEGORY
, NS_MEDIAWIKI
, NS_USER
// don't mess with magic namespaces
2157 $talk = array_filter( $namespaces, function ( $ns ) {
2158 return MWNamespace
::isTalk( $ns );
2161 // prefer non-talk pages
2162 $namespaces = array_diff( $namespaces, $talk );
2163 $namespaces = array_merge( $namespaces, $talk );
2165 // check default content model of each namespace
2166 foreach ( $namespaces as $ns ) {
2167 if ( !isset( $wgNamespaceContentModels[$ns] ) ||
2168 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
2177 // @todo Inside a test, we could skip the test as incomplete.
2178 // But frequently, this is used in fixture setup.
2179 throw new MWException( "No namespace defaults to wikitext!" );
2183 * Check, if $wgDiff3 is set and ready to merge
2184 * Will mark the calling test as skipped, if not ready
2188 protected function markTestSkippedIfNoDiff3() {
2191 # This check may also protect against code injection in
2192 # case of broken installations.
2193 Wikimedia\
suppressWarnings();
2194 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2195 Wikimedia\restoreWarnings
();
2197 if ( !$haveDiff3 ) {
2198 $this->markTestSkipped( "Skip test, since diff3 is not configured" );
2203 * Check if $extName is a loaded PHP extension, will skip the
2204 * test whenever it is not loaded.
2207 * @param string $extName
2210 protected function checkPHPExtension( $extName ) {
2211 $loaded = extension_loaded( $extName );
2213 $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
2220 * Skip the test if using the specified database type
2222 * @param string $type Database type
2225 protected function markTestSkippedIfDbType( $type ) {
2226 if ( $this->db
->getType() === $type ) {
2227 $this->markTestSkipped( "The $type database type isn't supported for this test" );
2232 * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
2233 * @param string $buffer
2236 public static function wfResetOutputBuffersBarrier( $buffer ) {
2241 * Create a temporary hook handler which will be reset by tearDown.
2242 * This replaces other handlers for the same hook.
2243 * @param string $hookName Hook name
2244 * @param mixed $handler Value suitable for a hook handler
2247 protected function setTemporaryHook( $hookName, $handler ) {
2248 $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
2252 * Check whether file contains given data.
2253 * @param string $fileName
2254 * @param string $actualData
2255 * @param bool $createIfMissing If true, and file does not exist, create it with given data
2256 * and skip the test.
2257 * @param string $msg
2260 protected function assertFileContains(
2263 $createIfMissing = true,
2266 if ( $createIfMissing ) {
2267 if ( !file_exists( $fileName ) ) {
2268 file_put_contents( $fileName, $actualData );
2269 $this->markTestSkipped( 'Data file $fileName does not exist' );
2272 self
::assertFileExists( $fileName );
2274 self
::assertEquals( file_get_contents( $fileName ), $actualData, $msg );
2278 * Edits or creates a page/revision
2279 * @param string $pageName Page title
2280 * @param string $text Content of the page
2281 * @param string $summary Optional summary string for the revision
2282 * @param int $defaultNs Optional namespace id
2283 * @return array Array as returned by WikiPage::doEditContent()
2285 protected function editPage( $pageName, $text, $summary = '', $defaultNs = NS_MAIN
) {
2286 $title = Title
::newFromText( $pageName, $defaultNs );
2287 $page = WikiPage
::factory( $title );
2289 return $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $summary );
2293 * Revision-deletes a revision.
2295 * @param Revision|int $rev Revision to delete
2296 * @param array $value Keys are Revision::DELETED_* flags. Values are 1 to set the bit, 0 to
2297 * clear, -1 to leave alone. (All other values also clear the bit.)
2298 * @param string $comment Deletion comment
2300 protected function revisionDelete(
2301 $rev, array $value = [ Revision
::DELETED_TEXT
=> 1 ], $comment = ''
2303 if ( is_int( $rev ) ) {
2304 $rev = Revision
::newFromId( $rev );
2306 RevisionDeleter
::createList(
2307 'revision', RequestContext
::getMain(), $rev->getTitle(), [ $rev->getId() ]
2310 'comment' => $comment,