sfa/rspecs/rspec.py

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