In CreateSliver() return the result rspec not the request rspec
[sfa.git] / sfa / managers / slice_manager_pl.py
1 #
2 import sys
3 import time,datetime
4 from StringIO import StringIO
5 from types import StringTypes
6 from copy import deepcopy
7 from copy import copy
8 from lxml import etree
9
10 from sfa.util.sfalogging import logger
11 from sfa.util.rspecHelper import merge_rspecs
12 from sfa.util.xrn import Xrn, urn_to_hrn, hrn_to_urn
13 from sfa.util.plxrn import hrn_to_pl_slicename
14 from sfa.util.rspec import *
15 from sfa.util.specdict import *
16 from sfa.util.faults import *
17 from sfa.util.record import SfaRecord
18 from sfa.rspecs.rspec_converter import RSpecConverter
19 from sfa.rspecs.version_manager import VersionManager
20 from sfa.rspecs.rspec import RSpec 
21 from sfa.util.policy import Policy
22 from sfa.util.prefixTree import prefixTree
23 from sfa.util.sfaticket import *
24 from sfa.trust.credential import Credential
25 from sfa.util.threadmanager import ThreadManager
26 import sfa.util.xmlrpcprotocol as xmlrpcprotocol     
27 import sfa.plc.peers as peers
28 from sfa.util.version import version_core
29 from sfa.util.callids import Callids
30
31
32 def _call_id_supported(api, server):
33     """
34     Returns true if server support the optional call_id arg, false otherwise.
35     """
36     server_version = api.get_cached_server_version(server)
37
38     if 'sfa' in server_version:
39         code_tag = server_version['code_tag']
40         code_tag_parts = code_tag.split("-")
41
42         version_parts = code_tag_parts[0].split(".")
43         major, minor = version_parts[0:2]
44         rev = code_tag_parts[1]
45         if int(major) > 1:
46             if int(minor) > 0 or int(rev) > 20:
47                 return True
48     return False
49
50 # we have specialized xmlrpclib.ServerProxy to remember the input url
51 # OTOH it's not clear if we're only dealing with XMLRPCServerProxy instances
52 def get_serverproxy_url (server):
53     try:
54         return server.url
55     except:
56         logger.warning("GetVersion, falling back to xmlrpclib.ServerProxy internals")
57         return server._ServerProxy__host + server._ServerProxy__handler
58
59 def GetVersion(api):
60     # peers explicitly in aggregates.xml
61     peers =dict ([ (peername,get_serverproxy_url(v)) for (peername,v) in api.aggregates.iteritems()
62                    if peername != api.hrn])
63     version_manager = VersionManager()
64     ad_rspec_versions = []
65     request_rspec_versions = []
66     for rspec_version in version_manager.versions:
67         if rspec_version in ['*', 'ad']:
68             request_rspec_versions.append(rspec_version.to_dict())
69         if rspec_version in ['*', 'request']:
70             request_rspec_version.append(rspec_version.to_dict())
71     default_rspec_version = version_manager.get_version("sfa 1").to_dict()
72     xrn=Xrn(api.hrn)
73     version_more = {'interface':'slicemgr',
74                     'hrn' : xrn.get_hrn(),
75                     'urn' : xrn.get_urn(),
76                     'peers': peers,
77                     'request_rspec_versions': request_rspec_versions,
78                     'ad_rspec_versions': ad_rspec_versions,
79                     'default_ad_rspec': default_rspec_version
80                     }
81     sm_version=version_core(version_more)
82     # local aggregate if present needs to have localhost resolved
83     if api.hrn in api.aggregates:
84         local_am_url=get_serverproxy_url(api.aggregates[api.hrn])
85         sm_version['peers'][api.hrn]=local_am_url.replace('localhost',sm_version['hostname'])
86     return sm_version
87
88 def drop_slicemgr_stats(rspec):
89     try:
90         stats_elements = rspec.xml.xpath('//statistics')
91         for node in stats_elements:
92             node.getparent().remove(node)
93     except Exception, e:
94         api.logger.warn("drop_slicemgr_stats failed: %s " % (str(e)))
95
96 def add_slicemgr_stat(rspec, callname, aggname, elapsed, status):
97     try:
98         stats_tags = rspec.xml.xpath('//statistics[@call="%s"]' % callname)
99         if stats_tags:
100             stats_tag = stats_tags[0]
101         else:
102             stats_tag = etree.SubElement(rspec.xml.root, "statistics", call=callname)
103
104         etree.SubElement(stats_tag, "aggregate", name=str(aggname), elapsed=str(elapsed), status=str(status))
105     except Exception, e:
106         api.logger.warn("add_slicemgr_stat failed on  %s: %s" %(aggname, str(e)))
107
108 def ListResources(api, creds, options, call_id):
109     version_manager = VersionManager()
110     def _ListResources(aggregate, server, credential, opts, call_id):
111
112         my_opts = copy(opts)
113         args = [credential, my_opts]
114         tStart = time.time()
115         try:
116             if _call_id_supported(api, server):
117                 args.append(call_id)
118             version = api.get_cached_server_version(server)
119             # force ProtoGENI aggregates to give us a v2 RSpec
120             if 'sfa' not in version.keys():
121                 my_opts['rspec_version'] = version_manager.get_version('ProtoGENI 2').to_dict()
122             rspec = server.ListResources(*args)
123             return {"aggregate": aggregate, "rspec": rspec, "elapsed": time.time()-tStart, "status": "success"}
124         except Exception, e:
125             api.logger.warn("ListResources failed at %s: %s" %(server.url, str(e)))
126             return {"aggregate": aggregate, "elapsed": time.time()-tStart, "status": "exception"}
127
128     if Callids().already_handled(call_id): return ""
129
130     # get slice's hrn from options
131     xrn = options.get('geni_slice_urn', '')
132     (hrn, type) = urn_to_hrn(xrn)
133     if 'geni_compressed' in options:
134         del(options['geni_compressed'])
135
136     # get the rspec's return format from options
137     rspec_version = version_manager.get_version(options.get('rspec_version'))
138     version_string = "rspec_%s" % (rspec_version.to_string())
139
140     # look in cache first
141     if caching and api.cache and not xrn:
142         rspec =  api.cache.get(version_string)
143         if rspec:
144             return rspec
145
146     # get the callers hrn
147     valid_cred = api.auth.checkCredentials(creds, 'listnodes', hrn)[0]
148     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
149
150     # attempt to use delegated credential first
151     credential = api.getDelegatedCredential(creds)
152     if not credential:
153         credential = api.getCredential()
154     credentials = [credential]
155     threads = ThreadManager()
156     for aggregate in api.aggregates:
157         # prevent infinite loop. Dont send request back to caller
158         # unless the caller is the aggregate's SM
159         if caller_hrn == aggregate and aggregate != api.hrn:
160             continue
161
162         # get the rspec from the aggregate
163         server = api.aggregates[aggregate]
164         threads.run(_ListResources, aggregate, server, credentials, options, call_id)
165
166     results = threads.get_results()
167     rspec_version = version_manager.get_version(options.get('rspec_version'))
168     if xrn:    
169         result_version = version_manager._get_version(rspec_version.type, rspec_version.version, 'manifest')
170     else: 
171         result_version = version_manager._get_version(rspec_version.type, rspec_version.version, 'ad')
172     rspec = RSpec(version=result_version)
173     for result in results:
174         add_slicemgr_stat(rspec, "ListResources", result["aggregate"], result["elapsed"], result["status"])
175         if result["status"]=="success":
176             try:
177                 rspec.version.merge(result["rspec"])
178             except:
179                 api.logger.log_exc("SM.ListResources: Failed to merge aggregate rspec")
180
181     # cache the result
182     if caching and api.cache and not xrn:
183         api.cache.add(version_string, rspec.toxml())
184
185     return rspec.toxml()
186
187
188 def CreateSliver(api, xrn, creds, rspec_str, users, call_id):
189
190     version_manager = VersionManager()
191     def _CreateSliver(aggregate, server, xrn, credential, rspec, users, call_id):
192         tStart = time.time()
193         try:
194             # Need to call GetVersion at an aggregate to determine the supported
195             # rspec type/format beofre calling CreateSliver at an Aggregate.
196             server_version = api.get_cached_server_version(server)
197             if 'sfa' not in server_version and 'geni_api' in server_version:
198                 # sfa aggregtes support both sfa and pg rspecs, no need to convert
199                 # if aggregate supports sfa rspecs. otherwise convert to pg rspec
200                 rspec = RSpecConverter.to_pg_rspec(rspec, 'request')
201                 raise
202             args = [xrn, credential, rspec, users]
203             if _call_id_supported(api, server):
204                 args.append(call_id)
205             rspec = server.CreateSliver(*args)
206             return {"aggregate": aggregate, "rspec": rspec, "elapsed": time.time()-tStart, "status": "success"}
207         except: 
208             logger.log_exc('Something wrong in _CreateSliver with URL %s'%server.url)
209             return {"aggregate": aggregate, "elapsed": time.time()-tStart, "status": "exception"}
210
211     if Callids().already_handled(call_id): return ""
212     # Validate the RSpec against PlanetLab's schema --disabled for now
213     # The schema used here needs to aggregate the PL and VINI schemas
214     # schema = "/var/www/html/schemas/pl.rng"
215     rspec = RSpec(rspec_str)
216     schema = None
217     if schema:
218         rspec.validate(schema)
219
220     # if there is a <statistics> section, the aggregates don't care about it,
221     # so delete it.
222     drop_slicemgr_stats(rspec)
223
224     # attempt to use delegated credential first
225     credential = api.getDelegatedCredential(creds)
226     if not credential:
227         credential = api.getCredential()
228
229     # get the callers hrn
230     hrn, type = urn_to_hrn(xrn)
231     valid_cred = api.auth.checkCredentials(creds, 'createsliver', hrn)[0]
232     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
233     threads = ThreadManager()
234     for aggregate in api.aggregates:
235         # prevent infinite loop. Dont send request back to caller
236         # unless the caller is the aggregate's SM 
237         if caller_hrn == aggregate and aggregate != api.hrn:
238             continue
239         server = api.aggregates[aggregate]
240         # Just send entire RSpec to each aggregate
241         threads.run(_CreateSliver, aggregate, server, xrn, credential, rspec.toxml(), users, call_id)
242             
243     results = threads.get_results()
244     manifest_version = version_manager._get_version(rspec.version.type, rspec.version.version, 'manifest')
245     result_rspec = RSpec(version=manifest_version)
246     for result in results:
247         add_slicemgr_stat(result_rspec, "CreateSliver", result["aggregate"], result["elapsed"], result["status"])
248         if result["status"]=="success":
249             try:
250                 result_rspec.version.merge(result["rspec"])
251             except:
252                 api.logger.log_exc("SM.CreateSliver: Failed to merge aggregate rspec")
253     return result_rspec.toxml()
254
255 def RenewSliver(api, xrn, creds, expiration_time, call_id):
256     def _RenewSliver(server, xrn, creds, expiration_time, call_id):
257         server_version = api.get_cached_server_version(server)
258         args =  [xrn, creds, expiration_time, call_id]
259         if _call_id_supported(api, server):
260             args.append(call_id)
261         return server.RenewSliver(*args)
262
263     if Callids().already_handled(call_id): return True
264
265     (hrn, type) = urn_to_hrn(xrn)
266     # get the callers hrn
267     valid_cred = api.auth.checkCredentials(creds, 'renewsliver', hrn)[0]
268     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
269
270     # attempt to use delegated credential first
271     credential = api.getDelegatedCredential(creds)
272     if not credential:
273         credential = api.getCredential()
274     threads = ThreadManager()
275     for aggregate in api.aggregates:
276         # prevent infinite loop. Dont send request back to caller
277         # unless the caller is the aggregate's SM
278         if caller_hrn == aggregate and aggregate != api.hrn:
279             continue
280         server = api.aggregates[aggregate]
281         threads.run(_RenewSliver, server, xrn, [credential], expiration_time, call_id)
282     # 'and' the results
283     return reduce (lambda x,y: x and y, threads.get_results() , True)
284
285 def DeleteSliver(api, xrn, creds, call_id):
286     def _DeleteSliver(server, xrn, creds, call_id):
287         server_version = api.get_cached_server_version(server)
288         args =  [xrn, creds]
289         if _call_id_supported(api, server):
290             args.append(call_id)
291         return server.DeleteSliver(*args)
292
293     if Callids().already_handled(call_id): return ""
294     (hrn, type) = urn_to_hrn(xrn)
295     # get the callers hrn
296     valid_cred = api.auth.checkCredentials(creds, 'deletesliver', hrn)[0]
297     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
298
299     # attempt to use delegated credential first
300     credential = api.getDelegatedCredential(creds)
301     if not credential:
302         credential = api.getCredential()
303     threads = ThreadManager()
304     for aggregate in api.aggregates:
305         # prevent infinite loop. Dont send request back to caller
306         # unless the caller is the aggregate's SM
307         if caller_hrn == aggregate and aggregate != api.hrn:
308             continue
309         server = api.aggregates[aggregate]
310         threads.run(_DeleteSliver, server, xrn, credential, call_id)
311     threads.get_results()
312     return 1
313
314
315 # first draft at a merging SliverStatus
316 def SliverStatus(api, slice_xrn, creds, call_id):
317     def _SliverStatus(server, xrn, creds, call_id):
318         server_version = api.get_cached_server_version(server)
319         args =  [xrn, creds]
320         if _call_id_supported(api, server):
321             args.append(call_id)
322         return server.SliverStatus(*args)
323     
324     if Callids().already_handled(call_id): return {}
325     # attempt to use delegated credential first
326     credential = api.getDelegatedCredential(creds)
327     if not credential:
328         credential = api.getCredential()
329     threads = ThreadManager()
330     for aggregate in api.aggregates:
331         server = api.aggregates[aggregate]
332         threads.run (_SliverStatus, server, slice_xrn, credential, call_id)
333     results = threads.get_results()
334
335     # get rid of any void result - e.g. when call_id was hit where by convention we return {}
336     results = [ result for result in results if result and result['geni_resources']]
337
338     # do not try to combine if there's no result
339     if not results : return {}
340
341     # otherwise let's merge stuff
342     overall = {}
343
344     # mmh, it is expected that all results carry the same urn
345     overall['geni_urn'] = results[0]['geni_urn']
346     overall['pl_login'] = results[0]['pl_login']
347     # append all geni_resources
348     overall['geni_resources'] = \
349         reduce (lambda x,y: x+y, [ result['geni_resources'] for result in results] , [])
350     overall['status'] = 'unknown'
351     if overall['geni_resources']:
352         overall['status'] = 'ready'
353
354     return overall
355
356 caching=True
357 #caching=False
358 def ListSlices(api, creds, call_id):
359     def _ListSlices(server, creds, call_id):
360         server_version = api.get_cached_server_version(server)
361         args =  [creds]
362         if _call_id_supported(api, server):
363             args.append(call_id)
364         return server.ListSlices(*args)
365
366     if Callids().already_handled(call_id): return []
367
368     # look in cache first
369     if caching and api.cache:
370         slices = api.cache.get('slices')
371         if slices:
372             return slices
373
374     # get the callers hrn
375     valid_cred = api.auth.checkCredentials(creds, 'listslices', None)[0]
376     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
377
378     # attempt to use delegated credential first
379     credential = api.getDelegatedCredential(creds)
380     if not credential:
381         credential = api.getCredential()
382     threads = ThreadManager()
383     # fetch from aggregates
384     for aggregate in api.aggregates:
385         # prevent infinite loop. Dont send request back to caller
386         # unless the caller is the aggregate's SM
387         if caller_hrn == aggregate and aggregate != api.hrn:
388             continue
389         server = api.aggregates[aggregate]
390         threads.run(_ListSlices, server, credential, call_id)
391
392     # combime results
393     results = threads.get_results()
394     slices = []
395     for result in results:
396         slices.extend(result)
397
398     # cache the result
399     if caching and api.cache:
400         api.cache.add('slices', slices)
401
402     return slices
403
404
405 def get_ticket(api, xrn, creds, rspec, users):
406     slice_hrn, type = urn_to_hrn(xrn)
407     # get the netspecs contained within the clients rspec
408     aggregate_rspecs = {}
409     tree= etree.parse(StringIO(rspec))
410     elements = tree.findall('./network')
411     for element in elements:
412         aggregate_hrn = element.values()[0]
413         aggregate_rspecs[aggregate_hrn] = rspec 
414
415     # get the callers hrn
416     valid_cred = api.auth.checkCredentials(creds, 'getticket', slice_hrn)[0]
417     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
418
419     # attempt to use delegated credential first
420     credential = api.getDelegatedCredential(creds)
421     if not credential:
422         credential = api.getCredential() 
423     threads = ThreadManager()
424     for (aggregate, aggregate_rspec) in aggregate_rspecs.iteritems():
425         # prevent infinite loop. Dont send request back to caller
426         # unless the caller is the aggregate's SM
427         if caller_hrn == aggregate and aggregate != api.hrn:
428             continue
429         server = None
430         if aggregate in api.aggregates:
431             server = api.aggregates[aggregate]
432         else:
433             net_urn = hrn_to_urn(aggregate, 'authority')     
434             # we may have a peer that knows about this aggregate
435             for agg in api.aggregates:
436                 target_aggs = api.aggregates[agg].get_aggregates(credential, net_urn)
437                 if not target_aggs or not 'hrn' in target_aggs[0]:
438                     continue
439                 # send the request to this address 
440                 url = target_aggs[0]['url']
441                 server = xmlrpcprotocol.get_server(url, api.key_file, api.cert_file, timeout=30)
442                 # aggregate found, no need to keep looping
443                 break   
444         if server is None:
445             continue 
446         threads.run(server.GetTicket, xrn, credential, aggregate_rspec, users)
447
448     results = threads.get_results()
449     
450     # gather information from each ticket 
451     rspecs = []
452     initscripts = []
453     slivers = [] 
454     object_gid = None  
455     for result in results:
456         agg_ticket = SfaTicket(string=result)
457         attrs = agg_ticket.get_attributes()
458         if not object_gid:
459             object_gid = agg_ticket.get_gid_object()
460         rspecs.append(agg_ticket.get_rspec())
461         initscripts.extend(attrs.get('initscripts', [])) 
462         slivers.extend(attrs.get('slivers', [])) 
463     
464     # merge info
465     attributes = {'initscripts': initscripts,
466                  'slivers': slivers}
467     merged_rspec = merge_rspecs(rspecs) 
468
469     # create a new ticket
470     ticket = SfaTicket(subject = slice_hrn)
471     ticket.set_gid_caller(api.auth.client_gid)
472     ticket.set_issuer(key=api.key, subject=api.hrn)
473     ticket.set_gid_object(object_gid)
474     ticket.set_pubkey(object_gid.get_pubkey())
475     #new_ticket.set_parent(api.auth.hierarchy.get_auth_ticket(auth_hrn))
476     ticket.set_attributes(attributes)
477     ticket.set_rspec(merged_rspec)
478     ticket.encode()
479     ticket.sign()          
480     return ticket.save_to_string(save_parents=True)
481
482 def start_slice(api, xrn, creds):
483     hrn, type = urn_to_hrn(xrn)
484
485     # get the callers hrn
486     valid_cred = api.auth.checkCredentials(creds, 'startslice', hrn)[0]
487     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
488
489     # attempt to use delegated credential first
490     credential = api.getDelegatedCredential(creds)
491     if not credential:
492         credential = api.getCredential()
493     threads = ThreadManager()
494     for aggregate in api.aggregates:
495         # prevent infinite loop. Dont send request back to caller
496         # unless the caller is the aggregate's SM
497         if caller_hrn == aggregate and aggregate != api.hrn:
498             continue
499         server = api.aggregates[aggregate]
500         threads.run(server.Start, xrn, credential)
501     threads.get_results()    
502     return 1
503  
504 def stop_slice(api, xrn, creds):
505     hrn, type = urn_to_hrn(xrn)
506
507     # get the callers hrn
508     valid_cred = api.auth.checkCredentials(creds, 'stopslice', hrn)[0]
509     caller_hrn = Credential(string=valid_cred).get_gid_caller().get_hrn()
510
511     # attempt to use delegated credential first
512     credential = api.getDelegatedCredential(creds)
513     if not credential:
514         credential = api.getCredential()
515     threads = ThreadManager()
516     for aggregate in api.aggregates:
517         # prevent infinite loop. Dont send request back to caller
518         # unless the caller is the aggregate's SM
519         if caller_hrn == aggregate and aggregate != api.hrn:
520             continue
521         server = api.aggregates[aggregate]
522         threads.run(server.Stop, xrn, credential)
523     threads.get_results()    
524     return 1
525
526 def reset_slice(api, xrn):
527     """
528     Not implemented
529     """
530     return 1
531
532 def shutdown(api, xrn, creds):
533     """
534     Not implemented   
535     """
536     return 1
537
538 def status(api, xrn, creds):
539     """
540     Not implemented 
541     """
542     return 1
543
544 def main():
545     r = RSpec()
546     r.parseFile(sys.argv[1])
547     rspec = r.toDict()
548     CreateSliver(None,'plc.princeton.tmacktestslice',rspec,'create-slice-tmacktestslice')
549
550 if __name__ == "__main__":
551     main()
552