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