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