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