sfa/rspecs/versions/pgv2.py

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