Local configuration override in ionlocal.config. Unit tests get broke…

…r host from config

.gitignore

@@ -7,3 +7,4 @@
 *.pid
 _trial*
 docs
+res/config/ionlocal.config

README.txt

@@ -63,7 +63,7 @@ Or in the CC shell:
     send(1, {'op':'hello','content':'Hello you there!'})
 
     from ion.play.hello_service import HelloServiceClient
-    hc = HelloServiceClient() 
+    hc = HelloServiceClient()
     hc.hello()
 
 
@@ -120,6 +120,11 @@ again (see above). Please review the branch logs for any hints.
 Change log:
 ===========
 
+2010-05-20:
+- The system now looks for a local config file ionlocal.config and if exists,
+  overrides entries in ion.config.
+- Test cases use the config file to determine the broker host to use. If local
+  config override exists, a different broker (e.g. localhast) can be given.
 2010-05-16:
 - Removed support for BaseProcess.send_message and reply_message. Always use
   send, reply and rpc_send now.

ion/core/ionconst.py

@@ -6,11 +6,17 @@
 @brief definitions of ION packages wide constants
 """
 
+# Name of central logginf configuration file
 LOGCONF_FILENAME = 'res/logging/ionlogging.conf'
 
+# Name of central ION configuration file (not to be changed)
 ION_CONF_FILENAME = 'res/config/ion.config'
 
+# Name of local ION config override file (can be changed locally)
+ION_LOCAL_CONF_FILENAME = 'res/config/ionlocal.config'
+
 # @todo use magnet version system
 VERSION = "ion 0.2.1"
 
+# Minimum version of Magnet required
 MIN_MAGNET = "0.3.4"

ion/core/ioninit.py

@@ -21,6 +21,9 @@
 # Load configuration properties for any module to access
 ion_config = Config(ic.ION_CONF_FILENAME)
 
+# Update configuration with local override config
+ion_config.update_from_file(ic.ION_LOCAL_CONF_FILENAME)
+
 # Arguments given to the container (i.e. the python process executing this code)
 cont_args = {}
 
@@ -48,4 +51,4 @@ def check_magnet_version():
     if mv[0]<minmv[0] or mv[1]<minmv[1] or mv[2]<minmv[2]:
         logging.error("*********** ATTENTION! Magnet %s required. Is %s ***********" % (ic.MIN_MAGNET, magnet.__version__))
 
-check_magnet_version()
+check_magnet_version()

ion/test/iontest.py

@@ -10,15 +10,16 @@
 
 from twisted.trial import unittest
 from twisted.internet import defer
-
 from magnet import container
 from magnet.container import Id
-from ion.data.store import Store
 
-from ion.core import base_process, bootstrap
+from ion.core import base_process, bootstrap, ioninit
 from ion.core import ioninit
+from ion.data.store import Store
 import ion.util.procutils as pu
 
+CONF = ioninit.config(__name__)
+
 class IonTestCase(unittest.TestCase):
     """
     Extension of python unittest.TestCase and trial unittest.TestCase for the
@@ -37,9 +38,9 @@ def _start_container(self):
         @note Hardwired to connect to amoeba for broker.
         """
         mopt = {}
-        mopt['broker_host'] = 'amoeba.ucsd.edu'
-        mopt['broker_port'] = 5672
-        mopt['broker_vhost'] = '/'
+        mopt['broker_host'] = CONF['broker_host']
+        mopt['broker_port'] = CONF['broker_port']
+        mopt['broker_vhost'] = CONF['broker_vhost']
         mopt['boot_script'] = None
         mopt['script'] = None
 
@@ -72,7 +73,7 @@ def _declare_messaging(self, messaging):
 
     def _spawn_processes(self, procs):
         return bootstrap.spawn_processes(procs)
-        
+
     def _get_procid(self, name):
         """
         @param name  process instance label given when spawning

ion/util/config.py

@@ -6,6 +6,9 @@
 @brief  supports work with config files
 """
 
+import logging
+import os.path
+
 class Config(object):
     """
     Helper class managing config files
@@ -48,3 +51,30 @@ def getValue2(self, key1, key2, default=None):
     def getValue3(self, key1, key2, key3, default=None):
         value = self.getValue2(key1, key2, {})
         return self._getValue(value, key3, default)
+
+    def update_from_file(self, filename):
+        if os.path.isfile(filename):
+            logging.info("Updating config from local file: "+filename)
+            # Load config override from filename
+            filecontent = open(filename,).read()
+            updates = eval(filecontent)
+            self.update(updates)
+
+    def update(self, updates):
+        """
+        Recursively updates configuration dict with values in given dict.
+        """
+        self._update_dict(self.obj, updates)
+
+    def _update_dict(self, src, upd):
+        """
+        Recursively updates a dict with values in another dict.
+        """
+        assert type(src) is dict and type(upd) is dict
+        for ukey,uval in upd.iteritems():
+            if type(uval) is dict:
+                if not ukey in src:
+                    src[ukey] = {}
+                self._update_dict(src[ukey], uval)
+            else:
+                src[ukey] = uval

res/config/_ionlocal.config

@@ -0,0 +1,8 @@
+# Override configuration file for "ion.config". Any entry in here replaces
+# or adds configuration in ion.config.
+# For a local configuration, copy to "ionlocal.config" and modify settings here.
+{
+'#REMOVEME#ion.test.iontest':{
+    'broker_host' : 'localhost',
+    },
+}

res/config/ion.config

@@ -1,6 +1,7 @@
 # Central configuration file for ION services and modules
-# Entried are key'ed by the __name__ of their module,
-# or startup for boot scripts
+# Entries are key'ed by the __name__ of their module,
+# or startup for boot scripts.
+# Do not modify this file locally! Set overrides in ionlocal.config
 {
 'ion.core.bootstrap':{
     'ccagent_cfg' : 'res/config/ionccagent.cfg',
@@ -34,6 +35,11 @@
     'backend_class':'ion.data.store.Store',
     },
 
+'ion.test.iontest':{
+    'broker_host' : 'amoeba.ucsd.edu',
+    'broker_port' : 5672,
+    'broker_vhost' : '/',
+    },
 
 'startup.bootstrap1':{
     'coreservices_cfg':'res/config/ioncoreservices.cfg',
@@ -45,6 +51,4 @@
     'services_cfg' : 'res/config/iondx_services.cfg',
     'messaging_cfg': 'res/config/ionmessaging.cfg'
     },
-
-
 }