sfa/rspecs/versions/sfav1.py

   1 from copy import deepcopy
   2 from lxml import etree
   3 from sfa.util.xrn import hrn_to_urn, urn_to_hrn
   4 from sfa.util.plxrn import PlXrn
   5 from sfa.rspecs.rspec_version import BaseVersion
   6 from sfa.rspecs.rspec_elements import RSpecElement, RSpecElements
   7 from sfa.rspecs.elements.versions.pgv2Link import PGv2Link
   8
   9 class SFAv1(BaseVersion):
  10     enabled = True
  11     type = 'SFA'
  12     content_type = '*'
  13     version = '1'
  14     schema = None
  15     namespace = None
  16     extensions = {}
  17     namespaces = None
  18     elements = []
  19     template = '<RSpec type="%s"></RSpec>' % type
  20
  21     def get_network_elements(self):
  22         return self.xml.xpath('//network')
  23
  24     def get_networks(self):
  25         return self.xml.xpath('//network[@name]/@name')
  26
  27     def get_node_element(self, hostname, network=None):
  28         if network:
  29             names = self.xml.xpath('//network[@name="%s"]//node/hostname' % network)
  30         else:
  31             names = self.xml.xpath('//node/hostname')
  32         for name in names:
  33             if str(name.text).strip() == hostname:
  34                 return name.getparent()
  35         return None
  36
  37     def get_node_elements(self, network=None):
  38         if network:
  39             return self.xml.xpath('//network[@name="%s"]//node' % network)
  40         else:
  41             return self.xml.xpath('//node')
  42
  43     def get_nodes(self, network=None):
  44         if network == None:
  45             nodes = self.xml.xpath('//node/hostname/text()')
  46         else:
  47             nodes = self.xml.xpath('//network[@name="%s"]//node/hostname/text()' % network)
  48
  49         nodes = [node.strip() for node in nodes]
  50         return nodes
  51
  52     def get_nodes_with_slivers(self, network = None):
  53         if network:
  54             nodes =  self.xml.xpath('//network[@name="%s"]//node[sliver]/hostname/text()' % network)
  55         else:
  56             nodes = self.xml.xpath('//node[sliver]/hostname/text()')
  57
  58         nodes = [node.strip() for node in nodes]
  59         return nodes
  60
  61     def get_nodes_without_slivers(self, network=None):
  62         xpath_nodes_without_slivers = '//node[not(sliver)]/hostname/text()'
  63         xpath_nodes_without_slivers_in_network = '//network[@name="%s"]//node[not(sliver)]/hostname/text()'
  64         if network:
  65             return self.xml.xpath('//network[@name="%s"]//node[not(sliver)]/hostname/text()' % network)
  66         else:
  67             return self.xml.xpath('//node[not(sliver)]/hostname/text()')
  68
  69     def attributes_list(self, elem):
  70         # convert a list of attribute tags into list of tuples
  71         # (tagnme, text_value)
  72         opts = []
  73         if elem is not None:
  74             for e in elem:
  75                 opts.append((e.tag, str(e.text).strip()))
  76         return opts
  77
  78     def get_default_sliver_attributes(self, network=None):
  79         if network:
  80             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
  81         else:
  82             defaults = self.xml.xpath("//sliver_defaults")
  83         if isinstance(defaults, list) and defaults:
  84             defaults = defaults[0]
  85         return self.attributes_list(defaults)
  86
  87     def get_sliver_attributes(self, hostname, network=None):
  88         attributes = []
  89         node = self.get_node_element(hostname, network)
  90         #sliver = node.find("sliver")
  91         slivers = node.xpath('./sliver')
  92         if isinstance(slivers, list) and slivers:
  93             attributes = self.attributes_list(slivers[0])
  94         return attributes
  95
  96     def get_slice_attributes(self, network=None):
  97         slice_attributes = []
  98         nodes_with_slivers = self.get_nodes_with_slivers(network)
  99         for default_attribute in self.get_default_sliver_attributes(network):
 100             attribute = {'name': str(default_attribute[0]), 'value': str(default_attribute[1]), 'node_id': None}
 101             slice_attributes.append(attribute)
 102         for node in nodes_with_slivers:
 103             sliver_attributes = self.get_sliver_attributes(node, network)
 104             for sliver_attribute in sliver_attributes:
 105                 attribute = {'name': str(sliver_attribute[0]), 'value': str(sliver_attribute[1]), 'node_id': node}
 106                 slice_attributes.append(attribute)
 107         return slice_attributes
 108
 109     def get_site_nodes(self, siteid, network=None):
 110         if network:
 111             nodes = self.xml.xpath('//network[@name="%s"]/site[@id="%s"]/node/hostname/text()' % \
 112                                     (network, siteid))
 113         else:
 114             nodes = self.xml.xpath('//site[@id="%s"]/node/hostname/text()' % siteid)
 115         return nodes
 116
 117     def get_links(self, network=None):
 118         return PGv2Link.get_links(self.xml)
 119
 120     def get_link_requests(self):
 121         return PGv2Link.get_link_requests(self.xml)
 122
 123     def get_link(self, fromnode, tonode, network=None):
 124         fromsite = fromnode.getparent()
 125         tosite = tonode.getparent()
 126         fromid = fromsite.get("id")
 127         toid = tosite.get("id")
 128         if network:
 129             query = "//network[@name='%s']" % network + "/link[@endpoints = '%s %s']"
 130         else:
 131             query = "//link[@endpoints = '%s %s']"
 132
 133         results = self.rspec.xpath(query % (fromid, toid))
 134         if not results:
 135             results = self.rspec.xpath(query % (toid, fromid))
 136         return results
 137
 138     def query_links(self, fromnode, tonode, network=None):
 139         return get_link(fromnode, tonode, network)
 140
 141     def get_vlinks(self, network=None):
 142         vlinklist = []
 143         if network:
 144             vlinks = self.xml.xpath("//network[@name='%s']//vlink" % network)
 145         else:
 146             vlinks = self.xml.xpath("//vlink")
 147         for vlink in vlinks:
 148             endpoints = vlink.get("endpoints")
 149             (end1, end2) = endpoints.split()
 150             if network:
 151                 node1 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
 152                                        (network, end1))[0]
 153                 node2 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
 154                                        (network, end2))[0]
 155             else:
 156                 node1 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end1)[0]
 157                 node2 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end2)[0]
 158             desc = "%s <--> %s" % (node1, node2)
 159             kbps = vlink.find("kbps")
 160             vlinklist.append((endpoints, desc, kbps.text))
 161         return vlinklist
 162
 163     def get_vlink(self, endponts, network=None):
 164         if network:
 165             query = "//network[@name='%s']//vlink[@endpoints = '%s']" % (network, endpoints)
 166         else:
 167             query = "//vlink[@endpoints = '%s']" % (network, endpoints)
 168         results = self.rspec.xpath(query)
 169         return results
 170
 171     def query_vlinks(self, endpoints, network=None):
 172         return get_vlink(endpoints,network)
 173
 174
 175     ##################
 176     # Builder
 177     ##################
 178
 179     def add_network(self, network):
 180         network_tags = self.xml.xpath('//network[@name="%s"]' % network)
 181         if not network_tags:
 182             network_tag = etree.SubElement(self.xml.root, 'network', name=network)
 183         else:
 184             network_tag = network_tags[0]
 185         return network_tag
 186
 187     def add_nodes(self, nodes, network = None, no_dupes=False):
 188         if not isinstance(nodes, list):
 189             nodes = [nodes]
 190         for node in nodes:
 191             if no_dupes and \
 192               self.get_node_element(node['hostname']):
 193                 # node already exists
 194                 continue
 195
 196             network_tag = self.xml.root
 197             if 'network' in node:
 198                 network = node['network']
 199                 network_tag = self.add_network(network)
 200
 201             node_tag = etree.SubElement(network_tag, 'node')
 202             if 'network' in node:
 203                 node_tag.set('component_manager_id', hrn_to_urn(network, 'authority+sa'))
 204             if 'urn' in node:
 205                 node_tag.set('component_id', node['urn'])
 206             if 'site_urn' in node:
 207                 node_tag.set('site_id', node['site_urn'])
 208             if 'node_id' in node:
 209                 node_tag.set('node_id', 'n'+str(node['node_id']))
 210             if 'boot_state' in node:
 211                 node_tag.set('boot_state', node['boot_state'])
 212             if 'hostname' in node:
 213                 node_tag.set('component_name', node['hostname'])
 214                 hostname_tag = etree.SubElement(node_tag, 'hostname').text = node['hostname']
 215             if 'interfaces' in node:
 216                 i = 0
 217                 for interface in node['interfaces']:
 218                     if 'bwlimit' in interface and interface['bwlimit']:
 219                         bwlimit = etree.SubElement(node_tag, 'bw_limit', units='kbps').text = str(interface['bwlimit']/1000)
 220                     comp_id = PlXrn(auth=network, interface='node%s:eth%s' % (node['node_id'], i)).get_urn()
 221                     ipaddr = interface['ip']
 222                     interface_tag = etree.SubElement(node_tag, 'interface', component_id=comp_id, ipv4=ipaddr)
 223                     i+=1
 224             if 'bw_unallocated' in node:
 225                 bw_unallocated = etree.SubElement(node_tag, 'bw_unallocated', units='kbps').text = str(node['bw_unallocated']/1000)
 226             if 'tags' in node:
 227                 for tag in node['tags']:
 228                    # expose this hard wired list of tags, plus the ones that are marked 'sfa' in their category
 229                    if tag['tagname'] in ['fcdistro', 'arch'] or 'sfa' in tag['category'].split('/'):
 230                         tag_element = etree.SubElement(node_tag, tag['tagname']).text=tag['value']
 231
 232             if 'site' in node:
 233                 longitude = str(node['site']['longitude'])
 234                 latitude = str(node['site']['latitude'])
 235                 location = etree.SubElement(node_tag, 'location', country='unknown', \
 236                                             longitude=longitude, latitude=latitude)
 237
 238     def merge_node(self, source_node_tag, network, no_dupes=False):
 239         if no_dupes and self.get_node_element(node['hostname']):
 240             # node already exists
 241             return
 242
 243         network_tag = self.add_network(network)
 244         network_tag.append(deepcopy(source_node_tag))
 245
 246     def add_interfaces(self, interfaces):
 247         pass
 248
 249     def add_links(self, links):
 250         networks = self.get_network_elements()
 251         if len(networks) > 0:
 252             xml = networks[0]
 253         else:
 254             xml = self.xml
 255         PGv2Link.add_links(xml, links)
 256
 257     def add_link_requests(self, links):
 258         PGv2Link.add_link_requests(self.xml, links)
 259
 260     def add_slivers(self, slivers, network=None, sliver_urn=None, no_dupes=False, append=False):
 261         # add slice name to network tag
 262         network_tags = self.xml.xpath('//network')
 263         if network_tags:
 264             network_tag = network_tags[0]
 265             network_tag.set('slice', urn_to_hrn(sliver_urn)[0])
 266
 267         all_nodes = self.get_nodes()
 268         nodes_with_slivers = [sliver['hostname'] for sliver in slivers]
 269         nodes_without_slivers = set(all_nodes).difference(nodes_with_slivers)
 270
 271         # add slivers
 272         for sliver in slivers:
 273             node_elem = self.get_node_element(sliver['hostname'], network)
 274             if not node_elem: continue
 275             sliver_elem = etree.SubElement(node_elem, 'sliver')
 276             if 'tags' in sliver:
 277                 for tag in sliver['tags']:
 278                     etree.SubElement(sliver_elem, tag['tagname']).text = value=tag['value']
 279
 280         # remove all nodes without slivers
 281         if not append:
 282             for node in nodes_without_slivers:
 283                 node_elem = self.get_node_element(node)
 284                 parent = node_elem.getparent()
 285                 parent.remove(node_elem)
 286
 287     def remove_slivers(self, slivers, network=None, no_dupes=False):
 288         for sliver in slivers:
 289             node_elem = self.get_node_element(sliver['hostname'], network)
 290             sliver_elem = node_elem.find('sliver')
 291             if sliver_elem != None:
 292                 node_elem.remove(sliver_elem)
 293
 294     def add_default_sliver_attribute(self, name, value, network=None):
 295         if network:
 296             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
 297         else:
 298             defaults = self.xml.xpath("//sliver_defaults" % network)
 299         if not defaults :
 300             network_tag = self.xml.xpath("//network[@name='%s']" % network)
 301             if isinstance(network_tag, list):
 302                 network_tag = network_tag[0]
 303             defaults = self.xml.add_element('sliver_defaults', attrs={}, parent=network_tag)
 304         elif isinstance(defaults, list):
 305             defaults = defaults[0]
 306         self.xml.add_attribute(defaults, name, value)
 307
 308     def add_sliver_attribute(self, hostname, name, value, network=None):
 309         node = self.get_node_element(hostname, network)
 310         sliver = node.find("sliver")
 311         self.xml.add_attribute(sliver, name, value)
 312
 313     def remove_default_sliver_attribute(self, name, value, network=None):
 314         if network:
 315             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
 316         else:
 317             defaults = self.xml.xpath("//sliver_defaults" % network)
 318         self.xml.remove_attribute(defaults, name, value)
 319
 320     def remove_sliver_attribute(self, hostname, name, value, network=None):
 321         node = self.get_node_element(hostname, network)
 322         sliver = node.find("sliver")
 323         self.xml.remove_attribute(sliver, name, value)
 324
 325     def add_vlink(self, fromhost, tohost, kbps, network=None):
 326         fromnode = self.get_node_element(fromhost, network)
 327         tonode = self.get_node_element(tohost, network)
 328         links = self.get_link(fromnode, tonode, network)
 329
 330         for link in links:
 331             vlink = etree.SubElement(link, "vlink")
 332             fromid = fromnode.get("id")
 333             toid = tonode.get("id")
 334             vlink.set("endpoints", "%s %s" % (fromid, toid))
 335             self.xml.add_attribute(vlink, "kbps", kbps)
 336
 337
 338     def remove_vlink(self, endpoints, network=None):
 339         vlinks = self.query_vlinks(endpoints, network)
 340         for vlink in vlinks:
 341             vlink.getparent().remove(vlink)
 342
 343
 344     def merge(self, in_rspec):
 345         """
 346         Merge contents for specified rspec with current rspec
 347         """
 348
 349         from sfa.rspecs.rspec import RSpec
 350         if isinstance(in_rspec, RSpec):
 351             rspec = in_rspec
 352         else:
 353             rspec = RSpec(in_rspec)
 354         if rspec.version.type.lower() == 'protogeni':
 355             from sfa.rspecs.rspec_converter import RSpecConverter
 356             in_rspec = RSpecConverter.to_sfa_rspec(rspec.toxml())
 357             rspec = RSpec(in_rspec)
 358
 359         # just copy over all networks
 360         current_networks = self.get_networks()
 361         networks = rspec.version.get_network_elements()
 362         for network in networks:
 363             current_network = network.get('name')
 364             if current_network and current_network not in current_networks:
 365                 self.xml.root.append(network)
 366                 current_networks.append(current_network)
 367
 368 if __name__ == '__main__':
 369     from sfa.rspecs.rspec import RSpec
 370     from sfa.rspecs.rspec_elements import *
 371     r = RSpec('/tmp/resources.rspec')
 372     r.load_rspec_elements(SFAv1.elements)
 373     print r.get(RSpecElements.NODE)