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_slice_attributes(self, network=None):
  95         # TODO: FINISH
  96         return []
  97
  98     def get_site_nodes(self, siteid, network=None):
  99         if network:
 100             nodes = self.xml.xpath('//network[@name="%s"]/site[@id="%s"]/node/hostname/text()' % \
 101                                     (network, siteid))
 102         else:
 103             nodes = self.xml.xpath('//site[@id="%s"]/node/hostname/text()' % siteid)
 104         return nodes
 105
 106     def get_links(self, network=None):
 107         if network:
 108             links = self.xml.xpath('//network[@name="%s"]/link' % network)
 109         else:
 110             links = self.xml.xpath('//link')
 111         linklist = []
 112         for link in links:
 113             (end1, end2) = link.get("endpoints").split()
 114             name = link.find("description")
 115             linklist.append((name.text,
 116                              self.get_site_nodes(end1, network),
 117                              self.get_site_nodes(end2, network)))
 118         return linklist
 119
 120     def get_link(self, fromnode, tonode, network=None):
 121         fromsite = fromnode.getparent()
 122         tosite = tonode.getparent()
 123         fromid = fromsite.get("id")
 124         toid = tosite.get("id")
 125         if network:
 126             query = "//network[@name='%s']" % network + "/link[@endpoints = '%s %s']"
 127         else:
 128             query = "//link[@endpoints = '%s %s']"
 129
 130         results = self.rspec.xpath(query % (fromid, toid))
 131         if not results:
 132             results = self.rspec.xpath(query % (toid, fromid))
 133         return results
 134
 135     def query_links(self, fromnode, tonode, network=None):
 136         return get_link(fromnode, tonode, network)
 137
 138     def get_vlinks(self, network=None):
 139         vlinklist = []
 140         if network:
 141             vlinks = self.xml.xpath("//network[@name='%s']//vlink" % network)
 142         else:
 143             vlinks = self.xml.xpath("//vlink")
 144         for vlink in vlinks:
 145             endpoints = vlink.get("endpoints")
 146             (end1, end2) = endpoints.split()
 147             if network:
 148                 node1 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
 149                                        (network, end1))[0]
 150                 node2 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
 151                                        (network, end2))[0]
 152             else:
 153                 node1 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end1)[0]
 154                 node2 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end2)[0]
 155             desc = "%s <--> %s" % (node1, node2)
 156             kbps = vlink.find("kbps")
 157             vlinklist.append((endpoints, desc, kbps.text))
 158         return vlinklist
 159
 160     def get_vlink(self, endponts, network=None):
 161         if network:
 162             query = "//network[@name='%s']//vlink[@endpoints = '%s']" % (network, endpoints)
 163         else:
 164             query = "//vlink[@endpoints = '%s']" % (network, endpoints)
 165         results = self.rspec.xpath(query)
 166         return results
 167
 168     def query_vlinks(self, endpoints, network=None):
 169         return get_vlink(endpoints,network)
 170
 171     ##################
 172     # Builder
 173     ##################
 174
 175     def add_network(self, network):
 176         network_tag = etree.SubElement(self.xml, 'network', id=network)
 177
 178     def add_nodes(self, nodes, network = None, no_dupes=False):
 179         if not isinstance(nodes, list):
 180             nodes = [nodes]
 181         for node in nodes:
 182             if no_dupes and \
 183               self.get_node_element(node['hostname']):
 184                 # node already exists
 185                 continue
 186
 187             network_tag = self.xml
 188             if 'network' in node:
 189                 network = node['network']
 190                 network_tags = self.xml.xpath('//network[@name="%s"]' % network)
 191                 if not network_tags:
 192                     network_tag = etree.SubElement(self.xml, 'network', name=network)
 193                 else:
 194                     network_tag = network_tags[0]
 195
 196             node_tag = etree.SubElement(network_tag, 'node')
 197             if 'network' in node:
 198                 node_tag.set('component_manager_id', network)
 199             if 'urn' in node:
 200                 node_tag.set('component_id', node['urn'])
 201             if 'site_urn' in node:
 202                 node_tag.set('site_id', node['site_urn'])
 203             if 'node_id' in node:
 204                 node_tag.set('node_id', 'n'+str(node['node_id']))
 205             if 'hostname' in node:
 206                 hostname_tag = etree.SubElement(node_tag, 'hostname').text = node['hostname']
 207             if 'interfaces' in node:
 208                 for interface in node['interfaces']:
 209                     if 'bwlimit' in interface and interface['bwlimit']:
 210                         bwlimit = etree.SubElement(node_tag, 'bw_limit', units='kbps').text = str(interface['bwlimit']/1000)
 211             if 'tags' in node:
 212                 for tag in node['tags']:
 213                    # expose this hard wired list of tags, plus the ones that are marked 'sfa' in their category
 214                    if tag['tagname'] in ['fcdistro', 'arch'] or 'sfa' in tag['category'].split('/'):
 215                         tag_element = etree.SubElement(node_tag, tag['tagname'], value=tag['value'])
 216
 217             if 'site' in node:
 218                 longitude = str(node['site']['longitude'])
 219                 latitude = str(node['site']['latitude'])
 220                 location = etree.SubElement(node_tag, 'location', country='unknown', \
 221                                             longitude=longitude, latitude=latitude)
 222
 223     def add_interfaces(self, interfaces):
 224         pass
 225
 226     def add_links(self, links):
 227         pass
 228
 229     def add_slivers(self, slivers, network=None, sliver_urn=None, no_dupes=False):
 230         slivers = self._process_slivers(slivers)
 231         nodes_with_slivers = self.get_nodes_with_slivers(network)
 232         for sliver in slivers:
 233             if sliver['hostname'] in nodes_with_slivers:
 234                 continue
 235             node_elem = self.get_node_element(sliver['hostname'], network)
 236             sliver_elem = etree.SubElement(node_elem, 'sliver')
 237             if 'tags' in sliver:
 238                 for tag in sliver['tags']:
 239                     etree.SubElement(sliver_elem, tag['tagname'], value=tag['value'])
 240
 241     def remove_slivers(self, slivers, network=None, no_dupes=False):
 242         slivers = self._process_slivers(slivers)
 243         for sliver in slivers:
 244             node_elem = self.get_node_element(sliver['hostname'], network)
 245             sliver_elem = node_elem.find('sliver')
 246             if sliver_elem != None:
 247                 node_elem.remove(sliver_elem)
 248
 249     def add_default_sliver_attribute(self, name, value, network=None):
 250         if network:
 251             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
 252         else:
 253             defaults = self.xml.xpath("//sliver_defaults" % network)
 254         if defaults is None:
 255             network_tag = self.xml.xpath("//network[@name='%s']" % network)
 256             defaults = self.add_element('sliver_defaults', attrs={}, parent=network_tag)
 257         self.add_attribute(defaults, name, value)
 258
 259     def add_sliver_attribute(self, hostname, name, value, network=None):
 260         node = self.get_node_element(hostname, network)
 261         sliver = node.find("sliver")
 262         self.add_attribute(sliver, name, value)
 263
 264     def remove_default_sliver_attribute(self, name, value, network=None):
 265         if network:
 266             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
 267         else:
 268             defaults = self.xml.xpath("//sliver_defaults" % network)
 269         self.remove_attribute(defaults, name, value)
 270
 271     def remove_sliver_attribute(self, hostname, name, value, network=None):
 272         node = self.get_node_element(hostname, network)
 273         sliver = node.find("sliver")
 274         self.remove_attribute(sliver, name, value)
 275
 276     def add_vlink(self, fromhost, tohost, kbps, network=None):
 277         fromnode = self.get_node_element(fromhost, network)
 278         tonode = self.get_node_element(tohost, network)
 279         links = self.get_link(fromnode, tonode, network)
 280
 281         for link in links:
 282             vlink = etree.SubElement(link, "vlink")
 283             fromid = fromnode.get("id")
 284             toid = tonode.get("id")
 285             vlink.set("endpoints", "%s %s" % (fromid, toid))
 286             self.add_attribute(vlink, "kbps", kbps)
 287
 288
 289     def remove_vlink(self, endpoints, network=None):
 290         vlinks = self.query_vlinks(endpoints, network)
 291         for vlink in vlinks:
 292             vlink.getparent().remove(vlink)
 293
 294
 295     def merge(self, in_rspec):
 296         """
 297         Merge contents for specified rspec with current rspec
 298         """
 299
 300         # just copy over all networks
 301         current_networks = self.get_networks()
 302         rspec = SfaRSpec(rspec=in_rspec)
 303         networks = rspec.get_network_elements()
 304         for network in networks:
 305             current_network = network.get('name')
 306             if not current_network in current_networks:
 307                 self.xml.append(network)
 308                 current_networks.append(current_network)
 309
 310
 311
 312 if __name__ == '__main__':
 313     rspec = SfaRSpec()
 314     nodes = [
 315     {'network': 'plc',
 316      'hostname': 'node1.planet-lab.org',
 317      'site_urn': 'urn:publicid:IDN+plc+authority+cm',
 318       'node_id': 1,
 319     },
 320     {'network': 'plc',
 321      'hostname': 'node2.planet-lab.org',
 322      'site_urn': 'urn:publicid:IDN+plc+authority+cm',
 323       'node_id': 1,
 324     },
 325     {'network': 'ple',
 326      'hostname': 'node1.planet-lab.eu',
 327      'site_urn': 'urn:publicid:IDN+plc+authority+cm',
 328       'node_id': 1,
 329     },
 330     ]
 331     rspec.add_nodes(nodes)
 332     print rspec