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