geni/util/specdict.py

   1 ##
   2 # SpecDict
   3 #
   4 # SpecDict defines a means for converting a dictionary with plc specific keys
   5 # to a dict with rspec specific keys.
   6 #
   7 # SpecDict.fields dict defines all the rspec specific attribute and their
   8 # expected type.
   9 #
  10 # SpecDict.plc_fields defines a one to one mapping of plc attribute to rspec
  11 # attribute
  12
  13 from types import StringTypes, ListType
  14
  15
  16 class SpecDict(dict):
  17     """
  18     Base class of SpecDict objects.
  19     """
  20     fields = {}
  21     plc_fields = {}
  22     type = None
  23
  24     def __init__(self, spec_dict):
  25         # convert plc dict and initialize self
  26         sdict = self.plcToSpec(spec_dict)
  27         dict.__init__(self, sdict)
  28
  29
  30     def plcToSpec(self, spec_dict):
  31         """
  32         Defines how to convert a plc dict to rspec dict
  33         """
  34         spec = {}
  35         for field in self.fields:
  36             value = ""
  37             expected = self.fields[field]
  38             if isinstance(expected, StringTypes):
  39                 if self.plc_fields.has_key(field):
  40                     plc_field = self.plc_fields[field]
  41                     if spec_dict.has_key(plc_field):
  42                         value = spec_dict[plc_field]
  43             elif isinstance(expected, ListType):
  44                 expected = expected[0]
  45                 if self.plc_fields.has_key(field):
  46                     plc_field = self.plc_fields[field]
  47                     if spec_dict.has_key(plc_field):
  48                         value = [expected(value) for value in spec_dict[plc_field]]
  49             spec[field] = value
  50         return {self.type: spec}
  51
  52 class IfSpecDict(SpecDict):
  53     type = 'IfSpec'
  54     fields = {'name': '',
  55               'addr': '',
  56               'type': '',
  57               'init_params': '',
  58               'min_rate': '',
  59               'max_rate': '',
  60               'max_kbyte': '',
  61               'ip_spoof': ''}
  62     plc_fields = {'name': 'is_primary',
  63                  'addr': 'ip',
  64                  'type': 'type'}
  65
  66 class NodeSpecDict(SpecDict):
  67     type = 'NodeSpec'
  68     fields = {'name': '',
  69               'type': '',
  70               'init_params': '',
  71               'cpu_min': '',
  72               'cpu_share': '',
  73               'cpu_pct': '',
  74               'disk_max': '',
  75               'start_time': '',
  76               'duration': '',
  77               'net_if': [IfSpecDict]}
  78
  79     plc_fields = {'name': 'hostname',
  80                   'net_if': 'interfaces'}
  81
  82 class NetSpecDict(SpecDict):
  83     type = 'NetSpec'
  84     fields = {'name': '',
  85               'start_time': '',
  86               'duration': '',
  87               'nodes': [NodeSpecDict],
  88              }
  89     plc_fields = {'name': 'name',
  90                   'start_time': 'start_time',
  91                   'duration': 'duration',
  92                   'nodes': 'nodes'}
  93
  94 class RspecDict(SpecDict):
  95     type = 'RSpec'
  96     fields = {'start_time': '',
  97               'duration': '',
  98               'networks': [NetSpecDict]
  99              }
 100     plc_fields = {'networks': 'networks',
 101                   'start_time': 'start_tim',
 102                   'duration': 'duration'
 103                  }
 104
 105 # vim:ts=4:expandtab