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