Added OAR base of OAR job creation upon slice creation feature.
[sfa.git] / sfa / senslab / slabdriver.py
1 import sys
2
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
7
8 from sfa.util.xrn import hrn_to_urn
9 from sfa.util.plxrn import slicename_to_hrn, hostname_to_hrn, hrn_to_pl_slicename, hrn_to_pl_login_base
10
11 ## thierry: everything that is API-related (i.e. handling incoming requests) 
12 # is taken care of 
13 # SlabDriver should be really only about talking to the senslab testbed
14
15 ## thierry : please avoid wildcard imports :)
16 from sfa.senslab.OARrestapi import OARapi, OARrestapi
17 from sfa.senslab.LDAPapi import LDAPapi
18 from sfa.senslab.SenslabImportUsers import SenslabImportUsers
19 from sfa.senslab.parsing import parse_filter
20 from sfa.senslab.slabpostgres import SlabDB
21
22 def list_to_dict(recs, key):
23     """
24     convert a list of dictionaries into a dictionary keyed on the 
25     specified dictionary key 
26     """
27    # print>>sys.stderr, " \r\n \t\t 1list_to_dict : rec %s  \r\n \t\t list_to_dict key %s" %(recs,key)   
28     keys = [rec[key] for rec in recs]
29     #print>>sys.stderr, " \r\n \t\t list_to_dict : rec %s  \r\n \t\t list_to_dict keys %s" %(recs,keys)   
30     return dict(zip(keys, recs))
31
32 # thierry : note
33 # this inheritance scheme is so that the driver object can receive
34 # GetNodes or GetSites sorts of calls directly
35 # and thus minimize the differences in the managers with the pl version
36 class SlabDriver ():
37
38     def __init__(self, config):
39        
40         self.config=config
41         self.hrn = config.SFA_INTERFACE_HRN
42     
43         self.root_auth = config.SFA_REGISTRY_ROOT_AUTH
44
45         
46         print >>sys.stderr, "\r\n_____________ SFA SENSLAB DRIVER \r\n" 
47         # thierry - just to not break the rest of this code
48         #self.oar = OARapi()
49         #self.users = SenslabImportUsers()
50         self.oar = OARapi()
51         self.ldap = LDAPapi()
52         self.users = SenslabImportUsers()
53         self.time_format = "%Y-%m-%d %H:%M:%S"
54         #self.logger=sfa_logger()
55       
56         
57     def GetPersons(self, person_filter=None, return_fields=None):
58         
59         person_list = self.ldap.ldapFind({'authority': self.root_auth })
60         
61         #check = False
62         #if person_filter and isinstance(person_filter, dict):
63             #for k in  person_filter.keys():
64                 #if k in person_list[0].keys():
65                     #check = True
66                     
67         return_person_list = parse_filter(person_list,person_filter ,'persons', return_fields)
68         if return_person_list:
69             print>>sys.stderr, " \r\n GetPersons person_filter %s return_fields %s return_person_list %s " %(person_filter,return_fields,return_person_list)
70             return return_person_list
71     
72     def GetNodes(self,node_filter= None, return_fields=None):
73                 
74         self.oar.parser.SendRequest("GET_resources_full")
75         node_dict = self.oar.parser.GetNodesFromOARParse()
76         return_node_list = []
77
78         if not (node_filter or return_fields):
79                 return_node_list = node_dict.values()
80                 return return_node_list
81     
82         return_node_list= parse_filter(node_dict.values(),node_filter ,'node', return_fields)
83         return return_node_list
84     
85     def GetSites(self, auth, site_filter = None, return_fields=None):
86         self.oar.parser.SendRequest("GET_resources_full")
87         site_dict = self.oar.parser.GetSitesFromOARParse()
88         return_site_list = []
89         site = site_dict.values()[0]
90         if not (site_filter or return_fields):
91                 return_site_list = site_dict.values()
92                 return return_site_list
93         
94         return_site_list = parse_filter(site_dict.values(),site_filter ,'site', return_fields)
95         return return_site_list
96     
97     def GetSlices(self,slice_filter = None, return_fields=None):
98         db = SlabDB()
99         return_slice_list =[]
100         sliceslist = db.find('slice',columns = ['slice_hrn', 'record_id_slice','record_id_user'])
101         print >>sys.stderr, " \r\n \r\n SLABDRIVER.PY  GetSlices  slices %s" %(sliceslist)
102         #slicesdict = sliceslist[0]
103         if not (slice_filter or return_fields):
104                 return_slice_list = sliceslist
105                 return  return_slice_list
106         
107         return_slice_list  = parse_filter(sliceslist, slice_filter,'slice', return_fields)
108         print >>sys.stderr, " \r\n \r\n SLABDRIVER.PY  GetSlices  return_slice_list %s" %(return_slice_list)
109         return return_slice_list
110        
111     ##
112     # Convert SFA fields to PLC fields for use when registering up updating
113     # registry record in the PLC database
114     #
115     # @param type type of record (user, slice, ...)
116     # @param hrn human readable name
117     # @param sfa_fields dictionary of SFA fields
118     # @param pl_fields dictionary of PLC fields (output)
119
120     def sfa_fields_to_pl_fields(self, type, hrn, record):
121
122         def convert_ints(tmpdict, int_fields):
123             for field in int_fields:
124                 if field in tmpdict:
125                     tmpdict[field] = int(tmpdict[field])
126
127         pl_record = {}
128         #for field in record:
129         #    pl_record[field] = record[field]
130  
131         if type == "slice":
132             if not "instantiation" in pl_record:
133                 pl_record["instantiation"] = "plc-instantiated"
134             pl_record["name"] = hrn_to_pl_slicename(hrn)
135             if "url" in record:
136                pl_record["url"] = record["url"]
137             if "description" in record:
138                 pl_record["description"] = record["description"]
139             if "expires" in record:
140                 pl_record["expires"] = int(record["expires"])
141
142         elif type == "node":
143             if not "hostname" in pl_record:
144                 if not "hostname" in record:
145                     raise MissingSfaInfo("hostname")
146                 pl_record["hostname"] = record["hostname"]
147             if not "model" in pl_record:
148                 pl_record["model"] = "geni"
149
150         elif type == "authority":
151             pl_record["login_base"] = hrn_to_pl_login_base(hrn)
152
153             if not "name" in pl_record:
154                 pl_record["name"] = hrn
155
156             if not "abbreviated_name" in pl_record:
157                 pl_record["abbreviated_name"] = hrn
158
159             if not "enabled" in pl_record:
160                 pl_record["enabled"] = True
161
162             if not "is_public" in pl_record:
163                 pl_record["is_public"] = True
164
165         return pl_record
166
167     def fill_record_pl_info(self, records):
168         """
169         Fill in the planetlab specific fields of a SFA record. This
170         involves calling the appropriate PLC method to retrieve the 
171         database record for the object.
172         
173         PLC data is filled into the pl_info field of the record.
174     
175         @param record: record to fill in field (in/out param)     
176         """
177         # get ids by type
178         #print>>sys.stderr, "\r\n \r\rn \t\t >>>>>>>>>>fill_record_pl_info  records %s : "%(records)
179         node_ids, site_ids, slice_ids = [], [], [] 
180         person_ids, key_ids = [], []
181         type_map = {'node': node_ids, 'authority': site_ids,
182                     'slice': slice_ids, 'user': person_ids}
183                   
184         for record in records:
185             for type in type_map:
186                 #print>>sys.stderr, "\r\n \t\t \t fill_record_pl_info : type %s. record['pointer'] %s "%(type,record['pointer'])   
187                 if type == record['type']:
188                     type_map[type].append(record['pointer'])
189         #print>>sys.stderr, "\r\n \t\t \t fill_record_pl_info : records %s... \r\n \t\t \t fill_record_pl_info : type_map   %s"%(records,type_map)
190         # get pl records
191         nodes, sites, slices, persons, keys = {}, {}, {}, {}, {}
192         if node_ids:
193             node_list = self.GetNodes( node_ids)
194             #print>>sys.stderr, " \r\n \t\t\t BEFORE LIST_TO_DICT_NODES node_ids : %s" %(node_ids)
195             nodes = list_to_dict(node_list, 'node_id')
196         if site_ids:
197             site_list = self.oar.GetSites( site_ids)
198             sites = list_to_dict(site_list, 'site_id')
199             #print>>sys.stderr, " \r\n \t\t\t  site_ids %s sites  : %s" %(site_ids,sites)           
200         if slice_ids:
201             slice_list = self.users.GetSlices( slice_ids)
202             slices = list_to_dict(slice_list, 'slice_id')
203         if person_ids:
204             #print>>sys.stderr, " \r\n \t\t \t fill_record_pl_info BEFORE GetPersons  person_ids: %s" %(person_ids)
205             person_list = self.GetPersons( person_ids)
206             persons = list_to_dict(person_list, 'person_id')
207             #print>>sys.stderr, "\r\n  fill_record_pl_info persons %s \r\n \t\t person_ids %s " %(persons, person_ids) 
208             for person in persons:
209                 key_ids.extend(persons[person]['key_ids'])
210                 #print>>sys.stderr, "\r\n key_ids %s " %(key_ids)
211
212         pl_records = {'node': nodes, 'authority': sites,
213                       'slice': slices, 'user': persons}
214
215         if key_ids:
216             key_list = self.users.GetKeys( key_ids)
217             keys = list_to_dict(key_list, 'key_id')
218            # print>>sys.stderr, "\r\n  fill_record_pl_info persons %s \r\n \t\t keys %s " %(keys) 
219         # fill record info
220         for record in records:
221             # records with pointer==-1 do not have plc info.
222             # for example, the top level authority records which are
223             # authorities, but not PL "sites"
224             if record['pointer'] == -1:
225                 continue
226            
227             for type in pl_records:
228                 if record['type'] == type:
229                     if record['pointer'] in pl_records[type]:
230                         record.update(pl_records[type][record['pointer']])
231                         break
232             # fill in key info 
233             if record['type'] == 'user':
234                  if 'key_ids' not in record:
235                         #print>>sys.stderr, " NO_KEY_IDS fill_record_pl_info key_ids record: %s" %(record)
236                         logger.info("user record has no 'key_ids' - need to import  ?")
237                  else:
238                         pubkeys = [keys[key_id]['key'] for key_id in record['key_ids'] if key_id in keys] 
239                         record['keys'] = pubkeys
240                         
241         #print>>sys.stderr, "\r\n \r\rn \t\t <<<<<<<<<<<<<<<<<< fill_record_pl_info  records %s : "%(records)
242         # fill in record hrns
243         records = self.fill_record_hrns(records)   
244
245         return records
246                  
247                  
248                  
249     def AddSliceToNodes(self,  slice_name, added_nodes, slice_user=None):
250         print>>sys.stderr, "\r\n \r\n AddSliceToNodes  slice_name %s added_nodes %s username %s" %(slice_name,added_nodes,slice_user )
251         site_list = []
252         nodeid_list =[]
253         resource = ""
254         reqdict = {}
255         reqdict['property'] ="network_address in ("
256         for node in added_nodes:
257             #Get the ID of the node : remove the root auth and put the site in a separate list
258             tmp = node.strip(self.root_auth+".")
259             l = tmp.split("_")
260              
261             nodeid= (l[len(l)-1]) 
262             reqdict['property'] += "'"+ nodeid +"', "
263             nodeid_list.append(nodeid)
264             site_list.append( l[0] )
265             
266         reqdict['property'] =  reqdict['property'][0: len( reqdict['property'])-2] +")"
267         reqdict['resource'] ="network_address="+ str(len(nodeid_list))
268         reqdict['resource']+= ",walltime=" + str(00) + ":" + str(05) + ":" + str(00)
269         reqdict['script_path'] = "/bin/sleep "
270
271         print>>sys.stderr, "\r\n \r\n AddSliceToNodes reqdict   %s \r\n site_list   %s"  %(reqdict,site_list)   
272         OAR = OARrestapi()
273         OAR.POSTRequestToOARRestAPI('POST_job',reqdict,slice_user)
274         return 
275     
276
277         
278         
279     def DeleteSliceFromNodes(self, slice_name, deleted_nodes):
280         return   
281     
282     def fill_record_hrns(self, records):
283         """
284         convert pl ids to hrns
285         """
286         #print>>sys.stderr, "\r\n \r\rn \t\t \t >>>>>>>>>>>>>>>>>>>>>> fill_record_hrns records %s : "%(records)  
287         # get ids
288         slice_ids, person_ids, site_ids, node_ids = [], [], [], []
289         for record in records:
290             #print>>sys.stderr, "\r\n \r\rn \t\t \t record %s : "%(record)
291             if 'site_id' in record:
292                 site_ids.append(record['site_id'])
293             if 'site_ids' in records:
294                 site_ids.extend(record['site_ids'])
295             if 'person_ids' in record:
296                 person_ids.extend(record['person_ids'])
297             if 'slice_ids' in record:
298                 slice_ids.extend(record['slice_ids'])
299             if 'node_ids' in record:
300                 node_ids.extend(record['node_ids'])
301
302         # get pl records
303         slices, persons, sites, nodes = {}, {}, {}, {}
304         if site_ids:
305             site_list = self.oar.GetSites( site_ids, ['site_id', 'login_base'])
306             sites = list_to_dict(site_list, 'site_id')
307             #print>>sys.stderr, " \r\n \r\n \t\t ____ site_list %s \r\n \t\t____ sites %s " % (site_list,sites)
308         if person_ids:
309             person_list = self.GetPersons( person_ids, ['person_id', 'email'])
310             #print>>sys.stderr, " \r\n \r\n   \t\t____ person_lists %s " %(person_list) 
311             persons = list_to_dict(person_list, 'person_id')
312         if slice_ids:
313             slice_list = self.users.GetSlices( slice_ids, ['slice_id', 'name'])
314             slices = list_to_dict(slice_list, 'slice_id')       
315         if node_ids:
316             node_list = self.GetNodes( node_ids, ['node_id', 'hostname'])
317             nodes = list_to_dict(node_list, 'node_id')
318        
319         # convert ids to hrns
320         for record in records:
321              
322             # get all relevant data
323             type = record['type']
324             pointer = record['pointer']
325             auth_hrn = self.hrn
326             login_base = ''
327             if pointer == -1:
328                 continue
329
330             #print>>sys.stderr, " \r\n \r\n \t\t fill_record_hrns : sites %s \r\n \t\t record %s " %(sites, record)
331             if 'site_id' in record:
332                 site = sites[record['site_id']]
333                 #print>>sys.stderr, " \r\n \r\n \t\t \t fill_record_hrns : sites %s \r\n \t\t\t site sites[record['site_id']] %s " %(sites,site)        
334                 login_base = site['login_base']
335                 record['site'] = ".".join([auth_hrn, login_base])
336             if 'person_ids' in record:
337                 emails = [persons[person_id]['email'] for person_id in record['person_ids'] \
338                           if person_id in  persons]
339                 usernames = [email.split('@')[0] for email in emails]
340                 person_hrns = [".".join([auth_hrn, login_base, username]) for username in usernames]
341                 #print>>sys.stderr, " \r\n \r\n \t\t ____ person_hrns : %s " %(person_hrns)
342                 record['persons'] = person_hrns 
343             if 'slice_ids' in record:
344                 slicenames = [slices[slice_id]['name'] for slice_id in record['slice_ids'] \
345                               if slice_id in slices]
346                 slice_hrns = [slicename_to_hrn(auth_hrn, slicename) for slicename in slicenames]
347                 record['slices'] = slice_hrns
348             if 'node_ids' in record:
349                 hostnames = [nodes[node_id]['hostname'] for node_id in record['node_ids'] \
350                              if node_id in nodes]
351                 node_hrns = [hostname_to_hrn(auth_hrn, login_base, hostname) for hostname in hostnames]
352                 record['nodes'] = node_hrns
353             if 'site_ids' in record:
354                 login_bases = [sites[site_id]['login_base'] for site_id in record['site_ids'] \
355                                if site_id in sites]
356                 site_hrns = [".".join([auth_hrn, lbase]) for lbase in login_bases]
357                 record['sites'] = site_hrns
358         #print>>sys.stderr, "\r\n \r\rn \t\t \t <<<<<<<<<<<<<<<<<<<<<<<<  fill_record_hrns records %s : "%(records)  
359         return records   
360
361     def fill_record_sfa_info(self, records):
362
363         def startswith(prefix, values):
364             return [value for value in values if value.startswith(prefix)]
365
366         # get person ids
367         person_ids = []
368         site_ids = []
369         for record in records:
370             person_ids.extend(record.get("person_ids", []))
371             site_ids.extend(record.get("site_ids", [])) 
372             if 'site_id' in record:
373                 site_ids.append(record['site_id']) 
374                 
375         #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)
376         
377         # get all pis from the sites we've encountered
378         # and store them in a dictionary keyed on site_id 
379         site_pis = {}
380         if site_ids:
381             pi_filter = {'|roles': ['pi'], '|site_ids': site_ids} 
382             pi_list = self.GetPersons( pi_filter, ['person_id', 'site_ids'])
383             #print>>sys.stderr, "\r\n \r\n _fill_record_sfa_info ___ GetPersons ['person_id', 'site_ids'] pi_ilist %s" %(pi_list)
384
385             for pi in pi_list:
386                 # we will need the pi's hrns also
387                 person_ids.append(pi['person_id'])
388                 
389                 # we also need to keep track of the sites these pis
390                 # belong to
391                 for site_id in pi['site_ids']:
392                     if site_id in site_pis:
393                         site_pis[site_id].append(pi)
394                     else:
395                         site_pis[site_id] = [pi]
396                  
397         # get sfa records for all records associated with these records.   
398         # we'll replace pl ids (person_ids) with hrns from the sfa records
399         # we obtain
400         
401         # get the sfa records
402         table = SfaTable()
403         person_list, persons = [], {}
404         person_list = table.find({'type': 'user', 'pointer': person_ids})
405         # create a hrns keyed on the sfa record's pointer.
406         # Its possible for  multiple records to have the same pointer so
407         # the dict's value will be a list of hrns.
408         persons = defaultdict(list)
409         for person in person_list:
410             persons[person['pointer']].append(person)
411
412         # get the pl records
413         pl_person_list, pl_persons = [], {}
414         pl_person_list = self.GetPersons(person_ids, ['person_id', 'roles'])
415         pl_persons = list_to_dict(pl_person_list, 'person_id')
416         #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) 
417         # fill sfa info
418         
419         for record in records:
420             # skip records with no pl info (top level authorities)
421             #Sandrine 24 oct 11 2 lines
422             #if record['pointer'] == -1:
423                 #continue 
424             sfa_info = {}
425             type = record['type']
426             if (type == "slice"):
427                 # all slice users are researchers
428                 #record['geni_urn'] = hrn_to_urn(record['hrn'], 'slice')  ? besoin ou pas ?
429                 record['PI'] = []
430                 record['researcher'] = []
431                 for person_id in record.get('person_ids', []):
432                          #Sandrine 24 oct 11 line
433                 #for person_id in record['person_ids']:
434                     hrns = [person['hrn'] for person in persons[person_id]]
435                     record['researcher'].extend(hrns)                
436
437                 # pis at the slice's site
438                 pl_pis = site_pis[record['site_id']]
439                 pi_ids = [pi['person_id'] for pi in pl_pis]
440                 for person_id in pi_ids:
441                     hrns = [person['hrn'] for person in persons[person_id]]
442                     record['PI'].extend(hrns)
443                 record['geni_urn'] = hrn_to_urn(record['hrn'], 'slice')
444                 record['geni_creator'] = record['PI'] 
445                 
446             elif (type == "authority"):
447                 record['PI'] = []
448                 record['operator'] = []
449                 record['owner'] = []
450                 for pointer in record['person_ids']:
451                     if pointer not in persons or pointer not in pl_persons:
452                         # this means there is not sfa or pl record for this user
453                         continue   
454                     hrns = [person['hrn'] for person in persons[pointer]] 
455                     roles = pl_persons[pointer]['roles']   
456                     if 'pi' in roles:
457                         record['PI'].extend(hrns)
458                     if 'tech' in roles:
459                         record['operator'].extend(hrns)
460                     if 'admin' in roles:
461                         record['owner'].extend(hrns)
462                     # xxx TODO: OrganizationName
463             elif (type == "node"):
464                 sfa_info['dns'] = record.get("hostname", "")
465                 # xxx TODO: URI, LatLong, IP, DNS
466     
467             elif (type == "user"):
468                  sfa_info['email'] = record.get("email", "")
469                  sfa_info['geni_urn'] = hrn_to_urn(record['hrn'], 'user')
470                  sfa_info['geni_certificate'] = record['gid'] 
471                 # xxx TODO: PostalAddress, Phone
472                 
473             #print>>sys.stderr, "\r\n \r\rn \t\t \t <<<<<<<<<<<<<<<<<<<<<<<<  fill_record_sfa_info sfa_info %s  \r\n record %s : "%(sfa_info,record)  
474             record.update(sfa_info)
475
476     def fill_record_info(self, records):
477         """
478         Given a SFA record, fill in the senslab specific and SFA specific
479         fields in the record. 
480         """
481         print >>sys.stderr, "\r\n \t\t BEFORE fill_record_pl_info %s" %(records)        
482         if isinstance(records, list):
483             records = records[0]
484         #print >>sys.stderr, "\r\n \t\t BEFORE fill_record_pl_info %s" %(records)       
485         
486        
487         if records['type'] == 'slice':
488             db = SlabDB()
489             sfatable = SfaTable()
490             recslice = db.find('slice',str(records['hrn']))
491             if isinstance(recslice,list) and len(recslice) == 1:
492                 recslice = recslice[0]
493             recuser = sfatable.find(  recslice['record_id_user'], ['hrn'])
494             
495             print >>sys.stderr, "\r\n \t\t  SLABDRIVER.PY fill_record_info %s" %(recuser)
496             records['type']
497             if isinstance(recuser,list) and len(recuser) == 1:
498                 recuser = recuser[0]              
499             records.update({'PI':[recuser['hrn']],
500             'researcher': [recuser['hrn']],
501             'name':records['hrn'], 'oar_job_id':recslice['oar_job_id'],
502             
503             'node_ids': [],
504             'person_ids':[recslice['record_id_user']]})
505
506         #self.fill_record_pl_info(records)
507         ##print >>sys.stderr, "\r\n \t\t after fill_record_pl_info %s" %(records)       
508         #self.fill_record_sfa_info(records)
509         #print >>sys.stderr, "\r\n \t\t after fill_record_sfa_info"
510         
511     def update_membership_list(self, oldRecord, record, listName, addFunc, delFunc):
512         # get a list of the HRNs tht are members of the old and new records
513         if oldRecord:
514             oldList = oldRecord.get(listName, [])
515         else:
516             oldList = []     
517         newList = record.get(listName, [])
518
519         # if the lists are the same, then we don't have to update anything
520         if (oldList == newList):
521             return
522
523         # build a list of the new person ids, by looking up each person to get
524         # their pointer
525         newIdList = []
526         table = SfaTable()
527         records = table.find({'type': 'user', 'hrn': newList})
528         for rec in records:
529             newIdList.append(rec['pointer'])
530
531         # build a list of the old person ids from the person_ids field 
532         if oldRecord:
533             oldIdList = oldRecord.get("person_ids", [])
534             containerId = oldRecord.get_pointer()
535         else:
536             # if oldRecord==None, then we are doing a Register, instead of an
537             # update.
538             oldIdList = []
539             containerId = record.get_pointer()
540
541     # add people who are in the new list, but not the oldList
542         for personId in newIdList:
543             if not (personId in oldIdList):
544                 addFunc(self.plauth, personId, containerId)
545
546         # remove people who are in the old list, but not the new list
547         for personId in oldIdList:
548             if not (personId in newIdList):
549                 delFunc(self.plauth, personId, containerId)
550
551     def update_membership(self, oldRecord, record):
552         print >>sys.stderr, " \r\n \r\n ***SLABDRIVER.PY update_membership record ", record
553         if record.type == "slice":
554             self.update_membership_list(oldRecord, record, 'researcher',
555                                         self.users.AddPersonToSlice,
556                                         self.users.DeletePersonFromSlice)
557         elif record.type == "authority":
558             # xxx TODO
559             pass
560
561 ### thierry
562 # I don't think you plan on running a component manager at this point
563 # let me clean up the mess of ComponentAPI that is deprecated anyways