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