Fixed sfi.py delete <slice name>
[sfa.git] / sfa / senslab / slabdriver.py
1 import subprocess
2
3 from datetime import datetime
4 from time import gmtime
5
6 from sfa.util.faults import SliverDoesNotExist, UnknownSfaType
7 from sfa.util.sfalogging import logger
8
9 from sfa.storage.alchemy import dbsession
10 from sfa.storage.model import RegRecord, RegUser
11
12 from sfa.trust.credential import Credential
13
14
15 from sfa.managers.driver import Driver
16 from sfa.rspecs.version_manager import VersionManager
17 from sfa.rspecs.rspec import RSpec
18
19 from sfa.util.xrn import hrn_to_urn, urn_to_sliver_id, get_leaf
20
21
22 ## thierry: everything that is API-related (i.e. handling incoming requests) 
23 # is taken care of 
24 # SlabDriver should be really only about talking to the senslab testbed
25
26
27 from sfa.senslab.OARrestapi import  OARrestapi
28 from sfa.senslab.LDAPapi import LDAPapi
29
30 from sfa.senslab.slabpostgres import SlabDB, slab_dbsession, SliceSenslab, \
31                                                                 JobSenslab
32 from sfa.senslab.slabaggregate import SlabAggregate, slab_xrn_to_hostname, \
33                                                             slab_xrn_object
34 from sfa.senslab.slabslices import SlabSlices
35
36
37
38
39
40 # thierry : note
41 # this inheritance scheme is so that the driver object can receive
42 # GetNodes or GetSites sorts of calls directly
43 # and thus minimize the differences in the managers with the pl version
44 class SlabDriver(Driver):
45
46     def __init__(self, config):
47         Driver.__init__ (self, config)
48         self.config = config
49         self.hrn = config.SFA_INTERFACE_HRN
50
51         self.root_auth = config.SFA_REGISTRY_ROOT_AUTH
52
53         self.oar = OARrestapi()
54         self.ldap = LDAPapi()
55         self.time_format = "%Y-%m-%d %H:%M:%S"
56         self.db = SlabDB(config,debug = True)
57         self.cache = None
58         
59     
60     def sliver_status(self, slice_urn, slice_hrn):
61         """Receive a status request for slice named urn/hrn 
62         urn:publicid:IDN+senslab+nturro_slice hrn senslab.nturro_slice
63         shall return a structure as described in
64         http://groups.geni.net/geni/wiki/GAPI_AM_API_V2#SliverStatus
65         NT : not sure if we should implement this or not, but used by sface.
66         
67         """
68         
69         #First get the slice with the slice hrn
70         sl = self.GetSlices(slice_filter = slice_hrn, \
71                                     slice_filter_type = 'slice_hrn')
72         
73         if len(sl) is 0:
74             raise SliverDoesNotExist("%s  slice_hrn" % (slice_hrn))
75         
76         if isinstance(sl,list):
77             sl = sl[0]
78             
79         
80         top_level_status = 'unknown'
81         nodes_in_slice = sl['node_ids']
82         recuser = dbsession.query(RegRecord).filter_by(record_id = \
83                                             sl['record_id_user']).first()
84         sl.update({'user':recuser.hrn})
85         if len(nodes_in_slice) is 0:
86             raise SliverDoesNotExist("No slivers allocated ") 
87         else:
88             top_level_status = 'ready' 
89         
90         logger.debug("Slabdriver - sliver_status Sliver status urn %s hrn %s sl\
91                              %s \r\n " %(slice_urn, slice_hrn, sl))
92                              
93         if sl['oar_job_id'] is not []:
94             #A job is running on Senslab for this slice
95             # report about the local nodes that are in the slice only
96             
97             nodes_all = self.GetNodes({'hostname':nodes_in_slice},
98                             ['node_id', 'hostname','site','boot_state'])
99             nodeall_byhostname = dict([(n['hostname'], n) for n in nodes_all])
100             
101
102             result = {}
103             result['geni_urn'] = slice_urn
104             result['pl_login'] = sl['user'] #For compatibility
105
106             
107             #timestamp = float(sl['startTime']) + float(sl['walltime']) 
108             #result['pl_expires'] = strftime(self.time_format, \
109                                                     #gmtime(float(timestamp)))
110             #result['slab_expires'] = strftime(self.time_format,\
111                                                      #gmtime(float(timestamp)))
112             
113             resources = []
114             for node in nodeall_byhostname:
115                 res = {}
116                 #res['slab_hostname'] = node['hostname']
117                 #res['slab_boot_state'] = node['boot_state']
118                 
119                 res['pl_hostname'] = nodeall_byhostname[node]['hostname']
120                 res['pl_boot_state'] = nodeall_byhostname[node]['boot_state']
121                 #res['pl_last_contact'] = strftime(self.time_format, \
122                                                     #gmtime(float(timestamp)))
123                 sliver_id = urn_to_sliver_id(slice_urn, sl['record_id_slice'], \
124                                             nodeall_byhostname[node]['node_id']) 
125                 res['geni_urn'] = sliver_id 
126                 if nodeall_byhostname[node]['boot_state'] == 'Alive':
127
128                     res['geni_status'] = 'ready'
129                 else:
130                     res['geni_status'] = 'failed'
131                     top_level_status = 'failed' 
132                     
133                 res['geni_error'] = ''
134         
135                 resources.append(res)
136                 
137             result['geni_status'] = top_level_status
138             result['geni_resources'] = resources 
139             logger.debug("SLABDRIVER \tsliver_statusresources %s res %s "\
140                                                      %(resources,res))
141             return result        
142         
143         
144     def synchronize_oar_and_slice_table(self, slice_hrn = None): 
145         #Get list of leases
146         oar_leases_list = self.GetReservedNodes()
147        
148         logger.debug("SLABDRIVER \tsynchronize_oar_and_slice_table  :\
149                                  oar_leases_list %s\r\n" %( oar_leases_list))
150         #Get list of slices/leases . multiple entry per user depending 
151         #on number of jobs
152         #At this point we don't have the slice_hrn so that's why
153         #we are calling Getslices, which holds a field with slice_hrn
154         
155         if slice_hrn :
156             sfa_slices_list = self.GetSlices(slice_filter = slice_hrn, \
157                                             slice_filter_type = 'slice_hrn')
158             self.synchronize_oar_and_slice_table_for_slice_hrn(slice_hrn, \
159                                         oar_leases_list, sfa_slices_list)
160         else :
161             sfa_slices_list = self.GetSlices()
162                      
163             sfa_slices_dict_by_slice_hrn = {}
164             for sfa_slice in sfa_slices_list:
165                 if sfa_slice['slice_hrn'] not in sfa_slices_dict_by_slice_hrn:
166                     sfa_slices_dict_by_slice_hrn[sfa_slice['slice_hrn']] = []
167                     
168                 sfa_slices_dict_by_slice_hrn[sfa_slice['slice_hrn']].\
169                                                             append(sfa_slice)
170
171             
172             for slice_hrn in sfa_slices_dict_by_slice_hrn:
173                 list_slices_sfa = sfa_slices_dict_by_slice_hrn[slice_hrn] 
174                 self.synchronize_oar_and_slice_table_for_slice_hrn(slice_hrn, \
175                                             oar_leases_list, list_slices_sfa)
176             
177         return 
178             
179          
180     def synchronize_oar_and_slice_table_for_slice_hrn(self,slice_hrn, \
181                                             oar_leases_list, sfa_slices_list):
182         
183         #Get list of slices/leases . 
184         #multiple entry per user depending on number of jobs
185
186         sfa_slices_dict = {}
187         oar_leases_dict = {}
188         login = slice_hrn.split(".")[1].split("_")[0]
189         
190         #Create dictionnaries based on the tuple user login/ job id
191         #for the leases list and the slices list
192
193         for sl in sfa_slices_list:
194             if sl['oar_job_id'] != [] :
195                 #one entry in the dictionnary for each jobid/login, one login
196                 #can have multiple jobs running
197                 for oar_jobid in sl['oar_job_id']:
198                     if (login, oar_jobid) not in sfa_slices_dict:
199                         sfa_slices_dict[(login,oar_jobid)] = sl
200         
201         for lease in oar_leases_list:
202             if (lease['user'], lease['lease_id']) not in oar_leases_dict:
203                 oar_leases_dict[(lease['user'], lease['lease_id'])] = lease
204         
205         #Find missing entries in the sfa slices list dict by comparing
206         #the keys in both dictionnaries
207         #Add the missing entries in the slice sneslab table
208
209         for lease in oar_leases_dict :
210             
211             if lease not in sfa_slices_dict and login == lease[0]:   
212                 #if lease in GetReservedNodes not in GetSlices 
213                 #and the login of the job running matches then update the db
214                 #for this login
215                 #First get the list of nodes hostnames for this job
216                 oar_reserved_nodes_listdict = \
217                                 oar_leases_dict[lease]['reserved_nodes']
218                 oar_reserved_nodes_list = []
219                 for node_dict in oar_reserved_nodes_listdict:
220                     oar_reserved_nodes_list.append(node_dict['hostname'])
221                 #And update the db with slice hrn, job id and node list 
222                 self.db.add_job(slice_hrn, lease[1], oar_reserved_nodes_list)
223                 
224         for lease in  sfa_slices_dict:
225             #Job is now terminated or in Error, 
226             #either way ot is not going to run again
227             #Remove it from the db
228             if lease not in  oar_leases_dict:
229                 self.db.delete_job( slice_hrn, lease[1])        
230         return     
231              
232     def create_sliver (self, slice_urn, slice_hrn, creds, rspec_string, \
233                                                              users, options):
234         aggregate = SlabAggregate(self)
235         
236         slices = SlabSlices(self)
237         peer = slices.get_peer(slice_hrn)
238         sfa_peer = slices.get_sfa_peer(slice_hrn)
239         slice_record = None 
240  
241         if not isinstance(creds, list):
242             creds = [creds]
243     
244         if users:
245             slice_record = users[0].get('slice_record', {})
246     
247         # parse rspec
248         rspec = RSpec(rspec_string)
249         logger.debug("SLABDRIVER.PY \tcreate_sliver \trspec.version %s " \
250                                                             %(rspec.version))
251         
252         self.synchronize_oar_and_slice_table(slice_hrn)
253         # ensure site record exists?
254         # ensure slice record exists
255         #Removed options to verify_slice SA 14/08/12
256         sfa_slice = slices.verify_slice(slice_hrn, slice_record, peer, \
257                                                     sfa_peer)
258                                                     
259         #requested_attributes returned by rspec.version.get_slice_attributes() 
260         #unused, removed SA 13/08/12
261         rspec.version.get_slice_attributes()
262
263         logger.debug("SLABDRIVER.PY create_sliver slice %s " %(sfa_slice))
264         
265         # ensure person records exists
266         #verify_persons returns added persons but since the return value
267         #is not used 
268         slices.verify_persons(slice_hrn, sfa_slice, users, peer, \
269                                                     sfa_peer, options=options)
270         
271
272         
273         # add/remove slice from nodes 
274        
275         requested_slivers = [node.get('component_name') \
276                             for node in rspec.version.get_nodes_with_slivers()]
277         l = [ node for node in rspec.version.get_nodes_with_slivers() ]
278         logger.debug("SLADRIVER \tcreate_sliver requested_slivers \
279                                     requested_slivers %s  listnodes %s" \
280                                     %(requested_slivers,l))
281         #verify_slice_nodes returns nodes, but unused here. Removed SA 13/08/12.
282         slices.verify_slice_nodes(sfa_slice, requested_slivers, peer) 
283         
284         # add/remove leases
285         requested_lease_list = []
286         kept_leases = []
287         for lease in rspec.version.get_leases():
288             single_requested_lease = {}
289             logger.debug("SLABDRIVER.PY \tcreate_sliver lease %s " %(lease))
290             if not lease.get('lease_id'):
291                 single_requested_lease['hostname'] = \
292                             slab_xrn_to_hostname(lease.get('component_id').strip())
293                 single_requested_lease['start_time'] = lease.get('start_time')
294                 single_requested_lease['duration'] = lease.get('duration')
295             else:
296                 kept_leases.append(int(lease['lease_id']))
297             if single_requested_lease.get('hostname'):
298                 requested_lease_list.append(single_requested_lease)
299                 
300         #dCreate dict of leases by start_time, regrouping nodes reserved
301         #at the same
302         #time, for the same amount of time = one job on OAR
303         requested_job_dict = {}
304         for lease in requested_lease_list:
305             
306             #In case it is an asap experiment start_time is empty
307             if lease['start_time'] == '':
308                 lease['start_time'] = '0' 
309                 
310             if lease['start_time'] not in requested_job_dict:
311                 if isinstance(lease['hostname'], str):
312                     lease['hostname'] =  [lease['hostname']]
313                     
314                 requested_job_dict[lease['start_time']] = lease
315                 
316             else :
317                 job_lease = requested_job_dict[lease['start_time']]
318                 if lease['duration'] == job_lease['duration'] :
319                     job_lease['hostname'].append(lease['hostname'])
320                     
321           
322                 
323                         
324         logger.debug("SLABDRIVER.PY \tcreate_sliver  requested_job_dict %s " %(requested_job_dict))    
325         #verify_slice_leases returns the leases , but the return value is unused
326         #here. Removed SA 13/08/12           
327         slices.verify_slice_leases(sfa_slice, \
328                                     requested_job_dict, kept_leases, peer)
329         
330         return aggregate.get_rspec(slice_xrn=slice_urn, version=rspec.version)
331         
332         
333     def delete_sliver (self, slice_urn, slice_hrn, creds, options):
334         
335         sfa_slice_list  = self.GetSlices(slice_filter = slice_hrn, \
336                                             slice_filter_type = 'slice_hrn')
337         
338         if not sfa_slice_list:
339             return 1
340         
341         sfa_slice = sfa_slice_list[0]
342         
343         logger.debug("SLABDRIVER.PY delete_sliver slice %s" %(sfa_slice))
344         slices = SlabSlices(self)
345         # determine if this is a peer slice
346       
347         peer = slices.get_peer(slice_hrn) 
348         #TODO delete_sliver SA : UnBindObjectFromPeer should be 
349         #used when there is another 
350         #senslab testbed, which is not the case 14/08/12 . 
351         
352         logger.debug("SLABDRIVER.PY delete_sliver peer %s" %(peer))
353         try:
354             if peer:
355                 self.UnBindObjectFromPeer('slice', \
356                                         sfa_slice['record_id_slice'], peer,None)
357             self.DeleteSliceFromNodes(sfa_slice)
358         finally:
359             if peer:
360                 self.BindObjectToPeer('slice', sfa_slice['record_id_slice'], \
361                                             peer, sfa_slice['peer_slice_id'])
362         return 1
363             
364             
365     def AddSlice(self, slice_record):
366         slab_slice = SliceSenslab( slice_hrn = slice_record['slice_hrn'], \
367                         record_id_slice= slice_record['record_id_slice'] , \
368                         record_id_user= slice_record['record_id_user'], \
369                         peer_authority = slice_record['peer_authority'])
370         logger.debug("SLABDRIVER.PY \tAddSlice slice_record %s slab_slice %s" \
371                                             %(slice_record,slab_slice))
372         slab_dbsession.add(slab_slice)
373         slab_dbsession.commit()
374         return
375         
376     # first 2 args are None in case of resource discovery
377     def list_resources (self, slice_urn, slice_hrn, creds, options):
378         #cached_requested = options.get('cached', True) 
379     
380         version_manager = VersionManager()
381         # get the rspec's return format from options
382         rspec_version = \
383                 version_manager.get_version(options.get('geni_rspec_version'))
384         version_string = "rspec_%s" % (rspec_version)
385     
386         #panos adding the info option to the caching key (can be improved)
387         if options.get('info'):
388             version_string = version_string + "_" + \
389                                         options.get('info', 'default')
390     
391         # look in cache first
392         #if cached_requested and self.cache and not slice_hrn:
393             #rspec = self.cache.get(version_string)
394             #if rspec:
395                 #logger.debug("SlabDriver.ListResources: \
396                                     #returning cached advertisement")
397                 #return rspec 
398     
399         #panos: passing user-defined options
400         aggregate = SlabAggregate(self)
401         origin_hrn = Credential(string=creds[0]).get_gid_caller().get_hrn()
402         options.update({'origin_hrn':origin_hrn})
403         rspec =  aggregate.get_rspec(slice_xrn=slice_urn, \
404                                         version=rspec_version, options=options)
405        
406         # cache the result
407         #if self.cache and not slice_hrn:
408             #logger.debug("Slab.ListResources: stores advertisement in cache")
409             #self.cache.add(version_string, rspec)
410     
411         return rspec
412         
413         
414     def list_slices (self, creds, options):
415         # look in cache first
416         #if self.cache:
417             #slices = self.cache.get('slices')
418             #if slices:
419                 #logger.debug("PlDriver.list_slices returns from cache")
420                 #return slices
421     
422         # get data from db 
423
424         slices = self.GetSlices()        
425         logger.debug("SLABDRIVER.PY \tlist_slices hrn %s \r\n \r\n" %(slices))        
426         slice_hrns = [slab_slice['slice_hrn'] for slab_slice in slices]
427         #slice_hrns = [slicename_to_hrn(self.hrn, slab_slice['slice_hrn']) \
428                                                     #for slab_slice in slices]
429         slice_urns = [hrn_to_urn(slice_hrn, 'slice') \
430                                                 for slice_hrn in slice_hrns]
431
432         # cache the result
433         #if self.cache:
434             #logger.debug ("SlabDriver.list_slices stores value in cache")
435             #self.cache.add('slices', slice_urns) 
436     
437         return slice_urns
438     
439     #No site or node register supported
440     def register (self, sfa_record, hrn, pub_key):
441         record_type = sfa_record['type']
442         slab_record = self.sfa_fields_to_slab_fields(record_type, hrn, \
443                                                             sfa_record)
444     
445
446         if record_type == 'slice':
447             acceptable_fields = ['url', 'instantiation', 'name', 'description']
448             for key in slab_record.keys():
449                 if key not in acceptable_fields:
450                     slab_record.pop(key) 
451             logger.debug("SLABDRIVER.PY register")
452             slices = self.GetSlices(slice_filter =slab_record['hrn'], \
453                                             slice_filter_type = 'slice_hrn')
454             if not slices:
455                 pointer = self.AddSlice(slab_record)
456             else:
457                 pointer = slices[0]['slice_id']
458     
459         elif record_type == 'user':  
460             persons = self.GetPersons([sfa_record])
461             #persons = self.GetPersons([sfa_record['hrn']])
462             if not persons:
463                 pointer = self.AddPerson(dict(sfa_record))
464                 #add in LDAP 
465             else:
466                 pointer = persons[0]['person_id']
467                 
468             #Does this make sense to senslab ?
469             #if 'enabled' in sfa_record and sfa_record['enabled']:
470                 #self.UpdatePerson(pointer, \
471                                     #{'enabled': sfa_record['enabled']})
472                 
473             #TODO register Change this AddPersonToSite stuff 05/07/2012 SA   
474             # add this person to the site only if 
475             # she is being added for the first
476             # time by sfa and doesnt already exist in plc
477             if not persons or not persons[0]['site_ids']:
478                 login_base = get_leaf(sfa_record['authority'])
479                 self.AddPersonToSite(pointer, login_base)
480     
481             # What roles should this user have?
482             #TODO : DElete this AddRoleToPerson 04/07/2012 SA
483             #Function prototype is :
484             #AddRoleToPerson(self, auth, role_id_or_name, person_id_or_email)
485             #what's the pointer doing here?
486             self.AddRoleToPerson('user', pointer)
487             # Add the user's key
488             if pub_key:
489                 self.AddPersonKey(pointer, {'key_type' : 'ssh', \
490                                                 'key' : pub_key})
491                 
492         #No node adding outside OAR
493
494         return pointer
495             
496     #No site or node record update allowed       
497     def update (self, old_sfa_record, new_sfa_record, hrn, new_key):
498         pointer = old_sfa_record['pointer']
499         old_sfa_record_type = old_sfa_record['type']
500
501         # new_key implemented for users only
502         if new_key and old_sfa_record_type not in [ 'user' ]:
503             raise UnknownSfaType(old_sfa_record_type)
504         
505         #if (type == "authority"):
506             #self.shell.UpdateSite(pointer, new_sfa_record)
507     
508         if old_sfa_record_type == "slice":
509             slab_record = self.sfa_fields_to_slab_fields(old_sfa_record_type, \
510                                                 hrn, new_sfa_record)
511             if 'name' in slab_record:
512                 slab_record.pop('name')
513                 #Prototype should be UpdateSlice(self,
514                 #auth, slice_id_or_name, slice_fields)
515                 #Senslab cannot update slice since slice = job
516                 #so we must delete and create another job
517                 self.UpdateSlice(pointer, slab_record)
518     
519         elif old_sfa_record_type == "user":
520             update_fields = {}
521             all_fields = new_sfa_record
522             for key in all_fields.keys():
523                 if key in ['first_name', 'last_name', 'title', 'email',
524                            'password', 'phone', 'url', 'bio', 'accepted_aup',
525                            'enabled']:
526                     update_fields[key] = all_fields[key]
527             self.UpdatePerson(pointer, update_fields)
528     
529             if new_key:
530                 # must check this key against the previous one if it exists
531                 persons = self.GetPersons([pointer], ['key_ids'])
532                 person = persons[0]
533                 keys = person['key_ids']
534                 keys = self.GetKeys(person['key_ids'])
535                 
536                 # Delete all stale keys
537                 key_exists = False
538                 for key in keys:
539                     if new_key != key['key']:
540                         self.DeleteKey(key['key_id'])
541                     else:
542                         key_exists = True
543                 if not key_exists:
544                     self.AddPersonKey(pointer, {'key_type': 'ssh', \
545                                                     'key': new_key})
546
547
548         return True
549         
550
551     def remove (self, sfa_record):
552         sfa_record_type = sfa_record['type']
553         hrn = sfa_record['hrn']
554         if sfa_record_type == 'user':
555
556             #get user from senslab ldap  
557             person = self.GetPersons(sfa_record)
558             #No registering at a given site in Senslab.
559             #Once registered to the LDAP, all senslab sites are
560             #accesible.
561             if person :
562                 #Mark account as disabled in ldap
563                 self.DeletePerson(sfa_record)
564         elif sfa_record_type == 'slice':
565             if self.GetSlices(slice_filter = hrn, \
566                                     slice_filter_type = 'slice_hrn'):
567                 self.DeleteSlice(sfa_record)
568
569         #elif type == 'authority':
570             #if self.GetSites(pointer):
571                 #self.DeleteSite(pointer)
572
573         return True
574             
575             
576             
577     #TODO clean GetPeers. 05/07/12SA        
578     def GetPeers (self, auth = None, peer_filter=None, return_fields_list=None):
579
580         existing_records = {}
581         existing_hrns_by_types = {}
582         logger.debug("SLABDRIVER \tGetPeers auth = %s, peer_filter %s, \
583                     return_field %s " %(auth , peer_filter, return_fields_list))
584         all_records = dbsession.query(RegRecord).filter(RegRecord.type.like('%authority%')).all()
585         for record in all_records:
586             existing_records[(record.hrn, record.type)] = record
587             if record.type not in existing_hrns_by_types:
588                 existing_hrns_by_types[record.type] = [record.hrn]
589                 logger.debug("SLABDRIVER \tGetPeer\t NOT IN \
590                     existing_hrns_by_types %s " %( existing_hrns_by_types))
591             else:
592                 
593                 logger.debug("SLABDRIVER \tGetPeer\t \INNN  type %s hrn %s " \
594                                                 %(record.type,record.hrn))
595                 existing_hrns_by_types[record.type].append(record.hrn)
596
597                         
598         logger.debug("SLABDRIVER \tGetPeer\texisting_hrns_by_types %s "\
599                                              %( existing_hrns_by_types))
600         records_list = [] 
601       
602         try: 
603             if peer_filter:
604                 records_list.append(existing_records[(peer_filter,'authority')])
605             else :
606                 for hrn in existing_hrns_by_types['authority']:
607                     records_list.append(existing_records[(hrn,'authority')])
608                     
609             logger.debug("SLABDRIVER \tGetPeer \trecords_list  %s " \
610                                             %(records_list))
611
612         except KeyError:
613             pass
614                 
615         return_records = records_list
616         if not peer_filter and not return_fields_list:
617             return records_list
618
619        
620         logger.debug("SLABDRIVER \tGetPeer return_records %s " \
621                                                     %(return_records))
622         return return_records
623         
624      
625     #TODO  : Handling OR request in make_ldap_filters_from_records 
626     #instead of the for loop 
627     #over the records' list
628     def GetPersons(self, person_filter=None):
629         """
630         person_filter should be a list of dictionnaries when not set to None.
631         Returns a list of users whose accounts are enabled found in ldap.
632        
633         """
634         logger.debug("SLABDRIVER \tGetPersons person_filter %s" \
635                                                     %(person_filter))
636         person_list = []
637         if person_filter and isinstance(person_filter, list):
638         #If we are looking for a list of users (list of dict records)
639         #Usually the list contains only one user record
640             for searched_attributes in person_filter:
641                 
642                 #Get only enabled user accounts in senslab LDAP : 
643                 #add a filter for make_ldap_filters_from_record
644                 person = self.ldap.LdapFindUser(searched_attributes, \
645                                 is_user_enabled=True)
646                 person_list.append(person)
647           
648         else:
649             #Get only enabled user accounts in senslab LDAP : 
650             #add a filter for make_ldap_filters_from_record
651             person_list  = self.ldap.LdapFindUser(is_user_enabled=True)  
652
653         return person_list
654
655     def GetTimezone(self):
656         server_timestamp, server_tz = self.oar.parser.\
657                                             SendRequest("GET_timezone")
658         return server_timestamp, server_tz
659     
660
661     def DeleteJobs(self, job_id, slice_hrn):
662         if not job_id or job_id is -1:
663             return
664         username  = slice_hrn.split(".")[-1].rstrip("_slice")
665         reqdict = {}
666         reqdict['method'] = "delete"
667         reqdict['strval'] = str(job_id)
668        
669         self.db.delete_job(slice_hrn, job_id)
670         answer = self.oar.POSTRequestToOARRestAPI('DELETE_jobs_id', \
671                                                     reqdict,username)
672         logger.debug("SLABDRIVER \tDeleteJobs jobid  %s \r\n answer %s \
673                                 username %s" %(job_id,answer, username))
674         return answer
675
676             
677         
678         ##TODO : Unused GetJobsId ? SA 05/07/12
679     #def GetJobsId(self, job_id, username = None ):
680         #"""
681         #Details about a specific job. 
682         #Includes details about submission time, jot type, state, events, 
683         #owner, assigned ressources, walltime etc...
684             
685         #"""
686         #req = "GET_jobs_id"
687         #node_list_k = 'assigned_network_address'
688         ##Get job info from OAR    
689         #job_info = self.oar.parser.SendRequest(req, job_id, username)
690
691         #logger.debug("SLABDRIVER \t GetJobsId  %s " %(job_info))
692         #try:
693             #if job_info['state'] == 'Terminated':
694                 #logger.debug("SLABDRIVER \t GetJobsId job %s TERMINATED"\
695                                                             #%(job_id))
696                 #return None
697             #if job_info['state'] == 'Error':
698                 #logger.debug("SLABDRIVER \t GetJobsId ERROR message %s "\
699                                                             #%(job_info))
700                 #return None
701                                                             
702         #except KeyError:
703             #logger.error("SLABDRIVER \tGetJobsId KeyError")
704             #return None 
705         
706         #parsed_job_info  = self.get_info_on_reserved_nodes(job_info, \
707                                                             #node_list_k)
708         ##Replaces the previous entry 
709         ##"assigned_network_address" / "reserved_resources"
710         ##with "node_ids"
711         #job_info.update({'node_ids':parsed_job_info[node_list_k]})
712         #del job_info[node_list_k]
713         #logger.debug(" \r\nSLABDRIVER \t GetJobsId job_info %s " %(job_info))
714         #return job_info
715
716         
717     def GetJobsResources(self, job_id, username = None):
718         #job_resources=['reserved_resources', 'assigned_resources',\
719                             #'job_id', 'job_uri', 'assigned_nodes',\
720                              #'api_timestamp']
721         #assigned_res = ['resource_id', 'resource_uri']
722         #assigned_n = ['node', 'node_uri']
723
724         req = "GET_jobs_id_resources"
725        
726                
727         #Get job resources list from OAR    
728         node_id_list = self.oar.parser.SendRequest(req, job_id, username)
729         logger.debug("SLABDRIVER \t GetJobsResources  %s " %(node_id_list))
730         
731         hostname_list = \
732             self.__get_hostnames_from_oar_node_ids(node_id_list)
733         
734
735         #Replaces the previous entry "assigned_network_address" / 
736         #"reserved_resources"
737         #with "node_ids"
738         job_info = {'node_ids': hostname_list}
739
740         return job_info
741
742             
743     def get_info_on_reserved_nodes(self, job_info, node_list_name):
744         #Get the list of the testbed nodes records and make a 
745         #dictionnary keyed on the hostname out of it
746         node_list_dict = self.GetNodes() 
747         #node_hostname_list = []
748         node_hostname_list = [node['hostname'] for node in node_list_dict] 
749         #for node in node_list_dict:
750             #node_hostname_list.append(node['hostname'])
751         node_dict = dict(zip(node_hostname_list, node_list_dict))
752         try :
753             reserved_node_hostname_list = []
754             for index in range(len(job_info[node_list_name])):
755                #job_info[node_list_name][k] = 
756                 reserved_node_hostname_list[index] = \
757                         node_dict[job_info[node_list_name][index]]['hostname']
758                             
759             logger.debug("SLABDRIVER \t get_info_on_reserved_nodes \
760                         reserved_node_hostname_list %s" \
761                         %(reserved_node_hostname_list))
762         except KeyError:
763             logger.error("SLABDRIVER \t get_info_on_reserved_nodes KEYERROR " )
764             
765         return reserved_node_hostname_list  
766             
767     def GetNodesCurrentlyInUse(self):
768         """Returns a list of all the nodes already involved in an oar job"""
769         return self.oar.parser.SendRequest("GET_running_jobs") 
770     
771     def __get_hostnames_from_oar_node_ids(self, resource_id_list ):
772         full_nodes_dict_list = self.GetNodes()
773         #Put the full node list into a dictionary keyed by oar node id
774         oar_id_node_dict = {}
775         for node in full_nodes_dict_list:
776             oar_id_node_dict[node['oar_id']] = node
777             
778         logger.debug("SLABDRIVER \t  __get_hostnames_from_oar_node_ids\
779                         oar_id_node_dict %s" %(oar_id_node_dict))
780
781         hostname_dict_list = [] 
782         for resource_id in resource_id_list:
783             #Because jobs requested "asap" do not have defined resources
784             if resource_id is not "Undefined":
785                 hostname_dict_list.append({'hostname' : \
786                         oar_id_node_dict[resource_id]['hostname'], 
787                         'site_id' :  oar_id_node_dict[resource_id]['site']})
788                 
789             #hostname_list.append(oar_id_node_dict[resource_id]['hostname'])
790         return hostname_dict_list 
791         
792     def GetReservedNodes(self):
793         #Get the nodes in use and the reserved nodes
794         reservation_dict_list = \
795                         self.oar.parser.SendRequest("GET_reserved_nodes")
796         
797         
798         for resa in reservation_dict_list:
799             logger.debug ("GetReservedNodes resa %s"%(resa))
800             #dict list of hostnames and their site
801             resa['reserved_nodes'] = \
802                 self.__get_hostnames_from_oar_node_ids(resa['resource_ids'])
803                 
804         #del resa['resource_ids']
805         return reservation_dict_list
806      
807     def GetNodes(self, node_filter_dict = None, return_fields_list = None):
808         """
809         node_filter_dict : dictionnary of lists
810         
811         """
812         node_dict_by_id = self.oar.parser.SendRequest("GET_resources_full")
813         node_dict_list = node_dict_by_id.values()
814         
815         #No  filtering needed return the list directly
816         if not (node_filter_dict or return_fields_list):
817             return node_dict_list
818         
819         return_node_list = []
820         if node_filter_dict:
821             for filter_key in node_filter_dict:
822                 try:
823                     #Filter the node_dict_list by each value contained in the 
824                     #list node_filter_dict[filter_key]
825                     for value in node_filter_dict[filter_key]:
826                         for node in node_dict_list:
827                             if node[filter_key] == value:
828                                 if return_fields_list :
829                                     tmp = {}
830                                     for k in return_fields_list:
831                                         tmp[k] = node[k]     
832                                     return_node_list.append(tmp)
833                                 else:
834                                     return_node_list.append(node)
835                 except KeyError:
836                     logger.log_exc("GetNodes KeyError")
837                     return
838
839
840         return return_node_list
841     
842   
843     def GetSites(self, site_filter_name_list = None, return_fields_list = None):
844         site_dict = self.oar.parser.SendRequest("GET_sites")
845         #site_dict : dict where the key is the sit ename
846         return_site_list = []
847         if not ( site_filter_name_list or return_fields_list):
848             return_site_list = site_dict.values()
849             return return_site_list
850         
851         for site_filter_name in site_filter_name_list:
852             if site_filter_name in site_dict:
853                 if return_fields_list:
854                     for field in return_fields_list:
855                         tmp = {}
856                         try:
857                             tmp[field] = site_dict[site_filter_name][field]
858                         except KeyError:
859                             logger.error("GetSites KeyError %s "%(field))
860                             return None
861                     return_site_list.append(tmp)
862                 else:
863                     return_site_list.append( site_dict[site_filter_name])
864             
865
866         return return_site_list
867     #warning return_fields_list paramr emoved  (Not used)     
868     def GetSlices(self, slice_filter = None, slice_filter_type = None):
869     #def GetSlices(self, slice_filter = None, slice_filter_type = None, \
870                                             #return_fields_list = None):
871         """ Get the slice records from the slab db. 
872         Returns a slice ditc if slice_filter  and slice_filter_type 
873         are specified.
874         Returns a list of slice dictionnaries if there are no filters
875         specified. 
876        
877         """
878         login = None
879         return_slice_list = []
880         slicerec  = {}
881         slicerec_dict = {}
882         authorized_filter_types_list = ['slice_hrn', 'record_id_user']
883         
884         if slice_filter_type in authorized_filter_types_list:
885             #Get list of slices based on the slice hrn
886             if slice_filter_type == 'slice_hrn':
887  
888                 login = slice_filter.split(".")[1].split("_")[0] 
889                 
890                 #DO NOT USE RegSlice - reg_researchers to get the hrn of the user
891                 #otherwise will mess up the RegRecord in Resolve, don't know
892                 #why - SA 08/08/2012
893                 
894                 #Only one entry for one user  = one slice in slice_senslab table
895                 slicerec = slab_dbsession.query(SliceSenslab).filter_by(slice_hrn = slice_filter).first()
896                 
897             #Get slice based on user id                             
898             if slice_filter_type == 'record_id_user':
899                 slicerec = slab_dbsession.query(SliceSenslab).filter_by(record_id_user = slice_filter).first()
900                 
901             if slicerec is None:
902                 return []
903             
904             #slicerec_dictlist = []
905             slicerec_dict = slicerec.dump_sqlalchemyobj_to_dict()
906             if login is None :
907                 login = slicerec_dict['slice_hrn'].split(".")[1].split("_")[0] 
908
909             #for record in slicerec:
910                 #slicerec_dictlist.append(record.dump_sqlalchemyobj_to_dict())
911                 #if login is None :
912                     #login = slicerec_dictlist[0]['slice_hrn'].split(".")[1].split("_")[0] 
913
914             #One slice can have multiple jobs
915             sqljob_list = slab_dbsession.query(JobSenslab).filter_by( slice_hrn=slicerec_dict['slice_hrn']).all() 
916             job_list = []
917             for job in sqljob_list:
918                 job_list.append(job.dump_sqlalchemyobj_to_dict())
919                 
920             logger.debug("\r\n SLABDRIVER \tGetSlices login %s \
921                                             slice record %s" \
922                                             %(login, slicerec_dict))
923             
924             #Several jobs for one slice   
925             slicerec_dict['oar_job_id'] = []
926             for job in job_list :                          
927                 #if slicerec_dict['oar_job_id'] is not -1:
928                 #Check with OAR the status of the job if a job id is in 
929                 #the slice record 
930                 
931                 rslt = self.GetJobsResources(job['oar_job_id'], \
932                                                         username = login)
933                 logger.debug("SLABDRIVER.PY  \tGetSlices  rslt fromn  GetJobsResources %s"\
934                                                         %(rslt))
935                 if rslt :
936                     slicerec_dict['oar_job_id'].append(job['oar_job_id'])
937                     slicerec_dict.update(rslt)
938                     slicerec_dict.update({'hrn':\
939                                         str(slicerec_dict['slice_hrn'])})
940                 #If GetJobsResources is empty, this means the job is 
941                 #now in the 'Terminated' state
942                 #Update the slice record
943                 else :
944                     self.db.delete_job(slice_filter, job['oar_job_id'])
945                     slicerec_dict.\
946                             update({'hrn':str(slicerec_dict['slice_hrn'])})
947         
948                 try:
949                     slicerec_dict['node_ids'] = job['node_list']
950                 except KeyError:
951                     pass
952             
953             logger.debug("SLABDRIVER.PY  \tGetSlices  RETURN slicerec_dict  %s"\
954                                                         %(slicerec_dict))
955                             
956             return [slicerec_dict]
957             
958                 
959         else:
960             slice_list = slab_dbsession.query(SliceSenslab).all()
961             sqljob_list = slab_dbsession.query(JobSenslab).all()
962             
963             job_list = []
964             for job in sqljob_list:
965                 job_list.append(job.dump_sqlalchemyobj_to_dict())
966                 
967             return_slice_list = []
968             for record in slice_list:
969                 return_slice_list.append(record.dump_sqlalchemyobj_to_dict())
970                 
971             for slicerec_dict in return_slice_list:
972                 slicerec_dict['oar_job_id'] = []
973                 for job in job_list:
974                     if slicerec_dict['slice_hrn'] in job:
975                         slicerec_dict['oar_job_id'].append(job['oar_job_id'])
976                 
977             logger.debug("SLABDRIVER.PY  \tGetSlices RETURN slices %s \
978                         slice_filter %s " %(return_slice_list, slice_filter))
979         
980         #if return_fields_list:
981             #return_slice_list  = parse_filter(sliceslist, \
982                                 #slice_filter,'slice', return_fields_list)
983
984         return return_slice_list
985
986             
987
988         
989     
990     def testbed_name (self): return self.hrn
991          
992     # 'geni_request_rspec_versions' and 'geni_ad_rspec_versions' are mandatory
993     def aggregate_version (self):
994         version_manager = VersionManager()
995         ad_rspec_versions = []
996         request_rspec_versions = []
997         for rspec_version in version_manager.versions:
998             if rspec_version.content_type in ['*', 'ad']:
999                 ad_rspec_versions.append(rspec_version.to_dict())
1000             if rspec_version.content_type in ['*', 'request']:
1001                 request_rspec_versions.append(rspec_version.to_dict()) 
1002         return {
1003             'testbed':self.testbed_name(),
1004             'geni_request_rspec_versions': request_rspec_versions,
1005             'geni_ad_rspec_versions': ad_rspec_versions,
1006             }
1007           
1008           
1009           
1010           
1011           
1012           
1013     ##
1014     # Convert SFA fields to PLC fields for use when registering up updating
1015     # registry record in the PLC database
1016     #
1017     # @param type type of record (user, slice, ...)
1018     # @param hrn human readable name
1019     # @param sfa_fields dictionary of SFA fields
1020     # @param slab_fields dictionary of PLC fields (output)
1021
1022     def sfa_fields_to_slab_fields(self, sfa_type, hrn, record):
1023
1024
1025         slab_record = {}
1026         #for field in record:
1027         #    slab_record[field] = record[field]
1028  
1029         if sfa_type == "slice":
1030             #instantion used in get_slivers ? 
1031             if not "instantiation" in slab_record:
1032                 slab_record["instantiation"] = "senslab-instantiated"
1033             #slab_record["hrn"] = hrn_to_pl_slicename(hrn)     
1034             #Unused hrn_to_pl_slicename because Slab's hrn already in the appropriate form SA 23/07/12
1035             slab_record["hrn"] = hrn 
1036             logger.debug("SLABDRIVER.PY sfa_fields_to_slab_fields \
1037                         slab_record %s  " %(slab_record['hrn']))
1038             if "url" in record:
1039                 slab_record["url"] = record["url"]
1040             if "description" in record:
1041                 slab_record["description"] = record["description"]
1042             if "expires" in record:
1043                 slab_record["expires"] = int(record["expires"])
1044                 
1045         #nodes added by OAR only and then imported to SFA
1046         #elif type == "node":
1047             #if not "hostname" in slab_record:
1048                 #if not "hostname" in record:
1049                     #raise MissingSfaInfo("hostname")
1050                 #slab_record["hostname"] = record["hostname"]
1051             #if not "model" in slab_record:
1052                 #slab_record["model"] = "geni"
1053                 
1054         #One authority only 
1055         #elif type == "authority":
1056             #slab_record["login_base"] = hrn_to_slab_login_base(hrn)
1057
1058             #if not "name" in slab_record:
1059                 #slab_record["name"] = hrn
1060
1061             #if not "abbreviated_name" in slab_record:
1062                 #slab_record["abbreviated_name"] = hrn
1063
1064             #if not "enabled" in slab_record:
1065                 #slab_record["enabled"] = True
1066
1067             #if not "is_public" in slab_record:
1068                 #slab_record["is_public"] = True
1069
1070         return slab_record
1071
1072     
1073
1074             
1075     def __transforms_timestamp_into_date(self, xp_utc_timestamp = None):
1076         """ Transforms unix timestamp into valid OAR date format """
1077         
1078         #Used in case of a scheduled experiment (not immediate)
1079         #To run an XP immediately, don't specify date and time in RSpec 
1080         #They will be set to None. 
1081         if xp_utc_timestamp:
1082             #transform the xp_utc_timestamp into server readable time  
1083             xp_server_readable_date = datetime.fromtimestamp(int(\
1084                                 xp_utc_timestamp)).strftime(self.time_format)
1085
1086             return xp_server_readable_date
1087             
1088         else:
1089             return None
1090         
1091    
1092
1093              
1094     def LaunchExperimentOnOAR(self, added_nodes, slice_name, \
1095                         lease_start_time, lease_duration, slice_user=None):
1096         lease_dict = {}
1097         lease_dict['lease_start_time'] = lease_start_time
1098         lease_dict['lease_duration'] = lease_duration
1099         lease_dict['added_nodes'] = added_nodes
1100         lease_dict['slice_name'] = slice_name
1101         lease_dict['slice_user'] = slice_user
1102         lease_dict['grain'] = self.GetLeaseGranularity()
1103         lease_dict['time_format'] = self.time_format
1104         
1105         def __create_job_structure_request_for_OAR(lease_dict):
1106             """ Creates the structure needed for a correct POST on OAR.
1107             Makes the timestamp transformation into the appropriate format.
1108             Sends the POST request to create the job with the resources in 
1109             added_nodes.
1110             
1111             """
1112
1113             nodeid_list = []
1114             reqdict = {}
1115     
1116             
1117             reqdict['workdir'] = '/tmp'   
1118             reqdict['resource'] = "{network_address in ("   
1119     
1120             for node in lease_dict['added_nodes']: 
1121                 logger.debug("\r\n \r\n OARrestapi \t __create_job_structure_request_for_OAR \
1122                                                                 node %s" %(node))
1123     
1124                 # Get the ID of the node 
1125                 nodeid = node
1126                 reqdict['resource'] += "'" + nodeid + "', "
1127                 nodeid_list.append(nodeid)
1128     
1129             custom_length = len(reqdict['resource'])- 2
1130             reqdict['resource'] = reqdict['resource'][0:custom_length] + \
1131                                                 ")}/nodes=" + str(len(nodeid_list))
1132     
1133             def __process_walltime(duration):
1134                 """ Calculates the walltime in seconds from the duration in H:M:S
1135                     specified in the RSpec.
1136                     
1137                 """
1138                 if duration:
1139                     # Fixing the walltime by adding a few delays. 
1140                     # First put the walltime in seconds oarAdditionalDelay = 20;
1141                     #  additional delay for /bin/sleep command to
1142                     # take in account  prologue and epilogue scripts execution
1143                     # int walltimeAdditionalDelay = 120;  additional delay
1144                     desired_walltime = duration 
1145                     total_walltime = desired_walltime + 140#+2 min 20
1146                     sleep_walltime = desired_walltime + 20 #+20 sec
1147                     walltime = []
1148                     #Put the walltime back in str form
1149                     #First get the hours
1150                     walltime.append(str(total_walltime / 3600))
1151                     total_walltime = total_walltime - 3600 * int(walltime[0])
1152                     #Get the remaining minutes
1153                     walltime.append(str(total_walltime / 60))
1154                     total_walltime = total_walltime - 60 * int(walltime[1])
1155                     #Get the seconds
1156                     walltime.append(str(total_walltime))
1157     
1158                 else:
1159                     logger.log_exc(" __process_walltime duration null")
1160                     
1161                 return walltime, sleep_walltime
1162                     
1163
1164             walltime, sleep_walltime = \
1165                         __process_walltime(int(lease_dict['lease_duration'])*lease_dict['grain'])
1166     
1167     
1168             reqdict['resource'] += ",walltime=" + str(walltime[0]) + \
1169                                 ":" + str(walltime[1]) + ":" + str(walltime[2])
1170             reqdict['script_path'] = "/bin/sleep " + str(sleep_walltime)
1171     
1172             #In case of a scheduled experiment (not immediate)
1173             #To run an XP immediately, don't specify date and time in RSpec 
1174             #They will be set to None.
1175             if lease_dict['lease_start_time'] is not '0':
1176                 #Readable time accepted by OAR
1177                 start_time = datetime.fromtimestamp(int(lease_dict['lease_start_time'])).\
1178                                                         strftime(lease_dict['time_format'])
1179                 reqdict['reservation'] = start_time
1180             #If there is not start time, Immediate XP. No need to add special 
1181             # OAR parameters
1182     
1183     
1184             reqdict['type'] = "deploy" 
1185             reqdict['directory'] = ""
1186             reqdict['name'] = "SFA_" + lease_dict['slice_user']
1187     
1188             return reqdict
1189         
1190                                    
1191         #Create the request for OAR
1192         reqdict = __create_job_structure_request_for_OAR(lease_dict)
1193          # first step : start the OAR job and update the job 
1194         logger.debug("SLABDRIVER.PY \tLaunchExperimentOnOAR reqdict %s\
1195                              \r\n "  %(reqdict))  
1196        
1197         answer = self.oar.POSTRequestToOARRestAPI('POST_job', \
1198                                                             reqdict, slice_user)
1199         logger.debug("SLABDRIVER \tLaunchExperimentOnOAR jobid   %s " %(answer))
1200         try:       
1201             jobid = answer['id']
1202         except KeyError:
1203             logger.log_exc("SLABDRIVER \tLaunchExperimentOnOAR \
1204                                 Impossible to create job  %s "  %(answer))
1205             return
1206         
1207         
1208         def __configure_experiment(jobid, added_nodes):
1209             # second step : configure the experiment
1210             # we need to store the nodes in a yaml (well...) file like this :
1211             # [1,56,23,14,45,75] with name /tmp/sfa<jobid>.json
1212             job_file = open('/tmp/sfa/'+ str(jobid) + '.json', 'w')
1213             job_file.write('[')
1214             job_file.write(str(added_nodes[0].strip('node')))
1215             for node in added_nodes[1:len(added_nodes)] :
1216                 job_file.write(', '+ node.strip('node'))
1217             job_file.write(']')
1218             job_file.close()
1219             return 
1220         
1221         def __launch_senslab_experiment(jobid):   
1222             # third step : call the senslab-experiment wrapper
1223             #command= "java -jar target/sfa-1.0-jar-with-dependencies.jar 
1224             # "+str(jobid)+" "+slice_user
1225             javacmdline = "/usr/bin/java"
1226             jarname = \
1227                 "/opt/senslabexperimentwrapper/sfa-1.0-jar-with-dependencies.jar"
1228             #ret=subprocess.check_output(["/usr/bin/java", "-jar", ", \
1229                                                         #str(jobid), slice_user])
1230             output = subprocess.Popen([javacmdline, "-jar", jarname, str(jobid), \
1231                                 slice_user],stdout=subprocess.PIPE).communicate()[0]
1232     
1233             logger.debug("SLABDRIVER \t __configure_experiment wrapper returns%s " \
1234                                                                     %(output))
1235             return 
1236         
1237         
1238         
1239         if jobid :
1240             logger.debug("SLABDRIVER \tLaunchExperimentOnOAR jobid %s \
1241                     added_nodes %s slice_user %s" %(jobid, added_nodes, slice_user))
1242             self.db.add_job( slice_name, jobid, added_nodes)
1243         
1244             __configure_experiment(jobid, added_nodes)
1245             __launch_senslab_experiment(jobid) 
1246             
1247         return
1248         
1249     def AddLeases(self, hostname_list, slice_record, lease_start_time, lease_duration):
1250         logger.debug("SLABDRIVER \r\n \r\n \t AddLeases hostname_list %s  \
1251                 slice_record %s lease_start_time %s lease_duration %s  "\
1252                  %( hostname_list, slice_record , lease_start_time, \
1253                  lease_duration))
1254
1255         tmp = slice_record['PI'][0].split(".")
1256         username = tmp[(len(tmp)-1)]
1257         self.LaunchExperimentOnOAR(hostname_list, slice_record['name'], lease_start_time, lease_duration, username)
1258         start_time = datetime.fromtimestamp(int(lease_start_time)).strftime(self.time_format)
1259         logger.debug("SLABDRIVER \t AddLeases hostname_list start_time %s " %(start_time))
1260         
1261         return
1262     
1263     
1264     #Delete the jobs from job_senslab table
1265     def DeleteSliceFromNodes(self, slice_record):
1266         for job_id in slice_record['oar_job_id']:
1267             self.DeleteJobs(job_id, slice_record['hrn'])
1268
1269         return   
1270     
1271  
1272     def GetLeaseGranularity(self):
1273         """ Returns the granularity of Senslab testbed.
1274         Defined in seconds. """
1275         
1276         grain = 60 
1277         return grain
1278     
1279     def GetLeases(self, lease_filter_dict=None):
1280         unfiltered_reservation_list = self.GetReservedNodes()
1281         
1282         ##Synchronize slice_table of sfa senslab db
1283         #self.synchronize_oar_and_slice_table(unfiltered_reservation_list)
1284         
1285         reservation_list = []
1286         #Find the slice associated with this user senslab ldap uid
1287         logger.debug(" SLABDRIVER.PY \tGetLeases ")
1288         #Create user dict first to avoir looking several times for
1289         #the same user in LDAP SA 27/07/12
1290         resa_user_dict = {}
1291         for resa in unfiltered_reservation_list:
1292             logger.debug("SLABDRIVER \tGetLeases USER %s"\
1293                                             %(resa['user']))    
1294             if resa['user'] not in resa_user_dict: 
1295                 logger.debug("SLABDRIVER \tGetLeases userNOTIN ")
1296                 ldap_info = self.ldap.LdapSearch('(uid='+resa['user']+')')
1297                 ldap_info = ldap_info[0][1]
1298                 user = dbsession.query(RegUser).filter_by(email = \
1299                                                     ldap_info['mail'][0]).first()
1300                 #Separated in case user not in database : record_id not defined SA 17/07//12
1301                 query_slice_info = slab_dbsession.query(SliceSenslab).filter_by(record_id_user = user.record_id)
1302                 if query_slice_info:
1303                     slice_info = query_slice_info.first()
1304                 else:
1305                     slice_info = None
1306                     
1307                 resa_user_dict[resa['user']] = {}
1308                 resa_user_dict[resa['user']]['ldap_info'] = user
1309                 resa_user_dict[resa['user']]['slice_info'] = slice_info
1310  
1311         logger.debug("SLABDRIVER \tGetLeases resa_user_dict %s"\
1312                                             %(resa_user_dict))         
1313         for resa in unfiltered_reservation_list:
1314             
1315             
1316             #Put the slice_urn  
1317             resa['slice_hrn'] = resa_user_dict[resa['user']]['slice_info'].slice_hrn
1318             resa['slice_id'] = hrn_to_urn(resa['slice_hrn'], 'slice')    
1319             #Put the slice_urn 
1320             #resa['slice_id'] = hrn_to_urn(slice_info.slice_hrn, 'slice')
1321             resa['component_id_list'] = []
1322             #Transform the hostnames into urns (component ids)
1323             for node in resa['reserved_nodes']:
1324                 #resa['component_id_list'].append(hostname_to_urn(self.hrn, \
1325                          #self.root_auth, node['hostname']))
1326                 slab_xrn = slab_xrn_object(self.root_auth, node['hostname'])
1327                 resa['component_id_list'].append(slab_xrn.urn)
1328         
1329         #Filter the reservation list if necessary
1330         #Returns all the leases associated with a given slice
1331         if lease_filter_dict:
1332             logger.debug("SLABDRIVER \tGetLeases lease_filter_dict %s"\
1333                                             %(lease_filter_dict))
1334             for resa in unfiltered_reservation_list:
1335                 if lease_filter_dict['name'] == resa['slice_hrn']:
1336                     reservation_list.append(resa)
1337         else:
1338             reservation_list = unfiltered_reservation_list
1339             
1340         logger.debug(" SLABDRIVER.PY \tGetLeases reservation_list %s"\
1341                                                     %(reservation_list))
1342         return reservation_list
1343             
1344     def augment_records_with_testbed_info (self, sfa_records):
1345         return self.fill_record_info (sfa_records)
1346     
1347     def fill_record_info(self, record_list):
1348         """
1349         Given a SFA record, fill in the senslab specific and SFA specific
1350         fields in the record. 
1351         """
1352                     
1353         logger.debug("SLABDRIVER \tfill_record_info records %s " %(record_list))
1354         if not isinstance(record_list, list):
1355             record_list = [record_list]
1356             
1357         try:
1358             for record in record_list:
1359                 #If the record is a SFA slice record, then add information 
1360                 #about the user of this slice. This kind of 
1361                 #information is in the Senslab's DB.
1362                 if str(record['type']) == 'slice':
1363                     #Get slab slice record.
1364                     recslice_list = self.GetSlices(slice_filter = \
1365                                                 str(record['hrn']),\
1366                                                 slice_filter_type = 'slice_hrn')
1367                     
1368                     recuser = dbsession.query(RegRecord).filter_by(record_id = \
1369                                             recslice_list[0]['record_id_user']).first()
1370                     logger.debug("SLABDRIVER \tfill_record_info TYPE SLICE RECUSER %s " %(recuser))
1371                     record.update({'PI':[recuser.hrn],
1372                                 'researcher': [recuser.hrn],
1373                                 'name':record['hrn'], 
1374                                 'oar_job_id':[rec['oar_job_id'] for rec in recslice_list],
1375                                 'node_ids': [],
1376                                 'person_ids':[recslice_list[0]['record_id_user']],
1377                                 'geni_urn':'',  #For client_helper.py compatibility
1378                                 'keys':'',  #For client_helper.py compatibility
1379                                 'key_ids':''})  #For client_helper.py compatibility
1380
1381                     #for rec in recslice_list:
1382                         #record['oar_job_id'].append(rec['oar_job_id'])
1383                     logger.debug( "SLABDRIVER.PY \t fill_record_info SLICE \
1384                                                     recslice_list  %s \r\n \t RECORD %s \r\n \r\n" %(recslice_list,record)) 
1385                 if str(record['type']) == 'user':
1386                     #The record is a SFA user record.
1387                     #Get the information about his slice from Senslab's DB
1388                     #and add it to the user record.
1389                     recslice_list = self.GetSlices(\
1390                             slice_filter = record['record_id'],\
1391                             slice_filter_type = 'record_id_user')
1392                                             
1393                     logger.debug( "SLABDRIVER.PY \t fill_record_info TYPE USER \
1394                                                 recslice_list %s \r\n \t RECORD %s \r\n" %(recslice_list , record)) 
1395                     #Append slice record in records list, 
1396                     #therefore fetches user and slice info again(one more loop)
1397                     #Will update PIs and researcher for the slice
1398                     recuser = dbsession.query(RegRecord).filter_by(record_id = \
1399                                                 recslice_list[0]['record_id_user']).first()
1400                     logger.debug( "SLABDRIVER.PY \t fill_record_info USER  \
1401                                                 recuser %s \r\n \r\n" %(recuser)) 
1402                     recslice = {}
1403                     recslice = recslice_list[0]
1404                     recslice.update({'PI':[recuser.hrn],
1405                         'researcher': [recuser.hrn],
1406                         'name':record['hrn'], 
1407                         'node_ids': [],
1408                         'oar_job_id': [rec['oar_job_id'] for rec in recslice_list],
1409                         'person_ids':[recslice_list[0]['record_id_user']]})
1410                     recslice.update({'type':'slice', \
1411                                                 'hrn':recslice_list[0]['slice_hrn']})
1412                     #for rec in recslice_list:
1413                         #recslice['oar_job_id'].append(rec['oar_job_id'])
1414
1415                     #GetPersons takes [] as filters 
1416                     #user_slab = self.GetPersons([{'hrn':recuser.hrn}])
1417                     user_slab = self.GetPersons([record])
1418     
1419                     
1420                     record.update(user_slab[0])
1421                     #For client_helper.py compatibility
1422                     record.update( { 'geni_urn':'',
1423                     'keys':'',
1424                     'key_ids':'' })                
1425                     record_list.append(recslice)
1426                     
1427                     logger.debug("SLABDRIVER.PY \tfill_record_info ADDING SLICE\
1428                                 INFO TO USER records %s" %(record_list)) 
1429                 logger.debug("SLABDRIVER.PY \tfill_record_info END \
1430                                 #record %s \r\n \r\n " %(record))     
1431
1432         except TypeError, error:
1433             logger.log_exc("SLABDRIVER \t fill_record_info  EXCEPTION %s"\
1434                                                                      %(error))
1435         #logger.debug("SLABDRIVER.PY \t fill_record_info ENDENDEND ")
1436                               
1437         return
1438         
1439         #self.fill_record_slab_info(records)
1440     
1441     
1442         
1443
1444     
1445     #TODO Update membership?    update_membership_list SA 05/07/12
1446     #def update_membership_list(self, oldRecord, record, listName, addFunc, \
1447                                                                 #delFunc):
1448         ## get a list of the HRNs tht are members of the old and new records
1449         #if oldRecord:
1450             #oldList = oldRecord.get(listName, [])
1451         #else:
1452             #oldList = []     
1453         #newList = record.get(listName, [])
1454
1455         ## if the lists are the same, then we don't have to update anything
1456         #if (oldList == newList):
1457             #return
1458
1459         ## build a list of the new person ids, by looking up each person to get
1460         ## their pointer
1461         #newIdList = []
1462         #table = SfaTable()
1463         #records = table.find({'type': 'user', 'hrn': newList})
1464         #for rec in records:
1465             #newIdList.append(rec['pointer'])
1466
1467         ## build a list of the old person ids from the person_ids field 
1468         #if oldRecord:
1469             #oldIdList = oldRecord.get("person_ids", [])
1470             #containerId = oldRecord.get_pointer()
1471         #else:
1472             ## if oldRecord==None, then we are doing a Register, instead of an
1473             ## update.
1474             #oldIdList = []
1475             #containerId = record.get_pointer()
1476
1477     ## add people who are in the new list, but not the oldList
1478         #for personId in newIdList:
1479             #if not (personId in oldIdList):
1480                 #addFunc(self.plauth, personId, containerId)
1481
1482         ## remove people who are in the old list, but not the new list
1483         #for personId in oldIdList:
1484             #if not (personId in newIdList):
1485                 #delFunc(self.plauth, personId, containerId)
1486
1487     #def update_membership(self, oldRecord, record):
1488        
1489         #if record.type == "slice":
1490             #self.update_membership_list(oldRecord, record, 'researcher',
1491                                         #self.users.AddPersonToSlice,
1492                                         #self.users.DeletePersonFromSlice)
1493         #elif record.type == "authority":
1494             ## xxx TODO
1495             #pass
1496
1497 ### thierry
1498 # I don't think you plan on running a component manager at this point
1499 # let me clean up the mess of ComponentAPI that is deprecated anyways
1500
1501
1502 #TODO FUNCTIONS SECTION 04/07/2012 SA
1503
1504     #TODO : Is UnBindObjectFromPeer still necessary ? Currently does nothing
1505     #04/07/2012 SA
1506     def UnBindObjectFromPeer(self, auth, object_type, object_id, shortname):
1507         """ This method is a hopefully temporary hack to let the sfa correctly
1508         detach the objects it creates from a remote peer object. This is 
1509         needed so that the sfa federation link can work in parallel with 
1510         RefreshPeer, as RefreshPeer depends on remote objects being correctly 
1511         marked.
1512         Parameters:
1513         auth : struct, API authentication structure
1514             AuthMethod : string, Authentication method to use 
1515         object_type : string, Object type, among 'site','person','slice',
1516         'node','key'
1517         object_id : int, object_id
1518         shortname : string, peer shortname 
1519         FROM PLC DOC
1520         
1521         """
1522         logger.warning("SLABDRIVER \tUnBindObjectFromPeer EMPTY-\
1523                         DO NOTHING \r\n ")
1524         return 
1525     
1526     #TODO Is BindObjectToPeer still necessary ? Currently does nothing 
1527     #04/07/2012 SA
1528     def BindObjectToPeer(self, auth, object_type, object_id, shortname=None, \
1529                                                     remote_object_id=None):
1530         """This method is a hopefully temporary hack to let the sfa correctly 
1531         attach the objects it creates to a remote peer object. This is needed 
1532         so that the sfa federation link can work in parallel with RefreshPeer, 
1533         as RefreshPeer depends on remote objects being correctly marked.
1534         Parameters:
1535         shortname : string, peer shortname 
1536         remote_object_id : int, remote object_id, set to 0 if unknown 
1537         FROM PLC API DOC
1538         
1539         """
1540         logger.warning("SLABDRIVER \tBindObjectToPeer EMPTY - DO NOTHING \r\n ")
1541         return
1542     
1543     #TODO UpdateSlice 04/07/2012 SA
1544     #Funciton should delete and create another job since oin senslab slice=job
1545     def UpdateSlice(self, auth, slice_id_or_name, slice_fields=None):    
1546         """Updates the parameters of an existing slice with the values in 
1547         slice_fields.
1548         Users may only update slices of which they are members. 
1549         PIs may update any of the slices at their sites, or any slices of 
1550         which they are members. Admins may update any slice.
1551         Only PIs and admins may update max_nodes. Slices cannot be renewed
1552         (by updating the expires parameter) more than 8 weeks into the future.
1553          Returns 1 if successful, faults otherwise.
1554         FROM PLC API DOC
1555         
1556         """  
1557         logger.warning("SLABDRIVER UpdateSlice EMPTY - DO NOTHING \r\n ")
1558         return
1559     
1560     #TODO UpdatePerson 04/07/2012 SA
1561     def UpdatePerson(self, auth, person_id_or_email, person_fields=None):
1562         """Updates a person. Only the fields specified in person_fields 
1563         are updated, all other fields are left untouched.
1564         Users and techs can only update themselves. PIs can only update
1565         themselves and other non-PIs at their sites.
1566         Returns 1 if successful, faults otherwise.
1567         FROM PLC API DOC
1568          
1569         """
1570         logger.warning("SLABDRIVER UpdatePerson EMPTY - DO NOTHING \r\n ")
1571         return
1572     
1573     #TODO GetKeys 04/07/2012 SA
1574     def GetKeys(self, auth, key_filter=None, return_fields=None):
1575         """Returns an array of structs containing details about keys. 
1576         If key_filter is specified and is an array of key identifiers, 
1577         or a struct of key attributes, only keys matching the filter 
1578         will be returned. If return_fields is specified, only the 
1579         specified details will be returned.
1580
1581         Admin may query all keys. Non-admins may only query their own keys.
1582         FROM PLC API DOC
1583         
1584         """
1585         logger.warning("SLABDRIVER  GetKeys EMPTY - DO NOTHING \r\n ")
1586         return
1587     
1588     #TODO DeleteKey 04/07/2012 SA
1589     def DeleteKey(self, auth, key_id):
1590         """  Deletes a key.
1591          Non-admins may only delete their own keys.
1592          Returns 1 if successful, faults otherwise.
1593          FROM PLC API DOC
1594          
1595         """
1596         logger.warning("SLABDRIVER  DeleteKey EMPTY - DO NOTHING \r\n ")
1597         return
1598
1599     
1600     #TODO : Check rights to delete person 
1601     def DeletePerson(self, auth, person_record):
1602         """ Disable an existing account in senslab LDAP.
1603         Users and techs can only delete themselves. PIs can only 
1604         delete themselves and other non-PIs at their sites. 
1605         ins can delete anyone.
1606         Returns 1 if successful, faults otherwise.
1607         FROM PLC API DOC
1608         
1609         """
1610         #Disable user account in senslab LDAP
1611         ret = self.ldap.LdapMarkUserAsDeleted(person_record)
1612         logger.warning("SLABDRIVER DeletePerson %s " %(person_record))
1613         return ret
1614     
1615     #TODO Check DeleteSlice, check rights 05/07/2012 SA
1616     def DeleteSlice(self, auth, slice_record):
1617         """ Deletes the specified slice.
1618          Senslab : Kill the job associated with the slice if there is one
1619          using DeleteSliceFromNodes.
1620          Updates the slice record in slab db to remove the slice nodes.
1621          
1622          Users may only delete slices of which they are members. PIs may 
1623          delete any of the slices at their sites, or any slices of which 
1624          they are members. Admins may delete any slice.
1625          Returns 1 if successful, faults otherwise.
1626          FROM PLC API DOC
1627         
1628         """
1629         self.DeleteSliceFromNodes(slice_record)
1630         logger.warning("SLABDRIVER DeleteSlice %s "%(slice_record))
1631         return
1632     
1633     #TODO AddPerson 04/07/2012 SA
1634     def AddPerson(self, auth, person_fields=None):
1635         """Adds a new account. Any fields specified in person_fields are used, 
1636         otherwise defaults are used.
1637         Accounts are disabled by default. To enable an account, 
1638         use UpdatePerson().
1639         Returns the new person_id (> 0) if successful, faults otherwise. 
1640         FROM PLC API DOC
1641         
1642         """
1643         logger.warning("SLABDRIVER AddPerson EMPTY - DO NOTHING \r\n ")
1644         return
1645     
1646     #TODO AddPersonToSite 04/07/2012 SA
1647     def AddPersonToSite (self, auth, person_id_or_email, \
1648                                                 site_id_or_login_base=None):
1649         """  Adds the specified person to the specified site. If the person is 
1650         already a member of the site, no errors are returned. Does not change 
1651         the person's primary site.
1652         Returns 1 if successful, faults otherwise.
1653         FROM PLC API DOC
1654         
1655         """
1656         logger.warning("SLABDRIVER AddPersonToSite EMPTY - DO NOTHING \r\n ")
1657         return
1658     
1659     #TODO AddRoleToPerson : Not sure if needed in senslab 04/07/2012 SA
1660     def AddRoleToPerson(self, auth, role_id_or_name, person_id_or_email):
1661         """Grants the specified role to the person.
1662         PIs can only grant the tech and user roles to users and techs at their 
1663         sites. Admins can grant any role to any user.
1664         Returns 1 if successful, faults otherwise.
1665         FROM PLC API DOC
1666         
1667         """
1668         logger.warning("SLABDRIVER AddRoleToPerson EMPTY - DO NOTHING \r\n ")
1669         return
1670     
1671     #TODO AddPersonKey 04/07/2012 SA
1672     def AddPersonKey(self, auth, person_id_or_email, key_fields=None):
1673         """Adds a new key to the specified account.
1674         Non-admins can only modify their own keys.
1675         Returns the new key_id (> 0) if successful, faults otherwise.
1676         FROM PLC API DOC
1677         
1678         """
1679         logger.warning("SLABDRIVER AddPersonKey EMPTY - DO NOTHING \r\n ")
1680         return
1681     
1682     def DeleteLeases(self, leases_id_list, slice_hrn ):
1683         for job_id in leases_id_list:
1684             self.DeleteJobs(job_id, slice_hrn)
1685         
1686         logger.debug("SLABDRIVER DeleteLeases leases_id_list %s slice_hrn %s \
1687                 \r\n " %(leases_id_list, slice_hrn))
1688         return