sfa/iotlab/iotlabslices.py

   1 """
   2 This file defines the IotlabSlices class by which all the slice checkings
   3 upon lease creation are done.
   4 """
   5 from sfa.util.xrn import get_authority, urn_to_hrn
   6 from sfa.util.sfalogging import logger
   7
   8 MAXINT = 2L**31-1
   9
  10
  11 class IotlabSlices:
  12     """
  13     This class is responsible for checking the slice when creating a
  14     lease or a sliver. Those checks include verifying that the user is valid,
  15     that the slice is known from the testbed or from our peers, that the list
  16     of nodes involved has not changed (in this case the lease is modified
  17     accordingly).
  18     """
  19     rspec_to_slice_tag = {'max_rate': 'net_max_rate'}
  20
  21     def __init__(self, driver):
  22         """
  23         Get the reference to the driver here.
  24         """
  25         self.driver = driver
  26
  27     def get_peer(self, xrn):
  28         """
  29         Finds the authority of a resource based on its xrn.
  30         If the authority is Iotlab (local) return None,
  31         Otherwise, look up in the DB if Iotlab is federated with this site
  32         authority and returns its DB record if it is the case.
  33
  34         :param xrn: resource's xrn
  35         :type xrn: string
  36         :returns: peer record
  37         :rtype: dict
  38
  39         """
  40         hrn, hrn_type = urn_to_hrn(xrn)
  41         #Does this slice belong to a local site or a peer iotlab site?
  42         peer = None
  43
  44         # get this slice's authority (site)
  45         slice_authority = get_authority(hrn)
  46         #Iotlab stuff
  47         #This slice belongs to the current site
  48         if slice_authority == self.driver.testbed_shell.root_auth:
  49             site_authority = slice_authority
  50             return None
  51
  52         site_authority = get_authority(slice_authority).lower()
  53         # get this site's authority (sfa root authority or sub authority)
  54
  55         logger.debug("IOTLABSLICES \t get_peer slice_authority  %s \
  56                     site_authority %s hrn %s"
  57                      % (slice_authority, site_authority, hrn))
  58
  59         # check if we are already peered with this site_authority
  60         #if so find the peer record
  61         peers = self.driver.GetPeers(peer_filter=site_authority)
  62         for peer_record in peers:
  63             if site_authority == peer_record.hrn:
  64                 peer = peer_record
  65         logger.debug(" IOTLABSLICES \tget_peer peer  %s " % (peer))
  66         return peer
  67
  68     def get_sfa_peer(self, xrn):
  69         """Returns the authority name for the xrn or None if the local site
  70         is the authority.
  71
  72         :param xrn: the xrn of the resource we are looking the authority for.
  73         :type xrn: string
  74         :returns: the resources's authority name.
  75         :rtype: string
  76
  77         """
  78         hrn, hrn_type = urn_to_hrn(xrn)
  79
  80         # return the authority for this hrn or None if we are the authority
  81         sfa_peer = None
  82         slice_authority = get_authority(hrn)
  83         site_authority = get_authority(slice_authority)
  84
  85         if site_authority != self.driver.hrn:
  86             sfa_peer = site_authority
  87
  88         return sfa_peer
  89
  90     def verify_slice_leases(self, sfa_slice, requested_jobs_dict, peer):
  91         """
  92         Compare requested leases with the leases already scheduled/
  93         running in OAR. If necessary, delete and recreate modified leases,
  94         and delete no longer requested ones.
  95
  96         :param sfa_slice: sfa slice record
  97         :param requested_jobs_dict: dictionary of requested leases
  98         :param peer: sfa peer record
  99
 100         :type sfa_slice: dict
 101         :type requested_jobs_dict: dict
 102         :type peer: dict
 103         :returns: leases list of dictionary
 104         :rtype: list
 105
 106         """
 107
 108         logger.debug("IOTLABSLICES verify_slice_leases sfa_slice %s "
 109                      % (sfa_slice))
 110         #First get the list of current leases from OAR
 111         leases = self.driver.GetLeases({'slice_hrn': sfa_slice['hrn']})
 112         logger.debug("IOTLABSLICES verify_slice_leases requested_jobs_dict %s \
 113                         leases %s " % (requested_jobs_dict, leases))
 114
 115         current_nodes_reserved_by_start_time = {}
 116         requested_nodes_by_start_time = {}
 117         leases_by_start_time = {}
 118         reschedule_jobs_dict = {}
 119
 120         #Create reduced dictionary with key start_time and value
 121         # the list of nodes
 122         #-for the leases already registered by OAR first
 123         # then for the new leases requested by the user
 124
 125         #Leases already scheduled/running in OAR
 126         for lease in leases:
 127             current_nodes_reserved_by_start_time[lease['t_from']] = \
 128                     lease['reserved_nodes']
 129             leases_by_start_time[lease['t_from']] = lease
 130
 131         #First remove job whose duration is too short
 132         for job in requested_jobs_dict.values():
 133             job['duration'] = \
 134                 str(int(job['duration']) \
 135                 * self.driver.testbed_shell.GetLeaseGranularity())
 136             if job['duration'] < \
 137                     self.driver.testbed_shell.GetLeaseGranularity():
 138                 del requested_jobs_dict[job['start_time']]
 139
 140         #Requested jobs
 141         for start_time in requested_jobs_dict:
 142             requested_nodes_by_start_time[int(start_time)] = \
 143                 requested_jobs_dict[start_time]['hostname']
 144         #Check if there is any difference between the leases already
 145         #registered in OAR and the requested jobs.
 146         #Difference could be:
 147         #-Lease deleted in the requested jobs
 148         #-Added/removed nodes
 149         #-Newly added lease
 150
 151         logger.debug("IOTLABSLICES verify_slice_leases \
 152                         requested_nodes_by_start_time %s \
 153                         "% (requested_nodes_by_start_time))
 154         #Find all deleted leases
 155         start_time_list = \
 156             list(set(leases_by_start_time.keys()).\
 157             difference(requested_nodes_by_start_time.keys()))
 158         deleted_leases = [leases_by_start_time[start_time]['lease_id'] \
 159                             for start_time in start_time_list]
 160
 161
 162         #Find added or removed nodes in exisiting leases
 163         for start_time in requested_nodes_by_start_time:
 164             logger.debug("IOTLABSLICES verify_slice_leases  start_time %s \
 165                          "%( start_time))
 166             if start_time in current_nodes_reserved_by_start_time:
 167
 168                 if requested_nodes_by_start_time[start_time] == \
 169                     current_nodes_reserved_by_start_time[start_time]:
 170                     continue
 171
 172                 else:
 173                     update_node_set = \
 174                             set(requested_nodes_by_start_time[start_time])
 175                     added_nodes = \
 176                         update_node_set.difference(\
 177                         current_nodes_reserved_by_start_time[start_time])
 178                     shared_nodes = \
 179                         update_node_set.intersection(\
 180                         current_nodes_reserved_by_start_time[start_time])
 181                     old_nodes_set = \
 182                         set(\
 183                         current_nodes_reserved_by_start_time[start_time])
 184                     removed_nodes = \
 185                         old_nodes_set.difference(\
 186                         requested_nodes_by_start_time[start_time])
 187                     logger.debug("IOTLABSLICES verify_slice_leases \
 188                         shared_nodes %s  added_nodes %s removed_nodes %s"\
 189                         %(shared_nodes, added_nodes,removed_nodes ))
 190                     #If the lease is modified, delete it before
 191                     #creating it again.
 192                     #Add the deleted lease job id in the list
 193                     #WARNING :rescheduling does not work if there is already
 194                     # 2 running/scheduled jobs because deleting a job
 195                     #takes time SA 18/10/2012
 196                     if added_nodes or removed_nodes:
 197                         deleted_leases.append(\
 198                             leases_by_start_time[start_time]['lease_id'])
 199                         #Reschedule the job
 200                         if added_nodes or shared_nodes:
 201                             reschedule_jobs_dict[str(start_time)] = \
 202                                         requested_jobs_dict[str(start_time)]
 203
 204             else:
 205                     #New lease
 206
 207                 job = requested_jobs_dict[str(start_time)]
 208                 logger.debug("IOTLABSLICES \
 209                               NEWLEASE slice %s  job %s"
 210                              % (sfa_slice, job))
 211                 job_id = self.driver.AddLeases(
 212                     job['hostname'],
 213                     sfa_slice, int(job['start_time']),
 214                     int(job['duration']))
 215                 if job_id is not None:
 216                     new_leases = self.driver.GetLeases(login=
 217                         sfa_slice['login'])
 218                     for new_lease in new_leases:
 219                         leases.append(new_lease)
 220
 221         #Deleted leases are the ones with lease id not declared in the Rspec
 222         if deleted_leases:
 223             self.driver.testbed_shell.DeleteLeases(deleted_leases,
 224                                                 sfa_slice['login'])
 225             #self.driver.testbed_shell.DeleteLeases(deleted_leases,
 226             #                                    sfa_slice['user']['uid'])
 227             logger.debug("IOTLABSLICES \
 228                           verify_slice_leases slice %s deleted_leases %s"
 229                          % (sfa_slice, deleted_leases))
 230
 231         if reschedule_jobs_dict:
 232             for start_time in reschedule_jobs_dict:
 233                 job = reschedule_jobs_dict[start_time]
 234                 self.driver.AddLeases(
 235                     job['hostname'],
 236                     sfa_slice, int(job['start_time']),
 237                     int(job['duration']))
 238         return leases
 239
 240     def verify_slice_nodes(self, sfa_slice, requested_slivers, peer):
 241         """Check for wanted and unwanted nodes in the slice.
 242
 243         Removes nodes and associated leases that the user does not want anymore
 244         by deleteing the associated job in OAR (DeleteSliceFromNodes).
 245         Returns the nodes' hostnames that are going to be in the slice.
 246
 247         :param sfa_slice: slice record. Must contain node_ids and list_node_ids.
 248
 249         :param requested_slivers: list of requested nodes' hostnames.
 250         :param peer: unused so far.
 251
 252         :type sfa_slice: dict
 253         :type requested_slivers: list
 254         :type peer: string
 255
 256         :returns: list requested nodes hostnames
 257         :rtype: list
 258
 259         .. warning:: UNUSED SQA 24/07/13
 260         .. seealso:: DeleteSliceFromNodes
 261         .. todo:: check what to do with the peer? Can not remove peer nodes from
 262             slice here. Anyway, in this case, the peer should have gotten the
 263             remove request too.
 264
 265         """
 266         current_slivers = []
 267         deleted_nodes = []
 268
 269         if 'node_ids' in sfa_slice:
 270             nodes = self.driver.testbed_shell.GetNodes(
 271                 sfa_slice['list_node_ids'],
 272                 ['hostname'])
 273             current_slivers = [node['hostname'] for node in nodes]
 274
 275             # remove nodes not in rspec
 276             deleted_nodes = list(set(current_slivers).
 277                                  difference(requested_slivers))
 278
 279             logger.debug("IOTLABSLICES \tverify_slice_nodes slice %s\
 280                                          \r\n \r\n deleted_nodes %s"
 281                          % (sfa_slice, deleted_nodes))
 282
 283             if deleted_nodes:
 284                 #Delete the entire experience
 285                 self.driver.testbed_shell.DeleteSliceFromNodes(sfa_slice)
 286             return nodes
 287
 288     def verify_slice(self, slice_hrn, slice_record, sfa_peer):
 289         """Ensures slice record exists.
 290
 291         The slice record must exist either in Iotlab or in the other
 292         federated testbed (sfa_peer). If the slice does not belong to Iotlab,
 293         check if the user already exists in LDAP. In this case, adds the slice
 294         to the sfa DB and associates its LDAP user.
 295
 296         :param slice_hrn: slice's name
 297         :param slice_record: sfa record of the slice
 298         :param sfa_peer: name of the peer authority if any.(not Iotlab).
 299
 300         :type slice_hrn: string
 301         :type slice_record: dictionary
 302         :type sfa_peer: string
 303
 304         .. seealso:: AddSlice
 305
 306
 307         """
 308
 309         slicename = slice_hrn
 310         # check if slice belongs to Iotlab
 311         slices_list = self.driver.GetSlices(slice_filter=slicename,
 312                                             slice_filter_type='slice_hrn')
 313
 314         sfa_slice = None
 315
 316         if slices_list:
 317             for sl in slices_list:
 318
 319                 logger.debug("IOTLABSLICES \t verify_slice slicename %s \
 320                                 slices_list %s sl %s \r slice_record %s"
 321                              % (slicename, slices_list, sl, slice_record))
 322                 sfa_slice = sl
 323                 sfa_slice.update(slice_record)
 324
 325         else:
 326             #Search for user in ldap based on email SA 14/11/12
 327             ldap_user = self.driver.testbed_shell.ldap.LdapFindUser(\
 328                                                     slice_record['user'])
 329             logger.debug(" IOTLABSLICES \tverify_slice Oups \
 330                         slice_record %s sfa_peer %s ldap_user %s"
 331                         % (slice_record, sfa_peer, ldap_user))
 332             #User already registered in ldap, meaning user should be in SFA db
 333             #and hrn = sfa_auth+ uid
 334             sfa_slice = {'hrn': slicename,
 335                          'node_list': [],
 336                          'authority': slice_record['authority'],
 337                          'gid': slice_record['gid'],
 338                          'slice_id': slice_record['record_id'],
 339                          'reg-researchers': slice_record['reg-researchers'],
 340                          'peer_authority': str(sfa_peer)
 341                          }
 342
 343             if ldap_user:
 344                 hrn = self.driver.testbed_shell.root_auth + '.' \
 345                                                 + ldap_user['uid']
 346                 user = self.driver.get_user_record(hrn)
 347
 348                 logger.debug(" IOTLABSLICES \tverify_slice hrn %s USER %s"
 349                              % (hrn, user))
 350
 351                  # add the external slice to the local SFA iotlab DB
 352                 if sfa_slice:
 353                     self.driver.AddSlice(sfa_slice, user)
 354
 355             logger.debug("IOTLABSLICES \tverify_slice ADDSLICE OK")
 356         return sfa_slice
 357
 358
 359     def verify_persons(self, slice_hrn, slice_record, users, options={}):
 360         """Ensures the users in users list exist and are enabled in LDAP. Adds
 361         person if needed (AddPerson).
 362
 363         Checking that a user exist is based on the user's email. If the user is
 364         still not found in the LDAP, it means that the user comes from another
 365         federated testbed. In this case an account has to be created in LDAP
 366         so as to enable the user to use the testbed, since we trust the testbed
 367         he comes from. This is done by calling AddPerson.
 368
 369         :param slice_hrn: slice name
 370         :param slice_record: record of the slice_hrn
 371         :param users: users is a record list. Records can either be
 372             local records or users records from known and trusted federated
 373             sites.If the user is from another site that iotlab doesn't trust
 374             yet, then Resolve will raise an error before getting to allocate.
 375
 376         :type slice_hrn: string
 377         :type slice_record: string
 378         :type users: list
 379
 380         .. seealso:: AddPerson
 381         .. note:: Removed unused peer and sfa_peer parameters. SA 18/07/13.
 382
 383
 384         """
 385
 386         logger.debug("IOTLABSLICES \tverify_persons \tslice_hrn  %s  \
 387                     \t slice_record %s\r\n users %s \t  "
 388                      % (slice_hrn, slice_record, users))
 389
 390         users_by_email = {}
 391         #users_dict : dict whose keys can either be the user's hrn or its id.
 392         #Values contains only id and hrn
 393         users_dict = {}
 394
 395         #First create dicts by hrn and id for each user in the user record list:
 396         for info in users:
 397             # if 'slice_record' in info:
 398             #     slice_rec = info['slice_record']
 399                 # if 'user' in slice_rec :
 400                 #     user = slice_rec['user']
 401
 402             if 'email' in info:
 403                 users_by_email[info['email']] = info
 404                 users_dict[info['email']] = info
 405
 406         logger.debug("IOTLABSLICES.PY \t verify_person  \
 407                         users_dict %s \r\n user_by_email %s \r\n  "
 408                      % (users_dict, users_by_email))
 409
 410         existing_user_ids = []
 411         existing_user_emails = []
 412         existing_users = []
 413         # Check if user is in Iotlab LDAP using its hrn.
 414         # Assuming Iotlab is centralised :  one LDAP for all sites,
 415         # user's record_id unknown from LDAP
 416         # LDAP does not provide users id, therefore we rely on email to find the
 417         # user in LDAP
 418
 419         if users_by_email:
 420             #Construct the list of filters (list of dicts) for GetPersons
 421             filter_user = [users_by_email[email] for email in users_by_email]
 422             #Check user i in LDAP with GetPersons
 423             #Needed because what if the user has been deleted in LDAP but
 424             #is still in SFA?
 425             existing_users = self.driver.testbed_shell.GetPersons(filter_user)
 426             logger.debug(" \r\n IOTLABSLICES.PY \tverify_person  filter_user %s\
 427                        existing_users %s  "
 428                         % (filter_user, existing_users))
 429             #User is in iotlab LDAP
 430             if existing_users:
 431                 for user in existing_users:
 432                     user['login'] = user['uid']
 433                     users_dict[user['email']].update(user)
 434                     existing_user_emails.append(
 435                         users_dict[user['email']]['email'])
 436
 437
 438             # User from another known trusted federated site. Check
 439             # if a iotlab account matching the email has already been created.
 440             else:
 441                 req = 'mail='
 442                 if isinstance(users, list):
 443                     req += users[0]['email']
 444                 else:
 445                     req += users['email']
 446                 ldap_reslt = self.driver.testbed_shell.ldap.LdapSearch(req)
 447
 448                 if ldap_reslt:
 449                     logger.debug(" IOTLABSLICES.PY \tverify_person users \
 450                                 USER already in Iotlab \t ldap_reslt %s \
 451                                 " % (ldap_reslt))
 452                     existing_users.append(ldap_reslt[1])
 453
 454                 else:
 455                     #User not existing in LDAP
 456                     logger.debug("IOTLABSLICES.PY \tverify_person users \
 457                                 not in ldap ...NEW ACCOUNT NEEDED %s \r\n \t \
 458                                 ldap_reslt %s " % (users, ldap_reslt))
 459
 460         requested_user_emails = users_by_email.keys()
 461         # requested_user_hrns = \
 462         #     [users_by_email[user]['hrn'] for user in users_by_email]
 463         # logger.debug("IOTLABSLICES.PY \tverify_person  \
 464         #                users_by_email  %s " % (users_by_email))
 465
 466         # #Check that the user of the slice in the slice record
 467         # #matches one of the existing users
 468         # try:
 469         #     if slice_record['reg-researchers'][0] in requested_user_hrns:
 470         #         logger.debug(" IOTLABSLICES  \tverify_person ['PI']\
 471         #                         slice_record %s" % (slice_record))
 472
 473         # except KeyError:
 474         #     pass
 475
 476         # users to be added, removed or updated
 477         #One user in one iotlab slice : there should be no need
 478         #to remove/ add any user from/to a slice.
 479         #However a user from SFA which is not registered in Iotlab yet
 480         #should be added to the LDAP.
 481         added_user_emails = set(requested_user_emails).\
 482                                         difference(set(existing_user_emails))
 483
 484
 485         #self.verify_keys(existing_slice_users, updated_users_list, \
 486                                                             #peer, append)
 487
 488         added_persons = []
 489         # add new users
 490         #requested_user_email is in existing_user_emails
 491         if len(added_user_emails) == 0:
 492             slice_record['login'] = users_dict[requested_user_emails[0]]['uid']
 493             logger.debug(" IOTLABSLICES  \tverify_person QUICK DIRTY %s"
 494                          % (slice_record))
 495
 496         for added_user_email in added_user_emails:
 497             added_user = users_dict[added_user_email]
 498             logger.debug(" IOTLABSLICES \r\n \r\n  \t  verify_person \
 499                          added_user %s" % (added_user))
 500             person = {}
 501             person['peer_person_id'] = None
 502             k_list = ['first_name', 'last_name', 'person_id']
 503             for k in k_list:
 504                 if k in added_user:
 505                     person[k] = added_user[k]
 506             # bug user without key
 507             if added_user['keys']:
 508                 person['pkey'] = added_user['keys'][0]
 509             person['mail'] = added_user['email']
 510             person['email'] = added_user['email']
 511             person['key_ids'] = added_user.get('key_ids', [])
 512
 513             ret = self.driver.AddPerson(person)
 514             if 'uid' in ret:
 515                 # meaning bool is True and the AddPerson was successful
 516                 person['uid'] = ret['uid']
 517                 slice_record['login'] = person['uid']
 518             else:
 519                 # error message in ret
 520                 logger.debug(" IOTLABSLICES ret message %s" %(ret))
 521
 522             logger.debug(" IOTLABSLICES \r\n \r\n  \t THE SECOND verify_person\
 523                            person %s" % (person))
 524             #Update slice_Record with the id now known to LDAP
 525
 526
 527             added_persons.append(person)
 528         return added_persons
 529
 530
 531     def verify_keys(self, persons, users, peer, options={}):
 532         """
 533         .. warning:: unused
 534         """
 535         # existing keys
 536         key_ids = []
 537         for person in persons:
 538             key_ids.extend(person['key_ids'])
 539         keylist = self.driver.GetKeys(key_ids, ['key_id', 'key'])
 540
 541         keydict = {}
 542         for key in keylist:
 543             keydict[key['key']] = key['key_id']
 544         existing_keys = keydict.keys()
 545
 546         persondict = {}
 547         for person in persons:
 548             persondict[person['email']] = person
 549
 550         # add new keys
 551         requested_keys = []
 552         updated_persons = []
 553         users_by_key_string = {}
 554         for user in users:
 555             user_keys = user.get('keys', [])
 556             updated_persons.append(user)
 557             for key_string in user_keys:
 558                 users_by_key_string[key_string] = user
 559                 requested_keys.append(key_string)
 560                 if key_string not in existing_keys:
 561                     key = {'key': key_string, 'key_type': 'ssh'}
 562                     #try:
 563                         ##if peer:
 564                             #person = persondict[user['email']]
 565                             #self.driver.testbed_shell.UnBindObjectFromPeer(
 566                                 # 'person',person['person_id'],
 567                                 # peer['shortname'])
 568                     ret = self.driver.testbed_shell.AddPersonKey(
 569                         user['email'], key)
 570                         #if peer:
 571                             #key_index = user_keys.index(key['key'])
 572                             #remote_key_id = user['key_ids'][key_index]
 573                             #self.driver.testbed_shell.BindObjectToPeer('key', \
 574                                             #key['key_id'], peer['shortname'], \
 575                                             #remote_key_id)
 576
 577         # remove old keys (only if we are not appending)
 578         append = options.get('append', True)
 579         if append is False:
 580             removed_keys = set(existing_keys).difference(requested_keys)
 581             for key in removed_keys:
 582                     #if peer:
 583                         #self.driver.testbed_shell.UnBindObjectFromPeer('key', \
 584                                         #key, peer['shortname'])
 585
 586                 user = users_by_key_string[key]
 587                 self.driver.testbed_shell.DeleteKey(user, key)
 588
 589         return