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 original service locator. This is overridden during setUp().
25 * @var MediaWikiServices|null
27 private static $originalServices;
30 * The local service locator, created during setUp().
32 private $localServices;
35 * $called tracks whether the setUp and tearDown method has been called.
36 * class extending MediaWikiTestCase usually override setUp and tearDown
37 * but forget to call the parent.
39 * The array format takes a method name as key and anything as a value.
40 * By asserting the key exist, we know the child class has called the
43 * This property must be private, we do not want child to override it,
44 * they should call the appropriate parent method instead.
66 protected $tablesUsed = []; // tables with data
68 private static $useTemporaryTables = true;
69 private static $reuseDB = false;
70 private static $dbSetup = false;
71 private static $oldTablePrefix = '';
74 * Original value of PHP's error_reporting setting.
78 private $phpErrorLevel;
81 * Holds the paths of temporary files/directories created through getNewTempFile,
82 * and getNewTempDirectory
86 private $tmpFiles = [];
89 * Holds original values of MediaWiki configuration settings
90 * to be restored in tearDown().
91 * See also setMwGlobals().
94 private $mwGlobals = [];
97 * Holds list of MediaWiki configuration settings to be unset in tearDown().
98 * See also setMwGlobals().
101 private $mwGlobalsToUnset = [];
104 * Holds original loggers which have been replaced by setLogger()
105 * @var LoggerInterface[]
107 private $loggers = [];
110 * The CLI arguments passed through from phpunit.php
113 private $cliArgs = [];
116 * Table name prefixes. Oracle likes it shorter.
118 const DB_PREFIX
= 'unittest_';
119 const ORA_DB_PREFIX
= 'ut_';
125 protected $supportedDBs = [
132 public function __construct( $name = null, array $data = [], $dataName = '' ) {
133 parent
::__construct( $name, $data, $dataName );
135 $this->backupGlobals
= false;
136 $this->backupStaticAttributes
= false;
139 public function __destruct() {
140 // Complain if self::setUp() was called, but not self::tearDown()
141 // $this->called['setUp'] will be checked by self::testMediaWikiTestCaseParentSetupCalled()
142 if ( isset( $this->called
['setUp'] ) && !isset( $this->called
['tearDown'] ) ) {
143 throw new MWException( static::class . "::tearDown() must call parent::tearDown()" );
147 public static function setUpBeforeClass() {
148 parent
::setUpBeforeClass();
150 // Get the original service locator
151 if ( !self
::$originalServices ) {
152 self
::$originalServices = MediaWikiServices
::getInstance();
157 * Convenience method for getting an immutable test user
161 * @param string[] $groups Groups the test user should be in.
164 public static function getTestUser( $groups = [] ) {
165 return TestUserRegistry
::getImmutableTestUser( $groups );
169 * Convenience method for getting a mutable test user
173 * @param string[] $groups Groups the test user should be added in.
176 public static function getMutableTestUser( $groups = [] ) {
177 return TestUserRegistry
::getMutableTestUser( __CLASS__
, $groups );
181 * Convenience method for getting an immutable admin test user
185 * @param string[] $groups Groups the test user should be added to.
188 public static function getTestSysop() {
189 return self
::getTestUser( [ 'sysop', 'bureaucrat' ] );
193 * Returns a WikiPage representing an existing page.
197 * @param Title|string|null $title
199 * @throws MWException
201 protected function getExistingTestPage( $title = null ) {
202 $title = ( $title === null ) ?
'UTPage' : $title;
203 $title = is_string( $title ) ? Title
::newFromText( $title ) : $title;
204 $page = WikiPage
::factory( $title );
206 if ( !$page->exists() ) {
207 $user = self
::getTestSysop()->getUser();
208 $page->doEditContent(
209 new WikitextContent( 'UTContent' ),
211 EDIT_NEW | EDIT_SUPPRESS_RC
,
221 * Returns a WikiPage representing a non-existing page.
225 * @param Title|string|null $title
227 * @throws MWException
229 protected function getNonexistingTestPage( $title = null ) {
230 $title = ( $title === null ) ?
'UTPage-' . rand( 0, 100000 ) : $title;
231 $title = is_string( $title ) ? Title
::newFromText( $title ) : $title;
232 $page = WikiPage
::factory( $title );
234 if ( $page->exists() ) {
235 $page->doDeleteArticle( 'Testing' );
242 * @deprecated since 1.32
244 public static function prepareServices( Config
$bootstrapConfig ) {
248 * Create a config suitable for testing, based on a base config, default overrides,
249 * and custom overrides.
251 * @param Config|null $baseConfig
252 * @param Config|null $customOverrides
256 private static function makeTestConfig(
257 Config
$baseConfig = null,
258 Config
$customOverrides = null
260 $defaultOverrides = new HashConfig();
262 if ( !$baseConfig ) {
263 $baseConfig = self
::$originalServices->getBootstrapConfig();
266 /* Some functions require some kind of caching, and will end up using the db,
267 * which we can't allow, as that would open a new connection for mysql.
268 * Replace with a HashBag. They would not be going to persist anyway.
270 $hashCache = [ 'class' => HashBagOStuff
::class, 'reportDupes' => false ];
272 CACHE_DB
=> $hashCache,
273 CACHE_ACCEL
=> $hashCache,
274 CACHE_MEMCACHED
=> $hashCache,
276 'apcu' => $hashCache,
277 'wincache' => $hashCache,
278 ] +
$baseConfig->get( 'ObjectCaches' );
280 $defaultOverrides->set( 'ObjectCaches', $objectCaches );
281 $defaultOverrides->set( 'MainCacheType', CACHE_NONE
);
282 $defaultOverrides->set( 'JobTypeConf', [ 'default' => [ 'class' => JobQueueMemory
::class ] ] );
284 // Use a fast hash algorithm to hash passwords.
285 $defaultOverrides->set( 'PasswordDefault', 'A' );
287 $testConfig = $customOverrides
288 ?
new MultiConfig( [ $customOverrides, $defaultOverrides, $baseConfig ] )
289 : new MultiConfig( [ $defaultOverrides, $baseConfig ] );
295 * @param ConfigFactory $oldConfigFactory
296 * @param LBFactory $oldLoadBalancerFactory
297 * @param MediaWikiServices $newServices
299 * @throws MWException
301 private static function installTestServices(
302 ConfigFactory
$oldConfigFactory,
303 LBFactory
$oldLoadBalancerFactory,
304 MediaWikiServices
$newServices
306 // Use bootstrap config for all configuration.
307 // This allows config overrides via global variables to take effect.
308 $bootstrapConfig = $newServices->getBootstrapConfig();
309 $newServices->resetServiceForTesting( 'ConfigFactory' );
310 $newServices->redefineService(
312 self
::makeTestConfigFactoryInstantiator(
314 [ 'main' => $bootstrapConfig ]
317 $newServices->resetServiceForTesting( 'DBLoadBalancerFactory' );
318 $newServices->redefineService(
319 'DBLoadBalancerFactory',
320 function ( MediaWikiServices
$services ) use ( $oldLoadBalancerFactory ) {
321 return $oldLoadBalancerFactory;
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 private 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 $needsResetDB = false;
391 if ( !self
::$dbSetup ||
$this->needsDB() ) {
392 // set up a DB connection for this test to use
394 self
::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
395 self
::$reuseDB = $this->getCliArg( 'reuse-db' );
397 $this->db
= wfGetDB( DB_MASTER
);
399 $this->checkDbIsSupported();
401 if ( !self
::$dbSetup ) {
402 $this->setupAllTestDBs();
403 $this->addCoreDBData();
406 // TODO: the DB setup should be done in setUpBeforeClass(), so the test DB
407 // is available in subclass's setUpBeforeClass() and setUp() methods.
408 // This would also remove the need for the HACK that is oncePerClass().
409 if ( $this->oncePerClass() ) {
410 $this->setUpSchema( $this->db
);
411 $this->resetDB( $this->db
, $this->tablesUsed
);
412 $this->addDBDataOnce();
416 $needsResetDB = true;
419 parent
::run( $result );
421 if ( $needsResetDB ) {
422 $this->resetDB( $this->db
, $this->tablesUsed
);
425 $this->localServices
->destroy();
426 $this->localServices
= null;
427 MediaWikiServices
::forceGlobalInstance( self
::$originalServices );
433 private function oncePerClass() {
434 // Remember current test class in the database connection,
435 // so we know when we need to run addData.
437 $class = static::class;
439 $first = !isset( $this->db
->_hasDataForTestClass
)
440 ||
$this->db
->_hasDataForTestClass
!== $class;
442 $this->db
->_hasDataForTestClass
= $class;
451 public function usesTemporaryTables() {
452 return self
::$useTemporaryTables;
456 * Obtains a new temporary file name
458 * The obtained filename is enlisted to be removed upon tearDown
462 * @return string Absolute name of the temporary file
464 protected function getNewTempFile() {
465 $fileName = tempnam( wfTempDir(), 'MW_PHPUnit_' . static::class . '_' );
466 $this->tmpFiles
[] = $fileName;
472 * obtains a new temporary directory
474 * The obtained directory is enlisted to be removed (recursively with all its contained
475 * files) upon tearDown.
479 * @return string Absolute name of the temporary directory
481 protected function getNewTempDirectory() {
482 // Starting of with a temporary /file/.
483 $fileName = $this->getNewTempFile();
485 // Converting the temporary /file/ to a /directory/
486 // The following is not atomic, but at least we now have a single place,
487 // where temporary directory creation is bundled and can be improved
489 $this->assertTrue( wfMkdirParents( $fileName ) );
494 protected function setUp() {
496 $this->called
['setUp'] = true;
498 $this->phpErrorLevel
= intval( ini_get( 'error_reporting' ) );
500 // Cleaning up temporary files
501 foreach ( $this->tmpFiles
as $fileName ) {
502 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
504 } elseif ( is_dir( $fileName ) ) {
505 wfRecursiveRemoveDir( $fileName );
509 if ( $this->needsDB() && $this->db
) {
510 // Clean up open transactions
511 while ( $this->db
->trxLevel() > 0 ) {
512 $this->db
->rollback( __METHOD__
, 'flush' );
514 // Check for unsafe queries
515 if ( $this->db
->getType() === 'mysql' ) {
516 $this->db
->query( "SET sql_mode = 'STRICT_ALL_TABLES'", __METHOD__
);
520 // Reset all caches between tests.
521 $this->resetNonServiceCaches();
523 // XXX: reset maintenance triggers
524 // Hook into period lag checks which often happen in long-running scripts
525 $lbFactory = $this->localServices
->getDBLoadBalancerFactory();
526 Maintenance
::setLBFactoryTriggers( $lbFactory, $this->localServices
->getMainConfig() );
528 ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
531 protected function addTmpFiles( $files ) {
532 $this->tmpFiles
= array_merge( $this->tmpFiles
, (array)$files );
535 protected function tearDown() {
536 global $wgRequest, $wgSQLMode;
538 $status = ob_get_status();
539 if ( isset( $status['name'] ) &&
540 $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier'
545 $this->called
['tearDown'] = true;
546 // Cleaning up temporary files
547 foreach ( $this->tmpFiles
as $fileName ) {
548 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
550 } elseif ( is_dir( $fileName ) ) {
551 wfRecursiveRemoveDir( $fileName );
555 if ( $this->needsDB() && $this->db
) {
556 // Clean up open transactions
557 while ( $this->db
->trxLevel() > 0 ) {
558 $this->db
->rollback( __METHOD__
, 'flush' );
560 if ( $this->db
->getType() === 'mysql' ) {
561 $this->db
->query( "SET sql_mode = " . $this->db
->addQuotes( $wgSQLMode ),
566 // Restore mw globals
567 foreach ( $this->mwGlobals
as $key => $value ) {
568 $GLOBALS[$key] = $value;
570 foreach ( $this->mwGlobalsToUnset
as $value ) {
571 unset( $GLOBALS[$value] );
574 array_key_exists( 'wgExtraNamespaces', $this->mwGlobals
) ||
575 in_array( 'wgExtraNamespaces', $this->mwGlobalsToUnset
)
577 $this->resetNamespaces();
579 $this->mwGlobals
= [];
580 $this->mwGlobalsToUnset
= [];
581 $this->restoreLoggers();
583 // TODO: move global state into MediaWikiServices
584 RequestContext
::resetMain();
585 if ( session_id() !== '' ) {
586 session_write_close();
589 $wgRequest = new FauxRequest();
590 MediaWiki\Session\SessionManager
::resetCache();
591 MediaWiki\Auth\AuthManager
::resetCache();
593 $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
595 if ( $phpErrorLevel !== $this->phpErrorLevel
) {
596 ini_set( 'error_reporting', $this->phpErrorLevel
);
598 $oldHex = strtoupper( dechex( $this->phpErrorLevel
) );
599 $newHex = strtoupper( dechex( $phpErrorLevel ) );
600 $message = "PHP error_reporting setting was left dirty: "
601 . "was 0x$oldHex before test, 0x$newHex after test!";
603 $this->fail( $message );
610 * Make sure MediaWikiTestCase extending classes have called their
611 * parent setUp method
613 * With strict coverage activated in PHP_CodeCoverage, this test would be
614 * marked as risky without the following annotation (T152923).
617 final public function testMediaWikiTestCaseParentSetupCalled() {
618 $this->assertArrayHasKey( 'setUp', $this->called
,
619 static::class . '::setUp() must call parent::setUp()'
624 * Sets a service, maintaining a stashed version of the previous service to be
625 * restored in tearDown
629 * @param string $name
630 * @param object $object
632 protected function setService( $name, $object ) {
633 if ( !$this->localServices
) {
634 throw new Exception( __METHOD__
. ' must be called after MediaWikiTestCase::run()' );
637 $this->localServices
->disableService( $name );
638 $this->localServices
->redefineService(
640 function () use ( $object ) {
645 if ( $name === 'ContentLanguage' ) {
646 $this->doSetMwGlobals( [ 'wgContLang' => $object ] );
651 * Sets a global, maintaining a stashed version of the previous global to be
652 * restored in tearDown
654 * The key is added to the array of globals that will be reset afterwards
659 * protected function setUp() {
660 * $this->setMwGlobals( 'wgRestrictStuff', true );
663 * function testFoo() {}
665 * function testBar() {}
666 * $this->assertTrue( self::getX()->doStuff() );
668 * $this->setMwGlobals( 'wgRestrictStuff', false );
669 * $this->assertTrue( self::getX()->doStuff() );
672 * function testQuux() {}
675 * @param array|string $pairs Key to the global variable, or an array
676 * of key/value pairs.
677 * @param mixed|null $value Value to set the global to (ignored
678 * if an array is given as first argument).
680 * @note To allow changes to global variables to take effect on global service instances,
681 * call overrideMwServices().
685 protected function setMwGlobals( $pairs, $value = null ) {
686 if ( is_string( $pairs ) ) {
687 $pairs = [ $pairs => $value ];
690 if ( isset( $pairs['wgContLang'] ) ) {
691 throw new MWException(
692 'No setting $wgContLang, use setContentLang() or setService( \'ContentLanguage\' )'
696 $this->doSetMwGlobals( $pairs, $value );
700 * An internal method that allows setService() to set globals that tests are not supposed to
703 private function doSetMwGlobals( $pairs, $value = null ) {
704 $this->stashMwGlobals( array_keys( $pairs ) );
706 foreach ( $pairs as $key => $value ) {
707 $GLOBALS[$key] = $value;
710 if ( array_key_exists( 'wgExtraNamespaces', $pairs ) ) {
711 $this->resetNamespaces();
716 * Must be called whenever namespaces are changed, e.g., $wgExtraNamespaces is altered.
717 * Otherwise old namespace data will lurk and cause bugs.
719 private function resetNamespaces() {
720 if ( !$this->localServices
) {
721 throw new Exception( __METHOD__
. ' must be called after MediaWikiTestCase::run()' );
723 MWNamespace
::clearCaches();
724 Language
::clearCaches();
726 // We can't have the TitleFormatter holding on to an old Language object either
727 // @todo We shouldn't need to reset all the aliases here.
728 $this->localServices
->resetServiceForTesting( 'TitleFormatter' );
729 $this->localServices
->resetServiceForTesting( 'TitleParser' );
730 $this->localServices
->resetServiceForTesting( '_MediaWikiTitleCodec' );
734 * Check if we can back up a value by performing a shallow copy.
735 * Values which fail this test are copied recursively.
737 * @param mixed $value
738 * @return bool True if a shallow copy will do; false if a deep copy
741 private static function canShallowCopy( $value ) {
742 if ( is_scalar( $value ) ||
$value === null ) {
745 if ( is_array( $value ) ) {
746 foreach ( $value as $subValue ) {
747 if ( !is_scalar( $subValue ) && $subValue !== null ) {
757 * Stashes the global, will be restored in tearDown()
759 * Individual test functions may override globals through the setMwGlobals() function
760 * or directly. When directly overriding globals their keys should first be passed to this
761 * method in setUp to avoid breaking global state for other tests
763 * That way all other tests are executed with the same settings (instead of using the
764 * unreliable local settings for most tests and fix it only for some tests).
766 * @param array|string $globalKeys Key to the global variable, or an array of keys.
768 * @note To allow changes to global variables to take effect on global service instances,
769 * call overrideMwServices().
773 protected function stashMwGlobals( $globalKeys ) {
774 if ( is_string( $globalKeys ) ) {
775 $globalKeys = [ $globalKeys ];
778 foreach ( $globalKeys as $globalKey ) {
779 // NOTE: make sure we only save the global once or a second call to
780 // setMwGlobals() on the same global would override the original
783 !array_key_exists( $globalKey, $this->mwGlobals
) &&
784 !array_key_exists( $globalKey, $this->mwGlobalsToUnset
)
786 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
787 $this->mwGlobalsToUnset
[$globalKey] = $globalKey;
790 // NOTE: we serialize then unserialize the value in case it is an object
791 // this stops any objects being passed by reference. We could use clone
792 // and if is_object but this does account for objects within objects!
793 if ( self
::canShallowCopy( $GLOBALS[$globalKey] ) ) {
794 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
796 // Many MediaWiki types are safe to clone. These are the
797 // ones that are most commonly stashed.
798 $GLOBALS[$globalKey] instanceof Language ||
799 $GLOBALS[$globalKey] instanceof User ||
800 $GLOBALS[$globalKey] instanceof FauxRequest
802 $this->mwGlobals
[$globalKey] = clone $GLOBALS[$globalKey];
803 } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
804 // Serializing Closure only gives a warning on HHVM while
805 // it throws an Exception on Zend.
806 // Workaround for https://github.com/facebook/hhvm/issues/6206
807 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
810 $this->mwGlobals
[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
811 } catch ( Exception
$e ) {
812 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
821 * @param int $maxDepth
825 private function containsClosure( $var, $maxDepth = 15 ) {
826 if ( $var instanceof Closure
) {
829 if ( !is_array( $var ) ||
$maxDepth === 0 ) {
833 foreach ( $var as $value ) {
834 if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
842 * Merges the given values into a MW global array variable.
843 * Useful for setting some entries in a configuration array, instead of
844 * setting the entire array.
846 * @param string $name The name of the global, as in wgFooBar
847 * @param array $values The array containing the entries to set in that global
849 * @throws MWException If the designated global is not an array.
851 * @note To allow changes to global variables to take effect on global service instances,
852 * call overrideMwServices().
856 protected function mergeMwGlobalArrayValue( $name, $values ) {
857 if ( !isset( $GLOBALS[$name] ) ) {
860 if ( !is_array( $GLOBALS[$name] ) ) {
861 throw new MWException( "MW global $name is not an array." );
864 // NOTE: do not use array_merge, it screws up for numeric keys.
865 $merged = $GLOBALS[$name];
866 foreach ( $values as $k => $v ) {
871 $this->setMwGlobals( $name, $merged );
875 * Stashes the global instance of MediaWikiServices, and installs a new one,
876 * allowing test cases to override settings and services.
877 * The previous instance of MediaWikiServices will be restored on tearDown.
881 * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
883 * @param callable[] $services An associative array of services to re-define. Keys are service
884 * names, values are callables.
886 * @return MediaWikiServices
887 * @throws MWException
889 protected function overrideMwServices(
890 Config
$configOverrides = null, array $services = []
892 if ( !$configOverrides ) {
893 $configOverrides = new HashConfig();
896 $oldConfigFactory = self
::$originalServices->getConfigFactory();
897 $oldLoadBalancerFactory = self
::$originalServices->getDBLoadBalancerFactory();
899 $testConfig = self
::makeTestConfig( null, $configOverrides );
900 $newInstance = new MediaWikiServices( $testConfig );
902 // Load the default wiring from the specified files.
903 // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
904 $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
905 $newInstance->loadWiringFiles( $wiringFiles );
907 // Provide a traditional hook point to allow extensions to configure services.
908 Hooks
::run( 'MediaWikiServices', [ $newInstance ] );
910 foreach ( $services as $name => $callback ) {
911 $newInstance->redefineService( $name, $callback );
914 self
::installTestServices(
916 $oldLoadBalancerFactory,
920 if ( $this->localServices
) {
921 $this->localServices
->destroy();
924 MediaWikiServices
::forceGlobalInstance( $newInstance );
925 $this->localServices
= $newInstance;
932 * @param string|Language $lang
934 public function setUserLang( $lang ) {
935 RequestContext
::getMain()->setLanguage( $lang );
936 $this->setMwGlobals( 'wgLang', RequestContext
::getMain()->getLanguage() );
941 * @param string|Language $lang
943 public function setContentLang( $lang ) {
944 if ( $lang instanceof Language
) {
945 $langCode = $lang->getCode();
949 $langObj = Language
::factory( $langCode );
951 $this->setMwGlobals( 'wgLanguageCode', $langCode );
952 $this->setService( 'ContentLanguage', $langObj );
956 * Alters $wgGroupPermissions for the duration of the test. Can be called
957 * with an array, like
958 * [ '*' => [ 'read' => false ], 'user' => [ 'read' => false ] ]
959 * or three values to set a single permission, like
960 * $this->setGroupPermissions( '*', 'read', false );
963 * @param array|string $newPerms Either an array of permissions to change,
964 * in which case the next two parameters are ignored; or a single string
965 * identifying a group, to use with the next two parameters.
966 * @param string|null $newKey
967 * @param mixed|null $newValue
969 public function setGroupPermissions( $newPerms, $newKey = null, $newValue = null ) {
970 global $wgGroupPermissions;
972 $this->stashMwGlobals( 'wgGroupPermissions' );
974 if ( is_string( $newPerms ) ) {
975 $newPerms = [ $newPerms => [ $newKey => $newValue ] ];
978 foreach ( $newPerms as $group => $permissions ) {
979 foreach ( $permissions as $key => $value ) {
980 $wgGroupPermissions[$group][$key] = $value;
986 * Sets the logger for a specified channel, for the duration of the test.
988 * @param string $channel
989 * @param LoggerInterface $logger
991 protected function setLogger( $channel, LoggerInterface
$logger ) {
992 // TODO: Once loggers are managed by MediaWikiServices, use
993 // overrideMwServices() to set loggers.
995 $provider = LoggerFactory
::getProvider();
996 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
997 $singletons = $wrappedProvider->singletons
;
998 if ( $provider instanceof MonologSpi
) {
999 if ( !isset( $this->loggers
[$channel] ) ) {
1000 $this->loggers
[$channel] = $singletons['loggers'][$channel] ??
null;
1002 $singletons['loggers'][$channel] = $logger;
1003 } elseif ( $provider instanceof LegacySpi
) {
1004 if ( !isset( $this->loggers
[$channel] ) ) {
1005 $this->loggers
[$channel] = $singletons[$channel] ??
null;
1007 $singletons[$channel] = $logger;
1009 throw new LogicException( __METHOD__
. ': setting a logger for ' . get_class( $provider )
1010 . ' is not implemented' );
1012 $wrappedProvider->singletons
= $singletons;
1016 * Restores loggers replaced by setLogger().
1019 private function restoreLoggers() {
1020 $provider = LoggerFactory
::getProvider();
1021 $wrappedProvider = TestingAccessWrapper
::newFromObject( $provider );
1022 $singletons = $wrappedProvider->singletons
;
1023 foreach ( $this->loggers
as $channel => $logger ) {
1024 if ( $provider instanceof MonologSpi
) {
1025 if ( $logger === null ) {
1026 unset( $singletons['loggers'][$channel] );
1028 $singletons['loggers'][$channel] = $logger;
1030 } elseif ( $provider instanceof LegacySpi
) {
1031 if ( $logger === null ) {
1032 unset( $singletons[$channel] );
1034 $singletons[$channel] = $logger;
1038 $wrappedProvider->singletons
= $singletons;
1039 $this->loggers
= [];
1046 public function dbPrefix() {
1047 return self
::getTestPrefixFor( $this->db
);
1051 * @param IDatabase $db
1055 public static function getTestPrefixFor( IDatabase
$db ) {
1056 return $db->getType() == 'oracle' ? self
::ORA_DB_PREFIX
: self
::DB_PREFIX
;
1063 public function needsDB() {
1064 // If the test says it uses database tables, it needs the database
1065 if ( $this->tablesUsed
) {
1069 // If the test class says it belongs to the Database group, it needs the database.
1070 // NOTE: This ONLY checks for the group in the class level doc comment.
1071 $rc = new ReflectionClass( $this );
1072 if ( preg_match( '/@group +Database/im', $rc->getDocComment() ) ) {
1080 * Insert a new page.
1082 * Should be called from addDBData().
1084 * @since 1.25 ($namespace in 1.28)
1085 * @param string|Title $pageName Page name or title
1086 * @param string $text Page's content
1087 * @param int|null $namespace Namespace id (name cannot already contain namespace)
1088 * @param User|null $user If null, static::getTestSysop()->getUser() is used.
1089 * @return array Title object and page id
1091 protected function insertPage(
1093 $text = 'Sample page for unit test.',
1097 if ( is_string( $pageName ) ) {
1098 $title = Title
::newFromText( $pageName, $namespace );
1104 $user = static::getTestSysop()->getUser();
1106 $comment = __METHOD__
. ': Sample page for unit test.';
1108 $page = WikiPage
::factory( $title );
1109 $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $comment, 0, false, $user );
1113 'id' => $page->getId(),
1118 * Stub. If a test suite needs to add additional data to the database, it should
1119 * implement this method and do so. This method is called once per test suite
1120 * (i.e. once per class).
1122 * Note data added by this method may be removed by resetDB() depending on
1123 * the contents of $tablesUsed.
1125 * To add additional data between test function runs, override prepareDB().
1132 public function addDBDataOnce() {
1136 * Stub. Subclasses may override this to prepare the database.
1137 * Called before every test run (test function or data set).
1139 * @see addDBDataOnce()
1144 public function addDBData() {
1150 protected function addCoreDBData() {
1151 if ( $this->db
->getType() == 'oracle' ) {
1152 # Insert 0 user to prevent FK violations
1154 if ( !$this->db
->selectField( 'user', '1', [ 'user_id' => 0 ] ) ) {
1155 $this->db
->insert( 'user', [
1157 'user_name' => 'Anonymous' ], __METHOD__
, [ 'IGNORE' ] );
1160 # Insert 0 page to prevent FK violations
1162 if ( !$this->db
->selectField( 'page', '1', [ 'page_id' => 0 ] ) ) {
1163 $this->db
->insert( 'page', [
1165 'page_namespace' => 0,
1166 'page_title' => ' ',
1167 'page_restrictions' => null,
1168 'page_is_redirect' => 0,
1171 'page_touched' => $this->db
->timestamp(),
1173 'page_len' => 0 ], __METHOD__
, [ 'IGNORE' ] );
1177 SiteStatsInit
::doPlaceholderInit();
1179 User
::resetIdByNameCache();
1182 $user = static::getTestSysop()->getUser();
1184 // Make 1 page with 1 revision
1185 $page = WikiPage
::factory( Title
::newFromText( 'UTPage' ) );
1186 if ( $page->getId() == 0 ) {
1187 $page->doEditContent(
1188 new WikitextContent( 'UTContent' ),
1190 EDIT_NEW | EDIT_SUPPRESS_RC
,
1194 // an edit always attempt to purge backlink links such as history
1195 // pages. That is unnecessary.
1196 JobQueueGroup
::singleton()->get( 'htmlCacheUpdate' )->delete();
1197 // WikiPages::doEditUpdates randomly adds RC purges
1198 JobQueueGroup
::singleton()->get( 'recentChangesUpdate' )->delete();
1200 // doEditContent() probably started the session via
1201 // User::loadFromSession(). Close it now.
1202 if ( session_id() !== '' ) {
1203 session_write_close();
1210 * Restores MediaWiki to using the table set (table prefix) it was using before
1211 * setupTestDB() was called. Useful if we need to perform database operations
1212 * after the test run has finished (such as saving logs or profiling info).
1214 * This is called by phpunit/bootstrap.php after the last test.
1218 public static function teardownTestDB() {
1219 global $wgJobClasses;
1221 if ( !self
::$dbSetup ) {
1225 Hooks
::run( 'UnitTestsBeforeDatabaseTeardown' );
1227 foreach ( $wgJobClasses as $type => $class ) {
1228 // Delete any jobs under the clone DB (or old prefix in other stores)
1229 JobQueueGroup
::singleton()->get( $type )->delete();
1232 CloneDatabase
::changePrefix( self
::$oldTablePrefix );
1234 self
::$oldTablePrefix = false;
1235 self
::$dbSetup = false;
1239 * Prepares the given database connection for usage in the context of usage tests.
1240 * This sets up clones database tables and changes the table prefix as appropriate.
1241 * If the database connection already has cloned tables, calling this method has no
1242 * effect. The tables are not re-cloned or reset in that case.
1244 * @param IMaintainableDatabase $db
1246 protected function prepareConnectionForTesting( IMaintainableDatabase
$db ) {
1247 if ( !self
::$dbSetup ) {
1248 throw new LogicException(
1249 'Cannot use prepareConnectionForTesting()'
1250 . ' if the test case is not defined to use the database!'
1254 if ( isset( $db->_originalTablePrefix
) ) {
1255 // The DB connection was already prepared for testing.
1259 $testPrefix = self
::getTestPrefixFor( $db );
1260 $oldPrefix = $db->tablePrefix();
1262 $tablesCloned = self
::listTables( $db );
1264 if ( $oldPrefix === $testPrefix ) {
1265 // The database connection already has the test prefix, but presumably not
1266 // the cloned tables. This is the typical case, since the LBFactory will
1267 // have the prefix set during testing, but LoadBalancers will still return
1268 // connections that don't have the cloned table structure.
1269 $oldPrefix = self
::$oldTablePrefix;
1272 $dbClone = new CloneDatabase( $db, $tablesCloned, $testPrefix, $oldPrefix );
1273 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1275 $db->_originalTablePrefix
= $oldPrefix;
1277 if ( ( $db->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
1278 throw new LogicException( 'Cannot clone database tables' );
1280 $dbClone->cloneTableStructure();
1285 * Setups a database with cloned tables using the given prefix.
1287 * If reuseDB is true and certain conditions apply, it will just change the prefix.
1288 * Otherwise, it will clone the tables and change the prefix.
1290 * @param IMaintainableDatabase $db Database to use
1291 * @param string|null $prefix Prefix to use for test tables. If not given, the prefix is determined
1292 * automatically for $db.
1293 * @return bool True if tables were cloned, false if only the prefix was changed
1295 protected static function setupDatabaseWithTestPrefix(
1296 IMaintainableDatabase
$db,
1299 if ( $prefix === null ) {
1300 $prefix = self
::getTestPrefixFor( $db );
1303 if ( ( $db->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
1304 $db->tablePrefix( $prefix );
1308 if ( !isset( $db->_originalTablePrefix
) ) {
1309 $oldPrefix = $db->tablePrefix();
1311 if ( $oldPrefix === $prefix ) {
1312 // table already has the correct prefix, but presumably no cloned tables
1313 $oldPrefix = self
::$oldTablePrefix;
1316 $db->tablePrefix( $oldPrefix );
1317 $tablesCloned = self
::listTables( $db );
1318 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix, $oldPrefix );
1319 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1321 $dbClone->cloneTableStructure();
1323 $db->tablePrefix( $prefix );
1324 $db->_originalTablePrefix
= $oldPrefix;
1331 * Set up all test DBs
1333 public function setupAllTestDBs() {
1336 self
::$oldTablePrefix = $wgDBprefix;
1338 $testPrefix = $this->dbPrefix();
1340 // switch to a temporary clone of the database
1341 self
::setupTestDB( $this->db
, $testPrefix );
1343 if ( self
::isUsingExternalStoreDB() ) {
1344 self
::setupExternalStoreTestDBs( $testPrefix );
1347 // NOTE: Change the prefix in the LBFactory and $wgDBprefix, to prevent
1348 // *any* database connections to operate on live data.
1349 CloneDatabase
::changePrefix( $testPrefix );
1353 * Creates an empty skeleton of the wiki database by cloning its structure
1354 * to equivalent tables using the given $prefix. Then sets MediaWiki to
1355 * use the new set of tables (aka schema) instead of the original set.
1357 * This is used to generate a dummy table set, typically consisting of temporary
1358 * tables, that will be used by tests instead of the original wiki database tables.
1362 * @note the original table prefix is stored in self::$oldTablePrefix. This is used
1363 * by teardownTestDB() to return the wiki to using the original table set.
1365 * @note this method only works when first called. Subsequent calls have no effect,
1366 * even if using different parameters.
1368 * @param Database $db The database connection
1369 * @param string $prefix The prefix to use for the new table set (aka schema).
1371 * @throws MWException If the database table prefix is already $prefix
1373 public static function setupTestDB( Database
$db, $prefix ) {
1374 if ( self
::$dbSetup ) {
1378 if ( $db->tablePrefix() === $prefix ) {
1379 throw new MWException(
1380 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
1383 // TODO: the below should be re-written as soon as LBFactory, LoadBalancer,
1384 // and Database no longer use global state.
1386 self
::$dbSetup = true;
1388 if ( !self
::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
1392 // Assuming this isn't needed for External Store database, and not sure if the procedure
1393 // would be available there.
1394 if ( $db->getType() == 'oracle' ) {
1395 $db->query( 'BEGIN FILL_WIKI_INFO; END;', __METHOD__
);
1398 Hooks
::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
1402 * Clones the External Store database(s) for testing
1404 * @param string|null $testPrefix Prefix for test tables. Will be determined automatically
1407 protected static function setupExternalStoreTestDBs( $testPrefix = null ) {
1408 $connections = self
::getExternalStoreDatabaseConnections();
1409 foreach ( $connections as $dbw ) {
1410 self
::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
1415 * Gets master database connections for all of the ExternalStoreDB
1416 * stores configured in $wgDefaultExternalStore.
1418 * @return Database[] Array of Database master connections
1420 protected static function getExternalStoreDatabaseConnections() {
1421 global $wgDefaultExternalStore;
1423 /** @var ExternalStoreDB $externalStoreDB */
1424 $externalStoreDB = ExternalStore
::getStoreObject( 'DB' );
1425 $defaultArray = (array)$wgDefaultExternalStore;
1427 foreach ( $defaultArray as $url ) {
1428 if ( strpos( $url, 'DB://' ) === 0 ) {
1429 list( $proto, $cluster ) = explode( '://', $url, 2 );
1430 // Avoid getMaster() because setupDatabaseWithTestPrefix()
1431 // requires Database instead of plain DBConnRef/IDatabase
1432 $dbws[] = $externalStoreDB->getMaster( $cluster );
1440 * Check whether ExternalStoreDB is being used
1442 * @return bool True if it's being used
1444 protected static function isUsingExternalStoreDB() {
1445 global $wgDefaultExternalStore;
1446 if ( !$wgDefaultExternalStore ) {
1450 $defaultArray = (array)$wgDefaultExternalStore;
1451 foreach ( $defaultArray as $url ) {
1452 if ( strpos( $url, 'DB://' ) === 0 ) {
1461 * @throws LogicException if the given database connection is not a set up to use
1464 * @since 1.31 this is no longer private.
1466 protected function ensureMockDatabaseConnection( IDatabase
$db ) {
1467 if ( $db->tablePrefix() !== $this->dbPrefix() ) {
1468 throw new LogicException(
1469 'Trying to delete mock tables, but table prefix does not indicate a mock database.'
1474 private static $schemaOverrideDefaults = [
1482 * Stub. If a test suite needs to test against a specific database schema, it should
1483 * override this method and return the appropriate information from it.
1485 * @param IMaintainableDatabase $db The DB connection to use for the mock schema.
1486 * May be used to check the current state of the schema, to determine what
1487 * overrides are needed.
1489 * @return array An associative array with the following fields:
1490 * - 'scripts': any SQL scripts to run. If empty or not present, schema overrides are skipped.
1491 * - 'create': A list of tables created (may or may not exist in the original schema).
1492 * - 'drop': A list of tables dropped (expected to be present in the original schema).
1493 * - 'alter': A list of tables altered (expected to be present in the original schema).
1495 protected function getSchemaOverrides( IMaintainableDatabase
$db ) {
1500 * Undoes the specified schema overrides..
1501 * Called once per test class, just before addDataOnce().
1503 * @param IMaintainableDatabase $db
1504 * @param array $oldOverrides
1506 private function undoSchemaOverrides( IMaintainableDatabase
$db, $oldOverrides ) {
1507 $this->ensureMockDatabaseConnection( $db );
1509 $oldOverrides = $oldOverrides + self
::$schemaOverrideDefaults;
1510 $originalTables = $this->listOriginalTables( $db, 'unprefixed' );
1512 // Drop tables that need to be restored or removed.
1513 $tablesToDrop = array_merge( $oldOverrides['create'], $oldOverrides['alter'] );
1515 // Restore tables that have been dropped or created or altered,
1516 // if they exist in the original schema.
1517 $tablesToRestore = array_merge( $tablesToDrop, $oldOverrides['drop'] );
1518 $tablesToRestore = array_intersect( $originalTables, $tablesToRestore );
1520 if ( $tablesToDrop ) {
1521 $this->dropMockTables( $db, $tablesToDrop );
1524 if ( $tablesToRestore ) {
1525 $this->recloneMockTables( $db, $tablesToRestore );
1530 * Applies the schema overrides returned by getSchemaOverrides(),
1531 * after undoing any previously applied schema overrides.
1532 * Called once per test class, just before addDataOnce().
1534 private function setUpSchema( IMaintainableDatabase
$db ) {
1535 // Undo any active overrides.
1536 $oldOverrides = $db->_schemaOverrides ?? self
::$schemaOverrideDefaults;
1538 if ( $oldOverrides['alter'] ||
$oldOverrides['create'] ||
$oldOverrides['drop'] ) {
1539 $this->undoSchemaOverrides( $db, $oldOverrides );
1542 // Determine new overrides.
1543 $overrides = $this->getSchemaOverrides( $db ) + self
::$schemaOverrideDefaults;
1545 $extraKeys = array_diff(
1546 array_keys( $overrides ),
1547 array_keys( self
::$schemaOverrideDefaults )
1551 throw new InvalidArgumentException(
1552 'Schema override contains extra keys: ' . var_export( $extraKeys, true )
1556 if ( !$overrides['scripts'] ) {
1557 // no scripts to run
1561 if ( !$overrides['create'] && !$overrides['drop'] && !$overrides['alter'] ) {
1562 throw new InvalidArgumentException(
1563 'Schema override scripts given, but no tables are declared to be '
1564 . 'created, dropped or altered.'
1568 $this->ensureMockDatabaseConnection( $db );
1570 // Drop the tables that will be created by the schema scripts.
1571 $originalTables = $this->listOriginalTables( $db, 'unprefixed' );
1572 $tablesToDrop = array_intersect( $originalTables, $overrides['create'] );
1574 if ( $tablesToDrop ) {
1575 $this->dropMockTables( $db, $tablesToDrop );
1578 // Run schema override scripts.
1579 foreach ( $overrides['scripts'] as $script ) {
1586 return $this->mungeSchemaUpdateQuery( $cmd );
1591 $db->_schemaOverrides
= $overrides;
1594 private function mungeSchemaUpdateQuery( $cmd ) {
1595 return self
::$useTemporaryTables
1596 ?
preg_replace( '/\bCREATE\s+TABLE\b/i', 'CREATE TEMPORARY TABLE', $cmd )
1601 * Drops the given mock tables.
1603 * @param IMaintainableDatabase $db
1604 * @param array $tables
1606 private function dropMockTables( IMaintainableDatabase
$db, array $tables ) {
1607 $this->ensureMockDatabaseConnection( $db );
1609 foreach ( $tables as $tbl ) {
1610 $tbl = $db->tableName( $tbl );
1611 $db->query( "DROP TABLE IF EXISTS $tbl", __METHOD__
);
1616 * Lists all tables in the live database schema.
1618 * @param IMaintainableDatabase $db
1619 * @param string $prefix Either 'prefixed' or 'unprefixed'
1622 private function listOriginalTables( IMaintainableDatabase
$db, $prefix = 'prefixed' ) {
1623 if ( !isset( $db->_originalTablePrefix
) ) {
1624 throw new LogicException( 'No original table prefix know, cannot list tables!' );
1627 $originalTables = $db->listTables( $db->_originalTablePrefix
, __METHOD__
);
1628 if ( $prefix === 'unprefixed' ) {
1629 $originalPrefixRegex = '/^' . preg_quote( $db->_originalTablePrefix
, '/' ) . '/';
1630 $originalTables = array_map(
1631 function ( $pt ) use ( $originalPrefixRegex ) {
1632 return preg_replace( $originalPrefixRegex, '', $pt );
1638 return $originalTables;
1642 * Re-clones the given mock tables to restore them based on the live database schema.
1643 * The tables listed in $tables are expected to currently not exist, so dropMockTables()
1644 * should be called first.
1646 * @param IMaintainableDatabase $db
1647 * @param array $tables
1649 private function recloneMockTables( IMaintainableDatabase
$db, array $tables ) {
1650 $this->ensureMockDatabaseConnection( $db );
1652 if ( !isset( $db->_originalTablePrefix
) ) {
1653 throw new LogicException( 'No original table prefix know, cannot restore tables!' );
1656 $originalTables = $this->listOriginalTables( $db, 'unprefixed' );
1657 $tables = array_intersect( $tables, $originalTables );
1659 $dbClone = new CloneDatabase( $db, $tables, $db->tablePrefix(), $db->_originalTablePrefix
);
1660 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
1662 $dbClone->cloneTableStructure();
1666 * Empty all tables so they can be repopulated for tests
1668 * @param Database $db|null Database to reset
1669 * @param array $tablesUsed Tables to reset
1671 private function resetDB( $db, $tablesUsed ) {
1673 $userTables = [ 'user', 'user_groups', 'user_properties', 'actor' ];
1675 'page', 'revision', 'ip_changes', 'revision_comment_temp', 'comment', 'archive',
1676 'revision_actor_temp', 'slots', 'content', 'content_models', 'slot_roles',
1678 $coreDBDataTables = array_merge( $userTables, $pageTables );
1680 // If any of the user or page tables were marked as used, we should clear all of them.
1681 if ( array_intersect( $tablesUsed, $userTables ) ) {
1682 $tablesUsed = array_unique( array_merge( $tablesUsed, $userTables ) );
1683 TestUserRegistry
::clear();
1685 if ( array_intersect( $tablesUsed, $pageTables ) ) {
1686 $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
1689 // Postgres, Oracle, and MSSQL all use mwuser/pagecontent
1690 // instead of user/text. But Postgres does not remap the
1691 // table name in tableExists(), so we mark the real table
1692 // names as being used.
1693 if ( $db->getType() === 'postgres' ) {
1694 if ( in_array( 'user', $tablesUsed ) ) {
1695 $tablesUsed[] = 'mwuser';
1697 if ( in_array( 'text', $tablesUsed ) ) {
1698 $tablesUsed[] = 'pagecontent';
1702 foreach ( $tablesUsed as $tbl ) {
1703 $this->truncateTable( $tbl, $db );
1706 if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
1707 // Reset services that may contain information relating to the truncated tables
1708 $this->overrideMwServices();
1709 // Re-add core DB data that was deleted
1710 $this->addCoreDBData();
1716 * Empties the given table and resets any auto-increment counters.
1717 * Will also purge caches associated with some well known tables.
1718 * If the table is not know, this method just returns.
1720 * @param string $tableName
1721 * @param IDatabase|null $db
1723 protected function truncateTable( $tableName, IDatabase
$db = null ) {
1728 if ( !$db->tableExists( $tableName ) ) {
1732 $truncate = in_array( $db->getType(), [ 'oracle', 'mysql' ] );
1735 $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tableName ), __METHOD__
);
1737 $db->delete( $tableName, '*', __METHOD__
);
1740 if ( $db instanceof DatabasePostgres ||
$db instanceof DatabaseSqlite
) {
1741 // Reset the table's sequence too.
1742 $db->resetSequenceForTable( $tableName, __METHOD__
);
1745 // re-initialize site_stats table
1746 if ( $tableName === 'site_stats' ) {
1747 SiteStatsInit
::doPlaceholderInit();
1751 private static function unprefixTable( &$tableName, $ind, $prefix ) {
1752 $tableName = substr( $tableName, strlen( $prefix ) );
1755 private static function isNotUnittest( $table ) {
1756 return strpos( $table, self
::DB_PREFIX
) !== 0;
1762 * @param IMaintainableDatabase $db
1766 public static function listTables( IMaintainableDatabase
$db ) {
1767 $prefix = $db->tablePrefix();
1768 $tables = $db->listTables( $prefix, __METHOD__
);
1770 if ( $db->getType() === 'mysql' ) {
1771 static $viewListCache = null;
1772 if ( $viewListCache === null ) {
1773 $viewListCache = $db->listViews( null, __METHOD__
);
1775 // T45571: cannot clone VIEWs under MySQL
1776 $tables = array_diff( $tables, $viewListCache );
1778 array_walk( $tables, [ __CLASS__
, 'unprefixTable' ], $prefix );
1780 // Don't duplicate test tables from the previous fataled run
1781 $tables = array_filter( $tables, [ __CLASS__
, 'isNotUnittest' ] );
1783 if ( $db->getType() == 'sqlite' ) {
1784 $tables = array_flip( $tables );
1785 // these are subtables of searchindex and don't need to be duped/dropped separately
1786 unset( $tables['searchindex_content'] );
1787 unset( $tables['searchindex_segdir'] );
1788 unset( $tables['searchindex_segments'] );
1789 $tables = array_flip( $tables );
1796 * Copy test data from one database connection to another.
1798 * This should only be used for small data sets.
1800 * @param IDatabase $source
1801 * @param IDatabase $target
1803 public function copyTestData( IDatabase
$source, IDatabase
$target ) {
1804 $tables = self
::listOriginalTables( $source, 'unprefixed' );
1806 foreach ( $tables as $table ) {
1807 $res = $source->select( $table, '*', [], __METHOD__
);
1810 foreach ( $res as $row ) {
1811 $allRows[] = (array)$row;
1814 $target->insert( $table, $allRows, __METHOD__
, [ 'IGNORE' ] );
1819 * @throws MWException
1822 protected function checkDbIsSupported() {
1823 if ( !in_array( $this->db
->getType(), $this->supportedDBs
) ) {
1824 throw new MWException( $this->db
->getType() . " is not currently supported for unit testing." );
1830 * @param string $offset
1833 public function getCliArg( $offset ) {
1834 return $this->cliArgs
[$offset] ??
null;
1839 * @param string $offset
1840 * @param mixed $value
1842 public function setCliArg( $offset, $value ) {
1843 $this->cliArgs
[$offset] = $value;
1847 * Don't throw a warning if $function is deprecated and called later
1851 * @param string $function
1853 public function hideDeprecated( $function ) {
1854 Wikimedia\
suppressWarnings();
1855 wfDeprecated( $function );
1856 Wikimedia\restoreWarnings
();
1860 * Asserts that the given database query yields the rows given by $expectedRows.
1861 * The expected rows should be given as indexed (not associative) arrays, with
1862 * the values given in the order of the columns in the $fields parameter.
1863 * Note that the rows are sorted by the columns given in $fields.
1867 * @param string|array $table The table(s) to query
1868 * @param string|array $fields The columns to include in the result (and to sort by)
1869 * @param string|array $condition "where" condition(s)
1870 * @param array $expectedRows An array of arrays giving the expected rows.
1871 * @param array $options Options for the query
1872 * @param array $join_conds Join conditions for the query
1874 * @throws MWException If this test cases's needsDB() method doesn't return true.
1875 * Test cases can use "@group Database" to enable database test support,
1876 * or list the tables under testing in $this->tablesUsed, or override the
1879 protected function assertSelect(
1880 $table, $fields, $condition, array $expectedRows, array $options = [], array $join_conds = []
1882 if ( !$this->needsDB() ) {
1883 throw new MWException( 'When testing database state, the test cases\'s needDB()' .
1884 ' method should return true. Use @group Database or $this->tablesUsed.' );
1887 $db = wfGetDB( DB_REPLICA
);
1894 $options +
[ 'ORDER BY' => $fields ],
1897 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
1901 foreach ( $expectedRows as $expected ) {
1902 $r = $res->fetchRow();
1903 self
::stripStringKeys( $r );
1906 $this->assertNotEmpty( $r, "row #$i missing" );
1908 $this->assertEquals( $expected, $r, "row #$i mismatches" );
1911 $r = $res->fetchRow();
1912 self
::stripStringKeys( $r );
1914 $this->assertFalse( $r, "found extra row (after #$i)" );
1918 * Utility method taking an array of elements and wrapping
1919 * each element in its own array. Useful for data providers
1920 * that only return a single argument.
1924 * @param array $elements
1928 protected function arrayWrap( array $elements ) {
1930 function ( $element ) {
1931 return [ $element ];
1938 * Assert that two arrays are equal. By default this means that both arrays need to hold
1939 * the same set of values. Using additional arguments, order and associated key can also
1940 * be set as relevant.
1944 * @param array $expected
1945 * @param array $actual
1946 * @param bool $ordered If the order of the values should match
1947 * @param bool $named If the keys should match
1949 protected function assertArrayEquals( array $expected, array $actual,
1950 $ordered = false, $named = false
1953 $this->objectAssociativeSort( $expected );
1954 $this->objectAssociativeSort( $actual );
1958 $expected = array_values( $expected );
1959 $actual = array_values( $actual );
1962 call_user_func_array(
1963 [ $this, 'assertEquals' ],
1964 array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
1969 * Put each HTML element on its own line and then equals() the results
1971 * Use for nicely formatting of PHPUnit diff output when comparing very
1976 * @param string $expected HTML on oneline
1977 * @param string $actual HTML on oneline
1978 * @param string $msg Optional message
1980 protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
1981 $expected = str_replace( '>', ">\n", $expected );
1982 $actual = str_replace( '>', ">\n", $actual );
1984 $this->assertEquals( $expected, $actual, $msg );
1988 * Does an associative sort that works for objects.
1992 * @param array &$array
1994 protected function objectAssociativeSort( array &$array ) {
1997 function ( $a, $b ) {
1998 return serialize( $a ) <=> serialize( $b );
2004 * Utility function for eliminating all string keys from an array.
2005 * Useful to turn a database result row as returned by fetchRow() into
2006 * a pure indexed array.
2010 * @param mixed &$r The array to remove string keys from.
2012 protected static function stripStringKeys( &$r ) {
2013 if ( !is_array( $r ) ) {
2017 foreach ( $r as $k => $v ) {
2018 if ( is_string( $k ) ) {
2025 * Asserts that the provided variable is of the specified
2026 * internal type or equals the $value argument. This is useful
2027 * for testing return types of functions that return a certain
2028 * type or *value* when not set or on error.
2032 * @param string $type
2033 * @param mixed $actual
2034 * @param mixed $value
2035 * @param string $message
2037 protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
2038 if ( $actual === $value ) {
2039 $this->assertTrue( true, $message );
2041 $this->assertType( $type, $actual, $message );
2046 * Asserts the type of the provided value. This can be either
2047 * in internal type such as boolean or integer, or a class or
2048 * interface the value extends or implements.
2052 * @param string $type
2053 * @param mixed $actual
2054 * @param string $message
2056 protected function assertType( $type, $actual, $message = '' ) {
2057 if ( class_exists( $type ) ||
interface_exists( $type ) ) {
2058 $this->assertInstanceOf( $type, $actual, $message );
2060 $this->assertInternalType( $type, $actual, $message );
2065 * Returns true if the given namespace defaults to Wikitext
2066 * according to $wgNamespaceContentModels
2068 * @param int $ns The namespace ID to check
2073 protected function isWikitextNS( $ns ) {
2074 global $wgNamespaceContentModels;
2076 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
2077 return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
;
2084 * Returns the ID of a namespace that defaults to Wikitext.
2086 * @throws MWException If there is none.
2087 * @return int The ID of the wikitext Namespace
2090 protected function getDefaultWikitextNS() {
2091 global $wgNamespaceContentModels;
2093 static $wikitextNS = null; // this is not going to change
2094 if ( $wikitextNS !== null ) {
2098 // quickly short out on most common case:
2099 if ( !isset( $wgNamespaceContentModels[NS_MAIN
] ) ) {
2103 // NOTE: prefer content namespaces
2104 $namespaces = array_unique( array_merge(
2105 MWNamespace
::getContentNamespaces(),
2106 [ NS_MAIN
, NS_HELP
, NS_PROJECT
], // prefer these
2107 MWNamespace
::getValidNamespaces()
2110 $namespaces = array_diff( $namespaces, [
2111 NS_FILE
, NS_CATEGORY
, NS_MEDIAWIKI
, NS_USER
// don't mess with magic namespaces
2114 $talk = array_filter( $namespaces, function ( $ns ) {
2115 return MWNamespace
::isTalk( $ns );
2118 // prefer non-talk pages
2119 $namespaces = array_diff( $namespaces, $talk );
2120 $namespaces = array_merge( $namespaces, $talk );
2122 // check default content model of each namespace
2123 foreach ( $namespaces as $ns ) {
2124 if ( !isset( $wgNamespaceContentModels[$ns] ) ||
2125 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
2134 // @todo Inside a test, we could skip the test as incomplete.
2135 // But frequently, this is used in fixture setup.
2136 throw new MWException( "No namespace defaults to wikitext!" );
2140 * Check, if $wgDiff3 is set and ready to merge
2141 * Will mark the calling test as skipped, if not ready
2145 protected function markTestSkippedIfNoDiff3() {
2148 # This check may also protect against code injection in
2149 # case of broken installations.
2150 Wikimedia\
suppressWarnings();
2151 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2152 Wikimedia\restoreWarnings
();
2154 if ( !$haveDiff3 ) {
2155 $this->markTestSkipped( "Skip test, since diff3 is not configured" );
2160 * Check if $extName is a loaded PHP extension, will skip the
2161 * test whenever it is not loaded.
2164 * @param string $extName
2167 protected function checkPHPExtension( $extName ) {
2168 $loaded = extension_loaded( $extName );
2170 $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
2177 * Skip the test if using the specified database type
2179 * @param string $type Database type
2182 protected function markTestSkippedIfDbType( $type ) {
2183 if ( $this->db
->getType() === $type ) {
2184 $this->markTestSkipped( "The $type database type isn't supported for this test" );
2189 * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
2190 * @param string $buffer
2193 public static function wfResetOutputBuffersBarrier( $buffer ) {
2198 * Create a temporary hook handler which will be reset by tearDown.
2199 * This replaces other handlers for the same hook.
2200 * @param string $hookName Hook name
2201 * @param mixed $handler Value suitable for a hook handler
2204 protected function setTemporaryHook( $hookName, $handler ) {
2205 $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
2209 * Check whether file contains given data.
2210 * @param string $fileName
2211 * @param string $actualData
2212 * @param bool $createIfMissing If true, and file does not exist, create it with given data
2213 * and skip the test.
2214 * @param string $msg
2217 protected function assertFileContains(
2220 $createIfMissing = false,
2223 if ( $createIfMissing ) {
2224 if ( !file_exists( $fileName ) ) {
2225 file_put_contents( $fileName, $actualData );
2226 $this->markTestSkipped( 'Data file $fileName does not exist' );
2229 self
::assertFileExists( $fileName );
2231 self
::assertEquals( file_get_contents( $fileName ), $actualData, $msg );
2235 * Edits or creates a page/revision
2236 * @param string $pageName Page title
2237 * @param string $text Content of the page
2238 * @param string $summary Optional summary string for the revision
2239 * @param int $defaultNs Optional namespace id
2240 * @return array Array as returned by WikiPage::doEditContent()
2242 protected function editPage( $pageName, $text, $summary = '', $defaultNs = NS_MAIN
) {
2243 $title = Title
::newFromText( $pageName, $defaultNs );
2244 $page = WikiPage
::factory( $title );
2246 return $page->doEditContent( ContentHandler
::makeContent( $text, $title ), $summary );
2250 * Revision-deletes a revision.
2252 * @param Revision|int $rev Revision to delete
2253 * @param array $value Keys are Revision::DELETED_* flags. Values are 1 to set the bit, 0 to
2254 * clear, -1 to leave alone. (All other values also clear the bit.)
2255 * @param string $comment Deletion comment
2257 protected function revisionDelete(
2258 $rev, array $value = [ Revision
::DELETED_TEXT
=> 1 ], $comment = ''
2260 if ( is_int( $rev ) ) {
2261 $rev = Revision
::newFromId( $rev );
2263 RevisionDeleter
::createList(
2264 'revision', RequestContext
::getMain(), $rev->getTitle(), [ $rev->getId() ]
2267 'comment' => $comment,