sfa/rspecs/sfa_rspec.py

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