sfa/iotlab/iotlabapi.py

   1 """
   2 File containing the IotlabTestbedAPI, used to interact with nodes, users,
   3 slices, leases and keys,  as well as the dedicated iotlab database and table,
   4 holding information about which slice is running which job.
   5
   6 """
   7 from datetime import datetime
   8
   9 from sfa.util.sfalogging import logger
  10
  11 from sfa.storage.alchemy import dbsession
  12 from sqlalchemy.orm import joinedload
  13 from sfa.storage.model import RegRecord, RegUser, RegSlice, RegKey
  14 from sfa.iotlab.iotlabpostgres import IotlabDB, IotlabXP
  15 from sfa.iotlab.OARrestapi import OARrestapi
  16 from sfa.iotlab.LDAPapi import LDAPapi
  17
  18 from sfa.util.xrn import Xrn, hrn_to_urn, get_authority
  19
  20 from sfa.trust.certificate import Keypair, convert_public_key
  21 from sfa.trust.gid import create_uuid
  22 from sfa.trust.hierarchy import Hierarchy
  23
  24 from sfa.iotlab.iotlabaggregate import iotlab_xrn_object
  25
  26 class IotlabTestbedAPI():
  27     """ Class enabled to use LDAP and OAR api calls. """
  28
  29     _MINIMUM_DURATION = 600
  30
  31     def __init__(self, config):
  32         """Creates an instance of OARrestapi and LDAPapi which will be used to
  33         issue calls to OAR or LDAP methods.
  34         Set the time format  and the testbed granularity used for OAR
  35         reservation and leases.
  36
  37         :param config: configuration object from sfa.util.config
  38         :type config: Config object
  39         """
  40         self.iotlab_db = IotlabDB(config)
  41         self.oar = OARrestapi()
  42         self.ldap = LDAPapi()
  43         self.time_format = "%Y-%m-%d %H:%M:%S"
  44         self.root_auth = config.SFA_REGISTRY_ROOT_AUTH
  45         self.grain = 1  # 10 mins lease minimum, 1 sec granularity
  46         #import logging, logging.handlers
  47         #from sfa.util.sfalogging import _SfaLogger
  48         #sql_logger = _SfaLogger(loggername = 'sqlalchemy.engine', \
  49                                                     #level=logging.DEBUG)
  50         return
  51
  52     @staticmethod
  53     def GetMinExperimentDurationInSec():
  54         """ Returns the minimum allowed duration for an experiment on the
  55         testbed. In seconds.
  56
  57         """
  58         return IotlabTestbedAPI._MINIMUM_DURATION
  59
  60     @staticmethod
  61     def GetPeers (peer_filter=None ):
  62         """ Gathers registered authorities in SFA DB and looks for specific peer
  63         if peer_filter is specified.
  64         :param peer_filter: name of the site authority looked for.
  65         :type peer_filter: string
  66         :returns: list of records.
  67
  68         """
  69
  70         existing_records = {}
  71         existing_hrns_by_types = {}
  72         logger.debug("IOTLABDRIVER \tGetPeers peer_filter %s, \
  73                     " %(peer_filter))
  74         all_records = dbsession.query(RegRecord).filter(RegRecord.type.like('%authority%')).all()
  75
  76         for record in all_records:
  77             existing_records[(record.hrn, record.type)] = record
  78             if record.type not in existing_hrns_by_types:
  79                 existing_hrns_by_types[record.type] = [record.hrn]
  80             else:
  81                 existing_hrns_by_types[record.type].append(record.hrn)
  82
  83
  84         logger.debug("IOTLABDRIVER \tGetPeer\texisting_hrns_by_types %s "\
  85                                              %( existing_hrns_by_types))
  86         records_list = []
  87
  88         try:
  89             if peer_filter:
  90                 records_list.append(existing_records[(peer_filter,'authority')])
  91             else:
  92                 for hrn in existing_hrns_by_types['authority']:
  93                     records_list.append(existing_records[(hrn,'authority')])
  94
  95             logger.debug("IOTLABDRIVER \tGetPeer \trecords_list  %s " \
  96                                             %(records_list))
  97
  98         except KeyError:
  99             pass
 100
 101         return_records = records_list
 102         logger.debug("IOTLABDRIVER \tGetPeer return_records %s "
 103                      % (return_records))
 104         return return_records
 105
 106     #TODO  : Handling OR request in make_ldap_filters_from_records
 107     #instead of the for loop
 108     #over the records' list
 109     def GetPersons(self, person_filter=None):
 110         """
 111         Get the enabled users and their properties from Iotlab LDAP.
 112         If a filter is specified, looks for the user whose properties match
 113         the filter, otherwise returns the whole enabled users'list.
 114
 115         :param person_filter: Must be a list of dictionnaries
 116             with users properties when not set to None.
 117         :param person_filter: list of dict
 118         :returns:Returns a list of users whose accounts are enabled
 119             found in ldap.
 120         :rtype: list of dicts
 121
 122         """
 123         logger.debug("IOTLABDRIVER \tGetPersons person_filter %s"
 124                      % (person_filter))
 125         person_list = []
 126         if person_filter and isinstance(person_filter, list):
 127         #If we are looking for a list of users (list of dict records)
 128         #Usually the list contains only one user record
 129             for searched_attributes in person_filter:
 130
 131                 #Get only enabled user accounts in iotlab LDAP :
 132                 #add a filter for make_ldap_filters_from_record
 133                 person = self.ldap.LdapFindUser(searched_attributes,
 134                                                 is_user_enabled=True)
 135                 #If a person was found, append it to the list
 136                 if person:
 137                     person_list.append(person)
 138
 139             #If the list is empty, return None
 140             if len(person_list) is 0:
 141                 person_list = None
 142
 143         else:
 144             #Get only enabled user accounts in iotlab LDAP :
 145             #add a filter for make_ldap_filters_from_record
 146             person_list  = self.ldap.LdapFindUser(is_user_enabled=True)
 147
 148         return person_list
 149
 150
 151     #def GetTimezone(self):
 152         #""" Returns the OAR server time and timezone.
 153         #Unused SA 30/05/13"""
 154         #server_timestamp, server_tz = self.oar.parser.\
 155                                             #SendRequest("GET_timezone")
 156         #return server_timestamp, server_tz
 157
 158     def DeleteJobs(self, job_id, username):
 159         """
 160
 161         Deletes the job with the specified job_id and username on OAR by
 162             posting a delete request to OAR.
 163
 164         :param job_id: job id in OAR.
 165         :param username: user's iotlab login in LDAP.
 166         :type job_id: integer
 167         :type username: string
 168
 169         :returns: dictionary with the job id and if delete has been successful
 170             (True) or no (False)
 171         :rtype: dict
 172
 173         """
 174         logger.debug("IOTLABDRIVER \tDeleteJobs jobid  %s username %s "
 175                      % (job_id, username))
 176         if not job_id or job_id is -1:
 177             return
 178
 179         reqdict = {}
 180         reqdict['method'] = "delete"
 181         reqdict['strval'] = str(job_id)
 182
 183         answer = self.oar.POSTRequestToOARRestAPI('DELETE_jobs_id',
 184                                                   reqdict, username)
 185         if answer['status'] == 'Delete request registered':
 186             ret = {job_id: True}
 187         else:
 188             ret = {job_id: False}
 189         logger.debug("IOTLABDRIVER \tDeleteJobs jobid  %s \r\n answer %s \
 190                                 username %s" % (job_id, answer, username))
 191         return ret
 192
 193
 194
 195         ##TODO : Unused GetJobsId ? SA 05/07/12
 196     #def GetJobsId(self, job_id, username = None ):
 197         #"""
 198         #Details about a specific job.
 199         #Includes details about submission time, jot type, state, events,
 200         #owner, assigned ressources, walltime etc...
 201
 202         #"""
 203         #req = "GET_jobs_id"
 204         #node_list_k = 'assigned_network_address'
 205         ##Get job info from OAR
 206         #job_info = self.oar.parser.SendRequest(req, job_id, username)
 207
 208         #logger.debug("IOTLABDRIVER \t GetJobsId  %s " %(job_info))
 209         #try:
 210             #if job_info['state'] == 'Terminated':
 211                 #logger.debug("IOTLABDRIVER \t GetJobsId job %s TERMINATED"\
 212                                                             #%(job_id))
 213                 #return None
 214             #if job_info['state'] == 'Error':
 215                 #logger.debug("IOTLABDRIVER \t GetJobsId ERROR message %s "\
 216                                                             #%(job_info))
 217                 #return None
 218
 219         #except KeyError:
 220             #logger.error("IOTLABDRIVER \tGetJobsId KeyError")
 221             #return None
 222
 223         #parsed_job_info  = self.get_info_on_reserved_nodes(job_info, \
 224                                                             #node_list_k)
 225         ##Replaces the previous entry
 226         ##"assigned_network_address" / "reserved_resources"
 227         ##with "node_ids"
 228         #job_info.update({'node_ids':parsed_job_info[node_list_k]})
 229         #del job_info[node_list_k]
 230         #logger.debug(" \r\nIOTLABDRIVER \t GetJobsId job_info %s " %(job_info))
 231         #return job_info
 232
 233
 234     def GetJobsResources(self, job_id, username = None):
 235         """ Gets the list of nodes associated with the job_id and username
 236         if provided.
 237         Transforms the iotlab hostnames to the corresponding
 238         SFA nodes hrns.
 239         Rertuns dict key :'node_ids' , value : hostnames list
 240         :param username: user's LDAP login
 241         :paran job_id: job's OAR identifier.
 242         :type username: string
 243         :type job_id: integer
 244
 245         :returns: dicionary with nodes' hostnames belonging to the job.
 246         :rtype: dict
 247         """
 248
 249         req = "GET_jobs_id_resources"
 250
 251
 252         #Get job resources list from OAR
 253         node_id_list = self.oar.parser.SendRequest(req, job_id, username)
 254         logger.debug("IOTLABDRIVER \t GetJobsResources  %s " %(node_id_list))
 255
 256         hostname_list = \
 257             self.__get_hostnames_from_oar_node_ids(node_id_list)
 258
 259
 260         #Replaces the previous entry "assigned_network_address" /
 261         #"reserved_resources" with "node_ids"
 262         job_info = {'node_ids': hostname_list}
 263
 264         return job_info
 265
 266
 267     #def get_info_on_reserved_nodes(self, job_info, node_list_name):
 268         #"""
 269         #..warning:unused  SA 23/05/13
 270         #"""
 271         ##Get the list of the testbed nodes records and make a
 272         ##dictionnary keyed on the hostname out of it
 273         #node_list_dict = self.GetNodes()
 274         ##node_hostname_list = []
 275         #node_hostname_list = [node['hostname'] for node in node_list_dict]
 276         ##for node in node_list_dict:
 277             ##node_hostname_list.append(node['hostname'])
 278         #node_dict = dict(zip(node_hostname_list, node_list_dict))
 279         #try :
 280             #reserved_node_hostname_list = []
 281             #for index in range(len(job_info[node_list_name])):
 282                ##job_info[node_list_name][k] =
 283                 #reserved_node_hostname_list[index] = \
 284                         #node_dict[job_info[node_list_name][index]]['hostname']
 285
 286             #logger.debug("IOTLABDRIVER \t get_info_on_reserved_nodes \
 287                         #reserved_node_hostname_list %s" \
 288                         #%(reserved_node_hostname_list))
 289         #except KeyError:
 290             #logger.error("IOTLABDRIVER \t get_info_on_reserved_nodes KEYERROR " )
 291
 292         #return reserved_node_hostname_list
 293
 294     def GetNodesCurrentlyInUse(self):
 295         """Returns a list of all the nodes already involved in an oar running
 296         job.
 297         :rtype: list of nodes hostnames.
 298         """
 299         return self.oar.parser.SendRequest("GET_running_jobs")
 300
 301     def __get_hostnames_from_oar_node_ids(self, resource_id_list ):
 302         """Get the hostnames of the nodes from their OAR identifiers.
 303         Get the list of nodes dict using GetNodes and find the hostname
 304         associated with the identifier.
 305         :param resource_id_list: list of nodes identifiers
 306         :returns: list of node hostnames.
 307         """
 308         full_nodes_dict_list = self.GetNodes()
 309         #Put the full node list into a dictionary keyed by oar node id
 310         oar_id_node_dict = {}
 311         for node in full_nodes_dict_list:
 312             oar_id_node_dict[node['oar_id']] = node
 313
 314         hostname_list = []
 315         for resource_id in resource_id_list:
 316             #Because jobs requested "asap" do not have defined resources
 317             if resource_id is not "Undefined":
 318                 hostname_list.append(\
 319                         oar_id_node_dict[resource_id]['hostname'])
 320
 321             #hostname_list.append(oar_id_node_dict[resource_id]['hostname'])
 322         return hostname_list
 323
 324     def GetReservedNodes(self, username = None):
 325         """ Get list of leases. Get the leases for the username if specified,
 326         otherwise get all the leases. Finds the nodes hostnames for each
 327         OAR node identifier.
 328         :param username: user's LDAP login
 329         :type username: string
 330         :returns: list of reservations dict
 331         :rtype: dict list
 332         """
 333
 334         #Get the nodes in use and the reserved nodes
 335         reservation_dict_list = \
 336                         self.oar.parser.SendRequest("GET_reserved_nodes", \
 337                         username = username)
 338
 339
 340         for resa in reservation_dict_list:
 341             logger.debug ("GetReservedNodes resa %s"%(resa))
 342             #dict list of hostnames and their site
 343             resa['reserved_nodes'] = \
 344                 self.__get_hostnames_from_oar_node_ids(resa['resource_ids'])
 345
 346         #del resa['resource_ids']
 347         return reservation_dict_list
 348
 349     def GetNodes(self, node_filter_dict=None, return_fields_list=None):
 350         """
 351
 352         Make a list of iotlab nodes and their properties from information
 353             given by OAR. Search for specific nodes if some filters are
 354             specified. Nodes properties returned if no return_fields_list given:
 355             'hrn','archi','mobile','hostname','site','boot_state','node_id',
 356             'radio','posx','posy','oar_id','posz'.
 357
 358         :param node_filter_dict: dictionnary of lists with node properties. For
 359             instance, if you want to look for a specific node with its hrn,
 360             the node_filter_dict should be {'hrn': [hrn_of_the_node]}
 361         :type node_filter_dict: dict
 362         :param return_fields_list: list of specific fields the user wants to be
 363             returned.
 364         :type return_fields_list: list
 365         :returns: list of dictionaries with node properties
 366         :rtype: list
 367
 368         """
 369         node_dict_by_id = self.oar.parser.SendRequest("GET_resources_full")
 370         node_dict_list = node_dict_by_id.values()
 371         logger.debug (" IOTLABDRIVER GetNodes  node_filter_dict %s \
 372             return_fields_list %s " % (node_filter_dict, return_fields_list))
 373         #No  filtering needed return the list directly
 374         if not (node_filter_dict or return_fields_list):
 375             return node_dict_list
 376
 377         return_node_list = []
 378         if node_filter_dict:
 379             for filter_key in node_filter_dict:
 380                 try:
 381                     #Filter the node_dict_list by each value contained in the
 382                     #list node_filter_dict[filter_key]
 383                     for value in node_filter_dict[filter_key]:
 384                         for node in node_dict_list:
 385                             if node[filter_key] == value:
 386                                 if return_fields_list:
 387                                     tmp = {}
 388                                     for k in return_fields_list:
 389                                         tmp[k] = node[k]
 390                                     return_node_list.append(tmp)
 391                                 else:
 392                                     return_node_list.append(node)
 393                 except KeyError:
 394                     logger.log_exc("GetNodes KeyError")
 395                     return
 396
 397
 398         return return_node_list
 399
 400
 401
 402     @staticmethod
 403     def AddSlice(slice_record, user_record):
 404         """
 405
 406         Add slice to the local iotlab sfa tables if the slice comes
 407             from a federated site and is not yet in the iotlab sfa DB,
 408             although the user has already a LDAP login.
 409             Called by verify_slice during lease/sliver creation.
 410
 411         :param slice_record: record of slice, must contain hrn, gid, slice_id
 412             and authority of the slice.
 413         :type slice_record: dictionary
 414         :param user_record: record of the user
 415         :type user_record: RegUser
 416
 417         """
 418
 419         sfa_record = RegSlice(hrn=slice_record['hrn'],
 420                               gid=slice_record['gid'],
 421                               pointer=slice_record['slice_id'],
 422                               authority=slice_record['authority'])
 423         logger.debug("IOTLABDRIVER.PY AddSlice  sfa_record %s user_record %s"
 424                      % (sfa_record, user_record))
 425         sfa_record.just_created()
 426         dbsession.add(sfa_record)
 427         dbsession.commit()
 428         #Update the reg-researcher dependance table
 429         sfa_record.reg_researchers = [user_record]
 430         dbsession.commit()
 431
 432         return
 433
 434
 435     def GetSites(self, site_filter_name_list=None, return_fields_list=None):
 436         """Returns the list of Iotlab's sites with the associated nodes and
 437         their properties as dictionaries.
 438
 439         Uses the OAR request GET_sites to find the Iotlab's sites.
 440
 441         :param site_filter_name_list: used to specify specific sites
 442         :param return_fields_list: field that has to be returned
 443         :type site_filter_name_list: list
 444         :type return_fields_list: list
 445
 446         .. warning:: unused
 447         """
 448         site_dict = self.oar.parser.SendRequest("GET_sites")
 449         #site_dict : dict where the key is the sit ename
 450         return_site_list = []
 451         if not (site_filter_name_list or return_fields_list):
 452             return_site_list = site_dict.values()
 453             return return_site_list
 454
 455         for site_filter_name in site_filter_name_list:
 456             if site_filter_name in site_dict:
 457                 if return_fields_list:
 458                     for field in return_fields_list:
 459                         tmp = {}
 460                         try:
 461                             tmp[field] = site_dict[site_filter_name][field]
 462                         except KeyError:
 463                             logger.error("GetSites KeyError %s " % (field))
 464                             return None
 465                     return_site_list.append(tmp)
 466                 else:
 467                     return_site_list.append(site_dict[site_filter_name])
 468
 469         return return_site_list
 470
 471
 472     #TODO : Check rights to delete person
 473     def DeletePerson(self, person_record):
 474         """Disable an existing account in iotlab LDAP.
 475
 476         Users and techs can only delete themselves. PIs can only
 477             delete themselves and other non-PIs at their sites.
 478             ins can delete anyone.
 479
 480         :param person_record: user's record
 481         :type person_record: dict
 482         :returns:  True if successful, False otherwise.
 483         :rtype: boolean
 484
 485         .. todo:: CHECK THAT ONLY THE USER OR ADMIN CAN DEL HIMSELF.
 486         """
 487         #Disable user account in iotlab LDAP
 488         ret = self.ldap.LdapMarkUserAsDeleted(person_record)
 489         logger.warning("IOTLABDRIVER DeletePerson %s " % (person_record))
 490         return ret['bool']
 491
 492     def DeleteSlice(self, slice_record):
 493         """Deletes the specified slice and kills the jobs associated with
 494             the slice if any,  using DeleteSliceFromNodes.
 495
 496         :param slice_record: record of the slice, must contain oar_job_id, user
 497         :type slice_record: dict
 498         :returns: True if all the jobs in the slice have been deleted,
 499             or the list of jobs that could not be deleted otherwise.
 500         :rtype: list or boolean
 501
 502          .. seealso:: DeleteSliceFromNodes
 503
 504         """
 505         ret = self.DeleteSliceFromNodes(slice_record)
 506         delete_failed = None
 507         for job_id in ret:
 508             if False in ret[job_id]:
 509                 if delete_failed is None:
 510                     delete_failed = []
 511                 delete_failed.append(job_id)
 512
 513         logger.info("IOTLABDRIVER DeleteSlice %s  answer %s"%(slice_record, \
 514                     delete_failed))
 515         return delete_failed or True
 516
 517     @staticmethod
 518     def __add_person_to_db(user_dict):
 519         """
 520         Add a federated user straight to db when the user issues a lease
 521         request with iotlab nodes and that he has not registered with iotlab
 522         yet (that is he does not have a LDAP entry yet).
 523         Uses parts of the routines in SlabImport when importing user from LDAP.
 524         Called by AddPerson, right after LdapAddUser.
 525         :param user_dict: Must contain email, hrn and pkey to get a GID
 526         and be added to the SFA db.
 527         :type user_dict: dict
 528
 529         """
 530         check_if_exists = \
 531         dbsession.query(RegUser).filter_by(email = user_dict['email']).first()
 532         #user doesn't exists
 533         if not check_if_exists:
 534             logger.debug("__add_person_to_db \t Adding %s \r\n \r\n \
 535                                             " %(user_dict))
 536             hrn = user_dict['hrn']
 537             person_urn = hrn_to_urn(hrn, 'user')
 538             pubkey = user_dict['pkey']
 539             try:
 540                 pkey = convert_public_key(pubkey)
 541             except TypeError:
 542                 #key not good. create another pkey
 543                 logger.warn('__add_person_to_db: unable to convert public \
 544                                     key for %s' %(hrn ))
 545                 pkey = Keypair(create=True)
 546
 547
 548             if pubkey is not None and pkey is not None :
 549                 hierarchy = Hierarchy()
 550                 person_gid = hierarchy.create_gid(person_urn, create_uuid(), \
 551                                 pkey)
 552                 if user_dict['email']:
 553                     logger.debug("__add_person_to_db \r\n \r\n \
 554                         IOTLAB IMPORTER PERSON EMAIL OK email %s "\
 555                         %(user_dict['email']))
 556                     person_gid.set_email(user_dict['email'])
 557
 558             user_record = RegUser(hrn=hrn , pointer= '-1', \
 559                                     authority=get_authority(hrn), \
 560                                     email=user_dict['email'], gid = person_gid)
 561             user_record.reg_keys = [RegKey(user_dict['pkey'])]
 562             user_record.just_created()
 563             dbsession.add (user_record)
 564             dbsession.commit()
 565         return
 566
 567
 568     def AddPerson(self, record):
 569         """
 570
 571         Adds a new account. Any fields specified in records are used,
 572             otherwise defaults are used. Creates an appropriate login by calling
 573             LdapAddUser.
 574
 575         :param record: dictionary with the sfa user's properties.
 576         :returns: The uid of the added person if sucessful, otherwise returns
 577             the error message from LDAP.
 578         :rtype: interger or string
 579
 580         """
 581         ret = self.ldap.LdapAddUser(record)
 582
 583         if ret['bool'] is True:
 584             record['hrn'] = self.root_auth + '.' + ret['uid']
 585             logger.debug("IOTLABDRIVER AddPerson return code %s record %s \r\n "\
 586                                                                 %(ret, record))
 587             self.__add_person_to_db(record)
 588             return ret['uid']
 589         else:
 590             return ret['message']
 591
 592
 593
 594     #TODO AddPersonKey 04/07/2012 SA
 595     def AddPersonKey(self, person_uid, old_attributes_dict, new_key_dict):
 596         """Adds a new key to the specified account. Adds the key to the
 597             iotlab ldap, provided that the person_uid is valid.
 598
 599         Non-admins can only modify their own keys.
 600
 601         :param person_uid: user's iotlab login in LDAP
 602         :param old_attributes_dict: dict with the user's old sshPublicKey
 603         :param new_key_dict: dict with the user's new sshPublicKey
 604         :type person_uid: string
 605
 606
 607         :rtype: Boolean
 608         :returns: True if the key has been modified, False otherwise.
 609
 610         """
 611         ret = self.ldap.LdapModify(person_uid, old_attributes_dict, \
 612                                                                 new_key_dict)
 613         logger.warning("IOTLABDRIVER AddPersonKey EMPTY - DO NOTHING \r\n ")
 614         return ret['bool']
 615
 616     def DeleteLeases(self, leases_id_list, slice_hrn):
 617         """
 618
 619         Deletes several leases, based on their job ids and the slice
 620             they are associated with. Uses DeleteJobs to delete the jobs
 621             on OAR. Note that one slice can contain multiple jobs, and in this
 622             case all the jobs in the leases_id_list MUST belong to ONE slice,
 623             since there is only one slice hrn provided here.
 624
 625         :param leases_id_list: list of job ids that belong to the slice whose
 626             slice hrn is provided.
 627         :param slice_hrn: the slice hrn.
 628         :type slice_hrn: string
 629
 630         .. warning:: Does not have a return value since there was no easy
 631             way to handle failure when dealing with multiple job delete. Plus,
 632             there was no easy way to report it to the user.
 633
 634         """
 635         logger.debug("IOTLABDRIVER DeleteLeases leases_id_list %s slice_hrn %s \
 636                 \r\n " %(leases_id_list, slice_hrn))
 637         for job_id in leases_id_list:
 638             self.DeleteJobs(job_id, slice_hrn)
 639
 640         return
 641
 642     @staticmethod
 643     def _process_walltime(duration):
 644         """ Calculates the walltime in seconds from the duration in H:M:S
 645             specified in the RSpec.
 646
 647         """
 648         if duration:
 649             # Fixing the walltime by adding a few delays.
 650             # First put the walltime in seconds oarAdditionalDelay = 20;
 651             #  additional delay for /bin/sleep command to
 652             # take in account  prologue and epilogue scripts execution
 653             # int walltimeAdditionalDelay = 240;  additional delay
 654             #for prologue/epilogue execution = $SERVER_PROLOGUE_EPILOGUE_TIMEOUT
 655             #in oar.conf
 656             # Put the duration in seconds first
 657             #desired_walltime = duration * 60
 658             desired_walltime = duration
 659             total_walltime = desired_walltime + 240 #+4 min Update SA 23/10/12
 660             sleep_walltime = desired_walltime  # 0 sec added Update SA 23/10/12
 661             walltime = []
 662             #Put the walltime back in str form
 663             #First get the hours
 664             walltime.append(str(total_walltime / 3600))
 665             total_walltime = total_walltime - 3600 * int(walltime[0])
 666             #Get the remaining minutes
 667             walltime.append(str(total_walltime / 60))
 668             total_walltime = total_walltime - 60 * int(walltime[1])
 669             #Get the seconds
 670             walltime.append(str(total_walltime))
 671
 672         else:
 673             logger.log_exc(" __process_walltime duration null")
 674
 675         return walltime, sleep_walltime
 676
 677     @staticmethod
 678     def _create_job_structure_request_for_OAR(lease_dict):
 679         """ Creates the structure needed for a correct POST on OAR.
 680         Makes the timestamp transformation into the appropriate format.
 681         Sends the POST request to create the job with the resources in
 682         added_nodes.
 683
 684         """
 685
 686         nodeid_list = []
 687         reqdict = {}
 688
 689
 690         reqdict['workdir'] = '/tmp'
 691         reqdict['resource'] = "{network_address in ("
 692
 693         for node in lease_dict['added_nodes']:
 694             logger.debug("\r\n \r\n OARrestapi \t \
 695             __create_job_structure_request_for_OAR node %s" %(node))
 696
 697             # Get the ID of the node
 698             nodeid = node
 699             reqdict['resource'] += "'" + nodeid + "', "
 700             nodeid_list.append(nodeid)
 701
 702         custom_length = len(reqdict['resource'])- 2
 703         reqdict['resource'] = reqdict['resource'][0:custom_length] + \
 704                                             ")}/nodes=" + str(len(nodeid_list))
 705
 706
 707         walltime, sleep_walltime = \
 708                     IotlabTestbedAPI._process_walltime(\
 709                                      int(lease_dict['lease_duration']))
 710
 711
 712         reqdict['resource'] += ",walltime=" + str(walltime[0]) + \
 713                             ":" + str(walltime[1]) + ":" + str(walltime[2])
 714         reqdict['script_path'] = "/bin/sleep " + str(sleep_walltime)
 715
 716         #In case of a scheduled experiment (not immediate)
 717         #To run an XP immediately, don't specify date and time in RSpec
 718         #They will be set to None.
 719         if lease_dict['lease_start_time'] is not '0':
 720             #Readable time accepted by OAR
 721             start_time = datetime.fromtimestamp( \
 722                 int(lease_dict['lease_start_time'])).\
 723                 strftime(lease_dict['time_format'])
 724             reqdict['reservation'] = start_time
 725         #If there is not start time, Immediate XP. No need to add special
 726         # OAR parameters
 727
 728
 729         reqdict['type'] = "deploy"
 730         reqdict['directory'] = ""
 731         reqdict['name'] = "SFA_" + lease_dict['slice_user']
 732
 733         return reqdict
 734
 735
 736     def LaunchExperimentOnOAR(self, added_nodes, slice_name, \
 737                         lease_start_time, lease_duration, slice_user=None):
 738
 739         """
 740         Create a job request structure based on the information provided
 741         and post the job on OAR.
 742         :param added_nodes: list of nodes that belong to the described lease.
 743         :param slice_name: the slice hrn associated to the lease.
 744         :param lease_start_time: timestamp of the lease startting time.
 745         :param lease_duration: lease durationin minutes
 746
 747         """
 748         lease_dict = {}
 749         lease_dict['lease_start_time'] = lease_start_time
 750         lease_dict['lease_duration'] = lease_duration
 751         lease_dict['added_nodes'] = added_nodes
 752         lease_dict['slice_name'] = slice_name
 753         lease_dict['slice_user'] = slice_user
 754         lease_dict['grain'] = self.GetLeaseGranularity()
 755         lease_dict['time_format'] = self.time_format
 756
 757
 758         logger.debug("IOTLABDRIVER.PY \tLaunchExperimentOnOAR slice_user %s\
 759                              \r\n "  %(slice_user))
 760         #Create the request for OAR
 761         reqdict = self._create_job_structure_request_for_OAR(lease_dict)
 762          # first step : start the OAR job and update the job
 763         logger.debug("IOTLABDRIVER.PY \tLaunchExperimentOnOAR reqdict %s\
 764                              \r\n "  %(reqdict))
 765
 766         answer = self.oar.POSTRequestToOARRestAPI('POST_job', \
 767                                                 reqdict, slice_user)
 768         logger.debug("IOTLABDRIVER \tLaunchExperimentOnOAR jobid  %s " %(answer))
 769         try:
 770             jobid = answer['id']
 771         except KeyError:
 772             logger.log_exc("IOTLABDRIVER \tLaunchExperimentOnOAR \
 773                                 Impossible to create job  %s "  %(answer))
 774             return None
 775
 776
 777
 778
 779         if jobid :
 780             logger.debug("IOTLABDRIVER \tLaunchExperimentOnOAR jobid %s \
 781                     added_nodes %s slice_user %s" %(jobid, added_nodes, \
 782                                                             slice_user))
 783
 784
 785         return jobid
 786
 787
 788     def AddLeases(self, hostname_list, slice_record, \
 789                                         lease_start_time, lease_duration):
 790
 791         """Creates a job in OAR corresponding to the information provided
 792         as parameters. Adds the job id and the slice hrn in the iotlab
 793         database so that we are able to know which slice has which nodes.
 794
 795         :param hostname_list: list of nodes' OAR hostnames.
 796         :param slice_record: sfa slice record, must contain login and hrn.
 797         :param lease_start_time: starting time , unix timestamp format
 798         :param lease_duration: duration in minutes
 799
 800         :type hostname_list: list
 801         :type slice_record: dict
 802         :type lease_start_time: integer
 803         :type lease_duration: integer
 804
 805         """
 806         logger.debug("IOTLABDRIVER \r\n \r\n \t AddLeases hostname_list %s  \
 807                 slice_record %s lease_start_time %s lease_duration %s  "\
 808                  %( hostname_list, slice_record , lease_start_time, \
 809                  lease_duration))
 810
 811         #tmp = slice_record['reg-researchers'][0].split(".")
 812         username = slice_record['login']
 813         #username = tmp[(len(tmp)-1)]
 814         job_id = self.LaunchExperimentOnOAR(hostname_list, \
 815                                     slice_record['hrn'], \
 816                                     lease_start_time, lease_duration, \
 817                                     username)
 818         start_time = \
 819                 datetime.fromtimestamp(int(lease_start_time)).\
 820                 strftime(self.time_format)
 821         end_time = lease_start_time + lease_duration
 822
 823
 824         logger.debug("IOTLABDRIVER \r\n \r\n \t AddLeases TURN ON LOGGING SQL \
 825                         %s %s %s "%(slice_record['hrn'], job_id, end_time))
 826
 827
 828         logger.debug("IOTLABDRIVER \r\n \r\n \t AddLeases %s %s %s " \
 829                 %(type(slice_record['hrn']), type(job_id), type(end_time)))
 830
 831         iotlab_ex_row = IotlabXP(slice_hrn = slice_record['hrn'], \
 832                 job_id = job_id, end_time= end_time)
 833
 834         logger.debug("IOTLABDRIVER \r\n \r\n \t AddLeases iotlab_ex_row %s" \
 835                 %(iotlab_ex_row))
 836         self.iotlab_db.iotlab_session.add(iotlab_ex_row)
 837         self.iotlab_db.iotlab_session.commit()
 838
 839         logger.debug("IOTLABDRIVER \t AddLeases hostname_list start_time %s " \
 840                 %(start_time))
 841
 842         return
 843
 844
 845     #Delete the jobs from job_iotlab table
 846     def DeleteSliceFromNodes(self, slice_record):
 847         """
 848
 849         Deletes all the running or scheduled jobs of a given slice
 850             given its record.
 851
 852         :param slice_record: record of the slice, must contain oar_job_id, user
 853         :type slice_record: dict
 854
 855         :returns: dict of the jobs'deletion status. Success= True, Failure=
 856             False, for each job id.
 857         :rtype: dict
 858
 859         """
 860         logger.debug("IOTLABDRIVER \t  DeleteSliceFromNodes %s "
 861                      % (slice_record))
 862
 863         if isinstance(slice_record['oar_job_id'], list):
 864             oar_bool_answer = {}
 865             for job_id in slice_record['oar_job_id']:
 866                 ret = self.DeleteJobs(job_id, slice_record['user'])
 867
 868                 oar_bool_answer.update(ret)
 869
 870         else:
 871             oar_bool_answer = [self.DeleteJobs(slice_record['oar_job_id'],
 872                                                slice_record['user'])]
 873
 874         return oar_bool_answer
 875
 876
 877
 878     def GetLeaseGranularity(self):
 879         """ Returns the granularity of an experiment in the Iotlab testbed.
 880         OAR uses seconds for experiments duration , the granulaity is also
 881         defined in seconds.
 882         Experiments which last less than 10 min (600 sec) are invalid"""
 883         return self.grain
 884
 885
 886     # @staticmethod
 887     # def update_jobs_in_iotlabdb( job_oar_list, jobs_psql):
 888     #     """ Cleans the iotlab db by deleting expired and cancelled jobs.
 889     #     Compares the list of job ids given by OAR with the job ids that
 890     #     are already in the database, deletes the jobs that are no longer in
 891     #     the OAR job id list.
 892     #     :param  job_oar_list: list of job ids coming from OAR
 893     #     :type job_oar_list: list
 894     #     :param job_psql: list of job ids cfrom the database.
 895     #     type job_psql: list
 896     #     """
 897     #     #Turn the list into a set
 898     #     set_jobs_psql = set(jobs_psql)
 899
 900     #     kept_jobs = set(job_oar_list).intersection(set_jobs_psql)
 901     #     logger.debug ( "\r\n \t\ update_jobs_in_iotlabdb jobs_psql %s \r\n \t \
 902     #         job_oar_list %s kept_jobs %s "%(set_jobs_psql, job_oar_list, kept_jobs))
 903     #     deleted_jobs = set_jobs_psql.difference(kept_jobs)
 904     #     deleted_jobs = list(deleted_jobs)
 905     #     if len(deleted_jobs) > 0:
 906     #         self.iotlab_db.iotlab_session.query(IotlabXP).filter(IotlabXP.job_id.in_(deleted_jobs)).delete(synchronize_session='fetch')
 907     #         self.iotlab_db.iotlab_session.commit()
 908
 909     #     return
 910
 911
 912     def GetLeases(self, lease_filter_dict=None, login=None):
 913         """
 914
 915         Get the list of leases from OAR with complete information
 916             about which slice owns which jobs and nodes.
 917             Two purposes:
 918             -Fetch all the jobs from OAR (running, waiting..)
 919             complete the reservation information with slice hrn
 920             found in iotlab_xp table. If not available in the table,
 921             assume it is a iotlab slice.
 922             -Updates the iotlab table, deleting jobs when necessary.
 923
 924         :returns: reservation_list, list of dictionaries with 'lease_id',
 925             'reserved_nodes','slice_id', 'state', 'user', 'component_id_list',
 926             'slice_hrn', 'resource_ids', 't_from', 't_until'
 927         :rtype: list
 928
 929         """
 930
 931         unfiltered_reservation_list = self.GetReservedNodes(login)
 932
 933         reservation_list = []
 934         #Find the slice associated with this user iotlab ldap uid
 935         logger.debug(" IOTLABDRIVER.PY \tGetLeases login %s\
 936                         unfiltered_reservation_list %s "
 937                      % (login, unfiltered_reservation_list))
 938         #Create user dict first to avoid looking several times for
 939         #the same user in LDAP SA 27/07/12
 940         job_oar_list = []
 941
 942         jobs_psql_query = self.iotlab_db.iotlab_session.query(IotlabXP).all()
 943         jobs_psql_dict = dict([(row.job_id, row.__dict__)
 944                                for row in jobs_psql_query])
 945         #jobs_psql_dict = jobs_psql_dict)
 946         logger.debug("IOTLABDRIVER \tGetLeases jobs_psql_dict %s"
 947                      % (jobs_psql_dict))
 948         jobs_psql_id_list = [row.job_id for row in jobs_psql_query]
 949
 950         for resa in unfiltered_reservation_list:
 951             logger.debug("IOTLABDRIVER \tGetLeases USER %s"
 952                          % (resa['user']))
 953             #Construct list of jobs (runing, waiting..) in oar
 954             job_oar_list.append(resa['lease_id'])
 955             #If there is information on the job in IOTLAB DB ]
 956             #(slice used and job id)
 957             if resa['lease_id'] in jobs_psql_dict:
 958                 job_info = jobs_psql_dict[resa['lease_id']]
 959                 logger.debug("IOTLABDRIVER \tGetLeases job_info %s"
 960                              % (job_info))
 961                 resa['slice_hrn'] = job_info['slice_hrn']
 962                 resa['slice_id'] = hrn_to_urn(resa['slice_hrn'], 'slice')
 963
 964             #otherwise, assume it is a iotlab slice:
 965             else:
 966                 resa['slice_id'] = hrn_to_urn(self.root_auth + '.' +
 967                                               resa['user'] + "_slice", 'slice')
 968                 resa['slice_hrn'] = Xrn(resa['slice_id']).get_hrn()
 969
 970             resa['component_id_list'] = []
 971             #Transform the hostnames into urns (component ids)
 972             for node in resa['reserved_nodes']:
 973
 974                 iotlab_xrn = iotlab_xrn_object(self.root_auth, node)
 975                 resa['component_id_list'].append(iotlab_xrn.urn)
 976
 977             if lease_filter_dict:
 978                 logger.debug("IOTLABDRIVER \tGetLeases resa_ %s \
 979                         \r\n leasefilter %s" % (resa, lease_filter_dict))
 980
 981                 if lease_filter_dict['name'] == resa['slice_hrn']:
 982                     reservation_list.append(resa)
 983
 984         if lease_filter_dict is None:
 985             reservation_list = unfiltered_reservation_list
 986
 987         self.iotlab_db.update_jobs_in_iotlabdb(job_oar_list, jobs_psql_id_list)
 988
 989         logger.debug(" IOTLABDRIVER.PY \tGetLeases reservation_list %s"
 990                      % (reservation_list))
 991         return reservation_list
 992
 993
 994
 995
 996 #TODO FUNCTIONS SECTION 04/07/2012 SA
 997
 998     ##TODO : Is UnBindObjectFromPeer still necessary ? Currently does nothing
 999     ##04/07/2012 SA
1000     #@staticmethod
1001     #def UnBindObjectFromPeer( auth, object_type, object_id, shortname):
1002         #""" This method is a hopefully temporary hack to let the sfa correctly
1003         #detach the objects it creates from a remote peer object. This is
1004         #needed so that the sfa federation link can work in parallel with
1005         #RefreshPeer, as RefreshPeer depends on remote objects being correctly
1006         #marked.
1007         #Parameters:
1008         #auth : struct, API authentication structure
1009             #AuthMethod : string, Authentication method to use
1010         #object_type : string, Object type, among 'site','person','slice',
1011         #'node','key'
1012         #object_id : int, object_id
1013         #shortname : string, peer shortname
1014         #FROM PLC DOC
1015
1016         #"""
1017         #logger.warning("IOTLABDRIVER \tUnBindObjectFromPeer EMPTY-\
1018                         #DO NOTHING \r\n ")
1019         #return
1020
1021     ##TODO Is BindObjectToPeer still necessary ? Currently does nothing
1022     ##04/07/2012 SA
1023     #|| Commented out 28/05/13 SA
1024     #def BindObjectToPeer(self, auth, object_type, object_id, shortname=None, \
1025                                                     #remote_object_id=None):
1026         #"""This method is a hopefully temporary hack to let the sfa correctly
1027         #attach the objects it creates to a remote peer object. This is needed
1028         #so that the sfa federation link can work in parallel with RefreshPeer,
1029         #as RefreshPeer depends on remote objects being correctly marked.
1030         #Parameters:
1031         #shortname : string, peer shortname
1032         #remote_object_id : int, remote object_id, set to 0 if unknown
1033         #FROM PLC API DOC
1034
1035         #"""
1036         #logger.warning("IOTLABDRIVER \tBindObjectToPeer EMPTY - DO NOTHING \r\n ")
1037         #return
1038
1039     ##TODO UpdateSlice 04/07/2012 SA || Commented out 28/05/13 SA
1040     ##Funciton should delete and create another job since oin iotlab slice=job
1041     #def UpdateSlice(self, auth, slice_id_or_name, slice_fields=None):
1042         #"""Updates the parameters of an existing slice with the values in
1043         #slice_fields.
1044         #Users may only update slices of which they are members.
1045         #PIs may update any of the slices at their sites, or any slices of
1046         #which they are members. Admins may update any slice.
1047         #Only PIs and admins may update max_nodes. Slices cannot be renewed
1048         #(by updating the expires parameter) more than 8 weeks into the future.
1049          #Returns 1 if successful, faults otherwise.
1050         #FROM PLC API DOC
1051
1052         #"""
1053         #logger.warning("IOTLABDRIVER UpdateSlice EMPTY - DO NOTHING \r\n ")
1054         #return
1055
1056     #Unused SA 30/05/13, we only update the user's key or we delete it.
1057     ##TODO UpdatePerson 04/07/2012 SA
1058     #def UpdatePerson(self, iotlab_hrn, federated_hrn, person_fields=None):
1059         #"""Updates a person. Only the fields specified in person_fields
1060         #are updated, all other fields are left untouched.
1061         #Users and techs can only update themselves. PIs can only update
1062         #themselves and other non-PIs at their sites.
1063         #Returns 1 if successful, faults otherwise.
1064         #FROM PLC API DOC
1065
1066         #"""
1067         ##new_row = FederatedToIotlab(iotlab_hrn, federated_hrn)
1068         ##self.iotlab_db.iotlab_session.add(new_row)
1069         ##self.iotlab_db.iotlab_session.commit()
1070
1071         #logger.debug("IOTLABDRIVER UpdatePerson EMPTY - DO NOTHING \r\n ")
1072         #return
1073
1074     @staticmethod
1075     def GetKeys(key_filter=None):
1076         """Returns a dict of dict based on the key string. Each dict entry
1077         contains the key id, the ssh key, the user's email and the
1078         user's hrn.
1079         If key_filter is specified and is an array of key identifiers,
1080         only keys matching the filter will be returned.
1081
1082         Admin may query all keys. Non-admins may only query their own keys.
1083         FROM PLC API DOC
1084
1085         :returns: dict with ssh key as key and dicts as value.
1086         :rtype: dict
1087         """
1088         if key_filter is None:
1089             keys = dbsession.query(RegKey).options(joinedload('reg_user')).all()
1090         else:
1091             keys = dbsession.query(RegKey).options(joinedload('reg_user')).filter(RegKey.key.in_(key_filter)).all()
1092
1093         key_dict = {}
1094         for key in keys:
1095             key_dict[key.key] = {'key_id': key.key_id, 'key': key.key,
1096                                  'email': key.reg_user.email,
1097                                  'hrn': key.reg_user.hrn}
1098
1099         #ldap_rslt = self.ldap.LdapSearch({'enabled']=True})
1100         #user_by_email = dict((user[1]['mail'][0], user[1]['sshPublicKey']) \
1101                                         #for user in ldap_rslt)
1102
1103         logger.debug("IOTLABDRIVER  GetKeys  -key_dict %s \r\n " % (key_dict))
1104         return key_dict
1105
1106     #TODO : test
1107     def DeleteKey(self, user_record, key_string):
1108         """Deletes a key in the LDAP entry of the specified user.
1109
1110         Removes the key_string from the user's key list and updates the LDAP
1111             user's entry with the new key attributes.
1112
1113         :param key_string: The ssh key to remove
1114         :param user_record: User's record
1115         :type key_string: string
1116         :type user_record: dict
1117         :returns: True if sucessful, False if not.
1118         :rtype: Boolean
1119
1120         """
1121         all_user_keys = user_record['keys']
1122         all_user_keys.remove(key_string)
1123         new_attributes = {'sshPublicKey':all_user_keys}
1124         ret = self.ldap.LdapModifyUser(user_record, new_attributes)
1125         logger.debug("IOTLABDRIVER  DeleteKey  %s- " % (ret))
1126         return ret['bool']
1127
1128
1129
1130
1131     @staticmethod
1132     def _sql_get_slice_info( slice_filter ):
1133         """
1134         Get the slice record based on the slice hrn. Fetch the record of the
1135         user associated with the slice by using joinedload based on the
1136         reg_researcher relationship.
1137
1138         :param slice_filter: the slice hrn we are looking for
1139         :type slice_filter: string
1140         :returns: the slice record enhanced with the user's information if the
1141             slice was found, None it wasn't.
1142
1143         :rtype: dict or None.
1144         """
1145         #DO NOT USE RegSlice - reg_researchers to get the hrn
1146         #of the user otherwise will mess up the RegRecord in
1147         #Resolve, don't know why - SA 08/08/2012
1148
1149         #Only one entry for one user  = one slice in iotlab_xp table
1150         #slicerec = dbsession.query(RegRecord).filter_by(hrn = slice_filter).first()
1151         raw_slicerec = dbsession.query(RegSlice).options(joinedload('reg_researchers')).filter_by(hrn=slice_filter).first()
1152         #raw_slicerec = dbsession.query(RegRecord).filter_by(hrn = slice_filter).first()
1153         if raw_slicerec:
1154             #load_reg_researcher
1155             #raw_slicerec.reg_researchers
1156             raw_slicerec = raw_slicerec.__dict__
1157             logger.debug(" IOTLABDRIVER \t  get_slice_info slice_filter %s  \
1158                             raw_slicerec %s" % (slice_filter, raw_slicerec))
1159             slicerec = raw_slicerec
1160             #only one researcher per slice so take the first one
1161             #slicerec['reg_researchers'] = raw_slicerec['reg_researchers']
1162             #del slicerec['reg_researchers']['_sa_instance_state']
1163             return slicerec
1164
1165         else:
1166             return None
1167
1168     @staticmethod
1169     def _sql_get_slice_info_from_user(slice_filter):
1170         """
1171         Get the slice record based on the user recordid by using a joinedload
1172         on the relationship reg_slices_as_researcher. Format the sql record
1173         into a dict with the mandatory fields for user and slice.
1174         :returns: dict with slice record and user record if the record was found
1175         based on the user's id, None if not..
1176         :rtype:dict or None..
1177         """
1178         #slicerec = dbsession.query(RegRecord).filter_by(record_id = slice_filter).first()
1179         raw_slicerec = dbsession.query(RegUser).options(joinedload('reg_slices_as_researcher')).filter_by(record_id=slice_filter).first()
1180         #raw_slicerec = dbsession.query(RegRecord).filter_by(record_id = slice_filter).first()
1181         #Put it in correct order
1182         user_needed_fields = ['peer_authority', 'hrn', 'last_updated',
1183                               'classtype', 'authority', 'gid', 'record_id',
1184                               'date_created', 'type', 'email', 'pointer']
1185         slice_needed_fields = ['peer_authority', 'hrn', 'last_updated',
1186                                'classtype', 'authority', 'gid', 'record_id',
1187                                'date_created', 'type', 'pointer']
1188         if raw_slicerec:
1189             #raw_slicerec.reg_slices_as_researcher
1190             raw_slicerec = raw_slicerec.__dict__
1191             slicerec = {}
1192             slicerec = \
1193                 dict([(k, raw_slicerec[
1194                     'reg_slices_as_researcher'][0].__dict__[k])
1195                     for k in slice_needed_fields])
1196             slicerec['reg_researchers'] = dict([(k, raw_slicerec[k])
1197                                                 for k in user_needed_fields])
1198              #TODO Handle multiple slices for one user SA 10/12/12
1199                         #for now only take the first slice record associated to the rec user
1200                         ##slicerec  = raw_slicerec['reg_slices_as_researcher'][0].__dict__
1201                         #del raw_slicerec['reg_slices_as_researcher']
1202                         #slicerec['reg_researchers'] = raw_slicerec
1203                         ##del slicerec['_sa_instance_state']
1204
1205             return slicerec
1206
1207         else:
1208             return None
1209
1210     def _get_slice_records(self, slice_filter=None,
1211                            slice_filter_type=None):
1212         """
1213         Get the slice record depending on the slice filter and its type.
1214         :param slice_filter: Can be either the slice hrn or the user's record
1215         id.
1216         :type slice_filter: string
1217         :param slice_filter_type: describes the slice filter type used, can be
1218         slice_hrn or record_id_user
1219         :type: string
1220         :returns: the slice record
1221         :rtype:dict
1222         .. seealso::_sql_get_slice_info_from_user
1223         .. seealso:: _sql_get_slice_info
1224         """
1225
1226         #Get list of slices based on the slice hrn
1227         if slice_filter_type == 'slice_hrn':
1228
1229             #if get_authority(slice_filter) == self.root_auth:
1230                 #login = slice_filter.split(".")[1].split("_")[0]
1231
1232             slicerec = self._sql_get_slice_info(slice_filter)
1233
1234             if slicerec is None:
1235                 return None
1236                 #return login, None
1237
1238         #Get slice based on user id
1239         if slice_filter_type == 'record_id_user':
1240
1241             slicerec = self._sql_get_slice_info_from_user(slice_filter)
1242
1243         if slicerec:
1244             fixed_slicerec_dict = slicerec
1245             #At this point if there is no login it means
1246             #record_id_user filter has been used for filtering
1247             #if login is None :
1248                 ##If theslice record is from iotlab
1249                 #if fixed_slicerec_dict['peer_authority'] is None:
1250                     #login = fixed_slicerec_dict['hrn'].split(".")[1].split("_")[0]
1251             #return login, fixed_slicerec_dict
1252             return fixed_slicerec_dict
1253
1254
1255     def GetSlices(self, slice_filter=None, slice_filter_type=None,
1256                   login=None):
1257         """Get the slice records from the iotlab db and add lease information
1258             if any.
1259
1260         :param slice_filter: can be the slice hrn or slice record id in the db
1261             depending on the slice_filter_type.
1262         :param slice_filter_type: defines the type of the filtering used, Can be
1263             either 'slice_hrn' or "record_id'.
1264         :type slice_filter: string
1265         :type slice_filter_type: string
1266         :returns: a slice dict if slice_filter  and slice_filter_type
1267             are specified and a matching entry is found in the db. The result
1268             is put into a list.Or a list of slice dictionnaries if no filters
1269             arespecified.
1270
1271         :rtype: list
1272
1273         """
1274         #login = None
1275         authorized_filter_types_list = ['slice_hrn', 'record_id_user']
1276         return_slicerec_dictlist = []
1277
1278         #First try to get information on the slice based on the filter provided
1279         if slice_filter_type in authorized_filter_types_list:
1280             fixed_slicerec_dict = self._get_slice_records(slice_filter,
1281                                                           slice_filter_type)
1282             slice_hrn = fixed_slicerec_dict['hrn']
1283
1284             logger.debug(" IOTLABDRIVER \tGetSlices login %s \
1285                             slice record %s slice_filter %s \
1286                             slice_filter_type %s " % (login,
1287                             fixed_slicerec_dict, slice_filter,
1288                             slice_filter_type))
1289
1290
1291             #Now we have the slice record fixed_slicerec_dict, get the
1292             #jobs associated to this slice
1293             leases_list = []
1294
1295             leases_list = self.GetLeases(login=login)
1296             #If no job is running or no job scheduled
1297             #return only the slice record
1298             if leases_list == [] and fixed_slicerec_dict:
1299                 return_slicerec_dictlist.append(fixed_slicerec_dict)
1300
1301             # if the jobs running don't belong to the user/slice we are looking
1302             # for
1303             leases_hrn = [lease['slice_hrn'] for lease in leases_list]
1304             if slice_hrn not in leases_hrn:
1305                 return_slicerec_dictlist.append(fixed_slicerec_dict)
1306             #If several jobs for one slice , put the slice record into
1307             # each lease information dict
1308             for lease in leases_list:
1309                 slicerec_dict = {}
1310                 logger.debug("IOTLABDRIVER.PY  \tGetSlices slice_filter %s   \
1311                         \t lease['slice_hrn'] %s"
1312                              % (slice_filter, lease['slice_hrn']))
1313                 if lease['slice_hrn'] == slice_hrn:
1314                     slicerec_dict['oar_job_id'] = lease['lease_id']
1315                     #Update lease dict with the slice record
1316                     if fixed_slicerec_dict:
1317                         fixed_slicerec_dict['oar_job_id'] = []
1318                         fixed_slicerec_dict['oar_job_id'].append(
1319                             slicerec_dict['oar_job_id'])
1320                         slicerec_dict.update(fixed_slicerec_dict)
1321                         #slicerec_dict.update({'hrn':\
1322                                         #str(fixed_slicerec_dict['slice_hrn'])})
1323                     slicerec_dict['slice_hrn'] = lease['slice_hrn']
1324                     slicerec_dict['hrn'] = lease['slice_hrn']
1325                     slicerec_dict['user'] = lease['user']
1326                     slicerec_dict.update(
1327                         {'list_node_ids':
1328                         {'hostname': lease['reserved_nodes']}})
1329                     slicerec_dict.update({'node_ids': lease['reserved_nodes']})
1330
1331
1332
1333                     return_slicerec_dictlist.append(slicerec_dict)
1334                     logger.debug("IOTLABDRIVER.PY  \tGetSlices  \
1335                         OHOHOHOH %s" %(return_slicerec_dictlist))
1336
1337                 logger.debug("IOTLABDRIVER.PY  \tGetSlices  \
1338                         slicerec_dict %s return_slicerec_dictlist %s \
1339                         lease['reserved_nodes'] \
1340                         %s" % (slicerec_dict, return_slicerec_dictlist,
1341                                lease['reserved_nodes']))
1342
1343             logger.debug("IOTLABDRIVER.PY  \tGetSlices  RETURN \
1344                         return_slicerec_dictlist  %s"
1345                           % (return_slicerec_dictlist))
1346
1347             return return_slicerec_dictlist
1348
1349
1350         else:
1351             #Get all slices from the iotlab sfa database ,
1352             #put them in dict format
1353             #query_slice_list = dbsession.query(RegRecord).all()
1354             query_slice_list = \
1355                 dbsession.query(RegSlice).options(joinedload('reg_researchers')).all()
1356
1357             for record in query_slice_list:
1358                 tmp = record.__dict__
1359                 tmp['reg_researchers'] = tmp['reg_researchers'][0].__dict__
1360                 #del tmp['reg_researchers']['_sa_instance_state']
1361                 return_slicerec_dictlist.append(tmp)
1362                 #return_slicerec_dictlist.append(record.__dict__)
1363
1364             #Get all the jobs reserved nodes
1365             leases_list = self.GetReservedNodes()
1366
1367             for fixed_slicerec_dict in return_slicerec_dictlist:
1368                 slicerec_dict = {}
1369                 #Check if the slice belongs to a iotlab user
1370                 if fixed_slicerec_dict['peer_authority'] is None:
1371                     owner = fixed_slicerec_dict['hrn'].split(
1372                         ".")[1].split("_")[0]
1373                 else:
1374                     owner = None
1375                 for lease in leases_list:
1376                     if owner == lease['user']:
1377                         slicerec_dict['oar_job_id'] = lease['lease_id']
1378
1379                         #for reserved_node in lease['reserved_nodes']:
1380                         logger.debug("IOTLABDRIVER.PY  \tGetSlices lease %s "
1381                                      % (lease))
1382                         slicerec_dict.update(fixed_slicerec_dict)
1383                         slicerec_dict.update({'node_ids':
1384                                               lease['reserved_nodes']})
1385                         slicerec_dict.update({'list_node_ids':
1386                                              {'hostname':
1387                                              lease['reserved_nodes']}})
1388
1389                         #slicerec_dict.update({'hrn':\
1390                                     #str(fixed_slicerec_dict['slice_hrn'])})
1391                         #return_slicerec_dictlist.append(slicerec_dict)
1392                         fixed_slicerec_dict.update(slicerec_dict)
1393
1394             logger.debug("IOTLABDRIVER.PY  \tGetSlices RETURN \
1395                         return_slicerec_dictlist %s \slice_filter %s " \
1396                         %(return_slicerec_dictlist, slice_filter))
1397
1398         return return_slicerec_dictlist
1399
1400
1401
1402     #Update slice unused, therefore  sfa_fields_to_iotlab_fields unused
1403     #SA 30/05/13
1404     #@staticmethod
1405     #def sfa_fields_to_iotlab_fields(sfa_type, hrn, record):
1406         #"""
1407         #"""
1408
1409         #iotlab_record = {}
1410         ##for field in record:
1411         ##    iotlab_record[field] = record[field]
1412
1413         #if sfa_type == "slice":
1414             ##instantion used in get_slivers ?
1415             #if not "instantiation" in iotlab_record:
1416                 #iotlab_record["instantiation"] = "iotlab-instantiated"
1417             ##iotlab_record["hrn"] = hrn_to_pl_slicename(hrn)
1418             ##Unused hrn_to_pl_slicename because Iotlab's hrn already
1419             ##in the appropriate form SA 23/07/12
1420             #iotlab_record["hrn"] = hrn
1421             #logger.debug("IOTLABDRIVER.PY sfa_fields_to_iotlab_fields \
1422                         #iotlab_record %s  " %(iotlab_record['hrn']))
1423             #if "url" in record:
1424                 #iotlab_record["url"] = record["url"]
1425             #if "description" in record:
1426                 #iotlab_record["description"] = record["description"]
1427             #if "expires" in record:
1428                 #iotlab_record["expires"] = int(record["expires"])
1429
1430         ##nodes added by OAR only and then imported to SFA
1431         ##elif type == "node":
1432             ##if not "hostname" in iotlab_record:
1433                 ##if not "hostname" in record:
1434                     ##raise MissingSfaInfo("hostname")
1435                 ##iotlab_record["hostname"] = record["hostname"]
1436             ##if not "model" in iotlab_record:
1437                 ##iotlab_record["model"] = "geni"
1438
1439         ##One authority only
1440         ##elif type == "authority":
1441             ##iotlab_record["login_base"] = hrn_to_iotlab_login_base(hrn)
1442
1443             ##if not "name" in iotlab_record:
1444                 ##iotlab_record["name"] = hrn
1445
1446             ##if not "abbreviated_name" in iotlab_record:
1447                 ##iotlab_record["abbreviated_name"] = hrn
1448
1449             ##if not "enabled" in iotlab_record:
1450                 ##iotlab_record["enabled"] = True
1451
1452             ##if not "is_public" in iotlab_record:
1453                 ##iotlab_record["is_public"] = True
1454
1455         #return iotlab_record
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465