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