PL driver: Fix verification of site, person and slice triggered by CreateSliver
[sfa.git] / sfa / planetlab / plslices.py
1 from types import StringTypes
2 from collections import defaultdict
3
4 from sfa.util.sfatime import utcparse, datetime_to_epoch
5 from sfa.util.sfalogging import logger
6 from sfa.util.xrn import Xrn, get_leaf, get_authority, urn_to_hrn
7
8 from sfa.rspecs.rspec import RSpec
9
10 from sfa.planetlab.vlink import VLink
11 from sfa.planetlab.plxrn import PlXrn, hrn_to_pl_slicename, xrn_to_hostname
12
13 import time
14
15 MAXINT =  2L**31-1
16
17 class PlSlices:
18
19     rspec_to_slice_tag = {'max_rate':'net_max_rate'}
20
21     def __init__(self, driver):
22         self.driver = driver
23
24     def get_slivers(self, xrn, node=None):
25         hrn, type = urn_to_hrn(xrn)
26          
27         slice_name = hrn_to_pl_slicename(hrn)
28         # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
29         # of doing all of this?
30         #return self.driver.shell.GetSliceTicket(self.auth, slice_name) 
31         
32         # from PLCAPI.GetSlivers.get_slivers()
33         slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
34         slices = self.driver.shell.GetSlices(slice_name, slice_fields)
35         # Build up list of users and slice attributes
36         person_ids = set()
37         all_slice_tag_ids = set()
38         for slice in slices:
39             person_ids.update(slice['person_ids'])
40             all_slice_tag_ids.update(slice['slice_tag_ids'])
41         person_ids = list(person_ids)
42         all_slice_tag_ids = list(all_slice_tag_ids)
43         # Get user information
44         all_persons_list = self.driver.shell.GetPersons({'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
45         all_persons = {}
46         for person in all_persons_list:
47             all_persons[person['person_id']] = person        
48
49         # Build up list of keys
50         key_ids = set()
51         for person in all_persons.values():
52             key_ids.update(person['key_ids'])
53         key_ids = list(key_ids)
54         # Get user account keys
55         all_keys_list = self.driver.shell.GetKeys(key_ids, ['key_id', 'key', 'key_type'])
56         all_keys = {}
57         for key in all_keys_list:
58             all_keys[key['key_id']] = key
59         # Get slice attributes
60         all_slice_tags_list = self.driver.shell.GetSliceTags(all_slice_tag_ids)
61         all_slice_tags = {}
62         for slice_tag in all_slice_tags_list:
63             all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
64            
65         slivers = []
66         for slice in slices:
67             keys = []
68             for person_id in slice['person_ids']:
69                 if person_id in all_persons:
70                     person = all_persons[person_id]
71                     if not person['enabled']:
72                         continue
73                     for key_id in person['key_ids']:
74                         if key_id in all_keys:
75                             key = all_keys[key_id]
76                             keys += [{'key_type': key['key_type'],
77                                     'key': key['key']}]
78             attributes = []
79             # All (per-node and global) attributes for this slice
80             slice_tags = []
81             for slice_tag_id in slice['slice_tag_ids']:
82                 if slice_tag_id in all_slice_tags:
83                     slice_tags.append(all_slice_tags[slice_tag_id]) 
84             # Per-node sliver attributes take precedence over global
85             # slice attributes, so set them first.
86             # Then comes nodegroup slice attributes
87             # Followed by global slice attributes
88             sliver_attributes = []
89
90             if node is not None:
91                 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
92                     sliver_attributes.append(sliver_attribute['tagname'])
93                     attributes.append({'tagname': sliver_attribute['tagname'],
94                                     'value': sliver_attribute['value']})
95
96             # set nodegroup slice attributes
97             for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
98                 # Do not set any nodegroup slice attributes for
99                 # which there is at least one sliver attribute
100                 # already set.
101                 if slice_tag not in slice_tags:
102                     attributes.append({'tagname': slice_tag['tagname'],
103                         'value': slice_tag['value']})
104
105             for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
106                 # Do not set any global slice attributes for
107                 # which there is at least one sliver attribute
108                 # already set.
109                 if slice_tag['tagname'] not in sliver_attributes:
110                     attributes.append({'tagname': slice_tag['tagname'],
111                                    'value': slice_tag['value']})
112
113             # XXX Sanity check; though technically this should be a system invariant
114             # checked with an assertion
115             if slice['expires'] > MAXINT:  slice['expires']= MAXINT
116             
117             slivers.append({
118                 'hrn': hrn,
119                 'name': slice['name'],
120                 'slice_id': slice['slice_id'],
121                 'instantiation': slice['instantiation'],
122                 'expires': slice['expires'],
123                 'keys': keys,
124                 'attributes': attributes
125             })
126
127         return slivers
128  
129     def get_peer(self, xrn):
130         hrn, type = urn_to_hrn(xrn)
131         # Becaues of myplc federation,  we first need to determine if this
132         # slice belongs to out local plc or a myplc peer. We will assume it 
133         # is a local site, unless we find out otherwise  
134         peer = None
135
136         # get this slice's authority (site)
137         slice_authority = get_authority(hrn)
138
139         # get this site's authority (sfa root authority or sub authority)
140         site_authority = get_authority(slice_authority).lower()
141
142         # check if we are already peered with this site_authority, if so
143         peers = self.driver.shell.GetPeers({}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
144         for peer_record in peers:
145             names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
146             if site_authority in names:
147                 peer = peer_record
148
149         return peer
150
151     def get_sfa_peer(self, xrn):
152         hrn, type = urn_to_hrn(xrn)
153
154         # return the authority for this hrn or None if we are the authority
155         sfa_peer = None
156         slice_authority = get_authority(hrn)
157         site_authority = get_authority(slice_authority)
158
159         if site_authority != self.driver.hrn:
160             sfa_peer = site_authority
161
162         return sfa_peer
163
164     def verify_slice_leases(self, slice, rspec_requested_leases, peer):
165
166         leases = self.driver.shell.GetLeases({'name':slice['name'], 'clip':int(time.time())}, ['lease_id','name', 'hostname', 't_from', 't_until'])
167         grain = self.driver.shell.GetLeaseGranularity()
168
169         requested_leases = []
170         for lease in rspec_requested_leases:
171              requested_lease = {}
172              slice_name = hrn_to_pl_slicename(lease['slice_id'])
173              if slice_name != slice['name']:
174                  continue
175              elif Xrn(lease['component_id']).get_authority_urn().split(':')[0] != self.driver.hrn:
176                  continue
177
178              hostname = xrn_to_hostname(lease['component_id'])
179              # fill the requested node with nitos ids
180              requested_lease['name'] = slice['name']
181              requested_lease['hostname'] = hostname
182              requested_lease['t_from'] = int(lease['start_time'])
183              requested_lease['t_until'] = int(lease['duration']) * grain + int(lease['start_time'])
184              requested_leases.append(requested_lease)
185
186
187
188         # prepare actual slice leases by lease_id  
189         leases_by_id = {}
190         for lease in leases:
191              leases_by_id[lease['lease_id']] = {'name': lease['name'], 'hostname': lease['hostname'], \
192                                                 't_from': lease['t_from'], 't_until': lease['t_until']}
193         
194         added_leases = []
195         kept_leases_id = []
196         deleted_leases_id = []
197         for lease_id in leases_by_id:
198              if leases_by_id[lease_id] not in requested_leases:
199                  deleted_leases_id.append(lease_id)
200              else:
201                  kept_leases_id.append(lease_id)
202                  requested_leases.remove(leases_by_id[lease_id])
203         added_leases = requested_leases
204    
205
206         try:
207             if peer:
208                 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
209             self.driver.shell.DeleteLeases(deleted_leases_id)
210             for lease in added_leases:
211                 self.driver.shell.AddLeases(lease['hostname'], slice['name'], lease['t_from'], lease['t_until'])
212
213         except: 
214             logger.log_exc('Failed to add/remove slice leases')
215
216         return leases
217
218
219     def verify_slice_nodes(self, slice, slivers, peer):
220         
221         nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
222         current_slivers = [node['hostname'] for node in nodes]
223
224         requested_slivers = []
225         tags = []
226         for node in slivers:
227             hostname = None
228             if node.get('component_name'):
229                 hostname = node.get('component_name').strip()
230             elif node.get('component_id'):
231                 hostname = xrn_to_hostname(node.get('component_id').strip())
232             if node.get('client_id'):
233                 tags.append({'slicename': slice['name'], 
234                              'tagname': 'client_id',
235                              'value': node['client_id'],
236                              'node': hostname})
237             if hostname:
238                 requested_slivers.append(hostname)
239         
240         # remove nodes not in rspec
241         deleted_nodes = list(set(current_slivers).difference(requested_slivers))
242
243         # add nodes from rspec
244         added_nodes = list(set(requested_slivers).difference(current_slivers))        
245
246         try:
247             if peer:
248                 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
249             self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
250             self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
251             
252         except: 
253             logger.log_exc('Failed to add/remove slice from nodes')
254
255         # add tags
256         for tag in tags:
257             try:
258                 self.driver.shell.AddSliceTag(tag['slicename'], tag['tagname'], tag['value'], tag['node']) 
259             except:
260                 logger.log_exc('Failed to add slice tag')
261         return nodes
262
263     def free_egre_key(self):
264         used = set()
265         for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
266                 used.add(int(tag['value']))
267
268         for i in range(1, 256):
269             if i not in used:
270                 key = i
271                 break
272         else:
273             raise KeyError("No more EGRE keys available")
274
275         return str(key)
276
277     def verify_slice_links(self, slice, requested_links, nodes):
278         # nodes is undefined here
279         if not requested_links:
280             return
281    
282         # build dict of nodes 
283         nodes_dict = {}
284         interface_ids = []
285         for node in nodes:
286             nodes_dict[node['node_id']] = node
287             interface_ids.extend(node['interface_ids'])
288         # build dict of interfaces
289         interfaces = self.driver.shell.GetInterfaces(interface_ids)
290         interfaces_dict = {}
291         for interface in interfaces:
292             interfaces_dict[interface['interface_id']] = interface 
293
294         slice_tags = []
295         
296         # set egre key
297         slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
298     
299         # set netns
300         slice_tags.append({'name': 'netns', 'value': '1'})
301
302         # set cap_net_admin 
303         # need to update the attribute string?
304         slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'}) 
305         
306         for link in requested_links:
307             # get the ip address of the first node in the link
308             ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
309             (node_raw, device) = ifname1.split(':')
310             node_id = int(node_raw.replace('node', ''))
311             node = nodes_dict[node_id]
312             if1 = interfaces_dict[node['interface_ids'][0]]
313             ipaddr = if1['ip']
314             topo_rspec = VLink.get_topo_rspec(link, ipaddr)
315             # set topo_rspec tag
316             slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
317             # set vini_topo tag
318             slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
319             #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id) 
320
321         self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
322                         
323         
324
325     def handle_peer(self, site, slice, persons, peer):
326         if peer:
327             # bind site
328             try:
329                 if site:
330                     self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
331             except Exception,e:
332                 self.driver.shell.DeleteSite(site['site_id'])
333                 raise e
334             
335             # bind slice
336             try:
337                 if slice:
338                     self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
339             except Exception,e:
340                 self.driver.shell.DeleteSlice(slice['slice_id'])
341                 raise e 
342
343             # bind persons
344             for person in persons:
345                 try:
346                     self.driver.shell.BindObjectToPeer('person', 
347                                                      person['person_id'], peer['shortname'], person['peer_person_id'])
348
349                     for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
350                         try:
351                             self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
352                         except:
353                             self.driver.shell.DeleteKey(key['key_id'])
354                             logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
355                 except Exception,e:
356                     self.driver.shell.DeletePerson(person['person_id'])
357                     raise e       
358
359         return slice
360
361     def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
362         (slice_hrn, type) = urn_to_hrn(slice_xrn)
363         site_hrn = get_authority(slice_hrn)
364         top_auth_hrn = site_hrn.split('.')[0]
365         if top_auth_hrn == self.driver.hrn:
366             # login base can't be longer than 20 characters
367             slicename = hrn_to_pl_slicename(slice_hrn)
368             authority_name = slicename.split('_')[0]
369             login_base = authority_name[:20]
370         else:
371             login_base = '8'.join(site_hrn.split('.'))[:20]
372             authority_name = login_base
373
374         sites = self.driver.shell.GetSites(login_base)
375         if not sites:
376             # create new site record
377             site = {'name': 'sfa.%s' % authority_name,
378                     'abbreviated_name': authority_name,
379                     'login_base': login_base,
380                     'max_slices': 100,
381                     'max_slivers': 1000,
382                     'enabled': True,
383                     'peer_site_id': None}
384             if peer:
385                 site['peer_site_id'] = slice_record.get('site_id', None)
386             site['site_id'] = self.driver.shell.AddSite(site)
387             # exempt federated sites from monitor policies
388             self.driver.shell.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
389             
390 #            # is this still necessary?
391 #            # add record to the local registry 
392 #            if sfa_peer and slice_record:
393 #                peer_dict = {'type': 'authority', 'hrn': site_hrn, \
394 #                             'peer_authority': sfa_peer, 'pointer': site['site_id']}
395 #                self.registry.register_peer_object(self.credential, peer_dict)
396         else:
397             site =  sites[0]
398             if peer:
399                 # unbind from peer so we can modify if necessary. Will bind back later
400                 self.driver.shell.UnBindObjectFromPeer('site', site['site_id'], peer['shortname']) 
401         
402         return site        
403
404     def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, options={}):
405         site_hrn = get_authority(slice_hrn)
406         top_auth_hrn = site_hrn.split('.')[0]
407         if top_auth_hrn == self.driver.hrn:
408             slicename = hrn_to_pl_slicename(slice_hrn)
409             parts = slicename.split("_")
410             login_base = parts[0]
411         else:
412             login_base = '8'.join(site_hrn.split('.'))
413             slice_name = '_'.join([login_base, slice_hrn.split('.')[-1]])
414             
415         slices = self.driver.shell.GetSlices([slice_name]) 
416         if not slices:
417             slice = {'name': slice_name,
418                      'url': slice_record.get('url', slice_hrn), 
419                      'description': slice_record.get('description', slice_hrn)}
420             # add the slice                          
421             slice['slice_id'] = self.driver.shell.AddSlice(slice)
422             # set the slice HRN
423             self.driver.shell.SetSliceHrn(int(slice['slice_id']), slice_hrn)            
424
425             slice['node_ids'] = []
426             slice['person_ids'] = []
427             if peer:
428                 slice['peer_slice_id'] = slice_record.get('slice_id', None) 
429             # mark this slice as an sfa peer record
430 #            if sfa_peer:
431 #                peer_dict = {'type': 'slice', 'hrn': slice_hrn, 
432 #                             'peer_authority': sfa_peer, 'pointer': slice['slice_id']}
433 #                self.registry.register_peer_object(self.credential, peer_dict)
434         else:
435             slice = slices[0]
436             # Check slice HRN
437             if self.driver.shell.GetSliceHrn(slice['slice_id']) != slice_hrn:
438                 self.driver.shell.SetSliceHrn(slice['slice_id'], slice_hrn)
439
440             if peer:
441                 slice['peer_slice_id'] = slice_record.get('slice_id', None)
442                 # unbind from peer so we can modify if necessary. Will bind back later
443                 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
444                 #Update existing record (e.g. expires field) it with the latest info.
445             if slice_record and slice_record.get('expires'):
446                 requested_expires = int(datetime_to_epoch(utcparse(slice_record['expires'])))
447                 if requested_expires and slice['expires'] != requested_expires:
448                     self.driver.shell.UpdateSlice( slice['slice_id'], {'expires' : requested_expires})
449        
450         return slice
451
452     #def get_existing_persons(self, users):
453     def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
454
455         site_hrn = get_authority(slice_hrn)
456         top_auth_hrn = site_hrn.split('.')[0]
457         if top_auth_hrn == self.driver.hrn:
458             slicename = hrn_to_pl_slicename(slice_hrn)
459             parts = slicename.split("_")
460             login_base = parts[0]
461         else:
462             login_base = '8'.join(site_hrn.split('.'))
463             slice_name = '_'.join([login_base, slice_hrn.split('.')[-1]])
464
465
466
467         users_by_email = {}
468         users_by_site = defaultdict(list)
469         users_dict = {} 
470         for user in users:
471             user['urn'] = user['urn'].lower()
472             hrn, type = urn_to_hrn(user['urn'])
473             username = get_leaf(hrn)
474             user['username'] = username
475              
476             site_hrn = get_authority(hrn)
477             top_auth_hrn = site_hrn.split('.')[0]            
478
479             if top_auth_hrn == self.driver.hrn:
480                 login_base = PlXrn(xrn=user['urn']).pl_login_base()
481             else:
482                 login_base = '8'.join(site_hrn.split('.'))
483
484             user['site'] = login_base
485             if 'email' in user:
486                 user['email'] = user['email'].lower() 
487                 users_by_email[user['email']] = user
488                 users_dict[user['email']] = user
489             else:
490                 users_by_site[user['site']].append(user)
491
492         # start building a list of existing users
493         existing_user_ids = []
494         existing_user_ids_filter = []
495         if users_by_email:
496             existing_user_ids_filter.extend(users_by_email.keys())
497         if users_by_site:
498             for login_base in users_by_site:
499                 users = users_by_site[login_base]
500                 for user in users:      
501                     existing_user_ids_filter.append(user['username']+'@geni.net')               
502         if existing_user_ids_filter:                    
503             # get existing users by email 
504             existing_users = self.driver.shell.GetPersons({'email': existing_user_ids_filter}, 
505                                                         ['person_id', 'key_ids', 'email'])
506             existing_user_ids.extend([user['email'] for user in existing_users])
507         
508         if users_by_site:
509             # get a list of user sites (based on requeste user urns
510             site_list = self.driver.shell.GetSites(users_by_site.keys(), \
511                 ['site_id', 'login_base', 'person_ids'])
512             # get all existing users at these sites
513             sites = {}
514             site_user_ids = []
515             for site in site_list:
516                 sites[site['site_id']] = site
517                 site_user_ids.extend(site['person_ids'])
518
519             existing_site_persons_list = self.driver.shell.GetPersons(site_user_ids,  
520                                                                     ['person_id', 'key_ids', 'email', 'site_ids'])
521
522             # all requested users are either existing users or new (added) users      
523             for login_base in users_by_site:
524                 requested_site_users = users_by_site[login_base]
525                 for requested_user in requested_site_users:
526                     user_found = False
527                     for existing_user in existing_site_persons_list:
528                         for site_id in existing_user['site_ids']:
529                             if site_id in sites:
530                                 site = sites[site_id]
531                                 if login_base == site['login_base'] and \
532                                    existing_user['email'].startswith(requested_user['username']+'@'):
533                                     existing_user_ids.append(existing_user['email'])
534                                     requested_user['email'] = existing_user['email']
535                                     users_dict[existing_user['email']] = requested_user
536                                     user_found = True
537                                     break
538                         if user_found:
539                             break
540       
541                     if user_found == False:
542                         fake_email = requested_user['username'] + '@geni.net'
543                         requested_user['email'] = fake_email
544                         users_dict[fake_email] = requested_user
545                 
546         # requested slice users        
547         requested_user_ids = users_dict.keys()
548         # existing slice users
549         existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
550         existing_slice_users = self.driver.shell.GetPersons(existing_slice_users_filter,
551                                                           ['person_id', 'key_ids', 'email'])
552         existing_slice_user_ids = [user['email'] for user in existing_slice_users]
553         
554         # users to be added, removed or updated
555         added_user_ids = set(requested_user_ids).difference(existing_user_ids)
556         added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
557         removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
558         updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
559
560         # Remove stale users (only if we are not appending).
561         # Append by default.
562         append = options.get('append', True)
563         if append == False:
564             for removed_user_id in removed_user_ids:
565                 self.driver.shell.DeletePersonFromSlice(removed_user_id, slice_record['name'])
566         # update_existing users
567         updated_users_list = [user for user in users_dict.values() if user['email'] in \
568           updated_user_ids]
569         self.verify_keys(existing_slice_users, updated_users_list, peer, options)
570
571         added_persons = []
572         # add new users
573         for added_user_id in added_user_ids:
574             added_user = users_dict[added_user_id]
575             hrn, type = urn_to_hrn(added_user['urn'])  
576             person = {
577                 'first_name': added_user.get('first_name', hrn),
578                 'last_name': added_user.get('last_name', hrn),
579                 'email': added_user_id,
580                 #'peer_person_id': None,
581                 #'keys': [],
582                 #'key_ids': added_user.get('key_ids', []),
583             }
584             person['person_id'] = self.driver.shell.AddPerson(person)
585             self.driver.shell.AddRoleToPerson('user', int(person['person_id']))
586             # check user HRN
587             if self.driver.shell.GetPersonHrn(int(person['person_id'])) != hrn:
588                 self.driver.shell.SetPersonHrn(int(person['person_id']), hrn)
589
590             if peer:
591                 person['peer_person_id'] = added_user['person_id']
592             added_persons.append(person)
593            
594             # enable the account 
595             self.driver.shell.UpdatePerson(person['person_id'], {'enabled': True})
596             
597             # add person to site
598             self.driver.shell.AddPersonToSite(added_user_id, added_user['site'])
599
600             for key_string in added_user.get('keys', []):
601                 key = {'key':key_string, 'key_type':'ssh'}
602                 key['key_id'] = self.driver.shell.AddPersonKey(person['person_id'], key)
603                 if 'keys' not in person:
604                     person['keys'] = []
605                 person['keys'].append(key)
606
607             # add the registry record
608 #            if sfa_peer:
609 #                peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
610 #                    'pointer': person['person_id']}
611 #                self.registry.register_peer_object(self.credential, peer_dict)
612     
613         for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
614             # add person to the slice 
615             self.driver.shell.AddPersonToSlice(added_slice_user_id, slice_record['name'])
616             # if this is a peer record then it should already be bound to a peer.
617             # no need to return worry about it getting bound later 
618
619         return added_persons
620             
621
622     def verify_keys(self, persons, users, peer, options={}):
623         # existing keys 
624         key_ids = []
625         for person in persons:
626             key_ids.extend(person['key_ids'])
627         keylist = self.driver.shell.GetKeys(key_ids, ['key_id', 'key'])
628         keydict = {}
629         for key in keylist:
630             keydict[key['key']] = key['key_id']     
631         existing_keys = keydict.keys()
632         persondict = {}
633         for person in persons:
634             persondict[person['email']] = person    
635     
636         # add new keys
637         requested_keys = []
638         updated_persons = []
639         for user in users:
640             user_keys = user.get('keys', [])
641             updated_persons.append(user)
642             for key_string in user_keys:
643                 requested_keys.append(key_string)
644                 if key_string not in existing_keys:
645                     key = {'key': key_string, 'key_type': 'ssh'}
646                     try:
647                         if peer:
648                             person = persondict[user['email']]
649                             self.driver.shell.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
650                         key['key_id'] = self.driver.shell.AddPersonKey(user['email'], key)
651                         if peer:
652                             key_index = user_keys.index(key['key'])
653                             remote_key_id = user['key_ids'][key_index]
654                             self.driver.shell.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
655                             
656                     finally:
657                         if peer:
658                             self.driver.shell.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
659         
660         # remove old keys (only if we are not appending)
661         append = options.get('append', True)
662         if append == False: 
663             removed_keys = set(existing_keys).difference(requested_keys)
664             for existing_key_id in keydict:
665                 if keydict[existing_key_id] in removed_keys:
666                     try:
667                         if peer:
668                             self.driver.shell.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
669                         self.driver.shell.DeleteKey(existing_key_id)
670                     except:
671                         pass   
672
673     def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
674         append = options.get('append', True)
675         # get list of attributes users ar able to manage
676         filter = {'category': '*slice*'}
677         if not admin:
678             filter['|roles'] = ['user']
679         slice_attributes = self.driver.shell.GetTagTypes(filter)
680         valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
681
682         # get sliver attributes
683         added_slice_attributes = []
684         removed_slice_attributes = []
685         ignored_slice_attribute_names = []
686         existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
687         
688         # get attributes that should be removed
689         for slice_tag in existing_slice_attributes:
690             if slice_tag['tagname'] in ignored_slice_attribute_names:
691                 # If a slice already has a admin only role it was probably given to them by an
692                 # admin, so we should ignore it.
693                 ignored_slice_attribute_names.append(slice_tag['tagname'])
694             else:
695                 # If an existing slice attribute was not found in the request it should
696                 # be removed
697                 attribute_found=False
698                 for requested_attribute in requested_slice_attributes:
699                     if requested_attribute['name'] == slice_tag['tagname'] and \
700                        requested_attribute['value'] == slice_tag['value']:
701                         attribute_found=True
702                         break
703
704             if not attribute_found and not append:
705                 removed_slice_attributes.append(slice_tag)
706         
707         # get attributes that should be added:
708         for requested_attribute in requested_slice_attributes:
709             # if the requested attribute wasn't found  we should add it
710             if requested_attribute['name'] in valid_slice_attribute_names:
711                 attribute_found = False
712                 for existing_attribute in existing_slice_attributes:
713                     if requested_attribute['name'] == existing_attribute['tagname'] and \
714                        requested_attribute['value'] == existing_attribute['value']:
715                         attribute_found=True
716                         break
717                 if not attribute_found:
718                     added_slice_attributes.append(requested_attribute)
719
720
721         # remove stale attributes
722         for attribute in removed_slice_attributes:
723             try:
724                 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
725             except Exception, e:
726                 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
727                                 % (slice['name'], attribute['value'],  attribute.get('node_id'), str(e)))
728
729         # add requested_attributes
730         for attribute in added_slice_attributes:
731             try:
732                 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
733             except Exception, e:
734                 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
735                                 % (slice['name'], attribute['value'],  attribute.get('node_id'), str(e)))
736