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