2 from httplib import HTTPConnection, HTTPException, NotConnected
5 #from time import gmtime, strftime
10 from sfa.util.config import Config
11 #from sfa.util.xrn import hrn_to_urn, get_authority, Xrn, get_leaf
13 from sfa.util.sfalogging import logger
16 OAR_REQUEST_POST_URI_DICT = {'POST_job':{'uri': '/oarapi/jobs.json'},
17 'DELETE_jobs_id':{'uri':'/oarapi/jobs/id.json'},
20 POST_FORMAT = {'json' : {'content':"application/json", 'object':json},}
22 #OARpostdatareqfields = {'resource' :"/nodes=", 'command':"sleep", \
23 #'workdir':"/home/", 'walltime':""}
28 """Class used to manipulate jsopn pages given by OAR."""
30 #All are boolean variables
31 self.concatenate = False
32 #Indicates end of data, no more pages to be loaded.
34 self.next_page = False
36 self.next_offset = None
40 def FindNextPage(self):
41 """ Gets next data page from OAR when the query's results
42 are too big to be transmitted in a single page.
43 Uses the "links' item in the json returned to check if
44 an additionnal page has to be loaded.
45 Returns : next page , next offset query
47 if "links" in self.raw_json:
48 for page in self.raw_json['links']:
49 if page['rel'] == 'next':
50 self.concatenate = True
52 self.next_offset = "?" + page['href'].split("?")[1]
53 print>>sys.stderr, "\r\n \t FindNextPage NEXT LINK"
58 self.next_page = False
59 self.next_offset = None
63 #Otherwise, no next page and no concatenate, must be a single page
64 #Concatenate the single page and get out of here.
66 self.next_page = False
67 self.concatenate = True
68 self.next_offset = None
72 def ConcatenateJsonPages(saved_json_list):
78 for page in saved_json_list:
79 tmp['items'].extend(page['items'])
83 def ResetNextPage(self):
85 self.next_offset = None
86 self.concatenate = False
91 def __init__(self, config_file = '/etc/sfa/oar_config.py'):
95 self.oarserver['uri'] = None
96 self.oarserver['postformat'] = 'json'
99 execfile(config_file, self.__dict__)
101 self.config_file = config_file
102 # path to configuration data
103 self.config_path = os.path.dirname(config_file)
106 raise IOError, "Could not find or load the configuration file: %s" \
108 #logger.setLevelDebug()
109 self.oarserver['ip'] = self.OAR_IP
110 self.oarserver['port'] = self.OAR_PORT
111 self.jobstates = ['Terminated', 'Hold', 'Waiting', 'toLaunch', \
112 'toError', 'toAckReservation', 'Launching', \
113 'Finishing', 'Running', 'Suspended', 'Resuming',\
116 self.parser = OARGETParser(self)
119 def GETRequestToOARRestAPI(self, request, strval=None, next_page=None, username = None ):
120 self.oarserver['uri'] = \
121 OARGETParser.OARrequests_uri_dict[request]['uri']
122 #Get job details with username
123 if 'owner' in OARGETParser.OARrequests_uri_dict[request] and username:
124 self.oarserver['uri'] += OARGETParser.OARrequests_uri_dict[request]['owner'] + username
126 data = json.dumps({})
127 logger.debug("OARrestapi \tGETRequestToOARRestAPI %s" %(request))
129 self.oarserver['uri'] = self.oarserver['uri'].\
130 replace("id",str(strval))
133 self.oarserver['uri'] += next_page
136 headers['X-REMOTE_IDENT'] = username
138 logger.debug("OARrestapi: \t GETRequestToOARRestAPI \
139 self.oarserver['uri'] %s strval %s" \
140 %(self.oarserver['uri'], strval))
142 #seems that it does not work if we don't add this
143 headers['content-length'] = '0'
145 conn = HTTPConnection(self.oarserver['ip'], \
146 self.oarserver['port'])
147 conn.request("GET", self.oarserver['uri'], data, headers)
148 resp = ( conn.getresponse()).read()
151 except HTTPException, error :
152 logger.log_exc("GET_OAR_SRVR : Problem with OAR server : %s " \
154 #raise ServerError("GET_OAR_SRVR : Could not reach OARserver")
156 js_dict = json.loads(resp)
157 #print "\r\n \t\t\t js_dict keys" , js_dict.keys(), " \r\n", js_dict
160 except ValueError, error:
161 logger.log_exc("Failed to parse Server Response: %s ERROR %s"\
163 #raise ServerError("Failed to parse Server Response:" + js)
166 def POSTRequestToOARRestAPI(self, request, datadict, username=None):
167 """ Used to post a job on OAR , along with data associated
172 #first check that all params for are OK
174 self.oarserver['uri'] = OAR_REQUEST_POST_URI_DICT[request]['uri']
177 logger.log_exc("OARrestapi \tPOSTRequestToOARRestAPI request not \
180 if datadict and 'strval' in datadict:
181 self.oarserver['uri'] = self.oarserver['uri'].replace("id", \
182 str(datadict['strval']))
183 del datadict['strval']
185 data = json.dumps(datadict)
186 headers = {'X-REMOTE_IDENT':username, \
187 'content-type': POST_FORMAT['json']['content'], \
188 'content-length':str(len(data))}
191 conn = HTTPConnection(self.oarserver['ip'], \
192 self.oarserver['port'])
193 conn.request("POST", self.oarserver['uri'], data, headers)
194 resp = (conn.getresponse()).read()
197 logger.log_exc("POSTRequestToOARRestAPI NotConnected ERROR: \
198 data %s \r\n \t\n \t\t headers %s uri %s" \
199 %(data,headers,self.oarserver['uri']))
201 #raise ServerError("POST_OAR_SRVR : error")
204 answer = json.loads(resp)
205 logger.debug("POSTRequestToOARRestAPI : answer %s" %(answer))
208 except ValueError, error:
209 logger.log_exc("Failed to parse Server Response: error %s \
211 #raise ServerError("Failed to parse Server Response:" + answer)
215 def AddOarNodeId(tuplelist, value):
216 """ Adds Oar internal node id to the nodes attributes """
218 tuplelist.append(('oar_id', int(value)))
221 def AddNodeNetworkAddr(dictnode, value):
222 #Inserts new key. The value associated is a tuple list
225 dictnode[node_id] = [('node_id', node_id),('hostname', node_id) ]
229 def AddNodeSite(tuplelist, value):
230 tuplelist.append(('site', str(value)))
232 def AddNodeRadio(tuplelist, value):
233 tuplelist.append(('radio', str(value)))
236 def AddMobility(tuplelist, value):
238 tuplelist.append(('mobile', 'False'))
240 tuplelist.append(('mobile', 'True'))
242 def AddPosX(tuplelist, value):
243 tuplelist.append(('posx', value))
245 def AddPosY(tuplelist, value):
246 tuplelist.append(('posy', value))
248 def AddPosZ(tuplelist, value):
249 tuplelist.append(('posz', value))
251 def AddBootState(tuplelist, value):
252 tuplelist.append(('boot_state', str(value)))
254 #Insert a new node into the dictnode dictionary
255 def AddNodeId(dictnode, value):
256 #Inserts new key. The value associated is a tuple list
259 dictnode[node_id] = [('node_id', node_id)]
262 def AddHardwareType(tuplelist, value):
263 value_list = value.split(':')
264 tuplelist.append(('archi', value_list[0]))
265 tuplelist.append(('radio', value_list[1]))
269 resources_fulljson_dict = {
270 'network_address' : AddNodeNetworkAddr,
272 'radio': AddNodeRadio,
273 'mobile': AddMobility,
277 'archi':AddHardwareType,
278 'state':AddBootState,
283 def __init__(self, srv) :
284 self.version_json_dict = {
285 'api_version' : None , 'apilib_version' :None,\
286 'api_timezone': None, 'api_timestamp': None, 'oar_version': None ,}
287 self.config = Config()
288 self.interface_hrn = self.config.SFA_INTERFACE_HRN
289 self.timezone_json_dict = {
290 'timezone': None, 'api_timestamp': None, }
291 #self.jobs_json_dict = {
292 #'total' : None, 'links' : [],\
293 #'offset':None , 'items' : [], }
294 #self.jobs_table_json_dict = self.jobs_json_dict
295 #self.jobs_details_json_dict = self.jobs_json_dict
297 self.node_dictlist = {}
299 self.json_page = JsonPage()
302 self.SendRequest("GET_version")
308 def ParseVersion(self) :
309 #print self.json_page.raw_json
310 #print >>sys.stderr, self.json_page.raw_json
311 if 'oar_version' in self.json_page.raw_json :
312 self.version_json_dict.update(api_version = \
313 self.json_page.raw_json['api_version'],
314 apilib_version = self.json_page.raw_json['apilib_version'],
315 api_timezone = self.json_page.raw_json['api_timezone'],
316 api_timestamp = self.json_page.raw_json['api_timestamp'],
317 oar_version = self.json_page.raw_json['oar_version'] )
319 self.version_json_dict.update(api_version = \
320 self.json_page.raw_json['api'] ,
321 apilib_version = self.json_page.raw_json['apilib'],
322 api_timezone = self.json_page.raw_json['api_timezone'],
323 api_timestamp = self.json_page.raw_json['api_timestamp'],
324 oar_version = self.json_page.raw_json['oar'] )
326 print self.version_json_dict['apilib_version']
329 def ParseTimezone(self) :
330 api_timestamp = self.json_page.raw_json['api_timestamp']
331 api_tz = self.json_page.raw_json['timezone']
332 return api_timestamp, api_tz
334 def ParseJobs(self) :
337 return self.json_page.raw_json
339 def ParseJobsTable(self) :
340 print "ParseJobsTable"
342 def ParseJobsDetails (self):
343 # currently, this function is not used a lot,
344 #so i have no idea what be usefull to parse,
345 #returning the full json. NT
346 #logger.debug("ParseJobsDetails %s " %(self.json_page.raw_json))
347 return self.json_page.raw_json
350 def ParseJobsIds(self):
352 job_resources = ['wanted_resources', 'name', 'id', 'start_time', \
353 'state','owner','walltime','message']
356 job_resources_full = ['launching_directory', 'links', \
357 'resubmit_job_id', 'owner', 'events', 'message', \
358 'scheduled_start', 'id', 'array_id', 'exit_code', \
359 'properties', 'state','array_index', 'walltime', \
360 'type', 'initial_request', 'stop_time', 'project',\
361 'start_time', 'dependencies','api_timestamp','submission_time', \
362 'reservation', 'stdout_file', 'types', 'cpuset_name', \
363 'name', 'wanted_resources','queue','stderr_file','command']
366 job_info = self.json_page.raw_json
367 #logger.debug("OARESTAPI ParseJobsIds %s" %(self.json_page.raw_json))
370 for k in job_resources:
371 values.append(job_info[k])
372 return dict(zip(job_resources, values))
375 logger.log_exc("ParseJobsIds KeyError ")
378 def ParseJobsIdResources(self):
379 """ Parses the json produced by the request
380 /oarapi/jobs/id/resources.json.
381 Returns a list of oar node ids that are scheduled for the
386 for resource in self.json_page.raw_json['items']:
387 job_resources.append(resource['id'])
389 #logger.debug("OARESTAPI \tParseJobsIdResources %s" %(self.json_page.raw_json))
392 def ParseResources(self) :
393 """ Parses the json produced by a get_resources request on oar."""
395 #logger.debug("OARESTAPI \tParseResources " )
396 #resources are listed inside the 'items' list from the json
397 self.json_page.raw_json = self.json_page.raw_json['items']
400 def ParseReservedNodes(self):
401 """ Returns an array containing the list of the reserved nodes """
403 #resources are listed inside the 'items' list from the json
404 reservation_list = []
406 #Parse resources info
407 for json_element in self.json_page.raw_json['items']:
408 #In case it is a real reservation (not asap case)
409 if json_element['scheduled_start']:
410 job['t_from'] = json_element['scheduled_start']
411 job['t_until'] = int(json_element['scheduled_start']) + \
412 int(json_element['walltime'])
413 #Get resources id list for the job
414 job['resource_ids'] = \
415 [ node_dict['id'] for node_dict in json_element['resources']]
417 job['t_from'] = "As soon as possible"
418 job['t_until'] = "As soon as possible"
419 job['resource_ids'] = ["Undefined"]
422 job['state'] = json_element['state']
423 job['lease_id'] = json_element['id']
426 job['user'] = json_element['owner']
427 #logger.debug("OARRestapi \tParseReservedNodes job %s" %(job))
428 reservation_list.append(job)
431 return reservation_list
433 def ParseRunningJobs(self):
434 """ Gets the list of nodes currently in use from the attributes of the
438 logger.debug("OARESTAPI \tParseRunningJobs__________________________ ")
439 #resources are listed inside the 'items' list from the json
441 for job in self.json_page.raw_json['items']:
442 for node in job['nodes']:
443 nodes.append(node['network_address'])
448 def ParseDeleteJobs(self):
449 """ No need to parse anything in this function.A POST
450 is done to delete the job.
455 def ParseResourcesFull(self) :
456 """ This method is responsible for parsing all the attributes
457 of all the nodes returned by OAR when issuing a get resources full.
458 The information from the nodes and the sites are separated.
459 Updates the node_dictlist so that the dictionnary of the platform's
460 nodes is available afterwards.
463 logger.debug("OARRESTAPI ParseResourcesFull________________________ ")
464 #print self.json_page.raw_json[1]
465 #resources are listed inside the 'items' list from the json
466 if self.version_json_dict['apilib_version'] != "0.2.10" :
467 self.json_page.raw_json = self.json_page.raw_json['items']
470 return self.node_dictlist
472 def ParseResourcesFullSites(self) :
473 """ UNUSED. Originally used to get information from the sites.
474 ParseResourcesFull is used instead.
477 if self.version_json_dict['apilib_version'] != "0.2.10" :
478 self.json_page.raw_json = self.json_page.raw_json['items']
481 return self.site_dict
485 def ParseNodes(self):
486 """ Parse nodes properties from OAR
487 Put them into a dictionary with key = node id and value is a dictionary
488 of the node properties and properties'values.
492 keys = self.resources_fulljson_dict.keys()
495 for dictline in self.json_page.raw_json:
497 # dictionary is empty and/or a new node has to be inserted
498 node_id = self.resources_fulljson_dict['network_address'](\
499 self.node_dictlist, dictline['network_address'])
502 if k == 'network_address':
505 self.resources_fulljson_dict[k](\
506 self.node_dictlist[node_id], dictline[k])
508 #The last property has been inserted in the property tuple list,
510 #Turn the property tuple list (=dict value) into a dictionary
511 self.node_dictlist[node_id] = dict(self.node_dictlist[node_id])
515 def slab_hostname_to_hrn( root_auth, hostname):
516 return root_auth + '.'+ hostname
520 def ParseSites(self):
521 """ Returns a list of dictionnaries containing the sites' attributes."""
525 #logger.debug(" OARrestapi.py \tParseSites self.node_dictlist %s"\
526 #%(self.node_dictlist))
527 # Create a list of nodes per site_id
528 for node_id in self.node_dictlist:
529 node = self.node_dictlist[node_id]
531 if node['site'] not in nodes_per_site:
532 nodes_per_site[node['site']] = []
533 nodes_per_site[node['site']].append(node['node_id'])
535 if node['node_id'] not in nodes_per_site[node['site']]:
536 nodes_per_site[node['site']].append(node['node_id'])
538 #Create a site dictionary whose key is site_login_base (name of the site)
539 # and value is a dictionary of properties, including the list
541 for node_id in self.node_dictlist:
542 node = self.node_dictlist[node_id]
543 #node.update({'hrn':self.slab_hostname_to_hrn(self.interface_hrn, \
544 #node['site'],node['hostname'])})
545 node.update({'hrn':self.slab_hostname_to_hrn(self.interface_hrn, node['hostname'])})
546 self.node_dictlist.update({node_id:node})
548 if node['site'] not in self.site_dict:
549 self.site_dict[node['site']] = {
551 'node_ids':nodes_per_site[node['site']],
552 'latitude':"48.83726",
553 'longitude':"- 2.10336",'name':config.SFA_REGISTRY_ROOT_AUTH,
554 'pcu_ids':[], 'max_slices':None, 'ext_consortium_id':None,
555 'max_slivers':None, 'is_public':True, 'peer_site_id': None,
556 'abbreviated_name':"senslab", 'address_ids': [],
557 'url':"http,//www.senslab.info", 'person_ids':[],
558 'site_tag_ids':[], 'enabled': True, 'slice_ids':[],
559 'date_created': None, 'peer_id': None }
560 #if node['site_login_base'] not in self.site_dict.keys():
561 #self.site_dict[node['site_login_base']] = {'login_base':node['site_login_base'],
562 #'node_ids':nodes_per_site[node['site_login_base']],
563 #'latitude':"48.83726",
564 #'longitude':"- 2.10336",'name':"senslab",
565 #'pcu_ids':[], 'max_slices':None, 'ext_consortium_id':None,
566 #'max_slivers':None, 'is_public':True, 'peer_site_id': None,
567 #'abbreviated_name':"senslab", 'address_ids': [],
568 #'url':"http,//www.senslab.info", 'person_ids':[],
569 #'site_tag_ids':[], 'enabled': True, 'slice_ids':[],
570 #'date_created': None, 'peer_id': None }
575 OARrequests_uri_dict = {
577 {'uri':'/oarapi/version.json', 'parse_func': ParseVersion},
579 {'uri':'/oarapi/timezone.json' ,'parse_func': ParseTimezone },
581 {'uri':'/oarapi/jobs.json','parse_func': ParseJobs},
583 {'uri':'/oarapi/jobs/id.json','parse_func': ParseJobsIds},
584 'GET_jobs_id_resources':
585 {'uri':'/oarapi/jobs/id/resources.json',\
586 'parse_func': ParseJobsIdResources},
588 {'uri':'/oarapi/jobs/table.json','parse_func': ParseJobsTable},
590 {'uri':'/oarapi/jobs/details.json',\
591 'parse_func': ParseJobsDetails},
592 'GET_reserved_nodes':
594 '/oarapi/jobs/details.json?state=Running,Waiting,Launching',\
596 'parse_func':ParseReservedNodes},
600 {'uri':'/oarapi/jobs/details.json?state=Running',\
601 'parse_func':ParseRunningJobs},
602 'GET_resources_full':
603 {'uri':'/oarapi/resources/full.json',\
604 'parse_func': ParseResourcesFull},
606 {'uri':'/oarapi/resources/full.json',\
607 'parse_func': ParseResourcesFullSites},
609 {'uri':'/oarapi/resources.json' ,'parse_func': ParseResources},
611 {'uri':'/oarapi/jobs/id.json' ,'parse_func': ParseDeleteJobs}
617 def SendRequest(self, request, strval = None , username = None):
618 """ Connects to OAR , sends the valid GET requests and uses
619 the appropriate json parsing functions.
624 self.json_page.ResetNextPage()
627 if request in self.OARrequests_uri_dict :
628 while self.json_page.next_page:
629 self.json_page.raw_json = self.server.GETRequestToOARRestAPI(\
632 self.json_page.next_offset, \
634 self.json_page.FindNextPage()
635 if self.json_page.concatenate:
636 save_json.append(self.json_page.raw_json)
638 if self.json_page.concatenate and self.json_page.end :
639 self.json_page.raw_json = \
640 self.json_page.ConcatenateJsonPages(save_json)
642 return self.OARrequests_uri_dict[request]['parse_func'](self)
644 logger.error("OARRESTAPI OARGetParse __init__ : ERROR_REQUEST " \