2 from copy import deepcopy
3 from StringIO import StringIO
4 from sfa.util.xrn import urn_to_sliver_id
5 from sfa.util.plxrn import hostname_to_urn, xrn_to_hostname
6 from sfa.rspecs.baseversion 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)])
23 def get_network(self):
25 nodes = self.xml.xpath('//default:node[@component_manager_id][1]', namespaces=self.namespaces)
27 network = nodes[0].get('component_manager_id')
30 def get_networks(self):
31 networks = self.xml.xpath('//default:node[@component_manager_id]/@component_manager_id', namespaces=self.namespaces)
34 def get_node_element(self, hostname, network=None):
35 nodes = self.xml.xpath('//default:node[@component_id[contains(., "%s")]] | node[@component_id[contains(., "%s")]]' % (hostname, hostname), namespaces=self.namespaces)
36 if isinstance(nodes,list) and nodes:
41 def get_node_elements(self, network=None):
42 nodes = self.xml.xpath('//default:node | //node', namespaces=self.namespaces)
46 def get_nodes(self, network=None):
47 xpath = '//default:node[@component_name]/@component_id | //node[@component_name]/@component_id'
48 nodes = self.xml.xpath(xpath, namespaces=self.namespaces)
49 nodes = [xrn_to_hostname(node) for node in nodes]
52 def get_nodes_with_slivers(self, network=None):
54 nodes = self.xml.xpath('//default:node[@component_manager_id="%s"][sliver_type]/@component_id' % network, namespaces=self.namespaces)
56 nodes = self.xml.xpath('//default:node[default:sliver_type]/@component_id', namespaces=self.namespaces)
57 nodes = [xrn_to_hostname(node) for node in nodes]
60 def get_nodes_without_slivers(self, network=None):
63 def get_sliver_attributes(self, hostname, network=None):
64 node = self.get_node_element(hostname, network)
65 sliver = node.xpath('./default:sliver_type', namespaces=self.namespaces)
66 if sliver is not None and isinstance(sliver, list):
68 return self.attributes_list(sliver)
70 def get_slice_attributes(self, network=None):
72 nodes_with_slivers = self.get_nodes_with_slivers(network)
73 # TODO: default sliver attributes in the PG rspec?
74 default_ns_prefix = self.namespaces['default']
75 for node in nodes_with_slivers:
76 sliver_attributes = self.get_sliver_attributes(node, network)
77 for sliver_attribute in sliver_attributes:
78 name=str(sliver_attribute[0])
79 text =str(sliver_attribute[1])
80 attribs = sliver_attribute[2]
81 # we currently only suppor the <initscript> and <flack> attributes
83 attribute = {'name': 'flack_info', 'value': str(attribs), 'node_id': node}
84 slice_attributes.append(attribute)
85 elif 'initscript' in name:
86 if attribs is not None and 'name' in attribs:
87 value = attribs['name']
90 attribute = {'name': 'initscript', 'value': value, 'node_id': node}
91 slice_attributes.append(attribute)
93 return slice_attributes
95 def get_links(self, network=None):
96 return PGv2Link.get_links(self.xml)
98 def get_link_requests(self):
99 return PGv2Link.get_link_requests(self.xml)
101 def add_links(self, links):
102 PGv2Link.add_links(self.xml.root, links)
104 def add_link_requests(self, link_tuples, append=False):
105 PGv2Link.add_link_requests(self.xml.root, link_tuples, append)
107 def attributes_list(self, elem):
111 opts.append((e.tag, str(e.text).strip(), e.attrib))
114 def get_default_sliver_attributes(self, network=None):
117 def add_default_sliver_attribute(self, name, value, network=None):
120 def add_nodes(self, nodes, check_for_dupes=False):
121 if not isinstance(nodes, list):
125 if check_for_dupes and \
126 self.xml.xpath('//default:node[@component_uuid="%s"]' % urn, namespaces=self.namespaces):
127 # node already exists
130 node_tag = etree.SubElement(self.xml.root, 'node', exclusive='false')
131 if 'network_urn' in node:
132 node_tag.set('component_manager_id', node['network_urn'])
134 node_tag.set('component_id', node['urn'])
135 if 'hostname' in node:
136 node_tag.set('component_name', node['hostname'])
137 # TODO: should replace plab-pc with pc model
138 node_type_tag = etree.SubElement(node_tag, 'hardware_type', name='plab-pc')
139 node_type_tag = etree.SubElement(node_tag, 'hardware_type', name='pc')
140 available_tag = etree.SubElement(node_tag, 'available', now='true')
141 sliver_type_tag = etree.SubElement(node_tag, 'sliver_type', name='plab-vserver')
143 pl_initscripts = node.get('pl_initscripts', {})
144 for pl_initscript in pl_initscripts.values():
145 etree.SubElement(sliver_type_tag, '{%s}initscript' % self.namespaces['planetlab'], name=pl_initscript['name'])
147 # protogeni uses the <sliver_type> tag to identify the types of
148 # vms available at the node.
149 # only add location tag if longitude and latitude are not null
151 longitude = node['site'].get('longitude', None)
152 latitude = node['site'].get('latitude', None)
153 if longitude and latitude:
154 location_tag = etree.SubElement(node_tag, 'location', country="us", \
155 longitude=str(longitude), latitude=str(latitude))
157 def merge_node(self, source_node_tag):
159 self.xml.root.append(deepcopy(source_node_tag))
161 def add_slivers(self, slivers, sliver_urn=None, no_dupes=False, append=False):
163 # all nodes hould already be present in the rspec. Remove all
164 # nodes that done have slivers
166 for sliver in slivers:
167 if isinstance(sliver, basestring):
168 slivers_dict[sliver] = {'hostname': sliver}
169 elif isinstance(sliver, dict):
170 slivers_dict[sliver['hostname']] = sliver
172 nodes = self.get_node_elements()
174 urn = node.get('component_id')
175 hostname = xrn_to_hostname(urn)
176 if hostname not in slivers_dict and not append:
177 parent = node.getparent()
180 sliver_info = slivers_dict[hostname]
181 sliver_type_elements = node.xpath('./default:sliver_type', namespaces=self.namespaces)
182 available_sliver_types = [element.attrib['name'] for element in sliver_type_elements]
183 valid_sliver_types = ['emulab-openvz', 'raw-pc', 'plab-vserver', 'plab-vnode']
184 requested_sliver_type = None
185 for valid_sliver_type in valid_sliver_types:
186 if valid_sliver_type in available_sliver_types:
187 requested_sliver_type = valid_sliver_type
188 if requested_sliver_type:
189 # remove existing sliver_type tags,it needs to be recreated
190 sliver_elem = node.xpath('./default:sliver_type | ./sliver_type', namespaces=self.namespaces)
191 if sliver_elem and isinstance(sliver_elem, list):
192 sliver_elem = sliver_elem[0]
193 node.remove(sliver_elem)
195 node.set('client_id', hostname)
198 slice_id = sliver_info.get('slice_id', -1)
199 node_id = sliver_info.get('node_id', -1)
200 sliver_id = urn_to_sliver_id(sliver_urn, slice_id, node_id)
201 node.set('sliver_id', sliver_id)
203 # add the sliver element
204 sliver_elem = etree.SubElement(node, 'sliver_type', name=requested_sliver_type)
205 for tag in sliver_info.get('tags', []):
206 if tag['tagname'] == 'flack_info':
207 e = etree.SubElement(sliver_elem, '{%s}info' % self.namespaces['flack'], attrib=eval(tag['value']))
208 elif tag['tagname'] == 'initscript':
209 e = etree.SubElement(sliver_elem, '{%s}initscript' % self.namespaces['planetlab'], attrib={'name': tag['value']})
211 # node isn't usable. just remove it from the request
212 parent = node.getparent()
217 def remove_slivers(self, slivers, network=None, no_dupes=False):
218 for sliver in slivers:
219 node_elem = self.get_node_element(sliver['hostname'])
220 sliver_elem = node_elem.xpath('./default:sliver_type', self.namespaces)
221 if sliver_elem != None and sliver_elem != []:
222 node_elem.remove(sliver_elem[0])
224 def add_default_sliver_attribute(self, name, value, network=None):
227 def add_interfaces(self, interfaces, no_dupes=False):
230 def merge(self, in_rspec):
232 Merge contents for specified rspec with current rspec
234 from sfa.rspecs.rspec import RSpec
235 # just copy over all the child elements under the root element
236 if isinstance(in_rspec, RSpec):
237 in_rspec = in_rspec.toxml()
238 tree = etree.parse(StringIO(in_rspec))
239 root = tree.getroot()
240 for child in root.getchildren():
241 self.xml.root.append(child)
244 # remove unncecessary elements, attributes
245 if self.type in ['request', 'manifest']:
246 # remove 'available' element from remaining node elements
247 self.xml.remove_element('//default:available | //available')
252 schema = 'http://www.protogeni.net/resources/rspec/2/ad.xsd'
253 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"/>'
255 class PGv2Request(PGv2):
257 content_type = 'request'
258 schema = 'http://www.protogeni.net/resources/rspec/2/request.xsd'
259 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"/>'
261 class PGv2Manifest(PGv2):
263 content_type = 'manifest'
264 schema = 'http://www.protogeni.net/resources/rspec/2/manifest.xsd'
265 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"/>'
270 if __name__ == '__main__':
271 from sfa.rspecs.rspec import RSpec
272 from sfa.rspecs.rspec_elements import *
273 r = RSpec('/tmp/pg.rspec')
274 r.load_rspec_elements(PGv2.elements)
275 r.namespaces = PGv2.namespaces
276 print r.get(RSpecElements.NODE)