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