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
9 class PGv2(BaseVersion):
13 schema = 'http://www.protogeni.net/resources/rspec/2/ad.xsd'
14 namespace = 'http://www.protogeni.net/resources/rspec/2'
16 'flack': "http://www.protogeni.net/resources/rspec/ext/flack/1",
17 'planetlab': "http://www.planet-lab.org/resources/sfa/ext/planetlab/1",
19 namespaces = dict(extensions.items() + [('default', namespace)])
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'),
26 def get_network(self):
28 nodes = self.xml.xpath('//default:node[@component_manager_id][1]', namespaces=self.namespaces)
30 network = nodes[0].get('component_manager_id')
33 def get_networks(self):
34 networks = self.xml.xpath('//default:node[@component_manager_id]/@component_manager_id', namespaces=self.namespaces)
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:
44 def get_node_elements(self, network=None):
45 nodes = self.xml.xpath('//default:node | //node', namespaces=self.namespaces)
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]
55 def get_nodes_with_slivers(self, network=None):
57 nodes = self.xml.xpath('//default:node[@component_manager_id="%s"][sliver_type]/@component_id' % network, namespaces=self.namespaces)
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]
63 def get_nodes_without_slivers(self, network=None):
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):
71 return self.attributes_list(sliver)
73 def get_slice_attributes(self, network=None):
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
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']
93 attribute = {'name': 'initscript', 'value': value, 'node_id': node}
94 slice_attributes.append(attribute)
96 return slice_attributes
98 def attributes_list(self, elem):
102 opts.append((e.tag, str(e.text).strip(), e.attrib))
105 def get_default_sliver_attributes(self, network=None):
108 def add_default_sliver_attribute(self, name, value, network=None):
111 def add_nodes(self, nodes, check_for_dupes=False):
112 if not isinstance(nodes, list):
116 if check_for_dupes and \
117 self.xml.xpath('//default:node[@component_uuid="%s"]' % urn, namespaces=self.namespaces):
118 # node already exists
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'])
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-vnode')
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'])
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
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))
148 def merge_node(self, source_node_tag):
150 self.xml.root.append(deepcopy(source_node_tag))
152 def add_slivers(self, slivers, sliver_urn=None, no_dupes=False):
154 # all nodes hould already be present in the rspec. Remove all
155 # nodes that done have slivers
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
163 nodes = self.get_node_elements()
165 urn = node.get('component_id')
166 hostname = xrn_to_hostname(urn)
167 if hostname not in slivers_dict:
168 parent = node.getparent()
171 sliver_info = slivers_dict[hostname]
172 sliver_type_elements = node.xpath('./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']
175 requested_sliver_type = None
176 for valid_sliver_type in valid_sliver_types:
177 if valid_sliver_type in available_sliver_type:
178 requested_sliver_type = valid_sliver_type
180 if requested_sliver_type:
181 # remove existing sliver_type tags,it needs to be recreated
182 sliver_elem = node.xpath('./default:sliver_type | ./sliver_type', namespaces=self.namespaces)
183 if sliver_elem and isinstance(sliver_elem, list):
184 sliver_elem = sliver_elem[0]
185 node.remove(sliver_elem)
187 node.set('client_id', hostname)
190 slice_id = sliver_info.get('slice_id', -1)
191 node_id = sliver_info.get('node_id', -1)
192 sliver_id = urn_to_sliver_id(sliver_urn, slice_id, node_id)
193 node.set('sliver_id', sliver_id)
195 # add the sliver element
196 sliver_elem = etree.SubElement(node, 'sliver_type', name=requested_sliver_type)
197 for tag in sliver_info.get('tags', []):
198 if tag['tagname'] == 'flack_info':
199 e = etree.SubElement(sliver_elem, '{%s}info' % self.namespaces['flack'], attrib=eval(tag['value']))
200 elif tag['tagname'] == 'initscript':
201 e = etree.SubElement(sliver_elem, '{%s}initscript' % self.namespaces['planetlab'], attrib={'name': tag['value']})
203 # node isn't usable. just remove it from the request
204 parent = node.getparent()
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])
215 def add_default_sliver_attribute(self, name, value, network=None):
218 def add_interfaces(self, interfaces, no_dupes=False):
221 def add_links(self, links, no_dupes=False):
224 def merge(self, in_rspec):
226 Merge contents for specified rspec with current rspec
228 from sfa.rspecs.rspec import RSpec
229 # just copy over all the child elements under the root element
230 if isinstance(in_rspec, RSpec):
231 in_rspec = in_rspec.toxml()
232 tree = etree.parse(StringIO(in_rspec))
233 root = tree.getroot()
234 for child in root.getchildren():
235 self.xml.root.append(child)
238 # remove unncecessary elements, attributes
239 if self.type in ['request', 'manifest']:
240 # remove 'available' element from remaining node elements
241 self.xml.remove_element('//default:available | //available')
246 schema = 'http://www.protogeni.net/resources/rspec/2/ad.xsd'
247 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" type="advertisement"/>'
249 class PGv2Request(PGv2):
251 content_type = 'request'
252 schema = 'http://www.protogeni.net/resources/rspec/2/request.xsd'
253 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" type="request"/>'
255 class PGv2Manifest(PGv2):
257 content_type = 'manifest'
258 schema = 'http://www.protogeni.net/resources/rspec/2/manifest.xsd'
259 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" type="manifest"/>'
263 if __name__ == '__main__':
264 from sfa.rspecs.rspec import RSpec
265 from sfa.rspecs.rspec_elements import *
266 r = RSpec('/tmp/pg.rspec')
267 r.load_rspec_elements(PGv2.elements)
268 r.namespaces = PGv2.namespaces
269 print r.get(RSpecElements.NODE)