sfa/rspecs/sfa_rspec.py

   1 #!/usr/bin/python
   2 from copy import deepcopy
   3 from lxml import etree
   4 from StringIO import StringIO
   5 from sfa.rspecs.rspec import RSpec
   6 from sfa.util.xrn import *
   7 from sfa.util.plxrn import hostname_to_urn
   8 from sfa.util.config import Config
   9 from sfa.rspecs.rspec_version import RSpecVersion
  10
  11
  12 _version = { 'type': 'SFA',
  13              'version': '1'
  14 }
  15
  16 sfa_rspec_version = RSpecVersion(_version)
  17
  18 class SfaRSpec(RSpec):
  19     xml = None
  20     header = '<?xml version="1.0"?>\n'
  21     version = sfa_rspec_version
  22
  23     def create(self):
  24         RSpec.create(self)
  25         self.xml.set('type', 'SFA')
  26
  27     ###################
  28     # Parser
  29     ###################
  30     def get_network_elements(self):
  31         return self.xml.xpath('//network')
  32
  33     def get_networks(self):
  34         return self.xml.xpath('//network[@name]/@name')
  35
  36     def get_node_element(self, hostname, network=None):
  37         if network:
  38             names = self.xml.xpath('//network[@name="%s"]//node/hostname' % network)
  39         else:
  40             names = self.xml.xpath('//node/hostname')
  41         for name in names:
  42             if str(name.text).strip() == hostname:
  43                 return name.getparent()
  44         return None
  45
  46     def get_node_elements(self, network=None):
  47         if network:
  48             return self.xml.xpath('//network[@name="%s"]//node' % network)
  49         else:
  50             return self.xml.xpath('//node')
  51
  52     def get_nodes(self, network=None):
  53         if network == None:
  54             nodes = self.xml.xpath('//node/hostname/text()')
  55         else:
  56             nodes = self.xml.xpath('//network[@name="%s"]//node/hostname/text()' % network)
  57
  58         nodes = [node.strip() for node in nodes]
  59         return nodes
  60
  61     def get_nodes_with_slivers(self, network = None):
  62         if network:
  63             nodes =  self.xml.xpath('//network[@name="%s"]//node[sliver]/hostname/text()' % network)
  64         else:
  65             nodes = self.xml.xpath('//node[sliver]/hostname/text()')
  66
  67         nodes = [node.strip() for node in nodes]
  68         return nodes
  69
  70     def get_nodes_without_slivers(self, network=None):
  71         xpath_nodes_without_slivers = '//node[not(sliver)]/hostname/text()'
  72         xpath_nodes_without_slivers_in_network = '//network[@name="%s"]//node[not(sliver)]/hostname/text()'
  73         if network:
  74             return self.xml.xpath('//network[@name="%s"]//node[not(sliver)]/hostname/text()' % network)
  75         else:
  76             return self.xml.xpath('//node[not(sliver)]/hostname/text()')
  77
  78
  79     def attributes_list(self, elem):
  80         # convert a list of attribute tags into list of tuples
  81         # (tagnme, text_value)
  82         opts = []
  83         if elem is not None:
  84             for e in elem:
  85                 opts.append((e.tag, str(e.text).strip()))
  86         return opts
  87
  88     def get_default_sliver_attributes(self, network=None):
  89         if network:
  90             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
  91         else:
  92             defaults = self.xml.xpath("//sliver_defaults")
  93         if isinstance(defaults, list) and defaults:
  94             defaults = defaults[0]
  95         return self.attributes_list(defaults)
  96
  97     def get_sliver_attributes(self, hostname, network=None):
  98         attributes = []
  99         node = self.get_node_element(hostname, network)
 100         #sliver = node.find("sliver")
 101         slivers = node.xpath('./sliver')
 102         if isinstance(slivers, list) and slivers:
 103             attributes = self.attributes_list(slivers[0])
 104         return attributes
 105
 106     def get_slice_attributes(self, network=None):
 107         slice_attributes = []
 108         nodes_with_slivers = self.get_nodes_with_slivers(network)
 109         for default_attribute in self.get_default_sliver_attributes(network):
 110             attribute = {'name': str(default_attribute[0]), 'value': str(default_attribute[1]), 'node_id': None}
 111             slice_attributes.append(attribute)
 112         for node in nodes_with_slivers:
 113             sliver_attributes = self.get_sliver_attributes(node, network)
 114             for sliver_attribute in sliver_attributes:
 115                 attribute = {'name': str(sliver_attribute[0]), 'value': str(sliver_attribute[1]), 'node_id': node}
 116                 slice_attributes.append(attribute)
 117         return slice_attributes
 118
 119     def get_site_nodes(self, siteid, network=None):
 120         if network:
 121             nodes = self.xml.xpath('//network[@name="%s"]/site[@id="%s"]/node/hostname/text()' % \
 122                                     (network, siteid))
 123         else:
 124             nodes = self.xml.xpath('//site[@id="%s"]/node/hostname/text()' % siteid)
 125         return nodes
 126
 127     def get_links(self, network=None):
 128         if network:
 129             links = self.xml.xpath('//network[@name="%s"]/link' % network)
 130         else:
 131             links = self.xml.xpath('//link')
 132         linklist = []
 133         for link in links:
 134             (end1, end2) = link.get("endpoints").split()
 135             name = link.find("description")
 136             linklist.append((name.text,
 137                              self.get_site_nodes(end1, network),
 138                              self.get_site_nodes(end2, network)))
 139         return linklist
 140
 141     def get_link(self, fromnode, tonode, network=None):
 142         fromsite = fromnode.getparent()
 143         tosite = tonode.getparent()
 144         fromid = fromsite.get("id")
 145         toid = tosite.get("id")
 146         if network:
 147             query = "//network[@name='%s']" % network + "/link[@endpoints = '%s %s']"
 148         else:
 149             query = "//link[@endpoints = '%s %s']"
 150
 151         results = self.rspec.xpath(query % (fromid, toid))
 152         if not results:
 153             results = self.rspec.xpath(query % (toid, fromid))
 154         return results
 155
 156     def query_links(self, fromnode, tonode, network=None):
 157         return get_link(fromnode, tonode, network)
 158
 159     def get_vlinks(self, network=None):
 160         vlinklist = []
 161         if network:
 162             vlinks = self.xml.xpath("//network[@name='%s']//vlink" % network)
 163         else:
 164             vlinks = self.xml.xpath("//vlink")
 165         for vlink in vlinks:
 166             endpoints = vlink.get("endpoints")
 167             (end1, end2) = endpoints.split()
 168             if network:
 169                 node1 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
 170                                        (network, end1))[0]
 171                 node2 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
 172                                        (network, end2))[0]
 173             else:
 174                 node1 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end1)[0]
 175                 node2 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end2)[0]
 176             desc = "%s <--> %s" % (node1, node2)
 177             kbps = vlink.find("kbps")
 178             vlinklist.append((endpoints, desc, kbps.text))
 179         return vlinklist
 180
 181     def get_vlink(self, endponts, network=None):
 182         if network:
 183             query = "//network[@name='%s']//vlink[@endpoints = '%s']" % (network, endpoints)
 184         else:
 185             query = "//vlink[@endpoints = '%s']" % (network, endpoints)
 186         results = self.rspec.xpath(query)
 187         return results
 188
 189     def query_vlinks(self, endpoints, network=None):
 190         return get_vlink(endpoints,network)
 191
 192     ##################
 193     # Builder
 194     ##################
 195
 196     def add_network(self, network):
 197         network_tags = self.xml.xpath('//network[@name="%s"]' % network)
 198         if not network_tags:
 199             network_tag = etree.SubElement(self.xml, 'network', name=network)
 200         else:
 201             network_tag = network_tags[0]
 202         return network_tag
 203
 204     def add_nodes(self, nodes, network = None, no_dupes=False):
 205         if not isinstance(nodes, list):
 206             nodes = [nodes]
 207         for node in nodes:
 208             if no_dupes and \
 209               self.get_node_element(node['hostname']):
 210                 # node already exists
 211                 continue
 212
 213             network_tag = self.xml
 214             if 'network' in node:
 215                 network = node['network']
 216                 network_tag = self.add_network(network)
 217
 218             node_tag = etree.SubElement(network_tag, 'node')
 219             if 'network' in node:
 220                 node_tag.set('component_manager_id', hrn_to_urn(network, 'authority+sa'))
 221             if 'urn' in node:
 222                 node_tag.set('component_id', node['urn'])
 223             if 'site_urn' in node:
 224                 node_tag.set('site_id', node['site_urn'])
 225             if 'node_id' in node:
 226                 node_tag.set('node_id', 'n'+str(node['node_id']))
 227             if 'boot_state' in node:
 228                 node_tag.set('boot_state', node['boot_state'])
 229             if 'hostname' in node:
 230                 hostname_tag = etree.SubElement(node_tag, 'hostname').text = node['hostname']
 231             if 'interfaces' in node:
 232                 for interface in node['interfaces']:
 233                     if 'bwlimit' in interface and interface['bwlimit']:
 234                         bwlimit = etree.SubElement(node_tag, 'bw_limit', units='kbps').text = str(interface['bwlimit']/1000)
 235             if 'tags' in node:
 236                 for tag in node['tags']:
 237                    # expose this hard wired list of tags, plus the ones that are marked 'sfa' in their category
 238                    if tag['tagname'] in ['fcdistro', 'arch'] or 'sfa' in tag['category'].split('/'):
 239                         tag_element = etree.SubElement(node_tag, tag['tagname']).text=tag['value']
 240
 241             if 'site' in node:
 242                 longitude = str(node['site']['longitude'])
 243                 latitude = str(node['site']['latitude'])
 244                 location = etree.SubElement(node_tag, 'location', country='unknown', \
 245                                             longitude=longitude, latitude=latitude)
 246
 247     def merge_node(self, source_node_tag, network, no_dupes=False):
 248         if no_dupes and self.get_node_element(node['hostname']):
 249             # node already exists
 250             return
 251
 252         network_tag = self.add_network(network)
 253         network_tag.append(deepcopy(source_node_tag))
 254
 255     def add_interfaces(self, interfaces):
 256         pass
 257
 258     def add_links(self, links):
 259         pass
 260
 261     def add_slivers(self, slivers, network=None, sliver_urn=None, no_dupes=False):
 262         # add slice name to network tag
 263         network_tags = self.xml.xpath('//network')
 264         if network_tags:
 265             network_tag = network_tags[0]
 266             network_tag.set('slice', urn_to_hrn(sliver_urn)[0])
 267         slivers = self._process_slivers(slivers)
 268         nodes_with_slivers = self.get_nodes_with_slivers(network)
 269         for sliver in slivers:
 270             if sliver['hostname'] in nodes_with_slivers:
 271                 continue
 272             node_elem = self.get_node_element(sliver['hostname'], network)
 273             sliver_elem = etree.SubElement(node_elem, 'sliver')
 274             if 'tags' in sliver:
 275                 for tag in sliver['tags']:
 276                     etree.SubElement(sliver_elem, tag['tagname']).text = value=tag['value']
 277
 278     def remove_slivers(self, slivers, network=None, no_dupes=False):
 279         slivers = self._process_slivers(slivers)
 280         for sliver in slivers:
 281             node_elem = self.get_node_element(sliver['hostname'], network)
 282             sliver_elem = node_elem.find('sliver')
 283             if sliver_elem != None:
 284                 node_elem.remove(sliver_elem)
 285
 286     def add_default_sliver_attribute(self, name, value, network=None):
 287         if network:
 288             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
 289         else:
 290             defaults = self.xml.xpath("//sliver_defaults" % network)
 291         if not defaults :
 292             network_tag = self.xml.xpath("//network[@name='%s']" % network)
 293             if isinstance(network_tag, list):
 294                 network_tag = network_tag[0]
 295             defaults = self.add_element('sliver_defaults', attrs={}, parent=network_tag)
 296         elif isinstance(defaults, list):
 297             defaults = defaults[0]
 298         self.add_attribute(defaults, name, value)
 299
 300     def add_sliver_attribute(self, hostname, name, value, network=None):
 301         node = self.get_node_element(hostname, network)
 302         sliver = node.find("sliver")
 303         self.add_attribute(sliver, name, value)
 304
 305     def remove_default_sliver_attribute(self, name, value, network=None):
 306         if network:
 307             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
 308         else:
 309             defaults = self.xml.xpath("//sliver_defaults" % network)
 310         self.remove_attribute(defaults, name, value)
 311
 312     def remove_sliver_attribute(self, hostname, name, value, network=None):
 313         node = self.get_node_element(hostname, network)
 314         sliver = node.find("sliver")
 315         self.remove_attribute(sliver, name, value)
 316
 317     def add_vlink(self, fromhost, tohost, kbps, network=None):
 318         fromnode = self.get_node_element(fromhost, network)
 319         tonode = self.get_node_element(tohost, network)
 320         links = self.get_link(fromnode, tonode, network)
 321
 322         for link in links:
 323             vlink = etree.SubElement(link, "vlink")
 324             fromid = fromnode.get("id")
 325             toid = tonode.get("id")
 326             vlink.set("endpoints", "%s %s" % (fromid, toid))
 327             self.add_attribute(vlink, "kbps", kbps)
 328
 329
 330     def remove_vlink(self, endpoints, network=None):
 331         vlinks = self.query_vlinks(endpoints, network)
 332         for vlink in vlinks:
 333             vlink.getparent().remove(vlink)
 334
 335
 336     def merge(self, in_rspec):
 337         """
 338         Merge contents for specified rspec with current rspec
 339         """
 340
 341         from sfa.rspecs.rspec_parser import parse_rspec
 342         rspec = parse_rspec(in_rspec)
 343         if rspec.type.lower() == 'protogeni':
 344             from sfa.rspecs.rspec_converter import RSpecConverter
 345             in_rspec = RSpecConverter.to_sfa_rspec(in_rspec)
 346
 347         # just copy over all networks
 348         current_networks = self.get_networks()
 349         rspec = SfaRSpec(rspec=in_rspec)
 350         networks = rspec.get_network_elements()
 351         for network in networks:
 352             current_network = network.get('name')
 353             if current_network and current_network not in current_networks:
 354                 self.xml.append(network)
 355                 current_networks.append(current_network)
 356
 357
 358
 359
 360 if __name__ == '__main__':
 361     rspec = SfaRSpec()
 362     nodes = [
 363     {'network': 'plc',
 364      'hostname': 'node1.planet-lab.org',
 365      'site_urn': 'urn:publicid:IDN+plc+authority+cm',
 366       'node_id': 1,
 367     },
 368     {'network': 'plc',
 369      'hostname': 'node2.planet-lab.org',
 370      'site_urn': 'urn:publicid:IDN+plc+authority+cm',
 371       'node_id': 1,
 372     },
 373     {'network': 'ple',
 374      'hostname': 'node1.planet-lab.eu',
 375      'site_urn': 'urn:publicid:IDN+plc+authority+cm',
 376       'node_id': 1,
 377     },
 378     ]
 379     rspec.add_nodes(nodes)
 380     print rspec