trimmed dependencies to plxrn
[sfa.git] / sfa / rspecs / versions / pgv2.py
1 from copy import deepcopy
2 from StringIO import StringIO
3 from sfa.util.xrn import Xrn, urn_to_sliver_id
4 from sfa.rspecs.version import RSpecVersion
5 from sfa.rspecs.elements.versions.pgv2Link import PGv2Link
6 from sfa.rspecs.elements.versions.pgv2Node import PGv2Node
7 from sfa.rspecs.elements.versions.pgv2SliverType import PGv2SliverType
8  
9 class PGv2(RSpecVersion):
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         'plos': "http://www.planet-lab.org/resources/sfa/ext/plos/1",
19     }
20     namespaces = dict(extensions.items() + [('default', namespace)])
21
22     # Networks
23     def get_networks(self):
24         network_names = set()
25         nodes = self.xml.xpath('//default:node[@component_manager_id] | //node[@component_manager_id]', namespaces=self.namespaces)
26         for node in nodes:
27             if 'component_manager_id' in node.attrib:
28                 network_urn = node.get('component_manager_id')
29                 if network_urn.startswith("urn:"):
30                     network_hrn = Xrn(network_urn).get_hrn()
31                 else:
32                     # some component_manager_ids are hrns instead of urns??
33                     network_hrn = network_urn
34                 network_names.add(network_hrn)
35         network_names = list(network_names)
36         networks = [{"name": x} for x in network_names]
37         return networks
38
39     # Nodes
40
41     def get_nodes(self, filter=None):
42         return PGv2Node.get_nodes(self.xml, filter)
43
44     def get_nodes_with_slivers(self):
45         return PGv2Node.get_nodes_with_slivers(self.xml)
46
47     def add_nodes(self, nodes, check_for_dupes=False):
48         return PGv2Node.add_nodes(self.xml, nodes)
49     
50     def merge_node(self, source_node_tag):
51         # this is untested
52         self.xml.root.append(deepcopy(source_node_tag))
53
54     # Slivers
55     
56     def get_sliver_attributes(self, hostname, network=None):
57         nodes = self.get_nodes({'component_id': '*%s*' %hostname})
58         attribs = []
59         if nodes is not None and isinstance(nodes, list) and len(nodes) > 0:
60             node = nodes[0]
61             sliver = node.xpath('./default:sliver_type', namespaces=self.namespaces)
62             if sliver is not None and isinstance(sliver, list) and len(sliver) > 0:
63                 sliver = sliver[0]
64                 #attribs = self.attributes_list(sliver)
65         return attribs
66
67     def get_slice_attributes(self, network=None):
68         slice_attributes = []
69         nodes_with_slivers = self.get_nodes_with_slivers()
70         # TODO: default sliver attributes in the PG rspec?
71         default_ns_prefix = self.namespaces['default']
72         for node in nodes_with_slivers:
73             sliver_attributes = self.get_sliver_attributes(node, network)
74             for sliver_attribute in sliver_attributes:
75                 name=str(sliver_attribute[0])
76                 text =str(sliver_attribute[1])
77                 attribs = sliver_attribute[2]
78                 # we currently only suppor the <initscript> and <flack> attributes
79                 if  'info' in name:
80                     attribute = {'name': 'flack_info', 'value': str(attribs), 'node_id': node}
81                     slice_attributes.append(attribute)
82                 elif 'initscript' in name:
83                     if attribs is not None and 'name' in attribs:
84                         value = attribs['name']
85                     else:
86                         value = text
87                     attribute = {'name': 'initscript', 'value': value, 'node_id': node}
88                     slice_attributes.append(attribute)
89
90         return slice_attributes
91
92     def attributes_list(self, elem):
93         opts = []
94         if elem is not None:
95             for e in elem:
96                 opts.append((e.tag, str(e.text).strip(), e.attrib))
97         return opts
98
99     def get_default_sliver_attributes(self, network=None):
100         return []
101
102     def add_default_sliver_attribute(self, name, value, network=None):
103         pass
104
105     def add_slivers(self, hostnames, attributes=[], sliver_urn=None, append=False):
106         # all nodes hould already be present in the rspec. Remove all
107         # nodes that done have slivers
108         for hostname in hostnames:
109             node_elems = self.get_nodes({'component_id': '*%s*' % hostname})
110             if not node_elems:
111                 continue
112             node_elem = node_elems[0]
113             
114             # determine sliver types for this node
115             valid_sliver_types = ['emulab-openvz', 'raw-pc', 'plab-vserver', 'plab-vnode']
116             requested_sliver_type = None
117             for sliver_type in node_elem.get('slivers', []):
118                 if sliver_type.get('type') in valid_sliver_types:
119                     requested_sliver_type = sliver_type['type']
120             
121             if not requested_sliver_type:
122                 continue
123             sliver = {'type': requested_sliver_type,
124                      'pl_tags': attributes}
125
126             # remove available element
127             for available_elem in node_elem.xpath('./default:available | ./available'):
128                 node_elem.remove(available_elem)
129             
130             # remove interface elements
131             for interface_elem in node_elem.xpath('./default:interface | ./interface'):
132                 node_elem.remove(interface_elem)
133         
134             # remove existing sliver_type elements
135             for sliver_type in node_elem.get('slivers', []):
136                 node_elem.element.remove(sliver_type.element)
137
138             # set the client id
139             node_elem.element.set('client_id', hostname)
140             if sliver_urn:
141                 pass
142                 # TODO
143                 # set the sliver id
144                 #slice_id = sliver_info.get('slice_id', -1)
145                 #node_id = sliver_info.get('node_id', -1)
146                 #sliver_id = urn_to_sliver_id(sliver_urn, slice_id, node_id)
147                 #node_elem.set('sliver_id', sliver_id)
148
149             # add the sliver type elemnt    
150             PGv2SliverType.add_slivers(node_elem.element, sliver)         
151
152         # remove all nodes without slivers
153         if not append:
154             for node_elem in self.get_nodes():
155                 if not node_elem['client_id']:
156                     parent = node_elem.element.getparent()
157                     parent.remove(node_elem.element)
158
159     def remove_slivers(self, slivers, network=None, no_dupes=False):
160         PGv2Node.remove_slivers(self.xml, slivers) 
161
162     # Links
163
164     def get_links(self, network=None):
165         return PGv2Link.get_links(self.xml)
166
167     def get_link_requests(self):
168         return PGv2Link.get_link_requests(self.xml)  
169
170     def add_links(self, links):
171         PGv2Link.add_links(self.xml.root, links)
172
173     def add_link_requests(self, link_tuples, append=False):
174         PGv2Link.add_link_requests(self.xml.root, link_tuples, append)
175
176     # Utility
177
178     def merge(self, in_rspec):
179         """
180         Merge contents for specified rspec with current rspec
181         """
182         from sfa.rspecs.rspec import RSpec
183         # just copy over all the child elements under the root element
184         if isinstance(in_rspec, basestring):
185             in_rspec = RSpec(in_rspec)
186
187         nodes = in_rspec.version.get_nodes()
188         # protogeni rspecs need to advertise the availabel sliver types
189         for node in nodes:
190             if not node.has_key('sliver') or not node['sliver']:
191                 node['sliver'] = {'name': 'plab-vserver'}
192             
193         self.add_nodes(nodes)
194         self.add_links(in_rspec.version.get_links())
195         
196         #
197         #rspec = RSpec(in_rspec)
198         #for child in rspec.xml.iterchildren():
199         #    self.xml.root.append(child)
200         
201         
202
203     def cleanup(self):
204         # remove unncecessary elements, attributes
205         if self.type in ['request', 'manifest']:
206             # remove 'available' element from remaining node elements
207             self.xml.remove_element('//default:available | //available')
208
209 class PGv2Ad(PGv2):
210     enabled = True
211     content_type = 'ad'
212     schema = 'http://www.protogeni.net/resources/rspec/2/ad.xsd'
213     template = '<rspec type="advertisement" xmlns="http://www.protogeni.net/resources/rspec/2" xmlns:flack="http://www.protogeni.net/resources/rspec/ext/flack/1" xmlns:plos="http://www.planet-lab.org/resources/sfa/ext/plos/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 http://www.planet-lab.org/resources/sfa/ext/plos/1 http://www.planet-lab.org/resources/sfa/ext/plos/1/plos.xsd"/>'
214
215 class PGv2Request(PGv2):
216     enabled = True
217     content_type = 'request'
218     schema = 'http://www.protogeni.net/resources/rspec/2/request.xsd'
219     template = '<rspec type="request" xmlns="http://www.protogeni.net/resources/rspec/2" xmlns:flack="http://www.protogeni.net/resources/rspec/ext/flack/1" xmlns:plos="http://www.planet-lab.org/resources/sfa/ext/plos/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 http://www.planet-lab.org/resources/sfa/ext/plos/1 http://www.planet-lab.org/resources/sfa/ext/plos/1/plos.xsd"/>'
220
221 class PGv2Manifest(PGv2):
222     enabled = True
223     content_type = 'manifest'
224     schema = 'http://www.protogeni.net/resources/rspec/2/manifest.xsd'
225     template = '<rspec type="manifest" xmlns="http://www.protogeni.net/resources/rspec/2" xmlns:plos="http://www.planet-lab.org/resources/sfa/ext/plos/1" 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 http://www.planet-lab.org/resources/sfa/ext/plos/1 http://www.planet-lab.org/resources/sfa/ext/plos/1/plos.xsd"/>'
226
227      
228
229
230 if __name__ == '__main__':
231     from sfa.rspecs.rspec import RSpec
232     from sfa.rspecs.rspec_elements import *
233     r = RSpec('/tmp/pg.rspec')
234     r.load_rspec_elements(PGv2.elements)
235     r.namespaces = PGv2.namespaces
236     print r.get(RSpecElements.NODE)