3 from sfa.util.faults import MissingSfaInfo
4 from sfa.util.sfalogging import logger
5 from sfa.util.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
11 from sfa.util.xrn import hrn_to_urn
12 from sfa.util.plxrn import slicename_to_hrn, hostname_to_hrn, hrn_to_pl_slicename, hrn_to_pl_login_base
14 ## thierry: everything that is API-related (i.e. handling incoming requests)
16 # SlabDriver should be really only about talking to the senslab testbed
18 ## thierry : please avoid wildcard imports :)
19 from sfa.senslab.OARrestapi import OARapi, OARrestapi
20 from sfa.senslab.LDAPapi import LDAPapi
21 from sfa.senslab.SenslabImportUsers import SenslabImportUsers
22 from sfa.senslab.parsing import parse_filter
23 from sfa.senslab.slabpostgres import SlabDB
25 def list_to_dict(recs, key):
27 convert a list of dictionaries into a dictionary keyed on the
28 specified dictionary key
30 # print>>sys.stderr, " \r\n \t\t 1list_to_dict : rec %s \r\n \t\t list_to_dict key %s" %(recs,key)
31 keys = [rec[key] for rec in recs]
32 #print>>sys.stderr, " \r\n \t\t list_to_dict : rec %s \r\n \t\t list_to_dict keys %s" %(recs,keys)
33 return dict(zip(keys, recs))
36 # this inheritance scheme is so that the driver object can receive
37 # GetNodes or GetSites sorts of calls directly
38 # and thus minimize the differences in the managers with the pl version
39 class SlabDriver(Driver):
41 def __init__(self, config):
42 Driver.__init__ (self, config)
44 self.hrn = config.SFA_INTERFACE_HRN
46 self.root_auth = config.SFA_REGISTRY_ROOT_AUTH
49 print >>sys.stderr, "\r\n_____________ SFA SENSLAB DRIVER \r\n"
50 # thierry - just to not break the rest of this code
55 self.users = SenslabImportUsers()
56 self.time_format = "%Y-%m-%d %H:%M:%S"
58 #self.logger=sfa_logger()
63 def create_sliver (self, slice_urn, slice_hrn, creds, rspec_string, users, options):
65 aggregate = SlabAggregate(self)
66 slices = SlabSlices(self)
67 peer = slices.get_peer(slice_hrn)
68 sfa_peer = slices.get_sfa_peer(slice_hrn)
71 slice_record = users[0].get('slice_record', {})
74 rspec = RSpec(rspec_string)
75 requested_attributes = rspec.version.get_slice_attributes()
77 # ensure site record exists
78 site = slices.verify_site(slice_hrn, slice_record, peer, sfa_peer, options=options)
79 # ensure slice record exists
80 slice = slices.verify_slice(slice_hrn, slice_record, peer, sfa_peer, options=options)
81 # ensure person records exists
82 persons = slices.verify_persons(slice_hrn, slice, users, peer, sfa_peer, options=options)
83 # ensure slice attributes exists
84 #slices.verify_slice_attributes(slice, requested_attributes, options=options)
86 # add/remove slice from nodes
87 requested_slivers = [node.get('component_name') for node in rspec.version.get_nodes_with_slivers()]
88 nodes = slices.verify_slice_nodes(slice, requested_slivers, peer)
90 # add/remove links links
91 #slices.verify_slice_links(slice, rspec.version.get_link_requests(), nodes)
93 # handle MyPLC peer association.
94 # only used by plc and ple.
95 #slices.handle_peer(site, slice, persons, peer)
97 return aggregate.get_rspec(slice_xrn=slice_urn, version=rspec.version)
100 def delete_sliver (self, slice_urn, slice_hrn, creds, options):
102 slices = self.GetSlices({'slice_hrn': slice_hrn})
107 # determine if this is a peer slice
108 # xxx I wonder if this would not need to use PlSlices.get_peer instead
109 # in which case plc.peers could be deprecated as this here
110 # is the only/last call to this last method in plc.peers
111 peer = peers.get_peer(self, slice_hrn)
114 self.UnBindObjectFromPeer('slice', slice['slice_id'], peer)
115 self.DeleteSliceFromNodes(slice_hrn, slice['node_ids'])
118 self.BindObjectToPeer('slice', slice['slice_id'], peer, slice['peer_slice_id'])
124 # first 2 args are None in case of resource discovery
125 def list_resources (self, slice_urn, slice_hrn, creds, options):
126 #cached_requested = options.get('cached', True)
128 version_manager = VersionManager()
129 # get the rspec's return format from options
130 rspec_version = version_manager.get_version(options.get('geni_rspec_version'))
131 version_string = "rspec_%s" % (rspec_version)
133 #panos adding the info option to the caching key (can be improved)
134 if options.get('info'):
135 version_string = version_string + "_"+options.get('info', 'default')
137 # look in cache first
138 #if cached_requested and self.cache and not slice_hrn:
139 #rspec = self.cache.get(version_string)
141 #logger.debug("SlabDriver.ListResources: returning cached advertisement")
144 #panos: passing user-defined options
145 #print "manager options = ",options
146 aggregate = SlabAggregate(self)
147 rspec = aggregate.get_rspec(slice_xrn=slice_urn, version=rspec_version,
151 #if self.cache and not slice_hrn:
152 #logger.debug("Slab.ListResources: stores advertisement in cache")
153 #self.cache.add(version_string, rspec)
158 def list_slices (self, creds, options):
159 # look in cache first
161 #slices = self.cache.get('slices')
163 #logger.debug("PlDriver.list_slices returns from cache")
167 slices = self.GetSlices({'peer_id': None}, ['name'])
168 slice_hrns = [slicename_to_hrn(self.hrn, slice['name']) for slice in slices]
169 slice_urns = [hrn_to_urn(slice_hrn, 'slice') for slice_hrn in slice_hrns]
173 #logger.debug ("SlabDriver.list_slices stores value in cache")
174 #self.cache.add('slices', slice_urns)
178 #No site or node register supported
179 def register (self, sfa_record, hrn, pub_key):
180 type = sfa_record['type']
181 pl_record = self.sfa_fields_to_pl_fields(type, hrn, sfa_record)
183 #if type == 'authority':
184 #sites = self.shell.GetSites([pl_record['login_base']])
186 #pointer = self.shell.AddSite(pl_record)
188 #pointer = sites[0]['site_id']
191 acceptable_fields=['url', 'instantiation', 'name', 'description']
192 for key in pl_record.keys():
193 if key not in acceptable_fields:
195 slices = self.GetSlices([pl_record['hrn']])
197 pointer = self.AddSlice(pl_record)
199 pointer = slices[0]['slice_id']
202 persons = self.GetPersons([sfa_record['hrn']])
204 pointer = self.AddPerson(dict(sfa_record))
207 pointer = persons[0]['person_id']
209 #Does this make sense to senslab ?
210 #if 'enabled' in sfa_record and sfa_record['enabled']:
211 #self.UpdatePerson(pointer, {'enabled': sfa_record['enabled']})
213 # add this person to the site only if she is being added for the first
214 # time by sfa and doesont already exist in plc
215 if not persons or not persons[0]['site_ids']:
216 login_base = get_leaf(sfa_record['authority'])
217 self.AddPersonToSite(pointer, login_base)
219 # What roles should this user have?
220 self.AddRoleToPerson('user', pointer)
223 self.AddPersonKey(pointer, {'key_type' : 'ssh', 'key' : pub_key})
225 #No node adding outside OAR
226 #elif type == 'node':
227 #login_base = hrn_to_pl_login_base(sfa_record['authority'])
228 #nodes = self.GetNodes([pl_record['hostname']])
230 #pointer = self.AddNode(login_base, pl_record)
232 #pointer = nodes[0]['node_id']
236 #No site or node record update allowed
237 def update (self, old_sfa_record, new_sfa_record, hrn, new_key):
238 pointer = old_sfa_record['pointer']
239 type = old_sfa_record['type']
241 # new_key implemented for users only
242 if new_key and type not in [ 'user' ]:
243 raise UnknownSfaType(type)
245 #if (type == "authority"):
246 #self.shell.UpdateSite(pointer, new_sfa_record)
249 pl_record=self.sfa_fields_to_pl_fields(type, hrn, new_sfa_record)
250 if 'name' in pl_record:
251 pl_record.pop('name')
252 self.UpdateSlice(pointer, pl_record)
256 all_fields = new_sfa_record
257 for key in all_fields.keys():
258 if key in ['first_name', 'last_name', 'title', 'email',
259 'password', 'phone', 'url', 'bio', 'accepted_aup',
261 update_fields[key] = all_fields[key]
262 self.UpdatePerson(pointer, update_fields)
265 # must check this key against the previous one if it exists
266 persons = self.GetPersons([pointer], ['key_ids'])
268 keys = person['key_ids']
269 keys = self.GetKeys(person['key_ids'])
271 # Delete all stale keys
274 if new_key != key['key']:
275 self.DeleteKey(key['key_id'])
279 self.AddPersonKey(pointer, {'key_type': 'ssh', 'key': new_key})
281 #elif type == "node":
282 #self.UpdateNode(pointer, new_sfa_record)
287 def GetPersons(self, person_filter=None, return_fields=None):
289 person_list = self.ldap.ldapFind({'authority': self.root_auth })
292 #if person_filter and isinstance(person_filter, dict):
293 #for k in person_filter.keys():
294 #if k in person_list[0].keys():
297 return_person_list = parse_filter(person_list,person_filter ,'persons', return_fields)
298 if return_person_list:
299 print>>sys.stderr, " \r\n GetPersons person_filter %s return_fields %s return_person_list %s " %(person_filter,return_fields,return_person_list)
300 return return_person_list
302 def GetNodes(self,node_filter= None, return_fields=None):
304 self.oar.parser.SendRequest("GET_resources_full")
305 node_dict = self.oar.parser.GetNodesFromOARParse()
306 return_node_list = []
308 if not (node_filter or return_fields):
309 return_node_list = node_dict.values()
310 return return_node_list
312 return_node_list= parse_filter(node_dict.values(),node_filter ,'node', return_fields)
313 return return_node_list
315 def GetSites(self, auth, site_filter = None, return_fields=None):
316 self.oar.parser.SendRequest("GET_resources_full")
317 site_dict = self.oar.parser.GetSitesFromOARParse()
318 return_site_list = []
319 site = site_dict.values()[0]
320 if not (site_filter or return_fields):
321 return_site_list = site_dict.values()
322 return return_site_list
324 return_site_list = parse_filter(site_dict.values(),site_filter ,'site', return_fields)
325 return return_site_list
327 def GetSlices(self,slice_filter = None, return_fields=None):
329 return_slice_list =[]
330 sliceslist = self.db.find('slice',columns = ['slice_hrn', 'record_id_slice','record_id_user'])
331 print >>sys.stderr, " \r\n \r\n SLABDRIVER.PY GetSlices slices %s" %(sliceslist)
332 #slicesdict = sliceslist[0]
333 if not (slice_filter or return_fields):
334 return_slice_list = sliceslist
335 return return_slice_list
337 return_slice_list = parse_filter(sliceslist, slice_filter,'slice', return_fields)
338 print >>sys.stderr, " \r\n \r\n SLABDRIVER.PY GetSlices return_slice_list %s" %(return_slice_list)
339 return return_slice_list
341 def testbed_name (self): return "senslab2"
343 # 'geni_request_rspec_versions' and 'geni_ad_rspec_versions' are mandatory
344 def aggregate_version (self):
345 version_manager = VersionManager()
346 ad_rspec_versions = []
347 request_rspec_versions = []
348 for rspec_version in version_manager.versions:
349 if rspec_version.content_type in ['*', 'ad']:
350 ad_rspec_versions.append(rspec_version.to_dict())
351 if rspec_version.content_type in ['*', 'request']:
352 request_rspec_versions.append(rspec_version.to_dict())
354 'testbed':self.testbed_name(),
355 'geni_request_rspec_versions': request_rspec_versions,
356 'geni_ad_rspec_versions': ad_rspec_versions,
365 # Convert SFA fields to PLC fields for use when registering up updating
366 # registry record in the PLC database
368 # @param type type of record (user, slice, ...)
369 # @param hrn human readable name
370 # @param sfa_fields dictionary of SFA fields
371 # @param pl_fields dictionary of PLC fields (output)
373 def sfa_fields_to_pl_fields(self, type, hrn, record):
375 def convert_ints(tmpdict, int_fields):
376 for field in int_fields:
378 tmpdict[field] = int(tmpdict[field])
381 #for field in record:
382 # pl_record[field] = record[field]
385 #instantion used in get_slivers ?
386 if not "instantiation" in pl_record:
387 pl_record["instantiation"] = "senslab-instantiated"
388 pl_record["hrn"] = hrn_to_pl_slicename(hrn)
390 pl_record["url"] = record["url"]
391 if "description" in record:
392 pl_record["description"] = record["description"]
393 if "expires" in record:
394 pl_record["expires"] = int(record["expires"])
396 #nodes added by OAR only and then imported to SFA
397 #elif type == "node":
398 #if not "hostname" in pl_record:
399 #if not "hostname" in record:
400 #raise MissingSfaInfo("hostname")
401 #pl_record["hostname"] = record["hostname"]
402 #if not "model" in pl_record:
403 #pl_record["model"] = "geni"
406 #elif type == "authority":
407 #pl_record["login_base"] = hrn_to_pl_login_base(hrn)
409 #if not "name" in pl_record:
410 #pl_record["name"] = hrn
412 #if not "abbreviated_name" in pl_record:
413 #pl_record["abbreviated_name"] = hrn
415 #if not "enabled" in pl_record:
416 #pl_record["enabled"] = True
418 #if not "is_public" in pl_record:
419 #pl_record["is_public"] = True
426 def AddSliceToNodes(self, slice_name, added_nodes, slice_user=None):
427 print>>sys.stderr, "\r\n \r\n AddSliceToNodes slice_name %s added_nodes %s username %s" %(slice_name,added_nodes,slice_user )
432 reqdict['property'] ="network_address in ("
433 for node in added_nodes:
434 #Get the ID of the node : remove the root auth and put the site in a separate list
435 tmp = node.strip(self.root_auth+".")
438 nodeid= (l[len(l)-1])
439 reqdict['property'] += "'"+ nodeid +"', "
440 nodeid_list.append(nodeid)
441 site_list.append( l[0] )
443 reqdict['property'] = reqdict['property'][0: len( reqdict['property'])-2] +")"
444 reqdict['resource'] ="network_address="+ str(len(nodeid_list))
445 reqdict['resource']+= ",walltime=" + str(00) + ":" + str(05) + ":" + str(00)
446 reqdict['script_path'] = "/bin/sleep "
448 print>>sys.stderr, "\r\n \r\n AddSliceToNodes reqdict %s \r\n site_list %s" %(reqdict,site_list)
450 #answer = OAR.POSTRequestToOARRestAPI('POST_job',reqdict,slice_user)
451 #print>>sys.stderr, "\r\n \r\n AddSliceToNodes jobid %s " %(answer)
452 #self.db.update('slice',['oar_job_id'], [answer['id']], 'slice_hrn', slice_name)
458 def DeleteSliceFromNodes(self, slice_name, deleted_nodes):
463 def fill_record_sfa_info(self, records):
465 def startswith(prefix, values):
466 return [value for value in values if value.startswith(prefix)]
471 for record in records:
472 person_ids.extend(record.get("person_ids", []))
473 site_ids.extend(record.get("site_ids", []))
474 if 'site_id' in record:
475 site_ids.append(record['site_id'])
477 #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)
479 # get all pis from the sites we've encountered
480 # and store them in a dictionary keyed on site_id
483 pi_filter = {'|roles': ['pi'], '|site_ids': site_ids}
484 pi_list = self.GetPersons( pi_filter, ['person_id', 'site_ids'])
485 #print>>sys.stderr, "\r\n \r\n _fill_record_sfa_info ___ GetPersons ['person_id', 'site_ids'] pi_ilist %s" %(pi_list)
488 # we will need the pi's hrns also
489 person_ids.append(pi['person_id'])
491 # we also need to keep track of the sites these pis
493 for site_id in pi['site_ids']:
494 if site_id in site_pis:
495 site_pis[site_id].append(pi)
497 site_pis[site_id] = [pi]
499 # get sfa records for all records associated with these records.
500 # we'll replace pl ids (person_ids) with hrns from the sfa records
503 # get the sfa records
505 person_list, persons = [], {}
506 person_list = table.find({'type': 'user', 'pointer': person_ids})
507 # create a hrns keyed on the sfa record's pointer.
508 # Its possible for multiple records to have the same pointer so
509 # the dict's value will be a list of hrns.
510 persons = defaultdict(list)
511 for person in person_list:
512 persons[person['pointer']].append(person)
515 pl_person_list, pl_persons = [], {}
516 pl_person_list = self.GetPersons(person_ids, ['person_id', 'roles'])
517 pl_persons = list_to_dict(pl_person_list, 'person_id')
518 #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)
521 for record in records:
522 # skip records with no pl info (top level authorities)
523 #Sandrine 24 oct 11 2 lines
524 #if record['pointer'] == -1:
527 type = record['type']
528 if (type == "slice"):
529 # all slice users are researchers
530 #record['geni_urn'] = hrn_to_urn(record['hrn'], 'slice') ? besoin ou pas ?
532 record['researcher'] = []
533 for person_id in record.get('person_ids', []):
534 #Sandrine 24 oct 11 line
535 #for person_id in record['person_ids']:
536 hrns = [person['hrn'] for person in persons[person_id]]
537 record['researcher'].extend(hrns)
539 # pis at the slice's site
540 pl_pis = site_pis[record['site_id']]
541 pi_ids = [pi['person_id'] for pi in pl_pis]
542 for person_id in pi_ids:
543 hrns = [person['hrn'] for person in persons[person_id]]
544 record['PI'].extend(hrns)
545 record['geni_urn'] = hrn_to_urn(record['hrn'], 'slice')
546 record['geni_creator'] = record['PI']
548 elif (type == "authority"):
550 record['operator'] = []
552 for pointer in record['person_ids']:
553 if pointer not in persons or pointer not in pl_persons:
554 # this means there is not sfa or pl record for this user
556 hrns = [person['hrn'] for person in persons[pointer]]
557 roles = pl_persons[pointer]['roles']
559 record['PI'].extend(hrns)
561 record['operator'].extend(hrns)
563 record['owner'].extend(hrns)
564 # xxx TODO: OrganizationName
565 elif (type == "node"):
566 sfa_info['dns'] = record.get("hostname", "")
567 # xxx TODO: URI, LatLong, IP, DNS
569 elif (type == "user"):
570 sfa_info['email'] = record.get("email", "")
571 sfa_info['geni_urn'] = hrn_to_urn(record['hrn'], 'user')
572 sfa_info['geni_certificate'] = record['gid']
573 # xxx TODO: PostalAddress, Phone
575 #print>>sys.stderr, "\r\n \r\rn \t\t \t <<<<<<<<<<<<<<<<<<<<<<<< fill_record_sfa_info sfa_info %s \r\n record %s : "%(sfa_info,record)
576 record.update(sfa_info)
578 def augment_records_with_testbed_info (self, sfa_records):
579 return self.fill_record_info (sfa_records)
581 def fill_record_info(self, records):
583 Given a SFA record, fill in the senslab specific and SFA specific
584 fields in the record.
586 print >>sys.stderr, "\r\n \t\t BEFORE fill_record_pl_info %s" %(records)
587 if isinstance(records, list):
589 #print >>sys.stderr, "\r\n \t\t BEFORE fill_record_pl_info %s" %(records)
592 if records['type'] == 'slice':
594 sfatable = SfaTable()
595 recslice = self.db.find('slice',str(records['hrn']))
596 if isinstance(recslice,list) and len(recslice) == 1:
597 recslice = recslice[0]
598 recuser = sfatable.find( recslice['record_id_user'], ['hrn'])
600 print >>sys.stderr, "\r\n \t\t SLABDRIVER.PY fill_record_info %s" %(recuser)
602 if isinstance(recuser,list) and len(recuser) == 1:
604 records.update({'PI':[recuser['hrn']],
605 'researcher': [recuser['hrn']],
606 'name':records['hrn'], 'oar_job_id':recslice['oar_job_id'],
609 'person_ids':[recslice['record_id_user']]})
611 #self.fill_record_pl_info(records)
612 ##print >>sys.stderr, "\r\n \t\t after fill_record_pl_info %s" %(records)
613 #self.fill_record_sfa_info(records)
614 #print >>sys.stderr, "\r\n \t\t after fill_record_sfa_info"
616 #def update_membership_list(self, oldRecord, record, listName, addFunc, delFunc):
617 ## get a list of the HRNs tht are members of the old and new records
619 #oldList = oldRecord.get(listName, [])
622 #newList = record.get(listName, [])
624 ## if the lists are the same, then we don't have to update anything
625 #if (oldList == newList):
628 ## build a list of the new person ids, by looking up each person to get
632 #records = table.find({'type': 'user', 'hrn': newList})
634 #newIdList.append(rec['pointer'])
636 ## build a list of the old person ids from the person_ids field
638 #oldIdList = oldRecord.get("person_ids", [])
639 #containerId = oldRecord.get_pointer()
641 ## if oldRecord==None, then we are doing a Register, instead of an
644 #containerId = record.get_pointer()
646 ## add people who are in the new list, but not the oldList
647 #for personId in newIdList:
648 #if not (personId in oldIdList):
649 #addFunc(self.plauth, personId, containerId)
651 ## remove people who are in the old list, but not the new list
652 #for personId in oldIdList:
653 #if not (personId in newIdList):
654 #delFunc(self.plauth, personId, containerId)
656 #def update_membership(self, oldRecord, record):
657 #print >>sys.stderr, " \r\n \r\n ***SLABDRIVER.PY update_membership record ", record
658 #if record.type == "slice":
659 #self.update_membership_list(oldRecord, record, 'researcher',
660 #self.users.AddPersonToSlice,
661 #self.users.DeletePersonFromSlice)
662 #elif record.type == "authority":
667 # I don't think you plan on running a component manager at this point
668 # let me clean up the mess of ComponentAPI that is deprecated anyways