3 from StringIO import StringIO
4 from sfa.rspecs.rspec import RSpec
5 from sfa.util.xrn import *
6 from sfa.util.plxrn import hostname_to_urn
7 from sfa.util.config import Config
8 from sfa.rspecs.rspec_version import RSpecVersion
11 _version = { 'type': 'SFA',
15 sfa_rspec_version = RSpecVersion(_version)
17 class SfaRSpec(RSpec):
19 header = '<?xml version="1.0"?>\n'
20 version = sfa_rspec_version
24 self.xml.set('type', 'SFA')
29 def get_network_elements(self):
30 return self.xml.xpath('//network')
32 def get_networks(self):
33 return self.xml.xpath('//network[@name]/@name')
35 def get_node_element(self, hostname, network=None):
37 names = self.xml.xpath('//network[@name="%s"]//node/hostname' % network)
39 names = self.xml.xpath('//node/hostname')
41 if str(name.text).strip() == hostname:
42 return name.getparent()
45 def get_node_elements(self, network=None):
47 return self.xml.xpath('//network[@name="%s"]//node' % network)
49 return self.xml.xpath('//node')
51 def get_nodes(self, network=None):
53 nodes = self.xml.xpath('//node/hostname/text()')
55 nodes = self.xml.xpath('//network[@name="%s"]//node/hostname/text()' % network)
57 nodes = [node.strip() for node in nodes]
60 def get_nodes_with_slivers(self, network = None):
62 nodes = self.xml.xpath('//network[@name="%s"]//node[sliver]/hostname/text()' % network)
64 nodes = self.xml.xpath('//node[sliver]/hostname/text()')
66 nodes = [node.strip() for node in nodes]
69 def get_nodes_without_slivers(self, network=None):
70 xpath_nodes_without_slivers = '//node[not(sliver)]/hostname/text()'
71 xpath_nodes_without_slivers_in_network = '//network[@name="%s"]//node[not(sliver)]/hostname/text()'
73 return self.xml.xpath('//network[@name="%s"]//node[not(sliver)]/hostname/text()' % network)
75 return self.xml.xpath('//node[not(sliver)]/hostname/text()')
78 def attributes_list(self, elem):
79 # convert a list of attribute tags into list of tuples
80 # (tagnme, text_value)
84 opts.append((e.tag, str(e.text).strip()))
87 def get_default_sliver_attributes(self, network=None):
89 defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
91 defaults = self.xml.xpath("//sliver_defaults")
92 if isinstance(defaults, list) and defaults:
93 defaults = defaults[0]
94 return self.attributes_list(defaults)
96 def get_sliver_attributes(self, hostname, network=None):
98 node = self.get_node_element(hostname, network)
99 #sliver = node.find("sliver")
100 slivers = node.xpath('./sliver')
101 if isinstance(slivers, list) and slivers:
102 attributes = self.attributes_list(slivers[0])
105 def get_slice_attributes(self, network=None):
106 slice_attributes = []
107 nodes_with_slivers = self.get_nodes_with_slivers(network)
108 for default_attribute in self.get_default_sliver_attributes(network):
109 attribute = {'name': str(default_attribute[0]), 'value': str(default_attribute[1]), 'node_id': None}
110 slice_attributes.append(attribute)
111 for node in nodes_with_slivers:
112 sliver_attributes = self.get_sliver_attributes(node, network)
113 for sliver_attribute in sliver_attributes:
114 attribute = {'name': str(sliver_attribute[0]), 'value': str(sliver_attribute[1]), 'node_id': node}
115 slice_attributes.append(attribute)
116 return slice_attributes
118 def get_site_nodes(self, siteid, network=None):
120 nodes = self.xml.xpath('//network[@name="%s"]/site[@id="%s"]/node/hostname/text()' % \
123 nodes = self.xml.xpath('//site[@id="%s"]/node/hostname/text()' % siteid)
126 def get_links(self, network=None):
128 links = self.xml.xpath('//network[@name="%s"]/link' % network)
130 links = self.xml.xpath('//link')
133 (end1, end2) = link.get("endpoints").split()
134 name = link.find("description")
135 linklist.append((name.text,
136 self.get_site_nodes(end1, network),
137 self.get_site_nodes(end2, network)))
140 def get_link(self, fromnode, tonode, network=None):
141 fromsite = fromnode.getparent()
142 tosite = tonode.getparent()
143 fromid = fromsite.get("id")
144 toid = tosite.get("id")
146 query = "//network[@name='%s']" % network + "/link[@endpoints = '%s %s']"
148 query = "//link[@endpoints = '%s %s']"
150 results = self.rspec.xpath(query % (fromid, toid))
152 results = self.rspec.xpath(query % (toid, fromid))
155 def query_links(self, fromnode, tonode, network=None):
156 return get_link(fromnode, tonode, network)
158 def get_vlinks(self, network=None):
161 vlinks = self.xml.xpath("//network[@name='%s']//vlink" % network)
163 vlinks = self.xml.xpath("//vlink")
165 endpoints = vlink.get("endpoints")
166 (end1, end2) = endpoints.split()
168 node1 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
170 node2 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
173 node1 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end1)[0]
174 node2 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end2)[0]
175 desc = "%s <--> %s" % (node1, node2)
176 kbps = vlink.find("kbps")
177 vlinklist.append((endpoints, desc, kbps.text))
180 def get_vlink(self, endponts, network=None):
182 query = "//network[@name='%s']//vlink[@endpoints = '%s']" % (network, endpoints)
184 query = "//vlink[@endpoints = '%s']" % (network, endpoints)
185 results = self.rspec.xpath(query)
188 def query_vlinks(self, endpoints, network=None):
189 return get_vlink(endpoints,network)
195 def add_network(self, network):
196 network_tags = self.xml.xpath('//network[@name="%s"]' % network)
198 network_tag = etree.SubElement(self.xml, 'network', name=network)
200 network_tag = network_tags[0]
203 def add_nodes(self, nodes, network = None, no_dupes=False):
204 if not isinstance(nodes, list):
208 self.get_node_element(node['hostname']):
209 # node already exists
212 network_tag = self.xml
213 if 'network' in node:
214 network = node['network']
215 network_tag = self.add_network(network)
217 node_tag = etree.SubElement(network_tag, 'node')
218 if 'network' in node:
219 node_tag.set('component_manager_id', hrn_to_urn(network, 'authority+sa'))
221 node_tag.set('component_id', node['urn'])
222 if 'site_urn' in node:
223 node_tag.set('site_id', node['site_urn'])
224 if 'node_id' in node:
225 node_tag.set('node_id', 'n'+str(node['node_id']))
226 if 'boot_state' in node:
227 node_tag.set('boot_state', node['boot_state'])
228 if 'hostname' in node:
229 hostname_tag = etree.SubElement(node_tag, 'hostname').text = node['hostname']
230 if 'interfaces' in node:
231 for interface in node['interfaces']:
232 if 'bwlimit' in interface and interface['bwlimit']:
233 bwlimit = etree.SubElement(node_tag, 'bw_limit', units='kbps').text = str(interface['bwlimit']/1000)
235 for tag in node['tags']:
236 # expose this hard wired list of tags, plus the ones that are marked 'sfa' in their category
237 if tag['tagname'] in ['fcdistro', 'arch'] or 'sfa' in tag['category'].split('/'):
238 tag_element = etree.SubElement(node_tag, tag['tagname']).text=tag['value']
241 longitude = str(node['site']['longitude'])
242 latitude = str(node['site']['latitude'])
243 location = etree.SubElement(node_tag, 'location', country='unknown', \
244 longitude=longitude, latitude=latitude)
246 def add_interfaces(self, interfaces):
249 def add_links(self, links):
252 def add_slivers(self, slivers, network=None, sliver_urn=None, no_dupes=False):
253 # add slice name to network tag
254 network_tags = self.xml.xpath('//network')
256 network_tag = network_tags[0]
257 network_tag.set('slice', urn_to_hrn(sliver_urn)[0])
258 slivers = self._process_slivers(slivers)
259 nodes_with_slivers = self.get_nodes_with_slivers(network)
260 for sliver in slivers:
261 if sliver['hostname'] in nodes_with_slivers:
263 node_elem = self.get_node_element(sliver['hostname'], network)
264 sliver_elem = etree.SubElement(node_elem, 'sliver')
266 for tag in sliver['tags']:
267 etree.SubElement(sliver_elem, tag['tagname']).text = value=tag['value']
269 def remove_slivers(self, slivers, network=None, no_dupes=False):
270 slivers = self._process_slivers(slivers)
271 for sliver in slivers:
272 node_elem = self.get_node_element(sliver['hostname'], network)
273 sliver_elem = node_elem.find('sliver')
274 if sliver_elem != None:
275 node_elem.remove(sliver_elem)
277 def add_default_sliver_attribute(self, name, value, network=None):
279 defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
281 defaults = self.xml.xpath("//sliver_defaults" % network)
283 network_tag = self.xml.xpath("//network[@name='%s']" % network)
284 if isinstance(network_tag, list):
285 network_tag = network_tag[0]
286 defaults = self.add_element('sliver_defaults', attrs={}, parent=network_tag)
287 elif isinstance(defaults, list):
288 defaults = defaults[0]
289 self.add_attribute(defaults, name, value)
291 def add_sliver_attribute(self, hostname, name, value, network=None):
292 node = self.get_node_element(hostname, network)
293 sliver = node.find("sliver")
294 self.add_attribute(sliver, name, value)
296 def remove_default_sliver_attribute(self, name, value, network=None):
298 defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
300 defaults = self.xml.xpath("//sliver_defaults" % network)
301 self.remove_attribute(defaults, name, value)
303 def remove_sliver_attribute(self, hostname, name, value, network=None):
304 node = self.get_node_element(hostname, network)
305 sliver = node.find("sliver")
306 self.remove_attribute(sliver, name, value)
308 def add_vlink(self, fromhost, tohost, kbps, network=None):
309 fromnode = self.get_node_element(fromhost, network)
310 tonode = self.get_node_element(tohost, network)
311 links = self.get_link(fromnode, tonode, network)
314 vlink = etree.SubElement(link, "vlink")
315 fromid = fromnode.get("id")
316 toid = tonode.get("id")
317 vlink.set("endpoints", "%s %s" % (fromid, toid))
318 self.add_attribute(vlink, "kbps", kbps)
321 def remove_vlink(self, endpoints, network=None):
322 vlinks = self.query_vlinks(endpoints, network)
324 vlink.getparent().remove(vlink)
327 def merge(self, in_rspec):
329 Merge contents for specified rspec with current rspec
332 from sfa.rspecs.rspec_parser import parse_rspec
333 rspec = parse_rspec(in_rspec)
334 if rspec.type.lower() == 'protogeni':
335 from sfa.rspecs.rspec_converter import RSpecConverter
336 in_rspec = RSpecConverter.to_sfa_rspec(in_rspec)
338 # just copy over all networks
339 current_networks = self.get_networks()
340 rspec = SfaRSpec(rspec=in_rspec)
341 networks = rspec.get_network_elements()
342 for network in networks:
343 current_network = network.get('name')
344 if current_network and current_network not in current_networks:
345 self.xml.append(network)
346 current_networks.append(current_network)
351 if __name__ == '__main__':
355 'hostname': 'node1.planet-lab.org',
356 'site_urn': 'urn:publicid:IDN+plc+authority+cm',
360 'hostname': 'node2.planet-lab.org',
361 'site_urn': 'urn:publicid:IDN+plc+authority+cm',
365 'hostname': 'node1.planet-lab.eu',
366 'site_urn': 'urn:publicid:IDN+plc+authority+cm',
370 rspec.add_nodes(nodes)