class RSpec:
header = '<?xml version="1.0"?>\n'
template = """<RSpec></RSpec>"""
- namespaces = {}
config = Config()
xml = None
+ type = None
+ version = None
+ namespaces = None
+ user_options = {}
- def __init__(self, rspec="", namespaces={}):
+ def __init__(self, rspec="", namespaces={}, type=None, user_options={}):
+ self.type = type
+ self.user_options = user_options
if rspec:
self.parse_rspec(rspec, namespaces)
else:
self.create()
- def create(self, type="advertisement"):
+ def create(self):
+ """
+ Create root element
+ """
# 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('valid_until', expires_ts)
+ 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)
tree = etree.parse(StringIO(rspec), parser)
except:
raise InvalidRSpec('Must specify a xml file or xml string. Received: ' + rspec )
-
self.xml = tree.getroot()
if namespaces:
self.namespaces = namespaces
+ def xpath(self, xpath):
+ return this.xml.xpath(xpath, namespaces=self.namespaces)
+
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:
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 merge(self, in_rspec):
+ pass
def validate(self, schema):
+ """
+ Validate against rng schema
+ """
+
relaxng_doc = etree.parse(schema)
relaxng = etree.RelaxNG(relaxng_doc)
if not relaxng(self.xml):
raise InvalidRSpec(message)
return True
+ 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
+
+ @param slivers a single hostname, list of hostanmes or list of dicts keys on hostname,
+ Returns a list of dicts
+ """
+ if not isinstance(slivers, list):
+ slivers = [slivers]
+ dicts = []
+ for sliver in slivers:
+ if isinstance(sliver, dict):
+ dicts.append(sliver)
+ elif isinstance(sliver, basestring):
+ dicts.append({'hostname': sliver})
+ return dicts
def __str__(self):
return self.toxml()
- def toxml(self):
+ def toxml(self, cleanup=False):
+ if cleanup:
+ self.cleanup()
return self.header + etree.tostring(self.xml, pretty_print=True)
def save(self, filename):