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