2 This file defines the IotlabSlices class by which all the slice checkings
3 upon lease creation are done.
5 from sfa.util.xrn import get_authority, urn_to_hrn, hrn_to_urn
6 from sfa.util.sfalogging import logger
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
19 rspec_to_slice_tag = {'max_rate': 'net_max_rate'}
21 def __init__(self, driver):
23 Get the reference to the driver here.
27 def get_peer(self, xrn):
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.
34 :param xrn: resource's xrn
40 hrn, hrn_type = urn_to_hrn(xrn)
41 #Does this slice belong to a local site or a peer iotlab site?
44 # get this slice's authority (site)
45 slice_authority = get_authority(hrn)
47 #This slice belongs to the current site
48 if slice_authority == self.driver.testbed_shell.root_auth:
49 site_authority = slice_authority
52 site_authority = get_authority(slice_authority).lower()
53 # get this site's authority (sfa root authority or sub authority)
55 logger.debug("IOTLABSLICES \t get_peer slice_authority %s \
56 site_authority %s hrn %s"
57 % (slice_authority, site_authority, hrn))
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:
65 logger.debug(" IOTLABSLICES \tget_peer peer %s " % (peer))
68 def get_sfa_peer(self, xrn):
69 """Returns the authority name for the xrn or None if the local site
72 :param xrn: the xrn of the resource we are looking the authority for.
74 :returns: the resources's authority name.
78 hrn, hrn_type = urn_to_hrn(xrn)
80 # return the authority for this hrn or None if we are the authority
82 slice_authority = get_authority(hrn)
83 site_authority = get_authority(slice_authority)
85 if site_authority != self.driver.hrn:
86 sfa_peer = site_authority
90 def verify_slice_leases(self, sfa_slice, requested_jobs_dict, peer):
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.
96 :param sfa_slice: sfa slice record
97 :param requested_jobs_dict: dictionary of requested leases
98 :param peer: sfa peer record
100 :type sfa_slice: dict
101 :type requested_jobs_dict: dict
103 :returns: leases list of dictionary
108 logger.debug("IOTLABSLICES verify_slice_leases sfa_slice %s "
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))
115 current_nodes_reserved_by_start_time = {}
116 requested_nodes_by_start_time = {}
117 leases_by_start_time = {}
118 reschedule_jobs_dict = {}
120 #Create reduced dictionary with key start_time and value
122 #-for the leases already registered by OAR first
123 # then for the new leases requested by the user
125 #Leases already scheduled/running in OAR
127 current_nodes_reserved_by_start_time[lease['t_from']] = \
128 lease['reserved_nodes']
129 leases_by_start_time[lease['t_from']] = lease
131 #First remove job whose duration is too short
132 for job in requested_jobs_dict.values():
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']]
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
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
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]
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 \
166 if start_time in current_nodes_reserved_by_start_time:
168 # JORDAN : if we request the same nodes: do nothing
169 if requested_nodes_by_start_time[start_time] == \
170 current_nodes_reserved_by_start_time[start_time]:
175 set(requested_nodes_by_start_time[start_time])
177 update_node_set.difference(\
178 current_nodes_reserved_by_start_time[start_time])
180 update_node_set.intersection(\
181 current_nodes_reserved_by_start_time[start_time])
184 current_nodes_reserved_by_start_time[start_time])
186 old_nodes_set.difference(\
187 requested_nodes_by_start_time[start_time])
188 logger.debug("IOTLABSLICES verify_slice_leases \
189 shared_nodes %s added_nodes %s removed_nodes %s"\
190 %(shared_nodes, added_nodes,removed_nodes ))
191 #If the lease is modified, delete it before
193 #Add the deleted lease job id in the list
194 #WARNING :rescheduling does not work if there is already
195 # 2 running/scheduled jobs because deleting a job
196 #takes time SA 18/10/2012
197 if added_nodes or removed_nodes:
198 deleted_leases.append(\
199 leases_by_start_time[start_time]['lease_id'])
201 if added_nodes or shared_nodes:
202 reschedule_jobs_dict[str(start_time)] = \
203 requested_jobs_dict[str(start_time)]
208 job = requested_jobs_dict[str(start_time)]
209 logger.debug("IOTLABSLICES \
210 NEWLEASE slice %s job %s"
212 job_id = self.driver.AddLeases(
214 sfa_slice, int(job['start_time']),
215 int(job['duration']))
218 #if job_id is not None:
219 # new_leases = self.driver.GetLeases(login=
220 # sfa_slice['login'])
221 # for new_lease in new_leases:
222 # leases.append(new_lease)
224 #Deleted leases are the ones with lease id not declared in the Rspec
226 self.driver.testbed_shell.DeleteLeases(deleted_leases,
228 #self.driver.testbed_shell.DeleteLeases(deleted_leases,
229 # sfa_slice['user']['uid'])
230 logger.debug("IOTLABSLICES \
231 verify_slice_leases slice %s deleted_leases %s"
232 % (sfa_slice, deleted_leases))
234 if reschedule_jobs_dict:
235 for start_time in reschedule_jobs_dict:
236 job = reschedule_jobs_dict[start_time]
237 self.driver.AddLeases(
239 sfa_slice, int(job['start_time']),
240 int(job['duration']))
242 # Added by Jordan: until we find a better solution, always update the list of leases
243 return self.driver.GetLeases(login= sfa_slice['login'])
246 def verify_slice_nodes(self, sfa_slice, requested_slivers, peer):
247 """Check for wanted and unwanted nodes in the slice.
249 Removes nodes and associated leases that the user does not want anymore
250 by deleteing the associated job in OAR (DeleteSliceFromNodes).
251 Returns the nodes' hostnames that are going to be in the slice.
253 :param sfa_slice: slice record. Must contain node_ids and list_node_ids.
255 :param requested_slivers: list of requested nodes' hostnames.
256 :param peer: unused so far.
258 :type sfa_slice: dict
259 :type requested_slivers: list
262 :returns: list requested nodes hostnames
265 .. warning:: UNUSED SQA 24/07/13
266 .. seealso:: DeleteSliceFromNodes
267 .. todo:: check what to do with the peer? Can not remove peer nodes from
268 slice here. Anyway, in this case, the peer should have gotten the
275 if 'node_ids' in sfa_slice:
276 nodes = self.driver.testbed_shell.GetNodes(
277 sfa_slice['list_node_ids'],
279 current_slivers = [node['hostname'] for node in nodes]
281 # remove nodes not in rspec
282 deleted_nodes = list(set(current_slivers).
283 difference(requested_slivers))
285 logger.debug("IOTLABSLICES \tverify_slice_nodes slice %s\
286 \r\n \r\n deleted_nodes %s"
287 % (sfa_slice, deleted_nodes))
290 #Delete the entire experience
291 self.driver.testbed_shell.DeleteSliceFromNodes(sfa_slice)
294 def verify_slice(self, slice_hrn, slice_record, sfa_peer):
295 """Ensures slice record exists.
297 The slice record must exist either in Iotlab or in the other
298 federated testbed (sfa_peer). If the slice does not belong to Iotlab,
299 check if the user already exists in LDAP. In this case, adds the slice
300 to the sfa DB and associates its LDAP user.
302 :param slice_hrn: slice's name
303 :param slice_record: sfa record of the slice
304 :param sfa_peer: name of the peer authority if any.(not Iotlab).
306 :type slice_hrn: string
307 :type slice_record: dictionary
308 :type sfa_peer: string
310 .. seealso:: AddSlice
315 slicename = slice_hrn
318 # check if slice belongs to Iotlab
319 if slicename.startswith("iotlab"):
320 slices_list = self.driver.GetSlices(slice_filter=slicename,
321 slice_filter_type='slice_hrn')
324 for sl in slices_list:
326 logger.debug("IOTLABSLICES \t verify_slice slicename %s \
327 slices_list %s sl %s \r slice_record %s"
328 % (slicename, slices_list, sl, slice_record))
330 sfa_slice.update(slice_record)
333 #Search for user in ldap based on email SA 14/11/12
334 ldap_user = self.driver.testbed_shell.ldap.LdapFindUser(\
335 slice_record['user'])
336 logger.debug(" IOTLABSLICES \tverify_slice Oups \
337 slice_record %s sfa_peer %s ldap_user %s"
338 % (slice_record, sfa_peer, ldap_user))
339 #User already registered in ldap, meaning user should be in SFA db
340 #and hrn = sfa_auth+ uid
341 sfa_slice = {'hrn': slicename,
343 'authority': slice_record['authority'],
344 'gid': slice_record['gid'],
345 #'slice_id': slice_record['record_id'],
346 'reg-researchers': slice_record['reg-researchers'],
347 'urn': hrn_to_urn(slicename,'slice'),
348 #'peer_authority': str(sfa_peer)
352 # hrn = self.driver.testbed_shell.root_auth + '.' \
354 for hrn in slice_record['reg-researchers']:
355 user = self.driver.get_user_record(hrn)
359 logger.debug(" IOTLABSLICES \tverify_slice hrn %s USER %s"
362 # add the external slice to the local SFA iotlab DB
364 self.driver.AddSlice(sfa_slice, user)
366 logger.debug("IOTLABSLICES \tverify_slice ADDSLICE OK")
370 def verify_persons(self, slice_hrn, slice_record, users, options=None):
371 """Ensures the users in users list exist and are enabled in LDAP. Adds
372 person if needed (AddPerson).
374 Checking that a user exist is based on the user's email. If the user is
375 still not found in the LDAP, it means that the user comes from another
376 federated testbed. In this case an account has to be created in LDAP
377 so as to enable the user to use the testbed, since we trust the testbed
378 he comes from. This is done by calling AddPerson.
380 :param slice_hrn: slice name
381 :param slice_record: record of the slice_hrn
382 :param users: users is a record list. Records can either be
383 local records or users records from known and trusted federated
384 sites.If the user is from another site that iotlab doesn't trust
385 yet, then Resolve will raise an error before getting to allocate.
387 :type slice_hrn: string
388 :type slice_record: string
391 .. seealso:: AddPerson
392 .. note:: Removed unused peer and sfa_peer parameters. SA 18/07/13.
396 slice_user = slice_record['user']['hrn']
398 if options is None: options={}
399 logger.debug("IOTLABSLICES \tverify_persons \tslice_hrn %s \
400 \t slice_record %s\r\n users %s \t "
401 % (slice_hrn, slice_record, users))
404 #users_dict : dict whose keys can either be the user's hrn or its id.
405 #Values contains only id and hrn
408 # XXX LOIC !!! Fix: Only 1 user per slice in iotlab
409 users = [slice_record['user']]
410 #First create dicts by hrn and id for each user in the user record list:
412 # if 'slice_record' in info:
413 # slice_rec = info['slice_record']
414 # if 'user' in slice_rec :
415 # user = slice_rec['user']
418 users_by_email[info['email']] = info
419 users_dict[info['email']] = info
421 #logger.debug("IOTLABSLICES.PY \t verify_person \
422 # users_dict %s \r\n user_by_email %s \r\n "
423 # % (users_dict, users_by_email))
425 existing_user_ids = []
426 existing_users_by_email = dict()
428 # Check if user is in Iotlab LDAP using its hrn.
429 # Assuming Iotlab is centralised : one LDAP for all sites,
430 # user's record_id unknown from LDAP
431 # LDAP does not provide users id, therefore we rely on email to find the
435 #Construct the list of filters (list of dicts) for GetPersons
436 filter_user = [users_by_email[email] for email in users_by_email]
437 #Check user i in LDAP with GetPersons
438 #Needed because what if the user has been deleted in LDAP but
440 # GetPersons -> LdapFindUser -> _process_ldap_info_for_one_user
441 # XXX LOIC Fix in _process_ldap_info_for_one_user not to update user with hrn=None
442 existing_users = self.driver.testbed_shell.GetPersons(filter_user)
443 logger.debug(" \r\n IOTLABSLICES.PY \tverify_person filter_user %s\
445 % (filter_user, existing_users))
446 #User is in iotlab LDAP
448 for user in existing_users:
449 user['login'] = user['uid']
450 # XXX LOIC Fix we already have all informations comming from Allocate
451 #users_dict[user['email']].update(user)
452 existing_users_by_email[user['email']] = user
453 logger.debug("User is in iotlab LDAP slice_record[user] = %s" % slice_user)
455 # User from another known trusted federated site. Check
456 # if a iotlab account matching the email has already been created.
459 if isinstance(users, list):
460 req += users[0]['email']
462 req += users['email']
463 ldap_reslt = self.driver.testbed_shell.ldap.LdapSearch(req)
464 logger.debug("LdapSearch slice_record[user] = %s" % slice_user)
466 logger.debug(" IOTLABSLICES.PY \tverify_person users \
467 USER already in Iotlab \t ldap_reslt %s \
469 existing_users.append(ldap_reslt[1])
470 logger.debug("ldap_reslt slice_record[user] = %s" % slice_user)
472 #User not existing in LDAP
473 logger.debug("IOTLABSLICES.PY \tverify_person users \
474 not in ldap ...NEW ACCOUNT NEEDED %s \r\n \t \
475 ldap_reslt %s " % (users, ldap_reslt))
477 requested_user_emails = users_by_email.keys()
478 # requested_user_hrns = \
479 # [users_by_email[user]['hrn'] for user in users_by_email]
480 # logger.debug("IOTLABSLICES.PY \tverify_person \
481 # users_by_email %s " % (users_by_email))
483 # #Check that the user of the slice in the slice record
484 # #matches one of the existing users
486 # if slice_record['reg-researchers'][0] in requested_user_hrns:
487 # logger.debug(" IOTLABSLICES \tverify_person ['PI']\
488 # slice_record %s" % (slice_record))
493 # The function returns a list of added persons (to the LDAP ?)
494 added_persons = list()
496 # We go though each requested user and make sure it exists both in the
497 # LDAP and in the local DB
498 for user_email in requested_user_emails:
499 user = users_by_email[user_email]
502 'peer_person_id': None,
503 'mail' : user['email'],
504 'email' : user['email'],
505 'key_ids' : user.get('key_ids', []),
506 'hrn' : users_by_email[user['email']]['hrn'],
508 if 'first_name' in user:
509 person['first_name'] = user['first_name']
510 if 'last_name' in user:
511 person['last_name'] = user['last_name']
512 if 'person_id' in user:
513 person['person_id'] = user['person_id']
515 # XXX Only one key is kept for IoTLAB
516 person['pkey'] = user['keys'][0]
519 if users_by_email not in existing_users_by_email.keys():
520 ret = self.driver.AddPerson(person)
522 person['uid'] = ret['uid']
523 added_persons.append(person)
525 logger.debug(" IOTLABSLICES ret message %s" %(ret))
527 person['uid'] = existing_users_by_email[user['email']]['uid']
530 self.driver.add_person_to_db(person)
533 # Set the login in the slice_record XXX
534 slice_record['login'] = existing_users[0]['uid']
538 #DEPRECATED| # users to be added, removed or updated
539 #DEPRECATED| #One user in one iotlab slice : there should be no need
540 #DEPRECATED| #to remove/ add any user from/to a slice.
541 #DEPRECATED| #However a user from SFA which is not registered in Iotlab yet
542 #DEPRECATED| #should be added to the LDAP.
543 #DEPRECATED| added_user_emails = set(requested_user_emails).\
544 #DEPRECATED| difference(set(existing_user_emails))
547 #DEPRECATED| #self.verify_keys(existing_slice_users, updated_users_list, \
548 #DEPRECATED| #peer, append)
550 #DEPRECATED| # XXX JORDAN the uid of the user is put in slice_record['login']
551 #DEPRECATED| added_persons = []
552 #DEPRECATED| # add new users
553 #DEPRECATED| #requested_user_email is in existing_user_emails
554 #DEPRECATED| if len(added_user_emails) == 0:
555 #DEPRECATED| slice_record['login'] = existing_users[0]['uid']
556 #DEPRECATED| #slice_record['login'] = users_dict[requested_user_emails[0]]['uid']
557 #DEPRECATED| logger.debug(" IOTLABSLICES \tverify_person QUICK DIRTY %s"
558 #DEPRECATED| % (slice_record))
559 #DEPRECATED| # XXX JORDAN uid == 'register'
560 #DEPRECATED| logger.debug("JORDAN USERS BY EMAIL: %r" % users_by_email)
562 #DEPRECATED| # XXX JORDAN i have no added_user_emails
563 #DEPRECATED| logger.debug("JORDAN: added_user_emails: %r" % added_user_emails)
564 #DEPRECATED| for added_user_email in added_user_emails:
565 #DEPRECATED| added_user = users_dict[added_user_email]
566 #DEPRECATED| logger.debug(" IOTLABSLICES \r\n \r\n \t verify_person \
567 #DEPRECATED| added_user %s" % (added_user))
568 #DEPRECATED| person = {}
569 #DEPRECATED| person['peer_person_id'] = None
570 #DEPRECATED| k_list = ['first_name', 'last_name', 'person_id']
571 #DEPRECATED| for k in k_list:
572 #DEPRECATED| if k in added_user:
573 #DEPRECATED| person[k] = added_user[k]
574 #DEPRECATED| # bug user without key
575 #DEPRECATED| if added_user['keys']:
576 #DEPRECATED| person['pkey'] = added_user['keys'][0]
577 #DEPRECATED| person['mail'] = added_user['email']
578 #DEPRECATED| person['email'] = added_user['email']
579 #DEPRECATED| person['key_ids'] = added_user.get('key_ids', [])
581 #DEPRECATED| # JORDAN
582 #DEPRECATED| # This is the only call to AddPerson. We need to be sure to provide
583 #DEPRECATED| # the right hrn, by default it used to be done in the function like
585 #DEPRECATED| # person['hrn'] = self.testbed_shell.root_auth + '.' + ret['uid']
586 #DEPRECATED| person['hrn'] = users_by_email[added_user['email']]['hrn']
588 #DEPRECATED| # This only deals with the LDAP (now)
589 #DEPRECATED| ret = self.driver.AddPerson(person)
590 #DEPRECATED| # This will check if we have a record in the local DB and add it if necessary
591 #DEPRECATED| self.__add_person_to_db(person)
593 #DEPRECATED| if 'uid' in ret:
594 #DEPRECATED| # meaning bool is True and the AddPerson was successful
595 #DEPRECATED| person['uid'] = ret['uid']
596 #DEPRECATED| slice_record['login'] = person['uid']
598 #DEPRECATED| # error message in ret
599 #DEPRECATED| logger.debug(" IOTLABSLICES ret message %s" %(ret))
601 #DEPRECATED| logger.debug(" IOTLABSLICES \r\n \r\n \t THE SECOND verify_person\
602 #DEPRECATED| person %s" % (person))
603 #DEPRECATED| #Update slice_Record with the id now known to LDAP
606 #DEPRECATED| added_persons.append(person)
607 #DEPRECATED| return added_persons
610 def verify_keys(self, persons, users, peer, options=None):
614 if options is None: options={}
617 for person in persons:
618 key_ids.extend(person['key_ids'])
619 keylist = self.driver.GetKeys(key_ids, ['key_id', 'key'])
623 keydict[key['key']] = key['key_id']
624 existing_keys = keydict.keys()
627 for person in persons:
628 persondict[person['email']] = person
633 users_by_key_string = {}
635 user_keys = user.get('keys', [])
636 updated_persons.append(user)
637 for key_string in user_keys:
638 users_by_key_string[key_string] = user
639 requested_keys.append(key_string)
640 if key_string not in existing_keys:
641 key = {'key': key_string, 'key_type': 'ssh'}
644 #person = persondict[user['email']]
645 #self.driver.testbed_shell.UnBindObjectFromPeer(
646 # 'person',person['person_id'],
648 ret = self.driver.testbed_shell.AddPersonKey(
651 #key_index = user_keys.index(key['key'])
652 #remote_key_id = user['key_ids'][key_index]
653 #self.driver.testbed_shell.BindObjectToPeer('key', \
654 #key['key_id'], peer['shortname'], \
657 # remove old keys (only if we are not appending)
658 append = options.get('append', True)
660 removed_keys = set(existing_keys).difference(requested_keys)
661 for key in removed_keys:
663 #self.driver.testbed_shell.UnBindObjectFromPeer('key', \
664 #key, peer['shortname'])
666 user = users_by_key_string[key]
667 self.driver.testbed_shell.DeleteKey(user, key)