3 from StringIO import StringIO
4 from datetime import datetime, timedelta
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
16 for (key, value) in filter.items():
21 if isinstance(value, str):
22 filter_list.append('%s="%s"' % (key, value))
23 elif isinstance(value, list):
24 filter_list.append('contains("%s", %s)' % (' '.join(map(str, value)), key))
26 xpath = ' and '.join(filter_list)
27 xpath = '[' + xpath + ']'
31 header = '<?xml version="1.0"?>\n'
32 template = """<RSpec></RSpec>"""
39 def __init__(self, rspec="", namespaces={}, type=None, user_options={}):
41 self.user_options = user_options
44 self.parse_rspec(rspec, namespaces)
52 # eg. 2011-03-23T19:53:28Z
53 date_format = '%Y-%m-%dT%H:%M:%SZ'
54 now = datetime.utcnow()
55 generated_ts = now.strftime(date_format)
56 expires_ts = (now + timedelta(hours=1)).strftime(date_format)
57 self.parse_rspec(self.template, self.namespaces)
58 self.xml.set('expires', expires_ts)
59 self.xml.set('generated', generated_ts)
61 def parse_rspec(self, rspec, namespaces={}):
63 parse rspec into etree
65 parser = etree.XMLParser(remove_blank_text=True)
67 tree = etree.parse(rspec, parser)
69 # 'rspec' file doesnt exist. 'rspec' is proably an xml string
71 tree = etree.parse(StringIO(rspec), parser)
73 raise InvalidRSpec(str(e))
74 self.xml = tree.getroot()
76 self.namespaces = namespaces
78 def validate(self, schema):
80 Validate against rng schema
83 relaxng_doc = etree.parse(schema)
84 relaxng = etree.RelaxNG(relaxng_doc)
85 if not relaxng(self.xml):
86 error = relaxng.error_log.last_error
87 message = "%s (line %s)" % (error.message, error.line)
88 raise InvalidRSpec(message)
91 def xpath(self, xpath):
92 return self.xml.xpath(xpath, namespaces=self.namespaces)
94 def load_rspec_elements(self, rspec_elements):
96 for rspec_element in rspec_elements:
97 if isinstance(rspec_element, RSpecElement):
98 self.elements[rspec_element.type] = rspec_element
100 def register_rspec_element(self, element_type, element_name, element_path):
101 if element_type not in RSpecElements:
102 raise InvalidRSpecElement(element_type, extra="no such element type: %s. Must specify a valid RSpecElement" % element_type)
103 self.elements[element_type] = RSpecElement(element_type, element_name, element_path)
105 def get_rspec_element(self, element_type):
106 if element_type not in self.elements:
107 msg = "ElementType %s not registerd for this rspec" % element_type
108 raise InvalidRSpecElement(element_type, extra=msg)
109 return self.elements[element_type]
111 def add_attribute(self, elem, name, value):
113 Add attribute to specified etree element
115 opt = etree.SubElement(elem, name)
118 def add_element(self, name, attrs={}, parent=None, text=""):
120 Generic wrapper around etree.SubElement(). Adds an element to
121 specified parent node. Adds element to root node is parent is
126 element = etree.SubElement(parent, name)
129 if isinstance(attrs, dict):
131 element.set(attr, attrs[attr])
134 def remove_attribute(self, elem, name, value):
136 Removes an attribute from an element
139 opts = elem.iterfind(name)
142 if opt.text == value:
145 def remove_element(self, element_name, root_node = None):
147 Removes all occurences of an element from the tree. Start at
148 specified root_node if specified, otherwise start at tree's root.
153 if not element_name.startswith('//'):
154 element_name = '//' + element_name
156 elements = root_node.xpath('%s ' % element_name, namespaces=self.namespaces)
157 for element in elements:
158 parent = element.getparent()
159 parent.remove(element)
161 def attributes_list(self, elem):
162 # convert a list of attribute tags into list of tuples
163 # (tagnme, text_value)
167 opts.append((e.tag, str(e.text).strip()))
170 def get_element_attributes(self, elem=None, depth=0):
172 elem = self.root_node
173 if not hasattr(elem, 'attrib'):
174 # this is probably not an element node with attribute. could be just and an
175 # attribute, return it
177 attrs = dict(elem.attrib)
178 attrs['text'] = str(elem.text).strip()
179 attrs['parent'] = elem.getparent()
180 if isinstance(depth, int) and depth > 0:
181 for child_elem in list(elem):
182 key = str(child_elem.tag)
184 attrs[key] = [self.get_element_attributes(child_elem, depth-1)]
186 attrs[key].append(self.get_element_attributes(child_elem, depth-1))
188 attrs['child_nodes'] = list(elem)
191 def get(self, element_type, filter={}, depth=0):
192 elements = self.get_elements(element_type, filter)
193 elements = [self.get_element_attributes(element, depth=depth) for element in elements]
196 def get_elements(self, element_type, filter={}):
198 search for a registered element
200 if element_type not in self.elements:
201 msg = "Unable to search for element %s in rspec, expath expression not found." % \
203 raise InvalidRSpecElement(element_type, extra=msg)
204 rspec_element = self.get_rspec_element(element_type)
205 xpath = rspec_element.path + XpathFilter.xpath(filter)
206 return self.xpath(xpath)
208 def merge(self, in_rspec):
213 Optional method which inheriting classes can choose to implent.
217 def _process_slivers(self, slivers):
219 Creates a dict of sliver details for each sliver host
221 @param slivers a single hostname, list of hostanmes or list of dicts keys on hostname,
222 Returns a list of dicts
224 if not isinstance(slivers, list):
227 for sliver in slivers:
228 if isinstance(sliver, dict):
230 elif isinstance(sliver, basestring):
231 dicts.append({'hostname': sliver})
237 def toxml(self, cleanup=False):
240 return self.header + etree.tostring(self.xml, pretty_print=True)
242 def save(self, filename):
243 f = open(filename, 'w')
244 f.write(self.toxml())
247 if __name__ == '__main__':
248 rspec = RSpec('/tmp/resources.rspec')
250 #rspec.register_rspec_element(RSpecElements.NETWORK, 'network', '//network')
251 #rspec.register_rspec_element(RSpecElements.NODE, 'node', '//node')
252 #print rspec.find(RSpecElements.NODE)[0]
253 #print rspec.find(RSpecElements.NODE, depth=1)[0]