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