sfa/rspecs/versions/pgv2.py

   1 from __future__ import print_function
   2
   3 from copy import deepcopy
   4 from sfa.util.xrn import Xrn
   5 from sfa.rspecs.version import RSpecVersion
   6 from sfa.rspecs.elements.versions.pgv2Link import PGv2Link
   7 from sfa.rspecs.elements.versions.pgv2Node import PGv2Node
   8 from sfa.rspecs.elements.versions.pgv2SliverType import PGv2SliverType
   9 from sfa.rspecs.elements.versions.pgv2Lease import PGv2Lease
  10 from sfa.util.sfalogging import logger
  11 from sfa.util.py23 import StringType
  12
  13 class PGv2(RSpecVersion):
  14     type = 'ProtoGENI'
  15     content_type = 'ad'
  16     version = '2'
  17     schema = 'http://www.protogeni.net/resources/rspec/2/ad.xsd'
  18     namespace = 'http://www.protogeni.net/resources/rspec/2'
  19     extensions = {
  20         'flack': "http://www.protogeni.net/resources/rspec/ext/flack/1",
  21         'planetlab': "http://www.planet-lab.org/resources/sfa/ext/planetlab/1",
  22         'plos': "http://www.planet-lab.org/resources/sfa/ext/plos/1",
  23     }
  24     namespaces = dict(list(extensions.items()) + [('default', namespace)])
  25
  26     # Networks
  27     def get_networks(self):
  28         network_names = set()
  29         nodes = self.xml.xpath('//default:node[@component_manager_id] | //node[@component_manager_id]',
  30                                namespaces=self.namespaces)
  31         for node in nodes:
  32             if 'component_manager_id' in node.attrib:
  33                 network_urn = node.get('component_manager_id')
  34                 if network_urn.startswith("urn:"):
  35                     network_hrn = Xrn(network_urn).get_hrn()
  36                 else:
  37                     # some component_manager_ids are hrns instead of urns??
  38                     network_hrn = network_urn
  39                 network_names.add(network_hrn)
  40         network_names = list(network_names)
  41         networks = [{"name": x} for x in network_names]
  42         return networks
  43
  44     # Nodes
  45
  46     def get_nodes(self, filter=None):
  47         return PGv2Node.get_nodes(self.xml, filter)
  48
  49     def get_nodes_with_slivers(self):
  50         return PGv2Node.get_nodes_with_slivers(self.xml)
  51
  52     def add_nodes(self, nodes, check_for_dupes=False, rspec_content_type=None):
  53         return PGv2Node.add_nodes(self.xml, nodes, rspec_content_type)
  54
  55     def merge_node(self, source_node_tag):
  56         # this is untested
  57         self.xml.root.append(deepcopy(source_node_tag))
  58
  59     # Slivers
  60
  61     def get_sliver_attributes(self, component_id, network=None):
  62         nodes = self.get_nodes({'component_id': '*%s*' %component_id})
  63         try:
  64             node = nodes[0]
  65             sliver = node.xpath('./default:sliver_type', namespaces=self.namespaces)
  66             if sliver is not None and isinstance(sliver, list) and len(sliver) > 0:
  67                 sliver = sliver[0]
  68                 return self.attributes_list(sliver)
  69             else:
  70                 return []
  71         except:
  72             return []
  73
  74     def get_slice_attributes(self, network=None):
  75         slice_attributes = []
  76         nodes_with_slivers = self.get_nodes_with_slivers()
  77         # TODO: default sliver attributes in the PG rspec?
  78         default_ns_prefix = self.namespaces['default']
  79         for node in nodes_with_slivers:
  80             sliver_attributes = self.get_sliver_attributes(node['component_id'], network)
  81             for sliver_attribute in sliver_attributes:
  82                 name=str(sliver_attribute[0])
  83                 text =str(sliver_attribute[1])
  84                 attribs = sliver_attribute[2]
  85                 # we currently only suppor the <initscript> and <flack> attributes
  86                 if  'info' in name:
  87                     attribute = {'name': 'flack_info', 'value': str(attribs), 'node_id': node}
  88                     slice_attributes.append(attribute)
  89                 elif 'initscript' in name:
  90                     if attribs is not None and 'name' in attribs:
  91                         value = attribs['name']
  92                     else:
  93                         value = text
  94                     attribute = {'name': 'initscript', 'value': value, 'node_id': node}
  95                     slice_attributes.append(attribute)
  96
  97         return slice_attributes
  98
  99     def attributes_list(self, elem):
 100         opts = []
 101         if elem is not None:
 102             for e in elem:
 103                 opts.append((e.tag, str(e.text).strip(), e.attrib))
 104         return opts
 105
 106     def get_default_sliver_attributes(self, network=None):
 107         return []
 108
 109     def add_default_sliver_attribute(self, name, value, network=None):
 110         pass
 111
 112     def add_slivers(self, hostnames, attributes=None, sliver_urn=None, append=False):
 113         if attributes is None: attributes=[]
 114         # all nodes hould already be present in the rspec. Remove all
 115         # nodes that done have slivers
 116         for hostname in hostnames:
 117             node_elems = self.get_nodes({'component_id': '*%s*' % hostname})
 118             if not node_elems:
 119                 continue
 120             node_elem = node_elems[0]
 121
 122             # determine sliver types for this node
 123             valid_sliver_types = ['emulab-openvz', 'raw-pc', 'plab-vserver', 'plab-vnode']
 124             requested_sliver_type = None
 125             for sliver_type in node_elem.get('slivers', []):
 126                 if sliver_type.get('type') in valid_sliver_types:
 127                     requested_sliver_type = sliver_type['type']
 128
 129             if not requested_sliver_type:
 130                 continue
 131             sliver = {'type': requested_sliver_type,
 132                      'pl_tags': attributes}
 133
 134             # remove available element
 135             for available_elem in node_elem.xpath('./default:available | ./available'):
 136                 node_elem.remove(available_elem)
 137
 138             # remove interface elements
 139             for interface_elem in node_elem.xpath('./default:interface | ./interface'):
 140                 node_elem.remove(interface_elem)
 141
 142             # remove existing sliver_type elements
 143             for sliver_type in node_elem.get('slivers', []):
 144                 node_elem.element.remove(sliver_type.element)
 145
 146             # set the client id
 147             node_elem.element.set('client_id', hostname)
 148             if sliver_urn:
 149                 pass
 150                 # TODO
 151                 # set the sliver id
 152                 #slice_id = sliver_info.get('slice_id', -1)
 153                 #node_id = sliver_info.get('node_id', -1)
 154                 #sliver_id = Xrn(xrn=sliver_urn, type='slice', id=str(node_id)).get_urn()
 155                 #node_elem.set('sliver_id', sliver_id)
 156
 157             # add the sliver type elemnt
 158             PGv2SliverType.add_slivers(node_elem.element, sliver)
 159
 160         # remove all nodes without slivers
 161         if not append:
 162             for node_elem in self.get_nodes():
 163                 if not node_elem['client_id']:
 164                     parent = node_elem.element.getparent()
 165                     parent.remove(node_elem.element)
 166
 167     def remove_slivers(self, slivers, network=None, no_dupes=False):
 168         PGv2Node.remove_slivers(self.xml, slivers)
 169
 170     # Links
 171
 172     def get_links(self, network=None):
 173         return PGv2Link.get_links(self.xml)
 174
 175     def get_link_requests(self):
 176         return PGv2Link.get_link_requests(self.xml)
 177
 178     def add_links(self, links):
 179         PGv2Link.add_links(self.xml.root, links)
 180
 181     def add_link_requests(self, link_tuples, append=False):
 182         PGv2Link.add_link_requests(self.xml.root, link_tuples, append)
 183
 184     # Leases
 185
 186     def get_leases(self, filter=None):
 187         return PGv2Lease.get_leases(self.xml, filter)
 188
 189     def add_leases(self, leases, network = None, no_dupes=False):
 190         PGv2Lease.add_leases(self.xml, leases)
 191
 192     # Spectrum
 193
 194     def get_channels(self, filter=None):
 195         return []
 196
 197     def add_channels(self, channels, network = None, no_dupes=False):
 198         pass
 199
 200     # Utility
 201
 202     def merge(self, in_rspec):
 203         """
 204         Merge contents for specified rspec with current rspec
 205         """
 206         from sfa.rspecs.rspec import RSpec
 207         # just copy over all the child elements under the root element
 208         if isinstance(in_rspec, StringType):
 209             in_rspec = RSpec(in_rspec)
 210
 211         nodes = in_rspec.version.get_nodes()
 212         # protogeni rspecs need to advertise the availabel sliver types
 213         main_nodes = []
 214         for node in nodes:
 215             if not node['component_name']:
 216                 # this node element is part of a lease
 217                 continue
 218             if 'sliver' not in node or not node['sliver']:
 219                 node['sliver'] = {'name': 'plab-vserver'}
 220                 main_nodes.append(node)
 221         self.add_nodes(main_nodes)
 222         self.add_links(in_rspec.version.get_links())
 223
 224         # Leases
 225         leases = in_rspec.version.get_leases()
 226         self.add_leases(leases)
 227         #
 228         #rspec = RSpec(in_rspec)
 229         #for child in rspec.xml.iterchildren():
 230         #    self.xml.root.append(child)
 231
 232
 233
 234     def cleanup(self):
 235         # remove unncecessary elements, attributes
 236         if self.type in ['request', 'manifest']:
 237             # remove 'available' element from remaining node elements
 238             self.xml.remove_element('//default:available | //available')
 239
 240 class PGv2Ad(PGv2):
 241     enabled = True
 242     content_type = 'ad'
 243     schema = 'http://www.protogeni.net/resources/rspec/2/ad.xsd'
 244     template = '<rspec type="advertisement" xmlns="http://www.protogeni.net/resources/rspec/2" xmlns:flack="http://www.protogeni.net/resources/rspec/ext/flack/1" xmlns:plos="http://www.planet-lab.org/resources/sfa/ext/plos/1" xmlns:planetlab="http://www.planet-lab.org/resources/sfa/ext/planetlab/1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.protogeni.net/resources/rspec/2 http://www.protogeni.net/resources/rspec/2/ad.xsd http://www.planet-lab.org/resources/sfa/ext/planetlab/1 http://www.planet-lab.org/resources/sfa/ext/planetlab/1/planetlab.xsd http://www.planet-lab.org/resources/sfa/ext/plos/1 http://www.planet-lab.org/resources/sfa/ext/plos/1/plos.xsd"/>'
 245
 246 class PGv2Request(PGv2):
 247     enabled = True
 248     content_type = 'request'
 249     schema = 'http://www.protogeni.net/resources/rspec/2/request.xsd'
 250     template = '<rspec type="request" xmlns="http://www.protogeni.net/resources/rspec/2" xmlns:flack="http://www.protogeni.net/resources/rspec/ext/flack/1" xmlns:plos="http://www.planet-lab.org/resources/sfa/ext/plos/1" xmlns:planetlab="http://www.planet-lab.org/resources/sfa/ext/planetlab/1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.protogeni.net/resources/rspec/2 http://www.protogeni.net/resources/rspec/2/request.xsd http://www.planet-lab.org/resources/sfa/ext/planetlab/1 http://www.planet-lab.org/resources/sfa/ext/planetlab/1/planetlab.xsd http://www.planet-lab.org/resources/sfa/ext/plos/1 http://www.planet-lab.org/resources/sfa/ext/plos/1/plos.xsd"/>'
 251
 252 class PGv2Manifest(PGv2):
 253     enabled = True
 254     content_type = 'manifest'
 255     schema = 'http://www.protogeni.net/resources/rspec/2/manifest.xsd'
 256     template = '<rspec type="manifest" xmlns="http://www.protogeni.net/resources/rspec/2" xmlns:plos="http://www.planet-lab.org/resources/sfa/ext/plos/1" xmlns:flack="http://www.protogeni.net/resources/rspec/ext/flack/1" xmlns:planetlab="http://www.planet-lab.org/resources/sfa/ext/planetlab/1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.protogeni.net/resources/rspec/2 http://www.protogeni.net/resources/rspec/2/manifest.xsd http://www.planet-lab.org/resources/sfa/ext/planetlab/1 http://www.planet-lab.org/resources/sfa/ext/planetlab/1/planetlab.xsd http://www.planet-lab.org/resources/sfa/ext/plos/1 http://www.planet-lab.org/resources/sfa/ext/plos/1/plos.xsd"/>'
 257
 258
 259
 260
 261 if __name__ == '__main__':
 262     from sfa.rspecs.rspec import RSpec
 263     from sfa.rspecs.rspec_elements import *
 264     r = RSpec('/tmp/pg.rspec')
 265     r.load_rspec_elements(PGv2.elements)
 266     r.namespaces = PGv2.namespaces
 267     print(r.get(RSpecElements.NODE))