3 from datetime import datetime
4 from dateutil import tz
5 from time import strftime, gmtime
7 from sfa.util.faults import SliverDoesNotExist, UnknownSfaType
8 from sfa.util.sfalogging import logger
10 from sfa.storage.alchemy import dbsession
11 from sfa.storage.model import RegRecord, RegUser
13 from sfa.trust.credential import Credential
16 from sfa.managers.driver import Driver
17 from sfa.rspecs.version_manager import VersionManager
18 from sfa.rspecs.rspec import RSpec
20 from sfa.util.xrn import hrn_to_urn, urn_to_sliver_id, get_leaf
21 from sfa.planetlab.plxrn import slicename_to_hrn, hrn_to_pl_slicename, \
25 ## thierry: everything that is API-related (i.e. handling incoming requests)
27 # SlabDriver should be really only about talking to the senslab testbed
30 from sfa.senslab.OARrestapi import OARrestapi
31 from sfa.senslab.LDAPapi import LDAPapi
33 from sfa.senslab.slabpostgres import SlabDB, slab_dbsession, SliceSenslab
34 from sfa.senslab.slabaggregate import SlabAggregate
35 from sfa.senslab.slabslices import SlabSlices
42 # this inheritance scheme is so that the driver object can receive
43 # GetNodes or GetSites sorts of calls directly
44 # and thus minimize the differences in the managers with the pl version
45 class SlabDriver(Driver):
47 def __init__(self, config):
48 Driver.__init__ (self, config)
50 self.hrn = config.SFA_INTERFACE_HRN
52 self.root_auth = config.SFA_REGISTRY_ROOT_AUTH
54 self.oar = OARrestapi()
56 self.time_format = "%Y-%m-%d %H:%M:%S"
57 self.db = SlabDB(config,debug = True)
61 def sliver_status(self, slice_urn, slice_hrn):
62 """Receive a status request for slice named urn/hrn
63 urn:publicid:IDN+senslab+nturro_slice hrn senslab.nturro_slice
64 shall return a structure as described in
65 http://groups.geni.net/geni/wiki/GAPI_AM_API_V2#SliverStatus
66 NT : not sure if we should implement this or not, but used by sface.
70 #First get the slice with the slice hrn
71 sl = self.GetSlices(slice_filter = slice_hrn, \
72 slice_filter_type = 'slice_hrn')
74 raise SliverDoesNotExist("%s slice_hrn" % (slice_hrn))
76 top_level_status = 'unknown'
77 nodes_in_slice = sl['node_ids']
79 if len(nodes_in_slice) is 0:
80 raise SliverDoesNotExist("No slivers allocated ")
82 top_level_status = 'ready'
84 logger.debug("Slabdriver - sliver_status Sliver status urn %s hrn %s sl\
85 %s \r\n " %(slice_urn, slice_hrn, sl))
87 if sl['oar_job_id'] is not -1:
88 #A job is running on Senslab for this slice
89 # report about the local nodes that are in the slice only
91 nodes_all = self.GetNodes({'hostname':nodes_in_slice},
92 ['node_id', 'hostname','site','boot_state'])
93 nodeall_byhostname = dict([(n['hostname'], n) for n in nodes_all])
97 result['geni_urn'] = slice_urn
98 result['pl_login'] = sl['job_user'] #For compatibility
101 timestamp = float(sl['startTime']) + float(sl['walltime'])
102 result['pl_expires'] = strftime(self.time_format, \
103 gmtime(float(timestamp)))
104 #result['slab_expires'] = strftime(self.time_format,\
105 #gmtime(float(timestamp)))
108 for node in nodeall_byhostname:
110 #res['slab_hostname'] = node['hostname']
111 #res['slab_boot_state'] = node['boot_state']
113 res['pl_hostname'] = nodeall_byhostname[node]['hostname']
114 res['pl_boot_state'] = nodeall_byhostname[node]['boot_state']
115 res['pl_last_contact'] = strftime(self.time_format, \
116 gmtime(float(timestamp)))
117 sliver_id = urn_to_sliver_id(slice_urn, sl['record_id_slice'], \
118 nodeall_byhostname[node]['node_id'])
119 res['geni_urn'] = sliver_id
120 if nodeall_byhostname[node]['boot_state'] == 'Alive':
122 res['geni_status'] = 'ready'
124 res['geni_status'] = 'failed'
125 top_level_status = 'failed'
127 res['geni_error'] = ''
129 resources.append(res)
131 result['geni_status'] = top_level_status
132 result['geni_resources'] = resources
133 logger.debug("SLABDRIVER \tsliver_statusresources %s res %s "\
138 def create_sliver (self, slice_urn, slice_hrn, creds, rspec_string, \
140 logger.debug("SLABDRIVER.PY \tcreate_sliver ")
141 aggregate = SlabAggregate(self)
143 slices = SlabSlices(self)
144 peer = slices.get_peer(slice_hrn)
145 sfa_peer = slices.get_sfa_peer(slice_hrn)
148 if not isinstance(creds, list):
152 slice_record = users[0].get('slice_record', {})
155 rspec = RSpec(rspec_string)
156 logger.debug("SLABDRIVER.PY \tcreate_sliver \trspec.version %s " \
160 # ensure site record exists?
161 # ensure slice record exists
162 sfa_slice = slices.verify_slice(slice_hrn, slice_record, peer, \
163 sfa_peer, options=options)
164 requested_attributes = rspec.version.get_slice_attributes()
166 if requested_attributes:
167 for attrib_dict in requested_attributes:
168 if 'timeslot' in attrib_dict and attrib_dict['timeslot'] \
170 sfa_slice.update({'timeslot':attrib_dict['timeslot']})
171 logger.debug("SLABDRIVER.PY create_sliver slice %s " %(sfa_slice))
173 # ensure person records exists
174 persons = slices.verify_persons(slice_hrn, sfa_slice, users, peer, \
175 sfa_peer, options=options)
177 # ensure slice attributes exists?
180 # add/remove slice from nodes
182 requested_slivers = [node.get('component_name') \
183 for node in rspec.version.get_nodes_with_slivers()]
184 logger.debug("SLADRIVER \tcreate_sliver requested_slivers \
185 requested_slivers %s " %(requested_slivers))
187 nodes = slices.verify_slice_nodes(sfa_slice, requested_slivers, peer)
190 requested_leases = []
192 for lease in rspec.version.get_leases():
194 if not lease.get('lease_id'):
195 requested_lease['hostname'] = \
196 xrn_to_hostname(lease.get('component_id').strip())
197 requested_lease['start_time'] = lease.get('start_time')
198 requested_lease['duration'] = lease.get('duration')
200 kept_leases.append(int(lease['lease_id']))
201 if requested_lease.get('hostname'):
202 requested_leases.append(requested_lease)
204 leases = slices.verify_slice_leases(sfa_slice, \
205 requested_leases, kept_leases, peer)
207 return aggregate.get_rspec(slice_xrn=slice_urn, version=rspec.version)
210 def delete_sliver (self, slice_urn, slice_hrn, creds, options):
212 sfa_slice = self.GetSlices(slice_filter = slice_hrn, \
213 slice_filter_type = 'slice_hrn')
214 logger.debug("SLABDRIVER.PY delete_sliver slice %s" %(sfa_slice))
218 slices = SlabSlices(self)
219 # determine if this is a peer slice
221 peer = slices.get_peer(slice_hrn)
224 self.UnBindObjectFromPeer('slice', \
225 sfa_slice['record_id_slice'], peer)
226 self.DeleteSliceFromNodes(sfa_slice)
229 self.BindObjectToPeer('slice', sfa_slice['slice_id'], \
230 peer, sfa_slice['peer_slice_id'])
234 def AddSlice(self, slice_record):
235 slab_slice = SliceSenslab( slice_hrn = slice_record['slice_hrn'], \
236 record_id_slice= slice_record['record_id_slice'] , \
237 record_id_user= slice_record['record_id_user'], \
238 peer_authority = slice_record['peer_authority'])
239 logger.debug("SLABDRIVER.PY \tAddSlice slice_record %s slab_slice %s" \
240 %(slice_record,slab_slice))
241 slab_dbsession.add(slab_slice)
242 slab_dbsession.commit()
245 # first 2 args are None in case of resource discovery
246 def list_resources (self, slice_urn, slice_hrn, creds, options):
247 #cached_requested = options.get('cached', True)
249 version_manager = VersionManager()
250 # get the rspec's return format from options
252 version_manager.get_version(options.get('geni_rspec_version'))
253 version_string = "rspec_%s" % (rspec_version)
255 #panos adding the info option to the caching key (can be improved)
256 if options.get('info'):
257 version_string = version_string + "_" + \
258 options.get('info', 'default')
260 # look in cache first
261 #if cached_requested and self.cache and not slice_hrn:
262 #rspec = self.cache.get(version_string)
264 #logger.debug("SlabDriver.ListResources: \
265 #returning cached advertisement")
268 #panos: passing user-defined options
269 aggregate = SlabAggregate(self)
270 origin_hrn = Credential(string=creds[0]).get_gid_caller().get_hrn()
271 options.update({'origin_hrn':origin_hrn})
272 rspec = aggregate.get_rspec(slice_xrn=slice_urn, \
273 version=rspec_version, options=options)
276 #if self.cache and not slice_hrn:
277 #logger.debug("Slab.ListResources: stores advertisement in cache")
278 #self.cache.add(version_string, rspec)
283 def list_slices (self, creds, options):
284 # look in cache first
286 #slices = self.cache.get('slices')
288 #logger.debug("PlDriver.list_slices returns from cache")
292 logger.debug("SLABDRIVER.PY \tlist_slices")
293 slices = self.GetSlices()
294 slice_hrns = [slicename_to_hrn(self.hrn, slab_slice['slice_hrn']) \
295 for slab_slice in slices]
296 slice_urns = [hrn_to_urn(slice_hrn, 'slice') \
297 for slice_hrn in slice_hrns]
301 #logger.debug ("SlabDriver.list_slices stores value in cache")
302 #self.cache.add('slices', slice_urns)
306 #No site or node register supported
307 def register (self, sfa_record, hrn, pub_key):
308 record_type = sfa_record['type']
309 slab_record = self.sfa_fields_to_slab_fields(record_type, hrn, \
313 if record_type == 'slice':
314 acceptable_fields = ['url', 'instantiation', 'name', 'description']
315 for key in slab_record.keys():
316 if key not in acceptable_fields:
318 logger.debug("SLABDRIVER.PY register")
319 slices = self.GetSlices(slice_filter =slab_record['hrn'], \
320 slice_filter_type = 'slice_hrn')
322 pointer = self.AddSlice(slab_record)
324 pointer = slices[0]['slice_id']
326 elif record_type == 'user':
327 persons = self.GetPersons([sfa_record])
328 #persons = self.GetPersons([sfa_record['hrn']])
330 pointer = self.AddPerson(dict(sfa_record))
333 pointer = persons[0]['person_id']
335 #Does this make sense to senslab ?
336 #if 'enabled' in sfa_record and sfa_record['enabled']:
337 #self.UpdatePerson(pointer, \
338 #{'enabled': sfa_record['enabled']})
340 #TODO register Change this AddPersonToSite stuff 05/07/2012 SA
341 # add this person to the site only if
342 # she is being added for the first
343 # time by sfa and doesnt already exist in plc
344 if not persons or not persons[0]['site_ids']:
345 login_base = get_leaf(sfa_record['authority'])
346 self.AddPersonToSite(pointer, login_base)
348 # What roles should this user have?
349 #TODO : DElete this AddRoleToPerson 04/07/2012 SA
350 #Function prototype is :
351 #AddRoleToPerson(self, auth, role_id_or_name, person_id_or_email)
352 #what's the pointer doing here?
353 self.AddRoleToPerson('user', pointer)
356 self.AddPersonKey(pointer, {'key_type' : 'ssh', \
359 #No node adding outside OAR
363 #No site or node record update allowed
364 def update (self, old_sfa_record, new_sfa_record, hrn, new_key):
365 pointer = old_sfa_record['pointer']
366 old_sfa_record_type = old_sfa_record['type']
368 # new_key implemented for users only
369 if new_key and old_sfa_record_type not in [ 'user' ]:
370 raise UnknownSfaType(old_sfa_record_type)
372 #if (type == "authority"):
373 #self.shell.UpdateSite(pointer, new_sfa_record)
375 if old_sfa_record_type == "slice":
376 slab_record = self.sfa_fields_to_slab_fields(old_sfa_record_type, \
378 if 'name' in slab_record:
379 slab_record.pop('name')
380 #Prototype should be UpdateSlice(self,
381 #auth, slice_id_or_name, slice_fields)
382 #Senslab cannot update slice since slice = job
383 #so we must delete and create another job
384 self.UpdateSlice(pointer, slab_record)
386 elif old_sfa_record_type == "user":
388 all_fields = new_sfa_record
389 for key in all_fields.keys():
390 if key in ['first_name', 'last_name', 'title', 'email',
391 'password', 'phone', 'url', 'bio', 'accepted_aup',
393 update_fields[key] = all_fields[key]
394 self.UpdatePerson(pointer, update_fields)
397 # must check this key against the previous one if it exists
398 persons = self.GetPersons([pointer], ['key_ids'])
400 keys = person['key_ids']
401 keys = self.GetKeys(person['key_ids'])
403 # Delete all stale keys
406 if new_key != key['key']:
407 self.DeleteKey(key['key_id'])
411 self.AddPersonKey(pointer, {'key_type': 'ssh', \
418 def remove (self, sfa_record):
419 sfa_record_type = sfa_record['type']
420 hrn = sfa_record['hrn']
421 record_id = sfa_record['record_id']
422 if sfa_record_type == 'user':
424 #get user from senslab ldap
425 person = self.GetPersons(sfa_record)
426 #No registering at a given site in Senslab.
427 #Once registered to the LDAP, all senslab sites are
430 #Mark account as disabled in ldap
431 self.DeletePerson(sfa_record)
432 elif sfa_record_type == 'slice':
433 if self.GetSlices(slice_filter = hrn, \
434 slice_filter_type = 'slice_hrn'):
435 self.DeleteSlice(sfa_record_type)
437 #elif type == 'authority':
438 #if self.GetSites(pointer):
439 #self.DeleteSite(pointer)
445 #TODO clean GetPeers. 05/07/12SA
446 def GetPeers (self, auth = None, peer_filter=None, return_fields_list=None):
448 existing_records = {}
449 existing_hrns_by_types = {}
450 logger.debug("SLABDRIVER \tGetPeers auth = %s, peer_filter %s, \
451 return_field %s " %(auth , peer_filter, return_fields_list))
452 all_records = dbsession.query(RegRecord).filter(RegRecord.type.like('%authority%')).all()
453 for record in all_records:
454 existing_records[(record.hrn, record.type)] = record
455 if record.type not in existing_hrns_by_types:
456 existing_hrns_by_types[record.type] = [record.hrn]
457 logger.debug("SLABDRIVER \tGetPeer\t NOT IN \
458 existing_hrns_by_types %s " %( existing_hrns_by_types))
461 logger.debug("SLABDRIVER \tGetPeer\t \INNN type %s hrn %s " \
462 %(record.type,record.hrn))
463 existing_hrns_by_types[record.type].append(record.hrn)
466 logger.debug("SLABDRIVER \tGetPeer\texisting_hrns_by_types %s "\
467 %( existing_hrns_by_types))
472 records_list.append(existing_records[(peer_filter,'authority')])
474 for hrn in existing_hrns_by_types['authority']:
475 records_list.append(existing_records[(hrn,'authority')])
477 logger.debug("SLABDRIVER \tGetPeer \trecords_list %s " \
483 return_records = records_list
484 if not peer_filter and not return_fields_list:
488 logger.debug("SLABDRIVER \tGetPeer return_records %s " \
490 return return_records
493 #TODO : Handling OR request in make_ldap_filters_from_records
494 #instead of the for loop
495 #over the records' list
496 def GetPersons(self, person_filter=None, return_fields_list=None):
498 person_filter should be a list of dictionnaries when not set to None.
499 Returns a list of users whose accounts are enabled found in ldap.
502 logger.debug("SLABDRIVER \tGetPersons person_filter %s" \
505 if person_filter and isinstance(person_filter, list):
506 #If we are looking for a list of users (list of dict records)
507 #Usually the list contains only one user record
508 for searched_attributes in person_filter:
510 #Get only enabled user accounts in senslab LDAP :
511 #add a filter for make_ldap_filters_from_record
512 person = self.ldap.LdapFindUser(searched_attributes, \
513 is_user_enabled=True)
514 person_list.append(person)
517 #Get only enabled user accounts in senslab LDAP :
518 #add a filter for make_ldap_filters_from_record
519 person_list = self.ldap.LdapFindUser(is_user_enabled=True)
523 def GetTimezone(self):
524 server_timestamp, server_tz = self.oar.parser.\
525 SendRequest("GET_timezone")
526 return server_timestamp, server_tz
529 def DeleteJobs(self, job_id, slice_hrn):
530 if not job_id or job_id is -1:
532 username = slice_hrn.split(".")[-1].rstrip("_slice")
534 reqdict['method'] = "delete"
535 reqdict['strval'] = str(job_id)
537 answer = self.oar.POSTRequestToOARRestAPI('DELETE_jobs_id', \
539 logger.debug("SLABDRIVER \tDeleteJobs jobid %s \r\n answer %s username %s" \
540 %(job_id,answer, username))
545 ##TODO : Unused GetJobsId ? SA 05/07/12
546 #def GetJobsId(self, job_id, username = None ):
548 #Details about a specific job.
549 #Includes details about submission time, jot type, state, events,
550 #owner, assigned ressources, walltime etc...
554 #node_list_k = 'assigned_network_address'
555 ##Get job info from OAR
556 #job_info = self.oar.parser.SendRequest(req, job_id, username)
558 #logger.debug("SLABDRIVER \t GetJobsId %s " %(job_info))
560 #if job_info['state'] == 'Terminated':
561 #logger.debug("SLABDRIVER \t GetJobsId job %s TERMINATED"\
564 #if job_info['state'] == 'Error':
565 #logger.debug("SLABDRIVER \t GetJobsId ERROR message %s "\
570 #logger.error("SLABDRIVER \tGetJobsId KeyError")
573 #parsed_job_info = self.get_info_on_reserved_nodes(job_info, \
575 ##Replaces the previous entry
576 ##"assigned_network_address" / "reserved_resources"
578 #job_info.update({'node_ids':parsed_job_info[node_list_k]})
579 #del job_info[node_list_k]
580 #logger.debug(" \r\nSLABDRIVER \t GetJobsId job_info %s " %(job_info))
584 def GetJobsResources(self, job_id, username = None):
585 #job_resources=['reserved_resources', 'assigned_resources',\
586 #'job_id', 'job_uri', 'assigned_nodes',\
588 #assigned_res = ['resource_id', 'resource_uri']
589 #assigned_n = ['node', 'node_uri']
591 req = "GET_jobs_id_resources"
592 node_list_k = 'reserved_resources'
594 #Get job resources list from OAR
595 node_id_list = self.oar.parser.SendRequest(req, job_id, username)
596 logger.debug("SLABDRIVER \t GetJobsResources %s " %(node_id_list))
599 self.__get_hostnames_from_oar_node_ids(node_id_list)
601 #parsed_job_info = self.get_info_on_reserved_nodes(job_info, \
603 #Replaces the previous entry "assigned_network_address" /
604 #"reserved_resources"
606 job_info = {'node_ids': hostname_list}
611 def get_info_on_reserved_nodes(self, job_info, node_list_name):
612 #Get the list of the testbed nodes records and make a
613 #dictionnary keyed on the hostname out of it
614 node_list_dict = self.GetNodes()
615 #node_hostname_list = []
616 node_hostname_list = [node['hostname'] for node in node_list_dict]
617 #for node in node_list_dict:
618 #node_hostname_list.append(node['hostname'])
619 node_dict = dict(zip(node_hostname_list, node_list_dict))
621 reserved_node_hostname_list = []
622 for index in range(len(job_info[node_list_name])):
623 #job_info[node_list_name][k] =
624 reserved_node_hostname_list[index] = \
625 node_dict[job_info[node_list_name][index]]['hostname']
627 logger.debug("SLABDRIVER \t get_info_on_reserved_nodes \
628 reserved_node_hostname_list %s" \
629 %(reserved_node_hostname_list))
631 logger.error("SLABDRIVER \t get_info_on_reserved_nodes KEYERROR " )
633 return reserved_node_hostname_list
635 def GetNodesCurrentlyInUse(self):
636 """Returns a list of all the nodes already involved in an oar job"""
637 return self.oar.parser.SendRequest("GET_running_jobs")
639 def __get_hostnames_from_oar_node_ids(self, resource_id_list ):
640 full_nodes_dict_list = self.GetNodes()
641 #Put the full node list into a dictionary keyed by oar node id
642 oar_id_node_dict = {}
643 for node in full_nodes_dict_list:
644 oar_id_node_dict[node['oar_id']] = node
646 logger.debug("SLABDRIVER \t __get_hostnames_from_oar_node_ids\
647 oar_id_node_dict %s" %(oar_id_node_dict))
649 hostname_dict_list = []
650 for resource_id in resource_id_list:
651 hostname_dict_list.append({'hostname' : \
652 oar_id_node_dict[resource_id]['hostname'],
653 'site_id' : oar_id_node_dict[resource_id]['site']})
655 #hostname_list.append(oar_id_node_dict[resource_id]['hostname'])
656 return hostname_dict_list
658 def GetReservedNodes(self):
659 #Get the nodes in use and the reserved nodes
660 reservation_dict_list = \
661 self.oar.parser.SendRequest("GET_reserved_nodes")
664 for resa in reservation_dict_list:
665 logger.debug ("GetReservedNodes resa %s"%(resa))
666 #dict list of hostnames and their site
667 resa['reserved_nodes'] = \
668 self.__get_hostnames_from_oar_node_ids(resa['resource_ids'])
670 #del resa['resource_ids']
671 return reservation_dict_list
673 def GetNodes(self, node_filter_dict = None, return_fields_list = None):
675 node_filter_dict : dictionnary of lists
678 node_dict_by_id = self.oar.parser.SendRequest("GET_resources_full")
679 node_dict_list = node_dict_by_id.values()
681 #No filtering needed return the list directly
682 if not (node_filter_dict or return_fields_list):
683 return node_dict_list
685 return_node_list = []
687 for filter_key in node_filter_dict:
689 #Filter the node_dict_list by each value contained in the
690 #list node_filter_dict[filter_key]
691 for value in node_filter_dict[filter_key]:
692 for node in node_dict_list:
693 if node[filter_key] == value:
694 if return_fields_list :
696 for k in return_fields_list:
698 return_node_list.append(tmp)
700 return_node_list.append(node)
702 logger.log_exc("GetNodes KeyError")
706 return return_node_list
709 def GetSites(self, site_filter_name_list = None, return_fields_list = None):
710 site_dict = self.oar.parser.SendRequest("GET_sites")
711 #site_dict : dict where the key is the sit ename
712 return_site_list = []
713 if not ( site_filter_name_list or return_fields_list):
714 return_site_list = site_dict.values()
715 return return_site_list
717 for site_filter_name in site_filter_name_list:
718 if site_filter_name in site_dict:
719 if return_fields_list:
720 for field in return_fields_list:
723 tmp[field] = site_dict[site_filter_name][field]
725 logger.error("GetSites KeyError %s "%(field))
727 return_site_list.append(tmp)
729 return_site_list.append( site_dict[site_filter_name])
732 return return_site_list
733 #warning return_fields_list paramr emoved (Not used)
734 def GetSlices(self, slice_filter = None, slice_filter_type = None):
735 #def GetSlices(self, slice_filter = None, slice_filter_type = None, \
736 #return_fields_list = None):
737 """ Get the slice records from the slab db.
738 Returns a slice ditc if slice_filter and slice_filter_type
740 Returns a list of slice dictionnaries if there are no filters
744 return_slice_list = []
747 authorized_filter_types_list = ['slice_hrn', 'record_id_user']
748 logger.debug("SLABDRIVER \tGetSlices authorized_filter_types_list %s"\
749 %(authorized_filter_types_list))
750 if slice_filter_type in authorized_filter_types_list:
751 if slice_filter_type == 'slice_hrn':
752 slicerec = slab_dbsession.query(SliceSenslab).filter_by(slice_hrn = slice_filter).first()
754 if slice_filter_type == 'record_id_user':
755 slicerec = slab_dbsession.query(SliceSenslab).filter_by(record_id_user = slice_filter).first()
759 slicerec_dict = slicerec.dump_sqlalchemyobj_to_dict()
760 logger.debug("SLABDRIVER \tGetSlices slicerec_dict %s" \
763 login = slicerec_dict['slice_hrn'].split(".")[1].split("_")[0]
764 logger.debug("\r\n SLABDRIVER \tGetSlices login %s \
766 %(login, slicerec_dict))
767 if slicerec_dict['oar_job_id'] is not -1:
768 #Check with OAR the status of the job if a job id is in
770 rslt = self.GetJobsResources(slicerec_dict['oar_job_id'], \
774 slicerec_dict.update(rslt)
775 slicerec_dict.update({'hrn':\
776 str(slicerec_dict['slice_hrn'])})
777 #If GetJobsResources is empty, this means the job is
778 #now in the 'Terminated' state
779 #Update the slice record
781 self.db.update_job(slice_filter, job_id = -1)
782 slicerec_dict['oar_job_id'] = -1
784 update({'hrn':str(slicerec_dict['slice_hrn'])})
787 slicerec_dict['node_ids'] = slicerec_dict['node_list']
791 logger.debug("SLABDRIVER.PY \tGetSlices slicerec_dict %s"\
798 return_slice_list = slab_dbsession.query(SliceSenslab).all()
800 logger.debug("SLABDRIVER.PY \tGetSlices slices %s \
801 slice_filter %s " %(return_slice_list, slice_filter))
803 #if return_fields_list:
804 #return_slice_list = parse_filter(sliceslist, \
805 #slice_filter,'slice', return_fields_list)
807 return return_slice_list
813 def testbed_name (self): return self.hrn
815 # 'geni_request_rspec_versions' and 'geni_ad_rspec_versions' are mandatory
816 def aggregate_version (self):
817 version_manager = VersionManager()
818 ad_rspec_versions = []
819 request_rspec_versions = []
820 for rspec_version in version_manager.versions:
821 if rspec_version.content_type in ['*', 'ad']:
822 ad_rspec_versions.append(rspec_version.to_dict())
823 if rspec_version.content_type in ['*', 'request']:
824 request_rspec_versions.append(rspec_version.to_dict())
826 'testbed':self.testbed_name(),
827 'geni_request_rspec_versions': request_rspec_versions,
828 'geni_ad_rspec_versions': ad_rspec_versions,
837 # Convert SFA fields to PLC fields for use when registering up updating
838 # registry record in the PLC database
840 # @param type type of record (user, slice, ...)
841 # @param hrn human readable name
842 # @param sfa_fields dictionary of SFA fields
843 # @param slab_fields dictionary of PLC fields (output)
845 def sfa_fields_to_slab_fields(self, sfa_type, hrn, record):
847 def convert_ints(tmpdict, int_fields):
848 for field in int_fields:
850 tmpdict[field] = int(tmpdict[field])
853 #for field in record:
854 # slab_record[field] = record[field]
856 if sfa_type == "slice":
857 #instantion used in get_slivers ?
858 if not "instantiation" in slab_record:
859 slab_record["instantiation"] = "senslab-instantiated"
860 slab_record["hrn"] = hrn_to_pl_slicename(hrn)
861 logger.debug("SLABDRIVER.PY sfa_fields_to_slab_fields \
862 slab_record %s hrn_to_pl_slicename(hrn) hrn %s " \
863 %(slab_record['hrn'], hrn))
865 slab_record["url"] = record["url"]
866 if "description" in record:
867 slab_record["description"] = record["description"]
868 if "expires" in record:
869 slab_record["expires"] = int(record["expires"])
871 #nodes added by OAR only and then imported to SFA
872 #elif type == "node":
873 #if not "hostname" in slab_record:
874 #if not "hostname" in record:
875 #raise MissingSfaInfo("hostname")
876 #slab_record["hostname"] = record["hostname"]
877 #if not "model" in slab_record:
878 #slab_record["model"] = "geni"
881 #elif type == "authority":
882 #slab_record["login_base"] = hrn_to_slab_login_base(hrn)
884 #if not "name" in slab_record:
885 #slab_record["name"] = hrn
887 #if not "abbreviated_name" in slab_record:
888 #slab_record["abbreviated_name"] = hrn
890 #if not "enabled" in slab_record:
891 #slab_record["enabled"] = True
893 #if not "is_public" in slab_record:
894 #slab_record["is_public"] = True
901 def __transforms_timestamp_into_date(self, xp_utc_timestamp = None):
902 """ Transforms unix timestamp into valid OAR date format """
904 #Used in case of a scheduled experiment (not immediate)
905 #To run an XP immediately, don't specify date and time in RSpec
906 #They will be set to None.
908 #transform the xp_utc_timestamp into server readable time
909 xp_server_readable_date = datetime.fromtimestamp(int(\
910 xp_utc_timestamp)).strftime(self.time_format)
912 return xp_server_readable_date
917 def LaunchExperimentOnOAR(self, slice_dict, added_nodes, slice_user=None):
918 """ Creates the structure needed for a correct POST on OAR.
919 Makes the timestamp transformation into the appropriate format.
920 Sends the POST request to create the job with the resources in
928 slice_name = slice_dict['name']
930 slot = slice_dict['timeslot']
931 logger.debug("SLABDRIVER.PY \tLaunchExperimentOnOAR \
934 #Running on default parameters
935 #XP immediate , 10 mins
936 slot = { 'date':None, 'start_time':None,
937 'timezone':None, 'duration':None }#10 min
939 reqdict['workdir'] = '/tmp'
940 reqdict['resource'] = "{network_address in ("
942 for node in added_nodes:
943 logger.debug("OARrestapi \tLaunchExperimentOnOAR \
946 #Get the ID of the node : remove the root auth and put
947 # the site in a separate list.
948 # NT: it's not clear for me if the nodenames will have the senslab
949 #prefix so lets take the last part only, for now.
951 # Again here it's not clear if nodes will be prefixed with <site>_,
952 #lets split and tanke the last part for now.
953 #s=lastpart.split("_")
956 reqdict['resource'] += "'" + nodeid + "', "
957 nodeid_list.append(nodeid)
959 custom_length = len(reqdict['resource'])- 2
960 reqdict['resource'] = reqdict['resource'][0:custom_length] + \
961 ")}/nodes=" + str(len(nodeid_list))
963 def __process_walltime(duration=None):
964 """ Calculates the walltime in seconds from the duration in H:M:S
965 specified in the RSpec.
969 walltime = duration.split(":")
970 # Fixing the walltime by adding a few delays. First put the walltime
971 # in seconds oarAdditionalDelay = 20; additional delay for
972 # /bin/sleep command to
973 # take in account prologue and epilogue scripts execution
974 # int walltimeAdditionalDelay = 120; additional delay
976 desired_walltime = int(walltime[0])*3600 + int(walltime[1]) * 60 +\
978 total_walltime = desired_walltime + 140 #+2 min 20
979 sleep_walltime = desired_walltime + 20 #+20 sec
980 logger.debug("SLABDRIVER \t__process_walltime desired_walltime %s\
981 total_walltime %s sleep_walltime %s "\
982 %(desired_walltime, total_walltime, \
984 #Put the walltime back in str form
986 walltime[0] = str(total_walltime / 3600)
987 total_walltime = total_walltime - 3600 * int(walltime[0])
988 #Get the remaining minutes
989 walltime[1] = str(total_walltime / 60)
990 total_walltime = total_walltime - 60 * int(walltime[1])
992 walltime[2] = str(total_walltime)
993 logger.debug("SLABDRIVER \t__process_walltime walltime %s "\
996 #automatically set 10min +2 min 20
1000 sleep_walltime = '620'
1002 return walltime, sleep_walltime
1004 #if slot['duration']:
1005 walltime, sleep_walltime = __process_walltime(duration = \
1008 #walltime, sleep_walltime = self.__process_walltime(duration = None)
1010 reqdict['resource'] += ",walltime=" + str(walltime[0]) + \
1011 ":" + str(walltime[1]) + ":" + str(walltime[2])
1012 reqdict['script_path'] = "/bin/sleep " + str(sleep_walltime)
1016 #In case of a scheduled experiment (not immediate)
1017 #To run an XP immediately, don't specify date and time in RSpec
1018 #They will be set to None.
1019 server_timestamp, server_tz = self.GetTimezone()
1020 if slot['date'] and slot['start_time']:
1021 if slot['timezone'] is '' or slot['timezone'] is None:
1022 #assume it is server timezone
1023 from_zone = tz.gettz(server_tz)
1024 logger.warning("SLABDRIVER \tLaunchExperimentOnOAR timezone \
1025 not specified server_tz %s from_zone %s" \
1026 %(server_tz, from_zone))
1028 #Get zone of the user from the reservation time given
1030 from_zone = tz.gettz(slot['timezone'])
1032 date = str(slot['date']) + " " + str(slot['start_time'])
1033 user_datetime = datetime.strptime(date, self.time_format)
1034 user_datetime = user_datetime.replace(tzinfo = from_zone)
1036 #Convert to server zone
1038 to_zone = tz.gettz(server_tz)
1039 reservation_date = user_datetime.astimezone(to_zone)
1040 #Readable time accpeted by OAR
1041 reqdict['reservation'] = reservation_date.strftime(self.time_format)
1043 logger.debug("SLABDRIVER \tLaunchExperimentOnOAR \
1044 reqdict['reservation'] %s " %(reqdict['reservation']))
1047 # Immediate XP. Not need to add special parameters.
1048 # normally not used in SFA
1053 reqdict['type'] = "deploy"
1054 reqdict['directory'] = ""
1055 reqdict['name'] = "TestSandrine"
1058 # first step : start the OAR job and update the job
1059 logger.debug("SLABDRIVER.PY \tLaunchExperimentOnOAR reqdict %s\
1060 \r\n site_list %s" %(reqdict, site_list))
1062 answer = self.oar.POSTRequestToOARRestAPI('POST_job', \
1063 reqdict, slice_user)
1064 logger.debug("SLABDRIVER \tLaunchExperimentOnOAR jobid %s " %(answer))
1066 jobid = answer['id']
1068 logger.log_exc("SLABDRIVER \tLaunchExperimentOnOAR \
1069 Impossible to create job %s " %(answer))
1072 logger.debug("SLABDRIVER \tLaunchExperimentOnOAR jobid %s \
1073 added_nodes %s slice_user %s" %(jobid, added_nodes, slice_user))
1074 self.db.update_job( slice_name, jobid, added_nodes)
1077 # second step : configure the experiment
1078 # we need to store the nodes in a yaml (well...) file like this :
1079 # [1,56,23,14,45,75] with name /tmp/sfa<jobid>.json
1080 job_file = open('/tmp/sfa/'+ str(jobid) + '.json', 'w')
1082 job_file.write(str(added_nodes[0].strip('node')))
1083 for node in added_nodes[1:len(added_nodes)] :
1084 job_file.write(', '+ node.strip('node'))
1088 # third step : call the senslab-experiment wrapper
1089 #command= "java -jar target/sfa-1.0-jar-with-dependencies.jar
1090 # "+str(jobid)+" "+slice_user
1091 javacmdline = "/usr/bin/java"
1093 "/opt/senslabexperimentwrapper/sfa-1.0-jar-with-dependencies.jar"
1094 #ret=subprocess.check_output(["/usr/bin/java", "-jar", ", \
1095 #str(jobid), slice_user])
1096 output = subprocess.Popen([javacmdline, "-jar", jarname, str(jobid), \
1097 slice_user],stdout=subprocess.PIPE).communicate()[0]
1099 logger.debug("SLABDRIVER \tLaunchExperimentOnOAR wrapper returns%s " \
1104 #Delete the jobs and updates the job id in the senslab table
1106 #Does not clear the node list
1107 def DeleteSliceFromNodes(self, slice_record):
1108 # Get user information
1110 self.DeleteJobs(slice_record['oar_job_id'], slice_record['hrn'])
1111 self.db.update_job(slice_record['hrn'], job_id = -1)
1115 def GetLeaseGranularity(self):
1116 """ Returns the granularity of Senslab testbed.
1117 Defined in seconds. """
1122 def GetLeases(self, lease_filter_dict=None, return_fields_list=None):
1123 unfiltered_reservation_list = self.GetReservedNodes()
1124 reservation_list = []
1125 #Find the slice associated with this user senslab ldap uid
1126 logger.debug(" SLABDRIVER.PY \tGetLeases ")
1127 for resa in unfiltered_reservation_list:
1128 ldap_info = self.ldap.LdapSearch('(uid='+resa['user']+')')
1129 ldap_info = ldap_info[0][1]
1131 user = dbsession.query(RegUser).filter_by(email = \
1132 ldap_info['mail'][0]).first()
1133 #Separated in case user not in database : record_id not defined SA 17/07//12
1134 query_slice_info = slab_dbsession.query(SliceSenslab).filter_by(record_id_user = user.record_id)
1135 if query_slice_info:
1136 slice_info = query_slice_info.first()
1139 resa['slice_id'] = hrn_to_urn(slice_info.slice_hrn, 'slice')
1140 resa['component_id_list'] = []
1141 #Transform the hostnames into urns (component ids)
1142 for node in resa['reserved_nodes']:
1143 resa['component_id_list'].append(hostname_to_urn(self.hrn, \
1144 self.root_auth, node['hostname']))
1147 #Filter the reservation list if necessary
1148 #Returns all the leases associated with a given slice
1149 if lease_filter_dict:
1150 logger.debug("SLABDRIVER \tGetLeases lease_filter_dict %s"\
1151 %(lease_filter_dict))
1152 for resa in unfiltered_reservation_list:
1153 if lease_filter_dict['name'] == resa['slice_id']:
1154 reservation_list.append(resa)
1156 reservation_list = unfiltered_reservation_list
1158 logger.debug(" SLABDRIVER.PY \tGetLeases reservation_list %s"\
1159 %(reservation_list))
1160 return reservation_list
1162 def augment_records_with_testbed_info (self, sfa_records):
1163 return self.fill_record_info (sfa_records)
1165 def fill_record_info(self, record_list):
1167 Given a SFA record, fill in the senslab specific and SFA specific
1168 fields in the record.
1171 logger.debug("SLABDRIVER \tfill_record_info records %s " %(record_list))
1172 if not isinstance(record_list, list):
1173 record_list = [record_list]
1176 for record in record_list:
1177 #If the record is a SFA slice record, then add information
1178 #about the user of this slice. This kind of
1179 #information is in the Senslab's DB.
1180 if str(record['type']) == 'slice':
1181 #Get slab slice record.
1182 recslice = self.GetSlices(slice_filter = \
1183 str(record['hrn']),\
1184 slice_filter_type = 'slice_hrn')
1185 recuser = dbsession.query(RegRecord).filter_by(record_id = \
1186 recslice['record_id_user']).first()
1187 logger.debug( "SLABDRIVER.PY \t fill_record_info SLICE \
1188 rec %s \r\n \r\n" %(recslice))
1189 record.update({'PI':[recuser.hrn],
1190 'researcher': [recuser.hrn],
1191 'name':record['hrn'],
1192 'oar_job_id':recslice['oar_job_id'],
1194 'person_ids':[recslice['record_id_user']],
1195 'geni_urn':'', #For client_helper.py compatibility
1196 'keys':'', #For client_helper.py compatibility
1197 'key_ids':''}) #For client_helper.py compatibility
1199 elif str(record['type']) == 'user':
1200 #The record is a SFA user record.
1201 #Get the information about his slice from Senslab's DB
1202 #and add it to the user record.
1203 recslice = self.GetSlices(\
1204 slice_filter = record['record_id'],\
1205 slice_filter_type = 'record_id_user')
1207 logger.debug( "SLABDRIVER.PY \t fill_record_info user \
1208 rec %s \r\n \r\n" %(recslice))
1209 #Append slice record in records list,
1210 #therefore fetches user and slice info again(one more loop)
1211 #Will update PIs and researcher for the slice
1212 recuser = dbsession.query(RegRecord).filter_by(record_id = \
1213 recslice['record_id_user']).first()
1214 recslice.update({'PI':[recuser.hrn],
1215 'researcher': [recuser.hrn],
1216 'name':record['hrn'],
1217 'oar_job_id':recslice['oar_job_id'],
1219 'person_ids':[recslice['record_id_user']]})
1221 #GetPersons takes [] as filters
1222 #user_slab = self.GetPersons([{'hrn':recuser.hrn}])
1223 user_slab = self.GetPersons([record])
1225 recslice.update({'type':'slice', \
1226 'hrn':recslice['slice_hrn']})
1227 record.update(user_slab[0])
1228 #For client_helper.py compatibility
1229 record.update( { 'geni_urn':'',
1232 record_list.append(recslice)
1234 logger.debug("SLABDRIVER.PY \tfill_record_info ADDING SLICE\
1235 INFO TO USER records %s" %(record_list))
1238 except TypeError, error:
1239 logger.log_exc("SLABDRIVER \t fill_record_info EXCEPTION %s"\
1244 #self.fill_record_slab_info(records)
1250 #TODO Update membership? update_membership_list SA 05/07/12
1251 #def update_membership_list(self, oldRecord, record, listName, addFunc, \
1253 ## get a list of the HRNs tht are members of the old and new records
1255 #oldList = oldRecord.get(listName, [])
1258 #newList = record.get(listName, [])
1260 ## if the lists are the same, then we don't have to update anything
1261 #if (oldList == newList):
1264 ## build a list of the new person ids, by looking up each person to get
1268 #records = table.find({'type': 'user', 'hrn': newList})
1269 #for rec in records:
1270 #newIdList.append(rec['pointer'])
1272 ## build a list of the old person ids from the person_ids field
1274 #oldIdList = oldRecord.get("person_ids", [])
1275 #containerId = oldRecord.get_pointer()
1277 ## if oldRecord==None, then we are doing a Register, instead of an
1280 #containerId = record.get_pointer()
1282 ## add people who are in the new list, but not the oldList
1283 #for personId in newIdList:
1284 #if not (personId in oldIdList):
1285 #addFunc(self.plauth, personId, containerId)
1287 ## remove people who are in the old list, but not the new list
1288 #for personId in oldIdList:
1289 #if not (personId in newIdList):
1290 #delFunc(self.plauth, personId, containerId)
1292 #def update_membership(self, oldRecord, record):
1294 #if record.type == "slice":
1295 #self.update_membership_list(oldRecord, record, 'researcher',
1296 #self.users.AddPersonToSlice,
1297 #self.users.DeletePersonFromSlice)
1298 #elif record.type == "authority":
1303 # I don't think you plan on running a component manager at this point
1304 # let me clean up the mess of ComponentAPI that is deprecated anyways
1307 #TODO FUNCTIONS SECTION 04/07/2012 SA
1309 #TODO : Is UnBindObjectFromPeer still necessary ? Currently does nothing
1311 def UnBindObjectFromPeer(self, auth, object_type, object_id, shortname):
1312 """ This method is a hopefully temporary hack to let the sfa correctly
1313 detach the objects it creates from a remote peer object. This is
1314 needed so that the sfa federation link can work in parallel with
1315 RefreshPeer, as RefreshPeer depends on remote objects being correctly
1318 auth : struct, API authentication structure
1319 AuthMethod : string, Authentication method to use
1320 object_type : string, Object type, among 'site','person','slice',
1322 object_id : int, object_id
1323 shortname : string, peer shortname
1327 logger.warning("SLABDRIVER \tUnBindObjectFromPeer EMPTY-\
1331 #TODO Is BindObjectToPeer still necessary ? Currently does nothing
1333 def BindObjectToPeer(self, auth, object_type, object_id, shortname=None, \
1334 remote_object_id=None):
1335 """This method is a hopefully temporary hack to let the sfa correctly
1336 attach the objects it creates to a remote peer object. This is needed
1337 so that the sfa federation link can work in parallel with RefreshPeer,
1338 as RefreshPeer depends on remote objects being correctly marked.
1340 shortname : string, peer shortname
1341 remote_object_id : int, remote object_id, set to 0 if unknown
1345 logger.warning("SLABDRIVER \tBindObjectToPeer EMPTY - DO NOTHING \r\n ")
1348 #TODO UpdateSlice 04/07/2012 SA
1349 #Funciton should delete and create another job since oin senslab slice=job
1350 def UpdateSlice(self, auth, slice_id_or_name, slice_fields=None):
1351 """Updates the parameters of an existing slice with the values in
1353 Users may only update slices of which they are members.
1354 PIs may update any of the slices at their sites, or any slices of
1355 which they are members. Admins may update any slice.
1356 Only PIs and admins may update max_nodes. Slices cannot be renewed
1357 (by updating the expires parameter) more than 8 weeks into the future.
1358 Returns 1 if successful, faults otherwise.
1362 logger.warning("SLABDRIVER UpdateSlice EMPTY - DO NOTHING \r\n ")
1365 #TODO UpdatePerson 04/07/2012 SA
1366 def UpdatePerson(self, auth, person_id_or_email, person_fields=None):
1367 """Updates a person. Only the fields specified in person_fields
1368 are updated, all other fields are left untouched.
1369 Users and techs can only update themselves. PIs can only update
1370 themselves and other non-PIs at their sites.
1371 Returns 1 if successful, faults otherwise.
1375 logger.warning("SLABDRIVER UpdatePerson EMPTY - DO NOTHING \r\n ")
1378 #TODO GetKeys 04/07/2012 SA
1379 def GetKeys(self, auth, key_filter=None, return_fields=None):
1380 """Returns an array of structs containing details about keys.
1381 If key_filter is specified and is an array of key identifiers,
1382 or a struct of key attributes, only keys matching the filter
1383 will be returned. If return_fields is specified, only the
1384 specified details will be returned.
1386 Admin may query all keys. Non-admins may only query their own keys.
1390 logger.warning("SLABDRIVER GetKeys EMPTY - DO NOTHING \r\n ")
1393 #TODO DeleteKey 04/07/2012 SA
1394 def DeleteKey(self, auth, key_id):
1396 Non-admins may only delete their own keys.
1397 Returns 1 if successful, faults otherwise.
1401 logger.warning("SLABDRIVER DeleteKey EMPTY - DO NOTHING \r\n ")
1405 #TODO : Check rights to delete person
1406 def DeletePerson(self, auth, person_record):
1407 """ Disable an existing account in senslab LDAP.
1408 Users and techs can only delete themselves. PIs can only
1409 delete themselves and other non-PIs at their sites.
1410 ins can delete anyone.
1411 Returns 1 if successful, faults otherwise.
1415 #Disable user account in senslab LDAP
1416 ret = self.ldap.LdapMarkUserAsDeleted(person_record)
1417 logger.warning("SLABDRIVER DeletePerson %s " %(person_record))
1420 #TODO Check DeleteSlice, check rights 05/07/2012 SA
1421 def DeleteSlice(self, auth, slice_record):
1422 """ Deletes the specified slice.
1423 Senslab : Kill the job associated with the slice if there is one
1424 using DeleteSliceFromNodes.
1425 Updates the slice record in slab db to remove the slice nodes.
1427 Users may only delete slices of which they are members. PIs may
1428 delete any of the slices at their sites, or any slices of which
1429 they are members. Admins may delete any slice.
1430 Returns 1 if successful, faults otherwise.
1434 self.DeleteSliceFromNodes(slice_record)
1435 self.db.update_job(slice_record['hrn'], job_id = -1, nodes = [])
1436 logger.warning("SLABDRIVER DeleteSlice %s "%(slice_record))
1439 #TODO AddPerson 04/07/2012 SA
1440 def AddPerson(self, auth, person_fields=None):
1441 """Adds a new account. Any fields specified in person_fields are used,
1442 otherwise defaults are used.
1443 Accounts are disabled by default. To enable an account,
1445 Returns the new person_id (> 0) if successful, faults otherwise.
1449 logger.warning("SLABDRIVER AddPerson EMPTY - DO NOTHING \r\n ")
1452 #TODO AddPersonToSite 04/07/2012 SA
1453 def AddPersonToSite (self, auth, person_id_or_email, \
1454 site_id_or_login_base=None):
1455 """ Adds the specified person to the specified site. If the person is
1456 already a member of the site, no errors are returned. Does not change
1457 the person's primary site.
1458 Returns 1 if successful, faults otherwise.
1462 logger.warning("SLABDRIVER AddPersonToSite EMPTY - DO NOTHING \r\n ")
1465 #TODO AddRoleToPerson : Not sure if needed in senslab 04/07/2012 SA
1466 def AddRoleToPerson(self, auth, role_id_or_name, person_id_or_email):
1467 """Grants the specified role to the person.
1468 PIs can only grant the tech and user roles to users and techs at their
1469 sites. Admins can grant any role to any user.
1470 Returns 1 if successful, faults otherwise.
1474 logger.warning("SLABDRIVER AddRoleToPerson EMPTY - DO NOTHING \r\n ")
1477 #TODO AddPersonKey 04/07/2012 SA
1478 def AddPersonKey(self, auth, person_id_or_email, key_fields=None):
1479 """Adds a new key to the specified account.
1480 Non-admins can only modify their own keys.
1481 Returns the new key_id (> 0) if successful, faults otherwise.
1485 logger.warning("SLABDRIVER AddPersonKey EMPTY - DO NOTHING \r\n ")