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