sfa/rspecs/versions/pgv2.py

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