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
10 class PGv2(BaseVersion):
14 schema = 'http://www.protogeni.net/resources/rspec/2/ad.xsd'
15 namespace = 'http://www.protogeni.net/resources/rspec/2'
17 'flack': "http://www.protogeni.net/resources/rspec/ext/flack/1",
18 'planetlab': "http://www.planet-lab.org/resources/sfa/ext/planetlab/1",
20 namespaces = dict(extensions.items() + [('default', namespace)])
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'),
27 def get_network(self):
29 nodes = self.xml.xpath('//default:node[@component_manager_id][1]', namespaces=self.namespaces)
31 network = nodes[0].get('component_manager_id')
34 def get_networks(self):
35 networks = self.xml.xpath('//default:node[@component_manager_id]/@component_manager_id', namespaces=self.namespaces)
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:
45 def get_node_elements(self, network=None):
46 nodes = self.xml.xpath('//default:node | //node', namespaces=self.namespaces)
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]
56 def get_nodes_with_slivers(self, network=None):
58 nodes = self.xml.xpath('//default:node[@component_manager_id="%s"][sliver_type]/@component_id' % network, namespaces=self.namespaces)
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]
64 def get_nodes_without_slivers(self, network=None):
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):
72 return self.attributes_list(sliver)
74 def get_slice_attributes(self, network=None):
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
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']
94 attribute = {'name': 'initscript', 'value': value, 'node_id': node}
95 slice_attributes.append(attribute)
97 return slice_attributes
99 def get_links(self, network=None):
100 links = PGv2Link.get_links(self.xml, self.namespaces)
103 def add_links(self, links):
104 PGv2Link.add_links(self.xml, links)
106 def attributes_list(self, elem):
110 opts.append((e.tag, str(e.text).strip(), e.attrib))
113 def get_default_sliver_attributes(self, network=None):
116 def add_default_sliver_attribute(self, name, value, network=None):
119 def add_nodes(self, nodes, check_for_dupes=False):
120 if not isinstance(nodes, list):
124 if check_for_dupes and \
125 self.xml.xpath('//default:node[@component_uuid="%s"]' % urn, namespaces=self.namespaces):
126 # node already exists
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'])
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')
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'])
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
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))
156 def merge_node(self, source_node_tag):
158 self.xml.root.append(deepcopy(source_node_tag))
160 def add_slivers(self, slivers, sliver_urn=None, no_dupes=False, append=False):
162 # all nodes hould already be present in the rspec. Remove all
163 # nodes that done have slivers
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
171 nodes = self.get_node_elements()
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()
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)
194 node.set('client_id', hostname)
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)
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']})
210 # node isn't usable. just remove it from the request
211 parent = node.getparent()
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])
223 def add_default_sliver_attribute(self, name, value, network=None):
226 def add_interfaces(self, interfaces, no_dupes=False):
229 def add_links(self, links, no_dupes=False):
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)
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)
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)
251 def merge(self, in_rspec):
253 Merge contents for specified rspec with current rspec
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)
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')
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"/>'
276 class PGv2Request(PGv2):
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"/>'
282 class PGv2Manifest(PGv2):
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"/>'
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)