sfa/rspecs/versions/pgv2.py

   1 from lxml import etree
   2 from copy import deepcopy
   3 from StringIO import StringIO
   4 from sfa.util.xrn import *
   5 from sfa.util.plxrn import hostname_to_urn, xrn_to_hostname
   6 from sfa.rspecs.rspec_version import BaseVersion
   7 from sfa.rspecs.rspec_elements import RSpecElement, RSpecElements
   8 from sfa.rspecs.elements.versions.pgv2Link import PGv2Link
   9
  10 class PGv2(BaseVersion):
  11     type = 'ProtoGENI'
  12     content_type = 'ad'
  13     version = '2'
  14     schema = 'http://www.protogeni.net/resources/rspec/2/ad.xsd'
  15     namespace = 'http://www.protogeni.net/resources/rspec/2'
  16     extensions = {
  17         'flack': "http://www.protogeni.net/resources/rspec/ext/flack/1",
  18         'planetlab': "http://www.planet-lab.org/resources/sfa/ext/planetlab/1",
  19     }
  20     namespaces = dict(extensions.items() + [('default', namespace)])
  21     elements = []
  22
  23     def get_network(self):
  24         network = None
  25         nodes = self.xml.xpath('//default:node[@component_manager_id][1]', namespaces=self.namespaces)
  26         if nodes:
  27             network  = nodes[0].get('component_manager_id')
  28         return network
  29
  30     def get_networks(self):
  31         networks = self.xml.xpath('//default:node[@component_manager_id]/@component_manager_id', namespaces=self.namespaces)
  32         return set(networks)
  33
  34     def get_node_element(self, hostname, network=None):
  35         nodes = self.xml.xpath('//default:node[@component_id[contains(., "%s")]] | node[@component_id[contains(., "%s")]]' % (hostname, hostname), namespaces=self.namespaces)
  36         if isinstance(nodes,list) and nodes:
  37             return nodes[0]
  38         else:
  39             return None
  40
  41     def get_node_elements(self, network=None):
  42         nodes = self.xml.xpath('//default:node | //node', namespaces=self.namespaces)
  43         return nodes
  44
  45
  46     def get_nodes(self, network=None):
  47         xpath = '//default:node[@component_name]/@component_id | //node[@component_name]/@component_id'
  48         nodes = self.xml.xpath(xpath, namespaces=self.namespaces)
  49         nodes = [xrn_to_hostname(node) for node in nodes]
  50         return nodes
  51
  52     def get_nodes_with_slivers(self, network=None):
  53         if network:
  54             nodes = self.xml.xpath('//default:node[@component_manager_id="%s"][sliver_type]/@component_id' % network, namespaces=self.namespaces)
  55         else:
  56             nodes = self.xml.xpath('//default:node[default:sliver_type]/@component_id', namespaces=self.namespaces)
  57         nodes = [xrn_to_hostname(node) for node in nodes]
  58         return nodes
  59
  60     def get_nodes_without_slivers(self, network=None):
  61         return []
  62
  63     def get_sliver_attributes(self, hostname, network=None):
  64         node = self.get_node_element(hostname, network)
  65         sliver = node.xpath('./default:sliver_type', namespaces=self.namespaces)
  66         if sliver is not None and isinstance(sliver, list):
  67             sliver = sliver[0]
  68         return self.attributes_list(sliver)
  69
  70     def get_slice_attributes(self, network=None):
  71         slice_attributes = []
  72         nodes_with_slivers = self.get_nodes_with_slivers(network)
  73         # TODO: default sliver attributes in the PG rspec?
  74         default_ns_prefix = self.namespaces['default']
  75         for node in nodes_with_slivers:
  76             sliver_attributes = self.get_sliver_attributes(node, network)
  77             for sliver_attribute in sliver_attributes:
  78                 name=str(sliver_attribute[0])
  79                 text =str(sliver_attribute[1])
  80                 attribs = sliver_attribute[2]
  81                 # we currently only suppor the <initscript> and <flack> attributes
  82                 if  'info' in name:
  83                     attribute = {'name': 'flack_info', 'value': str(attribs), 'node_id': node}
  84                     slice_attributes.append(attribute)
  85                 elif 'initscript' in name:
  86                     if attribs is not None and 'name' in attribs:
  87                         value = attribs['name']
  88                     else:
  89                         value = text
  90                     attribute = {'name': 'initscript', 'value': value, 'node_id': node}
  91                     slice_attributes.append(attribute)
  92
  93         return slice_attributes
  94
  95     def get_links(self, network=None):
  96         links = PGv2Link.get_links(self.xml)
  97         return links
  98
  99     def add_links(self, links):
 100         PGv2Link.add_links(self.xml, links)
 101
 102     def attributes_list(self, elem):
 103         opts = []
 104         if elem is not None:
 105             for e in elem:
 106                 opts.append((e.tag, str(e.text).strip(), e.attrib))
 107         return opts
 108
 109     def get_default_sliver_attributes(self, network=None):
 110         return []
 111
 112     def add_default_sliver_attribute(self, name, value, network=None):
 113         pass
 114
 115     def add_nodes(self, nodes, check_for_dupes=False):
 116         if not isinstance(nodes, list):
 117             nodes = [nodes]
 118         for node in nodes:
 119             urn = ""
 120             if check_for_dupes and \
 121               self.xml.xpath('//default:node[@component_uuid="%s"]' % urn, namespaces=self.namespaces):
 122                 # node already exists
 123                 continue
 124
 125             node_tag = etree.SubElement(self.xml.root, 'node', exclusive='false')
 126             if 'network_urn' in node:
 127                 node_tag.set('component_manager_id', node['network_urn'])
 128             if 'urn' in node:
 129                 node_tag.set('component_id', node['urn'])
 130             if 'hostname' in node:
 131                 node_tag.set('component_name', node['hostname'])
 132             # TODO: should replace plab-pc with pc model
 133             node_type_tag = etree.SubElement(node_tag, 'hardware_type', name='plab-pc')
 134             node_type_tag = etree.SubElement(node_tag, 'hardware_type', name='pc')
 135             available_tag = etree.SubElement(node_tag, 'available', now='true')
 136             sliver_type_tag = etree.SubElement(node_tag, 'sliver_type', name='plab-vserver')
 137
 138             pl_initscripts = node.get('pl_initscripts', {})
 139             for pl_initscript in pl_initscripts.values():
 140                 etree.SubElement(sliver_type_tag, '{%s}initscript' % self.namespaces['planetlab'], name=pl_initscript['name'])
 141
 142             # protogeni uses the <sliver_type> tag to identify the types of
 143             # vms available at the node.
 144             # only add location tag if longitude and latitude are not null
 145             if 'site' in node:
 146                 longitude = node['site'].get('longitude', None)
 147                 latitude = node['site'].get('latitude', None)
 148                 if longitude and latitude:
 149                     location_tag = etree.SubElement(node_tag, 'location', country="us", \
 150                                                     longitude=str(longitude), latitude=str(latitude))
 151
 152     def merge_node(self, source_node_tag):
 153         # this is untested
 154         self.xml.root.append(deepcopy(source_node_tag))
 155
 156     def add_slivers(self, slivers, sliver_urn=None, no_dupes=False, append=False):
 157
 158         # all nodes hould already be present in the rspec. Remove all
 159         # nodes that done have slivers
 160         slivers_dict = {}
 161         for sliver in slivers:
 162             if isinstance(sliver, basestring):
 163                 slivers_dict[sliver] = {'hostname': sliver}
 164             elif isinstance(sliver, dict):
 165                 slivers_dict[sliver['hostname']] = sliver
 166
 167         nodes = self.get_node_elements()
 168         for node in nodes:
 169             urn = node.get('component_id')
 170             hostname = xrn_to_hostname(urn)
 171             if hostname not in slivers_dict and not append:
 172                 parent = node.getparent()
 173                 parent.remove(node)
 174             else:
 175                 sliver_info = slivers_dict[hostname]
 176                 sliver_type_elements = node.xpath('./default:sliver_type', namespaces=self.namespaces)
 177                 available_sliver_types = [element.attrib['name'] for element in sliver_type_elements]
 178                 valid_sliver_types = ['emulab-openvz', 'raw-pc', 'plab-vserver', 'plab-vnode']
 179                 requested_sliver_type = None
 180                 for valid_sliver_type in valid_sliver_types:
 181                     if valid_sliver_type in available_sliver_types:
 182                         requested_sliver_type = valid_sliver_type
 183                 if requested_sliver_type:
 184                     # remove existing sliver_type tags,it needs to be recreated
 185                     sliver_elem = node.xpath('./default:sliver_type | ./sliver_type', namespaces=self.namespaces)
 186                     if sliver_elem and isinstance(sliver_elem, list):
 187                         sliver_elem = sliver_elem[0]
 188                         node.remove(sliver_elem)
 189                     # set the client id
 190                     node.set('client_id', hostname)
 191                     if sliver_urn:
 192                         # set the sliver id
 193                         slice_id = sliver_info.get('slice_id', -1)
 194                         node_id = sliver_info.get('node_id', -1)
 195                         sliver_id = urn_to_sliver_id(sliver_urn, slice_id, node_id)
 196                         node.set('sliver_id', sliver_id)
 197
 198                     # add the sliver element
 199                     sliver_elem = etree.SubElement(node, 'sliver_type', name=requested_sliver_type)
 200                     for tag in sliver_info.get('tags', []):
 201                         if tag['tagname'] == 'flack_info':
 202                             e = etree.SubElement(sliver_elem, '{%s}info' % self.namespaces['flack'], attrib=eval(tag['value']))
 203                         elif tag['tagname'] == 'initscript':
 204                             e = etree.SubElement(sliver_elem, '{%s}initscript' % self.namespaces['planetlab'], attrib={'name': tag['value']})
 205                 else:
 206                     # node isn't usable. just remove it from the request
 207                     parent = node.getparent()
 208                     parent.remove(node)
 209
 210
 211
 212     def remove_slivers(self, slivers, network=None, no_dupes=False):
 213         for sliver in slivers:
 214             node_elem = self.get_node_element(sliver['hostname'])
 215             sliver_elem = node_elem.xpath('./default:sliver_type', self.namespaces)
 216             if sliver_elem != None and sliver_elem != []:
 217                 node_elem.remove(sliver_elem[0])
 218
 219     def add_default_sliver_attribute(self, name, value, network=None):
 220         pass
 221
 222     def add_interfaces(self, interfaces, no_dupes=False):
 223         pass
 224
 225     def merge(self, in_rspec):
 226         """
 227         Merge contents for specified rspec with current rspec
 228         """
 229         from sfa.rspecs.rspec import RSpec
 230         # just copy over all the child elements under the root element
 231         if isinstance(in_rspec, RSpec):
 232             in_rspec = in_rspec.toxml()
 233         tree = etree.parse(StringIO(in_rspec))
 234         root = tree.getroot()
 235         for child in root.getchildren():
 236             self.xml.root.append(child)
 237
 238     def cleanup(self):
 239         # remove unncecessary elements, attributes
 240         if self.type in ['request', 'manifest']:
 241             # remove 'available' element from remaining node elements
 242             self.xml.remove_element('//default:available | //available')
 243
 244 class PGv2Ad(PGv2):
 245     enabled = True
 246     content_type = 'ad'
 247     schema = 'http://www.protogeni.net/resources/rspec/2/ad.xsd'
 248     template = '<rspec type="advertisement" xmlns="http://www.protogeni.net/resources/rspec/2" 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/ad.xsd http://www.planet-lab.org/resources/sfa/ext/planetlab/1 http://www.planet-lab.org/resources/sfa/ext/planetlab/1/planetlab.xsd"/>'
 249
 250 class PGv2Request(PGv2):
 251     enabled = True
 252     content_type = 'request'
 253     schema = 'http://www.protogeni.net/resources/rspec/2/request.xsd'
 254     template = '<rspec type="request" xmlns="http://www.protogeni.net/resources/rspec/2" 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/request.xsd http://www.planet-lab.org/resources/sfa/ext/planetlab/1 http://www.planet-lab.org/resources/sfa/ext/planetlab/1/planetlab.xsd"/>'
 255
 256 class PGv2Manifest(PGv2):
 257     enabled = True
 258     content_type = 'manifest'
 259     schema = 'http://www.protogeni.net/resources/rspec/2/manifest.xsd'
 260     template = '<rspec type="manifest" xmlns="http://www.protogeni.net/resources/rspec/2" 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"/>'
 261
 262
 263
 264
 265 if __name__ == '__main__':
 266     from sfa.rspecs.rspec import RSpec
 267     from sfa.rspecs.rspec_elements import *
 268     r = RSpec('/tmp/pg.rspec')
 269     r.load_rspec_elements(PGv2.elements)
 270     r.namespaces = PGv2.namespaces
 271     print r.get(RSpecElements.NODE)