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