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          * Insert a new page.
 433          *
 434          * Should be called from addDBData().
 435          *
 436          * @since 1.25
 437          * @param string $pageName Page name
 438          * @param string $text Page's content
 439          * @return array Title object and page id
 440          */
 441         protected function insertPage( $pageName, $text = 'Sample page for unit test.' ) {
 442                 $title = Title::newFromText( $pageName, 0 );
 443
 444                 $user = User::newFromName( 'WikiSysop' );
 445                 $comment = __METHOD__ . ': Sample page for unit test.';
 446
 447                 // Avoid memory leak...?
 448                 LinkCache::singleton()->clear();
 449
 450                 $page = WikiPage::factory( $title );
 451                 $page->doEditContent( ContentHandler::makeContent( $text, $title ), $comment, 0, false, $user );
 452
 453                 return array(
 454                         'title' => $title,
 455                         'id' => $page->getId(),
 456                 );
 457         }
 458
 459         /**
 460          * Stub. If a test needs to add additional data to the database, it should
 461          * implement this method and do so
 462          *
 463          * @since 1.18
 464          */
 465         public function addDBData() {
 466         }
 467
 468         private function addCoreDBData() {
 469                 if ( $this->db->getType() == 'oracle' ) {
 470
 471                         # Insert 0 user to prevent FK violations
 472                         # Anonymous user
 473                         $this->db->insert( 'user', array(
 474                                 'user_id' => 0,
 475                                 'user_name' => 'Anonymous' ), __METHOD__, array( 'IGNORE' ) );
 476
 477                         # Insert 0 page to prevent FK violations
 478                         # Blank page
 479                         $this->db->insert( 'page', array(
 480                                 'page_id' => 0,
 481                                 'page_namespace' => 0,
 482                                 'page_title' => ' ',
 483                                 'page_restrictions' => null,
 484                                 'page_counter' => 0,
 485                                 'page_is_redirect' => 0,
 486                                 'page_is_new' => 0,
 487                                 'page_random' => 0,
 488                                 'page_touched' => $this->db->timestamp(),
 489                                 'page_latest' => 0,
 490                                 'page_len' => 0 ), __METHOD__, array( 'IGNORE' ) );
 491                 }
 492
 493                 User::resetIdByNameCache();
 494
 495                 // Make sysop user
 496                 $user = User::newFromName( 'UTSysop' );
 497
 498                 if ( $user->idForName() == 0 ) {
 499                         $user->addToDatabase();
 500                         $user->setPassword( 'UTSysopPassword' );
 501
 502                         $user->addGroup( 'sysop' );
 503                         $user->addGroup( 'bureaucrat' );
 504                         $user->saveSettings();
 505                 }
 506
 507                 // Make 1 page with 1 revision
 508                 $page = WikiPage::factory( Title::newFromText( 'UTPage' ) );
 509                 if ( $page->getId() == 0 ) {
 510                         $page->doEditContent(
 511                                 new WikitextContent( 'UTContent' ),
 512                                 'UTPageSummary',
 513                                 EDIT_NEW,
 514                                 false,
 515                                 User::newFromName( 'UTSysop' )
 516                         );
 517                 }
 518         }
 519
 520         /**
 521          * Restores MediaWiki to using the table set (table prefix) it was using before
 522          * setupTestDB() was called. Useful if we need to perform database operations
 523          * after the test run has finished (such as saving logs or profiling info).
 524          *
 525          * @since 1.21
 526          */
 527         public static function teardownTestDB() {
 528                 if ( !self::$dbSetup ) {
 529                         return;
 530                 }
 531
 532                 CloneDatabase::changePrefix( self::$oldTablePrefix );
 533
 534                 self::$oldTablePrefix = false;
 535                 self::$dbSetup = false;
 536         }
 537
 538         /**
 539          * Creates an empty skeleton of the wiki database by cloning its structure
 540          * to equivalent tables using the given $prefix. Then sets MediaWiki to
 541          * use the new set of tables (aka schema) instead of the original set.
 542          *
 543          * This is used to generate a dummy table set, typically consisting of temporary
 544          * tables, that will be used by tests instead of the original wiki database tables.
 545          *
 546          * @since 1.21
 547          *
 548          * @note the original table prefix is stored in self::$oldTablePrefix. This is used
 549          * by teardownTestDB() to return the wiki to using the original table set.
 550          *
 551          * @note this method only works when first called. Subsequent calls have no effect,
 552          * even if using different parameters.
 553          *
 554          * @param DatabaseBase $db The database connection
 555          * @param string $prefix The prefix to use for the new table set (aka schema).
 556          *
 557          * @throws MWException If the database table prefix is already $prefix
 558          */
 559         public static function setupTestDB( DatabaseBase $db, $prefix ) {
 560                 global $wgDBprefix;
 561                 if ( $wgDBprefix === $prefix ) {
 562                         throw new MWException(
 563                                 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
 564                 }
 565
 566                 if ( self::$dbSetup ) {
 567                         return;
 568                 }
 569
 570                 $tablesCloned = self::listTables( $db );
 571                 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix );
 572                 $dbClone->useTemporaryTables( self::$useTemporaryTables );
 573
 574                 self::$dbSetup = true;
 575                 self::$oldTablePrefix = $wgDBprefix;
 576
 577                 if ( ( $db->getType() == 'oracle' || !self::$useTemporaryTables ) && self::$reuseDB ) {
 578                         CloneDatabase::changePrefix( $prefix );
 579
 580                         return;
 581                 } else {
 582                         $dbClone->cloneTableStructure();
 583                 }
 584
 585                 if ( $db->getType() == 'oracle' ) {
 586                         $db->query( 'BEGIN FILL_WIKI_INFO; END;' );
 587                 }
 588         }
 589
 590         /**
 591          * Empty all tables so they can be repopulated for tests
 592          */
 593         private function resetDB() {
 594                 if ( $this->db ) {
 595                         if ( $this->db->getType() == 'oracle' ) {
 596                                 if ( self::$useTemporaryTables ) {
 597                                         wfGetLB()->closeAll();
 598                                         $this->db = wfGetDB( DB_MASTER );
 599                                 } else {
 600                                         foreach ( $this->tablesUsed as $tbl ) {
 601                                                 if ( $tbl == 'interwiki' ) {
 602                                                         continue;
 603                                                 }
 604                                                 $this->db->query( 'TRUNCATE TABLE ' . $this->db->tableName( $tbl ), __METHOD__ );
 605                                         }
 606                                 }
 607                         } else {
 608                                 foreach ( $this->tablesUsed as $tbl ) {
 609                                         if ( $tbl == 'interwiki' || $tbl == 'user' ) {
 610                                                 continue;
 611                                         }
 612                                         $this->db->delete( $tbl, '*', __METHOD__ );
 613                                 }
 614                         }
 615                 }
 616         }
 617
 618         /**
 619          * @since 1.18
 620          *
 621          * @param string $func
 622          * @param array $args
 623          *
 624          * @return mixed
 625          * @throws MWException
 626          */
 627         public function __call( $func, $args ) {
 628                 static $compatibility = array(
 629                         'assertEmpty' => 'assertEmpty2', // assertEmpty was added in phpunit 3.7.32
 630                 );
 631
 632                 if ( isset( $compatibility[$func] ) ) {
 633                         return call_user_func_array( array( $this, $compatibility[$func] ), $args );
 634                 } else {
 635                         throw new MWException( "Called non-existant $func method on "
 636                                 . get_class( $this ) );
 637                 }
 638         }
 639
 640         /**
 641          * Used as a compatibility method for phpunit < 3.7.32
 642          * @param string $value
 643          * @param string $msg
 644          */
 645         private function assertEmpty2( $value, $msg ) {
 646                 return $this->assertTrue( $value == '', $msg );
 647         }
 648
 649         private static function unprefixTable( $tableName ) {
 650                 global $wgDBprefix;
 651
 652                 return substr( $tableName, strlen( $wgDBprefix ) );
 653         }
 654
 655         private static function isNotUnittest( $table ) {
 656                 return strpos( $table, 'unittest_' ) !== 0;
 657         }
 658
 659         /**
 660          * @since 1.18
 661          *
 662          * @param DataBaseBase $db
 663          *
 664          * @return array
 665          */
 666         public static function listTables( $db ) {
 667                 global $wgDBprefix;
 668
 669                 $tables = $db->listTables( $wgDBprefix, __METHOD__ );
 670
 671                 if ( $db->getType() === 'mysql' ) {
 672                         # bug 43571: cannot clone VIEWs under MySQL
 673                         $views = $db->listViews( $wgDBprefix, __METHOD__ );
 674                         $tables = array_diff( $tables, $views );
 675                 }
 676                 $tables = array_map( array( __CLASS__, 'unprefixTable' ), $tables );
 677
 678                 // Don't duplicate test tables from the previous fataled run
 679                 $tables = array_filter( $tables, array( __CLASS__, 'isNotUnittest' ) );
 680
 681                 if ( $db->getType() == 'sqlite' ) {
 682                         $tables = array_flip( $tables );
 683                         // these are subtables of searchindex and don't need to be duped/dropped separately
 684                         unset( $tables['searchindex_content'] );
 685                         unset( $tables['searchindex_segdir'] );
 686                         unset( $tables['searchindex_segments'] );
 687                         $tables = array_flip( $tables );
 688                 }
 689
 690                 return $tables;
 691         }
 692
 693         /**
 694          * @throws MWException
 695          * @since 1.18
 696          */
 697         protected function checkDbIsSupported() {
 698                 if ( !in_array( $this->db->getType(), $this->supportedDBs ) ) {
 699                         throw new MWException( $this->db->getType() . " is not currently supported for unit testing." );
 700                 }
 701         }
 702
 703         /**
 704          * @since 1.18
 705          * @param string $offset
 706          * @return mixed
 707          */
 708         public function getCliArg( $offset ) {
 709                 if ( isset( PHPUnitMaintClass::$additionalOptions[$offset] ) ) {
 710                         return PHPUnitMaintClass::$additionalOptions[$offset];
 711                 }
 712         }
 713
 714         /**
 715          * @since 1.18
 716          * @param string $offset
 717          * @param mixed $value
 718          */
 719         public function setCliArg( $offset, $value ) {
 720                 PHPUnitMaintClass::$additionalOptions[$offset] = $value;
 721         }
 722
 723         /**
 724          * Don't throw a warning if $function is deprecated and called later
 725          *
 726          * @since 1.19
 727          *
 728          * @param string $function
 729          */
 730         public function hideDeprecated( $function ) {
 731                 wfSuppressWarnings();
 732                 wfDeprecated( $function );
 733                 wfRestoreWarnings();
 734         }
 735
 736         /**
 737          * Asserts that the given database query yields the rows given by $expectedRows.
 738          * The expected rows should be given as indexed (not associative) arrays, with
 739          * the values given in the order of the columns in the $fields parameter.
 740          * Note that the rows are sorted by the columns given in $fields.
 741          *
 742          * @since 1.20
 743          *
 744          * @param string|array $table The table(s) to query
 745          * @param string|array $fields The columns to include in the result (and to sort by)
 746          * @param string|array $condition "where" condition(s)
 747          * @param array $expectedRows An array of arrays giving the expected rows.
 748          *
 749          * @throws MWException If this test cases's needsDB() method doesn't return true.
 750          *         Test cases can use "@group Database" to enable database test support,
 751          *         or list the tables under testing in $this->tablesUsed, or override the
 752          *         needsDB() method.
 753          */
 754         protected function assertSelect( $table, $fields, $condition, array $expectedRows ) {
 755                 if ( !$this->needsDB() ) {
 756                         throw new MWException( 'When testing database state, the test cases\'s needDB()' .
 757                                 ' method should return true. Use @group Database or $this->tablesUsed.' );
 758                 }
 759
 760                 $db = wfGetDB( DB_SLAVE );
 761
 762                 $res = $db->select( $table, $fields, $condition, wfGetCaller(), array( 'ORDER BY' => $fields ) );
 763                 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
 764
 765                 $i = 0;
 766
 767                 foreach ( $expectedRows as $expected ) {
 768                         $r = $res->fetchRow();
 769                         self::stripStringKeys( $r );
 770
 771                         $i += 1;
 772                         $this->assertNotEmpty( $r, "row #$i missing" );
 773
 774                         $this->assertEquals( $expected, $r, "row #$i mismatches" );
 775                 }
 776
 777                 $r = $res->fetchRow();
 778                 self::stripStringKeys( $r );
 779
 780                 $this->assertFalse( $r, "found extra row (after #$i)" );
 781         }
 782
 783         /**
 784          * Utility method taking an array of elements and wrapping
 785          * each element in it's own array. Useful for data providers
 786          * that only return a single argument.
 787          *
 788          * @since 1.20
 789          *
 790          * @param array $elements
 791          *
 792          * @return array
 793          */
 794         protected function arrayWrap( array $elements ) {
 795                 return array_map(
 796                         function ( $element ) {
 797                                 return array( $element );
 798                         },
 799                         $elements
 800                 );
 801         }
 802
 803         /**
 804          * Assert that two arrays are equal. By default this means that both arrays need to hold
 805          * the same set of values. Using additional arguments, order and associated key can also
 806          * be set as relevant.
 807          *
 808          * @since 1.20
 809          *
 810          * @param array $expected
 811          * @param array $actual
 812          * @param bool $ordered If the order of the values should match
 813          * @param bool $named If the keys should match
 814          */
 815         protected function assertArrayEquals( array $expected, array $actual,
 816                 $ordered = false, $named = false
 817         ) {
 818                 if ( !$ordered ) {
 819                         $this->objectAssociativeSort( $expected );
 820                         $this->objectAssociativeSort( $actual );
 821                 }
 822
 823                 if ( !$named ) {
 824                         $expected = array_values( $expected );
 825                         $actual = array_values( $actual );
 826                 }
 827
 828                 call_user_func_array(
 829                         array( $this, 'assertEquals' ),
 830                         array_merge( array( $expected, $actual ), array_slice( func_get_args(), 4 ) )
 831                 );
 832         }
 833
 834         /**
 835          * Put each HTML element on its own line and then equals() the results
 836          *
 837          * Use for nicely formatting of PHPUnit diff output when comparing very
 838          * simple HTML
 839          *
 840          * @since 1.20
 841          *
 842          * @param string $expected HTML on oneline
 843          * @param string $actual HTML on oneline
 844          * @param string $msg Optional message
 845          */
 846         protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
 847                 $expected = str_replace( '>', ">\n", $expected );
 848                 $actual = str_replace( '>', ">\n", $actual );
 849
 850                 $this->assertEquals( $expected, $actual, $msg );
 851         }
 852
 853         /**
 854          * Does an associative sort that works for objects.
 855          *
 856          * @since 1.20
 857          *
 858          * @param array $array
 859          */
 860         protected function objectAssociativeSort( array &$array ) {
 861                 uasort(
 862                         $array,
 863                         function ( $a, $b ) {
 864                                 return serialize( $a ) > serialize( $b ) ? 1 : -1;
 865                         }
 866                 );
 867         }
 868
 869         /**
 870          * Utility function for eliminating all string keys from an array.
 871          * Useful to turn a database result row as returned by fetchRow() into
 872          * a pure indexed array.
 873          *
 874          * @since 1.20
 875          *
 876          * @param mixed $r The array to remove string keys from.
 877          */
 878         protected static function stripStringKeys( &$r ) {
 879                 if ( !is_array( $r ) ) {
 880                         return;
 881                 }
 882
 883                 foreach ( $r as $k => $v ) {
 884                         if ( is_string( $k ) ) {
 885                                 unset( $r[$k] );
 886                         }
 887                 }
 888         }
 889
 890         /**
 891          * Asserts that the provided variable is of the specified
 892          * internal type or equals the $value argument. This is useful
 893          * for testing return types of functions that return a certain
 894          * type or *value* when not set or on error.
 895          *
 896          * @since 1.20
 897          *
 898          * @param string $type
 899          * @param mixed $actual
 900          * @param mixed $value
 901          * @param string $message
 902          */
 903         protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
 904                 if ( $actual === $value ) {
 905                         $this->assertTrue( true, $message );
 906                 } else {
 907                         $this->assertType( $type, $actual, $message );
 908                 }
 909         }
 910
 911         /**
 912          * Asserts the type of the provided value. This can be either
 913          * in internal type such as boolean or integer, or a class or
 914          * interface the value extends or implements.
 915          *
 916          * @since 1.20
 917          *
 918          * @param string $type
 919          * @param mixed $actual
 920          * @param string $message
 921          */
 922         protected function assertType( $type, $actual, $message = '' ) {
 923                 if ( class_exists( $type ) || interface_exists( $type ) ) {
 924                         $this->assertInstanceOf( $type, $actual, $message );
 925                 } else {
 926                         $this->assertInternalType( $type, $actual, $message );
 927                 }
 928         }
 929
 930         /**
 931          * Returns true if the given namespace defaults to Wikitext
 932          * according to $wgNamespaceContentModels
 933          *
 934          * @param int $ns The namespace ID to check
 935          *
 936          * @return bool
 937          * @since 1.21
 938          */
 939         protected function isWikitextNS( $ns ) {
 940                 global $wgNamespaceContentModels;
 941
 942                 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
 943                         return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT;
 944                 }
 945
 946                 return true;
 947         }
 948
 949         /**
 950          * Returns the ID of a namespace that defaults to Wikitext.
 951          *
 952          * @throws MWException If there is none.
 953          * @return int The ID of the wikitext Namespace
 954          * @since 1.21
 955          */
 956         protected function getDefaultWikitextNS() {
 957                 global $wgNamespaceContentModels;
 958
 959                 static $wikitextNS = null; // this is not going to change
 960                 if ( $wikitextNS !== null ) {
 961                         return $wikitextNS;
 962                 }
 963
 964                 // quickly short out on most common case:
 965                 if ( !isset( $wgNamespaceContentModels[NS_MAIN] ) ) {
 966                         return NS_MAIN;
 967                 }
 968
 969                 // NOTE: prefer content namespaces
 970                 $namespaces = array_unique( array_merge(
 971                         MWNamespace::getContentNamespaces(),
 972                         array( NS_MAIN, NS_HELP, NS_PROJECT ), // prefer these
 973                         MWNamespace::getValidNamespaces()
 974                 ) );
 975
 976                 $namespaces = array_diff( $namespaces, array(
 977                         NS_FILE, NS_CATEGORY, NS_MEDIAWIKI, NS_USER // don't mess with magic namespaces
 978                 ) );
 979
 980                 $talk = array_filter( $namespaces, function ( $ns ) {
 981                         return MWNamespace::isTalk( $ns );
 982                 } );
 983
 984                 // prefer non-talk pages
 985                 $namespaces = array_diff( $namespaces, $talk );
 986                 $namespaces = array_merge( $namespaces, $talk );
 987
 988                 // check default content model of each namespace
 989                 foreach ( $namespaces as $ns ) {
 990                         if ( !isset( $wgNamespaceContentModels[$ns] ) ||
 991                                 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
 992                         ) {
 993
 994                                 $wikitextNS = $ns;
 995
 996                                 return $wikitextNS;
 997                         }
 998                 }
 999
1000                 // give up
1001                 // @todo Inside a test, we could skip the test as incomplete.
1002                 //        But frequently, this is used in fixture setup.
1003                 throw new MWException( "No namespace defaults to wikitext!" );
1004         }
1005
1006         /**
1007          * Check, if $wgDiff3 is set and ready to merge
1008          * Will mark the calling test as skipped, if not ready
1009          *
1010          * @since 1.21
1011          */
1012         protected function checkHasDiff3() {
1013                 global $wgDiff3;
1014
1015                 # This check may also protect against code injection in
1016                 # case of broken installations.
1017                 wfSuppressWarnings();
1018                 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
1019                 wfRestoreWarnings();
1020
1021                 if ( !$haveDiff3 ) {
1022                         $this->markTestSkipped( "Skip test, since diff3 is not configured" );
1023                 }
1024         }
1025
1026         /**
1027          * Check whether we have the 'gzip' commandline utility, will skip
1028          * the test whenever "gzip -V" fails.
1029          *
1030          * Result is cached at the process level.
1031          *
1032          * @return bool
1033          *
1034          * @since 1.21
1035          */
1036         protected function checkHasGzip() {
1037                 static $haveGzip;
1038
1039                 if ( $haveGzip === null ) {
1040                         $retval = null;
1041                         wfShellExec( 'gzip -V', $retval );
1042                         $haveGzip = ( $retval === 0 );
1043                 }
1044
1045                 if ( !$haveGzip ) {
1046                         $this->markTestSkipped( "Skip test, requires the gzip utility in PATH" );
1047                 }
1048
1049                 return $haveGzip;
1050         }
1051
1052         /**
1053          * Check if $extName is a loaded PHP extension, will skip the
1054          * test whenever it is not loaded.
1055          *
1056          * @since 1.21
1057          * @param string $extName
1058          * @return bool
1059          */
1060         protected function checkPHPExtension( $extName ) {
1061                 $loaded = extension_loaded( $extName );
1062                 if ( !$loaded ) {
1063                         $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
1064                 }
1065
1066                 return $loaded;
1067         }
1068
1069         /**
1070          * Asserts that an exception of the specified type occurs when running
1071          * the provided code.
1072          *
1073          * @since 1.21
1074          * @deprecated since 1.22 Use setExpectedException
1075          *
1076          * @param callable $code
1077          * @param string $expected
1078          * @param string $message
1079          */
1080         protected function assertException( $code, $expected = 'Exception', $message = '' ) {
1081                 $pokemons = null;
1082
1083                 try {
1084                         call_user_func( $code );
1085                 } catch ( Exception $pokemons ) {
1086                         // Gotta Catch 'Em All!
1087                 }
1088
1089                 if ( $message === '' ) {
1090                         $message = 'An exception of type "' . $expected . '" should have been thrown';
1091                 }
1092
1093                 $this->assertInstanceOf( $expected, $pokemons, $message );
1094         }
1095
1096         /**
1097          * Asserts that the given string is a valid HTML snippet.
1098          * Wraps the given string in the required top level tags and
1099          * then calls assertValidHtmlDocument().
1100          * The snippet is expected to be HTML 5.
1101          *
1102          * @since 1.23
1103          *
1104          * @note Will mark the test as skipped if the "tidy" module is not installed.
1105          * @note This ignores $wgUseTidy, so we can check for valid HTML even (and especially)
1106          *        when automatic tidying is disabled.
1107          *
1108          * @param string $html An HTML snippet (treated as the contents of the body tag).
1109          */
1110         protected function assertValidHtmlSnippet( $html ) {
1111                 $html = '<!DOCTYPE html><html><head><title>test</title></head><body>' . $html . '</body></html>';
1112                 $this->assertValidHtmlDocument( $html );
1113         }
1114
1115         /**
1116          * Asserts that the given string is valid HTML document.
1117          *
1118          * @since 1.23
1119          *
1120          * @note Will mark the test as skipped if the "tidy" module is not installed.
1121          * @note This ignores $wgUseTidy, so we can check for valid HTML even (and especially)
1122          *        when automatic tidying is disabled.
1123          *
1124          * @param string $html A complete HTML document
1125          */
1126         protected function assertValidHtmlDocument( $html ) {
1127                 // Note: we only validate if the tidy PHP extension is available.
1128                 // In case wgTidyInternal is false, MWTidy would fall back to the command line version
1129                 // of tidy. In that case however, we can not reliably detect whether a failing validation
1130                 // is due to malformed HTML, or caused by tidy not being installed as a command line tool.
1131                 // That would cause all HTML assertions to fail on a system that has no tidy installed.
1132                 if ( !$GLOBALS['wgTidyInternal'] ) {
1133                         $this->markTestSkipped( 'Tidy extension not installed' );
1134                 }
1135
1136                 $errorBuffer = '';
1137                 MWTidy::checkErrors( $html, $errorBuffer );
1138                 $allErrors = preg_split( '/[\r\n]+/', $errorBuffer );
1139
1140                 // Filter Tidy warnings which aren't useful for us.
1141                 // Tidy eg. often cries about parameters missing which have actually
1142                 // been deprecated since HTML4, thus we should not care about them.
1143                 $errors = preg_grep(
1144                         '/^(.*Warning: (trimming empty|.* lacks ".*?" attribute).*|\s*)$/m',
1145                         $allErrors, PREG_GREP_INVERT
1146                 );
1147
1148                 $this->assertEmpty( $errors, implode( "\n", $errors ) );
1149         }
1150
1151         /**
1152          * Note: we are overriding this method to remove the deprecated error
1153          * @see https://bugzilla.wikimedia.org/show_bug.cgi?id=69505
1154          * @see https://github.com/sebastianbergmann/phpunit/issues/1292
1155          *
1156          * @param array $matcher
1157          * @param string $actual
1158          * @param string $message
1159          * @param bool $isHtml
1160          */
1161         public static function assertTag( $matcher, $actual, $message = '', $isHtml = true ) {
1162                 //trigger_error(__METHOD__ . ' is deprecated', E_USER_DEPRECATED);
1163
1164                 $dom = PHPUnit_Util_XML::load( $actual, $isHtml );
1165                 $tags = PHPUnit_Util_XML::findNodes( $dom, $matcher, $isHtml );
1166                 $matched = count( $tags ) > 0 && $tags[0] instanceof DOMNode;
1167
1168                 self::assertTrue( $matched, $message );
1169         }
1170 }