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)
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']
190 elif type == 'slice':
191 acceptable_fields=['url', 'instantiation', 'name', 'description']
192 for key in pl_record.keys():
193 if key not in acceptable_fields:
195 slices = self.shell.GetSlices([pl_record['name']])
197 pointer = self.shell.AddSlice(pl_record)
199 pointer = slices[0]['slice_id']
202 persons = self.shell.GetPersons([sfa_record['email']])
204 pointer = self.shell.AddPerson(dict(sfa_record))
206 pointer = persons[0]['person_id']
208 if 'enabled' in sfa_record and sfa_record['enabled']:
209 self.shell.UpdatePerson(pointer, {'enabled': sfa_record['enabled']})
210 # add this person to the site only if she is being added for the first
211 # time by sfa and doesont already exist in plc
212 if not persons or not persons[0]['site_ids']:
213 login_base = get_leaf(sfa_record['authority'])
214 self.shell.AddPersonToSite(pointer, login_base)
216 # What roles should this user have?
217 self.shell.AddRoleToPerson('user', pointer)
220 self.shell.AddPersonKey(pointer, {'key_type' : 'ssh', 'key' : pub_key})
223 login_base = hrn_to_pl_login_base(sfa_record['authority'])
224 nodes = self.shell.GetNodes([pl_record['hostname']])
226 pointer = self.shell.AddNode(login_base, pl_record)
228 pointer = nodes[0]['node_id']
233 def GetPersons(self, person_filter=None, return_fields=None):
235 person_list = self.ldap.ldapFind({'authority': self.root_auth })
238 #if person_filter and isinstance(person_filter, dict):
239 #for k in person_filter.keys():
240 #if k in person_list[0].keys():
243 return_person_list = parse_filter(person_list,person_filter ,'persons', return_fields)
244 if return_person_list:
245 print>>sys.stderr, " \r\n GetPersons person_filter %s return_fields %s return_person_list %s " %(person_filter,return_fields,return_person_list)
246 return return_person_list
248 def GetNodes(self,node_filter= None, return_fields=None):
250 self.oar.parser.SendRequest("GET_resources_full")
251 node_dict = self.oar.parser.GetNodesFromOARParse()
252 return_node_list = []
254 if not (node_filter or return_fields):
255 return_node_list = node_dict.values()
256 return return_node_list
258 return_node_list= parse_filter(node_dict.values(),node_filter ,'node', return_fields)
259 return return_node_list
261 def GetSites(self, auth, site_filter = None, return_fields=None):
262 self.oar.parser.SendRequest("GET_resources_full")
263 site_dict = self.oar.parser.GetSitesFromOARParse()
264 return_site_list = []
265 site = site_dict.values()[0]
266 if not (site_filter or return_fields):
267 return_site_list = site_dict.values()
268 return return_site_list
270 return_site_list = parse_filter(site_dict.values(),site_filter ,'site', return_fields)
271 return return_site_list
273 def GetSlices(self,slice_filter = None, return_fields=None):
275 return_slice_list =[]
276 sliceslist = self.db.find('slice',columns = ['slice_hrn', 'record_id_slice','record_id_user'])
277 print >>sys.stderr, " \r\n \r\n SLABDRIVER.PY GetSlices slices %s" %(sliceslist)
278 #slicesdict = sliceslist[0]
279 if not (slice_filter or return_fields):
280 return_slice_list = sliceslist
281 return return_slice_list
283 return_slice_list = parse_filter(sliceslist, slice_filter,'slice', return_fields)
284 print >>sys.stderr, " \r\n \r\n SLABDRIVER.PY GetSlices return_slice_list %s" %(return_slice_list)
285 return return_slice_list
287 def testbed_name (self): return "senslab2"
289 # 'geni_request_rspec_versions' and 'geni_ad_rspec_versions' are mandatory
290 def aggregate_version (self):
291 version_manager = VersionManager()
292 ad_rspec_versions = []
293 request_rspec_versions = []
294 for rspec_version in version_manager.versions:
295 if rspec_version.content_type in ['*', 'ad']:
296 ad_rspec_versions.append(rspec_version.to_dict())
297 if rspec_version.content_type in ['*', 'request']:
298 request_rspec_versions.append(rspec_version.to_dict())
300 'testbed':self.testbed_name(),
301 'geni_request_rspec_versions': request_rspec_versions,
302 'geni_ad_rspec_versions': ad_rspec_versions,
311 # Convert SFA fields to PLC fields for use when registering up updating
312 # registry record in the PLC database
314 # @param type type of record (user, slice, ...)
315 # @param hrn human readable name
316 # @param sfa_fields dictionary of SFA fields
317 # @param pl_fields dictionary of PLC fields (output)
319 def sfa_fields_to_pl_fields(self, type, hrn, record):
321 def convert_ints(tmpdict, int_fields):
322 for field in int_fields:
324 tmpdict[field] = int(tmpdict[field])
327 #for field in record:
328 # pl_record[field] = record[field]
331 #instantion used in get_slivers ?
332 if not "instantiation" in pl_record:
333 pl_record["instantiation"] = "senslab-instantiated"
334 pl_record["hrn"] = hrn_to_pl_slicename(hrn)
336 pl_record["url"] = record["url"]
337 if "description" in record:
338 pl_record["description"] = record["description"]
339 if "expires" in record:
340 pl_record["expires"] = int(record["expires"])
342 #nodes added by OAR only and then imported to SFA
343 #elif type == "node":
344 #if not "hostname" in pl_record:
345 #if not "hostname" in record:
346 #raise MissingSfaInfo("hostname")
347 #pl_record["hostname"] = record["hostname"]
348 #if not "model" in pl_record:
349 #pl_record["model"] = "geni"
352 #elif type == "authority":
353 #pl_record["login_base"] = hrn_to_pl_login_base(hrn)
355 #if not "name" in pl_record:
356 #pl_record["name"] = hrn
358 #if not "abbreviated_name" in pl_record:
359 #pl_record["abbreviated_name"] = hrn
361 #if not "enabled" in pl_record:
362 #pl_record["enabled"] = True
364 #if not "is_public" in pl_record:
365 #pl_record["is_public"] = True
372 def AddSliceToNodes(self, slice_name, added_nodes, slice_user=None):
373 print>>sys.stderr, "\r\n \r\n AddSliceToNodes slice_name %s added_nodes %s username %s" %(slice_name,added_nodes,slice_user )
378 reqdict['property'] ="network_address in ("
379 for node in added_nodes:
380 #Get the ID of the node : remove the root auth and put the site in a separate list
381 tmp = node.strip(self.root_auth+".")
384 nodeid= (l[len(l)-1])
385 reqdict['property'] += "'"+ nodeid +"', "
386 nodeid_list.append(nodeid)
387 site_list.append( l[0] )
389 reqdict['property'] = reqdict['property'][0: len( reqdict['property'])-2] +")"
390 reqdict['resource'] ="network_address="+ str(len(nodeid_list))
391 reqdict['resource']+= ",walltime=" + str(00) + ":" + str(05) + ":" + str(00)
392 reqdict['script_path'] = "/bin/sleep "
394 print>>sys.stderr, "\r\n \r\n AddSliceToNodes reqdict %s \r\n site_list %s" %(reqdict,site_list)
396 #answer = OAR.POSTRequestToOARRestAPI('POST_job',reqdict,slice_user)
397 #print>>sys.stderr, "\r\n \r\n AddSliceToNodes jobid %s " %(answer)
398 #self.db.update('slice',['oar_job_id'], [answer['id']], 'slice_hrn', slice_name)
404 def DeleteSliceFromNodes(self, slice_name, deleted_nodes):
409 def fill_record_sfa_info(self, records):
411 def startswith(prefix, values):
412 return [value for value in values if value.startswith(prefix)]
417 for record in records:
418 person_ids.extend(record.get("person_ids", []))
419 site_ids.extend(record.get("site_ids", []))
420 if 'site_id' in record:
421 site_ids.append(record['site_id'])
423 #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)
425 # get all pis from the sites we've encountered
426 # and store them in a dictionary keyed on site_id
429 pi_filter = {'|roles': ['pi'], '|site_ids': site_ids}
430 pi_list = self.GetPersons( pi_filter, ['person_id', 'site_ids'])
431 #print>>sys.stderr, "\r\n \r\n _fill_record_sfa_info ___ GetPersons ['person_id', 'site_ids'] pi_ilist %s" %(pi_list)
434 # we will need the pi's hrns also
435 person_ids.append(pi['person_id'])
437 # we also need to keep track of the sites these pis
439 for site_id in pi['site_ids']:
440 if site_id in site_pis:
441 site_pis[site_id].append(pi)
443 site_pis[site_id] = [pi]
445 # get sfa records for all records associated with these records.
446 # we'll replace pl ids (person_ids) with hrns from the sfa records
449 # get the sfa records
451 person_list, persons = [], {}
452 person_list = table.find({'type': 'user', 'pointer': person_ids})
453 # create a hrns keyed on the sfa record's pointer.
454 # Its possible for multiple records to have the same pointer so
455 # the dict's value will be a list of hrns.
456 persons = defaultdict(list)
457 for person in person_list:
458 persons[person['pointer']].append(person)
461 pl_person_list, pl_persons = [], {}
462 pl_person_list = self.GetPersons(person_ids, ['person_id', 'roles'])
463 pl_persons = list_to_dict(pl_person_list, 'person_id')
464 #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)
467 for record in records:
468 # skip records with no pl info (top level authorities)
469 #Sandrine 24 oct 11 2 lines
470 #if record['pointer'] == -1:
473 type = record['type']
474 if (type == "slice"):
475 # all slice users are researchers
476 #record['geni_urn'] = hrn_to_urn(record['hrn'], 'slice') ? besoin ou pas ?
478 record['researcher'] = []
479 for person_id in record.get('person_ids', []):
480 #Sandrine 24 oct 11 line
481 #for person_id in record['person_ids']:
482 hrns = [person['hrn'] for person in persons[person_id]]
483 record['researcher'].extend(hrns)
485 # pis at the slice's site
486 pl_pis = site_pis[record['site_id']]
487 pi_ids = [pi['person_id'] for pi in pl_pis]
488 for person_id in pi_ids:
489 hrns = [person['hrn'] for person in persons[person_id]]
490 record['PI'].extend(hrns)
491 record['geni_urn'] = hrn_to_urn(record['hrn'], 'slice')
492 record['geni_creator'] = record['PI']
494 elif (type == "authority"):
496 record['operator'] = []
498 for pointer in record['person_ids']:
499 if pointer not in persons or pointer not in pl_persons:
500 # this means there is not sfa or pl record for this user
502 hrns = [person['hrn'] for person in persons[pointer]]
503 roles = pl_persons[pointer]['roles']
505 record['PI'].extend(hrns)
507 record['operator'].extend(hrns)
509 record['owner'].extend(hrns)
510 # xxx TODO: OrganizationName
511 elif (type == "node"):
512 sfa_info['dns'] = record.get("hostname", "")
513 # xxx TODO: URI, LatLong, IP, DNS
515 elif (type == "user"):
516 sfa_info['email'] = record.get("email", "")
517 sfa_info['geni_urn'] = hrn_to_urn(record['hrn'], 'user')
518 sfa_info['geni_certificate'] = record['gid']
519 # xxx TODO: PostalAddress, Phone
521 #print>>sys.stderr, "\r\n \r\rn \t\t \t <<<<<<<<<<<<<<<<<<<<<<<< fill_record_sfa_info sfa_info %s \r\n record %s : "%(sfa_info,record)
522 record.update(sfa_info)
524 def augment_records_with_testbed_info (self, sfa_records):
525 return self.fill_record_info (sfa_records)
527 def fill_record_info(self, records):
529 Given a SFA record, fill in the senslab specific and SFA specific
530 fields in the record.
532 print >>sys.stderr, "\r\n \t\t BEFORE fill_record_pl_info %s" %(records)
533 if isinstance(records, list):
535 #print >>sys.stderr, "\r\n \t\t BEFORE fill_record_pl_info %s" %(records)
538 if records['type'] == 'slice':
540 sfatable = SfaTable()
541 recslice = self.db.find('slice',str(records['hrn']))
542 if isinstance(recslice,list) and len(recslice) == 1:
543 recslice = recslice[0]
544 recuser = sfatable.find( recslice['record_id_user'], ['hrn'])
546 print >>sys.stderr, "\r\n \t\t SLABDRIVER.PY fill_record_info %s" %(recuser)
548 if isinstance(recuser,list) and len(recuser) == 1:
550 records.update({'PI':[recuser['hrn']],
551 'researcher': [recuser['hrn']],
552 'name':records['hrn'], 'oar_job_id':recslice['oar_job_id'],
555 'person_ids':[recslice['record_id_user']]})
557 #self.fill_record_pl_info(records)
558 ##print >>sys.stderr, "\r\n \t\t after fill_record_pl_info %s" %(records)
559 #self.fill_record_sfa_info(records)
560 #print >>sys.stderr, "\r\n \t\t after fill_record_sfa_info"
562 #def update_membership_list(self, oldRecord, record, listName, addFunc, delFunc):
563 ## get a list of the HRNs tht are members of the old and new records
565 #oldList = oldRecord.get(listName, [])
568 #newList = record.get(listName, [])
570 ## if the lists are the same, then we don't have to update anything
571 #if (oldList == newList):
574 ## build a list of the new person ids, by looking up each person to get
578 #records = table.find({'type': 'user', 'hrn': newList})
580 #newIdList.append(rec['pointer'])
582 ## build a list of the old person ids from the person_ids field
584 #oldIdList = oldRecord.get("person_ids", [])
585 #containerId = oldRecord.get_pointer()
587 ## if oldRecord==None, then we are doing a Register, instead of an
590 #containerId = record.get_pointer()
592 ## add people who are in the new list, but not the oldList
593 #for personId in newIdList:
594 #if not (personId in oldIdList):
595 #addFunc(self.plauth, personId, containerId)
597 ## remove people who are in the old list, but not the new list
598 #for personId in oldIdList:
599 #if not (personId in newIdList):
600 #delFunc(self.plauth, personId, containerId)
602 #def update_membership(self, oldRecord, record):
603 #print >>sys.stderr, " \r\n \r\n ***SLABDRIVER.PY update_membership record ", record
604 #if record.type == "slice":
605 #self.update_membership_list(oldRecord, record, 'researcher',
606 #self.users.AddPersonToSlice,
607 #self.users.DeletePersonFromSlice)
608 #elif record.type == "authority":
613 # I don't think you plan on running a component manager at this point
614 # let me clean up the mess of ComponentAPI that is deprecated anyways