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