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
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.iotlab_api.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.iotlab_api.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.iotlab_api.GetLeases({'name': 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.iotlab_api.GetLeaseGranularity())
136 if job['duration'] < self.driver.iotlab_api.GetLeaseGranularity():
137 del requested_jobs_dict[job['start_time']]
140 for start_time in requested_jobs_dict:
141 requested_nodes_by_start_time[int(start_time)] = \
142 requested_jobs_dict[start_time]['hostname']
143 #Check if there is any difference between the leases already
144 #registered in OAR and the requested jobs.
145 #Difference could be:
146 #-Lease deleted in the requested jobs
147 #-Added/removed nodes
150 logger.debug("IOTLABSLICES verify_slice_leases \
151 requested_nodes_by_start_time %s \
152 "% (requested_nodes_by_start_time))
153 #Find all deleted leases
155 list(set(leases_by_start_time.keys()).\
156 difference(requested_nodes_by_start_time.keys()))
157 deleted_leases = [leases_by_start_time[start_time]['lease_id'] \
158 for start_time in start_time_list]
161 #Find added or removed nodes in exisiting leases
162 for start_time in requested_nodes_by_start_time:
163 logger.debug("IOTLABSLICES verify_slice_leases start_time %s \
165 if start_time in current_nodes_reserved_by_start_time:
167 if requested_nodes_by_start_time[start_time] == \
168 current_nodes_reserved_by_start_time[start_time]:
173 set(requested_nodes_by_start_time[start_time])
175 update_node_set.difference(\
176 current_nodes_reserved_by_start_time[start_time])
178 update_node_set.intersection(\
179 current_nodes_reserved_by_start_time[start_time])
182 current_nodes_reserved_by_start_time[start_time])
184 old_nodes_set.difference(\
185 requested_nodes_by_start_time[start_time])
186 logger.debug("IOTLABSLICES verify_slice_leases \
187 shared_nodes %s added_nodes %s removed_nodes %s"\
188 %(shared_nodes, added_nodes,removed_nodes ))
189 #If the lease is modified, delete it before
191 #Add the deleted lease job id in the list
192 #WARNING :rescheduling does not work if there is already
193 # 2 running/scheduled jobs because deleting a job
194 #takes time SA 18/10/2012
195 if added_nodes or removed_nodes:
196 deleted_leases.append(\
197 leases_by_start_time[start_time]['lease_id'])
199 if added_nodes or shared_nodes:
200 reschedule_jobs_dict[str(start_time)] = \
201 requested_jobs_dict[str(start_time)]
206 job = requested_jobs_dict[str(start_time)]
207 logger.debug("IOTLABSLICES \
208 NEWLEASE slice %s job %s"
210 self.driver.iotlab_api.AddLeases(
212 sfa_slice, int(job['start_time']),
213 int(job['duration']))
215 #Deleted leases are the ones with lease id not declared in the Rspec
217 self.driver.iotlab_api.DeleteLeases(deleted_leases,
218 sfa_slice['user']['uid'])
219 logger.debug("IOTLABSLICES \
220 verify_slice_leases slice %s deleted_leases %s"
221 % (sfa_slice, deleted_leases))
223 if reschedule_jobs_dict:
224 for start_time in reschedule_jobs_dict:
225 job = reschedule_jobs_dict[start_time]
226 self.driver.iotlab_api.AddLeases(
228 sfa_slice, int(job['start_time']),
229 int(job['duration']))
232 def verify_slice_nodes(self, sfa_slice, requested_slivers, peer):
233 """Check for wanted and unwanted nodes in the slice.
235 Removes nodes and associated leases that the user does not want anymore
236 by deleteing the associated job in OAR (DeleteSliceFromNodes).
237 Returns the nodes' hostnames that are going to be in the slice.
239 :param sfa_slice: slice record. Must contain node_ids and list_node_ids.
241 :param requested_slivers: list of requested nodes' hostnames.
242 :param peer: unused so far.
244 :type sfa_slice: dict
245 :type requested_slivers: list
248 :returns: list requested nodes hostnames
251 .. warning:: UNUSED SQA 24/07/13
252 .. seealso:: DeleteSliceFromNodes
253 .. todo:: check what to do with the peer? Can not remove peer nodes from
254 slice here. Anyway, in this case, the peer should have gotten the
261 if 'node_ids' in sfa_slice:
262 nodes = self.driver.iotlab_api.GetNodes(
263 sfa_slice['list_node_ids'],
265 current_slivers = [node['hostname'] for node in nodes]
267 # remove nodes not in rspec
268 deleted_nodes = list(set(current_slivers).
269 difference(requested_slivers))
271 logger.debug("IOTLABSLICES \tverify_slice_nodes slice %s\
272 \r\n \r\n deleted_nodes %s"
273 % (sfa_slice, deleted_nodes))
276 #Delete the entire experience
277 self.driver.iotlab_api.DeleteSliceFromNodes(sfa_slice)
280 def verify_slice(self, slice_hrn, slice_record, sfa_peer):
281 """Ensures slice record exists.
283 The slice record must exist either in Iotlab or in the other
284 federated testbed (sfa_peer). If the slice does not belong to Iotlab,
285 check if the user already exists in LDAP. In this case, adds the slice
286 to the sfa DB and associates its LDAP user.
288 :param slice_hrn: slice's name
289 :param slice_record: sfa record of the slice
290 :param sfa_peer: name of the peer authority if any.(not Iotlab).
292 :type slice_hrn: string
293 :type slice_record: dictionary
294 :type sfa_peer: string
296 .. seealso:: AddSlice
301 slicename = slice_hrn
302 # check if slice belongs to Iotlab
303 slices_list = self.driver.iotlab_api.GetSlices(
304 slice_filter=slicename, slice_filter_type='slice_hrn')
309 for sl in slices_list:
311 logger.debug("SLABSLICE \t verify_slice slicename %s \
312 slices_list %s sl %s \r slice_record %s"
313 % (slicename, slices_list, sl, slice_record))
315 sfa_slice.update(slice_record)
318 #Search for user in ldap based on email SA 14/11/12
319 ldap_user = self.driver.iotlab_api.ldap.LdapFindUser(\
320 slice_record['user'])
321 logger.debug(" IOTLABSLICES \tverify_slice Oups \
322 slice_record %s sfa_peer %s ldap_user %s"
323 % (slice_record, sfa_peer, ldap_user))
324 #User already registered in ldap, meaning user should be in SFA db
325 #and hrn = sfa_auth+ uid
326 sfa_slice = {'hrn': slicename,
328 'authority': slice_record['authority'],
329 'gid': slice_record['gid'],
330 'slice_id': slice_record['record_id'],
331 'reg-researchers': slice_record['reg-researchers'],
332 'peer_authority': str(sfa_peer)
336 hrn = self.driver.iotlab_api.root_auth + '.' + ldap_user['uid']
337 user = self.driver.get_user_record(hrn)
339 logger.debug(" IOTLABSLICES \tverify_slice hrn %s USER %s"
342 # add the external slice to the local SFA iotlab DB
344 self.driver.iotlab_api.AddSlice(sfa_slice, user)
346 logger.debug("IOTLABSLICES \tverify_slice ADDSLICE OK")
350 def verify_persons(self, slice_hrn, slice_record, users, options={}):
351 """Ensures the users in users list exist and are enabled in LDAP. Adds
354 Checking that a user exist is based on the user's email. If the user is
355 still not found in the LDAP, it means that the user comes from another
356 federated testbed. In this case an account has to be created in LDAP
357 so as to enable the user to use the testbed, since we trust the testbed
358 he comes from. This is done by calling AddPerson.
360 :param slice_hrn: slice name
361 :param slice_record: record of the slice_hrn
362 :param users: users is a record list. Records can either be
363 local records or users records from known and trusted federated
364 sites.If the user is from another site that iotlab doesn't trust yet,
365 then Resolve will raise an error before getting to create_sliver.
367 :type slice_hrn: string
368 :type slice_record: string
371 .. seealso:: AddPerson
372 .. note:: Removed unused peer and sfa_peer parameters. SA 18/07/13.
376 #TODO SA 21/08/12 verify_persons Needs review
378 logger.debug("IOTLABSLICES \tverify_persons \tslice_hrn %s \
379 \t slice_record %s\r\n users %s \t "
380 % (slice_hrn, slice_record, users))
384 #users_dict : dict whose keys can either be the user's hrn or its id.
385 #Values contains only id and hrn
388 #First create dicts by hrn and id for each user in the user record list:
390 if 'slice_record' in info:
391 slice_rec = info['slice_record']
392 user = slice_rec['user']
395 users_by_email[user['email']] = user
396 users_dict[user['email']] = user
398 logger.debug("SLABSLICE.PY \t verify_person \
399 users_dict %s \r\n user_by_email %s \r\n \
401 % (users_dict, users_by_email, users_by_id))
403 existing_user_ids = []
404 existing_user_emails = []
406 # Check if user is in Iotlab LDAP using its hrn.
407 # Assuming Iotlab is centralised : one LDAP for all sites,
408 # user's record_id unknown from LDAP
409 # LDAP does not provide users id, therefore we rely on email to find the
413 #Construct the list of filters (list of dicts) for GetPersons
414 filter_user = [users_by_email[email] for email in users_by_email]
415 #Check user i in LDAP with GetPersons
416 #Needed because what if the user has been deleted in LDAP but
418 existing_users = self.driver.iotlab_api.GetPersons(filter_user)
419 logger.debug(" \r\n SLABSLICE.PY \tverify_person filter_user \
420 %s existing_users %s "
421 % (filter_user, existing_users))
422 #User is in iotlab LDAP
424 for user in existing_users:
425 users_dict[user['email']].update(user)
426 existing_user_emails.append(
427 users_dict[user['email']]['email'])
430 # User from another known trusted federated site. Check
431 # if a iotlab account matching the email has already been created.
434 if isinstance(users, list):
435 req += users[0]['email']
437 req += users['email']
438 ldap_reslt = self.driver.iotlab_api.ldap.LdapSearch(req)
441 logger.debug(" SLABSLICE.PY \tverify_person users \
442 USER already in Iotlab \t ldap_reslt %s \
444 existing_users.append(ldap_reslt[1])
447 #User not existing in LDAP
448 logger.debug("SLABSLICE.PY \tverify_person users \
449 not in ldap ...NEW ACCOUNT NEEDED %s \r\n \t \
450 ldap_reslt %s " % (users, ldap_reslt))
452 requested_user_emails = users_by_email.keys()
453 requested_user_hrns = \
454 [users_by_email[user]['hrn'] for user in users_by_email]
455 logger.debug("SLABSLICE.PY \tverify_person \
456 users_by_email %s " % (users_by_email))
458 #Check that the user of the slice in the slice record
459 #matches one of the existing users
461 if slice_record['PI'][0] in requested_user_hrns:
462 logger.debug(" SLABSLICE \tverify_person ['PI']\
463 slice_record %s" % (slice_record))
468 # users to be added, removed or updated
469 #One user in one iotlab slice : there should be no need
470 #to remove/ add any user from/to a slice.
471 #However a user from SFA which is not registered in Iotlab yet
472 #should be added to the LDAP.
473 added_user_emails = set(requested_user_emails).\
474 difference(set(existing_user_emails))
477 #self.verify_keys(existing_slice_users, updated_users_list, \
482 #requested_user_email is in existing_user_emails
483 if len(added_user_emails) == 0:
484 slice_record['login'] = users_dict[requested_user_emails[0]]['uid']
485 logger.debug(" SLABSLICE \tverify_person QUICK DIRTY %s"
488 for added_user_email in added_user_emails:
489 added_user = users_dict[added_user_email]
490 logger.debug(" IOTLABSLICES \r\n \r\n \t verify_person \
491 added_user %s" % (added_user))
493 person['peer_person_id'] = None
494 k_list = ['first_name', 'last_name', 'person_id']
497 person[k] = added_user[k]
499 person['pkey'] = added_user['keys'][0]
500 person['mail'] = added_user['email']
501 person['email'] = added_user['email']
502 person['key_ids'] = added_user.get('key_ids', [])
504 ret = self.driver.iotlab_api.AddPerson(person)
506 # meaning bool is True and the AddPerson was successful
507 person['uid'] = ret['uid']
508 slice_record['login'] = person['uid']
510 # error message in ret
511 logger.debug(" IOTLABSLICES ret message %s" %(ret))
513 logger.debug(" SLABSLICE \r\n \r\n \t THE SECOND verify_person\
514 person %s" % (person))
515 #Update slice_Record with the id now known to LDAP
518 added_persons.append(person)
522 def verify_keys(self, persons, users, peer, options={}):
528 for person in persons:
529 key_ids.extend(person['key_ids'])
530 keylist = self.driver.iotlab_api.GetKeys(key_ids, ['key_id', 'key'])
534 keydict[key['key']] = key['key_id']
535 existing_keys = keydict.keys()
538 for person in persons:
539 persondict[person['email']] = person
544 users_by_key_string = {}
546 user_keys = user.get('keys', [])
547 updated_persons.append(user)
548 for key_string in user_keys:
549 users_by_key_string[key_string] = user
550 requested_keys.append(key_string)
551 if key_string not in existing_keys:
552 key = {'key': key_string, 'key_type': 'ssh'}
555 #person = persondict[user['email']]
556 #self.driver.iotlab_api.UnBindObjectFromPeer(
557 # 'person',person['person_id'],
559 ret = self.driver.iotlab_api.AddPersonKey(
562 #key_index = user_keys.index(key['key'])
563 #remote_key_id = user['key_ids'][key_index]
564 #self.driver.iotlab_api.BindObjectToPeer('key', \
565 #key['key_id'], peer['shortname'], \
570 #self.driver.iotlab_api.BindObjectToPeer('person', \
571 #person['person_id'], peer['shortname'], \
574 # remove old keys (only if we are not appending)
575 append = options.get('append', True)
577 removed_keys = set(existing_keys).difference(requested_keys)
578 for key in removed_keys:
580 #self.driver.iotlab_api.UnBindObjectFromPeer('key', \
581 #key, peer['shortname'])
583 user = users_by_key_string[key]
584 self.driver.iotlab_api.DeleteKey(user, key)