sfa/rspecs/versions/sfav1.py

   1 from sfa.rspecs.rspec_version import BaseVersion
   2 from sfa.rspecs.rspec_elements import RSpecElement, RSpecElements
   3
   4 class SFAv1(BaseVersion):
   5     enabled = True
   6     type = 'SFA'
   7     content_type = '*'
   8     version = '1'
   9     schema = None
  10     namespace = None
  11     extensions = {}
  12     namespaces = None
  13     elements = [
  14         RSpecElement(RSpecElements.NETWORK, 'network', '//network'),
  15         RSpecElement(RSpecElements.NODE, 'node', '//node'),
  16         RSpecElement(RSpecElements.SLIVER, 'sliver', '//node/sliver'),
  17     ]
  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         if network:
 118             links = self.xml.xpath('//network[@name="%s"]/link' % network)
 119         else:
 120             links = self.xml.xpath('//link')
 121         linklist = []
 122         for link in links:
 123             (end1, end2) = link.get("endpoints").split()
 124             name = link.find("description")
 125             linklist.append((name.text,
 126                              self.get_site_nodes(end1, network),
 127                              self.get_site_nodes(end2, network)))
 128         return linklist
 129
 130     def get_link(self, fromnode, tonode, network=None):
 131         fromsite = fromnode.getparent()
 132         tosite = tonode.getparent()
 133         fromid = fromsite.get("id")
 134         toid = tosite.get("id")
 135         if network:
 136             query = "//network[@name='%s']" % network + "/link[@endpoints = '%s %s']"
 137         else:
 138             query = "//link[@endpoints = '%s %s']"
 139
 140         results = self.rspec.xpath(query % (fromid, toid))
 141         if not results:
 142             results = self.rspec.xpath(query % (toid, fromid))
 143         return results
 144
 145     def query_links(self, fromnode, tonode, network=None):
 146         return get_link(fromnode, tonode, network)
 147
 148     def get_vlinks(self, network=None):
 149         vlinklist = []
 150         if network:
 151             vlinks = self.xml.xpath("//network[@name='%s']//vlink" % network)
 152         else:
 153             vlinks = self.xml.xpath("//vlink")
 154         for vlink in vlinks:
 155             endpoints = vlink.get("endpoints")
 156             (end1, end2) = endpoints.split()
 157             if network:
 158                 node1 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
 159                                        (network, end1))[0]
 160                 node2 = self.xml.xpath('//network[@name="%s"]//node[@id="%s"]/hostname/text()' % \
 161                                        (network, end2))[0]
 162             else:
 163                 node1 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end1)[0]
 164                 node2 = self.xml.xpath('//node[@id="%s"]/hostname/text()' % end2)[0]
 165             desc = "%s <--> %s" % (node1, node2)
 166             kbps = vlink.find("kbps")
 167             vlinklist.append((endpoints, desc, kbps.text))
 168         return vlinklist
 169
 170     def get_vlink(self, endponts, network=None):
 171         if network:
 172             query = "//network[@name='%s']//vlink[@endpoints = '%s']" % (network, endpoints)
 173         else:
 174             query = "//vlink[@endpoints = '%s']" % (network, endpoints)
 175         results = self.rspec.xpath(query)
 176         return results
 177
 178     def query_vlinks(self, endpoints, network=None):
 179         return get_vlink(endpoints,network)
 180
 181
 182     ##################
 183     # Builder
 184     ##################
 185
 186     def add_network(self, network):
 187         network_tags = self.xml.xpath('//network[@name="%s"]' % network)
 188         if not network_tags:
 189             network_tag = etree.SubElement(self.xml, 'network', name=network)
 190         else:
 191             network_tag = network_tags[0]
 192         return network_tag
 193
 194     def add_nodes(self, nodes, network = None, no_dupes=False):
 195         if not isinstance(nodes, list):
 196             nodes = [nodes]
 197         for node in nodes:
 198             if no_dupes and \
 199               self.get_node_element(node['hostname']):
 200                 # node already exists
 201                 continue
 202
 203             network_tag = self.xml
 204             if 'network' in node:
 205                 network = node['network']
 206                 network_tag = self.add_network(network)
 207
 208             node_tag = etree.SubElement(network_tag, 'node')
 209             if 'network' in node:
 210                 node_tag.set('component_manager_id', hrn_to_urn(network, 'authority+sa'))
 211             if 'urn' in node:
 212                 node_tag.set('component_id', node['urn'])
 213             if 'site_urn' in node:
 214                 node_tag.set('site_id', node['site_urn'])
 215             if 'node_id' in node:
 216                 node_tag.set('node_id', 'n'+str(node['node_id']))
 217             if 'boot_state' in node:
 218                 node_tag.set('boot_state', node['boot_state'])
 219             if 'hostname' in node:
 220                 hostname_tag = etree.SubElement(node_tag, 'hostname').text = node['hostname']
 221             if 'interfaces' in node:
 222                 for interface in node['interfaces']:
 223                     if 'bwlimit' in interface and interface['bwlimit']:
 224                         bwlimit = etree.SubElement(node_tag, 'bw_limit', units='kbps').text = str(interface['bwlimit']/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         pass
 250
 251     def add_slivers(self, slivers, network=None, sliver_urn=None, no_dupes=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         slivers = self._process_slivers(slivers)
 258         nodes_with_slivers = self.get_nodes_with_slivers(network)
 259         for sliver in slivers:
 260             if sliver['hostname'] in nodes_with_slivers:
 261                 continue
 262             node_elem = self.get_node_element(sliver['hostname'], network)
 263             sliver_elem = etree.SubElement(node_elem, 'sliver')
 264             if 'tags' in sliver:
 265                 for tag in sliver['tags']:
 266                     etree.SubElement(sliver_elem, tag['tagname']).text = value=tag['value']
 267
 268
 269     def remove_slivers(self, slivers, network=None, no_dupes=False):
 270         slivers = self._process_slivers(slivers)
 271         for sliver in slivers:
 272             node_elem = self.get_node_element(sliver['hostname'], network)
 273             sliver_elem = node_elem.find('sliver')
 274             if sliver_elem != None:
 275                 node_elem.remove(sliver_elem)
 276
 277     def add_default_sliver_attribute(self, name, value, network=None):
 278         if network:
 279             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
 280         else:
 281             defaults = self.xml.xpath("//sliver_defaults" % network)
 282         if not defaults :
 283             network_tag = self.xml.xpath("//network[@name='%s']" % network)
 284             if isinstance(network_tag, list):
 285                 network_tag = network_tag[0]
 286             defaults = self.add_element('sliver_defaults', attrs={}, parent=network_tag)
 287         elif isinstance(defaults, list):
 288             defaults = defaults[0]
 289         self.add_attribute(defaults, name, value)
 290
 291     def add_sliver_attribute(self, hostname, name, value, network=None):
 292         node = self.get_node_element(hostname, network)
 293         sliver = node.find("sliver")
 294         self.add_attribute(sliver, name, value)
 295
 296     def remove_default_sliver_attribute(self, name, value, network=None):
 297         if network:
 298             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
 299         else:
 300             defaults = self.xml.xpath("//sliver_defaults" % network)
 301         self.remove_attribute(defaults, name, value)
 302
 303     def remove_sliver_attribute(self, hostname, name, value, network=None):
 304         node = self.get_node_element(hostname, network)
 305         sliver = node.find("sliver")
 306         self.remove_attribute(sliver, name, value)
 307
 308     def add_vlink(self, fromhost, tohost, kbps, network=None):
 309         fromnode = self.get_node_element(fromhost, network)
 310         tonode = self.get_node_element(tohost, network)
 311         links = self.get_link(fromnode, tonode, network)
 312
 313         for link in links:
 314             vlink = etree.SubElement(link, "vlink")
 315             fromid = fromnode.get("id")
 316             toid = tonode.get("id")
 317             vlink.set("endpoints", "%s %s" % (fromid, toid))
 318             self.add_attribute(vlink, "kbps", kbps)
 319
 320
 321     def remove_vlink(self, endpoints, network=None):
 322         vlinks = self.query_vlinks(endpoints, network)
 323         for vlink in vlinks:
 324             vlink.getparent().remove(vlink)
 325
 326
 327     def merge(self, in_rspec):
 328         """
 329         Merge contents for specified rspec with current rspec
 330         """
 331
 332         from sfa.rspecs.rspec_parser import parse_rspec
 333         rspec = parse_rspec(in_rspec)
 334         if rspec.type.lower() == 'protogeni':
 335             from sfa.rspecs.rspec_converter import RSpecConverter
 336             in_rspec = RSpecConverter.to_sfa_rspec(in_rspec)
 337
 338         # just copy over all networks
 339         current_networks = self.get_networks()
 340         rspec = SfaRSpec(rspec=in_rspec)
 341         networks = rspec.get_network_elements()
 342         for network in networks:
 343             current_network = network.get('name')
 344             if current_network and current_network not in current_networks:
 345                 self.xml.append(network)
 346                 current_networks.append(current_network)
 347
 348 if __name__ == '__main__':
 349     from sfa.rspecs.rspec import RSpec
 350     from sfa.rspecs.rspec_elements import *
 351     r = RSpec('/tmp/resources.rspec')
 352     r.load_rspec_elements(SFAv1.elements)
 353     print r.get(RSpecElements.NODE)