2649abd7144b5f2012aeeb83b8d62cdbe21c0fe9
[sfa.git] / sfa / senslab / OARrestapi.py
1 import sys
2 import httplib
3 import json
4 import datetime
5 from time import gmtime, strftime 
6
7 import urllib
8 import urllib2
9 from sfa.util.config import Config
10 from sfa.planetlab.plxrn import PlXrn
11 from sfa.util.xrn import hrn_to_urn, get_authority,Xrn,get_leaf
12
13 from sfa.util.config import Config
14 from sfa.util.sfalogging import logger
15
16
17 OARIP ='194.199.16.161'
18
19
20
21
22
23
24
25 OARrequest_post_uri_dict = { 'POST_job':{'uri': '/oarapi/jobs.json'},
26                             'DELETE_jobs_id':{'uri':'/oarapi/jobs/id.json'},
27                             }
28
29 POSTformat = {  'json' : {'content':"application/json",'object':json}, 
30                 }
31
32 OARpostdatareqfields = {'resource' :"/nodes=", 'command':"sleep", \
33                         'workdir':"/home/", 'walltime':""}
34
35 class OARrestapi:
36     def __init__(self):
37         self.oarserver= {}
38         self.oarserver['ip'] = OARIP
39         self.oarserver['port'] = 8800
40         self.oarserver['uri'] = None
41         self.oarserver['postformat'] = 'json'
42         #logger.setLevelDebug()
43
44         self.jobstates  = ['Terminated','Hold','Waiting','toLaunch','toError',\
45                             'toAckReservation','Launching','Finishing',\
46                             'Running','Suspended','Resuming','Error']
47                             
48         self.parser = OARGETParser(self)
49        
50             
51     def GETRequestToOARRestAPI(self, request, strval=None , username = None ): 
52         self.oarserver['uri'] = OARGETParser.OARrequests_uri_dict[request]['uri']
53         headers = {}
54         data = json.dumps({})
55         logger.debug("OARrestapi \tGETRequestToOARRestAPI %s" %(request))
56         if strval:
57           self.oarserver['uri'] = self.oarserver['uri'].replace("id",str(strval))
58           logger.debug("OARrestapi: \t  GETRequestToOARRestAPI  \
59                             self.oarserver['uri'] %s strval %s" \
60                             %(self.oarserver['uri'], strval))
61         if username:
62             headers['X-REMOTE_IDENT'] = username 
63         try :  
64             #seems that it does not work if we don't add this
65             headers['content-length'] = '0' 
66
67             conn = httplib.HTTPConnection(self.oarserver['ip'],self.oarserver['port'])
68             conn.request("GET",self.oarserver['uri'],data , headers )
69             resp = ( conn.getresponse()).read()
70             #logger.debug("OARrestapi: \t GETRequestToOARRestAPI resp %s" %(resp))
71             conn.close()
72         except:
73             logger.log_exc("GET_OAR_SRVR : Could not reach OARserver")
74             #raise ServerError("GET_OAR_SRVR : Could not reach OARserver")
75         try:
76             js = json.loads(resp)
77             return js
78         
79         except ValueError,error:
80              logger.log_exc("Failed to parse Server Response: %s ERROR %s"\
81                                                             %(js, error))
82             #raise ServerError("Failed to parse Server Response:" + js)
83
84                 
85     def POSTRequestToOARRestAPI(self, request, datadict, username=None):
86         """ Used to post a job on OAR , along with data associated 
87         with the job.
88         
89         """
90
91         #first check that all params for are OK 
92         try:
93             self.oarserver['uri'] = OARrequest_post_uri_dict[request]['uri']
94
95         except KeyError:
96             logger.log_exc("OARrestapi \tPOSTRequestToOARRestAPI request not \
97                              valid")
98             return
99         try:
100             if datadict and 'strval' in datadict:
101                 self.oarserver['uri'] = self.oarserver['uri'].replace("id",\
102                                                     str(datadict['strval']))
103                 del datadict['strval']
104         except:
105             logger.log_exc("OARrestapi.py POSTRequestToOARRestAPI Error")
106             return
107
108         data = json.dumps(datadict)
109         headers = {'X-REMOTE_IDENT':username,\
110                 'content-type':POSTformat['json']['content'],\
111                 'content-length':str(len(data))}     
112         try :
113
114             conn = httplib.HTTPConnection(self.oarserver['ip'], \
115                                         self.oarserver['port'])
116             conn.request("POST",self.oarserver['uri'],data,headers )
117             resp = ( conn.getresponse()).read()
118             conn.close()
119         except:
120            logger.log_exc("POSTRequestToOARRestAPI  ERROR: \
121                             data %s \r\n \t\n \t\t headers %s uri %s" \
122                             %(data,headers,self.oarserver['uri']))
123
124             #raise ServerError("POST_OAR_SRVR : error")
125                 
126         try:
127             answer = json.loads(resp)
128             logger.debug("POSTRequestToOARRestAPI : answer %s" %(answer))
129             return answer
130
131         except ValueError,error:
132             logger.log_exc("Failed to parse Server Response: error %s answer \
133                             %s" %(error,answer))
134             #raise ServerError("Failed to parse Server Response:" + answer)
135
136
137     #def createjobrequest(self, nodelist):
138         #datadict = dict(zip(self.OARpostdatareqfields.keys(), self.OARpostdatareqfields.values())
139         #for k in datadict:
140                 #if k is 'resource':
141                     #for node in nodelist:
142                     #datadict[k] += str(nodelist)
143
144                         
145                         
146 class OARGETParser:
147
148
149     #def AddNodeNetworkAddr(self,tuplelist,value):
150         #tuplelist.append(('hostname',str(value)))
151         
152     def AddNodeNetworkAddr(self,dictnode,value):
153         #Inserts new key. The value associated is a tuple list
154         node_id = value
155         
156         dictnode[node_id] = [('node_id',node_id),('hostname',node_id) ] 
157         
158         return node_id 
159             
160     def AddNodeSite(self,tuplelist,value):
161         tuplelist.append(('site',str(value)))
162                 
163             
164     def AddNodeRadio(self,tuplelist,value):
165         tuplelist.append(('radio',str(value)))  
166     
167     
168     def AddMobility(self,tuplelist,value): 
169         if value :
170             tuplelist.append(('mobile',int(value)))     
171
172     
173     
174     def AddPosX(self,tuplelist,value):
175         tuplelist.append(('posx',value))        
176     
177     
178     def AddPosY(self,tuplelist,value):
179         tuplelist.append(('posy',value))        
180     
181     def AddBootState(self,tuplelist,value):
182         tuplelist.append(('boot_state',str(value)))
183                 
184     #Insert a new node into the dictnode dictionary
185     def AddNodeId(self,dictnode,value):
186         #Inserts new key. The value associated is a tuple list
187         node_id = int(value)
188         
189         dictnode[node_id] = [('node_id',node_id) ]      
190         return node_id
191     
192     def ParseVersion(self) : 
193         #print self.raw_json
194         #print >>sys.stderr, self.raw_json
195         if 'oar_version' in self.raw_json :
196             self.version_json_dict.update(api_version=self.raw_json['api_version'] ,
197                             apilib_version=self.raw_json['apilib_version'],
198                             api_timezone=self.raw_json['api_timezone'],
199                             api_timestamp=self.raw_json['api_timestamp'],
200                             oar_version=self.raw_json['oar_version'] )
201         else :
202             self.version_json_dict.update(api_version=self.raw_json['api'] ,
203                             apilib_version=self.raw_json['apilib'],
204                             api_timezone=self.raw_json['api_timezone'],
205                             api_timestamp=self.raw_json['api_timestamp'],
206                             oar_version=self.raw_json['oar'] )
207                                 
208         print self.version_json_dict['apilib_version']
209         
210             
211     def ParseTimezone(self) : 
212         api_timestamp=self.raw_json['api_timestamp']
213         api_tz=self.raw_json['timezone']
214         #readable_time = strftime("%Y-%m-%d %H:%M:%S", gmtime(float(api_timestamp))) 
215
216         return api_timestamp,api_tz
217             
218     def ParseJobs(self) :
219         self.jobs_list = []
220         print " ParseJobs "
221         return self.raw_json
222             
223     def ParseJobsTable(self) : 
224         print "ParseJobsTable"
225                 
226     def ParseJobsDetails (self):
227         # currently, this function is not used a lot, so i have no idea what be usefull to parse, returning the full json. NT
228         print >>sys.stderr,"ParseJobsDetails %s " %(self.raw_json)
229         return self.raw_json
230         
231
232     def ParseJobsIds(self):
233         
234         job_resources =['wanted_resources', 'name','id', 'start_time','state','owner','walltime','message']
235         
236         
237         job_resources_full = ['launching_directory', 'links', 'resubmit_job_id', 'owner', 'events', 'message', 'scheduled_start', 'id', 'array_id',  'exit_code','properties', 'state','array_index', 'walltime', 'type', 'initial_request', 'stop_time', 'project',  'start_time',  'dependencies','api_timestamp','submission_time', 'reservation', 'stdout_file', 'types', 'cpuset_name',  'name',  'wanted_resources','queue','stderr_file','command']
238
239
240         job_info = self.raw_json
241      
242         values=[]
243         try:
244             for k in job_resources:
245                 values.append(job_info[k])
246             return dict(zip(job_resources,values))
247             
248         except KeyError:
249                 print>>sys.stderr, " \r\n \t ParseJobsIds Key Error"
250             
251         
252         
253         
254     def ParseJobsIdResources(self):
255         logger.debug("OARESTAPI ParseJobsIdResources %s" %(self.raw_json))
256         print>>sys.stderr, "ParseJobsIdResources"
257         return self.raw_json
258             
259     def ParseResources(self) :
260         print>>sys.stderr, " \r\n  \t\t\t ParseResources__________________________ " 
261         #resources are listed inside the 'items' list from the json
262         self.raw_json = self.raw_json['items']
263         self.ParseNodes()
264
265     # Returns an array containing the list of the reserved nodes
266     def ParseReservedNodes(self):
267         print>>sys.stderr, " \r\n  \t\t\t ParseReservedNodes__________________________ " 
268         #resources are listed inside the 'items' list from the json
269         nodes=[]
270         for job in  self.raw_json['items']:
271             for node in job['nodes']:
272                 nodes.append(node['network_address'])
273         return nodes
274     
275     def ParseRunningJobs(self): 
276         print>>sys.stderr, " \r\n  \t\t\t ParseRunningJobs__________________________ " 
277         #resources are listed inside the 'items' list from the json
278         nodes = []
279         for job in  self.raw_json['items']:
280             for node in job['nodes']:
281                 nodes.append(node['network_address'])
282         return nodes
283        
284         
285         
286     def ParseDeleteJobs(self):
287         return  
288             
289     def ParseResourcesFull(self ) :
290         print>>sys.stderr, " \r\n \t\t\t  ParseResourcesFull_____________________________ "
291         #print self.raw_json[1]
292         #resources are listed inside the 'items' list from the json
293         if self.version_json_dict['apilib_version'] != "0.2.10" :
294                 self.raw_json = self.raw_json['items']
295         self.ParseNodes()
296         self.ParseSites()
297         return self.node_dictlist
298         
299     def ParseResourcesFullSites(self ) :
300         if self.version_json_dict['apilib_version'] != "0.2.10" :
301                 self.raw_json = self.raw_json['items']
302         self.ParseNodes()
303         self.ParseSites()
304         return self.site_dict
305         
306
307     resources_fulljson_dict= {
308         'network_address' : AddNodeNetworkAddr,
309         'site': AddNodeSite, 
310         'radio': AddNodeRadio,
311         'mobile': AddMobility,
312         'posx': AddPosX,
313         'posy': AddPosY,
314         'state':AddBootState,
315         #'id' : AddNodeId,
316         }
317       
318             
319     #Parse nodes properties from OAR
320     #Put them into a dictionary with key = node id and value is a dictionary 
321     #of the node properties and properties'values.
322     def ParseNodes(self):  
323         node_id = None
324         keys = self.resources_fulljson_dict.keys()
325         keys.sort()
326
327         #print >>sys.stderr, " \r\n \r\n \t\t OARrestapi.py ParseNodes self.raw_json %s" %(self.raw_json)
328         for dictline in self.raw_json:
329             node_id = None 
330             # dictionary is empty and/or a new node has to be inserted 
331             node_id = self.resources_fulljson_dict['network_address'](self,self.node_dictlist, dictline['network_address'])
332             for k in keys:
333                 if k in dictline:
334                     if k == 'network_address':
335                         continue
336                  
337                     
338                     self.resources_fulljson_dict[k](self,self.node_dictlist[node_id], dictline[k])
339             
340             #The last property has been inserted in the property tuple list, reset node_id 
341             #Turn the property tuple list (=dict value) into a dictionary
342             self.node_dictlist[node_id] = dict(self.node_dictlist[node_id])
343             node_id = None
344                     
345                 
346     def hostname_to_hrn(self, root_auth, login_base, hostname):
347         return PlXrn(auth=root_auth,hostname= login_base + '_' + hostname).get_hrn()
348     #Retourne liste de dictionnaires contenant attributs des sites      
349     def ParseSites(self):
350         nodes_per_site = {}
351         config = Config()
352         logger.debug(" OARrestapi.py \t ParseSites  self.node_dictlist %s"%(self.node_dictlist))
353         # Create a list of nodes per  site_id
354         for node_id in self.node_dictlist.keys():
355             node  = self.node_dictlist[node_id]
356             
357             if node['site'] not in nodes_per_site:
358                 nodes_per_site[node['site']] = []
359                 nodes_per_site[node['site']].append(node['node_id'])
360             else:
361                 if node['node_id'] not in nodes_per_site[node['site']]:
362                     nodes_per_site[node['site']].append(node['node_id'])
363                         
364         #Create a site dictionary with key is site_login_base (name of the site)
365         # and value is a dictionary of properties, including the list of the node_ids
366         for node_id in self.node_dictlist.keys():
367             node  = self.node_dictlist[node_id]
368             node.update({'hrn':self.hostname_to_hrn(self.interface_hrn, node['site'],node['hostname'])})
369             #node['hrn'] = self.hostname_to_hrn(self.interface_hrn, node['site_login_base'],node['hostname'])
370             self.node_dictlist.update({node_id:node})
371             #if node_id is 1:
372             if node['site'] not in self.site_dict:
373                 self.site_dict[node['site']] = {'site':node['site'],
374                                                         'node_ids':nodes_per_site[node['site']],
375                                                         'latitude':"48.83726",
376                                                         'longitude':"- 2.10336",'name':config.SFA_REGISTRY_ROOT_AUTH,
377                                                         'pcu_ids':[], 'max_slices':None, 'ext_consortium_id':None,
378                                                         'max_slivers':None, 'is_public':True, 'peer_site_id': None,
379                                                         'abbreviated_name':"senslab", 'address_ids': [],
380                                                         'url':"http,//www.senslab.info", 'person_ids':[],
381                                                         'site_tag_ids':[], 'enabled': True,  'slice_ids':[],
382                                                         'date_created': None, 'peer_id': None }     
383             #if node['site_login_base'] not in self.site_dict.keys():
384                 #self.site_dict[node['site_login_base']] = {'login_base':node['site_login_base'],
385                                                         #'node_ids':nodes_per_site[node['site_login_base']],
386                                                         #'latitude':"48.83726",
387                                                         #'longitude':"- 2.10336",'name':"senslab",
388                                                         #'pcu_ids':[], 'max_slices':None, 'ext_consortium_id':None,
389                                                         #'max_slivers':None, 'is_public':True, 'peer_site_id': None,
390                                                         #'abbreviated_name':"senslab", 'address_ids': [],
391                                                         #'url':"http,//www.senslab.info", 'person_ids':[],
392                                                         #'site_tag_ids':[], 'enabled': True,  'slice_ids':[],
393                                                         #'date_created': None, 'peer_id': None } 
394
395                         
396
397
398     OARrequests_uri_dict = { 
399         'GET_version': {'uri':'/oarapi/version.json', 'parse_func': ParseVersion},
400         'GET_timezone':{'uri':'/oarapi/timezone.json' ,'parse_func': ParseTimezone },
401         'GET_jobs': {'uri':'/oarapi/jobs.json','parse_func': ParseJobs},
402         'GET_jobs_id': {'uri':'/oarapi/jobs/id.json','parse_func': ParseJobsIds},
403         'GET_jobs_id_resources': {'uri':'/oarapi/jobs/id/resources.json','parse_func': ParseJobsIdResources},
404         'GET_jobs_table': {'uri':'/oarapi/jobs/table.json','parse_func': ParseJobsTable},
405         'GET_jobs_details': {'uri':'/oarapi/jobs/details.json','parse_func': ParseJobsDetails},
406         'GET_reserved_nodes':{'uri':'/oarapi/jobs/details.json?state=Running,Waiting,Launching','parse_func':ParseReservedNodes},
407         'GET_running_jobs':  {'uri':'/oarapi/jobs/details.json?state=Running','parse_func':ParseRunningJobs},
408         'GET_resources_full': {'uri':'/oarapi/resources/full.json','parse_func': ParseResourcesFull},
409         'GET_sites':{'uri':'/oarapi/resources/full.json','parse_func': ParseResourcesFullSites},
410         'GET_resources':{'uri':'/oarapi/resources.json' ,'parse_func': ParseResources},
411         'DELETE_jobs_id':{'uri':'/oarapi/jobs/id.json' ,'parse_func': ParseDeleteJobs}
412         }
413
414     
415     def __init__(self, srv ):
416         self.version_json_dict= { 'api_version' : None , 'apilib_version' :None,  'api_timezone': None, 'api_timestamp': None, 'oar_version': None ,}
417         self.config = Config()
418         self.interface_hrn = self.config.SFA_INTERFACE_HRN      
419         self.timezone_json_dict = { 'timezone': None, 'api_timestamp': None, }
420         self.jobs_json_dict = { 'total' : None, 'links' : [] , 'offset':None , 'items' : [] , }
421         self.jobs_table_json_dict = self.jobs_json_dict
422         self.jobs_details_json_dict = self.jobs_json_dict               
423         self.server = srv
424         self.node_dictlist = {}
425
426         self.site_dict = {}
427         self.SendRequest("GET_version")
428
429     def SendRequest(self,request, strval = None , username = None):
430         if request in self.OARrequests_uri_dict :
431             self.raw_json = self.server.GETRequestToOARRestAPI(request,strval,username) 
432             return self.OARrequests_uri_dict[request]['parse_func'](self)
433         else:
434             print>>sys.stderr, "\r\n OARGetParse __init__ : ERROR_REQUEST "     ,request
435             
436
437