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\MediaWikiServices;
   7 use Psr\Log\LoggerInterface;
   8 use Wikimedia\Rdbms\IMaintainableDatabase;
   9 use Wikimedia\Rdbms\Database;
  10 use Wikimedia\TestingAccessWrapper;
  11
  12 /**
  13  * @since 1.18
  14  */
  15 abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase {
  16
  17         use MediaWikiCoversValidator;
  18
  19         /**
  20          * The service locator created by prepareServices(). This service locator will
  21          * be restored after each test. Tests that pollute the global service locator
  22          * instance should use overrideMwServices() to isolate the test.
  23          *
  24          * @var MediaWikiServices|null
  25          */
  26         private static $serviceLocator = null;
  27
  28         /**
  29          * $called tracks whether the setUp and tearDown method has been called.
  30          * class extending MediaWikiTestCase usually override setUp and tearDown
  31          * but forget to call the parent.
  32          *
  33          * The array format takes a method name as key and anything as a value.
  34          * By asserting the key exist, we know the child class has called the
  35          * parent.
  36          *
  37          * This property must be private, we do not want child to override it,
  38          * they should call the appropriate parent method instead.
  39          */
  40         private $called = [];
  41
  42         /**
  43          * @var TestUser[]
  44          * @since 1.20
  45          */
  46         public static $users;
  47
  48         /**
  49          * Primary database
  50          *
  51          * @var Database
  52          * @since 1.18
  53          */
  54         protected $db;
  55
  56         /**
  57          * @var array
  58          * @since 1.19
  59          */
  60         protected $tablesUsed = []; // tables with data
  61
  62         private static $useTemporaryTables = true;
  63         private static $reuseDB = false;
  64         private static $dbSetup = false;
  65         private static $oldTablePrefix = '';
  66
  67         /**
  68          * Original value of PHP's error_reporting setting.
  69          *
  70          * @var int
  71          */
  72         private $phpErrorLevel;
  73
  74         /**
  75          * Holds the paths of temporary files/directories created through getNewTempFile,
  76          * and getNewTempDirectory
  77          *
  78          * @var array
  79          */
  80         private $tmpFiles = [];
  81
  82         /**
  83          * Holds original values of MediaWiki configuration settings
  84          * to be restored in tearDown().
  85          * See also setMwGlobals().
  86          * @var array
  87          */
  88         private $mwGlobals = [];
  89
  90         /**
  91          * Holds list of MediaWiki configuration settings to be unset in tearDown().
  92          * See also setMwGlobals().
  93          * @var array
  94          */
  95         private $mwGlobalsToUnset = [];
  96
  97         /**
  98          * Holds original loggers which have been replaced by setLogger()
  99          * @var LoggerInterface[]
 100          */
 101         private $loggers = [];
 102
 103         /**
 104          * Table name prefixes. Oracle likes it shorter.
 105          */
 106         const DB_PREFIX = 'unittest_';
 107         const ORA_DB_PREFIX = 'ut_';
 108
 109         /**
 110          * @var array
 111          * @since 1.18
 112          */
 113         protected $supportedDBs = [
 114                 'mysql',
 115                 'sqlite',
 116                 'postgres',
 117                 'oracle'
 118         ];
 119
 120         public function __construct( $name = null, array $data = [], $dataName = '' ) {
 121                 parent::__construct( $name, $data, $dataName );
 122
 123                 $this->backupGlobals = false;
 124                 $this->backupStaticAttributes = false;
 125         }
 126
 127         public function __destruct() {
 128                 // Complain if self::setUp() was called, but not self::tearDown()
 129                 // $this->called['setUp'] will be checked by self::testMediaWikiTestCaseParentSetupCalled()
 130                 if ( isset( $this->called['setUp'] ) && !isset( $this->called['tearDown'] ) ) {
 131                         throw new MWException( static::class . "::tearDown() must call parent::tearDown()" );
 132                 }
 133         }
 134
 135         public static function setUpBeforeClass() {
 136                 parent::setUpBeforeClass();
 137
 138                 // Get the service locator, and reset services if it's not done already
 139                 self::$serviceLocator = self::prepareServices( new GlobalVarConfig() );
 140         }
 141
 142         /**
 143          * Convenience method for getting an immutable test user
 144          *
 145          * @since 1.28
 146          *
 147          * @param string[] $groups Groups the test user should be in.
 148          * @return TestUser
 149          */
 150         public static function getTestUser( $groups = [] ) {
 151                 return TestUserRegistry::getImmutableTestUser( $groups );
 152         }
 153
 154         /**
 155          * Convenience method for getting a mutable test user
 156          *
 157          * @since 1.28
 158          *
 159          * @param string[] $groups Groups the test user should be added in.
 160          * @return TestUser
 161          */
 162         public static function getMutableTestUser( $groups = [] ) {
 163                 return TestUserRegistry::getMutableTestUser( __CLASS__, $groups );
 164         }
 165
 166         /**
 167          * Convenience method for getting an immutable admin test user
 168          *
 169          * @since 1.28
 170          *
 171          * @param string[] $groups Groups the test user should be added to.
 172          * @return TestUser
 173          */
 174         public static function getTestSysop() {
 175                 return self::getTestUser( [ 'sysop', 'bureaucrat' ] );
 176         }
 177
 178         /**
 179          * Prepare service configuration for unit testing.
 180          *
 181          * This calls MediaWikiServices::resetGlobalInstance() to allow some critical services
 182          * to be overridden for testing.
 183          *
 184          * prepareServices() only needs to be called once, but should be called as early as possible,
 185          * before any class has a chance to grab a reference to any of the global services
 186          * instances that get discarded by prepareServices(). Only the first call has any effect,
 187          * later calls are ignored.
 188          *
 189          * @note This is called by PHPUnitMaintClass::finalSetup.
 190          *
 191          * @see MediaWikiServices::resetGlobalInstance()
 192          *
 193          * @param Config $bootstrapConfig The bootstrap config to use with the new
 194          *        MediaWikiServices. Only used for the first call to this method.
 195          * @return MediaWikiServices
 196          */
 197         public static function prepareServices( Config $bootstrapConfig ) {
 198                 static $services = null;
 199
 200                 if ( !$services ) {
 201                         $services = self::resetGlobalServices( $bootstrapConfig );
 202                 }
 203                 return $services;
 204         }
 205
 206         /**
 207          * Reset global services, and install testing environment.
 208          * This is the testing equivalent of MediaWikiServices::resetGlobalInstance().
 209          * This should only be used to set up the testing environment, not when
 210          * running unit tests. Use MediaWikiTestCase::overrideMwServices() for that.
 211          *
 212          * @see MediaWikiServices::resetGlobalInstance()
 213          * @see prepareServices()
 214          * @see MediaWikiTestCase::overrideMwServices()
 215          *
 216          * @param Config|null $bootstrapConfig The bootstrap config to use with the new
 217          *        MediaWikiServices.
 218          * @return MediaWikiServices
 219          */
 220         protected static function resetGlobalServices( Config $bootstrapConfig = null ) {
 221                 $oldServices = MediaWikiServices::getInstance();
 222                 $oldConfigFactory = $oldServices->getConfigFactory();
 223                 $oldLoadBalancerFactory = $oldServices->getDBLoadBalancerFactory();
 224
 225                 $testConfig = self::makeTestConfig( $bootstrapConfig );
 226
 227                 MediaWikiServices::resetGlobalInstance( $testConfig );
 228
 229                 $serviceLocator = MediaWikiServices::getInstance();
 230                 self::installTestServices(
 231                         $oldConfigFactory,
 232                         $oldLoadBalancerFactory,
 233                         $serviceLocator
 234                 );
 235                 return $serviceLocator;
 236         }
 237
 238         /**
 239          * Create a config suitable for testing, based on a base config, default overrides,
 240          * and custom overrides.
 241          *
 242          * @param Config|null $baseConfig
 243          * @param Config|null $customOverrides
 244          *
 245          * @return Config
 246          */
 247         private static function makeTestConfig(
 248                 Config $baseConfig = null,
 249                 Config $customOverrides = null
 250         ) {
 251                 $defaultOverrides = new HashConfig();
 252
 253                 if ( !$baseConfig ) {
 254                         $baseConfig = MediaWikiServices::getInstance()->getBootstrapConfig();
 255                 }
 256
 257                 /* Some functions require some kind of caching, and will end up using the db,
 258                  * which we can't allow, as that would open a new connection for mysql.
 259                  * Replace with a HashBag. They would not be going to persist anyway.
 260                  */
 261                 $hashCache = [ 'class' => 'HashBagOStuff', 'reportDupes' => false ];
 262                 $objectCaches = [
 263                                 CACHE_DB => $hashCache,
 264                                 CACHE_ACCEL => $hashCache,
 265                                 CACHE_MEMCACHED => $hashCache,
 266                                 'apc' => $hashCache,
 267                                 'apcu' => $hashCache,
 268                                 'xcache' => $hashCache,
 269                                 'wincache' => $hashCache,
 270                         ] + $baseConfig->get( 'ObjectCaches' );
 271
 272                 $defaultOverrides->set( 'ObjectCaches', $objectCaches );
 273                 $defaultOverrides->set( 'MainCacheType', CACHE_NONE );
 274                 $defaultOverrides->set( 'JobTypeConf', [ 'default' => [ 'class' => 'JobQueueMemory' ] ] );
 275
 276                 // Use a fast hash algorithm to hash passwords.
 277                 $defaultOverrides->set( 'PasswordDefault', 'A' );
 278
 279                 $testConfig = $customOverrides
 280                         ? new MultiConfig( [ $customOverrides, $defaultOverrides, $baseConfig ] )
 281                         : new MultiConfig( [ $defaultOverrides, $baseConfig ] );
 282
 283                 return $testConfig;
 284         }
 285
 286         /**
 287          * @param ConfigFactory $oldConfigFactory
 288          * @param LBFactory $oldLoadBalancerFactory
 289          * @param MediaWikiServices $newServices
 290          *
 291          * @throws MWException
 292          */
 293         private static function installTestServices(
 294                 ConfigFactory $oldConfigFactory,
 295                 LBFactory $oldLoadBalancerFactory,
 296                 MediaWikiServices $newServices
 297         ) {
 298                 // Use bootstrap config for all configuration.
 299                 // This allows config overrides via global variables to take effect.
 300                 $bootstrapConfig = $newServices->getBootstrapConfig();
 301                 $newServices->resetServiceForTesting( 'ConfigFactory' );
 302                 $newServices->redefineService(
 303                         'ConfigFactory',
 304                         self::makeTestConfigFactoryInstantiator(
 305                                 $oldConfigFactory,
 306                                 [ 'main' => $bootstrapConfig ]
 307                         )
 308                 );
 309                 $newServices->resetServiceForTesting( 'DBLoadBalancerFactory' );
 310                 $newServices->redefineService(
 311                         'DBLoadBalancerFactory',
 312                         function ( MediaWikiServices $services ) use ( $oldLoadBalancerFactory ) {
 313                                 return $oldLoadBalancerFactory;
 314                         }
 315                 );
 316         }
 317
 318         /**
 319          * @param ConfigFactory $oldFactory
 320          * @param Config[] $configurations
 321          *
 322          * @return Closure
 323          */
 324         private static function makeTestConfigFactoryInstantiator(
 325                 ConfigFactory $oldFactory,
 326                 array $configurations
 327         ) {
 328                 return function ( MediaWikiServices $services ) use ( $oldFactory, $configurations ) {
 329                         $factory = new ConfigFactory();
 330
 331                         // clone configurations from $oldFactory that are not overwritten by $configurations
 332                         $namesToClone = array_diff(
 333                                 $oldFactory->getConfigNames(),
 334                                 array_keys( $configurations )
 335                         );
 336
 337                         foreach ( $namesToClone as $name ) {
 338                                 $factory->register( $name, $oldFactory->makeConfig( $name ) );
 339                         }
 340
 341                         foreach ( $configurations as $name => $config ) {
 342                                 $factory->register( $name, $config );
 343                         }
 344
 345                         return $factory;
 346                 };
 347         }
 348
 349         /**
 350          * Resets some well known services that typically have state that may interfere with unit tests.
 351          * This is a lightweight alternative to resetGlobalServices().
 352          *
 353          * @note There is no guarantee that no references remain to stale service instances destroyed
 354          * by a call to doLightweightServiceReset().
 355          *
 356          * @throws MWException if called outside of PHPUnit tests.
 357          *
 358          * @see resetGlobalServices()
 359          */
 360         private function doLightweightServiceReset() {
 361                 global $wgRequest;
 362
 363                 JobQueueGroup::destroySingletons();
 364                 ObjectCache::clear();
 365                 $services = MediaWikiServices::getInstance();
 366                 $services->resetServiceForTesting( 'MainObjectStash' );
 367                 $services->resetServiceForTesting( 'LocalServerObjectCache' );
 368                 $services->getMainWANObjectCache()->clearProcessCache();
 369                 FileBackendGroup::destroySingleton();
 370
 371                 // TODO: move global state into MediaWikiServices
 372                 RequestContext::resetMain();
 373                 if ( session_id() !== '' ) {
 374                         session_write_close();
 375                         session_id( '' );
 376                 }
 377
 378                 $wgRequest = new FauxRequest();
 379                 MediaWiki\Session\SessionManager::resetCache();
 380         }
 381
 382         public function run( PHPUnit_Framework_TestResult $result = null ) {
 383                 // Reset all caches between tests.
 384                 $this->doLightweightServiceReset();
 385
 386                 $needsResetDB = false;
 387
 388                 if ( !self::$dbSetup || $this->needsDB() ) {
 389                         // set up a DB connection for this test to use
 390
 391                         self::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
 392                         self::$reuseDB = $this->getCliArg( 'reuse-db' );
 393
 394                         $this->db = wfGetDB( DB_MASTER );
 395
 396                         $this->checkDbIsSupported();
 397
 398                         if ( !self::$dbSetup ) {
 399                                 $this->setupAllTestDBs();
 400                                 $this->addCoreDBData();
 401
 402                                 if ( ( $this->db->getType() == 'oracle' || !self::$useTemporaryTables ) && self::$reuseDB ) {
 403                                         $this->resetDB( $this->db, $this->tablesUsed );
 404                                 }
 405                         }
 406
 407                         // TODO: the DB setup should be done in setUpBeforeClass(), so the test DB
 408                         // is available in subclass's setUpBeforeClass() and setUp() methods.
 409                         // This would also remove the need for the HACK that is oncePerClass().
 410                         if ( $this->oncePerClass() ) {
 411                                 $this->addDBDataOnce();
 412                         }
 413
 414                         $this->addDBData();
 415                         $needsResetDB = true;
 416                 }
 417
 418                 parent::run( $result );
 419
 420                 if ( $needsResetDB ) {
 421                         $this->resetDB( $this->db, $this->tablesUsed );
 422                 }
 423         }
 424
 425         /**
 426          * @return bool
 427          */
 428         private function oncePerClass() {
 429                 // Remember current test class in the database connection,
 430                 // so we know when we need to run addData.
 431
 432                 $class = static::class;
 433
 434                 $first = !isset( $this->db->_hasDataForTestClass )
 435                         || $this->db->_hasDataForTestClass !== $class;
 436
 437                 $this->db->_hasDataForTestClass = $class;
 438                 return $first;
 439         }
 440
 441         /**
 442          * @since 1.21
 443          *
 444          * @return bool
 445          */
 446         public function usesTemporaryTables() {
 447                 return self::$useTemporaryTables;
 448         }
 449
 450         /**
 451          * Obtains a new temporary file name
 452          *
 453          * The obtained filename is enlisted to be removed upon tearDown
 454          *
 455          * @since 1.20
 456          *
 457          * @return string Absolute name of the temporary file
 458          */
 459         protected function getNewTempFile() {
 460                 $fileName = tempnam( wfTempDir(), 'MW_PHPUnit_' . static::class . '_' );
 461                 $this->tmpFiles[] = $fileName;
 462
 463                 return $fileName;
 464         }
 465
 466         /**
 467          * obtains a new temporary directory
 468          *
 469          * The obtained directory is enlisted to be removed (recursively with all its contained
 470          * files) upon tearDown.
 471          *
 472          * @since 1.20
 473          *
 474          * @return string Absolute name of the temporary directory
 475          */
 476         protected function getNewTempDirectory() {
 477                 // Starting of with a temporary /file/.
 478                 $fileName = $this->getNewTempFile();
 479
 480                 // Converting the temporary /file/ to a /directory/
 481                 // The following is not atomic, but at least we now have a single place,
 482                 // where temporary directory creation is bundled and can be improved
 483                 unlink( $fileName );
 484                 $this->assertTrue( wfMkdirParents( $fileName ) );
 485
 486                 return $fileName;
 487         }
 488
 489         protected function setUp() {
 490                 parent::setUp();
 491                 $this->called['setUp'] = true;
 492
 493                 $this->phpErrorLevel = intval( ini_get( 'error_reporting' ) );
 494
 495                 // Cleaning up temporary files
 496                 foreach ( $this->tmpFiles as $fileName ) {
 497                         if ( is_file( $fileName ) || ( is_link( $fileName ) ) ) {
 498                                 unlink( $fileName );
 499                         } elseif ( is_dir( $fileName ) ) {
 500                                 wfRecursiveRemoveDir( $fileName );
 501                         }
 502                 }
 503
 504                 if ( $this->needsDB() && $this->db ) {
 505                         // Clean up open transactions
 506                         while ( $this->db->trxLevel() > 0 ) {
 507                                 $this->db->rollback( __METHOD__, 'flush' );
 508                         }
 509                         // Check for unsafe queries
 510                         if ( $this->db->getType() === 'mysql' ) {
 511                                 $this->db->query( "SET sql_mode = 'STRICT_ALL_TABLES'" );
 512                         }
 513                 }
 514
 515                 DeferredUpdates::clearPendingUpdates();
 516                 ObjectCache::getMainWANInstance()->clearProcessCache();
 517
 518                 // XXX: reset maintenance triggers
 519                 // Hook into period lag checks which often happen in long-running scripts
 520                 $services = MediaWikiServices::getInstance();
 521                 $lbFactory = $services->getDBLoadBalancerFactory();
 522                 Maintenance::setLBFactoryTriggers( $lbFactory, $services->getMainConfig() );
 523
 524                 ob_start( 'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
 525         }
 526
 527         protected function addTmpFiles( $files ) {
 528                 $this->tmpFiles = array_merge( $this->tmpFiles, (array)$files );
 529         }
 530
 531         protected function tearDown() {
 532                 global $wgRequest, $wgSQLMode;
 533
 534                 $status = ob_get_status();
 535                 if ( isset( $status['name'] ) &&
 536                         $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier'
 537                 ) {
 538                         ob_end_flush();
 539                 }
 540
 541                 $this->called['tearDown'] = true;
 542                 // Cleaning up temporary files
 543                 foreach ( $this->tmpFiles as $fileName ) {
 544                         if ( is_file( $fileName ) || ( is_link( $fileName ) ) ) {
 545                                 unlink( $fileName );
 546                         } elseif ( is_dir( $fileName ) ) {
 547                                 wfRecursiveRemoveDir( $fileName );
 548                         }
 549                 }
 550
 551                 if ( $this->needsDB() && $this->db ) {
 552                         // Clean up open transactions
 553                         while ( $this->db->trxLevel() > 0 ) {
 554                                 $this->db->rollback( __METHOD__, 'flush' );
 555                         }
 556                         if ( $this->db->getType() === 'mysql' ) {
 557                                 $this->db->query( "SET sql_mode = " . $this->db->addQuotes( $wgSQLMode ) );
 558                         }
 559                 }
 560
 561                 // Restore mw globals
 562                 foreach ( $this->mwGlobals as $key => $value ) {
 563                         $GLOBALS[$key] = $value;
 564                 }
 565                 foreach ( $this->mwGlobalsToUnset as $value ) {
 566                         unset( $GLOBALS[$value] );
 567                 }
 568                 $this->mwGlobals = [];
 569                 $this->mwGlobalsToUnset = [];
 570                 $this->restoreLoggers();
 571
 572                 if ( self::$serviceLocator && MediaWikiServices::getInstance() !== self::$serviceLocator ) {
 573                         MediaWikiServices::forceGlobalInstance( self::$serviceLocator );
 574                 }
 575
 576                 // TODO: move global state into MediaWikiServices
 577                 RequestContext::resetMain();
 578                 if ( session_id() !== '' ) {
 579                         session_write_close();
 580                         session_id( '' );
 581                 }
 582                 $wgRequest = new FauxRequest();
 583                 MediaWiki\Session\SessionManager::resetCache();
 584                 MediaWiki\Auth\AuthManager::resetCache();
 585
 586                 $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
 587
 588                 if ( $phpErrorLevel !== $this->phpErrorLevel ) {
 589                         ini_set( 'error_reporting', $this->phpErrorLevel );
 590
 591                         $oldHex = strtoupper( dechex( $this->phpErrorLevel ) );
 592                         $newHex = strtoupper( dechex( $phpErrorLevel ) );
 593                         $message = "PHP error_reporting setting was left dirty: "
 594                                 . "was 0x$oldHex before test, 0x$newHex after test!";
 595
 596                         $this->fail( $message );
 597                 }
 598
 599                 parent::tearDown();
 600         }
 601
 602         /**
 603          * Make sure MediaWikiTestCase extending classes have called their
 604          * parent setUp method
 605          *
 606          * With strict coverage activated in PHP_CodeCoverage, this test would be
 607          * marked as risky without the following annotation (T152923).
 608          * @coversNothing
 609          */
 610         final public function testMediaWikiTestCaseParentSetupCalled() {
 611                 $this->assertArrayHasKey( 'setUp', $this->called,
 612                         static::class . '::setUp() must call parent::setUp()'
 613                 );
 614         }
 615
 616         /**
 617          * Sets a service, maintaining a stashed version of the previous service to be
 618          * restored in tearDown
 619          *
 620          * @since 1.27
 621          *
 622          * @param string $name
 623          * @param object $object
 624          */
 625         protected function setService( $name, $object ) {
 626                 // If we did not yet override the service locator, so so now.
 627                 if ( MediaWikiServices::getInstance() === self::$serviceLocator ) {
 628                         $this->overrideMwServices();
 629                 }
 630
 631                 MediaWikiServices::getInstance()->disableService( $name );
 632                 MediaWikiServices::getInstance()->redefineService(
 633                         $name,
 634                         function () use ( $object ) {
 635                                 return $object;
 636                         }
 637                 );
 638         }
 639
 640         /**
 641          * Sets a global, maintaining a stashed version of the previous global to be
 642          * restored in tearDown
 643          *
 644          * The key is added to the array of globals that will be reset afterwards
 645          * in the tearDown().
 646          *
 647          * @par Example
 648          * @code
 649          *     protected function setUp() {
 650          *         $this->setMwGlobals( 'wgRestrictStuff', true );
 651          *     }
 652          *
 653          *     function testFoo() {}
 654          *
 655          *     function testBar() {}
 656          *         $this->assertTrue( self::getX()->doStuff() );
 657          *
 658          *         $this->setMwGlobals( 'wgRestrictStuff', false );
 659          *         $this->assertTrue( self::getX()->doStuff() );
 660          *     }
 661          *
 662          *     function testQuux() {}
 663          * @endcode
 664          *
 665          * @param array|string $pairs Key to the global variable, or an array
 666          *  of key/value pairs.
 667          * @param mixed $value Value to set the global to (ignored
 668          *  if an array is given as first argument).
 669          *
 670          * @note To allow changes to global variables to take effect on global service instances,
 671          *       call overrideMwServices().
 672          *
 673          * @since 1.21
 674          */
 675         protected function setMwGlobals( $pairs, $value = null ) {
 676                 if ( is_string( $pairs ) ) {
 677                         $pairs = [ $pairs => $value ];
 678                 }
 679
 680                 $this->stashMwGlobals( array_keys( $pairs ) );
 681
 682                 foreach ( $pairs as $key => $value ) {
 683                         $GLOBALS[$key] = $value;
 684                 }
 685         }
 686
 687         /**
 688          * Check if we can back up a value by performing a shallow copy.
 689          * Values which fail this test are copied recursively.
 690          *
 691          * @param mixed $value
 692          * @return bool True if a shallow copy will do; false if a deep copy
 693          *  is required.
 694          */
 695         private static function canShallowCopy( $value ) {
 696                 if ( is_scalar( $value ) || $value === null ) {
 697                         return true;
 698                 }
 699                 if ( is_array( $value ) ) {
 700                         foreach ( $value as $subValue ) {
 701                                 if ( !is_scalar( $subValue ) && $subValue !== null ) {
 702                                         return false;
 703                                 }
 704                         }
 705                         return true;
 706                 }
 707                 return false;
 708         }
 709
 710         /**
 711          * Stashes the global, will be restored in tearDown()
 712          *
 713          * Individual test functions may override globals through the setMwGlobals() function
 714          * or directly. When directly overriding globals their keys should first be passed to this
 715          * method in setUp to avoid breaking global state for other tests
 716          *
 717          * That way all other tests are executed with the same settings (instead of using the
 718          * unreliable local settings for most tests and fix it only for some tests).
 719          *
 720          * @param array|string $globalKeys Key to the global variable, or an array of keys.
 721          *
 722          * @note To allow changes to global variables to take effect on global service instances,
 723          *       call overrideMwServices().
 724          *
 725          * @since 1.23
 726          */
 727         protected function stashMwGlobals( $globalKeys ) {
 728                 if ( is_string( $globalKeys ) ) {
 729                         $globalKeys = [ $globalKeys ];
 730                 }
 731
 732                 foreach ( $globalKeys as $globalKey ) {
 733                         // NOTE: make sure we only save the global once or a second call to
 734                         // setMwGlobals() on the same global would override the original
 735                         // value.
 736                         if (
 737                                 !array_key_exists( $globalKey, $this->mwGlobals ) &&
 738                                 !array_key_exists( $globalKey, $this->mwGlobalsToUnset )
 739                         ) {
 740                                 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
 741                                         $this->mwGlobalsToUnset[$globalKey] = $globalKey;
 742                                         continue;
 743                                 }
 744                                 // NOTE: we serialize then unserialize the value in case it is an object
 745                                 // this stops any objects being passed by reference. We could use clone
 746                                 // and if is_object but this does account for objects within objects!
 747                                 if ( self::canShallowCopy( $GLOBALS[$globalKey] ) ) {
 748                                         $this->mwGlobals[$globalKey] = $GLOBALS[$globalKey];
 749                                 } elseif (
 750                                         // Many MediaWiki types are safe to clone. These are the
 751                                         // ones that are most commonly stashed.
 752                                         $GLOBALS[$globalKey] instanceof Language ||
 753                                         $GLOBALS[$globalKey] instanceof User ||
 754                                         $GLOBALS[$globalKey] instanceof FauxRequest
 755                                 ) {
 756                                         $this->mwGlobals[$globalKey] = clone $GLOBALS[$globalKey];
 757                                 } elseif ( $this->containsClosure( $GLOBALS[$globalKey] ) ) {
 758                                         // Serializing Closure only gives a warning on HHVM while
 759                                         // it throws an Exception on Zend.
 760                                         // Workaround for https://github.com/facebook/hhvm/issues/6206
 761                                         $this->mwGlobals[$globalKey] = $GLOBALS[$globalKey];
 762                                 } else {
 763                                         try {
 764                                                 $this->mwGlobals[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
 765                                         } catch ( Exception $e ) {
 766                                                 $this->mwGlobals[$globalKey] = $GLOBALS[$globalKey];
 767                                         }
 768                                 }
 769                         }
 770                 }
 771         }
 772
 773         /**
 774          * @param mixed $var
 775          * @param int $maxDepth
 776          *
 777          * @return bool
 778          */
 779         private function containsClosure( $var, $maxDepth = 15 ) {
 780                 if ( $var instanceof Closure ) {
 781                         return true;
 782                 }
 783                 if ( !is_array( $var ) || $maxDepth === 0 ) {
 784                         return false;
 785                 }
 786
 787                 foreach ( $var as $value ) {
 788                         if ( $this->containsClosure( $value, $maxDepth - 1 ) ) {
 789                                 return true;
 790                         }
 791                 }
 792                 return false;
 793         }
 794
 795         /**
 796          * Merges the given values into a MW global array variable.
 797          * Useful for setting some entries in a configuration array, instead of
 798          * setting the entire array.
 799          *
 800          * @param string $name The name of the global, as in wgFooBar
 801          * @param array $values The array containing the entries to set in that global
 802          *
 803          * @throws MWException If the designated global is not an array.
 804          *
 805          * @note To allow changes to global variables to take effect on global service instances,
 806          *       call overrideMwServices().
 807          *
 808          * @since 1.21
 809          */
 810         protected function mergeMwGlobalArrayValue( $name, $values ) {
 811                 if ( !isset( $GLOBALS[$name] ) ) {
 812                         $merged = $values;
 813                 } else {
 814                         if ( !is_array( $GLOBALS[$name] ) ) {
 815                                 throw new MWException( "MW global $name is not an array." );
 816                         }
 817
 818                         // NOTE: do not use array_merge, it screws up for numeric keys.
 819                         $merged = $GLOBALS[$name];
 820                         foreach ( $values as $k => $v ) {
 821                                 $merged[$k] = $v;
 822                         }
 823                 }
 824
 825                 $this->setMwGlobals( $name, $merged );
 826         }
 827
 828         /**
 829          * Stashes the global instance of MediaWikiServices, and installs a new one,
 830          * allowing test cases to override settings and services.
 831          * The previous instance of MediaWikiServices will be restored on tearDown.
 832          *
 833          * @since 1.27
 834          *
 835          * @param Config $configOverrides Configuration overrides for the new MediaWikiServices instance.
 836          * @param callable[] $services An associative array of services to re-define. Keys are service
 837          *        names, values are callables.
 838          *
 839          * @return MediaWikiServices
 840          * @throws MWException
 841          */
 842         protected function overrideMwServices( Config $configOverrides = null, array $services = [] ) {
 843                 if ( !$configOverrides ) {
 844                         $configOverrides = new HashConfig();
 845                 }
 846
 847                 $oldInstance = MediaWikiServices::getInstance();
 848                 $oldConfigFactory = $oldInstance->getConfigFactory();
 849                 $oldLoadBalancerFactory = $oldInstance->getDBLoadBalancerFactory();
 850
 851                 $testConfig = self::makeTestConfig( null, $configOverrides );
 852                 $newInstance = new MediaWikiServices( $testConfig );
 853
 854                 // Load the default wiring from the specified files.
 855                 // NOTE: this logic mirrors the logic in MediaWikiServices::newInstance.
 856                 $wiringFiles = $testConfig->get( 'ServiceWiringFiles' );
 857                 $newInstance->loadWiringFiles( $wiringFiles );
 858
 859                 // Provide a traditional hook point to allow extensions to configure services.
 860                 Hooks::run( 'MediaWikiServices', [ $newInstance ] );
 861
 862                 foreach ( $services as $name => $callback ) {
 863                         $newInstance->redefineService( $name, $callback );
 864                 }
 865
 866                 self::installTestServices(
 867                         $oldConfigFactory,
 868                         $oldLoadBalancerFactory,
 869                         $newInstance
 870                 );
 871                 MediaWikiServices::forceGlobalInstance( $newInstance );
 872
 873                 return $newInstance;
 874         }
 875
 876         /**
 877          * @since 1.27
 878          * @param string|Language $lang
 879          */
 880         public function setUserLang( $lang ) {
 881                 RequestContext::getMain()->setLanguage( $lang );
 882                 $this->setMwGlobals( 'wgLang', RequestContext::getMain()->getLanguage() );
 883         }
 884
 885         /**
 886          * @since 1.27
 887          * @param string|Language $lang
 888          */
 889         public function setContentLang( $lang ) {
 890                 if ( $lang instanceof Language ) {
 891                         $langCode = $lang->getCode();
 892                         $langObj = $lang;
 893                 } else {
 894                         $langCode = $lang;
 895                         $langObj = Language::factory( $langCode );
 896                 }
 897                 $this->setMwGlobals( [
 898                         'wgLanguageCode' => $langCode,
 899                         'wgContLang' => $langObj,
 900                 ] );
 901         }
 902
 903         /**
 904          * Sets the logger for a specified channel, for the duration of the test.
 905          * @since 1.27
 906          * @param string $channel
 907          * @param LoggerInterface $logger
 908          */
 909         protected function setLogger( $channel, LoggerInterface $logger ) {
 910                 // TODO: Once loggers are managed by MediaWikiServices, use
 911                 //       overrideMwServices() to set loggers.
 912
 913                 $provider = LoggerFactory::getProvider();
 914                 $wrappedProvider = TestingAccessWrapper::newFromObject( $provider );
 915                 $singletons = $wrappedProvider->singletons;
 916                 if ( $provider instanceof MonologSpi ) {
 917                         if ( !isset( $this->loggers[$channel] ) ) {
 918                                 $this->loggers[$channel] = isset( $singletons['loggers'][$channel] )
 919                                         ? $singletons['loggers'][$channel] : null;
 920                         }
 921                         $singletons['loggers'][$channel] = $logger;
 922                 } elseif ( $provider instanceof LegacySpi ) {
 923                         if ( !isset( $this->loggers[$channel] ) ) {
 924                                 $this->loggers[$channel] = isset( $singletons[$channel] ) ? $singletons[$channel] : null;
 925                         }
 926                         $singletons[$channel] = $logger;
 927                 } else {
 928                         throw new LogicException( __METHOD__ . ': setting a logger for ' . get_class( $provider )
 929                                 . ' is not implemented' );
 930                 }
 931                 $wrappedProvider->singletons = $singletons;
 932         }
 933
 934         /**
 935          * Restores loggers replaced by setLogger().
 936          * @since 1.27
 937          */
 938         private function restoreLoggers() {
 939                 $provider = LoggerFactory::getProvider();
 940                 $wrappedProvider = TestingAccessWrapper::newFromObject( $provider );
 941                 $singletons = $wrappedProvider->singletons;
 942                 foreach ( $this->loggers as $channel => $logger ) {
 943                         if ( $provider instanceof MonologSpi ) {
 944                                 if ( $logger === null ) {
 945                                         unset( $singletons['loggers'][$channel] );
 946                                 } else {
 947                                         $singletons['loggers'][$channel] = $logger;
 948                                 }
 949                         } elseif ( $provider instanceof LegacySpi ) {
 950                                 if ( $logger === null ) {
 951                                         unset( $singletons[$channel] );
 952                                 } else {
 953                                         $singletons[$channel] = $logger;
 954                                 }
 955                         }
 956                 }
 957                 $wrappedProvider->singletons = $singletons;
 958                 $this->loggers = [];
 959         }
 960
 961         /**
 962          * @return string
 963          * @since 1.18
 964          */
 965         public function dbPrefix() {
 966                 return $this->db->getType() == 'oracle' ? self::ORA_DB_PREFIX : self::DB_PREFIX;
 967         }
 968
 969         /**
 970          * @return bool
 971          * @since 1.18
 972          */
 973         public function needsDB() {
 974                 // If the test says it uses database tables, it needs the database
 975                 if ( $this->tablesUsed ) {
 976                         return true;
 977                 }
 978
 979                 // If the test class says it belongs to the Database group, it needs the database.
 980                 // NOTE: This ONLY checks for the group in the class level doc comment.
 981                 $rc = new ReflectionClass( $this );
 982                 if ( preg_match( '/@group +Database/im', $rc->getDocComment() ) ) {
 983                         return true;
 984                 }
 985
 986                 return false;
 987         }
 988
 989         /**
 990          * Insert a new page.
 991          *
 992          * Should be called from addDBData().
 993          *
 994          * @since 1.25 ($namespace in 1.28)
 995          * @param string|title $pageName Page name or title
 996          * @param string $text Page's content
 997          * @param int $namespace Namespace id (name cannot already contain namespace)
 998          * @return array Title object and page id
 999          */
1000         protected function insertPage(
1001                 $pageName,
1002                 $text = 'Sample page for unit test.',
1003                 $namespace = null
1004         ) {
1005                 if ( is_string( $pageName ) ) {
1006                         $title = Title::newFromText( $pageName, $namespace );
1007                 } else {
1008                         $title = $pageName;
1009                 }
1010
1011                 $user = static::getTestSysop()->getUser();
1012                 $comment = __METHOD__ . ': Sample page for unit test.';
1013
1014                 $page = WikiPage::factory( $title );
1015                 $page->doEditContent( ContentHandler::makeContent( $text, $title ), $comment, 0, false, $user );
1016
1017                 return [
1018                         'title' => $title,
1019                         'id' => $page->getId(),
1020                 ];
1021         }
1022
1023         /**
1024          * Stub. If a test suite needs to add additional data to the database, it should
1025          * implement this method and do so. This method is called once per test suite
1026          * (i.e. once per class).
1027          *
1028          * Note data added by this method may be removed by resetDB() depending on
1029          * the contents of $tablesUsed.
1030          *
1031          * To add additional data between test function runs, override prepareDB().
1032          *
1033          * @see addDBData()
1034          * @see resetDB()
1035          *
1036          * @since 1.27
1037          */
1038         public function addDBDataOnce() {
1039         }
1040
1041         /**
1042          * Stub. Subclasses may override this to prepare the database.
1043          * Called before every test run (test function or data set).
1044          *
1045          * @see addDBDataOnce()
1046          * @see resetDB()
1047          *
1048          * @since 1.18
1049          */
1050         public function addDBData() {
1051         }
1052
1053         private function addCoreDBData() {
1054                 if ( $this->db->getType() == 'oracle' ) {
1055                         # Insert 0 user to prevent FK violations
1056                         # Anonymous user
1057                         if ( !$this->db->selectField( 'user', '1', [ 'user_id' => 0 ] ) ) {
1058                                 $this->db->insert( 'user', [
1059                                         'user_id' => 0,
1060                                         'user_name' => 'Anonymous' ], __METHOD__, [ 'IGNORE' ] );
1061                         }
1062
1063                         # Insert 0 page to prevent FK violations
1064                         # Blank page
1065                         if ( !$this->db->selectField( 'page', '1', [ 'page_id' => 0 ] ) ) {
1066                                 $this->db->insert( 'page', [
1067                                         'page_id' => 0,
1068                                         'page_namespace' => 0,
1069                                         'page_title' => ' ',
1070                                         'page_restrictions' => null,
1071                                         'page_is_redirect' => 0,
1072                                         'page_is_new' => 0,
1073                                         'page_random' => 0,
1074                                         'page_touched' => $this->db->timestamp(),
1075                                         'page_latest' => 0,
1076                                         'page_len' => 0 ], __METHOD__, [ 'IGNORE' ] );
1077                         }
1078                 }
1079
1080                 User::resetIdByNameCache();
1081
1082                 // Make sysop user
1083                 $user = static::getTestSysop()->getUser();
1084
1085                 // Make 1 page with 1 revision
1086                 $page = WikiPage::factory( Title::newFromText( 'UTPage' ) );
1087                 if ( $page->getId() == 0 ) {
1088                         $page->doEditContent(
1089                                 new WikitextContent( 'UTContent' ),
1090                                 'UTPageSummary',
1091                                 EDIT_NEW | EDIT_SUPPRESS_RC,
1092                                 false,
1093                                 $user
1094                         );
1095                         // an edit always attempt to purge backlink links such as history
1096                         // pages. That is unneccessary.
1097                         JobQueueGroup::singleton()->get( 'htmlCacheUpdate' )->delete();
1098                         // WikiPages::doEditUpdates randomly adds RC purges
1099                         JobQueueGroup::singleton()->get( 'recentChangesUpdate' )->delete();
1100
1101                         // doEditContent() probably started the session via
1102                         // User::loadFromSession(). Close it now.
1103                         if ( session_id() !== '' ) {
1104                                 session_write_close();
1105                                 session_id( '' );
1106                         }
1107                 }
1108         }
1109
1110         /**
1111          * Restores MediaWiki to using the table set (table prefix) it was using before
1112          * setupTestDB() was called. Useful if we need to perform database operations
1113          * after the test run has finished (such as saving logs or profiling info).
1114          *
1115          * @since 1.21
1116          */
1117         public static function teardownTestDB() {
1118                 global $wgJobClasses;
1119
1120                 if ( !self::$dbSetup ) {
1121                         return;
1122                 }
1123
1124                 Hooks::run( 'UnitTestsBeforeDatabaseTeardown' );
1125
1126                 foreach ( $wgJobClasses as $type => $class ) {
1127                         // Delete any jobs under the clone DB (or old prefix in other stores)
1128                         JobQueueGroup::singleton()->get( $type )->delete();
1129                 }
1130
1131                 CloneDatabase::changePrefix( self::$oldTablePrefix );
1132
1133                 self::$oldTablePrefix = false;
1134                 self::$dbSetup = false;
1135         }
1136
1137         /**
1138          * Setups a database with the given prefix.
1139          *
1140          * If reuseDB is true and certain conditions apply, it will just change the prefix.
1141          * Otherwise, it will clone the tables and change the prefix.
1142          *
1143          * Clones all tables in the given database (whatever database that connection has
1144          * open), to versions with the test prefix.
1145          *
1146          * @param IMaintainableDatabase $db Database to use
1147          * @param string $prefix Prefix to use for test tables
1148          * @return bool True if tables were cloned, false if only the prefix was changed
1149          */
1150         protected static function setupDatabaseWithTestPrefix( IMaintainableDatabase $db, $prefix ) {
1151                 $tablesCloned = self::listTables( $db );
1152                 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix );
1153                 $dbClone->useTemporaryTables( self::$useTemporaryTables );
1154
1155                 if ( ( $db->getType() == 'oracle' || !self::$useTemporaryTables ) && self::$reuseDB ) {
1156                         CloneDatabase::changePrefix( $prefix );
1157
1158                         return false;
1159                 } else {
1160                         $dbClone->cloneTableStructure();
1161                         return true;
1162                 }
1163         }
1164
1165         /**
1166          * Set up all test DBs
1167          */
1168         public function setupAllTestDBs() {
1169                 global $wgDBprefix;
1170
1171                 self::$oldTablePrefix = $wgDBprefix;
1172
1173                 $testPrefix = $this->dbPrefix();
1174
1175                 // switch to a temporary clone of the database
1176                 self::setupTestDB( $this->db, $testPrefix );
1177
1178                 if ( self::isUsingExternalStoreDB() ) {
1179                         self::setupExternalStoreTestDBs( $testPrefix );
1180                 }
1181         }
1182
1183         /**
1184          * Creates an empty skeleton of the wiki database by cloning its structure
1185          * to equivalent tables using the given $prefix. Then sets MediaWiki to
1186          * use the new set of tables (aka schema) instead of the original set.
1187          *
1188          * This is used to generate a dummy table set, typically consisting of temporary
1189          * tables, that will be used by tests instead of the original wiki database tables.
1190          *
1191          * @since 1.21
1192          *
1193          * @note the original table prefix is stored in self::$oldTablePrefix. This is used
1194          * by teardownTestDB() to return the wiki to using the original table set.
1195          *
1196          * @note this method only works when first called. Subsequent calls have no effect,
1197          * even if using different parameters.
1198          *
1199          * @param Database $db The database connection
1200          * @param string $prefix The prefix to use for the new table set (aka schema).
1201          *
1202          * @throws MWException If the database table prefix is already $prefix
1203          */
1204         public static function setupTestDB( Database $db, $prefix ) {
1205                 if ( self::$dbSetup ) {
1206                         return;
1207                 }
1208
1209                 if ( $db->tablePrefix() === $prefix ) {
1210                         throw new MWException(
1211                                 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
1212                 }
1213
1214                 // TODO: the below should be re-written as soon as LBFactory, LoadBalancer,
1215                 // and Database no longer use global state.
1216
1217                 self::$dbSetup = true;
1218
1219                 if ( !self::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
1220                         return;
1221                 }
1222
1223                 // Assuming this isn't needed for External Store database, and not sure if the procedure
1224                 // would be available there.
1225                 if ( $db->getType() == 'oracle' ) {
1226                         $db->query( 'BEGIN FILL_WIKI_INFO; END;' );
1227                 }
1228
1229                 Hooks::run( 'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
1230         }
1231
1232         /**
1233          * Clones the External Store database(s) for testing
1234          *
1235          * @param string $testPrefix Prefix for test tables
1236          */
1237         protected static function setupExternalStoreTestDBs( $testPrefix ) {
1238                 $connections = self::getExternalStoreDatabaseConnections();
1239                 foreach ( $connections as $dbw ) {
1240                         // Hack: cloneTableStructure sets $wgDBprefix to the unit test
1241                         // prefix,.  Even though listTables now uses tablePrefix, that
1242                         // itself is populated from $wgDBprefix by default.
1243
1244                         // We have to set it back, or we won't find the original 'blobs'
1245                         // table to copy.
1246
1247                         $dbw->tablePrefix( self::$oldTablePrefix );
1248                         self::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
1249                 }
1250         }
1251
1252         /**
1253          * Gets master database connections for all of the ExternalStoreDB
1254          * stores configured in $wgDefaultExternalStore.
1255          *
1256          * @return Database[] Array of Database master connections
1257          */
1258         protected static function getExternalStoreDatabaseConnections() {
1259                 global $wgDefaultExternalStore;
1260
1261                 /** @var ExternalStoreDB $externalStoreDB */
1262                 $externalStoreDB = ExternalStore::getStoreObject( 'DB' );
1263                 $defaultArray = (array)$wgDefaultExternalStore;
1264                 $dbws = [];
1265                 foreach ( $defaultArray as $url ) {
1266                         if ( strpos( $url, 'DB://' ) === 0 ) {
1267                                 list( $proto, $cluster ) = explode( '://', $url, 2 );
1268                                 // Avoid getMaster() because setupDatabaseWithTestPrefix()
1269                                 // requires Database instead of plain DBConnRef/IDatabase
1270                                 $dbws[] = $externalStoreDB->getMaster( $cluster );
1271                         }
1272                 }
1273
1274                 return $dbws;
1275         }
1276
1277         /**
1278          * Check whether ExternalStoreDB is being used
1279          *
1280          * @return bool True if it's being used
1281          */
1282         protected static function isUsingExternalStoreDB() {
1283                 global $wgDefaultExternalStore;
1284                 if ( !$wgDefaultExternalStore ) {
1285                         return false;
1286                 }
1287
1288                 $defaultArray = (array)$wgDefaultExternalStore;
1289                 foreach ( $defaultArray as $url ) {
1290                         if ( strpos( $url, 'DB://' ) === 0 ) {
1291                                 return true;
1292                         }
1293                 }
1294
1295                 return false;
1296         }
1297
1298         /**
1299          * Empty all tables so they can be repopulated for tests
1300          *
1301          * @param Database $db|null Database to reset
1302          * @param array $tablesUsed Tables to reset
1303          */
1304         private function resetDB( $db, $tablesUsed ) {
1305                 if ( $db ) {
1306                         $userTables = [ 'user', 'user_groups', 'user_properties' ];
1307                         $pageTables = [ 'page', 'revision', 'ip_changes', 'revision_comment_temp', 'comment' ];
1308                         $coreDBDataTables = array_merge( $userTables, $pageTables );
1309
1310                         // If any of the user or page tables were marked as used, we should clear all of them.
1311                         if ( array_intersect( $tablesUsed, $userTables ) ) {
1312                                 $tablesUsed = array_unique( array_merge( $tablesUsed, $userTables ) );
1313                                 TestUserRegistry::clear();
1314                         }
1315                         if ( array_intersect( $tablesUsed, $pageTables ) ) {
1316                                 $tablesUsed = array_unique( array_merge( $tablesUsed, $pageTables ) );
1317                         }
1318
1319                         $truncate = in_array( $db->getType(), [ 'oracle', 'mysql' ] );
1320                         foreach ( $tablesUsed as $tbl ) {
1321                                 // TODO: reset interwiki table to its original content.
1322                                 if ( $tbl == 'interwiki' ) {
1323                                         continue;
1324                                 }
1325
1326                                 if ( $truncate ) {
1327                                         $db->query( 'TRUNCATE TABLE ' . $db->tableName( $tbl ), __METHOD__ );
1328                                 } else {
1329                                         $db->delete( $tbl, '*', __METHOD__ );
1330                                 }
1331
1332                                 if ( $tbl === 'page' ) {
1333                                         // Forget about the pages since they don't
1334                                         // exist in the DB.
1335                                         LinkCache::singleton()->clear();
1336                                 }
1337                         }
1338
1339                         if ( array_intersect( $tablesUsed, $coreDBDataTables ) ) {
1340                                 // Re-add core DB data that was deleted
1341                                 $this->addCoreDBData();
1342                         }
1343                 }
1344         }
1345
1346         /**
1347          * @since 1.18
1348          *
1349          * @param string $func
1350          * @param array $args
1351          *
1352          * @return mixed
1353          * @throws MWException
1354          */
1355         public function __call( $func, $args ) {
1356                 static $compatibility = [
1357                         'createMock' => 'createMock2',
1358                 ];
1359
1360                 if ( isset( $compatibility[$func] ) ) {
1361                         return call_user_func_array( [ $this, $compatibility[$func] ], $args );
1362                 } else {
1363                         throw new MWException( "Called non-existent $func method on " . static::class );
1364                 }
1365         }
1366
1367         /**
1368          * Return a test double for the specified class.
1369          *
1370          * @param string $originalClassName
1371          * @return PHPUnit_Framework_MockObject_MockObject
1372          * @throws Exception
1373          */
1374         private function createMock2( $originalClassName ) {
1375                 return $this->getMockBuilder( $originalClassName )
1376                         ->disableOriginalConstructor()
1377                         ->disableOriginalClone()
1378                         ->disableArgumentCloning()
1379                         // New in phpunit-mock-objects 3.2 (phpunit 5.4.0)
1380                         // ->disallowMockingUnknownTypes()
1381                         ->getMock();
1382         }
1383
1384         private static function unprefixTable( &$tableName, $ind, $prefix ) {
1385                 $tableName = substr( $tableName, strlen( $prefix ) );
1386         }
1387
1388         private static function isNotUnittest( $table ) {
1389                 return strpos( $table, 'unittest_' ) !== 0;
1390         }
1391
1392         /**
1393          * @since 1.18
1394          *
1395          * @param IMaintainableDatabase $db
1396          *
1397          * @return array
1398          */
1399         public static function listTables( IMaintainableDatabase $db ) {
1400                 $prefix = $db->tablePrefix();
1401                 $tables = $db->listTables( $prefix, __METHOD__ );
1402
1403                 if ( $db->getType() === 'mysql' ) {
1404                         static $viewListCache = null;
1405                         if ( $viewListCache === null ) {
1406                                 $viewListCache = $db->listViews( null, __METHOD__ );
1407                         }
1408                         // T45571: cannot clone VIEWs under MySQL
1409                         $tables = array_diff( $tables, $viewListCache );
1410                 }
1411                 array_walk( $tables, [ __CLASS__, 'unprefixTable' ], $prefix );
1412
1413                 // Don't duplicate test tables from the previous fataled run
1414                 $tables = array_filter( $tables, [ __CLASS__, 'isNotUnittest' ] );
1415
1416                 if ( $db->getType() == 'sqlite' ) {
1417                         $tables = array_flip( $tables );
1418                         // these are subtables of searchindex and don't need to be duped/dropped separately
1419                         unset( $tables['searchindex_content'] );
1420                         unset( $tables['searchindex_segdir'] );
1421                         unset( $tables['searchindex_segments'] );
1422                         $tables = array_flip( $tables );
1423                 }
1424
1425                 return $tables;
1426         }
1427
1428         /**
1429          * @throws MWException
1430          * @since 1.18
1431          */
1432         protected function checkDbIsSupported() {
1433                 if ( !in_array( $this->db->getType(), $this->supportedDBs ) ) {
1434                         throw new MWException( $this->db->getType() . " is not currently supported for unit testing." );
1435                 }
1436         }
1437
1438         /**
1439          * @since 1.18
1440          * @param string $offset
1441          * @return mixed
1442          */
1443         public function getCliArg( $offset ) {
1444                 if ( isset( PHPUnitMaintClass::$additionalOptions[$offset] ) ) {
1445                         return PHPUnitMaintClass::$additionalOptions[$offset];
1446                 }
1447
1448                 return null;
1449         }
1450
1451         /**
1452          * @since 1.18
1453          * @param string $offset
1454          * @param mixed $value
1455          */
1456         public function setCliArg( $offset, $value ) {
1457                 PHPUnitMaintClass::$additionalOptions[$offset] = $value;
1458         }
1459
1460         /**
1461          * Don't throw a warning if $function is deprecated and called later
1462          *
1463          * @since 1.19
1464          *
1465          * @param string $function
1466          */
1467         public function hideDeprecated( $function ) {
1468                 MediaWiki\suppressWarnings();
1469                 wfDeprecated( $function );
1470                 MediaWiki\restoreWarnings();
1471         }
1472
1473         /**
1474          * Asserts that the given database query yields the rows given by $expectedRows.
1475          * The expected rows should be given as indexed (not associative) arrays, with
1476          * the values given in the order of the columns in the $fields parameter.
1477          * Note that the rows are sorted by the columns given in $fields.
1478          *
1479          * @since 1.20
1480          *
1481          * @param string|array $table The table(s) to query
1482          * @param string|array $fields The columns to include in the result (and to sort by)
1483          * @param string|array $condition "where" condition(s)
1484          * @param array $expectedRows An array of arrays giving the expected rows.
1485          *
1486          * @throws MWException If this test cases's needsDB() method doesn't return true.
1487          *         Test cases can use "@group Database" to enable database test support,
1488          *         or list the tables under testing in $this->tablesUsed, or override the
1489          *         needsDB() method.
1490          */
1491         protected function assertSelect( $table, $fields, $condition, array $expectedRows ) {
1492                 if ( !$this->needsDB() ) {
1493                         throw new MWException( 'When testing database state, the test cases\'s needDB()' .
1494                                 ' method should return true. Use @group Database or $this->tablesUsed.' );
1495                 }
1496
1497                 $db = wfGetDB( DB_REPLICA );
1498
1499                 $res = $db->select( $table, $fields, $condition, wfGetCaller(), [ 'ORDER BY' => $fields ] );
1500                 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
1501
1502                 $i = 0;
1503
1504                 foreach ( $expectedRows as $expected ) {
1505                         $r = $res->fetchRow();
1506                         self::stripStringKeys( $r );
1507
1508                         $i += 1;
1509                         $this->assertNotEmpty( $r, "row #$i missing" );
1510
1511                         $this->assertEquals( $expected, $r, "row #$i mismatches" );
1512                 }
1513
1514                 $r = $res->fetchRow();
1515                 self::stripStringKeys( $r );
1516
1517                 $this->assertFalse( $r, "found extra row (after #$i)" );
1518         }
1519
1520         /**
1521          * Utility method taking an array of elements and wrapping
1522          * each element in its own array. Useful for data providers
1523          * that only return a single argument.
1524          *
1525          * @since 1.20
1526          *
1527          * @param array $elements
1528          *
1529          * @return array
1530          */
1531         protected function arrayWrap( array $elements ) {
1532                 return array_map(
1533                         function ( $element ) {
1534                                 return [ $element ];
1535                         },
1536                         $elements
1537                 );
1538         }
1539
1540         /**
1541          * Assert that two arrays are equal. By default this means that both arrays need to hold
1542          * the same set of values. Using additional arguments, order and associated key can also
1543          * be set as relevant.
1544          *
1545          * @since 1.20
1546          *
1547          * @param array $expected
1548          * @param array $actual
1549          * @param bool $ordered If the order of the values should match
1550          * @param bool $named If the keys should match
1551          */
1552         protected function assertArrayEquals( array $expected, array $actual,
1553                 $ordered = false, $named = false
1554         ) {
1555                 if ( !$ordered ) {
1556                         $this->objectAssociativeSort( $expected );
1557                         $this->objectAssociativeSort( $actual );
1558                 }
1559
1560                 if ( !$named ) {
1561                         $expected = array_values( $expected );
1562                         $actual = array_values( $actual );
1563                 }
1564
1565                 call_user_func_array(
1566                         [ $this, 'assertEquals' ],
1567                         array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
1568                 );
1569         }
1570
1571         /**
1572          * Put each HTML element on its own line and then equals() the results
1573          *
1574          * Use for nicely formatting of PHPUnit diff output when comparing very
1575          * simple HTML
1576          *
1577          * @since 1.20
1578          *
1579          * @param string $expected HTML on oneline
1580          * @param string $actual HTML on oneline
1581          * @param string $msg Optional message
1582          */
1583         protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
1584                 $expected = str_replace( '>', ">\n", $expected );
1585                 $actual = str_replace( '>', ">\n", $actual );
1586
1587                 $this->assertEquals( $expected, $actual, $msg );
1588         }
1589
1590         /**
1591          * Does an associative sort that works for objects.
1592          *
1593          * @since 1.20
1594          *
1595          * @param array &$array
1596          */
1597         protected function objectAssociativeSort( array &$array ) {
1598                 uasort(
1599                         $array,
1600                         function ( $a, $b ) {
1601                                 return serialize( $a ) > serialize( $b ) ? 1 : -1;
1602                         }
1603                 );
1604         }
1605
1606         /**
1607          * Utility function for eliminating all string keys from an array.
1608          * Useful to turn a database result row as returned by fetchRow() into
1609          * a pure indexed array.
1610          *
1611          * @since 1.20
1612          *
1613          * @param mixed &$r The array to remove string keys from.
1614          */
1615         protected static function stripStringKeys( &$r ) {
1616                 if ( !is_array( $r ) ) {
1617                         return;
1618                 }
1619
1620                 foreach ( $r as $k => $v ) {
1621                         if ( is_string( $k ) ) {
1622                                 unset( $r[$k] );
1623                         }
1624                 }
1625         }
1626
1627         /**
1628          * Asserts that the provided variable is of the specified
1629          * internal type or equals the $value argument. This is useful
1630          * for testing return types of functions that return a certain
1631          * type or *value* when not set or on error.
1632          *
1633          * @since 1.20
1634          *
1635          * @param string $type
1636          * @param mixed $actual
1637          * @param mixed $value
1638          * @param string $message
1639          */
1640         protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
1641                 if ( $actual === $value ) {
1642                         $this->assertTrue( true, $message );
1643                 } else {
1644                         $this->assertType( $type, $actual, $message );
1645                 }
1646         }
1647
1648         /**
1649          * Asserts the type of the provided value. This can be either
1650          * in internal type such as boolean or integer, or a class or
1651          * interface the value extends or implements.
1652          *
1653          * @since 1.20
1654          *
1655          * @param string $type
1656          * @param mixed $actual
1657          * @param string $message
1658          */
1659         protected function assertType( $type, $actual, $message = '' ) {
1660                 if ( class_exists( $type ) || interface_exists( $type ) ) {
1661                         $this->assertInstanceOf( $type, $actual, $message );
1662                 } else {
1663                         $this->assertInternalType( $type, $actual, $message );
1664                 }
1665         }
1666
1667         /**
1668          * Returns true if the given namespace defaults to Wikitext
1669          * according to $wgNamespaceContentModels
1670          *
1671          * @param int $ns The namespace ID to check
1672          *
1673          * @return bool
1674          * @since 1.21
1675          */
1676         protected function isWikitextNS( $ns ) {
1677                 global $wgNamespaceContentModels;
1678
1679                 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
1680                         return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT;
1681                 }
1682
1683                 return true;
1684         }
1685
1686         /**
1687          * Returns the ID of a namespace that defaults to Wikitext.
1688          *
1689          * @throws MWException If there is none.
1690          * @return int The ID of the wikitext Namespace
1691          * @since 1.21
1692          */
1693         protected function getDefaultWikitextNS() {
1694                 global $wgNamespaceContentModels;
1695
1696                 static $wikitextNS = null; // this is not going to change
1697                 if ( $wikitextNS !== null ) {
1698                         return $wikitextNS;
1699                 }
1700
1701                 // quickly short out on most common case:
1702                 if ( !isset( $wgNamespaceContentModels[NS_MAIN] ) ) {
1703                         return NS_MAIN;
1704                 }
1705
1706                 // NOTE: prefer content namespaces
1707                 $namespaces = array_unique( array_merge(
1708                         MWNamespace::getContentNamespaces(),
1709                         [ NS_MAIN, NS_HELP, NS_PROJECT ], // prefer these
1710                         MWNamespace::getValidNamespaces()
1711                 ) );
1712
1713                 $namespaces = array_diff( $namespaces, [
1714                         NS_FILE, NS_CATEGORY, NS_MEDIAWIKI, NS_USER // don't mess with magic namespaces
1715                 ] );
1716
1717                 $talk = array_filter( $namespaces, function ( $ns ) {
1718                         return MWNamespace::isTalk( $ns );
1719                 } );
1720
1721                 // prefer non-talk pages
1722                 $namespaces = array_diff( $namespaces, $talk );
1723                 $namespaces = array_merge( $namespaces, $talk );
1724
1725                 // check default content model of each namespace
1726                 foreach ( $namespaces as $ns ) {
1727                         if ( !isset( $wgNamespaceContentModels[$ns] ) ||
1728                                 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
1729                         ) {
1730                                 $wikitextNS = $ns;
1731
1732                                 return $wikitextNS;
1733                         }
1734                 }
1735
1736                 // give up
1737                 // @todo Inside a test, we could skip the test as incomplete.
1738                 //        But frequently, this is used in fixture setup.
1739                 throw new MWException( "No namespace defaults to wikitext!" );
1740         }
1741
1742         /**
1743          * Check, if $wgDiff3 is set and ready to merge
1744          * Will mark the calling test as skipped, if not ready
1745          *
1746          * @since 1.21
1747          */
1748         protected function markTestSkippedIfNoDiff3() {
1749                 global $wgDiff3;
1750
1751                 # This check may also protect against code injection in
1752                 # case of broken installations.
1753                 MediaWiki\suppressWarnings();
1754                 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
1755                 MediaWiki\restoreWarnings();
1756
1757                 if ( !$haveDiff3 ) {
1758                         $this->markTestSkipped( "Skip test, since diff3 is not configured" );
1759                 }
1760         }
1761
1762         /**
1763          * Check if $extName is a loaded PHP extension, will skip the
1764          * test whenever it is not loaded.
1765          *
1766          * @since 1.21
1767          * @param string $extName
1768          * @return bool
1769          */
1770         protected function checkPHPExtension( $extName ) {
1771                 $loaded = extension_loaded( $extName );
1772                 if ( !$loaded ) {
1773                         $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
1774                 }
1775
1776                 return $loaded;
1777         }
1778
1779         /**
1780          * Asserts that the given string is a valid HTML snippet.
1781          * Wraps the given string in the required top level tags and
1782          * then calls assertValidHtmlDocument().
1783          * The snippet is expected to be HTML 5.
1784          *
1785          * @since 1.23
1786          *
1787          * @note Will mark the test as skipped if the "tidy" module is not installed.
1788          * @note This ignores $wgUseTidy, so we can check for valid HTML even (and especially)
1789          *        when automatic tidying is disabled.
1790          *
1791          * @param string $html An HTML snippet (treated as the contents of the body tag).
1792          */
1793         protected function assertValidHtmlSnippet( $html ) {
1794                 $html = '<!DOCTYPE html><html><head><title>test</title></head><body>' . $html . '</body></html>';
1795                 $this->assertValidHtmlDocument( $html );
1796         }
1797
1798         /**
1799          * Asserts that the given string is valid HTML document.
1800          *
1801          * @since 1.23
1802          *
1803          * @note Will mark the test as skipped if the "tidy" module is not installed.
1804          * @note This ignores $wgUseTidy, so we can check for valid HTML even (and especially)
1805          *        when automatic tidying is disabled.
1806          *
1807          * @param string $html A complete HTML document
1808          */
1809         protected function assertValidHtmlDocument( $html ) {
1810                 // Note: we only validate if the tidy PHP extension is available.
1811                 // In case wgTidyInternal is false, MWTidy would fall back to the command line version
1812                 // of tidy. In that case however, we can not reliably detect whether a failing validation
1813                 // is due to malformed HTML, or caused by tidy not being installed as a command line tool.
1814                 // That would cause all HTML assertions to fail on a system that has no tidy installed.
1815                 if ( !$GLOBALS['wgTidyInternal'] || !MWTidy::isEnabled() ) {
1816                         $this->markTestSkipped( 'Tidy extension not installed' );
1817                 }
1818
1819                 $errorBuffer = '';
1820                 MWTidy::checkErrors( $html, $errorBuffer );
1821                 $allErrors = preg_split( '/[\r\n]+/', $errorBuffer );
1822
1823                 // Filter Tidy warnings which aren't useful for us.
1824                 // Tidy eg. often cries about parameters missing which have actually
1825                 // been deprecated since HTML4, thus we should not care about them.
1826                 $errors = preg_grep(
1827                         '/^(.*Warning: (trimming empty|.* lacks ".*?" attribute).*|\s*)$/m',
1828                         $allErrors, PREG_GREP_INVERT
1829                 );
1830
1831                 $this->assertEmpty( $errors, implode( "\n", $errors ) );
1832         }
1833
1834         /**
1835          * Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
1836          * @param string $buffer
1837          * @return string
1838          */
1839         public static function wfResetOutputBuffersBarrier( $buffer ) {
1840                 return $buffer;
1841         }
1842
1843         /**
1844          * Create a temporary hook handler which will be reset by tearDown.
1845          * This replaces other handlers for the same hook.
1846          * @param string $hookName Hook name
1847          * @param mixed $handler Value suitable for a hook handler
1848          * @since 1.28
1849          */
1850         protected function setTemporaryHook( $hookName, $handler ) {
1851                 $this->mergeMwGlobalArrayValue( 'wgHooks', [ $hookName => [ $handler ] ] );
1852         }
1853
1854         /**
1855          * Check whether file contains given data.
1856          * @param string $fileName
1857          * @param string $actualData
1858          * @param bool $createIfMissing If true, and file does not exist, create it with given data
1859          *                              and skip the test.
1860          * @param string $msg
1861          * @since 1.30
1862          */
1863         protected function assertFileContains(
1864                 $fileName,
1865                 $actualData,
1866                 $createIfMissing = true,
1867                 $msg = ''
1868         ) {
1869                 if ( $createIfMissing ) {
1870                         if ( !file_exists( $fileName ) ) {
1871                                 file_put_contents( $fileName, $actualData );
1872                                 $this->markTestSkipped( 'Data file $fileName does not exist' );
1873                         }
1874                 } else {
1875                         self::assertFileExists( $fileName );
1876                 }
1877                 self::assertEquals( file_get_contents( $fileName ), $actualData, $msg );
1878         }
1879 }