2 from sfa.util.xrn import hrn_to_urn, urn_to_hrn
3 from sfa.rspecs.rspec_version import BaseVersion
4 from sfa.rspecs.rspec_elements import RSpecElement, RSpecElements
6 class SFAv1(BaseVersion):
16 RSpecElement(RSpecElements.NETWORK, 'network', '//network'),
17 RSpecElement(RSpecElements.NODE, 'node', '//node'),
18 RSpecElement(RSpecElements.SLIVER, 'sliver', '//node/sliver'),
20 template = '<RSpec type="%s"></RSpec>' % type
22 def get_network_elements(self):
23 return self.xml.xpath('//network')
25 def get_networks(self):
26 return self.xml.xpath('//network[@name]/@name')
28 def get_node_element(self, hostname, network=None):
30 names = self.xml.xpath('//network[@name="%s"]//node/hostname' % network)
32 names = self.xml.xpath('//node/hostname')
34 if str(name.text).strip() == hostname:
35 return name.getparent()
38 def get_node_elements(self, network=None):
40 return self.xml.xpath('//network[@name="%s"]//node' % network)
42 return self.xml.xpath('//node')
44 def get_nodes(self, network=None):
46 nodes = self.xml.xpath('//node/hostname/text()')
48 nodes = self.xml.xpath('//network[@name="%s"]//node/hostname/text()' % network)
50 nodes = [node.strip() for node in nodes]
53 def get_nodes_with_slivers(self, network = None):
55 nodes = self.xml.xpath('//network[@name="%s"]//node[sliver]/hostname/text()' % network)
57 nodes = self.xml.xpath('//node[sliver]/hostname/text()')
59 nodes = [node.strip() for node in nodes]
62 def get_nodes_without_slivers(self, network=None):
63 xpath_nodes_without_slivers = '//node[not(sliver)]/hostname/text()'
64 xpath_nodes_without_slivers_in_network = '//network[@name="%s"]//node[not(sliver)]/hostname/text()'
66 return self.xml.xpath('//network[@name="%s"]//node[not(sliver)]/hostname/text()' % network)
68 return self.xml.xpath('//node[not(sliver)]/hostname/text()')
70 def attributes_list(self, elem):
71 # convert a list of attribute tags into list of tuples
72 # (tagnme, text_value)
76 opts.append((e.tag, str(e.text).strip()))
79 def get_default_sliver_attributes(self, network=None):
81 defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
83 defaults = self.xml.xpath("//sliver_defaults")
84 if isinstance(defaults, list) and defaults:
85 defaults = defaults[0]
86 return self.attributes_list(defaults)
88 def get_sliver_attributes(self, hostname, network=None):
90 node = self.get_node_element(hostname, network)
91 #sliver = node.find("sliver")
92 slivers = node.xpath('./sliver')
93 if isinstance(slivers, list) and slivers:
94 attributes = self.attributes_list(slivers[0])
97 def get_slice_attributes(self, network=None):
99 nodes_with_slivers = self.get_nodes_with_slivers(network)
100 for default_attribute in self.get_default_sliver_attributes(network):
101 attribute = {'name': str(default_attribute[0]), 'value': str(default_attribute[1]), 'node_id': None}
102 slice_attributes.append(attribute)
103 for node in nodes_with_slivers:
104 sliver_attributes = self.get_sliver_attributes(node, network)
105 for sliver_attribute in sliver_attributes:
106 attribute = {'name': str(sliver_attribute[0]), 'value': str(sliver_attribute[1]), 'node_id': node}
107 slice_attributes.append(attribute)
108 return slice_attributes
110 def get_site_nodes(self, siteid, network=None):
112 nodes = self.xml.xpath('//network[@name="%s"]/site[@id="%s"]/node/hostname/text()' % \
115 nodes = self.xml.xpath('//site[@id="%s"]/node/hostname/text()' % siteid)
118 def get_links(self, network=None):
120 links = self.xml.xpath('//network[@name="%s"]/link' % network)
122 links = self.xml.xpath('//link')
125 (end1, end2) = link.get("endpoints").split()
126 name = link.find("description")
127 linklist.append((name.text,
128 self.get_site_nodes(end1, network),
129 self.get_site_nodes(end2, network)))
132 def get_link(self, fromnode, tonode, network=None):
133 fromsite = fromnode.getparent()
134 tosite = tonode.getparent()
135 fromid = fromsite.get("id")
136 toid = tosite.get("id")
138 query = "//network[@name='%s']" % network + "/link[@endpoints = '%s %s']"
140 query = "//link[@endpoints = '%s %s']"
142 results = self.rspec.xpath(query % (fromid, toid))
144 results = self.rspec.xpath(query % (toid, fromid))
147 def query_links(self, fromnode, tonode, network=None):
148 return get_link(fromnode, tonode, network)
150 def get_vlinks(self, network=None):
153 vlinks = self.xml.xpath("//network[@name='%s']//vlink" % network)
155 vlinks = self.xml.xpath("//vlink")
157 endpoints = vlink.get("endpoints")
158 (end1, end2) = endpoints.split()
160 node1 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
162 node2 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
165 node1 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end1)[0]
166 node2 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end2)[0]
167 desc = "%s <--> %s" % (node1, node2)
168 kbps = vlink.find("kbps")
169 vlinklist.append((endpoints, desc, kbps.text))
172 def get_vlink(self, endponts, network=None):
174 query = "//network[@name='%s']//vlink[@endpoints = '%s']" % (network, endpoints)
176 query = "//vlink[@endpoints = '%s']" % (network, endpoints)
177 results = self.rspec.xpath(query)
180 def query_vlinks(self, endpoints, network=None):
181 return get_vlink(endpoints,network)
188 def add_network(self, network):
189 network_tags = self.xml.xpath('//network[@name="%s"]' % network)
191 network_tag = etree.SubElement(self.xml.root, 'network', name=network)
193 network_tag = network_tags[0]
196 def add_nodes(self, nodes, network = None, no_dupes=False):
197 if not isinstance(nodes, list):
201 self.get_node_element(node['hostname']):
202 # node already exists
205 network_tag = self.xml.root
206 if 'network' in node:
207 network = node['network']
208 network_tag = self.add_network(network)
210 node_tag = etree.SubElement(network_tag, 'node')
211 if 'network' in node:
212 node_tag.set('component_manager_id', hrn_to_urn(network, 'authority+sa'))
214 node_tag.set('component_id', node['urn'])
215 if 'site_urn' in node:
216 node_tag.set('site_id', node['site_urn'])
217 if 'node_id' in node:
218 node_tag.set('node_id', 'n'+str(node['node_id']))
219 if 'boot_state' in node:
220 node_tag.set('boot_state', node['boot_state'])
221 if 'hostname' in node:
222 node_tag.set('component_name', node['hostname'])
223 hostname_tag = etree.SubElement(node_tag, 'hostname').text = node['hostname']
224 if 'interfaces' in node:
225 for interface in node['interfaces']:
226 if 'bwlimit' in interface and interface['bwlimit']:
227 bwlimit = etree.SubElement(node_tag, 'bw_limit', units='kbps').text = str(interface['bwlimit']/1000)
228 if 'bw_unallocated' in node:
229 bw_unallocated = etree.SubElement(node_tag, 'bw_unallocated', units='kbps').text = str(node['bw_unallocated']/1000)
231 for tag in node['tags']:
232 # expose this hard wired list of tags, plus the ones that are marked 'sfa' in their category
233 if tag['tagname'] in ['fcdistro', 'arch'] or 'sfa' in tag['category'].split('/'):
234 tag_element = etree.SubElement(node_tag, tag['tagname']).text=tag['value']
237 longitude = str(node['site']['longitude'])
238 latitude = str(node['site']['latitude'])
239 location = etree.SubElement(node_tag, 'location', country='unknown', \
240 longitude=longitude, latitude=latitude)
242 def merge_node(self, source_node_tag, network, no_dupes=False):
243 if no_dupes and self.get_node_element(node['hostname']):
244 # node already exists
247 network_tag = self.add_network(network)
248 network_tag.append(deepcopy(source_node_tag))
250 def add_interfaces(self, interfaces):
253 def add_links(self, links):
255 network_tag = self.xml.root
256 if link.component_manager_id != None:
257 network_hrn, type = urn_to_hrn(link.component_manager_id)
258 network_tag = self.add_network(network)
260 link_elem = etree.SubElement(network_tag, 'link')
261 link_elem.set('endpoints', '%s %s' % (link.endpoint1.name, link.endpoint2.name))
262 description = etree.SubElement(link_elem, 'description').text = link.description
263 bw_unallocated = etree.SubElement(link_elem, 'bw_unallocated', units='kbps').text = link.capacity
265 def add_slivers(self, slivers, network=None, sliver_urn=None, no_dupes=False):
266 # add slice name to network tag
267 network_tags = self.xml.xpath('//network')
269 network_tag = network_tags[0]
270 network_tag.set('slice', urn_to_hrn(sliver_urn)[0])
272 all_nodes = self.get_nodes()
273 nodes_with_slivers = [sliver['hostname'] for sliver in slivers]
274 nodes_without_slivers = set(all_nodes).difference(nodes_with_slivers)
277 for sliver in slivers:
278 node_elem = self.get_node_element(sliver['hostname'], network)
279 if not node_elem: continue
280 sliver_elem = etree.SubElement(node_elem, 'sliver')
282 for tag in sliver['tags']:
283 etree.SubElement(sliver_elem, tag['tagname']).text = value=tag['value']
285 # remove all nodes without slivers
286 for node in nodes_without_slivers:
287 node_elem = self.get_node_element(node, network)
288 parent = node_elem.getparent()
289 parent.remove(node_elem)
291 def remove_slivers(self, slivers, network=None, no_dupes=False):
292 for sliver in slivers:
293 node_elem = self.get_node_element(sliver['hostname'], network)
294 sliver_elem = node_elem.find('sliver')
295 if sliver_elem != None:
296 node_elem.remove(sliver_elem)
298 def add_default_sliver_attribute(self, name, value, network=None):
300 defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
302 defaults = self.xml.xpath("//sliver_defaults" % network)
304 network_tag = self.xml.xpath("//network[@name='%s']" % network)
305 if isinstance(network_tag, list):
306 network_tag = network_tag[0]
307 defaults = self.xml.add_element('sliver_defaults', attrs={}, parent=network_tag)
308 elif isinstance(defaults, list):
309 defaults = defaults[0]
310 self.xml.add_attribute(defaults, name, value)
312 def add_sliver_attribute(self, hostname, name, value, network=None):
313 node = self.get_node_element(hostname, network)
314 sliver = node.find("sliver")
315 self.xml.add_attribute(sliver, name, value)
317 def remove_default_sliver_attribute(self, name, value, network=None):
319 defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
321 defaults = self.xml.xpath("//sliver_defaults" % network)
322 self.xml.remove_attribute(defaults, name, value)
324 def remove_sliver_attribute(self, hostname, name, value, network=None):
325 node = self.get_node_element(hostname, network)
326 sliver = node.find("sliver")
327 self.xml.remove_attribute(sliver, name, value)
329 def add_vlink(self, fromhost, tohost, kbps, network=None):
330 fromnode = self.get_node_element(fromhost, network)
331 tonode = self.get_node_element(tohost, network)
332 links = self.get_link(fromnode, tonode, network)
335 vlink = etree.SubElement(link, "vlink")
336 fromid = fromnode.get("id")
337 toid = tonode.get("id")
338 vlink.set("endpoints", "%s %s" % (fromid, toid))
339 self.xml.add_attribute(vlink, "kbps", kbps)
342 def remove_vlink(self, endpoints, network=None):
343 vlinks = self.query_vlinks(endpoints, network)
345 vlink.getparent().remove(vlink)
348 def merge(self, in_rspec):
350 Merge contents for specified rspec with current rspec
353 from sfa.rspecs.rspec import RSpec
354 if isinstance(in_rspec, RSpec):
357 rspec = RSpec(in_rspec)
358 if rspec.version.type.lower() == 'protogeni':
359 from sfa.rspecs.rspec_converter import RSpecConverter
360 in_rspec = RSpecConverter.to_sfa_rspec(rspec.toxml())
361 rspec = RSpec(in_rspec)
363 # just copy over all networks
364 current_networks = self.get_networks()
365 networks = rspec.version.get_network_elements()
366 for network in networks:
367 current_network = network.get('name')
368 if current_network and current_network not in current_networks:
369 self.xml.root.append(network)
370 current_networks.append(current_network)
372 if __name__ == '__main__':
373 from sfa.rspecs.rspec import RSpec
374 from sfa.rspecs.rspec_elements import *
375 r = RSpec('/tmp/resources.rspec')
376 r.load_rspec_elements(SFAv1.elements)
377 print r.get(RSpecElements.NODE)