tests/phpunit/MediaWikiTestCase.php

   1 <?php
   2
   3 /**
   4  * @since 1.18
   5  */
   6 abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase {
   7         /**
   8          * $called tracks whether the setUp and tearDown method has been called.
   9          * class extending MediaWikiTestCase usually override setUp and tearDown
  10          * but forget to call the parent.
  11          *
  12          * The array format takes a method name as key and anything as a value.
  13          * By asserting the key exist, we know the child class has called the
  14          * parent.
  15          *
  16          * This property must be private, we do not want child to override it,
  17          * they should call the appropriate parent method instead.
  18          */
  19         private $called = array();
  20
  21         /**
  22          * @var TestUser[]
  23          * @since 1.20
  24          */
  25         public static $users;
  26
  27         /**
  28          * @var DatabaseBase
  29          * @since 1.18
  30          */
  31         protected $db;
  32
  33         /**
  34          * @var array
  35          * @since 1.19
  36          */
  37         protected $tablesUsed = array(); // tables with data
  38
  39         private static $useTemporaryTables = true;
  40         private static $reuseDB = false;
  41         private static $dbSetup = false;
  42         private static $oldTablePrefix = false;
  43
  44         /**
  45          * Original value of PHP's error_reporting setting.
  46          *
  47          * @var int
  48          */
  49         private $phpErrorLevel;
  50
  51         /**
  52          * Holds the paths of temporary files/directories created through getNewTempFile,
  53          * and getNewTempDirectory
  54          *
  55          * @var array
  56          */
  57         private $tmpFiles = array();
  58
  59         /**
  60          * Holds original values of MediaWiki configuration settings
  61          * to be restored in tearDown().
  62          * See also setMwGlobals().
  63          * @var array
  64          */
  65         private $mwGlobals = array();
  66
  67         /**
  68          * Table name prefixes. Oracle likes it shorter.
  69          */
  70         const DB_PREFIX = 'unittest_';
  71         const ORA_DB_PREFIX = 'ut_';
  72
  73         /**
  74          * @var array
  75          * @since 1.18
  76          */
  77         protected $supportedDBs = array(
  78                 'mysql',
  79                 'sqlite',
  80                 'postgres',
  81                 'oracle'
  82         );
  83
  84         public function __construct( $name = null, array $data = array(), $dataName = '' ) {
  85                 parent::__construct( $name, $data, $dataName );
  86
  87                 $this->backupGlobals = false;
  88                 $this->backupStaticAttributes = false;
  89         }
  90
  91         public function __destruct() {
  92                 // Complain if self::setUp() was called, but not self::tearDown()
  93                 // $this->called['setUp'] will be checked by self::testMediaWikiTestCaseParentSetupCalled()
  94                 if ( isset( $this->called['setUp'] ) && !isset( $this->called['tearDown'] ) ) {
  95                         throw new MWException( get_called_class() . "::tearDown() must call parent::tearDown()" );
  96                 }
  97         }
  98
  99         public function run( PHPUnit_Framework_TestResult $result = null ) {
 100                 /* Some functions require some kind of caching, and will end up using the db,
 101                  * which we can't allow, as that would open a new connection for mysql.
 102                  * Replace with a HashBag. They would not be going to persist anyway.
 103                  */
 104                 ObjectCache::$instances[CACHE_DB] = new HashBagOStuff;
 105
 106                 $needsResetDB = false;
 107                 $logName = get_class( $this ) . '::' . $this->getName( false );
 108
 109                 if ( $this->needsDB() ) {
 110                         // set up a DB connection for this test to use
 111
 112                         self::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
 113                         self::$reuseDB = $this->getCliArg( 'reuse-db' );
 114
 115                         $this->db = wfGetDB( DB_MASTER );
 116
 117                         $this->checkDbIsSupported();
 118
 119                         if ( !self::$dbSetup ) {
 120                                 wfProfileIn( $logName . ' (clone-db)' );
 121
 122                                 // switch to a temporary clone of the database
 123                                 self::setupTestDB( $this->db, $this->dbPrefix() );
 124
 125                                 if ( ( $this->db->getType() == 'oracle' || !self::$useTemporaryTables ) && self::$reuseDB ) {
 126                                         $this->resetDB();
 127                                 }
 128
 129                                 wfProfileOut( $logName . ' (clone-db)' );
 130                         }
 131
 132                         wfProfileIn( $logName . ' (prepare-db)' );
 133                         $this->addCoreDBData();
 134                         $this->addDBData();
 135                         wfProfileOut( $logName . ' (prepare-db)' );
 136
 137                         $needsResetDB = true;
 138                 }
 139
 140                 wfProfileIn( $logName );
 141                 parent::run( $result );
 142                 wfProfileOut( $logName );
 143
 144                 if ( $needsResetDB ) {
 145                         wfProfileIn( $logName . ' (reset-db)' );
 146                         $this->resetDB();
 147                         wfProfileOut( $logName . ' (reset-db)' );
 148                 }
 149         }
 150
 151         /**
 152          * @since 1.21
 153          *
 154          * @return bool
 155          */
 156         public function usesTemporaryTables() {
 157                 return self::$useTemporaryTables;
 158         }
 159
 160         /**
 161          * Obtains a new temporary file name
 162          *
 163          * The obtained filename is enlisted to be removed upon tearDown
 164          *
 165          * @since 1.20
 166          *
 167          * @return string Absolute name of the temporary file
 168          */
 169         protected function getNewTempFile() {
 170                 $fileName = tempnam( wfTempDir(), 'MW_PHPUnit_' . get_class( $this ) . '_' );
 171                 $this->tmpFiles[] = $fileName;
 172
 173                 return $fileName;
 174         }
 175
 176         /**
 177          * obtains a new temporary directory
 178          *
 179          * The obtained directory is enlisted to be removed (recursively with all its contained
 180          * files) upon tearDown.
 181          *
 182          * @since 1.20
 183          *
 184          * @return string Absolute name of the temporary directory
 185          */
 186         protected function getNewTempDirectory() {
 187                 // Starting of with a temporary /file/.
 188                 $fileName = $this->getNewTempFile();
 189
 190                 // Converting the temporary /file/ to a /directory/
 191                 //
 192                 // The following is not atomic, but at least we now have a single place,
 193                 // where temporary directory creation is bundled and can be improved
 194                 unlink( $fileName );
 195                 $this->assertTrue( wfMkdirParents( $fileName ) );
 196
 197                 return $fileName;
 198         }
 199
 200         protected function setUp() {
 201                 wfProfileIn( __METHOD__ );
 202                 parent::setUp();
 203                 $this->called['setUp'] = true;
 204
 205                 $this->phpErrorLevel = intval( ini_get( 'error_reporting' ) );
 206
 207                 // Cleaning up temporary files
 208                 foreach ( $this->tmpFiles as $fileName ) {
 209                         if ( is_file( $fileName ) || ( is_link( $fileName ) ) ) {
 210                                 unlink( $fileName );
 211                         } elseif ( is_dir( $fileName ) ) {
 212                                 wfRecursiveRemoveDir( $fileName );
 213                         }
 214                 }
 215
 216                 if ( $this->needsDB() && $this->db ) {
 217                         // Clean up open transactions
 218                         while ( $this->db->trxLevel() > 0 ) {
 219                                 $this->db->rollback();
 220                         }
 221
 222                         // don't ignore DB errors
 223                         $this->db->ignoreErrors( false );
 224                 }
 225
 226                 wfProfileOut( __METHOD__ );
 227         }
 228
 229         protected function tearDown() {
 230                 wfProfileIn( __METHOD__ );
 231
 232                 $this->called['tearDown'] = true;
 233                 // Cleaning up temporary files
 234                 foreach ( $this->tmpFiles as $fileName ) {
 235                         if ( is_file( $fileName ) || ( is_link( $fileName ) ) ) {
 236                                 unlink( $fileName );
 237                         } elseif ( is_dir( $fileName ) ) {
 238                                 wfRecursiveRemoveDir( $fileName );
 239                         }
 240                 }
 241
 242                 if ( $this->needsDB() && $this->db ) {
 243                         // Clean up open transactions
 244                         while ( $this->db->trxLevel() > 0 ) {
 245                                 $this->db->rollback();
 246                         }
 247
 248                         // don't ignore DB errors
 249                         $this->db->ignoreErrors( false );
 250                 }
 251
 252                 // Restore mw globals
 253                 foreach ( $this->mwGlobals as $key => $value ) {
 254                         $GLOBALS[$key] = $value;
 255                 }
 256                 $this->mwGlobals = array();
 257                 RequestContext::resetMain();
 258                 MediaHandler::resetCache();
 259
 260                 $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
 261
 262                 if ( $phpErrorLevel !== $this->phpErrorLevel ) {
 263                         ini_set( 'error_reporting', $this->phpErrorLevel );
 264
 265                         $oldHex = strtoupper( dechex( $this->phpErrorLevel ) );
 266                         $newHex = strtoupper( dechex( $phpErrorLevel ) );
 267                         $message = "PHP error_reporting setting was left dirty: "
 268                                 . "was 0x$oldHex before test, 0x$newHex after test!";
 269
 270                         $this->fail( $message );
 271                 }
 272
 273                 parent::tearDown();
 274                 wfProfileOut( __METHOD__ );
 275         }
 276
 277         /**
 278          * Make sure MediaWikiTestCase extending classes have called their
 279          * parent setUp method
 280          */
 281         final public function testMediaWikiTestCaseParentSetupCalled() {
 282                 $this->assertArrayHasKey( 'setUp', $this->called,
 283                         get_called_class() . "::setUp() must call parent::setUp()"
 284                 );
 285         }
 286
 287         /**
 288          * Sets a global, maintaining a stashed version of the previous global to be
 289          * restored in tearDown
 290          *
 291          * The key is added to the array of globals that will be reset afterwards
 292          * in the tearDown().
 293          *
 294          * @example
 295          * <code>
 296          *     protected function setUp() {
 297          *         $this->setMwGlobals( 'wgRestrictStuff', true );
 298          *     }
 299          *
 300          *     function testFoo() {}
 301          *
 302          *     function testBar() {}
 303          *         $this->assertTrue( self::getX()->doStuff() );
 304          *
 305          *         $this->setMwGlobals( 'wgRestrictStuff', false );
 306          *         $this->assertTrue( self::getX()->doStuff() );
 307          *     }
 308          *
 309          *     function testQuux() {}
 310          * </code>
 311          *
 312          * @param array|string $pairs Key to the global variable, or an array
 313          *  of key/value pairs.
 314          * @param mixed $value Value to set the global to (ignored
 315          *  if an array is given as first argument).
 316          *
 317          * @since 1.21
 318          */
 319         protected function setMwGlobals( $pairs, $value = null ) {
 320                 if ( is_string( $pairs ) ) {
 321                         $pairs = array( $pairs => $value );
 322                 }
 323
 324                 $this->stashMwGlobals( array_keys( $pairs ) );
 325
 326                 foreach ( $pairs as $key => $value ) {
 327                         $GLOBALS[$key] = $value;
 328                 }
 329         }
 330
 331         /**
 332          * Stashes the global, will be restored in tearDown()
 333          *
 334          * Individual test functions may override globals through the setMwGlobals() function
 335          * or directly. When directly overriding globals their keys should first be passed to this
 336          * method in setUp to avoid breaking global state for other tests
 337          *
 338          * That way all other tests are executed with the same settings (instead of using the
 339          * unreliable local settings for most tests and fix it only for some tests).
 340          *
 341          * @param array|string $globalKeys Key to the global variable, or an array of keys.
 342          *
 343          * @throws Exception When trying to stash an unset global
 344          * @since 1.23
 345          */
 346         protected function stashMwGlobals( $globalKeys ) {
 347                 if ( is_string( $globalKeys ) ) {
 348                         $globalKeys = array( $globalKeys );
 349                 }
 350
 351                 foreach ( $globalKeys as $globalKey ) {
 352                         // NOTE: make sure we only save the global once or a second call to
 353                         // setMwGlobals() on the same global would override the original
 354                         // value.
 355                         if ( !array_key_exists( $globalKey, $this->mwGlobals ) ) {
 356                                 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
 357                                         throw new Exception( "Global with key {$globalKey} doesn't exist and cant be stashed" );
 358                                 }
 359                                 // NOTE: we serialize then unserialize the value in case it is an object
 360                                 // this stops any objects being passed by reference. We could use clone
 361                                 // and if is_object but this does account for objects within objects!
 362                                 try {
 363                                         $this->mwGlobals[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
 364                                 }
 365                                         // NOTE; some things such as Closures are not serializable
 366                                         // in this case just set the value!
 367                                 catch ( Exception $e ) {
 368                                         $this->mwGlobals[$globalKey] = $GLOBALS[$globalKey];
 369                                 }
 370                         }
 371                 }
 372         }
 373
 374         /**
 375          * Merges the given values into a MW global array variable.
 376          * Useful for setting some entries in a configuration array, instead of
 377          * setting the entire array.
 378          *
 379          * @param string $name The name of the global, as in wgFooBar
 380          * @param array $values The array containing the entries to set in that global
 381          *
 382          * @throws MWException If the designated global is not an array.
 383          *
 384          * @since 1.21
 385          */
 386         protected function mergeMwGlobalArrayValue( $name, $values ) {
 387                 if ( !isset( $GLOBALS[$name] ) ) {
 388                         $merged = $values;
 389                 } else {
 390                         if ( !is_array( $GLOBALS[$name] ) ) {
 391                                 throw new MWException( "MW global $name is not an array." );
 392                         }
 393
 394                         // NOTE: do not use array_merge, it screws up for numeric keys.
 395                         $merged = $GLOBALS[$name];
 396                         foreach ( $values as $k => $v ) {
 397                                 $merged[$k] = $v;
 398                         }
 399                 }
 400
 401                 $this->setMwGlobals( $name, $merged );
 402         }
 403
 404         /**
 405          * @return string
 406          * @since 1.18
 407          */
 408         public function dbPrefix() {
 409                 return $this->db->getType() == 'oracle' ? self::ORA_DB_PREFIX : self::DB_PREFIX;
 410         }
 411
 412         /**
 413          * @return bool
 414          * @since 1.18
 415          */
 416         public function needsDB() {
 417                 # if the test says it uses database tables, it needs the database
 418                 if ( $this->tablesUsed ) {
 419                         return true;
 420                 }
 421
 422                 # if the test says it belongs to the Database group, it needs the database
 423                 $rc = new ReflectionClass( $this );
 424                 if ( preg_match( '/@group +Database/im', $rc->getDocComment() ) ) {
 425                         return true;
 426                 }
 427
 428                 return false;
 429         }
 430
 431         /**
 432          * Stub. If a test needs to add additional data to the database, it should
 433          * implement this method and do so
 434          *
 435          * @since 1.18
 436          */
 437         public function addDBData() {
 438         }
 439
 440         private function addCoreDBData() {
 441                 if ( $this->db->getType() == 'oracle' ) {
 442
 443                         # Insert 0 user to prevent FK violations
 444                         # Anonymous user
 445                         $this->db->insert( 'user', array(
 446                                 'user_id' => 0,
 447                                 'user_name' => 'Anonymous' ), __METHOD__, array( 'IGNORE' ) );
 448
 449                         # Insert 0 page to prevent FK violations
 450                         # Blank page
 451                         $this->db->insert( 'page', array(
 452                                 'page_id' => 0,
 453                                 'page_namespace' => 0,
 454                                 'page_title' => ' ',
 455                                 'page_restrictions' => null,
 456                                 'page_counter' => 0,
 457                                 'page_is_redirect' => 0,
 458                                 'page_is_new' => 0,
 459                                 'page_random' => 0,
 460                                 'page_touched' => $this->db->timestamp(),
 461                                 'page_latest' => 0,
 462                                 'page_len' => 0 ), __METHOD__, array( 'IGNORE' ) );
 463                 }
 464
 465                 User::resetIdByNameCache();
 466
 467                 //Make sysop user
 468                 $user = User::newFromName( 'UTSysop' );
 469
 470                 if ( $user->idForName() == 0 ) {
 471                         $user->addToDatabase();
 472                         $user->setPassword( 'UTSysopPassword' );
 473
 474                         $user->addGroup( 'sysop' );
 475                         $user->addGroup( 'bureaucrat' );
 476                         $user->saveSettings();
 477                 }
 478
 479                 //Make 1 page with 1 revision
 480                 $page = WikiPage::factory( Title::newFromText( 'UTPage' ) );
 481                 if ( $page->getId() == 0 ) {
 482                         $page->doEditContent(
 483                                 new WikitextContent( 'UTContent' ),
 484                                 'UTPageSummary',
 485                                 EDIT_NEW,
 486                                 false,
 487                                 User::newFromName( 'UTSysop' ) );
 488                 }
 489         }
 490
 491         /**
 492          * Restores MediaWiki to using the table set (table prefix) it was using before
 493          * setupTestDB() was called. Useful if we need to perform database operations
 494          * after the test run has finished (such as saving logs or profiling info).
 495          *
 496          * @since 1.21
 497          */
 498         public static function teardownTestDB() {
 499                 if ( !self::$dbSetup ) {
 500                         return;
 501                 }
 502
 503                 CloneDatabase::changePrefix( self::$oldTablePrefix );
 504
 505                 self::$oldTablePrefix = false;
 506                 self::$dbSetup = false;
 507         }
 508
 509         /**
 510          * Creates an empty skeleton of the wiki database by cloning its structure
 511          * to equivalent tables using the given $prefix. Then sets MediaWiki to
 512          * use the new set of tables (aka schema) instead of the original set.
 513          *
 514          * This is used to generate a dummy table set, typically consisting of temporary
 515          * tables, that will be used by tests instead of the original wiki database tables.
 516          *
 517          * @since 1.21
 518          *
 519          * @note the original table prefix is stored in self::$oldTablePrefix. This is used
 520          * by teardownTestDB() to return the wiki to using the original table set.
 521          *
 522          * @note this method only works when first called. Subsequent calls have no effect,
 523          * even if using different parameters.
 524          *
 525          * @param DatabaseBase $db The database connection
 526          * @param string $prefix The prefix to use for the new table set (aka schema).
 527          *
 528          * @throws MWException If the database table prefix is already $prefix
 529          */
 530         public static function setupTestDB( DatabaseBase $db, $prefix ) {
 531                 global $wgDBprefix;
 532                 if ( $wgDBprefix === $prefix ) {
 533                         throw new MWException(
 534                                 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
 535                 }
 536
 537                 if ( self::$dbSetup ) {
 538                         return;
 539                 }
 540
 541                 $tablesCloned = self::listTables( $db );
 542                 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix );
 543                 $dbClone->useTemporaryTables( self::$useTemporaryTables );
 544
 545                 self::$dbSetup = true;
 546                 self::$oldTablePrefix = $wgDBprefix;
 547
 548                 if ( ( $db->getType() == 'oracle' || !self::$useTemporaryTables ) && self::$reuseDB ) {
 549                         CloneDatabase::changePrefix( $prefix );
 550
 551                         return;
 552                 } else {
 553                         $dbClone->cloneTableStructure();
 554                 }
 555
 556                 if ( $db->getType() == 'oracle' ) {
 557                         $db->query( 'BEGIN FILL_WIKI_INFO; END;' );
 558                 }
 559         }
 560
 561         /**
 562          * Empty all tables so they can be repopulated for tests
 563          */
 564         private function resetDB() {
 565                 if ( $this->db ) {
 566                         if ( $this->db->getType() == 'oracle' ) {
 567                                 if ( self::$useTemporaryTables ) {
 568                                         wfGetLB()->closeAll();
 569                                         $this->db = wfGetDB( DB_MASTER );
 570                                 } else {
 571                                         foreach ( $this->tablesUsed as $tbl ) {
 572                                                 if ( $tbl == 'interwiki' ) {
 573                                                         continue;
 574                                                 }
 575                                                 $this->db->query( 'TRUNCATE TABLE ' . $this->db->tableName( $tbl ), __METHOD__ );
 576                                         }
 577                                 }
 578                         } else {
 579                                 foreach ( $this->tablesUsed as $tbl ) {
 580                                         if ( $tbl == 'interwiki' || $tbl == 'user' ) {
 581                                                 continue;
 582                                         }
 583                                         $this->db->delete( $tbl, '*', __METHOD__ );
 584                                 }
 585                         }
 586                 }
 587         }
 588
 589         /**
 590          * @since 1.18
 591          *
 592          * @param string $func
 593          * @param array $args
 594          *
 595          * @return mixed
 596          * @throws MWException
 597          */
 598         public function __call( $func, $args ) {
 599                 static $compatibility = array(
 600                         'assertEmpty' => 'assertEmpty2', // assertEmpty was added in phpunit 3.7.32
 601                 );
 602
 603                 if ( isset( $compatibility[$func] ) ) {
 604                         return call_user_func_array( array( $this, $compatibility[$func] ), $args );
 605                 } else {
 606                         throw new MWException( "Called non-existant $func method on "
 607                                 . get_class( $this ) );
 608                 }
 609         }
 610
 611         /**
 612          * Used as a compatibility method for phpunit < 3.7.32
 613          * @param string $value
 614          * @param string $msg
 615          */
 616         private function assertEmpty2( $value, $msg ) {
 617                 return $this->assertTrue( $value == '', $msg );
 618         }
 619
 620         private static function unprefixTable( $tableName ) {
 621                 global $wgDBprefix;
 622
 623                 return substr( $tableName, strlen( $wgDBprefix ) );
 624         }
 625
 626         private static function isNotUnittest( $table ) {
 627                 return strpos( $table, 'unittest_' ) !== 0;
 628         }
 629
 630         /**
 631          * @since 1.18
 632          *
 633          * @param DataBaseBase $db
 634          *
 635          * @return array
 636          */
 637         public static function listTables( $db ) {
 638                 global $wgDBprefix;
 639
 640                 $tables = $db->listTables( $wgDBprefix, __METHOD__ );
 641
 642                 if ( $db->getType() === 'mysql' ) {
 643                         # bug 43571: cannot clone VIEWs under MySQL
 644                         $views = $db->listViews( $wgDBprefix, __METHOD__ );
 645                         $tables = array_diff( $tables, $views );
 646                 }
 647                 $tables = array_map( array( __CLASS__, 'unprefixTable' ), $tables );
 648
 649                 // Don't duplicate test tables from the previous fataled run
 650                 $tables = array_filter( $tables, array( __CLASS__, 'isNotUnittest' ) );
 651
 652                 if ( $db->getType() == 'sqlite' ) {
 653                         $tables = array_flip( $tables );
 654                         // these are subtables of searchindex and don't need to be duped/dropped separately
 655                         unset( $tables['searchindex_content'] );
 656                         unset( $tables['searchindex_segdir'] );
 657                         unset( $tables['searchindex_segments'] );
 658                         $tables = array_flip( $tables );
 659                 }
 660
 661                 return $tables;
 662         }
 663
 664         /**
 665          * @throws MWException
 666          * @since 1.18
 667          */
 668         protected function checkDbIsSupported() {
 669                 if ( !in_array( $this->db->getType(), $this->supportedDBs ) ) {
 670                         throw new MWException( $this->db->getType() . " is not currently supported for unit testing." );
 671                 }
 672         }
 673
 674         /**
 675          * @since 1.18
 676          * @param string $offset
 677          * @return mixed
 678          */
 679         public function getCliArg( $offset ) {
 680                 if ( isset( PHPUnitMaintClass::$additionalOptions[$offset] ) ) {
 681                         return PHPUnitMaintClass::$additionalOptions[$offset];
 682                 }
 683         }
 684
 685         /**
 686          * @since 1.18
 687          * @param string $offset
 688          * @param mixed $value
 689          */
 690         public function setCliArg( $offset, $value ) {
 691                 PHPUnitMaintClass::$additionalOptions[$offset] = $value;
 692         }
 693
 694         /**
 695          * Don't throw a warning if $function is deprecated and called later
 696          *
 697          * @since 1.19
 698          *
 699          * @param string $function
 700          */
 701         public function hideDeprecated( $function ) {
 702                 wfSuppressWarnings();
 703                 wfDeprecated( $function );
 704                 wfRestoreWarnings();
 705         }
 706
 707         /**
 708          * Asserts that the given database query yields the rows given by $expectedRows.
 709          * The expected rows should be given as indexed (not associative) arrays, with
 710          * the values given in the order of the columns in the $fields parameter.
 711          * Note that the rows are sorted by the columns given in $fields.
 712          *
 713          * @since 1.20
 714          *
 715          * @param string|array $table The table(s) to query
 716          * @param string|array $fields The columns to include in the result (and to sort by)
 717          * @param string|array $condition "where" condition(s)
 718          * @param array $expectedRows An array of arrays giving the expected rows.
 719          *
 720          * @throws MWException If this test cases's needsDB() method doesn't return true.
 721          *         Test cases can use "@group Database" to enable database test support,
 722          *         or list the tables under testing in $this->tablesUsed, or override the
 723          *         needsDB() method.
 724          */
 725         protected function assertSelect( $table, $fields, $condition, array $expectedRows ) {
 726                 if ( !$this->needsDB() ) {
 727                         throw new MWException( 'When testing database state, the test cases\'s needDB()' .
 728                                 ' method should return true. Use @group Database or $this->tablesUsed.' );
 729                 }
 730
 731                 $db = wfGetDB( DB_SLAVE );
 732
 733                 $res = $db->select( $table, $fields, $condition, wfGetCaller(), array( 'ORDER BY' => $fields ) );
 734                 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
 735
 736                 $i = 0;
 737
 738                 foreach ( $expectedRows as $expected ) {
 739                         $r = $res->fetchRow();
 740                         self::stripStringKeys( $r );
 741
 742                         $i += 1;
 743                         $this->assertNotEmpty( $r, "row #$i missing" );
 744
 745                         $this->assertEquals( $expected, $r, "row #$i mismatches" );
 746                 }
 747
 748                 $r = $res->fetchRow();
 749                 self::stripStringKeys( $r );
 750
 751                 $this->assertFalse( $r, "found extra row (after #$i)" );
 752         }
 753
 754         /**
 755          * Utility method taking an array of elements and wrapping
 756          * each element in it's own array. Useful for data providers
 757          * that only return a single argument.
 758          *
 759          * @since 1.20
 760          *
 761          * @param array $elements
 762          *
 763          * @return array
 764          */
 765         protected function arrayWrap( array $elements ) {
 766                 return array_map(
 767                         function ( $element ) {
 768                                 return array( $element );
 769                         },
 770                         $elements
 771                 );
 772         }
 773
 774         /**
 775          * Assert that two arrays are equal. By default this means that both arrays need to hold
 776          * the same set of values. Using additional arguments, order and associated key can also
 777          * be set as relevant.
 778          *
 779          * @since 1.20
 780          *
 781          * @param array $expected
 782          * @param array $actual
 783          * @param bool $ordered If the order of the values should match
 784          * @param bool $named If the keys should match
 785          */
 786         protected function assertArrayEquals( array $expected, array $actual,
 787                 $ordered = false, $named = false
 788         ) {
 789                 if ( !$ordered ) {
 790                         $this->objectAssociativeSort( $expected );
 791                         $this->objectAssociativeSort( $actual );
 792                 }
 793
 794                 if ( !$named ) {
 795                         $expected = array_values( $expected );
 796                         $actual = array_values( $actual );
 797                 }
 798
 799                 call_user_func_array(
 800                         array( $this, 'assertEquals' ),
 801                         array_merge( array( $expected, $actual ), array_slice( func_get_args(), 4 ) )
 802                 );
 803         }
 804
 805         /**
 806          * Put each HTML element on its own line and then equals() the results
 807          *
 808          * Use for nicely formatting of PHPUnit diff output when comparing very
 809          * simple HTML
 810          *
 811          * @since 1.20
 812          *
 813          * @param string $expected HTML on oneline
 814          * @param string $actual HTML on oneline
 815          * @param string $msg Optional message
 816          */
 817         protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
 818                 $expected = str_replace( '>', ">\n", $expected );
 819                 $actual = str_replace( '>', ">\n", $actual );
 820
 821                 $this->assertEquals( $expected, $actual, $msg );
 822         }
 823
 824         /**
 825          * Does an associative sort that works for objects.
 826          *
 827          * @since 1.20
 828          *
 829          * @param array $array
 830          */
 831         protected function objectAssociativeSort( array &$array ) {
 832                 uasort(
 833                         $array,
 834                         function ( $a, $b ) {
 835                                 return serialize( $a ) > serialize( $b ) ? 1 : -1;
 836                         }
 837                 );
 838         }
 839
 840         /**
 841          * Utility function for eliminating all string keys from an array.
 842          * Useful to turn a database result row as returned by fetchRow() into
 843          * a pure indexed array.
 844          *
 845          * @since 1.20
 846          *
 847          * @param mixed $r The array to remove string keys from.
 848          */
 849         protected static function stripStringKeys( &$r ) {
 850                 if ( !is_array( $r ) ) {
 851                         return;
 852                 }
 853
 854                 foreach ( $r as $k => $v ) {
 855                         if ( is_string( $k ) ) {
 856                                 unset( $r[$k] );
 857                         }
 858                 }
 859         }
 860
 861         /**
 862          * Asserts that the provided variable is of the specified
 863          * internal type or equals the $value argument. This is useful
 864          * for testing return types of functions that return a certain
 865          * type or *value* when not set or on error.
 866          *
 867          * @since 1.20
 868          *
 869          * @param string $type
 870          * @param mixed $actual
 871          * @param mixed $value
 872          * @param string $message
 873          */
 874         protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
 875                 if ( $actual === $value ) {
 876                         $this->assertTrue( true, $message );
 877                 } else {
 878                         $this->assertType( $type, $actual, $message );
 879                 }
 880         }
 881
 882         /**
 883          * Asserts the type of the provided value. This can be either
 884          * in internal type such as boolean or integer, or a class or
 885          * interface the value extends or implements.
 886          *
 887          * @since 1.20
 888          *
 889          * @param string $type
 890          * @param mixed $actual
 891          * @param string $message
 892          */
 893         protected function assertType( $type, $actual, $message = '' ) {
 894                 if ( class_exists( $type ) || interface_exists( $type ) ) {
 895                         $this->assertInstanceOf( $type, $actual, $message );
 896                 } else {
 897                         $this->assertInternalType( $type, $actual, $message );
 898                 }
 899         }
 900
 901         /**
 902          * Returns true if the given namespace defaults to Wikitext
 903          * according to $wgNamespaceContentModels
 904          *
 905          * @param int $ns The namespace ID to check
 906          *
 907          * @return bool
 908          * @since 1.21
 909          */
 910         protected function isWikitextNS( $ns ) {
 911                 global $wgNamespaceContentModels;
 912
 913                 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
 914                         return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT;
 915                 }
 916
 917                 return true;
 918         }
 919
 920         /**
 921          * Returns the ID of a namespace that defaults to Wikitext.
 922          *
 923          * @throws MWException If there is none.
 924          * @return int The ID of the wikitext Namespace
 925          * @since 1.21
 926          */
 927         protected function getDefaultWikitextNS() {
 928                 global $wgNamespaceContentModels;
 929
 930                 static $wikitextNS = null; // this is not going to change
 931                 if ( $wikitextNS !== null ) {
 932                         return $wikitextNS;
 933                 }
 934
 935                 // quickly short out on most common case:
 936                 if ( !isset( $wgNamespaceContentModels[NS_MAIN] ) ) {
 937                         return NS_MAIN;
 938                 }
 939
 940                 // NOTE: prefer content namespaces
 941                 $namespaces = array_unique( array_merge(
 942                         MWNamespace::getContentNamespaces(),
 943                         array( NS_MAIN, NS_HELP, NS_PROJECT ), // prefer these
 944                         MWNamespace::getValidNamespaces()
 945                 ) );
 946
 947                 $namespaces = array_diff( $namespaces, array(
 948                         NS_FILE, NS_CATEGORY, NS_MEDIAWIKI, NS_USER // don't mess with magic namespaces
 949                 ) );
 950
 951                 $talk = array_filter( $namespaces, function ( $ns ) {
 952                         return MWNamespace::isTalk( $ns );
 953                 } );
 954
 955                 // prefer non-talk pages
 956                 $namespaces = array_diff( $namespaces, $talk );
 957                 $namespaces = array_merge( $namespaces, $talk );
 958
 959                 // check default content model of each namespace
 960                 foreach ( $namespaces as $ns ) {
 961                         if ( !isset( $wgNamespaceContentModels[$ns] ) ||
 962                                 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
 963                         ) {
 964
 965                                 $wikitextNS = $ns;
 966
 967                                 return $wikitextNS;
 968                         }
 969                 }
 970
 971                 // give up
 972                 // @todo Inside a test, we could skip the test as incomplete.
 973                 //        But frequently, this is used in fixture setup.
 974                 throw new MWException( "No namespace defaults to wikitext!" );
 975         }
 976
 977         /**
 978          * Check, if $wgDiff3 is set and ready to merge
 979          * Will mark the calling test as skipped, if not ready
 980          *
 981          * @since 1.21
 982          */
 983         protected function checkHasDiff3() {
 984                 global $wgDiff3;
 985
 986                 # This check may also protect against code injection in
 987                 # case of broken installations.
 988                 wfSuppressWarnings();
 989                 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
 990                 wfRestoreWarnings();
 991
 992                 if ( !$haveDiff3 ) {
 993                         $this->markTestSkipped( "Skip test, since diff3 is not configured" );
 994                 }
 995         }
 996
 997         /**
 998          * Check whether we have the 'gzip' commandline utility, will skip
 999          * the test whenever "gzip -V" fails.
1000          *
1001          * Result is cached at the process level.
1002          *
1003          * @return bool
1004          *
1005          * @since 1.21
1006          */
1007         protected function checkHasGzip() {
1008                 static $haveGzip;
1009
1010                 if ( $haveGzip === null ) {
1011                         $retval = null;
1012                         wfShellExec( 'gzip -V', $retval );
1013                         $haveGzip = ( $retval === 0 );
1014                 }
1015
1016                 if ( !$haveGzip ) {
1017                         $this->markTestSkipped( "Skip test, requires the gzip utility in PATH" );
1018                 }
1019
1020                 return $haveGzip;
1021         }
1022
1023         /**
1024          * Check if $extName is a loaded PHP extension, will skip the
1025          * test whenever it is not loaded.
1026          *
1027          * @since 1.21
1028          * @param string $extName
1029          * @return bool
1030          */
1031         protected function checkPHPExtension( $extName ) {
1032                 $loaded = extension_loaded( $extName );
1033                 if ( !$loaded ) {
1034                         $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
1035                 }
1036
1037                 return $loaded;
1038         }
1039
1040         /**
1041          * Asserts that an exception of the specified type occurs when running
1042          * the provided code.
1043          *
1044          * @since 1.21
1045          * @deprecated since 1.22 Use setExpectedException
1046          *
1047          * @param callable $code
1048          * @param string $expected
1049          * @param string $message
1050          */
1051         protected function assertException( $code, $expected = 'Exception', $message = '' ) {
1052                 $pokemons = null;
1053
1054                 try {
1055                         call_user_func( $code );
1056                 } catch ( Exception $pokemons ) {
1057                         // Gotta Catch 'Em All!
1058                 }
1059
1060                 if ( $message === '' ) {
1061                         $message = 'An exception of type "' . $expected . '" should have been thrown';
1062                 }
1063
1064                 $this->assertInstanceOf( $expected, $pokemons, $message );
1065         }
1066
1067         /**
1068          * Asserts that the given string is a valid HTML snippet.
1069          * Wraps the given string in the required top level tags and
1070          * then calls assertValidHtmlDocument().
1071          * The snippet is expected to be HTML 5.
1072          *
1073          * @since 1.23
1074          *
1075          * @note Will mark the test as skipped if the "tidy" module is not installed.
1076          * @note This ignores $wgUseTidy, so we can check for valid HTML even (and especially)
1077          *        when automatic tidying is disabled.
1078          *
1079          * @param string $html An HTML snippet (treated as the contents of the body tag).
1080          */
1081         protected function assertValidHtmlSnippet( $html ) {
1082                 $html = '<!DOCTYPE html><html><head><title>test</title></head><body>' . $html . '</body></html>';
1083                 $this->assertValidHtmlDocument( $html );
1084         }
1085
1086         /**
1087          * Asserts that the given string is valid HTML document.
1088          *
1089          * @since 1.23
1090          *
1091          * @note Will mark the test as skipped if the "tidy" module is not installed.
1092          * @note This ignores $wgUseTidy, so we can check for valid HTML even (and especially)
1093          *        when automatic tidying is disabled.
1094          *
1095          * @param string $html A complete HTML document
1096          */
1097         protected function assertValidHtmlDocument( $html ) {
1098                 // Note: we only validate if the tidy PHP extension is available.
1099                 // In case wgTidyInternal is false, MWTidy would fall back to the command line version
1100                 // of tidy. In that case however, we can not reliably detect whether a failing validation
1101                 // is due to malformed HTML, or caused by tidy not being installed as a command line tool.
1102                 // That would cause all HTML assertions to fail on a system that has no tidy installed.
1103                 if ( !$GLOBALS['wgTidyInternal'] ) {
1104                         $this->markTestSkipped( 'Tidy extension not installed' );
1105                 }
1106
1107                 $errorBuffer = '';
1108                 MWTidy::checkErrors( $html, $errorBuffer );
1109                 $allErrors = preg_split( '/[\r\n]+/', $errorBuffer );
1110
1111                 // Filter Tidy warnings which aren't useful for us.
1112                 // Tidy eg. often cries about parameters missing which have actually
1113                 // been deprecated since HTML4, thus we should not care about them.
1114                 $errors = preg_grep(
1115                         '/^(.*Warning: (trimming empty|.* lacks ".*?" attribute).*|\s*)$/m',
1116                         $allErrors, PREG_GREP_INVERT
1117                 );
1118
1119                 $this->assertEmpty( $errors, implode( "\n", $errors ) );
1120         }
1121
1122         /**
1123          * Note: we are overriding this method to remove the deprecated error
1124          * @see https://bugzilla.wikimedia.org/show_bug.cgi?id=69505
1125          * @see https://github.com/sebastianbergmann/phpunit/issues/1292
1126          *
1127          * @param array $matcher
1128          * @param string $actual
1129          * @param string $message
1130          * @param bool $isHtml
1131          */
1132         public static function assertTag( $matcher, $actual, $message = '', $isHtml = true ) {
1133                 //trigger_error(__METHOD__ . ' is deprecated', E_USER_DEPRECATED);
1134
1135                 $dom = PHPUnit_Util_XML::load( $actual, $isHtml );
1136                 $tags = PHPUnit_Util_XML::findNodes( $dom, $matcher, $isHtml );
1137                 $matched = count( $tags ) > 0 && $tags[0] instanceof DOMNode;
1138
1139                 self::assertTrue( $matched, $message );
1140         }
1141 }