2 from types import StringTypes
3 from collections import defaultdict
5 from sfa.util.sfatime import utcparse, datetime_to_epoch
6 from sfa.util.sfalogging import logger
7 from sfa.util.xrn import Xrn, get_leaf, get_authority, urn_to_hrn
8 from sfa.rspecs.rspec import RSpec
9 from sfa.planetlab.vlink import VLink
10 from sfa.planetlab.topology import Topology
11 from sfa.planetlab.plxrn import PlXrn, hrn_to_pl_slicename, xrn_to_hostname, top_auth, hash_loginbase
12 from sfa.storage.model import SliverAllocation
18 rspec_to_slice_tag = {'max_rate':'net_max_rate'}
20 def __init__(self, driver):
23 def get_slivers(self, xrn, node=None):
24 hrn, type = urn_to_hrn(xrn)
26 slice_name = hrn_to_pl_slicename(hrn)
27 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
28 # of doing all of this?
29 #return self.driver.shell.GetSliceTicket(self.auth, slice_name)
31 # from PLCAPI.GetSlivers.get_slivers()
32 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
33 slices = self.driver.shell.GetSlices(slice_name, slice_fields)
34 # Build up list of users and slice attributes
36 all_slice_tag_ids = set()
38 person_ids.update(slice['person_ids'])
39 all_slice_tag_ids.update(slice['slice_tag_ids'])
40 person_ids = list(person_ids)
41 all_slice_tag_ids = list(all_slice_tag_ids)
42 # Get user information
43 all_persons_list = self.driver.shell.GetPersons({'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
45 for person in all_persons_list:
46 all_persons[person['person_id']] = person
48 # Build up list of keys
50 for person in all_persons.values():
51 key_ids.update(person['key_ids'])
52 key_ids = list(key_ids)
53 # Get user account keys
54 all_keys_list = self.driver.shell.GetKeys(key_ids, ['key_id', 'key', 'key_type'])
56 for key in all_keys_list:
57 all_keys[key['key_id']] = key
58 # Get slice attributes
59 all_slice_tags_list = self.driver.shell.GetSliceTags(all_slice_tag_ids)
61 for slice_tag in all_slice_tags_list:
62 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
67 for person_id in slice['person_ids']:
68 if person_id in all_persons:
69 person = all_persons[person_id]
70 if not person['enabled']:
72 for key_id in person['key_ids']:
73 if key_id in all_keys:
74 key = all_keys[key_id]
75 keys += [{'key_type': key['key_type'],
78 # All (per-node and global) attributes for this slice
80 for slice_tag_id in slice['slice_tag_ids']:
81 if slice_tag_id in all_slice_tags:
82 slice_tags.append(all_slice_tags[slice_tag_id])
83 # Per-node sliver attributes take precedence over global
84 # slice attributes, so set them first.
85 # Then comes nodegroup slice attributes
86 # Followed by global slice attributes
87 sliver_attributes = []
90 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
91 sliver_attributes.append(sliver_attribute['tagname'])
92 attributes.append({'tagname': sliver_attribute['tagname'],
93 'value': sliver_attribute['value']})
95 # set nodegroup slice attributes
96 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
97 # Do not set any nodegroup slice attributes for
98 # which there is at least one sliver attribute
100 if slice_tag not in slice_tags:
101 attributes.append({'tagname': slice_tag['tagname'],
102 'value': slice_tag['value']})
104 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
105 # Do not set any global slice attributes for
106 # which there is at least one sliver attribute
108 if slice_tag['tagname'] not in sliver_attributes:
109 attributes.append({'tagname': slice_tag['tagname'],
110 'value': slice_tag['value']})
112 # XXX Sanity check; though technically this should be a system invariant
113 # checked with an assertion
114 if slice['expires'] > MAXINT: slice['expires']= MAXINT
118 'name': slice['name'],
119 'slice_id': slice['slice_id'],
120 'instantiation': slice['instantiation'],
121 'expires': slice['expires'],
123 'attributes': attributes
129 def get_sfa_peer(self, xrn):
130 hrn, type = urn_to_hrn(xrn)
132 # return the authority for this hrn or None if we are the authority
134 slice_authority = get_authority(hrn)
135 site_authority = get_authority(slice_authority)
137 if site_authority != self.driver.hrn:
138 sfa_peer = site_authority
142 def verify_slice_leases(self, slice, rspec_requested_leases):
144 leases = self.driver.shell.GetLeases({'name':slice['name'], 'clip':int(time.time())}, ['lease_id','name', 'hostname', 't_from', 't_until'])
145 grain = self.driver.shell.GetLeaseGranularity()
147 requested_leases = []
148 for lease in rspec_requested_leases:
150 slice_hrn, _ = urn_to_hrn(lease['slice_id'])
152 top_auth_hrn = top_auth(slice_hrn)
153 site_hrn = '.'.join(slice_hrn.split('.')[:-1])
154 slice_part = slice_hrn.split('.')[-1]
155 if top_auth_hrn == self.driver.hrn:
156 login_base = slice_hrn.split('.')[-2][:12]
158 login_base = hash_loginbase(site_hrn)
160 slice_name = '_'.join([login_base, slice_part])
162 if slice_name != slice['name']:
164 elif Xrn(lease['component_id']).get_authority_urn().split(':')[0] != self.driver.hrn:
167 hostname = xrn_to_hostname(lease['component_id'])
168 # fill the requested node with nitos ids
169 requested_lease['name'] = slice['name']
170 requested_lease['hostname'] = hostname
171 requested_lease['t_from'] = int(lease['start_time'])
172 requested_lease['t_until'] = int(lease['duration']) * grain + int(lease['start_time'])
173 requested_leases.append(requested_lease)
177 # prepare actual slice leases by lease_id
180 leases_by_id[lease['lease_id']] = {'name': lease['name'], 'hostname': lease['hostname'], \
181 't_from': lease['t_from'], 't_until': lease['t_until']}
185 deleted_leases_id = []
186 for lease_id in leases_by_id:
187 if leases_by_id[lease_id] not in requested_leases:
188 deleted_leases_id.append(lease_id)
190 kept_leases_id.append(lease_id)
191 requested_leases.remove(leases_by_id[lease_id])
192 added_leases = requested_leases
196 self.driver.shell.DeleteLeases(deleted_leases_id)
197 for lease in added_leases:
198 self.driver.shell.AddLeases(lease['hostname'], slice['name'], lease['t_from'], lease['t_until'])
201 logger.log_exc('Failed to add/remove slice leases')
206 def verify_slice_nodes(self, slice_urn, slice, rspec_nodes):
209 for node in rspec_nodes:
210 hostname = node.get('component_name')
211 client_id = node.get('client_id')
212 component_id = node.get('component_id').strip()
214 hostname = hostname.strip()
216 hostname = xrn_to_hostname(component_id)
218 slivers[hostname] = {'client_id': client_id, 'component_id': component_id}
220 nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
221 current_slivers = [node['hostname'] for node in nodes]
223 # remove nodes not in rspec
224 deleted_nodes = list(set(current_slivers).difference(slivers.keys()))
226 # add nodes from rspec
227 added_nodes = list(set(slivers.keys()).difference(current_slivers))
230 self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
231 self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
234 logger.log_exc('Failed to add/remove slice from nodes')
236 slices = self.driver.shell.GetSlices(slice['name'], ['node_ids'])
237 resulting_nodes = self.driver.shell.GetNodes(slices[0]['node_ids'])
239 # update sliver allocations
240 for node in resulting_nodes:
241 client_id = slivers[node['hostname']]['client_id']
242 component_id = slivers[node['hostname']]['component_id']
243 sliver_hrn = '%s.%s-%s' % (self.driver.hrn, slice['slice_id'], node['node_id'])
244 sliver_id = Xrn(sliver_hrn, type='sliver').urn
245 record = SliverAllocation(sliver_id=sliver_id, client_id=client_id,
246 component_id=component_id,
247 slice_urn = slice_urn,
248 allocation_state='geni_allocated')
249 record.sync(self.driver.api.dbsession())
250 return resulting_nodes
252 def free_egre_key(self):
254 for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
255 used.add(int(tag['value']))
257 for i in range(1, 256):
262 raise KeyError("No more EGRE keys available")
266 def verify_slice_links(self, slice, requested_links, nodes):
268 if not requested_links:
271 # exit if links are not supported here
272 topology = Topology()
276 # build dict of nodes
280 nodes_dict[node['node_id']] = node
281 interface_ids.extend(node['interface_ids'])
282 # build dict of interfaces
283 interfaces = self.driver.shell.GetInterfaces(interface_ids)
285 for interface in interfaces:
286 interfaces_dict[interface['interface_id']] = interface
291 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
294 slice_tags.append({'name': 'netns', 'value': '1'})
297 # need to update the attribute string?
298 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
300 for link in requested_links:
301 # get the ip address of the first node in the link
302 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
305 ifname_parts = ifname1.split(':')
306 node_raw = ifname_parts[0]
308 if len(ifname_parts) > 1:
309 device = ifname_parts[1]
310 node_id = int(node_raw.replace('node', ''))
311 node = nodes_dict[node_id]
312 if1 = interfaces_dict[node['interface_ids'][0]]
314 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
316 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
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)
321 self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
325 def verify_site(self, slice_xrn, slice_record=None, sfa_peer=None, options=None):
326 if slice_record is None: slice_record={}
327 if options is None: options={}
328 (slice_hrn, type) = urn_to_hrn(slice_xrn)
329 top_auth_hrn = top_auth(slice_hrn)
330 site_hrn = '.'.join(slice_hrn.split('.')[:-1])
331 if top_auth_hrn == self.driver.hrn:
332 login_base = slice_hrn.split('.')[-2][:12]
334 login_base = hash_loginbase(site_hrn)
335 #plxrn = PlXrn(xrn=slice_xrn)
336 #slice_hrn = plxrn.get_hrn()
337 #type = plxrn.get_type()
338 #site_hrn = plxrn.get_authority_hrn()
339 #authority_name = plxrn.pl_authname()
340 #slicename = plxrn.pl_slicename()
341 #login_base = plxrn.pl_login_base()
343 sites = self.driver.shell.GetSites({'peer_id': None},['site_id','name','abbreviated_name','login_base','hrn'])
345 # filter sites by hrn
346 site_exists = [site for site in sites if site['hrn'] == site_hrn]
349 # create new site record
350 site = {'name': 'sfa:%s' % site_hrn,
351 'abbreviated_name': site_hrn,
352 'login_base': login_base,
356 'peer_site_id': None}
358 site['site_id'] = self.driver.shell.AddSite(site)
360 self.driver.shell.SetSiteHrn(int(site['site_id']), site_hrn)
361 # Tag this as created through SFA
362 self.driver.shell.SetSiteSfaCreated(int(site['site_id']), 'True')
363 # exempt federated sites from monitor policies
364 self.driver.shell.AddSiteTag(int(site['site_id']), 'exempt_site_until', "20200101")
367 site = site_exists[0]
372 def verify_slice(self, slice_hrn, slice_record, sfa_peer, expiration, options=None):
373 if options is None: options={}
374 top_auth_hrn = top_auth(slice_hrn)
375 site_hrn = '.'.join(slice_hrn.split('.')[:-1])
376 slice_part = slice_hrn.split('.')[-1]
377 if top_auth_hrn == self.driver.hrn:
378 login_base = slice_hrn.split('.')[-2][:12]
380 login_base = hash_loginbase(site_hrn)
381 slice_name = '_'.join([login_base, slice_part])
382 #plxrn = PlXrn(xrn=slice_hrn)
383 #slice_hrn = plxrn.get_hrn()
384 #type = plxrn.get_type()
385 #site_hrn = plxrn.get_authority_hrn()
386 #authority_name = plxrn.pl_authname()
387 #slicename = plxrn.pl_slicename()
388 #login_base = plxrn.pl_login_base()
390 slices = self.driver.shell.GetSlices({'peer_id': None},['slice_id','name','hrn'])
391 # Filter slices by HRN
392 slice_exists = [slice for slice in slices if slice['hrn'] == slice_hrn]
393 expires = int(datetime_to_epoch(utcparse(expiration)))
396 url = slice_record.get('url', slice_hrn)
397 description = slice_record.get('description', slice_hrn)
400 description = slice_hrn
401 slice = {'name': slice_name,
403 'description': description}
405 slice['slice_id'] = self.driver.shell.AddSlice(slice)
407 self.driver.shell.SetSliceHrn(int(slice['slice_id']), slice_hrn)
408 # Tag this as created through SFA
409 self.driver.shell.SetSliceSfaCreated(int(slice['slice_id']), 'True')
411 self.driver.shell.UpdateSlice(int(slice['slice_id']), {'expires': expires})
414 slice = slice_exists[0]
415 #Update expiration if necessary
416 if slice.get('expires', None) != expires:
417 self.driver.shell.UpdateSlice( int(slice['slice_id']), {'expires' : expires})
419 return self.driver.shell.GetSlices(int(slice['slice_id']))[0]
422 # in the following code, we use
423 # 'person' to denote a PLCAPI-like record with typically 'person_id' and 'email'
424 # 'user' to denote an incoming record with typically 'urn' and 'email' - we add 'hrn' in there
425 # 'slice_record': it seems like the first of these 'users' also contains a 'slice_record'
426 # key that holds stuff like 'hrn', 'slice_id', 'authority',...
428 def create_person (self, user, site_id):
429 user_hrn = user['hrn']
430 # the value to use if 'user' has no 'email' attached - xxx should be configurable
431 default_email = "%s@geni.net"%user_hrn.split('.')[-1]
432 # PLCAPI requires at least these to be set
435 'first_name': user.get('first_name',user_hrn),
436 'last_name': user.get('last_name',user_hrn),
437 'email': user.get('email', default_email),
440 person_record.update({'enabled': True})
441 # mark it sfa_created; a string is required here, sfa_created is a tag
442 person_record.update({'sfa_created':'True'})
444 person_record.update({'hrn':user_hrn})
446 person_id = int (self.driver.shell.AddPerson(person_record))
447 self.driver.shell.AddRoleToPerson('user', person_id)
448 self.driver.shell.AddPersonToSite(person_id, site['site_id'])
452 def verify_persons(self, slice_hrn, slice_record, users, sfa_peer, options=None):
453 if options is None: options={}
455 # first we annotate the incoming users arg with a 'hrn' key
457 user['hrn'], _ = urn_to_hrn(user['urn'])
458 # this is for retrieving users from a hrn
459 users_by_hrn = { user['hrn'] : user for user in users }
461 # compute the hrn's for the authority and site
462 top_auth_hrn = top_auth(slice_hrn)
463 site_hrn = '.'.join(slice_hrn.split('.')[:-1])
464 slice_part = slice_hrn.split('.')[-1]
465 # deduce login_base and slice_name
466 if top_auth_hrn == self.driver.hrn:
467 login_base = slice_hrn.split('.')[-2][:12]
469 login_base = hash_loginbase(site_hrn)
470 slice_name = '_'.join([login_base, slice_part])
472 # locate the site object
473 # due to a limitation in PLCAPI, we have to specify 'hrn' as part of the return fields
474 site = self.driver.shell.GetSites ({'peer_id':None, 'hrn':site_hrn}, ['site_id','hrn'])[0]
475 site_id = site['site_id']
477 # locate the slice object
478 slice = self.driver.shell.GetSlices ({'peer_id':None, 'hrn':slice_hrn}, ['slice_id','hrn','person_ids'])[0]
479 slice_id = slice['slice_id']
480 slice_person_ids = slice['person_ids']
482 # the common set of attributes for our calls to GetPersons
483 person_fields = ['person_id','email','hrn']
485 # for the intended set of hrns, locate existing persons
486 target_hrns = [ user['hrn'] for user in users ]
487 target_existing_persons = self.driver.shell.GetPersons ({'peer_id':None, 'hrn': target_hrns}, person_fields)
488 target_existing_person_ids = [ person ['person_id'] for person in target_existing_persons ]
489 # find out the hrns that *do not* have a corresponding person
490 existing_hrns = [ person['hrn'] for person in target_existing_persons ]
491 tocreate_hrns = set (target_hrns) - set (existing_hrns)
493 target_created_person_ids = [ self.create_person (users_by_hrn[hrn], site_id) for hrn in tocreate_hrns ]
495 # we can partition the persons of interest into one of these 3 classes
496 add_person_ids = set(target_created_person_ids) | set(target_existing_person_ids) - set(slice_person_ids)
497 keep_person_ids = set(target_existing_person_ids) & set(slice_person_ids)
498 del_person_ids = set(slice_person_ids) - set(target_existing_person_ids)
501 for person_id in del_person_ids:
502 self.driver.shell.DeletePersonFromSlice (person_id, slice_id)
504 # about the last 2 sets, for managing keys, we need to trace back person_id -> user
505 # and for this we need all the Person objects; we already have the target_existing ones
506 # also we avoid issuing a call if possible
507 target_created_persons = [] if not target_created_person_ids \
508 else driver.shell.GetPersons ({'peer_id':None, 'person_id':target_created_person_ids},
510 persons_by_person_id = { person['person_id'] : person \
511 for person in target_existing_persons + target_created_persons }
513 def user_by_person_id (person_id):
514 person = persons_by_person_id [person_id]
516 return users_by_hrn [hrn]
518 persons_to_verify_keys = {}
520 for person_id in add_person_ids:
521 self.driver.shell.AddPersonToSlice(person_id, slice_id)
522 persons_to_verify_keys[person_id] = user_by_person_id(person_id)
523 # Update kept persons
524 for person_id in keep_person_ids:
525 persons_to_verify_keys[person_id] = user_by_person_id(person_id)
526 self.verify_keys(persons_to_verify_keys, options)
528 # return hrns of the newly added persons
530 return [ persons_by_person_id[person_id]['hrn'] for person_id in add_person_ids ]
532 def verify_keys(self, persons_to_verify_keys, options=None):
533 if options is None: options={}
534 # we only add keys that comes from sfa to persons in PL
535 for person_id in persons_to_verify_keys:
536 person_sfa_keys = persons_to_verify_keys[person_id].get('keys', [])
537 person_pl_keys = self.driver.shell.GetKeys({'person_id': int(person_id)})
538 person_pl_keys_list = [key['key'] for key in person_pl_keys]
540 keys_to_add = set(person_sfa_keys).difference(person_pl_keys_list)
542 for key_string in keys_to_add:
543 key = {'key': key_string, 'key_type': 'ssh'}
544 self.driver.shell.AddPersonKey(int(person_id), key)
547 def verify_slice_attributes(self, slice, requested_slice_attributes, options=None, admin=False):
548 if options is None: options={}
549 append = options.get('append', True)
550 # get list of attributes users ar able to manage
551 filter = {'category': '*slice*'}
553 filter['|roles'] = ['user']
554 slice_attributes = self.driver.shell.GetTagTypes(filter)
555 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
557 # get sliver attributes
558 added_slice_attributes = []
559 removed_slice_attributes = []
560 # we need to keep the slice hrn anyway
561 ignored_slice_attribute_names = ['hrn']
562 existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
564 # get attributes that should be removed
565 for slice_tag in existing_slice_attributes:
566 if slice_tag['tagname'] in ignored_slice_attribute_names:
567 # If a slice already has a admin only role it was probably given to them by an
568 # admin, so we should ignore it.
569 ignored_slice_attribute_names.append(slice_tag['tagname'])
572 # If an existing slice attribute was not found in the request it should
574 attribute_found=False
575 for requested_attribute in requested_slice_attributes:
576 if requested_attribute['name'] == slice_tag['tagname'] and \
577 requested_attribute['value'] == slice_tag['value']:
581 if not attribute_found and not append:
582 removed_slice_attributes.append(slice_tag)
584 # get attributes that should be added:
585 for requested_attribute in requested_slice_attributes:
586 # if the requested attribute wasn't found we should add it
587 if requested_attribute['name'] in valid_slice_attribute_names:
588 attribute_found = False
589 for existing_attribute in existing_slice_attributes:
590 if requested_attribute['name'] == existing_attribute['tagname'] and \
591 requested_attribute['value'] == existing_attribute['value']:
594 if not attribute_found:
595 added_slice_attributes.append(requested_attribute)
598 # remove stale attributes
599 for attribute in removed_slice_attributes:
601 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
603 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
604 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))
606 # add requested_attributes
607 for attribute in added_slice_attributes:
609 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
611 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
612 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))