tests/phpunit/bootstrap.php

   1 <?php
   2 /**
   3  * Bootstrapping for MediaWiki PHPUnit tests
   4  * This file is included by phpunit and is NOT in the global scope.
   5  *
   6  * @file
   7  */
   8
   9 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
  10         echo <<<EOF
  11 You are running these tests directly from phpunit. You may not have all globals correctly set.
  12 Running phpunit.php instead is recommended.
  13 EOF;
  14         require_once ( dirname( __FILE__ ) . "/phpunit.php" );
  15 }
  16
  17 // Output a notice when running with older versions of PHPUnit
  18 if ( !version_compare( PHPUnit_Runner_Version::id(), "3.4.1", ">" ) ) {
  19   echo <<<EOF
  20 ********************************************************************************
  21
  22 These tests run best with version PHPUnit 3.4.2 or better. Earlier versions may
  23 show failures because earlier versions of PHPUnit do not properly implement
  24 dependencies.
  25
  26 ********************************************************************************
  27
  28 EOF;
  29 }
  30
  31 global $wgLocalisationCacheConf, $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType;
  32 global $wgMessageCache, $messageMemc, $wgUseDatabaseMessages, $wgMsgCacheExpiry;
  33 $wgLocalisationCacheConf['storeClass'] =  'LCStore_Null';
  34 $wgMainCacheType = CACHE_NONE;
  35 $wgMessageCacheType = CACHE_NONE;
  36 $wgParserCacheType = CACHE_NONE;
  37 $wgUseDatabaseMessages = false; # Set for future resets
  38
  39 # The message cache was already created in Setup.php
  40 $wgMessageCache = new StubObject( 'wgMessageCache', 'MessageCache',
  41         array( $messageMemc, $wgUseDatabaseMessages, $wgMsgCacheExpiry ) );
  42
  43 /* Classes */
  44
  45 abstract class MediaWikiTestSetup extends PHPUnit_Framework_TestCase {
  46         protected $suite;
  47         public $regex = '';
  48         public $runDisabled = false;
  49
  50         protected static $databaseSetupDone = false;
  51         protected $db;
  52         protected $dbClone;
  53         protected $oldTablePrefix;
  54         protected $useTemporaryTables = true;
  55
  56         function __construct( PHPUnit_Framework_TestSuite $suite = null ) {
  57                 if ( null !== $suite ) {
  58                         $this->suite = $suite;
  59                 }
  60                 parent::__construct();
  61
  62                 if( $this->needsDB() && !is_object( $this->dbClone ) ) {
  63                         $this->initDB();
  64                         $this->addCoreDBData();
  65                         $this->addDBData();
  66                 }
  67         }
  68
  69         function __destruct() {
  70                 if( $this->needsDB() && is_object( $this->dbClone ) && $this->dbClone instanceof CloneDatabase ) {
  71                         $this->destroyDB();
  72                 }
  73         }
  74
  75         function needsDB() { return false; }
  76
  77         function addDBData() {}
  78
  79         private function addCoreDBData() {
  80
  81                 //Make sysop user
  82                 $user = User::newFromName( 'UTSysop' );
  83                 if ( $user->idForName() == 0 ) {
  84                         $user->addToDatabase();
  85                         $user->setPassword( 'UTSysopPassword' );
  86
  87                         $user->addGroup( 'sysop' );
  88                         $user->addGroup( 'bureaucrat' );
  89                         $user->saveSettings();
  90                 }
  91
  92
  93                 //Make 1 page with 1 revision
  94                 $article = new Article( Title::newFromText( 'UTPage' ) );
  95                 $article->doEdit( 'UTContent',
  96                                                         'UTPageSummary',
  97                                                         EDIT_NEW,
  98                                                         false,
  99                                                         User::newFromName( 'UTSysop' ) );
 100         }
 101
 102         private function initDB() {
 103                 global $wgDBprefix;
 104
 105                 if ( self::$databaseSetupDone ) {
 106                         return;
 107                 }
 108
 109                 $this->db = wfGetDB( DB_MASTER );
 110                 $dbType = $this->db->getType();
 111
 112                 if ( $wgDBprefix === 'unittest_' || ( $dbType == 'oracle' && $wgDBprefix === 'ut_' ) ) {
 113                         throw new MWException( 'Cannot run unit tests, the database prefix is already "unittest_"' );
 114                 }
 115
 116                 self::$databaseSetupDone = true;
 117                 $this->oldTablePrefix = $wgDBprefix;
 118
 119                 # SqlBagOStuff broke when using temporary tables on r40209 (bug 15892).
 120                 # It seems to have been fixed since (r55079?).
 121                 # If it fails, $wgCaches[CACHE_DB] = new HashBagOStuff(); should work around it.
 122
 123                 # CREATE TEMPORARY TABLE breaks if there is more than one server
 124                 if ( wfGetLB()->getServerCount() != 1 ) {
 125                         $this->useTemporaryTables = false;
 126                 }
 127
 128                 $temporary = $this->useTemporaryTables || $dbType == 'postgres';
 129
 130                 $tables = $this->listTables();
 131
 132                 $prefix = $dbType != 'oracle' ? 'unittest_' : 'ut_';
 133
 134                 $this->dbClone = new CloneDatabase( $this->db, $tables, $prefix );
 135                 $this->dbClone->useTemporaryTables( $temporary );
 136                 $this->dbClone->cloneTableStructure();
 137
 138                 if ( $dbType == 'oracle' )
 139                         $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' );
 140
 141                 if ( $dbType == 'oracle' ) {
 142                         # Insert 0 user to prevent FK violations
 143
 144                         # Anonymous user
 145                         $this->db->insert( 'user', array(
 146                                 'user_id'         => 0,
 147                                 'user_name'       => 'Anonymous' ) );
 148                 }
 149
 150         }
 151
 152         private function destroyDB() {
 153                 if ( !self::$databaseSetupDone ) {
 154                         return;
 155                 }
 156
 157                 $this->dbClone->destroy();
 158                 self::$databaseSetupDone = false;
 159
 160                 if ( $this->useTemporaryTables ) {
 161                         # Don't need to do anything
 162                         //return;
 163                         //Temporary tables seem to be broken ATM, delete anyway
 164                 }
 165
 166                 if( $this->db->getType() == 'oracle' ) {
 167                         $tables = $this->db->listTables( 'ut_', __METHOD__ );
 168                 }
 169                 else {
 170                         $tables = $this->db->listTables( 'unittest_', __METHOD__ );
 171                 }
 172
 173                 foreach ( $tables as $table ) {
 174                         $sql = $this->db->getType() == 'oracle' ? "DROP TABLE $table DROP CONSTRAINTS" : "DROP TABLE `$table`";
 175                         $this->db->query( $sql );
 176                 }
 177
 178                 if ( $this->db->getType() == 'oracle' )
 179                         $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' );
 180
 181
 182         }
 183
 184         function __call( $func, $args ) {
 185                 if ( method_exists( $this->suite, $func ) ) {
 186                         return call_user_func_array( array( $this->suite, $func ), $args);
 187                 } else {
 188                         throw new MWException( "Called non-existant $func method on "
 189                                 . get_class( $this ) );
 190                 }
 191         }
 192
 193         protected function listTables() {
 194                 global $wgDBprefix;
 195
 196                 $tables = $this->db->listTables( $wgDBprefix, __METHOD__ );
 197                 $tables = array_map( create_function( '$table', 'global $wgDBprefix; return substr( $table, strlen( $wgDBprefix ) );' ), $tables );
 198                 return $tables;
 199
 200         }
 201 }
 202