RSpec class can now represent any rspec format. No longer need to explicitly instance...
authorTony Mack <tmack@paris.CS.Princeton.EDU>
Sat, 1 Oct 2011 02:33:11 +0000 (22:33 -0400)
committerTony Mack <tmack@paris.CS.Princeton.EDU>
Sat, 1 Oct 2011 02:33:11 +0000 (22:33 -0400)
sfa/rspecs/rspec.py

index 5872e33..66a1b01 100755 (executable)
@@ -1,96 +1,65 @@
 #!/usr/bin/python 
-from lxml import etree
-from StringIO import StringIO
 from datetime import datetime, timedelta
+from sfa.rspecs.xml_interface import XMLInterface, XpathFilter
+from sfa.rspecs.version_manager import VersionManager
 from sfa.util.xrn import *
 from sfa.util.plxrn import hostname_to_urn
 from sfa.rspecs.rspec_elements import RSpecElement, RSpecElements 
 from sfa.util.faults import SfaNotImplemented, InvalidRSpec, InvalidRSpecElement
 
-class XpathFilter:
-    @staticmethod
-    def xpath(filter={}):
-        xpath = ""
-        if filter:
-            filter_list = []
-            for (key, value) in filter.items():
-                if key == 'text':
-                    key = 'text()'
-                else:
-                    key = '@'+key
-                if isinstance(value, str):
-                    filter_list.append('%s="%s"' % (key, value))
-                elif isinstance(value, list):
-                    filter_list.append('contains("%s", %s)' % (' '.join(map(str, value)), key))
-            if filter_list:
-                xpath = ' and '.join(filter_list)
-                xpath = '[' + xpath + ']'
-        return xpath
-
-class RSpec:
-    header = '<?xml version="1.0"?>\n'
-    template = """<RSpec></RSpec>"""
-    xml = None
-    type = None
-    version = None
-    namespaces = None
-    user_options = {}
+class RSpec(XMLInterface):
  
-    def __init__(self, rspec="", namespaces={}, type=None, user_options={}):
-        self.type = type
+    def __init__(self, rspec="", version=None, user_options={}):
+        self.header = '<?xml version="1.0"?>\n'
+        self.template = """<RSpec></RSpec>"""
+        self.version = None
+        self.xml = None
+        self.version_manager = VersionManager()
         self.user_options = user_options
         self.elements = {}
         if rspec:
-            self.parse_rspec(rspec, namespaces)
+            self.parse_xml(rspec)
         else:
-            self.create()
+            self.create(version)
 
-    def create(self):
+    def create(self, version=None):
         """
         Create root element
         """
+        self.version = self.version_manager.get_version(version)
+        self.namespaces = self.version.namespaces
+        self.parse_xml(self.version.template) 
         # eg. 2011-03-23T19:53:28Z 
         date_format = '%Y-%m-%dT%H:%M:%SZ'
         now = datetime.utcnow()
         generated_ts = now.strftime(date_format)
         expires_ts = (now + timedelta(hours=1)).strftime(date_format) 
-        self.parse_rspec(self.template, self.namespaces)
         self.xml.set('expires', expires_ts)
         self.xml.set('generated', generated_ts)
-    
-    def parse_rspec(self, rspec, namespaces={}):
-        """
-        parse rspec into etree
-        """
-        parser = etree.XMLParser(remove_blank_text=True)
-        try:
-            tree = etree.parse(rspec, parser)
-        except IOError:
-            # 'rspec' file doesnt exist. 'rspec' is proably an xml string
-            try:
-                tree = etree.parse(StringIO(rspec), parser)
-            except Exception, e:
-                raise InvalidRSpec(str(e))
-        self.xml = tree.getroot()  
-        if namespaces:
-           self.namespaces = namespaces
 
-    def validate(self, schema):
-        """
-        Validate against rng schema
-        """
-
-        relaxng_doc = etree.parse(schema)
-        relaxng = etree.RelaxNG(relaxng_doc)
-        if not relaxng(self.xml):
-            error = relaxng.error_log.last_error
-            message = "%s (line %s)" % (error.message, error.line)
-            raise InvalidRSpec(message)
-        return True
-
-    def xpath(self, xpath):
-        return self.xml.xpath(xpath, namespaces=self.namespaces)
 
+    def parse_xml(self, xml):
+        XMLInterface.parse_xml(self, xml)
+        # determine rspec version
+        # look for schema first
+        schema = None
+        self.version = None
+        for key in self.xml.attrib.keys():
+            if key.endswith('schemaLocation'):
+                # schema location should be at the end of the list
+                schema_parts  = self.xml.attrib[key].split(' ')
+                namespace, schema  = schema_parts[0], schema_parts[1]                 
+                break
+
+        if schema:
+            self.version = self.version_manager.get_version_by_schema(schema)
+        else:
+            # TODO: probably isn't safe to assume use default version here
+            # should probably fault if we arent certain  
+            self.version = self.version_manager.get_version()
+        self.version.xml = self.xml    
+        self.namespaces = self.version.namespaces
+    
     def load_rspec_elements(self, rspec_elements):
         self.elements = {}
         for rspec_element in rspec_elements:
@@ -108,86 +77,6 @@ class RSpec:
             raise InvalidRSpecElement(element_type, extra=msg)
         return self.elements[element_type]
 
-    def add_attribute(self, elem, name, value):
-        """
-        Add attribute to specified etree element    
-        """
-        opt = etree.SubElement(elem, name)
-        opt.text = value
-
-    def add_element(self, name, attrs={}, parent=None, text=""):
-        """
-        Generic wrapper around etree.SubElement(). Adds an element to 
-        specified parent node. Adds element to root node is parent is 
-        not specified. 
-        """
-        if parent == None:
-            parent = self.xml
-        element = etree.SubElement(parent, name)
-        if text:
-            element.text = text
-        if isinstance(attrs, dict):
-            for attr in attrs:
-                element.set(attr, attrs[attr])  
-        return element
-
-    def remove_attribute(self, elem, name, value):
-        """
-        Removes an attribute from an element
-        """
-        if elem is not None:
-            opts = elem.iterfind(name)
-            if opts is not None:
-                for opt in opts:
-                    if opt.text == value:
-                        elem.remove(opt)
-
-    def remove_element(self, element_name, root_node = None):
-        """
-        Removes all occurences of an element from the tree. Start at 
-        specified root_node if specified, otherwise start at tree's root.   
-        """
-        if not root_node:
-            root_node = self.xml
-
-        if not element_name.startswith('//'):
-            element_name = '//' + element_name
-
-        elements = root_node.xpath('%s ' % element_name, namespaces=self.namespaces)
-        for element in elements:
-            parent = element.getparent()
-            parent.remove(element)
-
-    def attributes_list(self, elem):
-        # convert a list of attribute tags into list of tuples
-        # (tagnme, text_value)
-        opts = []
-        if elem is not None:
-            for e in elem:
-                opts.append((e.tag, str(e.text).strip()))
-        return opts
-
-    def get_element_attributes(self, elem=None, depth=0):
-        if elem == None:
-            elem = self.root_node
-        if not hasattr(elem, 'attrib'):
-            # this is probably not an element node with attribute. could be just and an
-            # attribute, return it
-            return elem
-        attrs = dict(elem.attrib)
-        attrs['text'] = str(elem.text).strip()
-        attrs['parent'] = elem.getparent()
-        if isinstance(depth, int) and depth > 0:
-            for child_elem in list(elem):
-                key = str(child_elem.tag)
-                if key not in attrs:
-                    attrs[key] = [self.get_element_attributes(child_elem, depth-1)]
-                else:
-                    attrs[key].append(self.get_element_attributes(child_elem, depth-1))
-        else:
-            attrs['child_nodes'] = list(elem)
-        return attrs
-
     def get(self, element_type, filter={}, depth=0):
         elements = self.get_elements(element_type, filter)
         elements = [self.get_element_attributes(element, depth=depth) for element in elements]
@@ -208,12 +97,6 @@ class RSpec:
     def merge(self, in_rspec):
         pass
 
-    def cleanup(self):
-        """
-        Optional method which inheriting classes can choose to implent. 
-        """
-        pass 
-
     def _process_slivers(self, slivers):
         """
         Creates a dict of sliver details for each sliver host
@@ -231,24 +114,11 @@ class RSpec:
                 dicts.append({'hostname': sliver}) 
         return dicts
 
-    def __str__(self):
-        return self.toxml()
-
-    def toxml(self, cleanup=False):
-        if cleanup:
-            self.cleanup()
-        return self.header + etree.tostring(self.xml, pretty_print=True)  
-        
-    def save(self, filename):
-        f = open(filename, 'w')
-        f.write(self.toxml())
-        f.close()
 if __name__ == '__main__':
     rspec = RSpec('/tmp/resources.rspec')
     print rspec
-    #rspec.register_rspec_element(RSpecElements.NETWORK, 'network', '//network')
-    #rspec.register_rspec_element(RSpecElements.NODE, 'node', '//node')
-    #print rspec.find(RSpecElements.NODE)[0]
-    #print rspec.find(RSpecElements.NODE, depth=1)[0]
+    rspec.register_rspec_element(RSpecElements.NETWORK, 'network', '//network')
+    rspec.register_rspec_element(RSpecElements.NODE, 'node', '//node')
+    print rspec.get(RSpecElements.NODE)[0]
+    print rspec.get(RSpecElements.NODE, depth=1)[0]