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