sfa/rspecs/versions/sfav1.py

   1 from lxml import etree
   2 from sfa.util.xrn import hrn_to_urn, urn_to_hrn
   3 from sfa.rspecs.rspec_version import BaseVersion
   4 from sfa.rspecs.rspec_elements import RSpecElement, RSpecElements
   5 from sfa.rspecs.elements.versions.pgv2Link import PGv2Link
   6
   7 class SFAv1(BaseVersion):
   8     enabled = True
   9     type = 'SFA'
  10     content_type = '*'
  11     version = '1'
  12     schema = None
  13     namespace = None
  14     extensions = {}
  15     namespaces = None
  16     elements = [
  17         RSpecElement(RSpecElements.NETWORK, 'network', '//network'),
  18         RSpecElement(RSpecElements.NODE, 'node', '//node'),
  19         RSpecElement(RSpecElements.SLIVER, 'sliver', '//node/sliver'),
  20     ]
  21     template = '<RSpec type="%s"></RSpec>' % type
  22
  23     def get_network_elements(self):
  24         return self.xml.xpath('//network')
  25
  26     def get_networks(self):
  27         return self.xml.xpath('//network[@name]/@name')
  28
  29     def get_node_element(self, hostname, network=None):
  30         if network:
  31             names = self.xml.xpath('//network[@name="%s"]//node/hostname' % network)
  32         else:
  33             names = self.xml.xpath('//node/hostname')
  34         for name in names:
  35             if str(name.text).strip() == hostname:
  36                 return name.getparent()
  37         return None
  38
  39     def get_node_elements(self, network=None):
  40         if network:
  41             return self.xml.xpath('//network[@name="%s"]//node' % network)
  42         else:
  43             return self.xml.xpath('//node')
  44
  45     def get_nodes(self, network=None):
  46         if network == None:
  47             nodes = self.xml.xpath('//node/hostname/text()')
  48         else:
  49             nodes = self.xml.xpath('//network[@name="%s"]//node/hostname/text()' % network)
  50
  51         nodes = [node.strip() for node in nodes]
  52         return nodes
  53
  54     def get_nodes_with_slivers(self, network = None):
  55         if network:
  56             nodes =  self.xml.xpath('//network[@name="%s"]//node[sliver]/hostname/text()' % network)
  57         else:
  58             nodes = self.xml.xpath('//node[sliver]/hostname/text()')
  59
  60         nodes = [node.strip() for node in nodes]
  61         return nodes
  62
  63     def get_nodes_without_slivers(self, network=None):
  64         xpath_nodes_without_slivers = '//node[not(sliver)]/hostname/text()'
  65         xpath_nodes_without_slivers_in_network = '//network[@name="%s"]//node[not(sliver)]/hostname/text()'
  66         if network:
  67             return self.xml.xpath('//network[@name="%s"]//node[not(sliver)]/hostname/text()' % network)
  68         else:
  69             return self.xml.xpath('//node[not(sliver)]/hostname/text()')
  70
  71     def attributes_list(self, elem):
  72         # convert a list of attribute tags into list of tuples
  73         # (tagnme, text_value)
  74         opts = []
  75         if elem is not None:
  76             for e in elem:
  77                 opts.append((e.tag, str(e.text).strip()))
  78         return opts
  79
  80     def get_default_sliver_attributes(self, network=None):
  81         if network:
  82             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
  83         else:
  84             defaults = self.xml.xpath("//sliver_defaults")
  85         if isinstance(defaults, list) and defaults:
  86             defaults = defaults[0]
  87         return self.attributes_list(defaults)
  88
  89     def get_sliver_attributes(self, hostname, network=None):
  90         attributes = []
  91         node = self.get_node_element(hostname, network)
  92         #sliver = node.find("sliver")
  93         slivers = node.xpath('./sliver')
  94         if isinstance(slivers, list) and slivers:
  95             attributes = self.attributes_list(slivers[0])
  96         return attributes
  97
  98     def get_slice_attributes(self, network=None):
  99         slice_attributes = []
 100         nodes_with_slivers = self.get_nodes_with_slivers(network)
 101         for default_attribute in self.get_default_sliver_attributes(network):
 102             attribute = {'name': str(default_attribute[0]), 'value': str(default_attribute[1]), 'node_id': None}
 103             slice_attributes.append(attribute)
 104         for node in nodes_with_slivers:
 105             sliver_attributes = self.get_sliver_attributes(node, network)
 106             for sliver_attribute in sliver_attributes:
 107                 attribute = {'name': str(sliver_attribute[0]), 'value': str(sliver_attribute[1]), 'node_id': node}
 108                 slice_attributes.append(attribute)
 109         return slice_attributes
 110
 111     def get_site_nodes(self, siteid, network=None):
 112         if network:
 113             nodes = self.xml.xpath('//network[@name="%s"]/site[@id="%s"]/node/hostname/text()' % \
 114                                     (network, siteid))
 115         else:
 116             nodes = self.xml.xpath('//site[@id="%s"]/node/hostname/text()' % siteid)
 117         return nodes
 118
 119     def get_links(self, network=None):
 120         links = PGv2Link.get_links(self.xml, self.namespaces)
 121         return links
 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 = hrn_to_urn(network, 'pc%s:eth%s' % (node['node_id'], i))
 221                     interface_tag = etree.SubElement(node_tag, 'interface', component_id=comp_id)
 222                     i+=1
 223             if 'bw_unallocated' in node:
 224                 bw_unallocated = etree.SubElement(node_tag, 'bw_unallocated', units='kbps').text = str(node['bw_unallocated']/1000)
 225             if 'tags' in node:
 226                 for tag in node['tags']:
 227                    # expose this hard wired list of tags, plus the ones that are marked 'sfa' in their category
 228                    if tag['tagname'] in ['fcdistro', 'arch'] or 'sfa' in tag['category'].split('/'):
 229                         tag_element = etree.SubElement(node_tag, tag['tagname']).text=tag['value']
 230
 231             if 'site' in node:
 232                 longitude = str(node['site']['longitude'])
 233                 latitude = str(node['site']['latitude'])
 234                 location = etree.SubElement(node_tag, 'location', country='unknown', \
 235                                             longitude=longitude, latitude=latitude)
 236
 237     def merge_node(self, source_node_tag, network, no_dupes=False):
 238         if no_dupes and self.get_node_element(node['hostname']):
 239             # node already exists
 240             return
 241
 242         network_tag = self.add_network(network)
 243         network_tag.append(deepcopy(source_node_tag))
 244
 245     def add_interfaces(self, interfaces):
 246         pass
 247
 248     def add_links(self, links):
 249         PGv2Link.add_links(self.xml, links)
 250
 251     def add_slivers(self, slivers, network=None, sliver_urn=None, no_dupes=False, append=False):
 252         # add slice name to network tag
 253         network_tags = self.xml.xpath('//network')
 254         if network_tags:
 255             network_tag = network_tags[0]
 256             network_tag.set('slice', urn_to_hrn(sliver_urn)[0])
 257
 258         all_nodes = self.get_nodes()
 259         nodes_with_slivers = [sliver['hostname'] for sliver in slivers]
 260         nodes_without_slivers = set(all_nodes).difference(nodes_with_slivers)
 261
 262         # add slivers
 263         for sliver in slivers:
 264             node_elem = self.get_node_element(sliver['hostname'], network)
 265             if not node_elem: continue
 266             sliver_elem = etree.SubElement(node_elem, 'sliver')
 267             if 'tags' in sliver:
 268                 for tag in sliver['tags']:
 269                     etree.SubElement(sliver_elem, tag['tagname']).text = value=tag['value']
 270
 271         # remove all nodes without slivers
 272         if not append:
 273             for node in nodes_without_slivers:
 274                 node_elem = self.get_node_element(node)
 275                 parent = node_elem.getparent()
 276                 parent.remove(node_elem)
 277
 278     def remove_slivers(self, slivers, network=None, no_dupes=False):
 279         for sliver in slivers:
 280             node_elem = self.get_node_element(sliver['hostname'], network)
 281             sliver_elem = node_elem.find('sliver')
 282             if sliver_elem != None:
 283                 node_elem.remove(sliver_elem)
 284
 285     def add_default_sliver_attribute(self, name, value, network=None):
 286         if network:
 287             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
 288         else:
 289             defaults = self.xml.xpath("//sliver_defaults" % network)
 290         if not defaults :
 291             network_tag = self.xml.xpath("//network[@name='%s']" % network)
 292             if isinstance(network_tag, list):
 293                 network_tag = network_tag[0]
 294             defaults = self.xml.add_element('sliver_defaults', attrs={}, parent=network_tag)
 295         elif isinstance(defaults, list):
 296             defaults = defaults[0]
 297         self.xml.add_attribute(defaults, name, value)
 298
 299     def add_sliver_attribute(self, hostname, name, value, network=None):
 300         node = self.get_node_element(hostname, network)
 301         sliver = node.find("sliver")
 302         self.xml.add_attribute(sliver, name, value)
 303
 304     def remove_default_sliver_attribute(self, name, value, network=None):
 305         if network:
 306             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
 307         else:
 308             defaults = self.xml.xpath("//sliver_defaults" % network)
 309         self.xml.remove_attribute(defaults, name, value)
 310
 311     def remove_sliver_attribute(self, hostname, name, value, network=None):
 312         node = self.get_node_element(hostname, network)
 313         sliver = node.find("sliver")
 314         self.xml.remove_attribute(sliver, name, value)
 315
 316     def add_vlink(self, fromhost, tohost, kbps, network=None):
 317         fromnode = self.get_node_element(fromhost, network)
 318         tonode = self.get_node_element(tohost, network)
 319         links = self.get_link(fromnode, tonode, network)
 320
 321         for link in links:
 322             vlink = etree.SubElement(link, "vlink")
 323             fromid = fromnode.get("id")
 324             toid = tonode.get("id")
 325             vlink.set("endpoints", "%s %s" % (fromid, toid))
 326             self.xml.add_attribute(vlink, "kbps", kbps)
 327
 328
 329     def remove_vlink(self, endpoints, network=None):
 330         vlinks = self.query_vlinks(endpoints, network)
 331         for vlink in vlinks:
 332             vlink.getparent().remove(vlink)
 333
 334
 335     def merge(self, in_rspec):
 336         """
 337         Merge contents for specified rspec with current rspec
 338         """
 339
 340         from sfa.rspecs.rspec import RSpec
 341         if isinstance(in_rspec, RSpec):
 342             rspec = in_rspec
 343         else:
 344             rspec = RSpec(in_rspec)
 345         if rspec.version.type.lower() == 'protogeni':
 346             from sfa.rspecs.rspec_converter import RSpecConverter
 347             in_rspec = RSpecConverter.to_sfa_rspec(rspec.toxml())
 348             rspec = RSpec(in_rspec)
 349
 350         # just copy over all networks
 351         current_networks = self.get_networks()
 352         networks = rspec.version.get_network_elements()
 353         for network in networks:
 354             current_network = network.get('name')
 355             if current_network and current_network not in current_networks:
 356                 self.xml.root.append(network)
 357                 current_networks.append(current_network)
 358
 359 if __name__ == '__main__':
 360     from sfa.rspecs.rspec import RSpec
 361     from sfa.rspecs.rspec_elements import *
 362     r = RSpec('/tmp/resources.rspec')
 363     r.load_rspec_elements(SFAv1.elements)
 364     print r.get(RSpecElements.NODE)