sfa/rspecs/pg_rspec.py

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