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={}, ttl=60):
  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.ttl = ttl
  20         self.elements = {}
  21         if rspec:
  22             if version:
  23                 self.version = self.version_manager.get_version(version)
  24                 self.parse_xml(rspec, version)
  25             else:
  26                 self.parse_xml(rspec)
  27         elif version:
  28             self.create(version)
  29         else:
  30             raise InvalidRSpec("No RSpec or version specified. Must specify a valid rspec string or a valid version")
  31
  32     def create(self, version=None, ttl=60):
  33         """
  34         Create root element
  35         ttl: time to live in minutes, this will determine the expires tag of the RSpec
  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         # eg. 2011-03-23T19:53:28Z
  41         date_format = '%Y-%m-%dT%H:%M:%SZ'
  42         now = datetime.utcnow()
  43         generated_ts = now.strftime(date_format)
  44         expires_ts = (now + timedelta(minutes=self.ttl)).strftime(date_format)
  45         self.xml.set('expires', expires_ts)
  46         self.xml.set('generated', generated_ts)
  47
  48     def parse_xml(self, xml, version=None):
  49         self.xml.parse_xml(xml)
  50         if not version:
  51             if self.xml.schema:
  52                 self.version = self.version_manager.get_version_by_schema(self.xml.schema)
  53             else:
  54                 #raise InvalidRSpec('unknown rspec schema: %s' % schema)
  55                 # TODO: Should start raising an exception once SFA defines a schema.
  56                 # for now we just  default to sfa
  57                 self.version = self.version_manager.get_version({'type':'sfa','version': '1'})
  58         self.version.xml = self.xml
  59         self.namespaces = self.xml.namespaces
  60
  61     def load_rspec_elements(self, rspec_elements):
  62         self.elements = {}
  63         for rspec_element in rspec_elements:
  64             if isinstance(rspec_element, RSpecElement):
  65                 self.elements[rspec_element.type] = rspec_element
  66
  67     def register_rspec_element(self, element_type, element_name, element_path):
  68         if element_type not in RSpecElements:
  69             raise InvalidRSpecElement(element_type, extra="no such element type: %s. Must specify a valid RSpecElement" % element_type)
  70         self.elements[element_type] = RSpecElement(element_type, element_name, element_path)
  71
  72     def get_rspec_element(self, element_type):
  73         if element_type not in self.elements:
  74             msg = "ElementType %s not registerd for this rspec" % element_type
  75             raise InvalidRSpecElement(element_type, extra=msg)
  76         return self.elements[element_type]
  77
  78     def get(self, element_type, filter={}, depth=0):
  79         elements = self.get_elements(element_type, filter)
  80         elements = [self.xml.get_element_attributes(elem, depth=depth) for elem in elements]
  81         return elements
  82
  83     def get_elements(self, element_type, filter={}):
  84         """
  85         search for a registered element
  86         """
  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