* Modified StoreBatchTest and FileBackendTest to allow specifying a registered backen...
[lhc/web/wiklou.git] / tests / phpunit / MediaWikiTestCase.php
index 37c7b59..0a2f58b 100644 (file)
@@ -4,21 +4,28 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase {
        public $suite;
        public $regex = '';
        public $runDisabled = false;
-       
+
+       /**
+        * @var DatabaseBase
+        */
        protected $db;
-       protected $dbClone;
        protected $oldTablePrefix;
        protected $useTemporaryTables = true;
+       protected $reuseDB = false;
+       protected $tablesUsed = array(); // tables with data
+
+       private static $dbSetup = false;
 
        /**
         * Table name prefixes. Oracle likes it shorter.
         */
        const DB_PREFIX = 'unittest_';
        const ORA_DB_PREFIX = 'ut_';
-       
+
        protected $supportedDBs = array(
                'mysql',
                'sqlite',
+               'postgres',
                'oracle'
        );
 
@@ -28,42 +35,46 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase {
                $this->backupGlobals = false;
                $this->backupStaticAttributes = false;
        }
-       
+
        function run( PHPUnit_Framework_TestResult $result = NULL ) {
-               
+               /* Some functions require some kind of caching, and will end up using the db,
+                * which we can't allow, as that would open a new connection for mysql.
+                * Replace with a HashBag. They would not be going to persist anyway.
+                */
+               ObjectCache::$instances[CACHE_DB] = new HashBagOStuff;
+
                if( $this->needsDB() ) {
-               
                        global $wgDBprefix;
                        
+                       $this->useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
+                       $this->reuseDB = $this->getCliArg('reuse-db');
+
                        $this->db = wfGetDB( DB_MASTER );
-                       
+
                        $this->checkDbIsSupported();
-                       
+
                        $this->oldTablePrefix = $wgDBprefix;
-                       
-                       $this->destroyDB();
-                       
-                       $this->initDB();
+
+                       if( !self::$dbSetup ) {
+                               $this->initDB();
+                               self::$dbSetup = true;
+                       }
+
                        $this->addCoreDBData();
                        $this->addDBData();
-                       
+
                        parent::run( $result );
-               
-                       $this->destroyDB();
-               }
-               else {
+
+                       $this->resetDB();
+               } else {
                        parent::run( $result );
-               
                }
-               
        }
-       
-       function __destruct() {
-               if( $this->needsDB() ) {
-                       $this->destroyDB();
-               }
+
+       function dbPrefix() {
+               return $this->db->getType() == 'oracle' ? self::ORA_DB_PREFIX : self::DB_PREFIX;
        }
-       
+
        function needsDB() {
                $rc = new ReflectionClass( $this );
                return strpos( $rc->getDocComment(), '@group Database' ) !== false;
@@ -74,14 +85,38 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase {
         * implement this method and do so
         */
        function addDBData() {}
-       
+
        private function addCoreDBData() {
+               if ( $this->db->getType() == 'oracle' ) {
+
+                       # Insert 0 user to prevent FK violations
+                       # Anonymous user
+                       $this->db->insert( 'user', array(
+                               'user_id'               => 0,
+                               'user_name'     => 'Anonymous' ), __METHOD__, array( 'IGNORE' ) );
+
+                       # Insert 0 page to prevent FK violations
+                       # Blank page
+                       $this->db->insert( 'page', array(
+                               'page_id' => 0,
+                               'page_namespace' => 0,
+                               'page_title' => ' ',
+                               'page_restrictions' => NULL,
+                               'page_counter' => 0,
+                               'page_is_redirect' => 0,
+                               'page_is_new' => 0,
+                               'page_random' => 0,
+                               'page_touched' => $this->db->timestamp(),
+                               'page_latest' => 0,
+                               'page_len' => 0 ), __METHOD__, array( 'IGNORE' ) );
+
+               }
 
                User::resetIdByNameCache();
 
                //Make sysop user
                $user = User::newFromName( 'UTSysop' );
-               
+
                if ( $user->idForName() == 0 ) {
                        $user->addToDatabase();
                        $user->setPassword( 'UTSysopPassword' );
@@ -91,78 +126,61 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase {
                        $user->saveSettings();
                }
 
-               
+
                //Make 1 page with 1 revision
-               $article = new Article( Title::newFromText( 'UTPage' ) );
-               $article->doEdit( 'UTContent',
-                                                       'UTPageSummary',
-                                                       EDIT_NEW,
-                                                       false,
-                                                       User::newFromName( 'UTSysop' ) );
-       }
-       
+               $page = WikiPage::factory( Title::newFromText( 'UTPage' ) );
+               $page->doEdit( 'UTContent',
+                                               'UTPageSummary',
+                                               EDIT_NEW,
+                                               false,
+                                               User::newFromName( 'UTSysop' ) );
+       }
+
        private function initDB() {
                global $wgDBprefix;
-
-               $dbType = $this->db->getType();
-               
-               if ( $wgDBprefix === self::DB_PREFIX || ( $dbType == 'oracle' && $wgDBprefix === self::ORA_DB_PREFIX ) ) {
+               if ( $wgDBprefix === $this->dbPrefix() ) {
                        throw new MWException( 'Cannot run unit tests, the database prefix is already "unittest_"' );
                }
 
-               $tables = $this->listTables();
-               
-               $prefix = $dbType != 'oracle' ? self::DB_PREFIX : self::ORA_DB_PREFIX;
-               
-               $this->dbClone = new CloneDatabase( $this->db, $tables, $prefix );
-               $this->dbClone->useTemporaryTables( $this->useTemporaryTables );
-               $this->dbClone->cloneTableStructure();
-               
-               if ( $dbType == 'oracle' )
-                       $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' );
+               $tablesCloned = $this->listTables();
+               $dbClone = new CloneDatabase( $this->db, $tablesCloned, $this->dbPrefix() );
+               $dbClone->useTemporaryTables( $this->useTemporaryTables );
 
-               if ( $dbType == 'oracle' ) {
-                       # Insert 0 user to prevent FK violations
-                       
-                       # Anonymous user
-                       $this->db->insert( 'user', array(
-                               'user_id'               => 0,
-                               'user_name'     => 'Anonymous' ) );
-               }
-               
-       }
-       
-       protected function destroyDB() {
-               
-               if ( $this->useTemporaryTables ) {
-                       # Don't need to do anything
-                       //return;
-                       //Temporary tables seem to be broken ATM, delete anyway
-               }
-               
-               if( is_null( $this->db ) ) {
+               if ( ( $this->db->getType() == 'oracle' || !$this->useTemporaryTables ) && $this->reuseDB ) {
+                       CloneDatabase::changePrefix( $this->dbPrefix() );
+                       $this->resetDB();
                        return;
+               } else {
+                       $dbClone->cloneTableStructure();
                }
-               
-               if( $this->db->getType() == 'oracle' ) {
-                       $tables = $this->db->listTables( self::ORA_DB_PREFIX, __METHOD__ );
-               }
-               else {
-                       $tables = $this->db->listTables( self::DB_PREFIX, __METHOD__ );
+
+               if ( $this->db->getType() == 'oracle' ) {
+                       $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' );
                }
-               
-               foreach ( $tables as $table ) {
-                       try {
-                               $sql = $this->db->getType() == 'oracle' ? "DROP TABLE $table CASCADE CONSTRAINTS PURGE" : "DROP TABLE `$table`";
-                               $this->db->query( $sql, __METHOD__ );
-                       } catch( Exception $e ) {
+       }
+
+       /**
+        * Empty all tables so they can be repopulated for tests
+        */
+       private function resetDB() {
+               if( $this->db ) {
+                       if ( $this->db->getType() == 'oracle' )  {
+                               if ( $this->useTemporaryTables ) {
+                                       wfGetLB()->closeAll();
+                                       $this->db = wfGetDB( DB_MASTER );
+                               } else {
+                                       foreach( $this->tablesUsed as $tbl ) {
+                                               if( $tbl == 'interwiki') continue;
+                                               $this->db->query( 'TRUNCATE TABLE '.$this->db->tableName($tbl), __METHOD__ );
+                                       }
+                               }
+                       } else {
+                               foreach( $this->tablesUsed as $tbl ) {
+                                       if( $tbl == 'interwiki' || $tbl == 'user' ) continue;
+                                       $this->db->delete( $tbl, '*', __METHOD__ );
+                               }
                        }
                }
-               
-               if ( $this->db->getType() == 'oracle' )
-                       $this->db->query( 'BEGIN FILL_WIKI_INFO; END;', __METHOD__ );
-               
-               CloneDatabase::changePrefix( $this->oldTablePrefix );
        }
 
        function __call( $func, $args ) {
@@ -186,39 +204,69 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase {
        private function assertEmpty2( $value, $msg ) {
                return $this->assertTrue( $value == '', $msg );
        }
-       
+
        static private function unprefixTable( $tableName ) {
                global $wgDBprefix;
                return substr( $tableName, strlen( $wgDBprefix ) );
        }
 
+       static private function isNotUnittest( $table ) {
+               return strpos( $table, 'unittest_' ) !== 0;
+       }
+
        protected function listTables() {
                global $wgDBprefix;
-               
+
                $tables = $this->db->listTables( $wgDBprefix, __METHOD__ );
                $tables = array_map( array( __CLASS__, 'unprefixTable' ), $tables );
+
+               // Don't duplicate test tables from the previous fataled run
+               $tables = array_filter( $tables, array( __CLASS__, 'isNotUnittest' ) );
+
+               if ( $this->db->getType() == 'sqlite' ) {
+                       $tables = array_flip( $tables );
+                       // these are subtables of searchindex and don't need to be duped/dropped separately
+                       unset( $tables['searchindex_content'] );
+                       unset( $tables['searchindex_segdir'] );
+                       unset( $tables['searchindex_segments'] );
+                       $tables = array_flip( $tables );
+               }
                return $tables;
-               
        }
-       
+
        protected function checkDbIsSupported() {
                if( !in_array( $this->db->getType(), $this->supportedDBs ) ) {
                        throw new MWException( $this->db->getType() . " is not currently supported for unit testing." );
                }
        }
-       
+
        public function getCliArg( $offset ) {
-       
+
                if( isset( MediaWikiPHPUnitCommand::$additionalOptions[$offset] ) ) {
                        return MediaWikiPHPUnitCommand::$additionalOptions[$offset];
                }
-               
+
        }
-       
+
        public function setCliArg( $offset, $value ) {
-       
+
                MediaWikiPHPUnitCommand::$additionalOptions[$offset] = $value;
-               
+
+       }
+
+       public static function disableInterwikis( $prefix, &$data ) {
+               return false;
        }
-}
 
+       /**
+        * Don't throw a warning if $function is deprecated and called later
+        *
+        * @param $function String
+        * @return null
+        */
+       function hideDeprecated( $function ) {
+               wfSuppressWarnings();
+               wfDeprecated( $function );
+               wfRestoreWarnings();
+       }
+}