tests/phpunit/MediaWikiTestCase.php

   1 <?php
   2
   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;
  13
  14 /**
  15  * @since 1.18
  16  */
  17 abstract class MediaWikiTestCase extends PHPUnit\Framework\TestCase {
  18
  19         use MediaWikiCoversValidator;
  20         use PHPUnit4And6Compat;
  21
  22         /**
  23          * The original service locator. This is overridden during setUp().
  24          *
  25          * @var MediaWikiServices|null
  26          */
  27         private static $originalServices;
  28
  29         /**
  30          * The local service locator, created during setUp().
  31          * @var MediaWikiServices
  32          */
  33         private $localServices;
  34
  35         /**
  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.
  39          *
  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
  42          * parent.
  43          *
  44          * This property must be private, we do not want child to override it,
  45          * they should call the appropriate parent method instead.
  46          */
  47         private $called = [];
  48
  49         /**
  50          * @var TestUser[]
  51          * @since 1.20
  52          */
  53         public static $users;
  54
  55         /**
  56          * Primary database
  57          *
  58          * @var Database
  59          * @since 1.18
  60          */
  61         protected $db;
  62
  63         /**
  64          * @var array
  65          * @since 1.19
  66          */
  67         protected $tablesUsed = []; // tables with data
  68
  69         private static $useTemporaryTables = true;
  70         private static $reuseDB = false;
  71         private static $dbSetup = false;
  72         private static $oldTablePrefix = '';
  73
  74         /**
  75          * Original value of PHP's error_reporting setting.
  76          *
  77          * @var int
  78          */
  79         private $phpErrorLevel;
  80
  81         /**
  82          * Holds the paths of temporary files/directories created through getNewTempFile,
  83          * and getNewTempDirectory
  84          *
  85          * @var array
  86          */
  87         private $tmpFiles = [];
  88
  89         /**
  90          * Holds original values of MediaWiki configuration settings
  91          * to be restored in tearDown().
  92          * See also setMwGlobals().
  93          * @var array
  94          */
  95         private $mwGlobals = [];
  96
  97         /**
  98          * Holds list of MediaWiki configuration settings to be unset in tearDown().
  99          * See also setMwGlobals().
 100          * @var array
 101          */
 102         private $mwGlobalsToUnset = [];
 103
 104         /**
 105          * Holds original values of ini settings to be restored
 106          * in tearDown().
 107          * @see setIniSettings()
 108          * @var array
 109          */
 110         private $iniSettings = [];
 111
 112         /**
 113          * Holds original loggers which have been replaced by setLogger()
 114          * @var LoggerInterface[]
 115          */
 116         private $loggers = [];
 117
 118         /**
 119          * The CLI arguments passed through from phpunit.php
 120          * @var array
 121          */
 122         private $cliArgs = [];
 123
 124         /**
 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.
 127          * @var string[]
 128          */
 129         private $overriddenServices = [];
 130
 131         /**
 132          * Table name prefixes. Oracle likes it shorter.
 133          */
 134         const DB_PREFIX = 'unittest_';
 135         const ORA_DB_PREFIX = 'ut_';
 136
 137         /**
 138          * @var array
 139          * @since 1.18
 140          */
 141         protected $supportedDBs = [
 142                 'mysql',
 143                 'sqlite',
 144                 'postgres',
 145                 'oracle'
 146         ];
 147
 148         public function __construct( $name = null, array $data = [], $dataName = '' ) {
 149                 parent::__construct( $name, $data, $dataName );
 150
 151                 $this->backupGlobals = false;
 152                 $this->backupStaticAttributes = false;
 153         }
 154
 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()" );
 160                 }
 161         }
 162
 163         public static function setUpBeforeClass() {
 164                 parent::setUpBeforeClass();
 165
 166                 // Get the original service locator
 167                 if ( !self::$originalServices ) {
 168                         self::$originalServices = MediaWikiServices::getInstance();
 169                 }
 170         }
 171
 172         /**
 173          * Convenience method for getting an immutable test user
 174          *
 175          * @since 1.28
 176          *
 177          * @param string|string[] $groups Groups the test user should be in.
 178          * @return TestUser
 179          */
 180         public static function getTestUser( $groups = [] ) {
 181                 return TestUserRegistry::getImmutableTestUser( $groups );
 182         }
 183
 184         /**
 185          * Convenience method for getting a mutable test user
 186          *
 187          * @since 1.28
 188          *
 189          * @param string|string[] $groups Groups the test user should be added in.
 190          * @return TestUser
 191          */
 192         public static function getMutableTestUser( $groups = [] ) {
 193                 return TestUserRegistry::getMutableTestUser( __CLASS__, $groups );
 194         }
 195
 196         /**
 197          * Convenience method for getting an immutable admin test user
 198          *
 199          * @since 1.28
 200          *
 201          * @param string[] $groups Groups the test user should be added to.
 202          * @return TestUser
 203          */
 204         public static function getTestSysop() {
 205                 return self::getTestUser( [ 'sysop', 'bureaucrat' ] );
 206         }
 207
 208         /**
 209          * Returns a WikiPage representing an existing page.
 210          *
 211          * @since 1.32
 212          *
 213          * @param Title|string|null $title
 214          * @return WikiPage
 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
 218          *         needsDB() method.
 219          */
 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.' );
 224                 }
 225
 226                 $title = ( $title === null ) ? 'UTPage' : $title;
 227                 $title = is_string( $title ) ? Title::newFromText( $title ) : $title;
 228                 $page = WikiPage::factory( $title );
 229
 230                 if ( !$page->exists() ) {
 231                         $user = self::getTestSysop()->getUser();
 232                         $page->doEditContent(
 233                                 new WikitextContent( 'UTContent' ),
 234                                 'UTPageSummary',
 235                                 EDIT_NEW | EDIT_SUPPRESS_RC,
 236                                 false,
 237                                 $user
 238                         );
 239                 }
 240
 241                 return $page;
 242         }
 243
 244         /**
 245          * Returns a WikiPage representing a non-existing page.
 246          *
 247          * @since 1.32
 248          *
 249          * @param Title|string|null $title
 250          * @return WikiPage
 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
 254          *         needsDB() method.
 255          */
 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.' );
 260                 }
 261
 262                 $title = ( $title === null ) ? 'UTPage-' . rand( 0, 100000 ) : $title;
 263                 $title = is_string( $title ) ? Title::newFromText( $title ) : $title;
 264                 $page = WikiPage::factory( $title );
 265
 266                 if ( $page->exists() ) {
 267                         $page->doDeleteArticle( 'Testing' );
 268                 }
 269
 270                 return $page;
 271         }
 272
 273         /**
 274          * @deprecated since 1.32
 275          */
 276         public static function prepareServices( Config $bootstrapConfig ) {
 277         }
 278
 279         /**
 280          * Create a config suitable for testing, based on a base config, default overrides,
 281          * and custom overrides.
 282          *
 283          * @param Config|null $baseConfig
 284          * @param Config|null $customOverrides
 285          *
 286          * @return Config
 287          */
 288         private static function makeTestConfig(
 289                 Config $baseConfig = null,
 290                 Config $customOverrides = null
 291         ) {
 292                 $defaultOverrides = new HashConfig();
 293
 294                 if ( !$baseConfig ) {
 295                         $baseConfig = self::$originalServices->getBootstrapConfig();
 296                 }
 297
 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.
 301                  */
 302                 $hashCache = [ 'class' => HashBagOStuff::class, 'reportDupes' => false ];
 303                 $objectCaches = [
 304                                 CACHE_DB => $hashCache,
 305                                 CACHE_ACCEL => $hashCache,
 306                                 CACHE_MEMCACHED => $hashCache,
 307                                 'apc' => $hashCache,
 308                                 'apcu' => $hashCache,
 309                                 'wincache' => $hashCache,
 310                         ] + $baseConfig->get( 'ObjectCaches' );
 311
 312                 $defaultOverrides->set( 'ObjectCaches', $objectCaches );
 313                 $defaultOverrides->set( 'MainCacheType', CACHE_NONE );
 314                 $defaultOverrides->set( 'JobTypeConf', [ 'default' => [ 'class' => JobQueueMemory::class ] ] );
 315
 316                 // Use a fast hash algorithm to hash passwords.
 317                 $defaultOverrides->set( 'PasswordDefault', 'A' );
 318
 319                 $testConfig = $customOverrides
 320                         ? new MultiConfig( [ $customOverrides, $defaultOverrides, $baseConfig ] )
 321                         : new MultiConfig( [ $defaultOverrides, $baseConfig ] );
 322
 323                 return $testConfig;
 324         }
 325
 326         /**
 327          * @param ConfigFactory $oldFactory
 328          * @param Config[] $configurations
 329          *
 330          * @return Closure
 331          */
 332         private static function makeTestConfigFactoryInstantiator(
 333                 ConfigFactory $oldFactory,
 334                 array $configurations
 335         ) {
 336                 return function ( MediaWikiServices $services ) use ( $oldFactory, $configurations ) {
 337                         $factory = new ConfigFactory();
 338
 339                         // clone configurations from $oldFactory that are not overwritten by $configurations
 340                         $namesToClone = array_diff(
 341                                 $oldFactory->getConfigNames(),
 342                                 array_keys( $configurations )
 343                         );
 344
 345                         foreach ( $namesToClone as $name ) {
 346                                 $factory->register( $name, $oldFactory->makeConfig( $name ) );
 347                         }
 348
 349                         foreach ( $configurations as $name => $config ) {
 350                                 $factory->register( $name, $config );
 351                         }
 352
 353                         return $factory;
 354                 };
 355         }
 356
 357         /**
 358          * Resets some non-service singleton instances and other static caches. It's not necessary to
 359          * reset services here.
 360          */
 361         public static function resetNonServiceCaches() {
 362                 global $wgRequest, $wgJobClasses;
 363
 364                 User::resetGetDefaultOptionsForTestsOnly();
 365                 foreach ( $wgJobClasses as $type => $class ) {
 366                         JobQueueGroup::singleton()->get( $type )->delete();
 367                 }
 368                 JobQueueGroup::destroySingletons();
 369
 370                 ObjectCache::clear();
 371                 FileBackendGroup::destroySingleton();
 372                 DeferredUpdates::clearPendingUpdates();
 373
 374                 // TODO: move global state into MediaWikiServices
 375                 RequestContext::resetMain();
 376                 if ( session_id() !== '' ) {
 377                         session_write_close();
 378                         session_id( '' );
 379                 }
 380
 381                 $wgRequest = new FauxRequest();
 382                 MediaWiki\Session\SessionManager::resetCache();
 383         }
 384
 385         public function run( PHPUnit_Framework_TestResult $result = null ) {
 386                 if ( $result instanceof MediaWikiTestResult ) {
 387                         $this->cliArgs = $result->getMediaWikiCliArgs();
 388                 }
 389                 $this->overrideMwServices();
 390
 391                 if ( $this->needsDB() && !$this->isTestInDatabaseGroup() ) {
 392                         throw new Exception(
 393                                 get_class( $this ) . ' apparently needsDB but is not in the Database group'
 394                         );
 395                 }
 396
 397                 $needsResetDB = false;
 398                 if ( !self::$dbSetup || $this->needsDB() ) {
 399                         // set up a DB connection for this test to use
 400
 401                         self::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
 402                         self::$reuseDB = $this->getCliArg( 'reuse-db' );
 403
 404                         $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
 405                         $this->db = $lb->getConnection( DB_MASTER );
 406
 407                         $this->checkDbIsSupported();
 408
 409                         if ( !self::$dbSetup ) {
 410                                 $this->setupAllTestDBs();
 411                                 $this->addCoreDBData();
 412                         }
 413
 414                         // TODO: the DB setup should be done in setUpBeforeClass(), so the test DB
 415                         // is available in subclass's setUpBeforeClass() and setUp() methods.
 416                         // This would also remove the need for the HACK that is oncePerClass().
 417                         if ( $this->oncePerClass() ) {
 418                                 $this->setUpSchema( $this->db );
 419                                 $this->resetDB( $this->db, $this->tablesUsed );
 420                                 $this->addDBDataOnce();
 421                         }
 422
 423                         $this->addDBData();
 424                         $needsResetDB = true;
 425                 }
 426
 427                 parent::run( $result );
 428
 429                 // We don't mind if we override already-overridden services during cleanup
 430                 $this->overriddenServices = [];
 431
 432                 if ( $needsResetDB ) {
 433                         $this->resetDB( $this->db, $this->tablesUsed );
 434                 }
 435
 436                 self::restoreMwServices();
 437                 $this->localServices = null;
 438         }
 439
 440         /**
 441          * @return bool
 442          */
 443         private function oncePerClass() {
 444                 // Remember current test class in the database connection,
 445                 // so we know when we need to run addData.
 446
 447                 $class = static::class;
 448
 449                 $first = !isset( $this->db->_hasDataForTestClass )
 450                         || $this->db->_hasDataForTestClass !== $class;
 451
 452                 $this->db->_hasDataForTestClass = $class;
 453                 return $first;
 454         }
 455
 456         /**
 457          * @since 1.21
 458          *
 459          * @return bool
 460          */
 461         public function usesTemporaryTables() {
 462                 return self::$useTemporaryTables;
 463         }
 464
 465         /**
 466          * Obtains a new temporary file name
 467          *
 468          * The obtained filename is enlisted to be removed upon tearDown
 469          *
 470          * @since 1.20
 471          *
 472          * @return string Absolute name of the temporary file
 473          */
 474         protected function getNewTempFile() {
 475                 $fileName = tempnam(
 476                         wfTempDir(),
 477                         // Avoid backslashes here as they result in inconsistent results
 478                         // between Windows and other OS, as well as between functions
 479                         // that try to normalise these in one or both directions.
 480                         // For example, tempnam rejects directory separators in the prefix which
 481                         // means it rejects any namespaced class on Windows.
 482                         // And then there is, wfMkdirParents which normalises paths always
 483                         // whereas most other PHP and MW functions do not.
 484                         'MW_PHPUnit_' . strtr( static::class, [ '\\' => '_' ] ) . '_'
 485                 );
 486                 $this->tmpFiles[] = $fileName;
 487
 488                 return $fileName;
 489         }
 490
 491         /**
 492          * obtains a new temporary directory
 493          *
 494          * The obtained directory is enlisted to be removed (recursively with all its contained
 495          * files) upon tearDown.
 496          *
 497          * @since 1.20
 498          *
 499          * @return string Absolute name of the temporary directory
 500          */
 501         protected function getNewTempDirectory() {
 502                 // Starting of with a temporary *file*.
 503                 $fileName = $this->getNewTempFile();
 504
 505                 // Converting the temporary file to a *directory*.
 506                 // The following is not atomic, but at least we now have a single place,
 507                 // where temporary directory creation is bundled and can be improved.
 508                 unlink( $fileName );
 509                 // If this fails for some reason, PHP will warn and fail the test.
 510                 mkdir( $fileName, 0777, /* recursive = */ true );
 511
 512                 return $fileName;
 513         }
 514
 515         protected function setUp() {
 516                 parent::setUp();
 517                 $this->called['setUp'] = true;
 518
 519                 $this->phpErrorLevel = intval( ini_get( 'error_reporting' ) );
 520
 521                 $this->overriddenServices = [];
 522
 523                 // Cleaning up temporary files
 524                 foreach ( $this->tmpFiles as $fileName ) {
 525                         if ( is_file( $fileName ) || ( is_link( $fileName ) ) ) {
 526                                 unlink( $fileName );
 527                         } elseif ( is_dir( $fileName ) ) {
 528                                 wfRecursiveRemoveDir( $fileName );
 529                         }
 530                 }
 531
 532                 if ( $this->needsDB() && $this->db ) {
 533                         // Clean up open transactions
 534                         while ( $this->db->trxLevel() > 0 ) {
 535                                 $this->db->rollback( __METHOD__, 'flush' );
 536                         }
 537                         // Check for unsafe queries
 538                         if ( $this->db->getType() === 'mysql' ) {
 539                                 $this->db->query( "SET sql_mode = 'STRICT_ALL_TABLES'", __METHOD__ );
 540                         }
 541                 }
 542
 543                 // Reset all caches between tests.
 544                 self::resetNonServiceCaches();
 545
 546                 // XXX: reset maintenance triggers
 547                 // Hook into period lag checks which often happen in long-running scripts
 548                 $lbFactory = $this->localServices->getDBLoadBalancerFactory();
 549                 Maintenance::setLBFactoryTriggers( $lbFactory, $this->localServices->getMainConfig() );
 550
 551                 ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
 552         }
 553
 554         protected function addTmpFiles( $files ) {
 555                 $this->tmpFiles = array_merge( $this->tmpFiles, (array)$files );
 556         }
 557
 558         // @todo Make const when we no longer support HHVM (T192166)
 559         private static $namespaceAffectingSettings = [
 560                 'wgAllowImageMoving',
 561                 'wgCanonicalNamespaceNames',
 562                 'wgCapitalLinkOverrides',
 563                 'wgCapitalLinks',
 564                 'wgContentNamespaces',
 565                 'wgExtensionMessagesFiles',
 566                 'wgExtensionNamespaces',
 567                 'wgExtraNamespaces',
 568                 'wgExtraSignatureNamespaces',
 569                 'wgNamespaceContentModels',
 570                 'wgNamespaceProtection',
 571                 'wgNamespacesWithSubpages',
 572                 'wgNonincludableNamespaces',
 573                 'wgRestrictionLevels',
 574         ];
 575
 576         protected function tearDown() {
 577                 global $wgRequest, $wgSQLMode;
 578
 579                 $status = ob_get_status();
 580                 if ( isset( $status['name'] ) &&
 581                         $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier'
 582                 ) {
 583                         ob_end_flush();
 584                 }
 585
 586                 $this->called['tearDown'] = true;
 587                 // Cleaning up temporary files
 588                 foreach ( $this->tmpFiles as $fileName ) {
 589                         if ( is_file( $fileName ) || ( is_link( $fileName ) ) ) {
 590                                 unlink( $fileName );
 591                         } elseif ( is_dir( $fileName ) ) {
 592                                 wfRecursiveRemoveDir( $fileName );
 593                         }
 594                 }
 595
 596                 if ( $this->needsDB() && $this->db ) {
 597                         // Clean up open transactions
 598                         while ( $this->db->trxLevel() > 0 ) {
 599                                 $this->db->rollback( __METHOD__, 'flush' );
 600                         }
 601                         if ( $this->db->getType() === 'mysql' ) {
 602                                 $this->db->query( "SET sql_mode = " . $this->db->addQuotes( $wgSQLMode ),
 603                                         __METHOD__ );
 604                         }
 605                 }
 606
 607                 // Re-enable any disabled deprecation warnings
 608                 MWDebug::clearLog();
 609                 // Restore mw globals
 610                 foreach ( $this->mwGlobals as $key => $value ) {
 611                         $GLOBALS[$key] = $value;
 612                 }
 613                 foreach ( $this->mwGlobalsToUnset as $value ) {
 614                         unset( $GLOBALS[$value] );
 615                 }
 616                 foreach ( $this->iniSettings as $name => $value ) {
 617                         ini_set( $name, $value );
 618                 }
 619                 if (
 620                         array_intersect( self::$namespaceAffectingSettings, array_keys( $this->mwGlobals ) ) ||
 621                         array_intersect( self::$namespaceAffectingSettings, $this->mwGlobalsToUnset )
 622                 ) {
 623                         $this->resetNamespaces();
 624                 }
 625                 $this->mwGlobals = [];
 626                 $this->mwGlobalsToUnset = [];
 627                 $this->restoreLoggers();
 628
 629                 // TODO: move global state into MediaWikiServices
 630                 RequestContext::resetMain();
 631                 if ( session_id() !== '' ) {
 632                         session_write_close();
 633                         session_id( '' );
 634                 }
 635                 $wgRequest = new FauxRequest();
 636                 MediaWiki\Session\SessionManager::resetCache();
 637                 MediaWiki\Auth\AuthManager::resetCache();
 638
 639                 $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
 640
 641                 if ( $phpErrorLevel !== $this->phpErrorLevel ) {
 642                         ini_set( 'error_reporting', $this->phpErrorLevel );
 643
 644                         $oldHex = strtoupper( dechex( $this->phpErrorLevel ) );
 645                         $newHex = strtoupper( dechex( $phpErrorLevel ) );
 646                         $message = "PHP error_reporting setting was left dirty: "
 647                                 . "was 0x$oldHex before test, 0x$newHex after test!";
 648
 649                         $this->fail( $message );
 650                 }
 651
 652                 parent::tearDown();
 653         }
 654
 655         /**
 656          * Make sure MediaWikiTestCase extending classes have called their
 657          * parent setUp method
 658          *
 659          * With strict coverage activated in PHP_CodeCoverage, this test would be
 660          * marked as risky without the following annotation (T152923).
 661          * @coversNothing
 662          */
 663         final public function testMediaWikiTestCaseParentSetupCalled() {
 664                 $this->assertArrayHasKey( 'setUp', $this->called,
 665                         static::class . '::setUp() must call parent::setUp()'
 666                 );
 667         }
 668
 669         /**
 670          * Sets a service, maintaining a stashed version of the previous service to be
 671          * restored in tearDown
 672          *
 673          * @since 1.27
 674          *
 675          * @param string $name
 676          * @param object $object
 677          */
 678         protected function setService( $name, $object ) {
 679                 if ( !$this->localServices ) {
 680                         throw new Exception( __METHOD__ . ' must be called after MediaWikiTestCase::run()' );
 681                 }
 682
 683                 if ( $this->localServices !== MediaWikiServices::getInstance() ) {
 684                         throw new Exception( __METHOD__ . ' will not work because the global MediaWikiServices '
 685                                 . 'instance has been replaced by test code.' );
 686                 }
 687
 688                 $this->overriddenServices[] = $name;
 689
 690                 $this->localServices->disableService( $name );
 691                 $this->localServices->redefineService(
 692                         $name,
 693                         function () use ( $object ) {
 694                                 return $object;
 695                         }
 696                 );
 697
 698                 if ( $name === 'ContentLanguage' ) {
 699                         $this->doSetMwGlobals( [ 'wgContLang' => $object ] );
 700                 }
 701         }
 702
 703         /**
 704          * Sets a global, maintaining a stashed version of the previous global to be
 705          * restored in tearDown
 706          *
 707          * The key is added to the array of globals that will be reset afterwards
 708          * in the tearDown().
 709          *
 710          * @par Example
 711          * @code
 712          *     protected function setUp() {
 713          *         $this->setMwGlobals( 'wgRestrictStuff', true );
 714          *     }
 715          *
 716          *     function testFoo() {}
 717          *
 718          *     function testBar() {}
 719          *         $this->assertTrue( self::getX()->doStuff() );
 720          *
 721          *         $this->setMwGlobals( 'wgRestrictStuff', false );
 722          *         $this->assertTrue( self::getX()->doStuff() );
 723          *     }
 724          *
 725          *     function testQuux() {}
 726          * @endcode
 727          *
 728          * @param array|string $pairs Key to the global variable, or an array
 729          *  of key/value pairs.
 730          * @param mixed|null $value Value to set the global to (ignored
 731          *  if an array is given as first argument).
 732          *
 733          * @note To allow changes to global variables to take effect on global service instances,
 734          *       call overrideMwServices().
 735          *
 736          * @since 1.21
 737          */
 738         protected function setMwGlobals( $pairs, $value = null ) {
 739                 if ( is_string( $pairs ) ) {
 740                         $pairs = [ $pairs => $value ];
 741                 }
 742
 743                 if ( isset( $pairs['wgContLang'] ) ) {
 744                         throw new MWException(
 745                                 'No setting $wgContLang, use setContentLang() or setService( \'ContentLanguage\' )'
 746                         );
 747                 }
 748
 749                 $this->doSetMwGlobals( $pairs, $value );
 750         }
 751
 752         /**
 753          * An internal method that allows setService() to set globals that tests are not supposed to
 754          * touch.
 755          */
 756         private function doSetMwGlobals( $pairs, $value = null ) {
 757                 $this->doStashMwGlobals( array_keys( $pairs ) );
 758
 759                 foreach ( $pairs as $key => $value ) {
 760                         $GLOBALS[$key] = $value;
 761                 }
 762
 763                 if ( array_intersect( self::$namespaceAffectingSettings, array_keys( $pairs ) ) ) {
 764                         $this->resetNamespaces();
 765                 }
 766         }
 767
 768         /**
 769          * Set an ini setting for the duration of the test
 770          * @param string $name Name of the setting
 771          * @param string $value Value to set
 772          * @since 1.32
 773          */
 774         protected function setIniSetting( $name, $value ) {
 775                 $original = ini_get( $name );
 776                 $this->iniSettings[$name] = $original;
 777                 ini_set( $name, $value );
 778         }
 779
 780         /**
 781          * Must be called whenever namespaces are changed, e.g., $wgExtraNamespaces is altered.
 782          * Otherwise old namespace data will lurk and cause bugs.
 783          */
 784         private function resetNamespaces() {
 785                 if ( !$this->localServices ) {
 786                         throw new Exception( __METHOD__ . ' must be called after MediaWikiTestCase::run()' );
 787                 }
 788
 789                 if ( $this->localServices !== MediaWikiServices::getInstance() ) {
 790                         throw new Exception( __METHOD__ . ' will not work because the global MediaWikiServices '
 791                                 . 'instance has been replaced by test code.' );
 792                 }
 793
 794                 Language::clearCaches();
 795         }
 796
 797         /**
 798          * Check if we can back up a value by performing a shallow copy.
 799          * Values which fail this test are copied recursively.
 800          *
 801          * @param mixed $value
 802          * @return bool True if a shallow copy will do; false if a deep copy
 803          *  is required.
 804          */
 805         private static function canShallowCopy( $value ) {
 806                 if ( is_scalar( $value ) || $value === null ) {
 807                         return true;
 808                 }
 809                 if ( is_array( $value ) ) {
 810                         foreach ( $value as $subValue ) {
 811                                 if ( !is_scalar( $subValue ) && $subValue !== null ) {
 812                                         return false;
 813                                 }
 814                         }
 815                         return true;
 816                 }
 817                 return false;
 818         }
 819
 820         private function doStashMwGlobals( $globalKeys ) {
 821                 if ( is_string( $globalKeys ) ) {
 822                         $globalKeys = [ $globalKeys ];
 823                 }
 824
 825                 foreach ( $globalKeys as $globalKey ) {
 826                         // NOTE: make sure we only save the global once or a second call to
 827                         // setMwGlobals() on the same global would override the original
 828                         // value.
 829                         if (
 830                                 !array_key_exists( $globalKey, $this->mwGlobals ) &&
 831                                 !array_key_exists( $globalKey, $this->mwGlobalsToUnset )
 832                         ) {
 833                                 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
 834                                         $this->mwGlobalsToUnset[$globalKey] = $globalKey;
 835                                         continue;
 836                                 }
 837                                 // NOTE: we serialize then unserialize the value in case it is an object
 838                                 // this stops any objects being passed by reference. We could use clone
 839                                 // and if is_object but this does account for objects within objects!
 840                                 if ( self::canShallowCopy( $GLOBALS[$globalKey] ) ) {
 841                                         $this->mwGlobals[$globalKey] = $GLOBALS[$globalKey];
 842                                 } elseif (
 843                                         // Many MediaWiki types are safe to clone. These are the
 844                                         // ones that are most commonly stashed.
 845                                         $GLOBALS[$globalKey] instanceof Language ||
 846                                         $GLOBALS[$globalKey] instanceof User ||
 847                                         $GLOBALS[$globalKey] instanceof FauxRequest
 848                                 ) {
 849                                         $this->mwGlobals[$globalKey] = clone $GLOBALS[$globalKey];
 850                                 } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
 851                                         // Serializing Closure only gives a warning on HHVM while
 852                                         // it throws an Exception on Zend.
 853                                         // Workaround for https://github.com/facebook/hhvm/issues/6206
 854                                         $this->mwGlobals[$globalKey] = $GLOBALS[$globalKey];
 855                                 } else {
 856                                         try {
 857                                                 $this->mwGlobals[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
 858                                         } catch ( Exception $e ) {
 859                                                 $this->mwGlobals[$globalKey] = $GLOBALS[$globalKey];
 860                                         }
 861                                 }
 862                         }
 863                 }
 864         }
 865
 866         /**
 867          * @param mixed $var
 868          * @param int $maxDepth
 869          *
 870          * @return bool
 871          */
 872         private function containsClosure( $var, $maxDepth = 15 ) {
 873                 if ( $var instanceof Closure ) {
 874                         return true;
 875                 }
 876                 if ( !is_array( $var ) || $maxDepth === 0 ) {
 877                         return false;
 878                 }
 879
 880                 foreach ( $var as $value ) {
 881                         if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
 882                                 return true;
 883                         }
 884                 }
 885                 return false;
 886         }
 887
 888         /**
 889          * Merges the given values into a MW global array variable.
 890          * Useful for setting some entries in a configuration array, instead of
 891          * setting the entire array.
 892          *
 893          * @param string $name The name of the global, as in wgFooBar
 894          * @param array $values The array containing the entries to set in that global
 895          *
 896          * @throws MWException If the designated global is not an array.
 897          *
 898          * @note To allow changes to global variables to take effect on global service instances,
 899          *       call overrideMwServices().
 900          *
 901          * @since 1.21
 902          */
 903         protected function mergeMwGlobalArrayValue( $name, $values ) {
 904                 if ( !isset( $GLOBALS[$name] ) ) {
 905                         $merged = $values;
 906                 } else {
 907                         if ( !is_array( $GLOBALS[$name] ) ) {
 908                                 throw new MWException( "MW global $name is not an array." );
 909                         }
 910
 911                         // NOTE: do not use array_merge, it screws up for numeric keys.
 912                         $merged = $GLOBALS[$name];
 913                         foreach ( $values as $k => $v ) {
 914                                 $merged[$k] = $v;
 915                         }
 916                 }
 917
 918                 $this->setMwGlobals( $name, $merged );
 919         }
 920
 921         /**
 922          * Stashes the global instance of MediaWikiServices, and installs a new one,
 923          * allowing test cases to override settings and services.
 924          * The previous instance of MediaWikiServices will be restored on tearDown.
 925          *
 926          * @since 1.27
 927          *
 928          * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
 929          *        instance.
 930          * @param callable[] $services An associative array of services to re-define. Keys are service
 931          *        names, values are callables.
 932          *
 933          * @return MediaWikiServices
 934          * @throws MWException
 935          */
 936         protected function overrideMwServices(
 937                 Config $configOverrides = null, array $services = []
 938         ) {
 939                 if ( $this->overriddenServices ) {
 940                         throw new MWException(
 941                                 'The following services were set and are now being unset by overrideMwServices: ' .
 942                                         implode( ', ', $this->overriddenServices )
 943                         );
 944                 }
 945                 $newInstance = self::installMockMwServices( $configOverrides );
 946
 947                 if ( $this->localServices ) {
 948                         $this->localServices->destroy();
 949                 }
 950
 951                 $this->localServices = $newInstance;
 952
 953                 foreach ( $services as $name => $callback ) {
 954                         $newInstance->redefineService( $name, $callback );
 955                 }
 956
 957                 return $newInstance;
 958         }
 959
 960         /**
 961          * Creates a new "mock" MediaWikiServices instance, and installs it.
 962          * This effectively resets all cached states in services, with the exception of
 963          * the ConfigFactory and the DBLoadBalancerFactory service, which are inherited from
 964          * the original MediaWikiServices.
 965          *
 966          * @note The new original MediaWikiServices instance can later be restored by calling
 967          * restoreMwServices(). That original is determined by the first call to this method, or
 968          * by setUpBeforeClass, whichever is called first. The caller is responsible for managing
 969          * and, when appropriate, destroying any other MediaWikiServices instances that may get
 970          * replaced when calling this method.
 971          *
 972          * @param Config|null $configOverrides Configuration overrides for the new MediaWikiServices
 973          *        instance.
 974          *
 975          * @return MediaWikiServices the new mock service locator.
 976          */
 977         public static function installMockMwServices( Config $configOverrides = null ) {
 978                 // Make sure we have the original service locator
 979                 if ( !self::$originalServices ) {
 980                         self::$originalServices = MediaWikiServices::getInstance();
 981                 }
 982
 983                 if ( !$configOverrides ) {
 984                         $configOverrides = new HashConfig();
 985                 }
 986
 987                 $oldConfigFactory = self::$originalServices->getConfigFactory();
 988                 $oldLoadBalancerFactory = self::$originalServices->getDBLoadBalancerFactory();
 989
 990                 $testConfig = self::makeTestConfig( null, $configOverrides );
 991                 $newServices = new MediaWikiServices( $testConfig );
 992
 993                 // Load the default wiring from the specified files.
 994                 // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
 995                 $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
 996                 $newServices->loadWiringFiles( $wiringFiles );
 997
 998                 // Provide a traditional hook point to allow extensions to configure services.
 999                 Hooks::run( 'MediaWikiServices', [ $newServices ] );
1000
1001                 // Use bootstrap config for all configuration.
1002                 // This allows config overrides via global variables to take effect.
1003                 $bootstrapConfig = $newServices->getBootstrapConfig();
1004                 $newServices->resetServiceForTesting( 'ConfigFactory' );
1005                 $newServices->redefineService(
1006                         'ConfigFactory',
1007                         self::makeTestConfigFactoryInstantiator(
1008                                 $oldConfigFactory,
1009                                 [ 'main' => $bootstrapConfig ]
1010                         )
1011                 );
1012                 $newServices->resetServiceForTesting( 'DBLoadBalancerFactory' );
1013                 $newServices->redefineService(
1014                         'DBLoadBalancerFactory',
1015                         function ( MediaWikiServices $services ) use ( $oldLoadBalancerFactory ) {
1016                                 return $oldLoadBalancerFactory;
1017                         }
1018                 );
1019
1020                 MediaWikiServices::forceGlobalInstance( $newServices );
1021                 return $newServices;
1022         }
1023
1024         /**
1025          * Restores the original, non-mock MediaWikiServices instance.
1026          * The previously active MediaWikiServices instance is destroyed,
1027          * if it is different from the original that is to be restored.
1028          *
1029          * @note this if for internal use by test framework code. It should never be
1030          * called from inside a test case, a data provider, or a setUp or tearDown method.
1031          *
1032          * @return bool true if the original service locator was restored,
1033          *         false if there was nothing  too do.
1034          */
1035         public static function restoreMwServices() {
1036                 if ( !self::$originalServices ) {
1037                         return false;
1038                 }
1039
1040                 $currentServices = MediaWikiServices::getInstance();
1041
1042                 if ( self::$originalServices === $currentServices ) {
1043                         return false;
1044                 }
1045
1046                 MediaWikiServices::forceGlobalInstance( self::$originalServices );
1047                 $currentServices->destroy();
1048
1049                 return true;
1050         }
1051
1052         /**
1053          * @since 1.27
1054          * @param string|Language $lang
1055          */
1056         public function setUserLang( $lang ) {
1057                 RequestContext::getMain()->setLanguage( $lang );
1058                 $this->setMwGlobals( 'wgLang', RequestContext::getMain()->getLanguage() );
1059         }
1060
1061         /**
1062          * @since 1.27
1063          * @param string|Language $lang
1064          */
1065         public function setContentLang( $lang ) {
1066                 if ( $lang instanceof Language ) {
1067                         $this->setMwGlobals( 'wgLanguageCode', $lang->getCode() );
1068                         // Set to the exact object requested
1069                         $this->setService( 'ContentLanguage', $lang );
1070                 } else {
1071                         $this->setMwGlobals( 'wgLanguageCode', $lang );
1072                         // Let the service handler make up the object.  Avoid calling setService(), because if
1073                         // we do, overrideMwServices() will complain if it's called later on.
1074                         $services = MediaWikiServices::getInstance();
1075                         $services->resetServiceForTesting( 'ContentLanguage' );
1076                         $this->doSetMwGlobals( [ 'wgContLang' => $services->getContentLanguage() ] );
1077                 }
1078         }
1079
1080         /**
1081          * Alters $wgGroupPermissions for the duration of the test.  Can be called
1082          * with an array, like
1083          *   [ '*' => [ 'read' => false ], 'user' => [ 'read' => false ] ]
1084          * or three values to set a single permission, like
1085          *   $this->setGroupPermissions( '*', 'read', false );
1086          *
1087          * @since 1.31
1088          * @param array|string $newPerms Either an array of permissions to change,
1089          *   in which case the next two parameters are ignored; or a single string
1090          *   identifying a group, to use with the next two parameters.
1091          * @param string|null $newKey
1092          * @param mixed|null $newValue
1093          */
1094         public function setGroupPermissions( $newPerms, $newKey = null, $newValue = null ) {
1095                 global $wgGroupPermissions;
1096
1097                 if ( is_string( $newPerms ) ) {
1098                         $newPerms = [ $newPerms => [ $newKey => $newValue ] ];
1099                 }
1100
1101                 $newPermissions = $wgGroupPermissions;
1102                 foreach ( $newPerms as $group => $permissions ) {
1103                         foreach ( $permissions as $key => $value ) {
1104                                 $newPermissions[$group][$key] = $value;
1105                         }
1106                 }
1107
1108                 $this->setMwGlobals( 'wgGroupPermissions', $newPermissions );
1109         }
1110
1111         /**
1112          * Sets the logger for a specified channel, for the duration of the test.
1113          * @since 1.27
1114          * @param string $channel
1115          * @param LoggerInterface $logger
1116          */
1117         protected function setLogger( $channel, LoggerInterface $logger ) {
1118                 // TODO: Once loggers are managed by MediaWikiServices, use
1119                 //       overrideMwServices() to set loggers.
1120
1121                 $provider = LoggerFactory::getProvider();
1122                 $wrappedProvider = TestingAccessWrapper::newFromObject( $provider );
1123                 $singletons = $wrappedProvider->singletons;
1124                 if ( $provider instanceof MonologSpi ) {
1125                         if ( !isset( $this->loggers[$channel] ) ) {
1126                                 $this->loggers[$channel] = $singletons['loggers'][$channel] ?? null;
1127                         }
1128                         $singletons['loggers'][$channel] = $logger;
1129                 } elseif ( $provider instanceof LegacySpi || $provider instanceof LogCapturingSpi ) {
1130                         if ( !isset( $this->loggers[$channel] ) ) {
1131                                 $this->loggers[$channel] = $singletons[$channel] ?? null;
1132                         }
1133                         $singletons[$channel] = $logger;
1134                 } else {
1135                         throw new LogicException( __METHOD__ . ': setting a logger for ' . get_class( $provider )
1136                                 . ' is not implemented' );
1137                 }
1138                 $wrappedProvider->singletons = $singletons;
1139         }
1140
1141         /**
1142          * Restores loggers replaced by setLogger().
1143          * @since 1.27
1144          */
1145         private function restoreLoggers() {
1146                 $provider = LoggerFactory::getProvider();
1147                 $wrappedProvider = TestingAccessWrapper::newFromObject( $provider );
1148                 $singletons = $wrappedProvider->singletons;
1149                 foreach ( $this->loggers as $channel => $logger ) {
1150                         if ( $provider instanceof MonologSpi ) {
1151                                 if ( $logger === null ) {
1152                                         unset( $singletons['loggers'][$channel] );
1153                                 } else {
1154                                         $singletons['loggers'][$channel] = $logger;
1155                                 }
1156                         } elseif ( $provider instanceof LegacySpi || $provider instanceof LogCapturingSpi ) {
1157                                 if ( $logger === null ) {
1158                                         unset( $singletons[$channel] );
1159                                 } else {
1160                                         $singletons[$channel] = $logger;
1161                                 }
1162                         }
1163                 }
1164                 $wrappedProvider->singletons = $singletons;
1165                 $this->loggers = [];
1166         }
1167
1168         /**
1169          * @return string
1170          * @since 1.18
1171          */
1172         public function dbPrefix() {
1173                 return self::getTestPrefixFor( $this->db );
1174         }
1175
1176         /**
1177          * @param IDatabase $db
1178          * @return string
1179          * @since 1.32
1180          */
1181         public static function getTestPrefixFor( IDatabase $db ) {
1182                 return $db->getType() == 'oracle' ? self::ORA_DB_PREFIX : self::DB_PREFIX;
1183         }
1184
1185         /**
1186          * @return bool
1187          * @since 1.18
1188          */
1189         public function needsDB() {
1190                 // If the test says it uses database tables, it needs the database
1191                 return $this->tablesUsed || $this->isTestInDatabaseGroup();
1192         }
1193
1194         /**
1195          * @return bool
1196          * @since 1.32
1197          */
1198         protected function isTestInDatabaseGroup() {
1199                 // If the test class says it belongs to the Database group, it needs the database.
1200                 // NOTE: This ONLY checks for the group in the class level doc comment.
1201                 $rc = new ReflectionClass( $this );
1202                 return (bool)preg_match( '/@group +Database/im', $rc->getDocComment() );
1203         }
1204
1205         /**
1206          * Insert a new page.
1207          *
1208          * Should be called from addDBData().
1209          *
1210          * @since 1.25 ($namespace in 1.28)
1211          * @param string|Title $pageName Page name or title
1212          * @param string $text Page's content
1213          * @param int|null $namespace Namespace id (name cannot already contain namespace)
1214          * @param User|null $user If null, static::getTestSysop()->getUser() is used.
1215          * @return array Title object and page id
1216          * @throws MWException If this test cases's needsDB() method doesn't return true.
1217          *         Test cases can use "@group Database" to enable database test support,
1218          *         or list the tables under testing in $this->tablesUsed, or override the
1219          *         needsDB() method.
1220          */
1221         protected function insertPage(
1222                 $pageName,
1223                 $text = 'Sample page for unit test.',
1224                 $namespace = null,
1225                 User $user = null
1226         ) {
1227                 if ( !$this->needsDB() ) {
1228                         throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
1229                                 ' method should return true. Use @group Database or $this->tablesUsed.' );
1230                 }
1231
1232                 if ( is_string( $pageName ) ) {
1233                         $title = Title::newFromText( $pageName, $namespace );
1234                 } else {
1235                         $title = $pageName;
1236                 }
1237
1238                 if ( !$user ) {
1239                         $user = static::getTestSysop()->getUser();
1240                 }
1241                 $comment = __METHOD__ . ': Sample page for unit test.';
1242
1243                 $page = WikiPage::factory( $title );
1244                 $page->doEditContent( ContentHandler::makeContent( $text, $title ), $comment, 0, false, $user );
1245
1246                 return [
1247                         'title' => $title,
1248                         'id' => $page->getId(),
1249                 ];
1250         }
1251
1252         /**
1253          * Stub. If a test suite needs to add additional data to the database, it should
1254          * implement this method and do so. This method is called once per test suite
1255          * (i.e. once per class).
1256          *
1257          * Note data added by this method may be removed by resetDB() depending on
1258          * the contents of $tablesUsed.
1259          *
1260          * To add additional data between test function runs, override prepareDB().
1261          *
1262          * @see addDBData()
1263          * @see resetDB()
1264          *
1265          * @since 1.27
1266          */
1267         public function addDBDataOnce() {
1268         }
1269
1270         /**
1271          * Stub. Subclasses may override this to prepare the database.
1272          * Called before every test run (test function or data set).
1273          *
1274          * @see addDBDataOnce()
1275          * @see resetDB()
1276          *
1277          * @since 1.18
1278          */
1279         public function addDBData() {
1280         }
1281
1282         /**
1283          * @since 1.32
1284          */
1285         protected function addCoreDBData() {
1286                 if ( $this->db->getType() == 'oracle' ) {
1287                         # Insert 0 user to prevent FK violations
1288                         # Anonymous user
1289                         if ( !$this->db->selectField( 'user', '1', [ 'user_id' => 0 ] ) ) {
1290                                 $this->db->insert( 'user', [
1291                                         'user_id' => 0,
1292                                         'user_name' => 'Anonymous' ], __METHOD__, [ 'IGNORE' ] );
1293                         }
1294
1295                         # Insert 0 page to prevent FK violations
1296                         # Blank page
1297                         if ( !$this->db->selectField( 'page', '1', [ 'page_id' => 0 ] ) ) {
1298                                 $this->db->insert( 'page', [
1299                                         'page_id' => 0,
1300                                         'page_namespace' => 0,
1301                                         'page_title' => ' ',
1302                                         'page_restrictions' => null,
1303                                         'page_is_redirect' => 0,
1304                                         'page_is_new' => 0,
1305                                         'page_random' => 0,
1306                                         'page_touched' => $this->db->timestamp(),
1307                                         'page_latest' => 0,
1308                                         'page_len' => 0 ], __METHOD__, [ 'IGNORE' ] );
1309                         }
1310                 }
1311
1312                 SiteStatsInit::doPlaceholderInit();
1313
1314                 User::resetIdByNameCache();
1315
1316                 // Make sysop user
1317                 $user = static::getTestSysop()->getUser();
1318
1319                 // Make 1 page with 1 revision
1320                 $page = WikiPage::factory( Title::newFromText( 'UTPage' ) );
1321                 if ( $page->getId() == 0 ) {
1322                         $page->doEditContent(
1323                                 new WikitextContent( 'UTContent' ),
1324                                 'UTPageSummary',
1325                                 EDIT_NEW | EDIT_SUPPRESS_RC,
1326                                 false,
1327                                 $user
1328                         );
1329                         // an edit always attempt to purge backlink links such as history
1330                         // pages. That is unnecessary.
1331                         JobQueueGroup::singleton()->get( 'htmlCacheUpdate' )->delete();
1332                         // WikiPages::doEditUpdates randomly adds RC purges
1333                         JobQueueGroup::singleton()->get( 'recentChangesUpdate' )->delete();
1334
1335                         // doEditContent() probably started the session via
1336                         // User::loadFromSession(). Close it now.
1337                         if ( session_id() !== '' ) {
1338                                 session_write_close();
1339                                 session_id( '' );
1340                         }
1341                 }
1342         }
1343
1344         /**
1345          * Restores MediaWiki to using the table set (table prefix) it was using before
1346          * setupTestDB() was called. Useful if we need to perform database operations
1347          * after the test run has finished (such as saving logs or profiling info).
1348          *
1349          * This is called by phpunit/bootstrap.php after the last test.
1350          *
1351          * @since 1.21
1352          */
1353         public static function teardownTestDB() {
1354                 global $wgJobClasses;
1355
1356                 if ( !self::$dbSetup ) {
1357                         return;
1358                 }
1359
1360                 Hooks::run( 'UnitTestsBeforeDatabaseTeardown' );
1361
1362                 foreach ( $wgJobClasses as $type => $class ) {
1363                         // Delete any jobs under the clone DB (or old prefix in other stores)
1364                         JobQueueGroup::singleton()->get( $type )->delete();
1365                 }
1366
1367                 // T219673: close any connections from code that failed to call reuseConnection()
1368                 // or is still holding onto a DBConnRef instance (e.g. in a singleton).
1369                 MediaWikiServices::getInstance()->getDBLoadBalancerFactory()->closeAll();
1370                 CloneDatabase::changePrefix( self::$oldTablePrefix );
1371
1372                 self::$oldTablePrefix = false;
1373                 self::$dbSetup = false;
1374         }
1375
1376         /**
1377          * Setups a database with cloned tables using the given prefix.
1378          *
1379          * If reuseDB is true and certain conditions apply, it will just change the prefix.
1380          * Otherwise, it will clone the tables and change the prefix.
1381          *
1382          * @param IMaintainableDatabase $db Database to use
1383          * @param string|null $prefix Prefix to use for test tables. If not given, the prefix is determined
1384          *        automatically for $db.
1385          * @return bool True if tables were cloned, false if only the prefix was changed
1386          */
1387         protected static function setupDatabaseWithTestPrefix(
1388                 IMaintainableDatabase $db,
1389                 $prefix = null
1390         ) {
1391                 if ( $prefix === null ) {
1392                         $prefix = self::getTestPrefixFor( $db );
1393                 }
1394
1395                 if ( ( $db->getType() == 'oracle' || !self::$useTemporaryTables ) && self::$reuseDB ) {
1396                         $db->tablePrefix( $prefix );
1397                         return false;
1398                 }
1399
1400                 if ( !isset( $db->_originalTablePrefix ) ) {
1401                         $oldPrefix = $db->tablePrefix();
1402
1403                         if ( $oldPrefix === $prefix ) {
1404                                 // table already has the correct prefix, but presumably no cloned tables
1405                                 $oldPrefix = self::$oldTablePrefix;
1406                         }
1407
1408                         $db->tablePrefix( $oldPrefix );
1409                         $tablesCloned = self::listTables( $db );
1410                         $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix, $oldPrefix );
1411                         $dbClone->useTemporaryTables( self::$useTemporaryTables );
1412
1413                         $dbClone->cloneTableStructure();
1414
1415                         $db->tablePrefix( $prefix );
1416                         $db->_originalTablePrefix = $oldPrefix;
1417                 }
1418
1419                 return true;
1420         }
1421
1422         /**
1423          * Set up all test DBs
1424          */
1425         public function setupAllTestDBs() {
1426                 global $wgDBprefix;
1427
1428                 self::$oldTablePrefix = $wgDBprefix;
1429
1430                 $testPrefix = $this->dbPrefix();
1431
1432                 // switch to a temporary clone of the database
1433                 self::setupTestDB( $this->db, $testPrefix );
1434
1435                 if ( self::isUsingExternalStoreDB() ) {
1436                         self::setupExternalStoreTestDBs( $testPrefix );
1437                 }
1438
1439                 // NOTE: Change the prefix in the LBFactory and $wgDBprefix, to prevent
1440                 // *any* database connections to operate on live data.
1441                 CloneDatabase::changePrefix( $testPrefix );
1442         }
1443
1444         /**
1445          * Creates an empty skeleton of the wiki database by cloning its structure
1446          * to equivalent tables using the given $prefix. Then sets MediaWiki to
1447          * use the new set of tables (aka schema) instead of the original set.
1448          *
1449          * This is used to generate a dummy table set, typically consisting of temporary
1450          * tables, that will be used by tests instead of the original wiki database tables.
1451          *
1452          * @since 1.21
1453          *
1454          * @note the original table prefix is stored in self::$oldTablePrefix. This is used
1455          * by teardownTestDB() to return the wiki to using the original table set.
1456          *
1457          * @note this method only works when first called. Subsequent calls have no effect,
1458          * even if using different parameters.
1459          *
1460          * @param IMaintainableDatabase $db The database connection
1461          * @param string $prefix The prefix to use for the new table set (aka schema).
1462          *
1463          * @throws MWException If the database table prefix is already $prefix
1464          */
1465         public static function setupTestDB( IMaintainableDatabase $db, $prefix ) {
1466                 if ( self::$dbSetup ) {
1467                         return;
1468                 }
1469
1470                 if ( $db->tablePrefix() === $prefix ) {
1471                         throw new MWException(
1472                                 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
1473                 }
1474
1475                 // TODO: the below should be re-written as soon as LBFactory, LoadBalancer,
1476                 // and Database no longer use global state.
1477
1478                 self::$dbSetup = true;
1479
1480                 if ( !self::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
1481                         return;
1482                 }
1483
1484                 // Assuming this isn't needed for External Store database, and not sure if the procedure
1485                 // would be available there.
1486                 if ( $db->getType() == 'oracle' ) {
1487                         $db->query( 'BEGIN FILL_WIKI_INFO; END;', __METHOD__ );
1488                 }
1489
1490                 Hooks::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
1491         }
1492
1493         /**
1494          * Clones the External Store database(s) for testing
1495          *
1496          * @param string|null $testPrefix Prefix for test tables. Will be determined automatically
1497          *        if not given.
1498          */
1499         protected static function setupExternalStoreTestDBs( $testPrefix = null ) {
1500                 $connections = self::getExternalStoreDatabaseConnections();
1501                 foreach ( $connections as $dbw ) {
1502                         self::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
1503                 }
1504         }
1505
1506         /**
1507          * Gets master database connections for all of the ExternalStoreDB
1508          * stores configured in $wgDefaultExternalStore.
1509          *
1510          * @return Database[] Array of Database master connections
1511          */
1512         protected static function getExternalStoreDatabaseConnections() {
1513                 global $wgDefaultExternalStore;
1514
1515                 /** @var ExternalStoreDB $externalStoreDB */
1516                 $externalStoreDB = ExternalStore::getStoreObject( 'DB' );
1517                 $defaultArray = (array)$wgDefaultExternalStore;
1518                 $dbws = [];
1519                 foreach ( $defaultArray as $url ) {
1520                         if ( strpos( $url, 'DB://' ) === 0 ) {
1521                                 list( $proto, $cluster ) = explode( '://', $url, 2 );
1522                                 // Avoid getMaster() because setupDatabaseWithTestPrefix()
1523                                 // requires Database instead of plain DBConnRef/IDatabase
1524                                 $dbws[] = $externalStoreDB->getMaster( $cluster );
1525                         }
1526                 }
1527
1528                 return $dbws;
1529         }
1530
1531         /**
1532          * Check whether ExternalStoreDB is being used
1533          *
1534          * @return bool True if it's being used
1535          */
1536         protected static function isUsingExternalStoreDB() {
1537                 global $wgDefaultExternalStore;
1538                 if ( !$wgDefaultExternalStore ) {
1539                         return false;
1540                 }
1541
1542                 $defaultArray = (array)$wgDefaultExternalStore;
1543                 foreach ( $defaultArray as $url ) {
1544                         if ( strpos( $url, 'DB://' ) === 0 ) {
1545                                 return true;
1546                         }
1547                 }
1548
1549                 return false;
1550         }
1551
1552         /**
1553          * @throws LogicException if the given database connection is not a set up to use
1554          * mock tables.
1555          *
1556          * @since 1.31 this is no longer private.
1557          */
1558         protected function ensureMockDatabaseConnection( IDatabase $db ) {
1559                 if ( $db->tablePrefix() !== $this->dbPrefix() ) {
1560                         throw new LogicException(
1561                                 'Trying to delete mock tables, but table prefix does not indicate a mock database.'
1562                         );
1563                 }
1564         }
1565
1566         private static $schemaOverrideDefaults = [
1567                 'scripts' => [],
1568                 'create' => [],
1569                 'drop' => [],
1570                 'alter' => [],
1571         ];
1572
1573         /**
1574          * Stub. If a test suite needs to test against a specific database schema, it should
1575          * override this method and return the appropriate information from it.
1576          *
1577          * @param IMaintainableDatabase $db The DB connection to use for the mock schema.
1578          *        May be used to check the current state of the schema, to determine what
1579          *        overrides are needed.
1580          *
1581          * @return array An associative array with the following fields:
1582          *  - 'scripts': any SQL scripts to run. If empty or not present, schema overrides are skipped.
1583          * - 'create': A list of tables created (may or may not exist in the original schema).
1584          * - 'drop': A list of tables dropped (expected to be present in the original schema).
1585          * - 'alter': A list of tables altered (expected to be present in the original schema).
1586          */
1587         protected function getSchemaOverrides( IMaintainableDatabase $db ) {
1588                 return [];
1589         }
1590
1591         /**
1592          * Undoes the specified schema overrides..
1593          * Called once per test class, just before addDataOnce().
1594          *
1595          * @param IMaintainableDatabase $db
1596          * @param array $oldOverrides
1597          */
1598         private function undoSchemaOverrides( IMaintainableDatabase $db, $oldOverrides ) {
1599                 $this->ensureMockDatabaseConnection( $db );
1600
1601                 $oldOverrides = $oldOverrides + self::$schemaOverrideDefaults;
1602                 $originalTables = $this->listOriginalTables( $db );
1603
1604                 // Drop tables that need to be restored or removed.
1605                 $tablesToDrop = array_merge( $oldOverrides['create'], $oldOverrides['alter'] );
1606
1607                 // Restore tables that have been dropped or created or altered,
1608                 // if they exist in the original schema.
1609                 $tablesToRestore = array_merge( $tablesToDrop, $oldOverrides['drop'] );
1610                 $tablesToRestore = array_intersect( $originalTables, $tablesToRestore );
1611
1612                 if ( $tablesToDrop ) {
1613                         $this->dropMockTables( $db, $tablesToDrop );
1614                 }
1615
1616                 if ( $tablesToRestore ) {
1617                         $this->recloneMockTables( $db, $tablesToRestore );
1618
1619                         // Reset the restored tables, mainly for the side effect of
1620                         // re-calling $this->addCoreDBData() if necessary.
1621                         $this->resetDB( $db, $tablesToRestore );
1622                 }
1623         }
1624
1625         /**
1626          * Applies the schema overrides returned by getSchemaOverrides(),
1627          * after undoing any previously applied schema overrides.
1628          * Called once per test class, just before addDataOnce().
1629          */
1630         private function setUpSchema( IMaintainableDatabase $db ) {
1631                 // Undo any active overrides.
1632                 $oldOverrides = $db->_schemaOverrides ?? self::$schemaOverrideDefaults;
1633
1634                 if ( $oldOverrides['alter'] || $oldOverrides['create'] || $oldOverrides['drop'] ) {
1635                         $this->undoSchemaOverrides( $db, $oldOverrides );
1636                         unset( $db->_schemaOverrides );
1637                 }
1638
1639                 // Determine new overrides.
1640                 $overrides = $this->getSchemaOverrides( $db ) + self::$schemaOverrideDefaults;
1641
1642                 $extraKeys = array_diff(
1643                         array_keys( $overrides ),
1644                         array_keys( self::$schemaOverrideDefaults )
1645                 );
1646
1647                 if ( $extraKeys ) {
1648                         throw new InvalidArgumentException(
1649                                 'Schema override contains extra keys: ' . var_export( $extraKeys, true )
1650                         );
1651                 }
1652
1653                 if ( !$overrides['scripts'] ) {
1654                         // no scripts to run
1655                         return;
1656                 }
1657
1658                 if ( !$overrides['create'] && !$overrides['drop'] && !$overrides['alter'] ) {
1659                         throw new InvalidArgumentException(
1660                                 'Schema override scripts given, but no tables are declared to be '
1661                                 . 'created, dropped or altered.'
1662                         );
1663                 }
1664
1665                 $this->ensureMockDatabaseConnection( $db );
1666
1667                 // Drop the tables that will be created by the schema scripts.
1668                 $originalTables = $this->listOriginalTables( $db );
1669                 $tablesToDrop = array_intersect( $originalTables, $overrides['create'] );
1670
1671                 if ( $tablesToDrop ) {
1672                         $this->dropMockTables( $db, $tablesToDrop );
1673                 }
1674
1675                 // Run schema override scripts.
1676                 foreach ( $overrides['scripts'] as $script ) {
1677                         $db->sourceFile(
1678                                 $script,
1679                                 null,
1680                                 null,
1681                                 __METHOD__,
1682                                 function ( $cmd ) {
1683                                         return $this->mungeSchemaUpdateQuery( $cmd );
1684                                 }
1685                         );
1686                 }
1687
1688                 $db->_schemaOverrides = $overrides;
1689         }
1690
1691         private function mungeSchemaUpdateQuery( $cmd ) {
1692                 return self::$useTemporaryTables
1693                         ? preg_replace( '/\bCREATE\s+TABLE\b/i', 'CREATE TEMPORARY TABLE', $cmd )
1694                         : $cmd;
1695         }
1696
1697         /**
1698          * Drops the given mock tables.
1699          *
1700          * @param IMaintainableDatabase $db
1701          * @param array $tables
1702          */
1703         private function dropMockTables( IMaintainableDatabase $db, array $tables ) {
1704                 $this->ensureMockDatabaseConnection( $db );
1705
1706                 foreach ( $tables as $tbl ) {
1707                         $tbl = $db->tableName( $tbl );
1708                         $db->query( "DROP TABLE IF EXISTS $tbl", __METHOD__ );
1709                 }
1710         }
1711
1712         /**
1713          * Lists all tables in the live database schema, without a prefix.
1714          *
1715          * @param IMaintainableDatabase $db
1716          * @return array
1717          */
1718         private function listOriginalTables( IMaintainableDatabase $db ) {
1719                 if ( !isset( $db->_originalTablePrefix ) ) {
1720                         throw new LogicException( 'No original table prefix know, cannot list tables!' );
1721                 }
1722
1723                 $originalTables = $db->listTables( $db->_originalTablePrefix, __METHOD__ );
1724
1725                 $unittestPrefixRegex = '/^' . preg_quote( $this->dbPrefix(), '/' ) . '/';
1726                 $originalPrefixRegex = '/^' . preg_quote( $db->_originalTablePrefix, '/' ) . '/';
1727
1728                 $originalTables = array_filter(
1729                         $originalTables,
1730                         function ( $pt ) use ( $unittestPrefixRegex ) {
1731                                 return !preg_match( $unittestPrefixRegex, $pt );
1732                         }
1733                 );
1734
1735                 $originalTables = array_map(
1736                         function ( $pt ) use ( $originalPrefixRegex ) {
1737                                 return preg_replace( $originalPrefixRegex, '', $pt );
1738                         },
1739                         $originalTables
1740                 );
1741
1742                 return array_unique( $originalTables );
1743         }
1744
1745         /**
1746          * Re-clones the given mock tables to restore them based on the live database schema.
1747          * The tables listed in $tables are expected to currently not exist, so dropMockTables()
1748          * should be called first.
1749          *
1750          * @param IMaintainableDatabase $db
1751          * @param array $tables
1752          */
1753         private function recloneMockTables( IMaintainableDatabase $db, array $tables ) {
1754                 $this->ensureMockDatabaseConnection( $db );
1755
1756                 if ( !isset( $db->_originalTablePrefix ) ) {
1757                         throw new LogicException( 'No original table prefix know, cannot restore tables!' );
1758                 }
1759
1760                 $originalTables = $this->listOriginalTables( $db );
1761                 $tables = array_intersect( $tables, $originalTables );
1762
1763                 $dbClone = new CloneDatabase( $db, $tables, $db->tablePrefix(), $db->_originalTablePrefix );
1764                 $dbClone->useTemporaryTables( self::$useTemporaryTables );
1765
1766                 $dbClone->cloneTableStructure();
1767         }
1768
1769         /**
1770          * Empty all tables so they can be repopulated for tests
1771          *
1772          * @param Database $db|null Database to reset
1773          * @param array $tablesUsed Tables to reset
1774          */
1775         private function resetDB( $db, $tablesUsed ) {
1776                 if ( $db ) {
1777                         $userTables = [ 'user', 'user_groups', 'user_properties', 'actor' ];
1778                         $pageTables = [
1779                                 'page', 'revision', 'ip_changes', 'revision_comment_temp', 'comment', 'archive',
1780                                 'revision_actor_temp', 'slots', 'content', 'content_models', 'slot_roles',
1781                         ];
1782                         $coreDBDataTables = array_merge( $userTables, $pageTables );
1783
1784                         // If any of the user or page tables were marked as used, we should clear all of them.
1785                         if ( array_intersect( $tablesUsed, $userTables ) ) {
1786                                 $tablesUsed = array_unique( array_merge( $tablesUsed, $userTables ) );
1787                                 TestUserRegistry::clear();
1788
1789                                 // Reset $wgUser, which is probably 127.0.0.1, as its loaded data is probably not valid
1790                                 // @todo Should we start setting $wgUser to something nondeterministic
1791                                 //  to encourage tests to be updated to not depend on it?
1792                                 global $wgUser;
1793                                 $wgUser->clearInstanceCache( $wgUser->mFrom );
1794                         }
1795                         if ( array_intersect( $tablesUsed, $pageTables ) ) {
1796                                 $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
1797                         }
1798
1799                         // Postgres, Oracle, and MSSQL all use mwuser/pagecontent
1800                         // instead of user/text. But Postgres does not remap the
1801                         // table name in tableExists(), so we mark the real table
1802                         // names as being used.
1803                         if ( $db->getType() === 'postgres' ) {
1804                                 if ( in_array( 'user', $tablesUsed ) ) {
1805                                         $tablesUsed[] = 'mwuser';
1806                                 }
1807                                 if ( in_array( 'text', $tablesUsed ) ) {
1808                                         $tablesUsed[] = 'pagecontent';
1809                                 }
1810                         }
1811
1812                         foreach ( $tablesUsed as $tbl ) {
1813                                 $this->truncateTable( $tbl, $db );
1814                         }
1815
1816                         if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
1817                                 // Reset services that may contain information relating to the truncated tables
1818                                 $this->overrideMwServices();
1819                                 // Re-add core DB data that was deleted
1820                                 $this->addCoreDBData();
1821                         }
1822                 }
1823         }
1824
1825         /**
1826          * Empties the given table and resets any auto-increment counters.
1827          * Will also purge caches associated with some well known tables.
1828          * If the table is not know, this method just returns.
1829          *
1830          * @param string $tableName
1831          * @param IDatabase|null $db
1832          */
1833         protected function truncateTable( $tableName, IDatabase $db = null ) {
1834                 if ( !$db ) {
1835                         $db = $this->db;
1836                 }
1837
1838                 if ( !$db->tableExists( $tableName ) ) {
1839                         return;
1840                 }
1841
1842                 $truncate = in_array( $db->getType(), [ 'oracle', 'mysql' ] );
1843
1844                 if ( $truncate ) {
1845                         $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tableName ), __METHOD__ );
1846                 } else {
1847                         $db->delete( $tableName, '*', __METHOD__ );
1848                 }
1849
1850                 if ( $db instanceof DatabasePostgres || $db instanceof DatabaseSqlite ) {
1851                         // Reset the table's sequence too.
1852                         $db->resetSequenceForTable( $tableName, __METHOD__ );
1853                 }
1854
1855                 // re-initialize site_stats table
1856                 if ( $tableName === 'site_stats' ) {
1857                         SiteStatsInit::doPlaceholderInit();
1858                 }
1859         }
1860
1861         private static function unprefixTable( &$tableName, $ind, $prefix ) {
1862                 $tableName = substr( $tableName, strlen( $prefix ) );
1863         }
1864
1865         private static function isNotUnittest( $table ) {
1866                 return strpos( $table, self::DB_PREFIX ) !== 0;
1867         }
1868
1869         /**
1870          * @since 1.18
1871          *
1872          * @param IMaintainableDatabase $db
1873          *
1874          * @return array
1875          */
1876         public static function listTables( IMaintainableDatabase $db ) {
1877                 $prefix = $db->tablePrefix();
1878                 $tables = $db->listTables( $prefix, __METHOD__ );
1879
1880                 if ( $db->getType() === 'mysql' ) {
1881                         static $viewListCache = null;
1882                         if ( $viewListCache === null ) {
1883                                 $viewListCache = $db->listViews( null, __METHOD__ );
1884                         }
1885                         // T45571: cannot clone VIEWs under MySQL
1886                         $tables = array_diff( $tables, $viewListCache );
1887                 }
1888                 array_walk( $tables, [ __CLASS__, 'unprefixTable' ], $prefix );
1889
1890                 // Don't duplicate test tables from the previous fataled run
1891                 $tables = array_filter( $tables, [ __CLASS__, 'isNotUnittest' ] );
1892
1893                 if ( $db->getType() == 'sqlite' ) {
1894                         $tables = array_flip( $tables );
1895                         // these are subtables of searchindex and don't need to be duped/dropped separately
1896                         unset( $tables['searchindex_content'] );
1897                         unset( $tables['searchindex_segdir'] );
1898                         unset( $tables['searchindex_segments'] );
1899                         $tables = array_flip( $tables );
1900                 }
1901
1902                 return $tables;
1903         }
1904
1905         /**
1906          * Copy test data from one database connection to another.
1907          *
1908          * This should only be used for small data sets.
1909          *
1910          * @param IDatabase $source
1911          * @param IDatabase $target
1912          */
1913         public function copyTestData( IDatabase $source, IDatabase $target ) {
1914                 if ( $this->db->getType() === 'sqlite' ) {
1915                         // SQLite uses a non-temporary copy of the searchindex table for testing,
1916                         // which gets deleted and re-created when setting up the secondary connection,
1917                         // causing "Error 17" when trying to copy the data. See T191863#4130112.
1918                         throw new RuntimeException(
1919                                 'Setting up a secondary database connection with test data is currently not'
1920                                 . 'with SQLite. You may want to use markTestSkippedIfDbType() to bypass this issue.'
1921                         );
1922                 }
1923
1924                 $tables = self::listOriginalTables( $source );
1925
1926                 foreach ( $tables as $table ) {
1927                         $res = $source->select( $table, '*', [], __METHOD__ );
1928                         $allRows = [];
1929
1930                         foreach ( $res as $row ) {
1931                                 $allRows[] = (array)$row;
1932                         }
1933
1934                         $target->insert( $table, $allRows, __METHOD__, [ 'IGNORE' ] );
1935                 }
1936         }
1937
1938         /**
1939          * @throws MWException
1940          * @since 1.18
1941          */
1942         protected function checkDbIsSupported() {
1943                 if ( !in_array( $this->db->getType(), $this->supportedDBs ) ) {
1944                         throw new MWException( $this->db->getType() . " is not currently supported for unit testing." );
1945                 }
1946         }
1947
1948         /**
1949          * @since 1.18
1950          * @param string $offset
1951          * @return mixed
1952          */
1953         public function getCliArg( $offset ) {
1954                 return $this->cliArgs[$offset] ?? null;
1955         }
1956
1957         /**
1958          * @since 1.18
1959          * @param string $offset
1960          * @param mixed $value
1961          */
1962         public function setCliArg( $offset, $value ) {
1963                 $this->cliArgs[$offset] = $value;
1964         }
1965
1966         /**
1967          * Don't throw a warning if $function is deprecated and called later
1968          *
1969          * @since 1.19
1970          *
1971          * @param string $function
1972          */
1973         public function hideDeprecated( $function ) {
1974                 Wikimedia\suppressWarnings();
1975                 wfDeprecated( $function );
1976                 Wikimedia\restoreWarnings();
1977         }
1978
1979         /**
1980          * Asserts that the given database query yields the rows given by $expectedRows.
1981          * The expected rows should be given as indexed (not associative) arrays, with
1982          * the values given in the order of the columns in the $fields parameter.
1983          * Note that the rows are sorted by the columns given in $fields.
1984          *
1985          * @since 1.20
1986          *
1987          * @param string|array $table The table(s) to query
1988          * @param string|array $fields The columns to include in the result (and to sort by)
1989          * @param string|array $condition "where" condition(s)
1990          * @param array $expectedRows An array of arrays giving the expected rows.
1991          * @param array $options Options for the query
1992          * @param array $join_conds Join conditions for the query
1993          *
1994          * @throws MWException If this test cases's needsDB() method doesn't return true.
1995          *         Test cases can use "@group Database" to enable database test support,
1996          *         or list the tables under testing in $this->tablesUsed, or override the
1997          *         needsDB() method.
1998          */
1999         protected function assertSelect(
2000                 $table, $fields, $condition, array $expectedRows, array $options = [], array $join_conds = []
2001         ) {
2002                 if ( !$this->needsDB() ) {
2003                         throw new MWException( 'When testing database state, the test cases\'s needDB()' .
2004                                 ' method should return true. Use @group Database or $this->tablesUsed.' );
2005                 }
2006
2007                 $db = wfGetDB( DB_REPLICA );
2008
2009                 $res = $db->select(
2010                         $table,
2011                         $fields,
2012                         $condition,
2013                         wfGetCaller(),
2014                         $options + [ 'ORDER BY' => $fields ],
2015                         $join_conds
2016                 );
2017                 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
2018
2019                 $i = 0;
2020
2021                 foreach ( $expectedRows as $expected ) {
2022                         $r = $res->fetchRow();
2023                         self::stripStringKeys( $r );
2024
2025                         $i += 1;
2026                         $this->assertNotEmpty( $r, "row #$i missing" );
2027
2028                         $this->assertEquals( $expected, $r, "row #$i mismatches" );
2029                 }
2030
2031                 $r = $res->fetchRow();
2032                 self::stripStringKeys( $r );
2033
2034                 $this->assertFalse( $r, "found extra row (after #$i)" );
2035         }
2036
2037         /**
2038          * Utility method taking an array of elements and wrapping
2039          * each element in its own array. Useful for data providers
2040          * that only return a single argument.
2041          *
2042          * @since 1.20
2043          *
2044          * @param array $elements
2045          *
2046          * @return array
2047          */
2048         protected function arrayWrap( array $elements ) {
2049                 return array_map(
2050                         function ( $element ) {
2051                                 return [ $element ];
2052                         },
2053                         $elements
2054                 );
2055         }
2056
2057         /**
2058          * Assert that two arrays are equal. By default this means that both arrays need to hold
2059          * the same set of values. Using additional arguments, order and associated key can also
2060          * be set as relevant.
2061          *
2062          * @since 1.20
2063          *
2064          * @param array $expected
2065          * @param array $actual
2066          * @param bool $ordered If the order of the values should match
2067          * @param bool $named If the keys should match
2068          */
2069         protected function assertArrayEquals( array $expected, array $actual,
2070                 $ordered = false, $named = false
2071         ) {
2072                 if ( !$ordered ) {
2073                         $this->objectAssociativeSort( $expected );
2074                         $this->objectAssociativeSort( $actual );
2075                 }
2076
2077                 if ( !$named ) {
2078                         $expected = array_values( $expected );
2079                         $actual = array_values( $actual );
2080                 }
2081
2082                 call_user_func_array(
2083                         [ $this, 'assertEquals' ],
2084                         array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
2085                 );
2086         }
2087
2088         /**
2089          * Put each HTML element on its own line and then equals() the results
2090          *
2091          * Use for nicely formatting of PHPUnit diff output when comparing very
2092          * simple HTML
2093          *
2094          * @since 1.20
2095          *
2096          * @param string $expected HTML on oneline
2097          * @param string $actual HTML on oneline
2098          * @param string $msg Optional message
2099          */
2100         protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
2101                 $expected = str_replace( '>', ">\n", $expected );
2102                 $actual = str_replace( '>', ">\n", $actual );
2103
2104                 $this->assertEquals( $expected, $actual, $msg );
2105         }
2106
2107         /**
2108          * Does an associative sort that works for objects.
2109          *
2110          * @since 1.20
2111          *
2112          * @param array &$array
2113          */
2114         protected function objectAssociativeSort( array &$array ) {
2115                 uasort(
2116                         $array,
2117                         function ( $a, $b ) {
2118                                 return serialize( $a ) <=> serialize( $b );
2119                         }
2120                 );
2121         }
2122
2123         /**
2124          * Utility function for eliminating all string keys from an array.
2125          * Useful to turn a database result row as returned by fetchRow() into
2126          * a pure indexed array.
2127          *
2128          * @since 1.20
2129          *
2130          * @param mixed &$r The array to remove string keys from.
2131          */
2132         protected static function stripStringKeys( &$r ) {
2133                 if ( !is_array( $r ) ) {
2134                         return;
2135                 }
2136
2137                 foreach ( $r as $k => $v ) {
2138                         if ( is_string( $k ) ) {
2139                                 unset( $r[$k] );
2140                         }
2141                 }
2142         }
2143
2144         /**
2145          * Asserts that the provided variable is of the specified
2146          * internal type or equals the $value argument. This is useful
2147          * for testing return types of functions that return a certain
2148          * type or *value* when not set or on error.
2149          *
2150          * @since 1.20
2151          *
2152          * @param string $type
2153          * @param mixed $actual
2154          * @param mixed $value
2155          * @param string $message
2156          */
2157         protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
2158                 if ( $actual === $value ) {
2159                         $this->assertTrue( true, $message );
2160                 } else {
2161                         $this->assertType( $type, $actual, $message );
2162                 }
2163         }
2164
2165         /**
2166          * Asserts the type of the provided value. This can be either
2167          * in internal type such as boolean or integer, or a class or
2168          * interface the value extends or implements.
2169          *
2170          * @since 1.20
2171          *
2172          * @param string $type
2173          * @param mixed $actual
2174          * @param string $message
2175          */
2176         protected function assertType( $type, $actual, $message = '' ) {
2177                 if ( class_exists( $type ) || interface_exists( $type ) ) {
2178                         $this->assertInstanceOf( $type, $actual, $message );
2179                 } else {
2180                         $this->assertInternalType( $type, $actual, $message );
2181                 }
2182         }
2183
2184         /**
2185          * Returns true if the given namespace defaults to Wikitext
2186          * according to $wgNamespaceContentModels
2187          *
2188          * @param int $ns The namespace ID to check
2189          *
2190          * @return bool
2191          * @since 1.21
2192          */
2193         protected function isWikitextNS( $ns ) {
2194                 global $wgNamespaceContentModels;
2195
2196                 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
2197                         return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT;
2198                 }
2199
2200                 return true;
2201         }
2202
2203         /**
2204          * Returns the ID of a namespace that defaults to Wikitext.
2205          *
2206          * @throws MWException If there is none.
2207          * @return int The ID of the wikitext Namespace
2208          * @since 1.21
2209          */
2210         protected function getDefaultWikitextNS() {
2211                 global $wgNamespaceContentModels;
2212
2213                 static $wikitextNS = null; // this is not going to change
2214                 if ( $wikitextNS !== null ) {
2215                         return $wikitextNS;
2216                 }
2217
2218                 // quickly short out on most common case:
2219                 if ( !isset( $wgNamespaceContentModels[NS_MAIN] ) ) {
2220                         return NS_MAIN;
2221                 }
2222
2223                 // NOTE: prefer content namespaces
2224                 $nsInfo = MediaWikiServices::getInstance()->getNamespaceInfo();
2225                 $namespaces = array_unique( array_merge(
2226                         $nsInfo->getContentNamespaces(),
2227                         [ NS_MAIN, NS_HELP, NS_PROJECT ], // prefer these
2228                         $nsInfo->getValidNamespaces()
2229                 ) );
2230
2231                 $namespaces = array_diff( $namespaces, [
2232                         NS_FILE, NS_CATEGORY, NS_MEDIAWIKI, NS_USER // don't mess with magic namespaces
2233                 ] );
2234
2235                 $talk = array_filter( $namespaces, function ( $ns ) use ( $nsInfo ) {
2236                         return $nsInfo->isTalk( $ns );
2237                 } );
2238
2239                 // prefer non-talk pages
2240                 $namespaces = array_diff( $namespaces, $talk );
2241                 $namespaces = array_merge( $namespaces, $talk );
2242
2243                 // check default content model of each namespace
2244                 foreach ( $namespaces as $ns ) {
2245                         if ( !isset( $wgNamespaceContentModels[$ns] ) ||
2246                                 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
2247                         ) {
2248                                 $wikitextNS = $ns;
2249
2250                                 return $wikitextNS;
2251                         }
2252                 }
2253
2254                 // give up
2255                 // @todo Inside a test, we could skip the test as incomplete.
2256                 //        But frequently, this is used in fixture setup.
2257                 throw new MWException( "No namespace defaults to wikitext!" );
2258         }
2259
2260         /**
2261          * Check, if $wgDiff3 is set and ready to merge
2262          * Will mark the calling test as skipped, if not ready
2263          *
2264          * @since 1.21
2265          */
2266         protected function markTestSkippedIfNoDiff3() {
2267                 global $wgDiff3;
2268
2269                 # This check may also protect against code injection in
2270                 # case of broken installations.
2271                 Wikimedia\suppressWarnings();
2272                 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2273                 Wikimedia\restoreWarnings();
2274
2275                 if ( !$haveDiff3 ) {
2276                         $this->markTestSkipped( "Skip test, since diff3 is not configured" );
2277                 }
2278         }
2279
2280         /**
2281          * Check if $extName is a loaded PHP extension, will skip the
2282          * test whenever it is not loaded.
2283          *
2284          * @since 1.21
2285          * @param string $extName
2286          * @return bool
2287          */
2288         protected function checkPHPExtension( $extName ) {
2289                 $loaded = extension_loaded( $extName );
2290                 if ( !$loaded ) {
2291                         $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
2292                 }
2293
2294                 return $loaded;
2295         }
2296
2297         /**
2298          * Skip the test if using the specified database type
2299          *
2300          * @param string $type Database type
2301          * @since 1.32
2302          */
2303         protected function markTestSkippedIfDbType( $type ) {
2304                 if ( $this->db->getType() === $type ) {
2305                         $this->markTestSkipped( "The $type database type isn't supported for this test" );
2306                 }
2307         }
2308
2309         /**
2310          * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
2311          * @param string $buffer
2312          * @return string
2313          */
2314         public static function wfResetOutputBuffersBarrier( $buffer ) {
2315                 return $buffer;
2316         }
2317
2318         /**
2319          * Create a temporary hook handler which will be reset by tearDown.
2320          * This replaces other handlers for the same hook.
2321          * @param string $hookName Hook name
2322          * @param mixed $handler Value suitable for a hook handler
2323          * @since 1.28
2324          */
2325         protected function setTemporaryHook( $hookName, $handler ) {
2326                 $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
2327         }
2328
2329         /**
2330          * Check whether file contains given data.
2331          * @param string $fileName
2332          * @param string $actualData
2333          * @param bool $createIfMissing If true, and file does not exist, create it with given data
2334          *                              and skip the test.
2335          * @param string $msg
2336          * @since 1.30
2337          */
2338         protected function assertFileContains(
2339                 $fileName,
2340                 $actualData,
2341                 $createIfMissing = false,
2342                 $msg = ''
2343         ) {
2344                 if ( $createIfMissing ) {
2345                         if ( !file_exists( $fileName ) ) {
2346                                 file_put_contents( $fileName, $actualData );
2347                                 $this->markTestSkipped( "Data file $fileName does not exist" );
2348                         }
2349                 } else {
2350                         self::assertFileExists( $fileName );
2351                 }
2352                 self::assertEquals( file_get_contents( $fileName ), $actualData, $msg );
2353         }
2354
2355         /**
2356          * Edits or creates a page/revision
2357          * @param string $pageName Page title
2358          * @param string $text Content of the page
2359          * @param string $summary Optional summary string for the revision
2360          * @param int $defaultNs Optional namespace id
2361          * @return Status Object as returned by WikiPage::doEditContent()
2362          * @throws MWException If this test cases's needsDB() method doesn't return true.
2363          *         Test cases can use "@group Database" to enable database test support,
2364          *         or list the tables under testing in $this->tablesUsed, or override the
2365          *         needsDB() method.
2366          */
2367         protected function editPage( $pageName, $text, $summary = '', $defaultNs = NS_MAIN ) {
2368                 if ( !$this->needsDB() ) {
2369                         throw new MWException( 'When testing which pages, the test cases\'s needsDB()' .
2370                                 ' method should return true. Use @group Database or $this->tablesUsed.' );
2371                 }
2372
2373                 $title = Title::newFromText( $pageName, $defaultNs );
2374                 $page = WikiPage::factory( $title );
2375
2376                 return $page->doEditContent( ContentHandler::makeContent( $text, $title ), $summary );
2377         }
2378
2379         /**
2380          * Revision-deletes a revision.
2381          *
2382          * @param Revision|int $rev Revision to delete
2383          * @param array $value Keys are Revision::DELETED_* flags.  Values are 1 to set the bit, 0 to
2384          *   clear, -1 to leave alone.  (All other values also clear the bit.)
2385          * @param string $comment Deletion comment
2386          */
2387         protected function revisionDelete(
2388                 $rev, array $value = [ Revision::DELETED_TEXT => 1 ], $comment = ''
2389         ) {
2390                 if ( is_int( $rev ) ) {
2391                         $rev = Revision::newFromId( $rev );
2392                 }
2393                 RevisionDeleter::createList(
2394                         'revision', RequestContext::getMain(), $rev->getTitle(), [ $rev->getId() ]
2395                 )->setVisibility( [
2396                         'value' => $value,
2397                         'comment' => $comment,
2398                 ] );
2399         }
2400
2401         /**
2402          * Returns a PHPUnit constraint that matches anything other than a fixed set of values. This can
2403          * be used to whitelist values, e.g.
2404          *   $mock->expects( $this->never() )->method( $this->anythingBut( 'foo', 'bar' ) );
2405          * which will throw if any unexpected method is called.
2406          *
2407          * @param mixed ...$values Values that are not matched
2408          */
2409         protected function anythingBut( ...$values ) {
2410                 return $this->logicalNot( $this->logicalOr(
2411                         ...array_map( [ $this, 'matches' ], $values )
2412                 ) );
2413         }
2414 }