sfa/generic/__init__.py

   1 from sfa.util.sfalogging import logger
   2 from sfa.util.config import Config
   3
   4 from sfa.managers.managerwrapper import ManagerWrapper
   5
   6 # a bundle is the combination of
   7 # (*) an api that reacts on the incoming requests to trigger the API methods
   8 # (*) a manager that implements the function of the service,
   9 #     either aggregate, registry, or slicemgr
  10 # (*) a driver that controls the underlying testbed
  11 #
  12 #
  13 # The Generic class is a utility that uses the configuration to figure out
  14 # which combination of these pieces need to be put together
  15 # from config.
  16 # this extra indirection is needed to adapt to the current naming scheme
  17 # where we have 'pl' and 'plc' and components and the like, that does not
  18 # yet follow a sensible scheme
  19
  20 # needs refinements to cache more efficiently, esp. wrt the config
  21
  22 class Generic:
  23
  24     def __init__ (self, flavour, config):
  25         self.flavour=flavour
  26         self.config=config
  27
  28     # proof of concept
  29     # example flavour='pl' -> sfa.generic.pl.pl()
  30     @staticmethod
  31     def the_flavour (flavour=None, config=None):
  32         if config is None: config=Config()
  33         if flavour is None: flavour=config.SFA_GENERIC_FLAVOUR
  34         flavour = flavour.lower()
  35         #mixed = flavour.capitalize()
  36         module_path="sfa.generic.%s"%flavour
  37         classname="%s"%flavour
  38         logger.debug("Generic.the_flavour with flavour=%s"%flavour)
  39         try:
  40             module = __import__ (module_path, globals(), locals(), [classname])
  41             return getattr(module, classname)(flavour,config)
  42         except:
  43             logger.log_exc("Cannot locate generic instance with flavour=%s"%flavour)
  44
  45     # in the simplest case these can be redefined to the class/module objects to be used
  46     # see pl.py for an example
  47     # some descendant of SfaApi
  48     def api_class (self) : pass
  49     # the python classes to use to build up the context
  50     def registry_class (self) : pass
  51     def slicemgr_class (self) : pass
  52     def aggregate_class (self) : pass
  53     def component_class (self) : pass
  54
  55
  56     # build an API object
  57     # insert a manager instance
  58     def make_api (self, *args, **kwargs):
  59         # interface is a required arg
  60         if not 'interface' in kwargs:
  61             logger.critical("Generic.make_api: no interface found")
  62         api = self.api_class()(*args, **kwargs)
  63         manager_class_or_module = self.make_manager(api.interface)
  64         driver = self.make_driver (api.config, api.interface)
  65         ### arrange stuff together
  66         # add a manager wrapper
  67         manager_wrap = ManagerWrapper(manager_class_or_module,api.interface,api.config)
  68         api.manager=manager_wrap
  69         # insert driver in manager
  70         logger.debug("Setting manager.driver, manager=%s"%manager_class_or_module)
  71         # xxx this should go into the object and not the class !?!
  72         manager_class_or_module.driver=driver
  73         # add it in api as well for convenience
  74         api.driver=driver
  75         return api
  76
  77     def make_manager (self, interface):
  78         """
  79         interface expected in ['registry', 'aggregate', 'slicemgr', 'component']
  80         flavour is e.g. 'pl' or 'max' or whatever
  81         """
  82         flavour = self.flavour
  83         message="Generic.make_manager for interface=%s and flavour=%s"%(interface,flavour)
  84
  85         classname = "%s_manager_class"%interface
  86         try:
  87             module_or_class = getattr(self,classname)()
  88             logger.debug("%s : %s"%(message,module_or_class))
  89             # this gets passed to ManagerWrapper that will call the class constructor
  90             # if it's a class, or use the module as is if it's a module
  91             # so bottom line is, don't try the constructor here
  92             return module_or_class
  93         except:
  94             logger.log_exc_critical(message)
  95
  96     # need interface to select the right driver
  97     def make_driver (self, config, interface):
  98         flavour = self.flavour
  99         message="Generic.make_driver for flavour=%s and interface=%s"%(flavour,interface)
 100
 101         if interface == "component":
 102             classname = "component_driver_class"
 103         else:
 104             classname = "driver_class"
 105         try:
 106             class_obj = getattr(self,classname)()
 107             logger.debug("%s : %s"%(message,class_obj))
 108             return class_obj(config)
 109         except:
 110             logger.log_exc_critical(message)
 111
 112