sfa/rspecs/rspec.py

   1 #!/usr/bin/python
   2 from datetime import datetime, timedelta
   3
   4 from sfa.util.xml import XML, XpathFilter
   5 from sfa.util.faults import InvalidRSpecElement, InvalidRSpec
   6 from sfa.util.sfatime import SFATIME_FORMAT
   7
   8 from sfa.rspecs.rspec_elements import RSpecElement, RSpecElements
   9 from sfa.rspecs.version_manager import VersionManager
  10
  11 class RSpec:
  12
  13     def __init__(self, rspec="", version=None, user_options=None):
  14         if user_options is None: user_options={}
  15         self.header = '<?xml version="1.0"?>\n'
  16         self.template = """<RSpec></RSpec>"""
  17         self.version = None
  18         self.xml = XML()
  19         self.version_manager = VersionManager()
  20         self.user_options = user_options
  21         self.elements = {}
  22         if rspec:
  23             if version:
  24                 self.version = self.version_manager.get_version(version)
  25                 self.parse_xml(rspec, version)
  26             else:
  27                 self.parse_xml(rspec)
  28         elif version:
  29             self.create(version)
  30         else:
  31             raise InvalidRSpec("No RSpec or version specified. Must specify a valid rspec string or a valid version")
  32
  33     def create(self, version=None):
  34         """
  35         Create root element
  36         """
  37         self.version = self.version_manager.get_version(version)
  38         self.namespaces = self.version.namespaces
  39         self.parse_xml(self.version.template, self.version)
  40         now = datetime.utcnow()
  41         generated_ts = now.strftime(SFATIME_FORMAT)
  42         expires_ts = (now + timedelta(hours=1)).strftime(SFATIME_FORMAT)
  43         self.xml.set('expires', expires_ts)
  44         self.xml.set('generated', generated_ts)
  45
  46     def parse_xml(self, xml, version=None):
  47         self.xml.parse_xml(xml)
  48         if not version:
  49             if self.xml.schema:
  50                 self.version = self.version_manager.get_version_by_schema(self.xml.schema)
  51             else:
  52                 #raise InvalidRSpec('unknown rspec schema: %s' % schema)
  53                 # TODO: Should start raising an exception once SFA defines a schema.
  54                 # for now we just  default to sfa
  55                 self.version = self.version_manager.get_version({'type':'sfa','version': '1'})
  56         self.version.xml = self.xml
  57         self.namespaces = self.xml.namespaces
  58
  59     def load_rspec_elements(self, rspec_elements):
  60         self.elements = {}
  61         for rspec_element in rspec_elements:
  62             if isinstance(rspec_element, RSpecElement):
  63                 self.elements[rspec_element.type] = rspec_element
  64
  65     def register_rspec_element(self, element_type, element_name, element_path):
  66         if element_type not in RSpecElements:
  67             raise InvalidRSpecElement(element_type, extra="no such element type: %s. Must specify a valid RSpecElement" % element_type)
  68         self.elements[element_type] = RSpecElement(element_type, element_name, element_path)
  69
  70     def get_rspec_element(self, element_type):
  71         if element_type not in self.elements:
  72             msg = "ElementType %s not registerd for this rspec" % element_type
  73             raise InvalidRSpecElement(element_type, extra=msg)
  74         return self.elements[element_type]
  75
  76     def get(self, element_type, filter=None, depth=0):
  77         if filter is None: filter={}
  78         elements = self.get_elements(element_type, filter)
  79         elements = [self.xml.get_element_attributes(elem, depth=depth) for elem in elements]
  80         return elements
  81
  82     def get_elements(self, element_type, filter=None):
  83         """
  84         search for a registered element
  85         """
  86         if filter is None: filter={}
  87         if element_type not in self.elements:
  88             msg = "Unable to search for element %s in rspec, expath expression not found." % \
  89                    element_type
  90             raise InvalidRSpecElement(element_type, extra=msg)
  91         rspec_element = self.get_rspec_element(element_type)
  92         xpath = rspec_element.path + XpathFilter.xpath(filter)
  93         return self.xml.xpath(xpath)
  94
  95     def merge(self, in_rspec):
  96         self.version.merge(in_rspec)
  97
  98     def filter(self, filter):
  99         if 'component_manager_id' in filter:
 100             nodes = self.version.get_nodes()
 101             for node in nodes:
 102                 if 'component_manager_id' not in node.attrib or \
 103                   node.attrib['component_manager_id'] != filter['component_manager_id']:
 104                     parent = node.getparent()
 105                     parent.remove(node.element)
 106
 107
 108     def toxml(self, header=True):
 109         if header:
 110             return self.header + self.xml.toxml()
 111         else:
 112             return self.xml.toxml()
 113
 114
 115     def save(self, filename):
 116         return self.xml.save(filename)
 117
 118 if __name__ == '__main__':
 119     rspec = RSpec('/tmp/resources.rspec')
 120     print rspec
 121     rspec.register_rspec_element(RSpecElements.NETWORK, 'network', '//network')
 122     rspec.register_rspec_element(RSpecElements.NODE, 'node', '//node')
 123     print rspec.get(RSpecElements.NODE)[0]
 124     print rspec.get(RSpecElements.NODE, depth=1)[0]
 125