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