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
   7 from sfa.rspecs.rspec_elements import RSpecElement, RSpecElements
   8 from sfa.rspecs.version_manager import VersionManager
   9
  10 class RSpec:
  11
  12     def __init__(self, rspec="", version=None, user_options={}):
  13         self.header = '<?xml version="1.0"?>\n'
  14         self.template = """<RSpec></RSpec>"""
  15         self.version = None
  16         self.xml = XML()
  17         self.version_manager = VersionManager()
  18         self.user_options = user_options
  19         self.elements = {}
  20         if rspec:
  21             if version:
  22                 self.version = self.version_manager.get_version(version)
  23                 self.parse_xml(rspec, version)
  24             else:
  25                 self.parse_xml(rspec)
  26         elif version:
  27             self.create(version)
  28         else:
  29             raise InvalidRSpec("No RSpec or version specified. Must specify a valid rspec string or a valid version")
  30     def create(self, version=None):
  31         """
  32         Create root element
  33         """
  34         self.version = self.version_manager.get_version(version)
  35         self.namespaces = self.version.namespaces
  36         self.parse_xml(self.version.template, self.version)
  37         # eg. 2011-03-23T19:53:28Z
  38         date_format = '%Y-%m-%dT%H:%M:%SZ'
  39         now = datetime.utcnow()
  40         generated_ts = now.strftime(date_format)
  41         expires_ts = (now + timedelta(hours=1)).strftime(date_format)
  42         self.xml.set('expires', expires_ts)
  43         self.xml.set('generated', generated_ts)
  44
  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={}, depth=0):
  77         elements = self.get_elements(element_type, filter)
  78         elements = [self.xml.get_element_attributes(elem, depth=depth) for elem in elements]
  79         return elements
  80
  81     def get_elements(self, element_type, filter={}):
  82         """
  83         search for a registered element
  84         """
  85         if element_type not in self.elements:
  86             msg = "Unable to search for element %s in rspec, expath expression not found." % \
  87                    element_type
  88             raise InvalidRSpecElement(element_type, extra=msg)
  89         rspec_element = self.get_rspec_element(element_type)
  90         xpath = rspec_element.path + XpathFilter.xpath(filter)
  91         return self.xml.xpath(xpath)
  92
  93     def merge(self, in_rspec):
  94         self.version.merge(in_rspec)
  95
  96     def filter(self, filter):
  97         if 'component_manager_id' in filter:
  98             nodes = self.version.get_nodes()
  99             for node in nodes:
 100                 if 'component_manager_id' not in node.attrib or \
 101                   node.attrib['component_manager_id'] != filter['component_manager_id']:
 102                     parent = node.getparent()
 103                     parent.remove(node.element)
 104
 105
 106     def toxml(self, header=True):
 107         if header:
 108             return self.header + self.xml.toxml()
 109         else:
 110             return self.xml.toxml()
 111
 112
 113     def save(self, filename):
 114         return self.xml.save(filename)
 115
 116 if __name__ == '__main__':
 117     rspec = RSpec('/tmp/resources.rspec')
 118     print rspec
 119     rspec.register_rspec_element(RSpecElements.NETWORK, 'network', '//network')
 120     rspec.register_rspec_element(RSpecElements.NODE, 'node', '//node')
 121     print rspec.get(RSpecElements.NODE)[0]
 122     print rspec.get(RSpecElements.NODE, depth=1)[0]
 123