""" File containing the IotlabShell, used to interact with nodes, users, slices, leases and keys, as well as the dedicated iotlab database and table, holding information about which slice is running which job. """ from datetime import datetime from sfa.util.sfalogging import logger from sqlalchemy.orm import joinedload from sfa.storage.model import RegRecord, RegUser, RegSlice, RegKey from sfa.iotlab.iotlabpostgres import TestbedAdditionalSfaDB, LeaseTableXP from sfa.iotlab.OARrestapi import OARrestapi from sfa.iotlab.LDAPapi import LDAPapi from sfa.util.xrn import Xrn, hrn_to_urn, get_authority from sfa.trust.certificate import Keypair, convert_public_key from sfa.trust.gid import create_uuid from sfa.trust.hierarchy import Hierarchy from sfa.iotlab.iotlabxrn import xrn_object class IotlabShell(): """ Class enabled to use LDAP and OAR api calls. """ _MINIMUM_DURATION = 10 # 10 units of granularity 60 s, 10 mins def __init__(self, api): """Creates an instance of OARrestapi and LDAPapi which will be used to issue calls to OAR or LDAP methods. Set the time format and the testbed granularity used for OAR reservation and leases. :param config: configuration object from sfa.util.config :type config: Config object """ self.api=api config=api.config self.leases_db = TestbedAdditionalSfaDB(config) self.oar = OARrestapi() self.ldap = LDAPapi() self.time_format = "%Y-%m-%d %H:%M:%S" self.root_auth = config.SFA_REGISTRY_ROOT_AUTH self.grain = 60 # 10 mins lease minimum, 60 sec granularity #import logging, logging.handlers #from sfa.util.sfalogging import _SfaLogger #sql_logger = _SfaLogger(loggername = 'sqlalchemy.engine', \ #level=logging.DEBUG) return @staticmethod def GetMinExperimentDurationInGranularity(): """ Returns the minimum allowed duration for an experiment on the testbed. In seconds. """ return IotlabShell._MINIMUM_DURATION def GetPeers(self, peer_filter=None ): """ Gathers registered authorities in SFA DB and looks for specific peer if peer_filter is specified. :param peer_filter: name of the site authority looked for. :type peer_filter: string :returns: list of records. """ existing_records = {} existing_hrns_by_types = {} logger.debug("IOTLAB_API \tGetPeers peer_filter %s " % (peer_filter)) all_records = self.api.dbsession().query(RegRecord).filter(RegRecord.type.like('%authority%')).all() for record in all_records: existing_records[(record.hrn, record.type)] = record if record.type not in existing_hrns_by_types: existing_hrns_by_types[record.type] = [record.hrn] else: existing_hrns_by_types[record.type].append(record.hrn) logger.debug("IOTLAB_API \tGetPeer\texisting_hrns_by_types %s " % (existing_hrns_by_types)) records_list = [] try: if peer_filter: records_list.append(existing_records[(peer_filter, 'authority')]) else: for hrn in existing_hrns_by_types['authority']: records_list.append(existing_records[(hrn, 'authority')]) logger.debug("IOTLAB_API \tGetPeer \trecords_list %s " % (records_list)) except KeyError: pass return_records = records_list logger.debug("IOTLAB_API \tGetPeer return_records %s " % (return_records)) return return_records #TODO : Handling OR request in make_ldap_filters_from_records #instead of the for loop #over the records' list def GetPersons(self, person_filter=None): """ Get the enabled users and their properties from Iotlab LDAP. If a filter is specified, looks for the user whose properties match the filter, otherwise returns the whole enabled users'list. :param person_filter: Must be a list of dictionnaries with users properties when not set to None. :type person_filter: list of dict :returns: Returns a list of users whose accounts are enabled found in ldap. :rtype: list of dicts """ logger.debug("IOTLAB_API \tGetPersons person_filter %s" % (person_filter)) person_list = [] if person_filter and isinstance(person_filter, list): #If we are looking for a list of users (list of dict records) #Usually the list contains only one user record for searched_attributes in person_filter: #Get only enabled user accounts in iotlab LDAP : #add a filter for make_ldap_filters_from_record person = self.ldap.LdapFindUser(searched_attributes, is_user_enabled=True) #If a person was found, append it to the list if person: person_list.append(person) #If the list is empty, return None if len(person_list) is 0: person_list = None else: #Get only enabled user accounts in iotlab LDAP : #add a filter for make_ldap_filters_from_record person_list = self.ldap.LdapFindUser(is_user_enabled=True) return person_list #def GetTimezone(self): #""" Returns the OAR server time and timezone. #Unused SA 30/05/13""" #server_timestamp, server_tz = self.oar.parser.\ #SendRequest("GET_timezone") #return server_timestamp, server_tz def DeleteJobs(self, job_id, username): """ Deletes the job with the specified job_id and username on OAR by posting a delete request to OAR. :param job_id: job id in OAR. :param username: user's iotlab login in LDAP. :type job_id: integer :type username: string :returns: dictionary with the job id and if delete has been successful (True) or no (False) :rtype: dict """ logger.debug("IOTLAB_API \tDeleteJobs jobid %s username %s " % (job_id, username)) if not job_id or job_id is -1: return reqdict = {} reqdict['method'] = "delete" reqdict['strval'] = str(job_id) answer = self.oar.POSTRequestToOARRestAPI('DELETE_jobs_id', reqdict, username) if answer['status'] == 'Delete request registered': ret = {job_id: True} else: ret = {job_id: False} logger.debug("IOTLAB_API \tDeleteJobs jobid %s \r\n answer %s \ username %s" % (job_id, answer, username)) return ret ##TODO : Unused GetJobsId ? SA 05/07/12 #def GetJobsId(self, job_id, username = None ): #""" #Details about a specific job. #Includes details about submission time, jot type, state, events, #owner, assigned ressources, walltime etc... #""" #req = "GET_jobs_id" #node_list_k = 'assigned_network_address' ##Get job info from OAR #job_info = self.oar.parser.SendRequest(req, job_id, username) #logger.debug("IOTLAB_API \t GetJobsId %s " %(job_info)) #try: #if job_info['state'] == 'Terminated': #logger.debug("IOTLAB_API \t GetJobsId job %s TERMINATED"\ #%(job_id)) #return None #if job_info['state'] == 'Error': #logger.debug("IOTLAB_API \t GetJobsId ERROR message %s "\ #%(job_info)) #return None #except KeyError: #logger.error("IOTLAB_API \tGetJobsId KeyError") #return None #parsed_job_info = self.get_info_on_reserved_nodes(job_info, \ #node_list_k) ##Replaces the previous entry ##"assigned_network_address" / "reserved_resources" ##with "node_ids" #job_info.update({'node_ids':parsed_job_info[node_list_k]}) #del job_info[node_list_k] #logger.debug(" \r\nIOTLAB_API \t GetJobsId job_info %s " %(job_info)) #return job_info def GetJobsResources(self, job_id, username = None): """ Gets the list of nodes associated with the job_id and username if provided. Transforms the iotlab hostnames to the corresponding SFA nodes hrns. Rertuns dict key :'node_ids' , value : hostnames list :param username: user's LDAP login :paran job_id: job's OAR identifier. :type username: string :type job_id: integer :returns: dicionary with nodes' hostnames belonging to the job. :rtype: dict .. warning: Unused. SA 16/10/13 """ req = "GET_jobs_id_resources" #Get job resources list from OAR node_id_list = self.oar.parser.SendRequest(req, job_id, username) logger.debug("IOTLAB_API \t GetJobsResources %s " %(node_id_list)) hostname_list = \ self.__get_hostnames_from_oar_node_ids(node_id_list) #Replaces the previous entry "assigned_network_address" / #"reserved_resources" with "node_ids" job_info = {'node_ids': hostname_list} return job_info #def get_info_on_reserved_nodes(self, job_info, node_list_name): #""" #..warning:unused SA 23/05/13 #""" ##Get the list of the testbed nodes records and make a ##dictionnary keyed on the hostname out of it #node_list_dict = self.GetNodes() ##node_hostname_list = [] #node_hostname_list = [node['hostname'] for node in node_list_dict] ##for node in node_list_dict: ##node_hostname_list.append(node['hostname']) #node_dict = dict(zip(node_hostname_list, node_list_dict)) #try : #reserved_node_hostname_list = [] #for index in range(len(job_info[node_list_name])): ##job_info[node_list_name][k] = #reserved_node_hostname_list[index] = \ #node_dict[job_info[node_list_name][index]]['hostname'] #logger.debug("IOTLAB_API \t get_info_on_reserved_nodes \ #reserved_node_hostname_list %s" \ #%(reserved_node_hostname_list)) #except KeyError: #logger.error("IOTLAB_API \t get_info_on_reserved_nodes KEYERROR " ) #return reserved_node_hostname_list def GetNodesCurrentlyInUse(self): """Returns a list of all the nodes already involved in an oar running job. :rtype: list of nodes hostnames. """ return self.oar.parser.SendRequest("GET_running_jobs") def __get_hostnames_from_oar_node_ids(self, oar_id_node_dict, resource_id_list ): """Get the hostnames of the nodes from their OAR identifiers. Get the list of nodes dict using GetNodes and find the hostname associated with the identifier. :param oar_id_node_dict: full node dictionary list keyed by oar node id :param resource_id_list: list of nodes identifiers :returns: list of node hostnames. """ hostname_list = [] for resource_id in resource_id_list: #Because jobs requested "asap" do not have defined resources if resource_id is not "Undefined": hostname_list.append(\ oar_id_node_dict[resource_id]['hostname']) #hostname_list.append(oar_id_node_dict[resource_id]['hostname']) return hostname_list def GetReservedNodes(self, username=None): """ Get list of leases. Get the leases for the username if specified, otherwise get all the leases. Finds the nodes hostnames for each OAR node identifier. :param username: user's LDAP login :type username: string :returns: list of reservations dict :rtype: dict list """ #Get the nodes in use and the reserved nodes reservation_dict_list = \ self.oar.parser.SendRequest("GET_reserved_nodes", \ username = username) # Get the full node dict list once for all # so that we can get the hostnames given their oar node id afterwards # when the reservations are checked. full_nodes_dict_list = self.GetNodes() #Put the full node list into a dictionary keyed by oar node id oar_id_node_dict = {} for node in full_nodes_dict_list: oar_id_node_dict[node['oar_id']] = node for resa in reservation_dict_list: logger.debug ("GetReservedNodes resa %s"%(resa)) #dict list of hostnames and their site resa['reserved_nodes'] = \ self.__get_hostnames_from_oar_node_ids(oar_id_node_dict, resa['resource_ids']) #del resa['resource_ids'] return reservation_dict_list def GetNodes(self, node_filter_dict=None, return_fields_list=None): """ Make a list of iotlab nodes and their properties from information given by OAR. Search for specific nodes if some filters are specified. Nodes properties returned if no return_fields_list given: 'hrn','archi','mobile','hostname','site','boot_state','node_id', 'radio','posx','posy','oar_id','posz'. :param node_filter_dict: dictionnary of lists with node properties. For instance, if you want to look for a specific node with its hrn, the node_filter_dict should be {'hrn': [hrn_of_the_node]} :type node_filter_dict: dict :param return_fields_list: list of specific fields the user wants to be returned. :type return_fields_list: list :returns: list of dictionaries with node properties :rtype: list """ node_dict_by_id = self.oar.parser.SendRequest("GET_resources_full") node_dict_list = node_dict_by_id.values() logger.debug (" IOTLAB_API GetNodes node_filter_dict %s \ return_fields_list %s " % (node_filter_dict, return_fields_list)) #No filtering needed return the list directly if not (node_filter_dict or return_fields_list): return node_dict_list return_node_list = [] if node_filter_dict: for filter_key in node_filter_dict: try: #Filter the node_dict_list by each value contained in the #list node_filter_dict[filter_key] for value in node_filter_dict[filter_key]: for node in node_dict_list: if node[filter_key] == value: if return_fields_list: tmp = {} for k in return_fields_list: tmp[k] = node[k] return_node_list.append(tmp) else: return_node_list.append(node) except KeyError: logger.log_exc("GetNodes KeyError") return return return_node_list def AddSlice(self, slice_record, user_record): """ Add slice to the local iotlab sfa tables if the slice comes from a federated site and is not yet in the iotlab sfa DB, although the user has already a LDAP login. Called by verify_slice during lease/sliver creation. :param slice_record: record of slice, must contain hrn, gid, slice_id and authority of the slice. :type slice_record: dictionary :param user_record: record of the user :type user_record: RegUser """ sfa_record = RegSlice(hrn=slice_record['hrn'], gid=slice_record['gid'], pointer=slice_record['slice_id'], authority=slice_record['authority']) logger.debug("IOTLAB_API.PY AddSlice sfa_record %s user_record %s" % (sfa_record, user_record)) sfa_record.just_created() self.api.dbsession().add(sfa_record) self.api.dbsession().commit() #Update the reg-researcher dependance table sfa_record.reg_researchers = [user_record] self.api.dbsession().commit() return def GetSites(self, site_filter_name_list=None, return_fields_list=None): """Returns the list of Iotlab's sites with the associated nodes and the sites' properties as dictionaries. Site properties: ['address_ids', 'slice_ids', 'name', 'node_ids', 'url', 'person_ids', 'site_tag_ids', 'enabled', 'site', 'longitude', 'pcu_ids', 'max_slivers', 'max_slices', 'ext_consortium_id', 'date_created', 'latitude', 'is_public', 'peer_site_id', 'peer_id', 'abbreviated_name'] Uses the OAR request GET_sites to find the Iotlab's sites. :param site_filter_name_list: used to specify specific sites :param return_fields_list: field that has to be returned :type site_filter_name_list: list :type return_fields_list: list """ site_dict = self.oar.parser.SendRequest("GET_sites") #site_dict : dict where the key is the sit ename return_site_list = [] if not (site_filter_name_list or return_fields_list): return_site_list = site_dict.values() return return_site_list for site_filter_name in site_filter_name_list: if site_filter_name in site_dict: if return_fields_list: for field in return_fields_list: tmp = {} try: tmp[field] = site_dict[site_filter_name][field] except KeyError: logger.error("GetSites KeyError %s " % (field)) return None return_site_list.append(tmp) else: return_site_list.append(site_dict[site_filter_name]) return return_site_list #TODO : Check rights to delete person def DeletePerson(self, person_record): """Disable an existing account in iotlab LDAP. Users and techs can only delete themselves. PIs can only delete themselves and other non-PIs at their sites. ins can delete anyone. :param person_record: user's record :type person_record: dict :returns: True if successful, False otherwise. :rtype: boolean .. todo:: CHECK THAT ONLY THE USER OR ADMIN CAN DEL HIMSELF. """ #Disable user account in iotlab LDAP ret = self.ldap.LdapMarkUserAsDeleted(person_record) logger.warning("IOTLAB_API DeletePerson %s " % (person_record)) return ret['bool'] def DeleteSlice(self, slice_record): """Deletes the specified slice and kills the jobs associated with the slice if any, using DeleteSliceFromNodes. :param slice_record: record of the slice, must contain oar_job_id, user :type slice_record: dict :returns: True if all the jobs in the slice have been deleted, or the list of jobs that could not be deleted otherwise. :rtype: list or boolean .. seealso:: DeleteSliceFromNodes """ ret = self.DeleteSliceFromNodes(slice_record) delete_failed = None for job_id in ret: if False in ret[job_id]: if delete_failed is None: delete_failed = [] delete_failed.append(job_id) logger.info("IOTLAB_API DeleteSlice %s answer %s"%(slice_record, \ delete_failed)) return delete_failed or True def __add_person_to_db(self, user_dict): """ Add a federated user straight to db when the user issues a lease request with iotlab nodes and that he has not registered with iotlab yet (that is he does not have a LDAP entry yet). Uses parts of the routines in IotlabImport when importing user from LDAP. Called by AddPerson, right after LdapAddUser. :param user_dict: Must contain email, hrn and pkey to get a GID and be added to the SFA db. :type user_dict: dict """ check_if_exists = \ self.api.dbsession().query(RegUser).filter_by(email = user_dict['email']).first() #user doesn't exists if not check_if_exists: logger.debug("__add_person_to_db \t Adding %s \r\n \r\n \ " %(user_dict)) hrn = user_dict['hrn'] person_urn = hrn_to_urn(hrn, 'user') pubkey = user_dict['pkey'] try: pkey = convert_public_key(pubkey) except TypeError: #key not good. create another pkey logger.warn('__add_person_to_db: unable to convert public \ key for %s' %(hrn )) pkey = Keypair(create=True) if pubkey is not None and pkey is not None : hierarchy = Hierarchy() person_gid = hierarchy.create_gid(person_urn, create_uuid(), \ pkey) if user_dict['email']: logger.debug("__add_person_to_db \r\n \r\n \ IOTLAB IMPORTER PERSON EMAIL OK email %s "\ %(user_dict['email'])) person_gid.set_email(user_dict['email']) user_record = RegUser(hrn=hrn , pointer= '-1', \ authority=get_authority(hrn), \ email=user_dict['email'], gid = person_gid) user_record.reg_keys = [RegKey(user_dict['pkey'])] user_record.just_created() self.api.dbsession().add (user_record) self.api.dbsession().commit() return def AddPerson(self, record): """ Adds a new account. Any fields specified in records are used, otherwise defaults are used. Creates an appropriate login by calling LdapAddUser. :param record: dictionary with the sfa user's properties. :returns: a dicitonary with the status. If successful, the dictionary boolean is set to True and there is a 'uid' key with the new login added to LDAP, otherwise the bool is set to False and a key 'message' is in the dictionary, with the error message. :rtype: dict """ ret = self.ldap.LdapAddUser(record) if ret['bool'] is True: record['hrn'] = self.root_auth + '.' + ret['uid'] logger.debug("IOTLAB_API AddPerson return code %s record %s " % (ret, record)) self.__add_person_to_db(record) return ret #TODO AddPersonKey 04/07/2012 SA def AddPersonKey(self, person_uid, old_attributes_dict, new_key_dict): """Adds a new key to the specified account. Adds the key to the iotlab ldap, provided that the person_uid is valid. Non-admins can only modify their own keys. :param person_uid: user's iotlab login in LDAP :param old_attributes_dict: dict with the user's old sshPublicKey :param new_key_dict: dict with the user's new sshPublicKey :type person_uid: string :rtype: Boolean :returns: True if the key has been modified, False otherwise. """ ret = self.ldap.LdapModify(person_uid, old_attributes_dict, \ new_key_dict) logger.warning("IOTLAB_API AddPersonKey EMPTY - DO NOTHING \r\n ") return ret['bool'] def DeleteLeases(self, leases_id_list, slice_hrn): """ Deletes several leases, based on their job ids and the slice they are associated with. Uses DeleteJobs to delete the jobs on OAR. Note that one slice can contain multiple jobs, and in this case all the jobs in the leases_id_list MUST belong to ONE slice, since there is only one slice hrn provided here. :param leases_id_list: list of job ids that belong to the slice whose slice hrn is provided. :param slice_hrn: the slice hrn. :type slice_hrn: string .. warning:: Does not have a return value since there was no easy way to handle failure when dealing with multiple job delete. Plus, there was no easy way to report it to the user. """ logger.debug("IOTLAB_API DeleteLeases leases_id_list %s slice_hrn %s \ \r\n " %(leases_id_list, slice_hrn)) for job_id in leases_id_list: self.DeleteJobs(job_id, slice_hrn) return @staticmethod def _process_walltime(duration): """ Calculates the walltime in seconds from the duration in H:M:S specified in the RSpec. """ if duration: # Fixing the walltime by adding a few delays. # First put the walltime in seconds oarAdditionalDelay = 20; # additional delay for /bin/sleep command to # take in account prologue and epilogue scripts execution # int walltimeAdditionalDelay = 240; additional delay #for prologue/epilogue execution = $SERVER_PROLOGUE_EPILOGUE_TIMEOUT #in oar.conf # Put the duration in seconds first #desired_walltime = duration * 60 desired_walltime = duration total_walltime = desired_walltime + 240 #+4 min Update SA 23/10/12 sleep_walltime = desired_walltime # 0 sec added Update SA 23/10/12 walltime = [] #Put the walltime back in str form #First get the hours walltime.append(str(total_walltime / 3600)) total_walltime = total_walltime - 3600 * int(walltime[0]) #Get the remaining minutes walltime.append(str(total_walltime / 60)) total_walltime = total_walltime - 60 * int(walltime[1]) #Get the seconds walltime.append(str(total_walltime)) else: logger.log_exc(" __process_walltime duration null") return walltime, sleep_walltime @staticmethod def _create_job_structure_request_for_OAR(lease_dict): """ Creates the structure needed for a correct POST on OAR. Makes the timestamp transformation into the appropriate format. Sends the POST request to create the job with the resources in added_nodes. """ nodeid_list = [] reqdict = {} reqdict['workdir'] = '/tmp' reqdict['resource'] = "{network_address in (" for node in lease_dict['added_nodes']: logger.debug("\r\n \r\n OARrestapi \t \ __create_job_structure_request_for_OAR node %s" %(node)) # Get the ID of the node nodeid = node reqdict['resource'] += "'" + nodeid + "', " nodeid_list.append(nodeid) custom_length = len(reqdict['resource'])- 2 reqdict['resource'] = reqdict['resource'][0:custom_length] + \ ")}/nodes=" + str(len(nodeid_list)) walltime, sleep_walltime = \ IotlabShell._process_walltime(\ int(lease_dict['lease_duration'])) reqdict['resource'] += ",walltime=" + str(walltime[0]) + \ ":" + str(walltime[1]) + ":" + str(walltime[2]) reqdict['script_path'] = "/bin/sleep " + str(sleep_walltime) #In case of a scheduled experiment (not immediate) #To run an XP immediately, don't specify date and time in RSpec #They will be set to None. if lease_dict['lease_start_time'] is not '0': #Readable time accepted by OAR start_time = datetime.fromtimestamp( \ int(lease_dict['lease_start_time'])).\ strftime(lease_dict['time_format']) reqdict['reservation'] = start_time #If there is not start time, Immediate XP. No need to add special # OAR parameters reqdict['type'] = "deploy" reqdict['directory'] = "" reqdict['name'] = "SFA_" + lease_dict['slice_user'] return reqdict def LaunchExperimentOnOAR(self, added_nodes, slice_name, \ lease_start_time, lease_duration, slice_user=None): """ Create a job request structure based on the information provided and post the job on OAR. :param added_nodes: list of nodes that belong to the described lease. :param slice_name: the slice hrn associated to the lease. :param lease_start_time: timestamp of the lease startting time. :param lease_duration: lease durationin minutes """ lease_dict = {} lease_dict['lease_start_time'] = lease_start_time lease_dict['lease_duration'] = lease_duration lease_dict['added_nodes'] = added_nodes lease_dict['slice_name'] = slice_name lease_dict['slice_user'] = slice_user lease_dict['grain'] = self.GetLeaseGranularity() lease_dict['time_format'] = self.time_format logger.debug("IOTLAB_API.PY \tLaunchExperimentOnOAR slice_user %s\ \r\n " %(slice_user)) #Create the request for OAR reqdict = self._create_job_structure_request_for_OAR(lease_dict) # first step : start the OAR job and update the job logger.debug("IOTLAB_API.PY \tLaunchExperimentOnOAR reqdict %s\ \r\n " %(reqdict)) answer = self.oar.POSTRequestToOARRestAPI('POST_job', \ reqdict, slice_user) logger.debug("IOTLAB_API \tLaunchExperimentOnOAR jobid %s " %(answer)) try: jobid = answer['id'] except KeyError: logger.log_exc("IOTLAB_API \tLaunchExperimentOnOAR \ Impossible to create job %s " %(answer)) return None if jobid : logger.debug("IOTLAB_API \tLaunchExperimentOnOAR jobid %s \ added_nodes %s slice_user %s" %(jobid, added_nodes, \ slice_user)) return jobid def AddLeases(self, hostname_list, slice_record, lease_start_time, lease_duration): """Creates a job in OAR corresponding to the information provided as parameters. Adds the job id and the slice hrn in the iotlab database so that we are able to know which slice has which nodes. :param hostname_list: list of nodes' OAR hostnames. :param slice_record: sfa slice record, must contain login and hrn. :param lease_start_time: starting time , unix timestamp format :param lease_duration: duration in minutes :type hostname_list: list :type slice_record: dict :type lease_start_time: integer :type lease_duration: integer """ logger.debug("IOTLAB_API \r\n \r\n \t AddLeases hostname_list %s \ slice_record %s lease_start_time %s lease_duration %s "\ %( hostname_list, slice_record , lease_start_time, \ lease_duration)) #tmp = slice_record['reg-researchers'][0].split(".") username = slice_record['login'] #username = tmp[(len(tmp)-1)] job_id = self.LaunchExperimentOnOAR(hostname_list, \ slice_record['hrn'], \ lease_start_time, lease_duration, \ username) start_time = \ datetime.fromtimestamp(int(lease_start_time)).\ strftime(self.time_format) end_time = lease_start_time + lease_duration logger.debug("IOTLAB_API \r\n \r\n \t AddLeases TURN ON LOGGING SQL \ %s %s %s "%(slice_record['hrn'], job_id, end_time)) logger.debug("IOTLAB_API \r\n \r\n \t AddLeases %s %s %s " \ %(type(slice_record['hrn']), type(job_id), type(end_time))) iotlab_ex_row = LeaseTableXP(slice_hrn = slice_record['hrn'], experiment_id=job_id, end_time= end_time) logger.debug("IOTLAB_API \r\n \r\n \t AddLeases iotlab_ex_row %s" \ %(iotlab_ex_row)) self.leases_db.testbed_session.add(iotlab_ex_row) self.leases_db.testbed_session.commit() logger.debug("IOTLAB_API \t AddLeases hostname_list start_time %s " \ %(start_time)) return #Delete the jobs from job_iotlab table def DeleteSliceFromNodes(self, slice_record): """ Deletes all the running or scheduled jobs of a given slice given its record. :param slice_record: record of the slice, must contain oar_job_id, user :type slice_record: dict :returns: dict of the jobs'deletion status. Success= True, Failure= False, for each job id. :rtype: dict """ logger.debug("IOTLAB_API \t DeleteSliceFromNodes %s " % (slice_record)) if isinstance(slice_record['oar_job_id'], list): oar_bool_answer = {} for job_id in slice_record['oar_job_id']: ret = self.DeleteJobs(job_id, slice_record['user']) oar_bool_answer.update(ret) else: oar_bool_answer = [self.DeleteJobs(slice_record['oar_job_id'], slice_record['user'])] return oar_bool_answer def GetLeaseGranularity(self): """ Returns the granularity of an experiment in the Iotlab testbed. OAR uses seconds for experiments duration , the granulaity is also defined in seconds. Experiments which last less than 10 min (600 sec) are invalid""" return self.grain @staticmethod def filter_lease_name(reservation_list, filter_value): filtered_reservation_list = list(reservation_list) logger.debug("IOTLAB_API \t filter_lease_name reservation_list %s" \ % (reservation_list)) for reservation in reservation_list: if 'slice_hrn' in reservation and \ reservation['slice_hrn'] != filter_value: filtered_reservation_list.remove(reservation) logger.debug("IOTLAB_API \t filter_lease_name filtered_reservation_list %s" \ % (filtered_reservation_list)) return filtered_reservation_list @staticmethod def filter_lease_start_time(reservation_list, filter_value): filtered_reservation_list = list(reservation_list) for reservation in reservation_list: if 't_from' in reservation and \ reservation['t_from'] > filter_value: filtered_reservation_list.remove(reservation) return filtered_reservation_list def GetLeases(self, lease_filter_dict=None, login=None): """ Get the list of leases from OAR with complete information about which slice owns which jobs and nodes. Two purposes: -Fetch all the jobs from OAR (running, waiting..) complete the reservation information with slice hrn found in testbed_xp table. If not available in the table, assume it is a iotlab slice. -Updates the iotlab table, deleting jobs when necessary. :returns: reservation_list, list of dictionaries with 'lease_id', 'reserved_nodes','slice_id', 'state', 'user', 'component_id_list', 'slice_hrn', 'resource_ids', 't_from', 't_until' :rtype: list """ unfiltered_reservation_list = self.GetReservedNodes(login) reservation_list = [] #Find the slice associated with this user iotlab ldap uid logger.debug(" IOTLAB_API.PY \tGetLeases login %s\ unfiltered_reservation_list %s " % (login, unfiltered_reservation_list)) #Create user dict first to avoid looking several times for #the same user in LDAP SA 27/07/12 job_oar_list = [] jobs_psql_query = self.leases_db.testbed_session.query(LeaseTableXP).all() jobs_psql_dict = dict([(row.experiment_id, row.__dict__) for row in jobs_psql_query]) #jobs_psql_dict = jobs_psql_dict) logger.debug("IOTLAB_API \tGetLeases jobs_psql_dict %s" % (jobs_psql_dict)) jobs_psql_id_list = [row.experiment_id for row in jobs_psql_query] for resa in unfiltered_reservation_list: logger.debug("IOTLAB_API \tGetLeases USER %s" % (resa['user'])) #Construct list of jobs (runing, waiting..) in oar job_oar_list.append(resa['lease_id']) #If there is information on the job in IOTLAB DB ] #(slice used and job id) if resa['lease_id'] in jobs_psql_dict: job_info = jobs_psql_dict[resa['lease_id']] logger.debug("IOTLAB_API \tGetLeases job_info %s" % (job_info)) resa['slice_hrn'] = job_info['slice_hrn'] resa['slice_id'] = hrn_to_urn(resa['slice_hrn'], 'slice') #otherwise, assume it is a iotlab slice: else: resa['slice_id'] = hrn_to_urn(self.root_auth + '.' + resa['user'] + "_slice", 'slice') resa['slice_hrn'] = Xrn(resa['slice_id']).get_hrn() resa['component_id_list'] = [] #Transform the hostnames into urns (component ids) for node in resa['reserved_nodes']: iotlab_xrn = xrn_object(self.root_auth, node) resa['component_id_list'].append(iotlab_xrn.urn) if lease_filter_dict: logger.debug("IOTLAB_API \tGetLeases \ \r\n leasefilter %s" % ( lease_filter_dict)) filter_dict_functions = { 'slice_hrn' : IotlabShell.filter_lease_name, 't_from' : IotlabShell.filter_lease_start_time } reservation_list = list(unfiltered_reservation_list) for filter_type in lease_filter_dict: logger.debug("IOTLAB_API \tGetLeases reservation_list %s" \ % (reservation_list)) reservation_list = filter_dict_functions[filter_type](\ reservation_list,lease_filter_dict[filter_type] ) # Filter the reservation list with a maximum timespan so that the # leases and jobs running after this timestamp do not appear # in the result leases. # if 'start_time' in : # if resa['start_time'] < lease_filter_dict['start_time']: # reservation_list.append(resa) # if 'name' in lease_filter_dict and \ # lease_filter_dict['name'] == resa['slice_hrn']: # reservation_list.append(resa) if lease_filter_dict is None: reservation_list = unfiltered_reservation_list self.leases_db.update_experiments_in_additional_sfa_db(job_oar_list, jobs_psql_id_list) logger.debug(" IOTLAB_API.PY \tGetLeases reservation_list %s" % (reservation_list)) return reservation_list #TODO FUNCTIONS SECTION 04/07/2012 SA ##TODO : Is UnBindObjectFromPeer still necessary ? Currently does nothing ##04/07/2012 SA #@staticmethod #def UnBindObjectFromPeer( auth, object_type, object_id, shortname): #""" This method is a hopefully temporary hack to let the sfa correctly #detach the objects it creates from a remote peer object. This is #needed so that the sfa federation link can work in parallel with #RefreshPeer, as RefreshPeer depends on remote objects being correctly #marked. #Parameters: #auth : struct, API authentication structure #AuthMethod : string, Authentication method to use #object_type : string, Object type, among 'site','person','slice', #'node','key' #object_id : int, object_id #shortname : string, peer shortname #FROM PLC DOC #""" #logger.warning("IOTLAB_API \tUnBindObjectFromPeer EMPTY-\ #DO NOTHING \r\n ") #return ##TODO Is BindObjectToPeer still necessary ? Currently does nothing ##04/07/2012 SA #|| Commented out 28/05/13 SA #def BindObjectToPeer(self, auth, object_type, object_id, shortname=None, \ #remote_object_id=None): #"""This method is a hopefully temporary hack to let the sfa correctly #attach the objects it creates to a remote peer object. This is needed #so that the sfa federation link can work in parallel with RefreshPeer, #as RefreshPeer depends on remote objects being correctly marked. #Parameters: #shortname : string, peer shortname #remote_object_id : int, remote object_id, set to 0 if unknown #FROM PLC API DOC #""" #logger.warning("IOTLAB_API \tBindObjectToPeer EMPTY - DO NOTHING \r\n ") #return ##TODO UpdateSlice 04/07/2012 SA || Commented out 28/05/13 SA ##Funciton should delete and create another job since oin iotlab slice=job #def UpdateSlice(self, auth, slice_id_or_name, slice_fields=None): #"""Updates the parameters of an existing slice with the values in #slice_fields. #Users may only update slices of which they are members. #PIs may update any of the slices at their sites, or any slices of #which they are members. Admins may update any slice. #Only PIs and admins may update max_nodes. Slices cannot be renewed #(by updating the expires parameter) more than 8 weeks into the future. #Returns 1 if successful, faults otherwise. #FROM PLC API DOC #""" #logger.warning("IOTLAB_API UpdateSlice EMPTY - DO NOTHING \r\n ") #return #Unused SA 30/05/13, we only update the user's key or we delete it. ##TODO UpdatePerson 04/07/2012 SA #def UpdatePerson(self, iotlab_hrn, federated_hrn, person_fields=None): #"""Updates a person. Only the fields specified in person_fields #are updated, all other fields are left untouched. #Users and techs can only update themselves. PIs can only update #themselves and other non-PIs at their sites. #Returns 1 if successful, faults otherwise. #FROM PLC API DOC #""" ##new_row = FederatedToIotlab(iotlab_hrn, federated_hrn) ##self.leases_db.testbed_session.add(new_row) ##self.leases_db.testbed_session.commit() #logger.debug("IOTLAB_API UpdatePerson EMPTY - DO NOTHING \r\n ") #return def GetKeys(self, key_filter=None): """Returns a dict of dict based on the key string. Each dict entry contains the key id, the ssh key, the user's email and the user's hrn. If key_filter is specified and is an array of key identifiers, only keys matching the filter will be returned. Admin may query all keys. Non-admins may only query their own keys. FROM PLC API DOC :returns: dict with ssh key as key and dicts as value. :rtype: dict """ if key_filter is None: keys = self.api.dbsession().query(RegKey).options(joinedload('reg_user')).all() else: keys = self.api.dbsession().query(RegKey).options(joinedload('reg_user')).filter(RegKey.key.in_(key_filter)).all() key_dict = {} for key in keys: key_dict[key.key] = {'key_id': key.key_id, 'key': key.key, 'email': key.reg_user.email, 'hrn': key.reg_user.hrn} #ldap_rslt = self.ldap.LdapSearch({'enabled']=True}) #user_by_email = dict((user[1]['mail'][0], user[1]['sshPublicKey']) \ #for user in ldap_rslt) logger.debug("IOTLAB_API GetKeys -key_dict %s \r\n " % (key_dict)) return key_dict #TODO : test def DeleteKey(self, user_record, key_string): """Deletes a key in the LDAP entry of the specified user. Removes the key_string from the user's key list and updates the LDAP user's entry with the new key attributes. :param key_string: The ssh key to remove :param user_record: User's record :type key_string: string :type user_record: dict :returns: True if sucessful, False if not. :rtype: Boolean """ all_user_keys = user_record['keys'] all_user_keys.remove(key_string) new_attributes = {'sshPublicKey':all_user_keys} ret = self.ldap.LdapModifyUser(user_record, new_attributes) logger.debug("IOTLAB_API DeleteKey %s- " % (ret)) return ret['bool'] def _sql_get_slice_info(self, slice_filter): """ Get the slice record based on the slice hrn. Fetch the record of the user associated with the slice by using joinedload based on the reg_researcher relationship. :param slice_filter: the slice hrn we are looking for :type slice_filter: string :returns: the slice record enhanced with the user's information if the slice was found, None it wasn't. :rtype: dict or None. """ #DO NOT USE RegSlice - reg_researchers to get the hrn #of the user otherwise will mess up the RegRecord in #Resolve, don't know why - SA 08/08/2012 #Only one entry for one user = one slice in testbed_xp table #slicerec = dbsession.query(RegRecord).filter_by(hrn = slice_filter).first() raw_slicerec = self.api.dbsession().query(RegSlice).options(joinedload('reg_researchers')).filter_by(hrn=slice_filter).first() #raw_slicerec = self.api.dbsession().query(RegRecord).filter_by(hrn = slice_filter).first() if raw_slicerec: #load_reg_researcher #raw_slicerec.reg_researchers raw_slicerec = raw_slicerec.__dict__ logger.debug(" IOTLAB_API \t _sql_get_slice_info slice_filter %s \ raw_slicerec %s" % (slice_filter, raw_slicerec)) slicerec = raw_slicerec #only one researcher per slice so take the first one #slicerec['reg_researchers'] = raw_slicerec['reg_researchers'] #del slicerec['reg_researchers']['_sa_instance_state'] return slicerec else: return None def _sql_get_slice_info_from_user(self, slice_filter): """ Get the slice record based on the user recordid by using a joinedload on the relationship reg_slices_as_researcher. Format the sql record into a dict with the mandatory fields for user and slice. :returns: dict with slice record and user record if the record was found based on the user's id, None if not.. :rtype:dict or None.. """ #slicerec = dbsession.query(RegRecord).filter_by(record_id = slice_filter).first() raw_slicerec = self.api.dbsession().query(RegUser).options(joinedload('reg_slices_as_researcher')).filter_by(record_id=slice_filter).first() #raw_slicerec = self.api.dbsession().query(RegRecord).filter_by(record_id = slice_filter).first() #Put it in correct order user_needed_fields = ['peer_authority', 'hrn', 'last_updated', 'classtype', 'authority', 'gid', 'record_id', 'date_created', 'type', 'email', 'pointer'] slice_needed_fields = ['peer_authority', 'hrn', 'last_updated', 'classtype', 'authority', 'gid', 'record_id', 'date_created', 'type', 'pointer'] if raw_slicerec: #raw_slicerec.reg_slices_as_researcher raw_slicerec = raw_slicerec.__dict__ slicerec = {} slicerec = \ dict([(k, raw_slicerec[ 'reg_slices_as_researcher'][0].__dict__[k]) for k in slice_needed_fields]) slicerec['reg_researchers'] = dict([(k, raw_slicerec[k]) for k in user_needed_fields]) #TODO Handle multiple slices for one user SA 10/12/12 #for now only take the first slice record associated to the rec user ##slicerec = raw_slicerec['reg_slices_as_researcher'][0].__dict__ #del raw_slicerec['reg_slices_as_researcher'] #slicerec['reg_researchers'] = raw_slicerec ##del slicerec['_sa_instance_state'] return slicerec else: return None def _get_slice_records(self, slice_filter=None, slice_filter_type=None): """ Get the slice record depending on the slice filter and its type. :param slice_filter: Can be either the slice hrn or the user's record id. :type slice_filter: string :param slice_filter_type: describes the slice filter type used, can be slice_hrn or record_id_user :type: string :returns: the slice record :rtype:dict .. seealso::_sql_get_slice_info_from_user .. seealso:: _sql_get_slice_info """ #Get list of slices based on the slice hrn if slice_filter_type == 'slice_hrn': #if get_authority(slice_filter) == self.root_auth: #login = slice_filter.split(".")[1].split("_")[0] slicerec = self._sql_get_slice_info(slice_filter) if slicerec is None: return None #return login, None #Get slice based on user id if slice_filter_type == 'record_id_user': slicerec = self._sql_get_slice_info_from_user(slice_filter) if slicerec: fixed_slicerec_dict = slicerec #At this point if there is no login it means #record_id_user filter has been used for filtering #if login is None : ##If theslice record is from iotlab #if fixed_slicerec_dict['peer_authority'] is None: #login = fixed_slicerec_dict['hrn'].split(".")[1].split("_")[0] #return login, fixed_slicerec_dict return fixed_slicerec_dict else: return None def GetSlices(self, slice_filter=None, slice_filter_type=None, login=None): """Get the slice records from the iotlab db and add lease information if any. :param slice_filter: can be the slice hrn or slice record id in the db depending on the slice_filter_type. :param slice_filter_type: defines the type of the filtering used, Can be either 'slice_hrn' or "record_id'. :type slice_filter: string :type slice_filter_type: string :returns: a slice dict if slice_filter and slice_filter_type are specified and a matching entry is found in the db. The result is put into a list.Or a list of slice dictionnaries if no filters arespecified. :rtype: list """ #login = None authorized_filter_types_list = ['slice_hrn', 'record_id_user'] return_slicerec_dictlist = [] #First try to get information on the slice based on the filter provided if slice_filter_type in authorized_filter_types_list: fixed_slicerec_dict = self._get_slice_records(slice_filter, slice_filter_type) # if the slice was not found in the sfa db if fixed_slicerec_dict is None: return return_slicerec_dictlist slice_hrn = fixed_slicerec_dict['hrn'] logger.debug(" IOTLAB_API \tGetSlices login %s \ slice record %s slice_filter %s \ slice_filter_type %s " % (login, fixed_slicerec_dict, slice_filter, slice_filter_type)) #Now we have the slice record fixed_slicerec_dict, get the #jobs associated to this slice leases_list = [] leases_list = self.GetLeases(login=login) #If no job is running or no job scheduled #return only the slice record if leases_list == [] and fixed_slicerec_dict: return_slicerec_dictlist.append(fixed_slicerec_dict) # if the jobs running don't belong to the user/slice we are looking # for leases_hrn = [lease['slice_hrn'] for lease in leases_list] if slice_hrn not in leases_hrn: return_slicerec_dictlist.append(fixed_slicerec_dict) #If several jobs for one slice , put the slice record into # each lease information dict for lease in leases_list: slicerec_dict = {} logger.debug("IOTLAB_API.PY \tGetSlices slice_filter %s \ \t lease['slice_hrn'] %s" % (slice_filter, lease['slice_hrn'])) if lease['slice_hrn'] == slice_hrn: slicerec_dict['oar_job_id'] = lease['lease_id'] #Update lease dict with the slice record if fixed_slicerec_dict: fixed_slicerec_dict['oar_job_id'] = [] fixed_slicerec_dict['oar_job_id'].append( slicerec_dict['oar_job_id']) slicerec_dict.update(fixed_slicerec_dict) #slicerec_dict.update({'hrn':\ #str(fixed_slicerec_dict['slice_hrn'])}) slicerec_dict['slice_hrn'] = lease['slice_hrn'] slicerec_dict['hrn'] = lease['slice_hrn'] slicerec_dict['user'] = lease['user'] slicerec_dict.update( {'list_node_ids': {'hostname': lease['reserved_nodes']}}) slicerec_dict.update({'node_ids': lease['reserved_nodes']}) return_slicerec_dictlist.append(slicerec_dict) logger.debug("IOTLAB_API.PY \tGetSlices \ OHOHOHOH %s" %(return_slicerec_dictlist)) logger.debug("IOTLAB_API.PY \tGetSlices \ slicerec_dict %s return_slicerec_dictlist %s \ lease['reserved_nodes'] \ %s" % (slicerec_dict, return_slicerec_dictlist, lease['reserved_nodes'])) logger.debug("IOTLAB_API.PY \tGetSlices RETURN \ return_slicerec_dictlist %s" % (return_slicerec_dictlist)) return return_slicerec_dictlist else: #Get all slices from the iotlab sfa database , #put them in dict format #query_slice_list = dbsession.query(RegRecord).all() query_slice_list = \ self.api.dbsession().query(RegSlice).options(joinedload('reg_researchers')).all() for record in query_slice_list: tmp = record.__dict__ tmp['reg_researchers'] = tmp['reg_researchers'][0].__dict__ #del tmp['reg_researchers']['_sa_instance_state'] return_slicerec_dictlist.append(tmp) #return_slicerec_dictlist.append(record.__dict__) #Get all the jobs reserved nodes leases_list = self.GetReservedNodes() for fixed_slicerec_dict in return_slicerec_dictlist: slicerec_dict = {} #Check if the slice belongs to a iotlab user if fixed_slicerec_dict['peer_authority'] is None: owner = fixed_slicerec_dict['hrn'].split( ".")[1].split("_")[0] else: owner = None for lease in leases_list: if owner == lease['user']: slicerec_dict['oar_job_id'] = lease['lease_id'] #for reserved_node in lease['reserved_nodes']: logger.debug("IOTLAB_API.PY \tGetSlices lease %s " % (lease)) slicerec_dict.update(fixed_slicerec_dict) slicerec_dict.update({'node_ids': lease['reserved_nodes']}) slicerec_dict.update({'list_node_ids': {'hostname': lease['reserved_nodes']}}) #slicerec_dict.update({'hrn':\ #str(fixed_slicerec_dict['slice_hrn'])}) #return_slicerec_dictlist.append(slicerec_dict) fixed_slicerec_dict.update(slicerec_dict) logger.debug("IOTLAB_API.PY \tGetSlices RETURN \ return_slicerec_dictlist %s \slice_filter %s " \ %(return_slicerec_dictlist, slice_filter)) return return_slicerec_dictlist #Update slice unused, therefore sfa_fields_to_iotlab_fields unused #SA 30/05/13 #@staticmethod #def sfa_fields_to_iotlab_fields(sfa_type, hrn, record): #""" #""" #iotlab_record = {} ##for field in record: ## iotlab_record[field] = record[field] #if sfa_type == "slice": ##instantion used in get_slivers ? #if not "instantiation" in iotlab_record: #iotlab_record["instantiation"] = "iotlab-instantiated" ##iotlab_record["hrn"] = hrn_to_pl_slicename(hrn) ##Unused hrn_to_pl_slicename because Iotlab's hrn already ##in the appropriate form SA 23/07/12 #iotlab_record["hrn"] = hrn #logger.debug("IOTLAB_API.PY sfa_fields_to_iotlab_fields \ #iotlab_record %s " %(iotlab_record['hrn'])) #if "url" in record: #iotlab_record["url"] = record["url"] #if "description" in record: #iotlab_record["description"] = record["description"] #if "expires" in record: #iotlab_record["expires"] = int(record["expires"]) ##nodes added by OAR only and then imported to SFA ##elif type == "node": ##if not "hostname" in iotlab_record: ##if not "hostname" in record: ##raise MissingSfaInfo("hostname") ##iotlab_record["hostname"] = record["hostname"] ##if not "model" in iotlab_record: ##iotlab_record["model"] = "geni" ##One authority only ##elif type == "authority": ##iotlab_record["login_base"] = hrn_to_iotlab_login_base(hrn) ##if not "name" in iotlab_record: ##iotlab_record["name"] = hrn ##if not "abbreviated_name" in iotlab_record: ##iotlab_record["abbreviated_name"] = hrn ##if not "enabled" in iotlab_record: ##iotlab_record["enabled"] = True ##if not "is_public" in iotlab_record: ##iotlab_record["is_public"] = True #return iotlab_record