3 use MediaWiki\Logger\LegacySpi
;
4 use MediaWiki\Logger\LoggerFactory
;
5 use MediaWiki\Logger\MonologSpi
;
6 use MediaWiki\Logger\LogCapturingSpi
;
7 use MediaWiki\MediaWikiServices
;
8 use Psr\Log\LoggerInterface
;
9 use Wikimedia\Rdbms\IDatabase
;
10 use Wikimedia\Rdbms\IMaintainableDatabase
;
11 use Wikimedia\Rdbms\Database
;
12 use Wikimedia\TestingAccessWrapper
;
17 abstract class MediaWikiTestCase
extends PHPUnit\Framework\TestCase
{
19 use MediaWikiCoversValidator
;
20 use PHPUnit4And6Compat
;
23 * The original service locator. This is overridden during setUp().
25 * @var MediaWikiServices|null
27 private static $originalServices;
30 * The local service locator, created during setUp().
31 * @var MediaWikiServices
33 private $localServices;
36 * $called tracks whether the setUp and tearDown method has been called.
37 * class extending MediaWikiTestCase usually override setUp and tearDown
38 * but forget to call the parent.
40 * The array format takes a method name as key and anything as a value.
41 * By asserting the key exist, we know the child class has called the
44 * This property must be private, we do not want child to override it,
45 * they should call the appropriate parent method instead.
67 protected $tablesUsed = []; // tables with data
69 private static $useTemporaryTables = true;
70 private static $reuseDB = false;
71 private static $dbSetup = false;
72 private static $oldTablePrefix = '';
75 * Original value of PHP's error_reporting setting.
79 private $phpErrorLevel;
82 * Holds the paths of temporary files/directories created through getNewTempFile,
83 * and getNewTempDirectory
87 private $tmpFiles = [];
90 * Holds original values of MediaWiki configuration settings
91 * to be restored in tearDown().
92 * See also setMwGlobals().
95 private $mwGlobals = [];
98 * Holds list of MediaWiki configuration settings to be unset in tearDown().
99 * See also setMwGlobals().
102 private $mwGlobalsToUnset = [];
105 * Holds original values of ini settings to be restored
107 * @see setIniSettings()
110 private $iniSettings = [];
113 * Holds original loggers which have been replaced by setLogger()
114 * @var LoggerInterface[]
116 private $loggers = [];
119 * The CLI arguments passed through from phpunit.php
122 private $cliArgs = [];
125 * Holds a list of services that were overridden with setService(). Used for printing an error
126 * if overrideMwServices() overrides a service that was previously set.
129 private $overriddenServices = [];
132 * Table name prefixes. Oracle likes it shorter.
134 const DB_PREFIX
= 'unittest_';
135 const ORA_DB_PREFIX
= 'ut_';
141 protected $supportedDBs = [
148 public function __construct( $name = null, array $data = [], $dataName = '' ) {
149 parent
::__construct( $name, $data, $dataName );
151 $this->backupGlobals
= false;
152 $this->backupStaticAttributes
= false;
155 public function __destruct() {
156 // Complain if self::setUp() was called, but not self::tearDown()
157 // $this->called['setUp'] will be checked by self::testMediaWikiTestCaseParentSetupCalled()
158 if ( isset( $this->called
['setUp'] ) && !isset( $this->called
['tearDown'] ) ) {
159 throw new MWException( static::class . "::tearDown() must call parent::tearDown()" );
163 public static function setUpBeforeClass() {
164 parent
::setUpBeforeClass();
166 // Get the original service locator
167 if ( !self
::$originalServices ) {
168 self
::$originalServices = MediaWikiServices
::getInstance();
173 * Convenience method for getting an immutable test user
177 * @param string|string[] $groups Groups the test user should be in.
180 public static function getTestUser( $groups = [] ) {
181 return TestUserRegistry
::getImmutableTestUser( $groups );
185 * Convenience method for getting a mutable test user
189 * @param string|string[] $groups Groups the test user should be added in.
192 public static function getMutableTestUser( $groups = [] ) {
193 return TestUserRegistry
::getMutableTestUser( __CLASS__
, $groups );
197 * Convenience method for getting an immutable admin test user
201 * @param string[] $groups Groups the test user should be added to.
204 public static function getTestSysop() {
205 return self
::getTestUser( [ 'sysop', 'bureaucrat' ] );
209 * Returns a WikiPage representing an existing page.
213 * @param Title|string|null $title
215 * @throws MWException If this test cases's needsDB() method doesn't return true.
216 * Test cases can use "@group Database" to enable database test support,
217 * or list the tables under testing in $this->tablesUsed, or override the
220 protected function getExistingTestPage( $title = null ) {
221 if ( !$this->needsDB() ) {
222 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
223 ' method should return true. Use @group Database or $this->tablesUsed.' );
226 $title = ( $title === null ) ?
'UTPage' : $title;
227 $title = is_string( $title ) ? Title
::newFromText( $title ) : $title;
228 $page = WikiPage
::factory( $title );
230 if ( !$page->exists() ) {
231 $user = self
::getTestSysop()->getUser();
232 $page->doEditContent(
233 new WikitextContent( 'UTContent' ),
235 EDIT_NEW | EDIT_SUPPRESS_RC
,
245 * Returns a WikiPage representing a non-existing page.
249 * @param Title|string|null $title
251 * @throws MWException If this test cases's needsDB() method doesn't return true.
252 * Test cases can use "@group Database" to enable database test support,
253 * or list the tables under testing in $this->tablesUsed, or override the
256 protected function getNonexistingTestPage( $title = null ) {
257 if ( !$this->needsDB() ) {
258 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
259 ' method should return true. Use @group Database or $this->tablesUsed.' );
262 $title = ( $title === null ) ?
'UTPage-' . rand( 0, 100000 ) : $title;
263 $title = is_string( $title ) ? Title
::newFromText( $title ) : $title;
264 $page = WikiPage
::factory( $title );
266 if ( $page->exists() ) {
267 $page->doDeleteArticle( 'Testing' );
274 * @deprecated since 1.32
276 public static function prepareServices( Config
$bootstrapConfig ) {
280 * Create a config suitable for testing, based on a base config, default overrides,
281 * and custom overrides.
283 * @param Config|null $baseConfig
284 * @param Config|null $customOverrides
288 private static function makeTestConfig(
289 Config
$baseConfig = null,
290 Config
$customOverrides = null
292 $defaultOverrides = new HashConfig();
294 if ( !$baseConfig ) {
295 $baseConfig = self
::$originalServices->getBootstrapConfig();
298 /* Some functions require some kind of caching, and will end up using the db,
299 * which we can't allow, as that would open a new connection for mysql.
300 * Replace with a HashBag. They would not be going to persist anyway.
302 $hashCache = [ 'class' => HashBagOStuff
::class, 'reportDupes' => false ];
304 CACHE_DB
=> $hashCache,
305 CACHE_ACCEL
=> $hashCache,
306 CACHE_MEMCACHED
=> $hashCache,
308 'apcu' => $hashCache,
309 'wincache' => $hashCache,
310 ] +
$baseConfig->get( 'ObjectCaches' );
312 $defaultOverrides->set( 'ObjectCaches', $objectCaches );
313 $defaultOverrides->set( 'MainCacheType', CACHE_NONE
);
314 $defaultOverrides->set( 'JobTypeConf', [ 'default' => [ 'class' => JobQueueMemory
::class ] ] );
316 // Use a fast hash algorithm to hash passwords.
317 $defaultOverrides->set( 'PasswordDefault', 'A' );
319 $testConfig = $customOverrides
320 ?
new MultiConfig( [ $customOverrides, $defaultOverrides, $baseConfig ] )
321 : new MultiConfig( [ $defaultOverrides, $baseConfig ] );
327 * @param ConfigFactory $oldFactory
328 * @param Config[] $configurations
332 private static function makeTestConfigFactoryInstantiator(
333 ConfigFactory
$oldFactory,
334 array $configurations
336 return function ( MediaWikiServices
$services ) use ( $oldFactory, $configurations ) {
337 $factory = new ConfigFactory();
339 // clone configurations from $oldFactory that are not overwritten by $configurations
340 $namesToClone = array_diff(
341 $oldFactory->getConfigNames(),
342 array_keys( $configurations )
345 foreach ( $namesToClone as $name ) {
346 $factory->register( $name, $oldFactory->makeConfig( $name ) );
349 foreach ( $configurations as $name => $config ) {
350 $factory->register( $name, $config );
358 * Resets some non-service singleton instances and other static caches. It's not necessary to
359 * reset services here.
361 public static function resetNonServiceCaches() {
362 global $wgRequest, $wgJobClasses;
364 foreach ( $wgJobClasses as $type => $class ) {
365 JobQueueGroup
::singleton()->get( $type )->delete();
367 JobQueueGroup
::destroySingletons();
369 ObjectCache
::clear();
370 FileBackendGroup
::destroySingleton();
371 DeferredUpdates
::clearPendingUpdates();
373 // TODO: move global state into MediaWikiServices
374 RequestContext
::resetMain();
375 if ( session_id() !== '' ) {
376 session_write_close();
380 $wgRequest = new FauxRequest();
381 MediaWiki\Session\SessionManager
::resetCache();
384 public function run( PHPUnit_Framework_TestResult
$result = null ) {
385 if ( $result instanceof MediaWikiTestResult
) {
386 $this->cliArgs
= $result->getMediaWikiCliArgs();
388 $this->overrideMwServices();
390 if ( $this->needsDB() && !$this->isTestInDatabaseGroup() ) {
392 get_class( $this ) . ' apparently needsDB but is not in the Database group'
396 $needsResetDB = false;
397 if ( !self
::$dbSetup ||
$this->needsDB() ) {
398 // set up a DB connection for this test to use
400 self
::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
401 self
::$reuseDB = $this->getCliArg( 'reuse-db' );
403 $this->db
= wfGetDB( DB_MASTER
);
405 $this->checkDbIsSupported();
407 if ( !self
::$dbSetup ) {
408 $this->setupAllTestDBs();
409 $this->addCoreDBData();
412 // TODO: the DB setup should be done in setUpBeforeClass(), so the test DB
413 // is available in subclass's setUpBeforeClass() and setUp() methods.
414 // This would also remove the need for the HACK that is oncePerClass().
415 if ( $this->oncePerClass() ) {
416 $this->setUpSchema( $this->db
);
417 $this->resetDB( $this->db
, $this->tablesUsed
);
418 $this->addDBDataOnce();
422 $needsResetDB = true;
425 parent
::run( $result );
427 // We don't mind if we override already-overridden services during cleanup
428 $this->overriddenServices
= [];
430 if ( $needsResetDB ) {
431 $this->resetDB( $this->db
, $this->tablesUsed
);
434 self
::restoreMwServices();
435 $this->localServices
= null;
441 private function oncePerClass() {
442 // Remember current test class in the database connection,
443 // so we know when we need to run addData.
445 $class = static::class;
447 $first = !isset( $this->db
->_hasDataForTestClass
)
448 ||
$this->db
->_hasDataForTestClass
!== $class;
450 $this->db
->_hasDataForTestClass
= $class;
459 public function usesTemporaryTables() {
460 return self
::$useTemporaryTables;
464 * Obtains a new temporary file name
466 * The obtained filename is enlisted to be removed upon tearDown
470 * @return string Absolute name of the temporary file
472 protected function getNewTempFile() {
473 $fileName = tempnam( wfTempDir(), 'MW_PHPUnit_' . static::class . '_' );
474 $this->tmpFiles
[] = $fileName;
480 * obtains a new temporary directory
482 * The obtained directory is enlisted to be removed (recursively with all its contained
483 * files) upon tearDown.
487 * @return string Absolute name of the temporary directory
489 protected function getNewTempDirectory() {
490 // Starting of with a temporary /file/.
491 $fileName = $this->getNewTempFile();
493 // Converting the temporary /file/ to a /directory/
494 // The following is not atomic, but at least we now have a single place,
495 // where temporary directory creation is bundled and can be improved
497 $this->assertTrue( wfMkdirParents( $fileName ) );
502 protected function setUp() {
504 $this->called
['setUp'] = true;
506 $this->phpErrorLevel
= intval( ini_get( 'error_reporting' ) );
508 $this->overriddenServices
= [];
510 // Cleaning up temporary files
511 foreach ( $this->tmpFiles
as $fileName ) {
512 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
514 } elseif ( is_dir( $fileName ) ) {
515 wfRecursiveRemoveDir( $fileName );
519 if ( $this->needsDB() && $this->db
) {
520 // Clean up open transactions
521 while ( $this->db
->trxLevel() > 0 ) {
522 $this->db
->rollback( __METHOD__
, 'flush' );
524 // Check for unsafe queries
525 if ( $this->db
->getType() === 'mysql' ) {
526 $this->db
->query( "SET sql_mode = 'STRICT_ALL_TABLES'", __METHOD__
);
530 // Reset all caches between tests.
531 self
::resetNonServiceCaches();
533 // XXX: reset maintenance triggers
534 // Hook into period lag checks which often happen in long-running scripts
535 $lbFactory = $this->localServices
->getDBLoadBalancerFactory();
536 Maintenance
::setLBFactoryTriggers( $lbFactory, $this->localServices
->getMainConfig() );
538 ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
541 protected function addTmpFiles( $files ) {
542 $this->tmpFiles
= array_merge( $this->tmpFiles
, (array)$files );
545 protected function tearDown() {
546 global $wgRequest, $wgSQLMode;
548 $status = ob_get_status();
549 if ( isset( $status['name'] ) &&
550 $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier'
555 $this->called
['tearDown'] = true;
556 // Cleaning up temporary files
557 foreach ( $this->tmpFiles
as $fileName ) {
558 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
560 } elseif ( is_dir( $fileName ) ) {
561 wfRecursiveRemoveDir( $fileName );
565 if ( $this->needsDB() && $this->db
) {
566 // Clean up open transactions
567 while ( $this->db
->trxLevel() > 0 ) {
568 $this->db
->rollback( __METHOD__
, 'flush' );
570 if ( $this->db
->getType() === 'mysql' ) {
571 $this->db
->query( "SET sql_mode = " . $this->db
->addQuotes( $wgSQLMode ),
576 // Re-enable any disabled deprecation warnings
578 // Restore mw globals
579 foreach ( $this->mwGlobals
as $key => $value ) {
580 $GLOBALS[$key] = $value;
582 foreach ( $this->mwGlobalsToUnset
as $value ) {
583 unset( $GLOBALS[$value] );
585 foreach ( $this->iniSettings
as $name => $value ) {
586 ini_set( $name, $value );
589 array_key_exists( 'wgExtraNamespaces', $this->mwGlobals
) ||
590 in_array( 'wgExtraNamespaces', $this->mwGlobalsToUnset
)
592 $this->resetNamespaces();
594 $this->mwGlobals
= [];
595 $this->mwGlobalsToUnset
= [];
596 $this->restoreLoggers();
598 // TODO: move global state into MediaWikiServices
599 RequestContext
::resetMain();
600 if ( session_id() !== '' ) {
601 session_write_close();
604 $wgRequest = new FauxRequest();
605 MediaWiki\Session\SessionManager
::resetCache();
606 MediaWiki\Auth\AuthManager
::resetCache();
608 $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
610 if ( $phpErrorLevel !== $this->phpErrorLevel
) {
611 ini_set( 'error_reporting', $this->phpErrorLevel
);
613 $oldHex = strtoupper( dechex( $this->phpErrorLevel
) );
614 $newHex = strtoupper( dechex( $phpErrorLevel ) );
615 $message = "PHP error_reporting setting was left dirty: "
616 . "was 0x$oldHex before test, 0x$newHex after test!";
618 $this->fail( $message );
625 * Make sure MediaWikiTestCase extending classes have called their
626 * parent setUp method
628 * With strict coverage activated in PHP_CodeCoverage, this test would be
629 * marked as risky without the following annotation (T152923).
632 final public function testMediaWikiTestCaseParentSetupCalled() {
633 $this->assertArrayHasKey( 'setUp', $this->called
,
634 static::class . '::setUp() must call parent::setUp()'
639 * Sets a service, maintaining a stashed version of the previous service to be
640 * restored in tearDown
644 * @param string $name
645 * @param object $object
647 protected function setService( $name, $object ) {
648 if ( !$this->localServices
) {
649 throw new Exception( __METHOD__
. ' must be called after MediaWikiTestCase::run()' );
652 if ( $this->localServices
!== MediaWikiServices
::getInstance() ) {
653 throw new Exception( __METHOD__
. ' will not work because the global MediaWikiServices '
654 . 'instance has been replaced by test code.' );
657 $this->overriddenServices
[] = $name;
659 $this->localServices
->disableService( $name );
660 $this->localServices
->redefineService(
662 function () use ( $object ) {
667 if ( $name === 'ContentLanguage' ) {
668 $this->doSetMwGlobals( [ 'wgContLang' => $object ] );
673 * Sets a global, maintaining a stashed version of the previous global to be
674 * restored in tearDown
676 * The key is added to the array of globals that will be reset afterwards
681 * protected function setUp() {
682 * $this->setMwGlobals( 'wgRestrictStuff', true );
685 * function testFoo() {}
687 * function testBar() {}
688 * $this->assertTrue( self::getX()->doStuff() );
690 * $this->setMwGlobals( 'wgRestrictStuff', false );
691 * $this->assertTrue( self::getX()->doStuff() );
694 * function testQuux() {}
697 * @param array|string $pairs Key to the global variable, or an array
698 * of key/value pairs.
699 * @param mixed|null $value Value to set the global to (ignored
700 * if an array is given as first argument).
702 * @note To allow changes to global variables to take effect on global service instances,
703 * call overrideMwServices().
707 protected function setMwGlobals( $pairs, $value = null ) {
708 if ( is_string( $pairs ) ) {
709 $pairs = [ $pairs => $value ];
712 if ( isset( $pairs['wgContLang'] ) ) {
713 throw new MWException(
714 'No setting $wgContLang, use setContentLang() or setService( \'ContentLanguage\' )'
718 $this->doSetMwGlobals( $pairs, $value );
722 * An internal method that allows setService() to set globals that tests are not supposed to
725 private function doSetMwGlobals( $pairs, $value = null ) {
726 $this->doStashMwGlobals( array_keys( $pairs ) );
728 foreach ( $pairs as $key => $value ) {
729 $GLOBALS[$key] = $value;
732 if ( array_key_exists( 'wgExtraNamespaces', $pairs ) ) {
733 $this->resetNamespaces();
738 * Set an ini setting for the duration of the test
739 * @param string $name Name of the setting
740 * @param string $value Value to set
743 protected function setIniSetting( $name, $value ) {
744 $original = ini_get( $name );
745 $this->iniSettings
[$name] = $original;
746 ini_set( $name, $value );
750 * Must be called whenever namespaces are changed, e.g., $wgExtraNamespaces is altered.
751 * Otherwise old namespace data will lurk and cause bugs.
753 private function resetNamespaces() {
754 if ( !$this->localServices
) {
755 throw new Exception( __METHOD__
. ' must be called after MediaWikiTestCase::run()' );
758 if ( $this->localServices
!== MediaWikiServices
::getInstance() ) {
759 throw new Exception( __METHOD__
. ' will not work because the global MediaWikiServices '
760 . 'instance has been replaced by test code.' );
763 MWNamespace
::clearCaches();
764 Language
::clearCaches();
766 // We can't have the TitleFormatter holding on to an old Language object either
767 // @todo We shouldn't need to reset all the aliases here.
768 $this->localServices
->resetServiceForTesting( 'TitleFormatter' );
769 $this->localServices
->resetServiceForTesting( 'TitleParser' );
770 $this->localServices
->resetServiceForTesting( '_MediaWikiTitleCodec' );
774 * Check if we can back up a value by performing a shallow copy.
775 * Values which fail this test are copied recursively.
777 * @param mixed $value
778 * @return bool True if a shallow copy will do; false if a deep copy
781 private static function canShallowCopy( $value ) {
782 if ( is_scalar( $value ) ||
$value === null ) {
785 if ( is_array( $value ) ) {
786 foreach ( $value as $subValue ) {
787 if ( !is_scalar( $subValue ) && $subValue !== null ) {
797 * Stashes the global, will be restored in tearDown()
799 * Individual test functions may override globals through the setMwGlobals() function
800 * or directly. When directly overriding globals their keys should first be passed to this
801 * method in setUp to avoid breaking global state for other tests
803 * That way all other tests are executed with the same settings (instead of using the
804 * unreliable local settings for most tests and fix it only for some tests).
806 * @param array|string $globalKeys Key to the global variable, or an array of keys.
808 * @note To allow changes to global variables to take effect on global service instances,
809 * call overrideMwServices().
812 * @deprecated since 1.32, use setMwGlobals() and don't alter globals directly
814 protected function stashMwGlobals( $globalKeys ) {
815 wfDeprecated( __METHOD__
, '1.32' );
816 $this->doStashMwGlobals( $globalKeys );
819 private function doStashMwGlobals( $globalKeys ) {
820 if ( is_string( $globalKeys ) ) {
821 $globalKeys = [ $globalKeys ];
824 foreach ( $globalKeys as $globalKey ) {
825 // NOTE: make sure we only save the global once or a second call to
826 // setMwGlobals() on the same global would override the original
829 !array_key_exists( $globalKey, $this->mwGlobals
) &&
830 !array_key_exists( $globalKey, $this->mwGlobalsToUnset
)
832 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
833 $this->mwGlobalsToUnset
[$globalKey] = $globalKey;
836 // NOTE: we serialize then unserialize the value in case it is an object
837 // this stops any objects being passed by reference. We could use clone
838 // and if is_object but this does account for objects within objects!
839 if ( self
::canShallowCopy( $GLOBALS[$globalKey] ) ) {
840 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
842 // Many MediaWiki types are safe to clone. These are the
843 // ones that are most commonly stashed.
844 $GLOBALS[$globalKey] instanceof Language ||
845 $GLOBALS[$globalKey] instanceof User ||
846 $GLOBALS[$globalKey] instanceof FauxRequest
848 $this->mwGlobals
[$globalKey] = clone $GLOBALS[$globalKey];
849 } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
850 // Serializing Closure only gives a warning on HHVM while
851 // it throws an Exception on Zend.
852 // Workaround for https://github.com/facebook/hhvm/issues/6206
853 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
856 $this->mwGlobals
[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
857 } catch ( Exception
$e ) {
858 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
867 * @param int $maxDepth
871 private function containsClosure( $var, $maxDepth = 15 ) {
872 if ( $var instanceof Closure
) {
875 if ( !is_array( $var ) ||
$maxDepth === 0 ) {
879 foreach ( $var as $value ) {
880 if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
888 * Merges the given values into a MW global array variable.
889 * Useful for setting some entries in a configuration array, instead of
890 * setting the entire array.
892 * @param string $name The name of the global, as in wgFooBar
893 * @param array $values The array containing the entries to set in that global
895 * @throws MWException If the designated global is not an array.
897 * @note To allow changes to global variables to take effect on global service instances,
898 * call overrideMwServices().
902 protected function mergeMwGlobalArrayValue( $name, $values ) {
903 if ( !isset( $GLOBALS[$name] ) ) {
906 if ( !is_array( $GLOBALS[$name] ) ) {
907 throw new MWException( "MW global $name is not an array." );
910 // NOTE: do not use array_merge, it screws up for numeric keys.
911 $merged = $GLOBALS[$name];
912 foreach ( $values as $k => $v ) {
917 $this->setMwGlobals( $name, $merged );
921 * Stashes the global instance of MediaWikiServices, and installs a new one,
922 * allowing test cases to override settings and services.
923 * The previous instance of MediaWikiServices will be restored on tearDown.
927 * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
929 * @param callable[] $services An associative array of services to re-define. Keys are service
930 * names, values are callables.
932 * @return MediaWikiServices
933 * @throws MWException
935 protected function overrideMwServices(
936 Config
$configOverrides = null, array $services = []
938 if ( $this->overriddenServices
) {
939 throw new MWException(
940 'The following services were set and are now being unset by overrideMwServices: ' .
941 implode( ', ', $this->overriddenServices
)
944 $newInstance = self
::installMockMwServices( $configOverrides );
946 if ( $this->localServices
) {
947 $this->localServices
->destroy();
950 $this->localServices
= $newInstance;
952 foreach ( $services as $name => $callback ) {
953 $newInstance->redefineService( $name, $callback );
960 * Creates a new "mock" MediaWikiServices instance, and installs it.
961 * This effectively resets all cached states in services, with the exception of
962 * the ConfigFactory and the DBLoadBalancerFactory service, which are inherited from
963 * the original MediaWikiServices.
965 * @note The new original MediaWikiServices instance can later be restored by calling
966 * restoreMwServices(). That original is determined by the first call to this method, or
967 * by setUpBeforeClass, whichever is called first. The caller is responsible for managing
968 * and, when appropriate, destroying any other MediaWikiServices instances that may get
969 * replaced when calling this method.
971 * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
974 * @return MediaWikiServices the new mock service locator.
976 public static function installMockMwServices( Config
$configOverrides = null ) {
977 // Make sure we have the original service locator
978 if ( !self
::$originalServices ) {
979 self
::$originalServices = MediaWikiServices
::getInstance();
982 if ( !$configOverrides ) {
983 $configOverrides = new HashConfig();
986 $oldConfigFactory = self
::$originalServices->getConfigFactory();
987 $oldLoadBalancerFactory = self
::$originalServices->getDBLoadBalancerFactory();
989 $testConfig = self
::makeTestConfig( null, $configOverrides );
990 $newServices = new MediaWikiServices( $testConfig );
992 // Load the default wiring from the specified files.
993 // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
994 $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
995 $newServices->loadWiringFiles( $wiringFiles );
997 // Provide a traditional hook point to allow extensions to configure services.
998 Hooks
::run( 'MediaWikiServices', [ $newServices ] );
1000 // Use bootstrap config for all configuration.
1001 // This allows config overrides via global variables to take effect.
1002 $bootstrapConfig = $newServices->getBootstrapConfig();
1003 $newServices->resetServiceForTesting( 'ConfigFactory' );
1004 $newServices->redefineService(
1006 self
::makeTestConfigFactoryInstantiator(
1008 [ 'main' => $bootstrapConfig ]
1011 $newServices->resetServiceForTesting( 'DBLoadBalancerFactory' );
1012 $newServices->redefineService(
1013 'DBLoadBalancerFactory',
1014 function ( MediaWikiServices
$services ) use ( $oldLoadBalancerFactory ) {
1015 return $oldLoadBalancerFactory;
1019 MediaWikiServices
::forceGlobalInstance( $newServices );
1020 return $newServices;
1024 * Restores the original, non-mock MediaWikiServices instance.
1025 * The previously active MediaWikiServices instance is destroyed,
1026 * if it is different from the original that is to be restored.
1028 * @note this if for internal use by test framework code. It should never be
1029 * called from inside a test case, a data provider, or a setUp or tearDown method.
1031 * @return bool true if the original service locator was restored,
1032 * false if there was nothing too do.
1034 public static function restoreMwServices() {
1035 if ( !self
::$originalServices ) {
1039 $currentServices = MediaWikiServices
::getInstance();
1041 if ( self
::$originalServices === $currentServices ) {
1045 MediaWikiServices
::forceGlobalInstance( self
::$originalServices );
1046 $currentServices->destroy();
1053 * @param string|Language $lang
1055 public function setUserLang( $lang ) {
1056 RequestContext
::getMain()->setLanguage( $lang );
1057 $this->setMwGlobals( 'wgLang', RequestContext
::getMain()->getLanguage() );
1062 * @param string|Language $lang
1064 public function setContentLang( $lang ) {
1065 if ( $lang instanceof Language
) {
1066 $this->setMwGlobals( 'wgLanguageCode', $lang->getCode() );
1067 // Set to the exact object requested
1068 $this->setService( 'ContentLanguage', $lang );
1070 $this->setMwGlobals( 'wgLanguageCode', $lang );
1071 // Let the service handler make up the object. Avoid calling setService(), because if
1072 // we do, overrideMwServices() will complain if it's called later on.
1073 $services = MediaWikiServices
::getInstance();
1074 $services->resetServiceForTesting( 'ContentLanguage' );
1075 $this->doSetMwGlobals( [ 'wgContLang' => $services->getContentLanguage() ] );
1080 * Alters $wgGroupPermissions for the duration of the test. Can be called
1081 * with an array, like
1082 * [ '*' => [ 'read' => false ], 'user' => [ 'read' => false ] ]
1083 * or three values to set a single permission, like
1084 * $this->setGroupPermissions( '*', 'read', false );
1087 * @param array|string $newPerms Either an array of permissions to change,
1088 * in which case the next two parameters are ignored; or a single string
1089 * identifying a group, to use with the next two parameters.
1090 * @param string|null $newKey
1091 * @param mixed|null $newValue
1093 public function setGroupPermissions( $newPerms, $newKey = null, $newValue = null ) {
1094 global $wgGroupPermissions;
1096 if ( is_string( $newPerms ) ) {
1097 $newPerms = [ $newPerms => [ $newKey => $newValue ] ];
1100 $newPermissions = $wgGroupPermissions;
1101 foreach ( $newPerms as $group => $permissions ) {
1102 foreach ( $permissions as $key => $value ) {
1103 $newPermissions[$group][$key] = $value;
1107 $this->setMwGlobals( 'wgGroupPermissions', $newPermissions );
1111 * Sets the logger for a specified channel, for the duration of the test.
1113 * @param string $channel
1114 * @param LoggerInterface $logger
1116 protected function setLogger( $channel, LoggerInterface
$logger ) {
1117 // TODO: Once loggers are managed by MediaWikiServices, use
1118 // overrideMwServices() to set loggers.
1120 $provider = LoggerFactory
::getProvider();
1121 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
1122 $singletons = $wrappedProvider->singletons
;
1123 if ( $provider instanceof MonologSpi
) {
1124 if ( !isset( $this->loggers
[$channel] ) ) {
1125 $this->loggers
[$channel] = $singletons['loggers'][$channel] ??
null;
1127 $singletons['loggers'][$channel] = $logger;
1128 } elseif ( $provider instanceof LegacySpi ||
$provider instanceof LogCapturingSpi
) {
1129 if ( !isset( $this->loggers
[$channel] ) ) {
1130 $this->loggers
[$channel] = $singletons[$channel] ??
null;
1132 $singletons[$channel] = $logger;
1134 throw new LogicException( __METHOD__
. ': setting a logger for ' . get_class( $provider )
1135 . ' is not implemented' );
1137 $wrappedProvider->singletons
= $singletons;
1141 * Restores loggers replaced by setLogger().
1144 private function restoreLoggers() {
1145 $provider = LoggerFactory
::getProvider();
1146 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
1147 $singletons = $wrappedProvider->singletons
;
1148 foreach ( $this->loggers
as $channel => $logger ) {
1149 if ( $provider instanceof MonologSpi
) {
1150 if ( $logger === null ) {
1151 unset( $singletons['loggers'][$channel] );
1153 $singletons['loggers'][$channel] = $logger;
1155 } elseif ( $provider instanceof LegacySpi ||
$provider instanceof LogCapturingSpi
) {
1156 if ( $logger === null ) {
1157 unset( $singletons[$channel] );
1159 $singletons[$channel] = $logger;
1163 $wrappedProvider->singletons
= $singletons;
1164 $this->loggers
= [];
1171 public function dbPrefix() {
1172 return self
::getTestPrefixFor( $this->db
);
1176 * @param IDatabase $db
1180 public static function getTestPrefixFor( IDatabase
$db ) {
1181 return $db->getType() == 'oracle' ? self
::ORA_DB_PREFIX
: self
::DB_PREFIX
;
1188 public function needsDB() {
1189 // If the test says it uses database tables, it needs the database
1190 return $this->tablesUsed ||
$this->isTestInDatabaseGroup();
1197 protected function isTestInDatabaseGroup() {
1198 // If the test class says it belongs to the Database group, it needs the database.
1199 // NOTE: This ONLY checks for the group in the class level doc comment.
1200 $rc = new ReflectionClass( $this );
1201 return (bool)preg_match( '/@group +Database/im', $rc->getDocComment() );
1205 * Insert a new page.
1207 * Should be called from addDBData().
1209 * @since 1.25 ($namespace in 1.28)
1210 * @param string|Title $pageName Page name or title
1211 * @param string $text Page's content
1212 * @param int|null $namespace Namespace id (name cannot already contain namespace)
1213 * @param User|null $user If null, static::getTestSysop()->getUser() is used.
1214 * @return array Title object and page id
1215 * @throws MWException If this test cases's needsDB() method doesn't return true.
1216 * Test cases can use "@group Database" to enable database test support,
1217 * or list the tables under testing in $this->tablesUsed, or override the
1220 protected function insertPage(
1222 $text = 'Sample page for unit test.',
1226 if ( !$this->needsDB() ) {
1227 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
1228 ' method should return true. Use @group Database or $this->tablesUsed.' );
1231 if ( is_string( $pageName ) ) {
1232 $title = Title
::newFromText( $pageName, $namespace );
1238 $user = static::getTestSysop()->getUser();
1240 $comment = __METHOD__
. ': Sample page for unit test.';
1242 $page = WikiPage
::factory( $title );
1243 $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $comment, 0, false, $user );
1247 'id' => $page->getId(),
1252 * Stub. If a test suite needs to add additional data to the database, it should
1253 * implement this method and do so. This method is called once per test suite
1254 * (i.e. once per class).
1256 * Note data added by this method may be removed by resetDB() depending on
1257 * the contents of $tablesUsed.
1259 * To add additional data between test function runs, override prepareDB().
1266 public function addDBDataOnce() {
1270 * Stub. Subclasses may override this to prepare the database.
1271 * Called before every test run (test function or data set).
1273 * @see addDBDataOnce()
1278 public function addDBData() {
1284 protected function addCoreDBData() {
1285 if ( $this->db
->getType() == 'oracle' ) {
1286 # Insert 0 user to prevent FK violations
1288 if ( !$this->db
->selectField( 'user', '1', [ 'user_id' => 0 ] ) ) {
1289 $this->db
->insert( 'user', [
1291 'user_name' => 'Anonymous' ], __METHOD__
, [ 'IGNORE' ] );
1294 # Insert 0 page to prevent FK violations
1296 if ( !$this->db
->selectField( 'page', '1', [ 'page_id' => 0 ] ) ) {
1297 $this->db
->insert( 'page', [
1299 'page_namespace' => 0,
1300 'page_title' => ' ',
1301 'page_restrictions' => null,
1302 'page_is_redirect' => 0,
1305 'page_touched' => $this->db
->timestamp(),
1307 'page_len' => 0 ], __METHOD__
, [ 'IGNORE' ] );
1311 SiteStatsInit
::doPlaceholderInit();
1313 User
::resetIdByNameCache();
1316 $user = static::getTestSysop()->getUser();
1318 // Make 1 page with 1 revision
1319 $page = WikiPage
::factory( Title
::newFromText( 'UTPage' ) );
1320 if ( $page->getId() == 0 ) {
1321 $page->doEditContent(
1322 new WikitextContent( 'UTContent' ),
1324 EDIT_NEW | EDIT_SUPPRESS_RC
,
1328 // an edit always attempt to purge backlink links such as history
1329 // pages. That is unnecessary.
1330 JobQueueGroup
::singleton()->get( 'htmlCacheUpdate' )->delete();
1331 // WikiPages::doEditUpdates randomly adds RC purges
1332 JobQueueGroup
::singleton()->get( 'recentChangesUpdate' )->delete();
1334 // doEditContent() probably started the session via
1335 // User::loadFromSession(). Close it now.
1336 if ( session_id() !== '' ) {
1337 session_write_close();
1344 * Restores MediaWiki to using the table set (table prefix) it was using before
1345 * setupTestDB() was called. Useful if we need to perform database operations
1346 * after the test run has finished (such as saving logs or profiling info).
1348 * This is called by phpunit/bootstrap.php after the last test.
1352 public static function teardownTestDB() {
1353 global $wgJobClasses;
1355 if ( !self
::$dbSetup ) {
1359 Hooks
::run( 'UnitTestsBeforeDatabaseTeardown' );
1361 foreach ( $wgJobClasses as $type => $class ) {
1362 // Delete any jobs under the clone DB (or old prefix in other stores)
1363 JobQueueGroup
::singleton()->get( $type )->delete();
1366 CloneDatabase
::changePrefix( self
::$oldTablePrefix );
1368 self
::$oldTablePrefix = false;
1369 self
::$dbSetup = false;
1373 * Setups a database with cloned tables using the given prefix.
1375 * If reuseDB is true and certain conditions apply, it will just change the prefix.
1376 * Otherwise, it will clone the tables and change the prefix.
1378 * @param IMaintainableDatabase $db Database to use
1379 * @param string|null $prefix Prefix to use for test tables. If not given, the prefix is determined
1380 * automatically for $db.
1381 * @return bool True if tables were cloned, false if only the prefix was changed
1383 protected static function setupDatabaseWithTestPrefix(
1384 IMaintainableDatabase
$db,
1387 if ( $prefix === null ) {
1388 $prefix = self
::getTestPrefixFor( $db );
1391 if ( ( $db->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
1392 $db->tablePrefix( $prefix );
1396 if ( !isset( $db->_originalTablePrefix
) ) {
1397 $oldPrefix = $db->tablePrefix();
1399 if ( $oldPrefix === $prefix ) {
1400 // table already has the correct prefix, but presumably no cloned tables
1401 $oldPrefix = self
::$oldTablePrefix;
1404 $db->tablePrefix( $oldPrefix );
1405 $tablesCloned = self
::listTables( $db );
1406 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix, $oldPrefix );
1407 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1409 $dbClone->cloneTableStructure();
1411 $db->tablePrefix( $prefix );
1412 $db->_originalTablePrefix
= $oldPrefix;
1419 * Set up all test DBs
1421 public function setupAllTestDBs() {
1424 self
::$oldTablePrefix = $wgDBprefix;
1426 $testPrefix = $this->dbPrefix();
1428 // switch to a temporary clone of the database
1429 self
::setupTestDB( $this->db
, $testPrefix );
1431 if ( self
::isUsingExternalStoreDB() ) {
1432 self
::setupExternalStoreTestDBs( $testPrefix );
1435 // NOTE: Change the prefix in the LBFactory and $wgDBprefix, to prevent
1436 // *any* database connections to operate on live data.
1437 CloneDatabase
::changePrefix( $testPrefix );
1441 * Creates an empty skeleton of the wiki database by cloning its structure
1442 * to equivalent tables using the given $prefix. Then sets MediaWiki to
1443 * use the new set of tables (aka schema) instead of the original set.
1445 * This is used to generate a dummy table set, typically consisting of temporary
1446 * tables, that will be used by tests instead of the original wiki database tables.
1450 * @note the original table prefix is stored in self::$oldTablePrefix. This is used
1451 * by teardownTestDB() to return the wiki to using the original table set.
1453 * @note this method only works when first called. Subsequent calls have no effect,
1454 * even if using different parameters.
1456 * @param Database $db The database connection
1457 * @param string $prefix The prefix to use for the new table set (aka schema).
1459 * @throws MWException If the database table prefix is already $prefix
1461 public static function setupTestDB( Database
$db, $prefix ) {
1462 if ( self
::$dbSetup ) {
1466 if ( $db->tablePrefix() === $prefix ) {
1467 throw new MWException(
1468 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
1471 // TODO: the below should be re-written as soon as LBFactory, LoadBalancer,
1472 // and Database no longer use global state.
1474 self
::$dbSetup = true;
1476 if ( !self
::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
1480 // Assuming this isn't needed for External Store database, and not sure if the procedure
1481 // would be available there.
1482 if ( $db->getType() == 'oracle' ) {
1483 $db->query( 'BEGIN FILL_WIKI_INFO; END;', __METHOD__
);
1486 Hooks
::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
1490 * Clones the External Store database(s) for testing
1492 * @param string|null $testPrefix Prefix for test tables. Will be determined automatically
1495 protected static function setupExternalStoreTestDBs( $testPrefix = null ) {
1496 $connections = self
::getExternalStoreDatabaseConnections();
1497 foreach ( $connections as $dbw ) {
1498 self
::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
1503 * Gets master database connections for all of the ExternalStoreDB
1504 * stores configured in $wgDefaultExternalStore.
1506 * @return Database[] Array of Database master connections
1508 protected static function getExternalStoreDatabaseConnections() {
1509 global $wgDefaultExternalStore;
1511 /** @var ExternalStoreDB $externalStoreDB */
1512 $externalStoreDB = ExternalStore
::getStoreObject( 'DB' );
1513 $defaultArray = (array)$wgDefaultExternalStore;
1515 foreach ( $defaultArray as $url ) {
1516 if ( strpos( $url, 'DB://' ) === 0 ) {
1517 list( $proto, $cluster ) = explode( '://', $url, 2 );
1518 // Avoid getMaster() because setupDatabaseWithTestPrefix()
1519 // requires Database instead of plain DBConnRef/IDatabase
1520 $dbws[] = $externalStoreDB->getMaster( $cluster );
1528 * Check whether ExternalStoreDB is being used
1530 * @return bool True if it's being used
1532 protected static function isUsingExternalStoreDB() {
1533 global $wgDefaultExternalStore;
1534 if ( !$wgDefaultExternalStore ) {
1538 $defaultArray = (array)$wgDefaultExternalStore;
1539 foreach ( $defaultArray as $url ) {
1540 if ( strpos( $url, 'DB://' ) === 0 ) {
1549 * @throws LogicException if the given database connection is not a set up to use
1552 * @since 1.31 this is no longer private.
1554 protected function ensureMockDatabaseConnection( IDatabase
$db ) {
1555 if ( $db->tablePrefix() !== $this->dbPrefix() ) {
1556 throw new LogicException(
1557 'Trying to delete mock tables, but table prefix does not indicate a mock database.'
1562 private static $schemaOverrideDefaults = [
1570 * Stub. If a test suite needs to test against a specific database schema, it should
1571 * override this method and return the appropriate information from it.
1573 * @param IMaintainableDatabase $db The DB connection to use for the mock schema.
1574 * May be used to check the current state of the schema, to determine what
1575 * overrides are needed.
1577 * @return array An associative array with the following fields:
1578 * - 'scripts': any SQL scripts to run. If empty or not present, schema overrides are skipped.
1579 * - 'create': A list of tables created (may or may not exist in the original schema).
1580 * - 'drop': A list of tables dropped (expected to be present in the original schema).
1581 * - 'alter': A list of tables altered (expected to be present in the original schema).
1583 protected function getSchemaOverrides( IMaintainableDatabase
$db ) {
1588 * Undoes the specified schema overrides..
1589 * Called once per test class, just before addDataOnce().
1591 * @param IMaintainableDatabase $db
1592 * @param array $oldOverrides
1594 private function undoSchemaOverrides( IMaintainableDatabase
$db, $oldOverrides ) {
1595 $this->ensureMockDatabaseConnection( $db );
1597 $oldOverrides = $oldOverrides + self
::$schemaOverrideDefaults;
1598 $originalTables = $this->listOriginalTables( $db, 'unprefixed' );
1600 // Drop tables that need to be restored or removed.
1601 $tablesToDrop = array_merge( $oldOverrides['create'], $oldOverrides['alter'] );
1603 // Restore tables that have been dropped or created or altered,
1604 // if they exist in the original schema.
1605 $tablesToRestore = array_merge( $tablesToDrop, $oldOverrides['drop'] );
1606 $tablesToRestore = array_intersect( $originalTables, $tablesToRestore );
1608 if ( $tablesToDrop ) {
1609 $this->dropMockTables( $db, $tablesToDrop );
1612 if ( $tablesToRestore ) {
1613 $this->recloneMockTables( $db, $tablesToRestore );
1618 * Applies the schema overrides returned by getSchemaOverrides(),
1619 * after undoing any previously applied schema overrides.
1620 * Called once per test class, just before addDataOnce().
1622 private function setUpSchema( IMaintainableDatabase
$db ) {
1623 // Undo any active overrides.
1624 $oldOverrides = $db->_schemaOverrides ?? self
::$schemaOverrideDefaults;
1626 if ( $oldOverrides['alter'] ||
$oldOverrides['create'] ||
$oldOverrides['drop'] ) {
1627 $this->undoSchemaOverrides( $db, $oldOverrides );
1630 // Determine new overrides.
1631 $overrides = $this->getSchemaOverrides( $db ) + self
::$schemaOverrideDefaults;
1633 $extraKeys = array_diff(
1634 array_keys( $overrides ),
1635 array_keys( self
::$schemaOverrideDefaults )
1639 throw new InvalidArgumentException(
1640 'Schema override contains extra keys: ' . var_export( $extraKeys, true )
1644 if ( !$overrides['scripts'] ) {
1645 // no scripts to run
1649 if ( !$overrides['create'] && !$overrides['drop'] && !$overrides['alter'] ) {
1650 throw new InvalidArgumentException(
1651 'Schema override scripts given, but no tables are declared to be '
1652 . 'created, dropped or altered.'
1656 $this->ensureMockDatabaseConnection( $db );
1658 // Drop the tables that will be created by the schema scripts.
1659 $originalTables = $this->listOriginalTables( $db, 'unprefixed' );
1660 $tablesToDrop = array_intersect( $originalTables, $overrides['create'] );
1662 if ( $tablesToDrop ) {
1663 $this->dropMockTables( $db, $tablesToDrop );
1666 // Run schema override scripts.
1667 foreach ( $overrides['scripts'] as $script ) {
1674 return $this->mungeSchemaUpdateQuery( $cmd );
1679 $db->_schemaOverrides
= $overrides;
1682 private function mungeSchemaUpdateQuery( $cmd ) {
1683 return self
::$useTemporaryTables
1684 ?
preg_replace( '/\bCREATE\s+TABLE\b/i', 'CREATE TEMPORARY TABLE', $cmd )
1689 * Drops the given mock tables.
1691 * @param IMaintainableDatabase $db
1692 * @param array $tables
1694 private function dropMockTables( IMaintainableDatabase
$db, array $tables ) {
1695 $this->ensureMockDatabaseConnection( $db );
1697 foreach ( $tables as $tbl ) {
1698 $tbl = $db->tableName( $tbl );
1699 $db->query( "DROP TABLE IF EXISTS $tbl", __METHOD__
);
1704 * Lists all tables in the live database schema.
1706 * @param IMaintainableDatabase $db
1707 * @param string $prefix Either 'prefixed' or 'unprefixed'
1710 private function listOriginalTables( IMaintainableDatabase
$db, $prefix = 'prefixed' ) {
1711 if ( !isset( $db->_originalTablePrefix
) ) {
1712 throw new LogicException( 'No original table prefix know, cannot list tables!' );
1715 $originalTables = $db->listTables( $db->_originalTablePrefix
, __METHOD__
);
1716 if ( $prefix === 'unprefixed' ) {
1717 $originalPrefixRegex = '/^' . preg_quote( $db->_originalTablePrefix
, '/' ) . '/';
1718 $originalTables = array_map(
1719 function ( $pt ) use ( $originalPrefixRegex ) {
1720 return preg_replace( $originalPrefixRegex, '', $pt );
1726 return $originalTables;
1730 * Re-clones the given mock tables to restore them based on the live database schema.
1731 * The tables listed in $tables are expected to currently not exist, so dropMockTables()
1732 * should be called first.
1734 * @param IMaintainableDatabase $db
1735 * @param array $tables
1737 private function recloneMockTables( IMaintainableDatabase
$db, array $tables ) {
1738 $this->ensureMockDatabaseConnection( $db );
1740 if ( !isset( $db->_originalTablePrefix
) ) {
1741 throw new LogicException( 'No original table prefix know, cannot restore tables!' );
1744 $originalTables = $this->listOriginalTables( $db, 'unprefixed' );
1745 $tables = array_intersect( $tables, $originalTables );
1747 $dbClone = new CloneDatabase( $db, $tables, $db->tablePrefix(), $db->_originalTablePrefix
);
1748 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1750 $dbClone->cloneTableStructure();
1754 * Empty all tables so they can be repopulated for tests
1756 * @param Database $db|null Database to reset
1757 * @param array $tablesUsed Tables to reset
1759 private function resetDB( $db, $tablesUsed ) {
1761 $userTables = [ 'user', 'user_groups', 'user_properties', 'actor' ];
1763 'page', 'revision', 'ip_changes', 'revision_comment_temp', 'comment', 'archive',
1764 'revision_actor_temp', 'slots', 'content', 'content_models', 'slot_roles',
1766 $coreDBDataTables = array_merge( $userTables, $pageTables );
1768 // If any of the user or page tables were marked as used, we should clear all of them.
1769 if ( array_intersect( $tablesUsed, $userTables ) ) {
1770 $tablesUsed = array_unique( array_merge( $tablesUsed, $userTables ) );
1771 TestUserRegistry
::clear();
1773 if ( array_intersect( $tablesUsed, $pageTables ) ) {
1774 $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
1777 // Postgres, Oracle, and MSSQL all use mwuser/pagecontent
1778 // instead of user/text. But Postgres does not remap the
1779 // table name in tableExists(), so we mark the real table
1780 // names as being used.
1781 if ( $db->getType() === 'postgres' ) {
1782 if ( in_array( 'user', $tablesUsed ) ) {
1783 $tablesUsed[] = 'mwuser';
1785 if ( in_array( 'text', $tablesUsed ) ) {
1786 $tablesUsed[] = 'pagecontent';
1790 foreach ( $tablesUsed as $tbl ) {
1791 $this->truncateTable( $tbl, $db );
1794 if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
1795 // Reset services that may contain information relating to the truncated tables
1796 $this->overrideMwServices();
1797 // Re-add core DB data that was deleted
1798 $this->addCoreDBData();
1804 * Empties the given table and resets any auto-increment counters.
1805 * Will also purge caches associated with some well known tables.
1806 * If the table is not know, this method just returns.
1808 * @param string $tableName
1809 * @param IDatabase|null $db
1811 protected function truncateTable( $tableName, IDatabase
$db = null ) {
1816 if ( !$db->tableExists( $tableName ) ) {
1820 $truncate = in_array( $db->getType(), [ 'oracle', 'mysql' ] );
1823 $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tableName ), __METHOD__
);
1825 $db->delete( $tableName, '*', __METHOD__
);
1828 if ( $db instanceof DatabasePostgres ||
$db instanceof DatabaseSqlite
) {
1829 // Reset the table's sequence too.
1830 $db->resetSequenceForTable( $tableName, __METHOD__
);
1833 // re-initialize site_stats table
1834 if ( $tableName === 'site_stats' ) {
1835 SiteStatsInit
::doPlaceholderInit();
1839 private static function unprefixTable( &$tableName, $ind, $prefix ) {
1840 $tableName = substr( $tableName, strlen( $prefix ) );
1843 private static function isNotUnittest( $table ) {
1844 return strpos( $table, self
::DB_PREFIX
) !== 0;
1850 * @param IMaintainableDatabase $db
1854 public static function listTables( IMaintainableDatabase
$db ) {
1855 $prefix = $db->tablePrefix();
1856 $tables = $db->listTables( $prefix, __METHOD__
);
1858 if ( $db->getType() === 'mysql' ) {
1859 static $viewListCache = null;
1860 if ( $viewListCache === null ) {
1861 $viewListCache = $db->listViews( null, __METHOD__
);
1863 // T45571: cannot clone VIEWs under MySQL
1864 $tables = array_diff( $tables, $viewListCache );
1866 array_walk( $tables, [ __CLASS__
, 'unprefixTable' ], $prefix );
1868 // Don't duplicate test tables from the previous fataled run
1869 $tables = array_filter( $tables, [ __CLASS__
, 'isNotUnittest' ] );
1871 if ( $db->getType() == 'sqlite' ) {
1872 $tables = array_flip( $tables );
1873 // these are subtables of searchindex and don't need to be duped/dropped separately
1874 unset( $tables['searchindex_content'] );
1875 unset( $tables['searchindex_segdir'] );
1876 unset( $tables['searchindex_segments'] );
1877 $tables = array_flip( $tables );
1884 * Copy test data from one database connection to another.
1886 * This should only be used for small data sets.
1888 * @param IDatabase $source
1889 * @param IDatabase $target
1891 public function copyTestData( IDatabase
$source, IDatabase
$target ) {
1892 $tables = self
::listOriginalTables( $source, 'unprefixed' );
1894 foreach ( $tables as $table ) {
1895 $res = $source->select( $table, '*', [], __METHOD__
);
1898 foreach ( $res as $row ) {
1899 $allRows[] = (array)$row;
1902 $target->insert( $table, $allRows, __METHOD__
, [ 'IGNORE' ] );
1907 * @throws MWException
1910 protected function checkDbIsSupported() {
1911 if ( !in_array( $this->db
->getType(), $this->supportedDBs
) ) {
1912 throw new MWException( $this->db
->getType() . " is not currently supported for unit testing." );
1918 * @param string $offset
1921 public function getCliArg( $offset ) {
1922 return $this->cliArgs
[$offset] ??
null;
1927 * @param string $offset
1928 * @param mixed $value
1930 public function setCliArg( $offset, $value ) {
1931 $this->cliArgs
[$offset] = $value;
1935 * Don't throw a warning if $function is deprecated and called later
1939 * @param string $function
1941 public function hideDeprecated( $function ) {
1942 Wikimedia\
suppressWarnings();
1943 wfDeprecated( $function );
1944 Wikimedia\restoreWarnings
();
1948 * Asserts that the given database query yields the rows given by $expectedRows.
1949 * The expected rows should be given as indexed (not associative) arrays, with
1950 * the values given in the order of the columns in the $fields parameter.
1951 * Note that the rows are sorted by the columns given in $fields.
1955 * @param string|array $table The table(s) to query
1956 * @param string|array $fields The columns to include in the result (and to sort by)
1957 * @param string|array $condition "where" condition(s)
1958 * @param array $expectedRows An array of arrays giving the expected rows.
1959 * @param array $options Options for the query
1960 * @param array $join_conds Join conditions for the query
1962 * @throws MWException If this test cases's needsDB() method doesn't return true.
1963 * Test cases can use "@group Database" to enable database test support,
1964 * or list the tables under testing in $this->tablesUsed, or override the
1967 protected function assertSelect(
1968 $table, $fields, $condition, array $expectedRows, array $options = [], array $join_conds = []
1970 if ( !$this->needsDB() ) {
1971 throw new MWException( 'When testing database state, the test cases\'s needDB()' .
1972 ' method should return true. Use @group Database or $this->tablesUsed.' );
1975 $db = wfGetDB( DB_REPLICA
);
1982 $options +
[ 'ORDER BY' => $fields ],
1985 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
1989 foreach ( $expectedRows as $expected ) {
1990 $r = $res->fetchRow();
1991 self
::stripStringKeys( $r );
1994 $this->assertNotEmpty( $r, "row #$i missing" );
1996 $this->assertEquals( $expected, $r, "row #$i mismatches" );
1999 $r = $res->fetchRow();
2000 self
::stripStringKeys( $r );
2002 $this->assertFalse( $r, "found extra row (after #$i)" );
2006 * Utility method taking an array of elements and wrapping
2007 * each element in its own array. Useful for data providers
2008 * that only return a single argument.
2012 * @param array $elements
2016 protected function arrayWrap( array $elements ) {
2018 function ( $element ) {
2019 return [ $element ];
2026 * Assert that two arrays are equal. By default this means that both arrays need to hold
2027 * the same set of values. Using additional arguments, order and associated key can also
2028 * be set as relevant.
2032 * @param array $expected
2033 * @param array $actual
2034 * @param bool $ordered If the order of the values should match
2035 * @param bool $named If the keys should match
2037 protected function assertArrayEquals( array $expected, array $actual,
2038 $ordered = false, $named = false
2041 $this->objectAssociativeSort( $expected );
2042 $this->objectAssociativeSort( $actual );
2046 $expected = array_values( $expected );
2047 $actual = array_values( $actual );
2050 call_user_func_array(
2051 [ $this, 'assertEquals' ],
2052 array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
2057 * Put each HTML element on its own line and then equals() the results
2059 * Use for nicely formatting of PHPUnit diff output when comparing very
2064 * @param string $expected HTML on oneline
2065 * @param string $actual HTML on oneline
2066 * @param string $msg Optional message
2068 protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
2069 $expected = str_replace( '>', ">\n", $expected );
2070 $actual = str_replace( '>', ">\n", $actual );
2072 $this->assertEquals( $expected, $actual, $msg );
2076 * Does an associative sort that works for objects.
2080 * @param array &$array
2082 protected function objectAssociativeSort( array &$array ) {
2085 function ( $a, $b ) {
2086 return serialize( $a ) <=> serialize( $b );
2092 * Utility function for eliminating all string keys from an array.
2093 * Useful to turn a database result row as returned by fetchRow() into
2094 * a pure indexed array.
2098 * @param mixed &$r The array to remove string keys from.
2100 protected static function stripStringKeys( &$r ) {
2101 if ( !is_array( $r ) ) {
2105 foreach ( $r as $k => $v ) {
2106 if ( is_string( $k ) ) {
2113 * Asserts that the provided variable is of the specified
2114 * internal type or equals the $value argument. This is useful
2115 * for testing return types of functions that return a certain
2116 * type or *value* when not set or on error.
2120 * @param string $type
2121 * @param mixed $actual
2122 * @param mixed $value
2123 * @param string $message
2125 protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
2126 if ( $actual === $value ) {
2127 $this->assertTrue( true, $message );
2129 $this->assertType( $type, $actual, $message );
2134 * Asserts the type of the provided value. This can be either
2135 * in internal type such as boolean or integer, or a class or
2136 * interface the value extends or implements.
2140 * @param string $type
2141 * @param mixed $actual
2142 * @param string $message
2144 protected function assertType( $type, $actual, $message = '' ) {
2145 if ( class_exists( $type ) ||
interface_exists( $type ) ) {
2146 $this->assertInstanceOf( $type, $actual, $message );
2148 $this->assertInternalType( $type, $actual, $message );
2153 * Returns true if the given namespace defaults to Wikitext
2154 * according to $wgNamespaceContentModels
2156 * @param int $ns The namespace ID to check
2161 protected function isWikitextNS( $ns ) {
2162 global $wgNamespaceContentModels;
2164 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
2165 return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
;
2172 * Returns the ID of a namespace that defaults to Wikitext.
2174 * @throws MWException If there is none.
2175 * @return int The ID of the wikitext Namespace
2178 protected function getDefaultWikitextNS() {
2179 global $wgNamespaceContentModels;
2181 static $wikitextNS = null; // this is not going to change
2182 if ( $wikitextNS !== null ) {
2186 // quickly short out on most common case:
2187 if ( !isset( $wgNamespaceContentModels[NS_MAIN
] ) ) {
2191 // NOTE: prefer content namespaces
2192 $namespaces = array_unique( array_merge(
2193 MWNamespace
::getContentNamespaces(),
2194 [ NS_MAIN
, NS_HELP
, NS_PROJECT
], // prefer these
2195 MWNamespace
::getValidNamespaces()
2198 $namespaces = array_diff( $namespaces, [
2199 NS_FILE
, NS_CATEGORY
, NS_MEDIAWIKI
, NS_USER
// don't mess with magic namespaces
2202 $talk = array_filter( $namespaces, function ( $ns ) {
2203 return MWNamespace
::isTalk( $ns );
2206 // prefer non-talk pages
2207 $namespaces = array_diff( $namespaces, $talk );
2208 $namespaces = array_merge( $namespaces, $talk );
2210 // check default content model of each namespace
2211 foreach ( $namespaces as $ns ) {
2212 if ( !isset( $wgNamespaceContentModels[$ns] ) ||
2213 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
2222 // @todo Inside a test, we could skip the test as incomplete.
2223 // But frequently, this is used in fixture setup.
2224 throw new MWException( "No namespace defaults to wikitext!" );
2228 * Check, if $wgDiff3 is set and ready to merge
2229 * Will mark the calling test as skipped, if not ready
2233 protected function markTestSkippedIfNoDiff3() {
2236 # This check may also protect against code injection in
2237 # case of broken installations.
2238 Wikimedia\
suppressWarnings();
2239 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2240 Wikimedia\restoreWarnings
();
2242 if ( !$haveDiff3 ) {
2243 $this->markTestSkipped( "Skip test, since diff3 is not configured" );
2248 * Check if $extName is a loaded PHP extension, will skip the
2249 * test whenever it is not loaded.
2252 * @param string $extName
2255 protected function checkPHPExtension( $extName ) {
2256 $loaded = extension_loaded( $extName );
2258 $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
2265 * Skip the test if using the specified database type
2267 * @param string $type Database type
2270 protected function markTestSkippedIfDbType( $type ) {
2271 if ( $this->db
->getType() === $type ) {
2272 $this->markTestSkipped( "The $type database type isn't supported for this test" );
2277 * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
2278 * @param string $buffer
2281 public static function wfResetOutputBuffersBarrier( $buffer ) {
2286 * Create a temporary hook handler which will be reset by tearDown.
2287 * This replaces other handlers for the same hook.
2288 * @param string $hookName Hook name
2289 * @param mixed $handler Value suitable for a hook handler
2292 protected function setTemporaryHook( $hookName, $handler ) {
2293 $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
2297 * Check whether file contains given data.
2298 * @param string $fileName
2299 * @param string $actualData
2300 * @param bool $createIfMissing If true, and file does not exist, create it with given data
2301 * and skip the test.
2302 * @param string $msg
2305 protected function assertFileContains(
2308 $createIfMissing = false,
2311 if ( $createIfMissing ) {
2312 if ( !file_exists( $fileName ) ) {
2313 file_put_contents( $fileName, $actualData );
2314 $this->markTestSkipped( 'Data file $fileName does not exist' );
2317 self
::assertFileExists( $fileName );
2319 self
::assertEquals( file_get_contents( $fileName ), $actualData, $msg );
2323 * Edits or creates a page/revision
2324 * @param string $pageName Page title
2325 * @param string $text Content of the page
2326 * @param string $summary Optional summary string for the revision
2327 * @param int $defaultNs Optional namespace id
2328 * @return array Array as returned by WikiPage::doEditContent()
2329 * @throws MWException If this test cases's needsDB() method doesn't return true.
2330 * Test cases can use "@group Database" to enable database test support,
2331 * or list the tables under testing in $this->tablesUsed, or override the
2334 protected function editPage( $pageName, $text, $summary = '', $defaultNs = NS_MAIN
) {
2335 if ( !$this->needsDB() ) {
2336 throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
2337 ' method should return true. Use @group Database or $this->tablesUsed.' );
2340 $title = Title
::newFromText( $pageName, $defaultNs );
2341 $page = WikiPage
::factory( $title );
2343 return $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $summary );
2347 * Revision-deletes a revision.
2349 * @param Revision|int $rev Revision to delete
2350 * @param array $value Keys are Revision::DELETED_* flags. Values are 1 to set the bit, 0 to
2351 * clear, -1 to leave alone. (All other values also clear the bit.)
2352 * @param string $comment Deletion comment
2354 protected function revisionDelete(
2355 $rev, array $value = [ Revision
::DELETED_TEXT
=> 1 ], $comment = ''
2357 if ( is_int( $rev ) ) {
2358 $rev = Revision
::newFromId( $rev );
2360 RevisionDeleter
::createList(
2361 'revision', RequestContext
::getMain(), $rev->getTitle(), [ $rev->getId() ]
2364 'comment' => $comment,