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