tests/phpunit/MediaWikiTestCase.php

   1 <?php
   2
   3 abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase {
   4         public $suite;
   5         public $regex = '';
   6         public $runDisabled = false;
   7
   8         /**
   9          * @var DatabaseBase
  10          */
  11         protected $db;
  12         protected $oldTablePrefix;
  13         protected $useTemporaryTables = true;
  14         protected $reuseDB = false;
  15         protected $tablesUsed = array(); // tables with data
  16
  17         private static $dbSetup = false;
  18
  19         /**
  20          * Holds the paths of temporary files/directories created through getNewTempFile,
  21          * and getNewTempDirectory
  22          *
  23          * @var array
  24          */
  25         private $tmpfiles = array();
  26
  27
  28         /**
  29          * Table name prefixes. Oracle likes it shorter.
  30          */
  31         const DB_PREFIX = 'unittest_';
  32         const ORA_DB_PREFIX = 'ut_';
  33
  34         protected $supportedDBs = array(
  35                 'mysql',
  36                 'sqlite',
  37                 'postgres',
  38                 'oracle'
  39         );
  40
  41         function  __construct( $name = null, array $data = array(), $dataName = '' ) {
  42                 parent::__construct( $name, $data, $dataName );
  43
  44                 $this->backupGlobals = false;
  45                 $this->backupStaticAttributes = false;
  46         }
  47
  48         function run( PHPUnit_Framework_TestResult $result = NULL ) {
  49                 /* Some functions require some kind of caching, and will end up using the db,
  50                  * which we can't allow, as that would open a new connection for mysql.
  51                  * Replace with a HashBag. They would not be going to persist anyway.
  52                  */
  53                 ObjectCache::$instances[CACHE_DB] = new HashBagOStuff;
  54
  55                 if( $this->needsDB() ) {
  56                         global $wgDBprefix;
  57
  58                         $this->useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
  59                         $this->reuseDB = $this->getCliArg('reuse-db');
  60
  61                         $this->db = wfGetDB( DB_MASTER );
  62
  63                         $this->checkDbIsSupported();
  64
  65                         $this->oldTablePrefix = $wgDBprefix;
  66
  67                         if( !self::$dbSetup ) {
  68                                 $this->initDB();
  69                                 self::$dbSetup = true;
  70                         }
  71
  72                         $this->addCoreDBData();
  73                         $this->addDBData();
  74
  75                         parent::run( $result );
  76
  77                         $this->resetDB();
  78                 } else {
  79                         parent::run( $result );
  80                 }
  81         }
  82
  83         /**
  84          * obtains a new temporary file name
  85          *
  86          * The obtained filename is enlisted to be removed upon tearDown
  87          *
  88          * @returns string: absolute name of the temporary file
  89          */
  90         protected function getNewTempFile() {
  91                 $fname = tempnam( wfTempDir(), 'MW_PHPUnit_' . get_class( $this ) . '_' );
  92                 $this->tmpfiles[] = $fname;
  93                 return $fname;
  94         }
  95
  96         /**
  97          * obtains a new temporary directory
  98          *
  99          * The obtained directory is enlisted to be removed (recursively with all its contained
 100          * files) upon tearDown.
 101          *
 102          * @returns string: absolute name of the temporary directory
 103          */
 104         protected function getNewTempDirectory() {
 105                 // Starting of with a temporary /file/.
 106                 $fname = $this->getNewTempFile();
 107
 108                 // Converting the temporary /file/ to a /directory/
 109                 //
 110                 // The following is not atomic, but at least we now have a single place,
 111                 // where temporary directory creation is bundled and can be improved
 112                 unlink( $fname );
 113                 $this->assertTrue( wfMkdirParents( $fname ) );
 114                 return $fname;
 115         }
 116
 117         protected function tearDown() {
 118                 // Cleaning up temoporary files
 119                 foreach ( $this->tmpfiles as $fname ) {
 120                         if ( is_file( $fname ) || ( is_link( $fname ) ) ) {
 121                                 unlink( $fname );
 122                         } elseif ( is_dir( $fname ) ) {
 123                                 wfRecursiveRemoveDir( $fname );
 124                         }
 125                 }
 126
 127                 parent::tearDown();
 128         }
 129
 130         function dbPrefix() {
 131                 return $this->db->getType() == 'oracle' ? self::ORA_DB_PREFIX : self::DB_PREFIX;
 132         }
 133
 134         function needsDB() {
 135                 # if the test says it uses database tables, it needs the database
 136                 if ( $this->tablesUsed ) {
 137                         return true;
 138                 }
 139
 140                 # if the test says it belongs to the Database group, it needs the database
 141                 $rc = new ReflectionClass( $this );
 142                 if ( preg_match( '/@group +Database/im', $rc->getDocComment() ) ) {
 143                         return true;
 144                 }
 145
 146                 return false;
 147         }
 148
 149         /**
 150          * Stub. If a test needs to add additional data to the database, it should
 151          * implement this method and do so
 152          */
 153         function addDBData() {}
 154
 155         private function addCoreDBData() {
 156                 # disabled for performance
 157                 #$this->tablesUsed[] = 'page';
 158                 #$this->tablesUsed[] = 'revision';
 159
 160                 if ( $this->db->getType() == 'oracle' ) {
 161
 162                         # Insert 0 user to prevent FK violations
 163                         # Anonymous user
 164                         $this->db->insert( 'user', array(
 165                                 'user_id'               => 0,
 166                                 'user_name'     => 'Anonymous' ), __METHOD__, array( 'IGNORE' ) );
 167
 168                         # Insert 0 page to prevent FK violations
 169                         # Blank page
 170                         $this->db->insert( 'page', array(
 171                                 'page_id' => 0,
 172                                 'page_namespace' => 0,
 173                                 'page_title' => ' ',
 174                                 'page_restrictions' => NULL,
 175                                 'page_counter' => 0,
 176                                 'page_is_redirect' => 0,
 177                                 'page_is_new' => 0,
 178                                 'page_random' => 0,
 179                                 'page_touched' => $this->db->timestamp(),
 180                                 'page_latest' => 0,
 181                                 'page_len' => 0 ), __METHOD__, array( 'IGNORE' ) );
 182
 183                 }
 184
 185                 User::resetIdByNameCache();
 186
 187                 //Make sysop user
 188                 $user = User::newFromName( 'UTSysop' );
 189
 190                 if ( $user->idForName() == 0 ) {
 191                         $user->addToDatabase();
 192                         $user->setPassword( 'UTSysopPassword' );
 193
 194                         $user->addGroup( 'sysop' );
 195                         $user->addGroup( 'bureaucrat' );
 196                         $user->saveSettings();
 197                 }
 198
 199
 200                 //Make 1 page with 1 revision
 201                 $page = WikiPage::factory( Title::newFromText( 'UTPage' ) );
 202                 if ( !$page->getId() == 0 ) {
 203                         $page->doEdit( 'UTContent',
 204                                                         'UTPageSummary',
 205                                                         EDIT_NEW,
 206                                                         false,
 207                                                         User::newFromName( 'UTSysop' ) );
 208                 }
 209         }
 210
 211         private function initDB() {
 212                 global $wgDBprefix;
 213                 if ( $wgDBprefix === $this->dbPrefix() ) {
 214                         throw new MWException( 'Cannot run unit tests, the database prefix is already "unittest_"' );
 215                 }
 216
 217                 $tablesCloned = $this->listTables();
 218                 $dbClone = new CloneDatabase( $this->db, $tablesCloned, $this->dbPrefix() );
 219                 $dbClone->useTemporaryTables( $this->useTemporaryTables );
 220
 221                 if ( ( $this->db->getType() == 'oracle' || !$this->useTemporaryTables ) && $this->reuseDB ) {
 222                         CloneDatabase::changePrefix( $this->dbPrefix() );
 223                         $this->resetDB();
 224                         return;
 225                 } else {
 226                         $dbClone->cloneTableStructure();
 227                 }
 228
 229                 if ( $this->db->getType() == 'oracle' ) {
 230                         $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' );
 231                 }
 232         }
 233
 234         /**
 235          * Empty all tables so they can be repopulated for tests
 236          */
 237         private function resetDB() {
 238                 if( $this->db ) {
 239                         if ( $this->db->getType() == 'oracle' )  {
 240                                 if ( $this->useTemporaryTables ) {
 241                                         wfGetLB()->closeAll();
 242                                         $this->db = wfGetDB( DB_MASTER );
 243                                 } else {
 244                                         foreach( $this->tablesUsed as $tbl ) {
 245                                                 if( $tbl == 'interwiki') continue;
 246                                                 $this->db->query( 'TRUNCATE TABLE '.$this->db->tableName($tbl), __METHOD__ );
 247                                         }
 248                                 }
 249                         } else {
 250                                 foreach( $this->tablesUsed as $tbl ) {
 251                                         if( $tbl == 'interwiki' || $tbl == 'user' ) continue;
 252                                         $this->db->delete( $tbl, '*', __METHOD__ );
 253                                 }
 254                         }
 255                 }
 256         }
 257
 258         function __call( $func, $args ) {
 259                 static $compatibility = array(
 260                         'assertInternalType' => 'assertType',
 261                         'assertNotInternalType' => 'assertNotType',
 262                         'assertInstanceOf' => 'assertType',
 263                         'assertEmpty' => 'assertEmpty2',
 264                 );
 265
 266                 if ( method_exists( $this->suite, $func ) ) {
 267                         return call_user_func_array( array( $this->suite, $func ), $args);
 268                 } elseif ( isset( $compatibility[$func] ) ) {
 269                         return call_user_func_array( array( $this, $compatibility[$func] ), $args);
 270                 } else {
 271                         throw new MWException( "Called non-existant $func method on "
 272                                 . get_class( $this ) );
 273                 }
 274         }
 275
 276         private function assertEmpty2( $value, $msg ) {
 277                 return $this->assertTrue( $value == '', $msg );
 278         }
 279
 280         static private function unprefixTable( $tableName ) {
 281                 global $wgDBprefix;
 282                 return substr( $tableName, strlen( $wgDBprefix ) );
 283         }
 284
 285         static private function isNotUnittest( $table ) {
 286                 return strpos( $table, 'unittest_' ) !== 0;
 287         }
 288
 289         protected function listTables() {
 290                 global $wgDBprefix;
 291
 292                 $tables = $this->db->listTables( $wgDBprefix, __METHOD__ );
 293                 $tables = array_map( array( __CLASS__, 'unprefixTable' ), $tables );
 294
 295                 // Don't duplicate test tables from the previous fataled run
 296                 $tables = array_filter( $tables, array( __CLASS__, 'isNotUnittest' ) );
 297
 298                 if ( $this->db->getType() == 'sqlite' ) {
 299                         $tables = array_flip( $tables );
 300                         // these are subtables of searchindex and don't need to be duped/dropped separately
 301                         unset( $tables['searchindex_content'] );
 302                         unset( $tables['searchindex_segdir'] );
 303                         unset( $tables['searchindex_segments'] );
 304                         $tables = array_flip( $tables );
 305                 }
 306                 return $tables;
 307         }
 308
 309         protected function checkDbIsSupported() {
 310                 if( !in_array( $this->db->getType(), $this->supportedDBs ) ) {
 311                         throw new MWException( $this->db->getType() . " is not currently supported for unit testing." );
 312                 }
 313         }
 314
 315         public function getCliArg( $offset ) {
 316
 317                 if( isset( MediaWikiPHPUnitCommand::$additionalOptions[$offset] ) ) {
 318                         return MediaWikiPHPUnitCommand::$additionalOptions[$offset];
 319                 }
 320
 321         }
 322
 323         public function setCliArg( $offset, $value ) {
 324
 325                 MediaWikiPHPUnitCommand::$additionalOptions[$offset] = $value;
 326
 327         }
 328
 329         /**
 330          * Don't throw a warning if $function is deprecated and called later
 331          *
 332          * @param $function String
 333          * @return null
 334          */
 335         function hideDeprecated( $function ) {
 336                 wfSuppressWarnings();
 337                 wfDeprecated( $function );
 338                 wfRestoreWarnings();
 339         }
 340
 341         /**
 342          * Asserts that the given database query yields the rows given by $expectedRows.
 343          * The expected rows should be given as indexed (not associative) arrays, with
 344          * the values given in the order of the columns in the $fields parameter.
 345          * Note that the rows are sorted by the columns given in $fields.
 346          *
 347          * @since 1.20
 348          *
 349          * @param $table String|Array the table(s) to query
 350          * @param $fields String|Array the columns to include in the result (and to sort by)
 351          * @param $condition String|Array "where" condition(s)
 352          * @param $expectedRows Array - an array of arrays giving the expected rows.
 353          *
 354          * @throws MWException if this test cases's needsDB() method doesn't return true.
 355          *         Test cases can use "@group Database" to enable database test support,
 356          *         or list the tables under testing in $this->tablesUsed, or override the
 357          *         needsDB() method.
 358          */
 359         protected function assertSelect( $table, $fields, $condition, Array $expectedRows ) {
 360                 if ( !$this->needsDB() ) {
 361                         throw new MWException( 'When testing database state, the test cases\'s needDB()' .
 362                                 ' method should return true. Use @group Database or $this->tablesUsed.');
 363                 }
 364
 365                 $db = wfGetDB( DB_SLAVE );
 366
 367                 $res = $db->select( $table, $fields, $condition, wfGetCaller(), array( 'ORDER BY' => $fields ) );
 368                 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
 369
 370                 $i = 0;
 371
 372                 foreach ( $expectedRows as $expected ) {
 373                         $r = $res->fetchRow();
 374                         self::stripStringKeys( $r );
 375
 376                         $i += 1;
 377                         $this->assertNotEmpty( $r, "row #$i missing" );
 378
 379                         $this->assertEquals( $expected, $r, "row #$i mismatches" );
 380                 }
 381
 382                 $r = $res->fetchRow();
 383                 self::stripStringKeys( $r );
 384
 385                 $this->assertFalse( $r, "found extra row (after #$i)" );
 386         }
 387
 388         /**
 389          * Utility method taking an array of elements and wrapping
 390          * each element in it's own array. Useful for data providers
 391          * that only return a single argument.
 392          *
 393          * @since 1.20
 394          *
 395          * @param array $elements
 396          *
 397          * @return array
 398          */
 399         protected function arrayWrap( array $elements ) {
 400                 return array_map(
 401                         function( $element ) {
 402                                 return array( $element );
 403                         },
 404                         $elements
 405                 );
 406         }
 407
 408         /**
 409          * Assert that two arrays are equal. By default this means that both arrays need to hold
 410          * the same set of values. Using additional arguments, order and associated key can also
 411          * be set as relevant.
 412          *
 413          * @since 1.20
 414          *
 415          * @param array $expected
 416          * @param array $actual
 417          * @param boolean $ordered If the order of the values should match
 418          * @param boolean $named If the keys should match
 419          */
 420         protected function assertArrayEquals( array $expected, array $actual, $ordered = false, $named = false ) {
 421                 if ( !$ordered ) {
 422                         $this->objectAssociativeSort( $expected );
 423                         $this->objectAssociativeSort( $actual );
 424                 }
 425
 426                 if ( !$named ) {
 427                         $expected = array_values( $expected );
 428                         $actual = array_values( $actual );
 429                 }
 430
 431                 call_user_func_array(
 432                         array( $this, 'assertEquals' ),
 433                         array_merge( array( $expected, $actual ), array_slice( func_get_args(), 4 ) )
 434                 );
 435         }
 436
 437         /**
 438          * Does an associative sort that works for objects.
 439          *
 440          * @since 1.20
 441          *
 442          * @param array $array
 443          */
 444         protected function objectAssociativeSort( array &$array ) {
 445                 uasort(
 446                         $array,
 447                         function( $a, $b ) {
 448                                 return serialize( $a ) > serialize( $b ) ? 1 : -1;
 449                         }
 450                 );
 451         }
 452
 453         /**
 454          * Utility function for eliminating all string keys from an array.
 455          * Useful to turn a database result row as returned by fetchRow() into
 456          * a pure indexed array.
 457          *
 458          * @since 1.20
 459          *
 460          * @param $r mixed the array to remove string keys from.
 461          */
 462         protected static function stripStringKeys( &$r ) {
 463                 if ( !is_array( $r ) ) {
 464                         return;
 465                 }
 466
 467                 foreach ( $r as $k => $v ) {
 468                         if ( is_string( $k ) ) {
 469                                 unset( $r[$k] );
 470                         }
 471                 }
 472         }
 473
 474 }