3 from sfa.util.faults import MissingSfaInfo
4 from sfa.util.sfalogging import logger
5 from sfa.storage.table import SfaTable
6 from sfa.util.defaultdict import defaultdict
8 from sfa.managers.driver import Driver
9 from sfa.rspecs.version_manager import VersionManager
10 from sfa.rspecs.rspec import RSpec
12 from sfa.util.xrn import hrn_to_urn
13 from sfa.util.plxrn import slicename_to_hrn, hostname_to_hrn, hrn_to_pl_slicename, hrn_to_pl_login_base
15 ## thierry: everything that is API-related (i.e. handling incoming requests)
17 # SlabDriver should be really only about talking to the senslab testbed
19 ## thierry : please avoid wildcard imports :)
20 from sfa.senslab.OARrestapi import OARapi, OARrestapi
21 from sfa.senslab.LDAPapi import LDAPapi
22 from sfa.senslab.SenslabImportUsers import SenslabImportUsers
23 from sfa.senslab.parsing import parse_filter
24 from sfa.senslab.slabpostgres import SlabDB
25 from sfa.senslab.slabaggregate import SlabAggregate
26 from sfa.senslab.slabslices import SlabSlices
28 def list_to_dict(recs, key):
30 convert a list of dictionaries into a dictionary keyed on the
31 specified dictionary key
33 # print>>sys.stderr, " \r\n \t\t 1list_to_dict : rec %s \r\n \t\t list_to_dict key %s" %(recs,key)
34 keys = [rec[key] for rec in recs]
35 #print>>sys.stderr, " \r\n \t\t list_to_dict : rec %s \r\n \t\t list_to_dict keys %s" %(recs,keys)
36 return dict(zip(keys, recs))
39 # this inheritance scheme is so that the driver object can receive
40 # GetNodes or GetSites sorts of calls directly
41 # and thus minimize the differences in the managers with the pl version
42 class SlabDriver(Driver):
44 def __init__(self, config):
45 Driver.__init__ (self, config)
47 self.hrn = config.SFA_INTERFACE_HRN
49 self.root_auth = config.SFA_REGISTRY_ROOT_AUTH
52 print >>sys.stderr, "\r\n_____________ SFA SENSLAB DRIVER \r\n"
53 # thierry - just to not break the rest of this code
58 self.users = SenslabImportUsers()
59 self.time_format = "%Y-%m-%d %H:%M:%S"
61 #self.logger=sfa_logger()
66 def create_sliver (self, slice_urn, slice_hrn, creds, rspec_string, users, options):
67 aggregate = SlabAggregate(self)
68 #aggregate = SlabAggregate(self)
69 slices = SlabSlices(self)
70 peer = slices.get_peer(slice_hrn)
71 sfa_peer = slices.get_sfa_peer(slice_hrn)
74 slice_record = users[0].get('slice_record', {})
77 rspec = RSpec(rspec_string)
78 requested_attributes = rspec.version.get_slice_attributes()
80 # ensure site record exists
81 site = slices.verify_site(slice_hrn, slice_record, peer, sfa_peer, options=options)
82 # ensure slice record exists
83 slice = slices.verify_slice(slice_hrn, slice_record, peer, sfa_peer, options=options)
84 # ensure person records exists
85 persons = slices.verify_persons(slice_hrn, slice, users, peer, sfa_peer, options=options)
86 # ensure slice attributes exists
87 #slices.verify_slice_attributes(slice, requested_attributes, options=options)
89 # add/remove slice from nodes
90 requested_slivers = [node.get('component_name') for node in rspec.version.get_nodes_with_slivers()]
91 nodes = slices.verify_slice_nodes(slice, requested_slivers, peer)
93 # add/remove links links
94 #slices.verify_slice_links(slice, rspec.version.get_link_requests(), nodes)
96 # handle MyPLC peer association.
97 # only used by plc and ple.
98 #slices.handle_peer(site, slice, persons, peer)
100 return aggregate.get_rspec(slice_xrn=slice_urn, version=rspec.version)
103 def delete_sliver (self, slice_urn, slice_hrn, creds, options):
105 slices = self.GetSlices({'slice_hrn': slice_hrn})
110 # determine if this is a peer slice
111 # xxx I wonder if this would not need to use PlSlices.get_peer instead
112 # in which case plc.peers could be deprecated as this here
113 # is the only/last call to this last method in plc.peers
114 peer = peers.get_peer(self, slice_hrn)
117 self.UnBindObjectFromPeer('slice', slice['slice_id'], peer)
118 self.DeleteSliceFromNodes(slice_hrn, slice['node_ids'])
121 self.BindObjectToPeer('slice', slice['slice_id'], peer, slice['peer_slice_id'])
127 # first 2 args are None in case of resource discovery
128 def list_resources (self, slice_urn, slice_hrn, creds, options):
129 #cached_requested = options.get('cached', True)
131 version_manager = VersionManager()
132 # get the rspec's return format from options
133 rspec_version = version_manager.get_version(options.get('geni_rspec_version'))
134 version_string = "rspec_%s" % (rspec_version)
136 #panos adding the info option to the caching key (can be improved)
137 if options.get('info'):
138 version_string = version_string + "_"+options.get('info', 'default')
140 # look in cache first
141 #if cached_requested and self.cache and not slice_hrn:
142 #rspec = self.cache.get(version_string)
144 #logger.debug("SlabDriver.ListResources: returning cached advertisement")
147 #panos: passing user-defined options
148 #print "manager options = ",options
149 aggregate = SlabAggregate(self)
150 rspec = aggregate.get_rspec(slice_xrn=slice_urn, version=rspec_version,
154 #if self.cache and not slice_hrn:
155 #logger.debug("Slab.ListResources: stores advertisement in cache")
156 #self.cache.add(version_string, rspec)
161 def list_slices (self, creds, options):
162 # look in cache first
164 #slices = self.cache.get('slices')
166 #logger.debug("PlDriver.list_slices returns from cache")
170 slices = self.GetSlices({'peer_id': None}, ['name'])
171 slice_hrns = [slicename_to_hrn(self.hrn, slice['name']) for slice in slices]
172 slice_urns = [hrn_to_urn(slice_hrn, 'slice') for slice_hrn in slice_hrns]
176 #logger.debug ("SlabDriver.list_slices stores value in cache")
177 #self.cache.add('slices', slice_urns)
181 #No site or node register supported
182 def register (self, sfa_record, hrn, pub_key):
183 type = sfa_record['type']
184 pl_record = self.sfa_fields_to_pl_fields(type, hrn, sfa_record)
186 #if type == 'authority':
187 #sites = self.shell.GetSites([pl_record['login_base']])
189 #pointer = self.shell.AddSite(pl_record)
191 #pointer = sites[0]['site_id']
194 acceptable_fields=['url', 'instantiation', 'name', 'description']
195 for key in pl_record.keys():
196 if key not in acceptable_fields:
198 slices = self.GetSlices([pl_record['hrn']])
200 pointer = self.AddSlice(pl_record)
202 pointer = slices[0]['slice_id']
205 persons = self.GetPersons([sfa_record['hrn']])
207 pointer = self.AddPerson(dict(sfa_record))
210 pointer = persons[0]['person_id']
212 #Does this make sense to senslab ?
213 #if 'enabled' in sfa_record and sfa_record['enabled']:
214 #self.UpdatePerson(pointer, {'enabled': sfa_record['enabled']})
216 # add this person to the site only if she is being added for the first
217 # time by sfa and doesont already exist in plc
218 if not persons or not persons[0]['site_ids']:
219 login_base = get_leaf(sfa_record['authority'])
220 self.AddPersonToSite(pointer, login_base)
222 # What roles should this user have?
223 self.AddRoleToPerson('user', pointer)
226 self.AddPersonKey(pointer, {'key_type' : 'ssh', 'key' : pub_key})
228 #No node adding outside OAR
229 #elif type == 'node':
230 #login_base = hrn_to_pl_login_base(sfa_record['authority'])
231 #nodes = self.GetNodes([pl_record['hostname']])
233 #pointer = self.AddNode(login_base, pl_record)
235 #pointer = nodes[0]['node_id']
239 #No site or node record update allowed
240 def update (self, old_sfa_record, new_sfa_record, hrn, new_key):
241 pointer = old_sfa_record['pointer']
242 type = old_sfa_record['type']
244 # new_key implemented for users only
245 if new_key and type not in [ 'user' ]:
246 raise UnknownSfaType(type)
248 #if (type == "authority"):
249 #self.shell.UpdateSite(pointer, new_sfa_record)
252 pl_record=self.sfa_fields_to_pl_fields(type, hrn, new_sfa_record)
253 if 'name' in pl_record:
254 pl_record.pop('name')
255 self.UpdateSlice(pointer, pl_record)
259 all_fields = new_sfa_record
260 for key in all_fields.keys():
261 if key in ['first_name', 'last_name', 'title', 'email',
262 'password', 'phone', 'url', 'bio', 'accepted_aup',
264 update_fields[key] = all_fields[key]
265 self.UpdatePerson(pointer, update_fields)
268 # must check this key against the previous one if it exists
269 persons = self.GetPersons([pointer], ['key_ids'])
271 keys = person['key_ids']
272 keys = self.GetKeys(person['key_ids'])
274 # Delete all stale keys
277 if new_key != key['key']:
278 self.DeleteKey(key['key_id'])
282 self.AddPersonKey(pointer, {'key_type': 'ssh', 'key': new_key})
284 #elif type == "node":
285 #self.UpdateNode(pointer, new_sfa_record)
290 def remove (self, sfa_record):
291 type=sfa_record['type']
292 hrn=sfa_record['hrn']
293 record_id= sfa_record['record_id']
295 username = hrn.split(".")[len(hrn.split(".")) -1]
297 persons = self.GetPersons(username)
298 # only delete this person if he has site ids. if he doesnt, it probably means
299 # he was just removed from a site, not actually deleted
300 if persons and persons[0]['site_ids']:
301 self.DeletePerson(username)
302 elif type == 'slice':
303 if self.GetSlices(hrn):
304 self.DeleteSlice(hrn)
306 #elif type == 'authority':
307 #if self.GetSites(pointer):
308 #self.DeleteSite(pointer)
314 def GetPersons(self, person_filter=None, return_fields=None):
316 person_list = self.ldap.ldapFind({'authority': self.root_auth })
319 #if person_filter and isinstance(person_filter, dict):
320 #for k in person_filter.keys():
321 #if k in person_list[0].keys():
324 return_person_list = parse_filter(person_list,person_filter ,'persons', return_fields)
325 if return_person_list:
326 print>>sys.stderr, " \r\n GetPersons person_filter %s return_fields %s return_person_list %s " %(person_filter,return_fields,return_person_list)
327 return return_person_list
329 def GetNodes(self,node_filter= None, return_fields=None):
331 self.oar.parser.SendRequest("GET_resources_full")
332 node_dict = self.oar.parser.GetNodesFromOARParse()
333 return_node_list = []
335 if not (node_filter or return_fields):
336 return_node_list = node_dict.values()
337 return return_node_list
339 return_node_list= parse_filter(node_dict.values(),node_filter ,'node', return_fields)
340 return return_node_list
342 def GetSites(self, auth, site_filter = None, return_fields=None):
343 self.oar.parser.SendRequest("GET_resources_full")
344 site_dict = self.oar.parser.GetSitesFromOARParse()
345 return_site_list = []
346 site = site_dict.values()[0]
347 if not (site_filter or return_fields):
348 return_site_list = site_dict.values()
349 return return_site_list
351 return_site_list = parse_filter(site_dict.values(),site_filter ,'site', return_fields)
352 return return_site_list
354 def GetSlices(self,slice_filter = None, return_fields=None):
356 return_slice_list =[]
357 sliceslist = self.db.find('slice',columns = ['slice_hrn', 'record_id_slice','record_id_user'])
358 print >>sys.stderr, " \r\n \r\n SLABDRIVER.PY GetSlices slices %s" %(sliceslist)
359 #slicesdict = sliceslist[0]
360 if not (slice_filter or return_fields):
361 return_slice_list = sliceslist
362 return return_slice_list
364 return_slice_list = parse_filter(sliceslist, slice_filter,'slice', return_fields)
365 print >>sys.stderr, " \r\n \r\n SLABDRIVER.PY GetSlices return_slice_list %s" %(return_slice_list)
366 return return_slice_list
368 def testbed_name (self): return "senslab2"
370 # 'geni_request_rspec_versions' and 'geni_ad_rspec_versions' are mandatory
371 def aggregate_version (self):
372 version_manager = VersionManager()
373 ad_rspec_versions = []
374 request_rspec_versions = []
375 for rspec_version in version_manager.versions:
376 if rspec_version.content_type in ['*', 'ad']:
377 ad_rspec_versions.append(rspec_version.to_dict())
378 if rspec_version.content_type in ['*', 'request']:
379 request_rspec_versions.append(rspec_version.to_dict())
381 'testbed':self.testbed_name(),
382 'geni_request_rspec_versions': request_rspec_versions,
383 'geni_ad_rspec_versions': ad_rspec_versions,
392 # Convert SFA fields to PLC fields for use when registering up updating
393 # registry record in the PLC database
395 # @param type type of record (user, slice, ...)
396 # @param hrn human readable name
397 # @param sfa_fields dictionary of SFA fields
398 # @param pl_fields dictionary of PLC fields (output)
400 def sfa_fields_to_pl_fields(self, type, hrn, record):
402 def convert_ints(tmpdict, int_fields):
403 for field in int_fields:
405 tmpdict[field] = int(tmpdict[field])
408 #for field in record:
409 # pl_record[field] = record[field]
412 #instantion used in get_slivers ?
413 if not "instantiation" in pl_record:
414 pl_record["instantiation"] = "senslab-instantiated"
415 pl_record["hrn"] = hrn_to_pl_slicename(hrn)
417 pl_record["url"] = record["url"]
418 if "description" in record:
419 pl_record["description"] = record["description"]
420 if "expires" in record:
421 pl_record["expires"] = int(record["expires"])
423 #nodes added by OAR only and then imported to SFA
424 #elif type == "node":
425 #if not "hostname" in pl_record:
426 #if not "hostname" in record:
427 #raise MissingSfaInfo("hostname")
428 #pl_record["hostname"] = record["hostname"]
429 #if not "model" in pl_record:
430 #pl_record["model"] = "geni"
433 #elif type == "authority":
434 #pl_record["login_base"] = hrn_to_pl_login_base(hrn)
436 #if not "name" in pl_record:
437 #pl_record["name"] = hrn
439 #if not "abbreviated_name" in pl_record:
440 #pl_record["abbreviated_name"] = hrn
442 #if not "enabled" in pl_record:
443 #pl_record["enabled"] = True
445 #if not "is_public" in pl_record:
446 #pl_record["is_public"] = True
453 def AddSliceToNodes(self, slice_name, added_nodes, slice_user=None):
454 print>>sys.stderr, "\r\n \r\n AddSliceToNodes slice_name %s added_nodes %s username %s" %(slice_name,added_nodes,slice_user )
459 reqdict['property'] ="network_address in ("
460 for node in added_nodes:
461 #Get the ID of the node : remove the root auth and put the site in a separate list
462 tmp = node.strip(self.root_auth+".")
465 nodeid= (l[len(l)-1])
466 reqdict['property'] += "'"+ nodeid +"', "
467 nodeid_list.append(nodeid)
468 site_list.append( l[0] )
470 reqdict['property'] = reqdict['property'][0: len( reqdict['property'])-2] +")"
471 reqdict['resource'] ="network_address="+ str(len(nodeid_list))
472 reqdict['resource']+= ",walltime=" + str(00) + ":" + str(05) + ":" + str(00)
473 reqdict['script_path'] = "/bin/sleep "
475 print>>sys.stderr, "\r\n \r\n AddSliceToNodes reqdict %s \r\n site_list %s" %(reqdict,site_list)
477 #answer = OAR.POSTRequestToOARRestAPI('POST_job',reqdict,slice_user)
478 #print>>sys.stderr, "\r\n \r\n AddSliceToNodes jobid %s " %(answer)
479 #self.db.update('slice',['oar_job_id'], [answer['id']], 'slice_hrn', slice_name)
485 def DeleteSliceFromNodes(self, slice_name, deleted_nodes):
490 def fill_record_sfa_info(self, records):
492 def startswith(prefix, values):
493 return [value for value in values if value.startswith(prefix)]
498 for record in records:
499 person_ids.extend(record.get("person_ids", []))
500 site_ids.extend(record.get("site_ids", []))
501 if 'site_id' in record:
502 site_ids.append(record['site_id'])
504 #print>>sys.stderr, "\r\n \r\n _fill_record_sfa_info ___person_ids %s \r\n \t\t site_ids %s " %(person_ids, site_ids)
506 # get all pis from the sites we've encountered
507 # and store them in a dictionary keyed on site_id
510 pi_filter = {'|roles': ['pi'], '|site_ids': site_ids}
511 pi_list = self.GetPersons( pi_filter, ['person_id', 'site_ids'])
512 #print>>sys.stderr, "\r\n \r\n _fill_record_sfa_info ___ GetPersons ['person_id', 'site_ids'] pi_ilist %s" %(pi_list)
515 # we will need the pi's hrns also
516 person_ids.append(pi['person_id'])
518 # we also need to keep track of the sites these pis
520 for site_id in pi['site_ids']:
521 if site_id in site_pis:
522 site_pis[site_id].append(pi)
524 site_pis[site_id] = [pi]
526 # get sfa records for all records associated with these records.
527 # we'll replace pl ids (person_ids) with hrns from the sfa records
530 # get the sfa records
532 person_list, persons = [], {}
533 person_list = table.find({'type': 'user', 'pointer': person_ids})
534 # create a hrns keyed on the sfa record's pointer.
535 # Its possible for multiple records to have the same pointer so
536 # the dict's value will be a list of hrns.
537 persons = defaultdict(list)
538 for person in person_list:
539 persons[person['pointer']].append(person)
542 pl_person_list, pl_persons = [], {}
543 pl_person_list = self.GetPersons(person_ids, ['person_id', 'roles'])
544 pl_persons = list_to_dict(pl_person_list, 'person_id')
545 #print>>sys.stderr, "\r\n \r\n _fill_record_sfa_info ___ _list %s \r\n \t\t SenslabUsers.GetPersons ['person_id', 'roles'] pl_persons %s \r\n records %s" %(pl_person_list, pl_persons,records)
548 for record in records:
549 # skip records with no pl info (top level authorities)
550 #Sandrine 24 oct 11 2 lines
551 #if record['pointer'] == -1:
554 type = record['type']
555 if (type == "slice"):
556 # all slice users are researchers
557 #record['geni_urn'] = hrn_to_urn(record['hrn'], 'slice') ? besoin ou pas ?
559 record['researcher'] = []
560 for person_id in record.get('person_ids', []):
561 #Sandrine 24 oct 11 line
562 #for person_id in record['person_ids']:
563 hrns = [person['hrn'] for person in persons[person_id]]
564 record['researcher'].extend(hrns)
566 # pis at the slice's site
567 pl_pis = site_pis[record['site_id']]
568 pi_ids = [pi['person_id'] for pi in pl_pis]
569 for person_id in pi_ids:
570 hrns = [person['hrn'] for person in persons[person_id]]
571 record['PI'].extend(hrns)
572 record['geni_urn'] = hrn_to_urn(record['hrn'], 'slice')
573 record['geni_creator'] = record['PI']
575 elif (type == "authority"):
577 record['operator'] = []
579 for pointer in record['person_ids']:
580 if pointer not in persons or pointer not in pl_persons:
581 # this means there is not sfa or pl record for this user
583 hrns = [person['hrn'] for person in persons[pointer]]
584 roles = pl_persons[pointer]['roles']
586 record['PI'].extend(hrns)
588 record['operator'].extend(hrns)
590 record['owner'].extend(hrns)
591 # xxx TODO: OrganizationName
592 elif (type == "node"):
593 sfa_info['dns'] = record.get("hostname", "")
594 # xxx TODO: URI, LatLong, IP, DNS
596 elif (type == "user"):
597 sfa_info['email'] = record.get("email", "")
598 sfa_info['geni_urn'] = hrn_to_urn(record['hrn'], 'user')
599 sfa_info['geni_certificate'] = record['gid']
600 # xxx TODO: PostalAddress, Phone
602 #print>>sys.stderr, "\r\n \r\rn \t\t \t <<<<<<<<<<<<<<<<<<<<<<<< fill_record_sfa_info sfa_info %s \r\n record %s : "%(sfa_info,record)
603 record.update(sfa_info)
605 def augment_records_with_testbed_info (self, sfa_records):
606 return self.fill_record_info (sfa_records)
608 def fill_record_info(self, records):
610 Given a SFA record, fill in the senslab specific and SFA specific
611 fields in the record.
613 print >>sys.stderr, "\r\n \t\t BEFORE fill_record_pl_info %s" %(records)
614 if isinstance(records, list):
616 #print >>sys.stderr, "\r\n \t\t BEFORE fill_record_pl_info %s" %(records)
619 if records['type'] == 'slice':
621 sfatable = SfaTable()
622 recslice = self.db.find('slice',str(records['hrn']))
623 if isinstance(recslice,list) and len(recslice) == 1:
624 recslice = recslice[0]
625 recuser = sfatable.find( recslice['record_id_user'], ['hrn'])
627 print >>sys.stderr, "\r\n \t\t SLABDRIVER.PY fill_record_info %s" %(recuser)
629 if isinstance(recuser,list) and len(recuser) == 1:
631 records.update({'PI':[recuser['hrn']],
632 'researcher': [recuser['hrn']],
633 'name':records['hrn'], 'oar_job_id':recslice['oar_job_id'],
636 'person_ids':[recslice['record_id_user']]})
638 #self.fill_record_pl_info(records)
639 ##print >>sys.stderr, "\r\n \t\t after fill_record_pl_info %s" %(records)
640 #self.fill_record_sfa_info(records)
641 #print >>sys.stderr, "\r\n \t\t after fill_record_sfa_info"
643 #def update_membership_list(self, oldRecord, record, listName, addFunc, delFunc):
644 ## get a list of the HRNs tht are members of the old and new records
646 #oldList = oldRecord.get(listName, [])
649 #newList = record.get(listName, [])
651 ## if the lists are the same, then we don't have to update anything
652 #if (oldList == newList):
655 ## build a list of the new person ids, by looking up each person to get
659 #records = table.find({'type': 'user', 'hrn': newList})
661 #newIdList.append(rec['pointer'])
663 ## build a list of the old person ids from the person_ids field
665 #oldIdList = oldRecord.get("person_ids", [])
666 #containerId = oldRecord.get_pointer()
668 ## if oldRecord==None, then we are doing a Register, instead of an
671 #containerId = record.get_pointer()
673 ## add people who are in the new list, but not the oldList
674 #for personId in newIdList:
675 #if not (personId in oldIdList):
676 #addFunc(self.plauth, personId, containerId)
678 ## remove people who are in the old list, but not the new list
679 #for personId in oldIdList:
680 #if not (personId in newIdList):
681 #delFunc(self.plauth, personId, containerId)
683 #def update_membership(self, oldRecord, record):
684 #print >>sys.stderr, " \r\n \r\n ***SLABDRIVER.PY update_membership record ", record
685 #if record.type == "slice":
686 #self.update_membership_list(oldRecord, record, 'researcher',
687 #self.users.AddPersonToSlice,
688 #self.users.DeletePersonFromSlice)
689 #elif record.type == "authority":
694 # I don't think you plan on running a component manager at this point
695 # let me clean up the mess of ComponentAPI that is deprecated anyways