sfa/senslab/OARrestapi.py

   1 #import sys
   2 from httplib import HTTPConnection, HTTPException
   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.util.xrn import hrn_to_urn, get_authority, Xrn, get_leaf
  11
  12 from sfa.util.sfalogging import logger
  13
  14
  15 OARIP = '194.199.16.161'
  16
  17 OAR_REQUEST_POST_URI_DICT = {'POST_job':{'uri': '/oarapi/jobs.json'},
  18                             'DELETE_jobs_id':{'uri':'/oarapi/jobs/id.json'},
  19                             }
  20
  21 POST_FORMAT = {'json' : {'content':"application/json", 'object':json},}
  22
  23 #OARpostdatareqfields = {'resource' :"/nodes=", 'command':"sleep", \
  24                         #'workdir':"/home/", 'walltime':""}
  25
  26
  27
  28
  29
  30 class OARrestapi:
  31     def __init__(self):
  32         self.oarserver = {}
  33         self.oarserver['ip'] = OARIP
  34         self.oarserver['port'] = 8800
  35         self.oarserver['uri'] = None
  36         self.oarserver['postformat'] = 'json'
  37         #logger.setLevelDebug()
  38
  39         self.jobstates  = ['Terminated', 'Hold', 'Waiting', 'toLaunch', \
  40                             'toError', 'toAckReservation', 'Launching', \
  41                             'Finishing', 'Running', 'Suspended', 'Resuming',\
  42                             'Error']
  43
  44         self.parser = OARGETParser(self)
  45
  46
  47     def GETRequestToOARRestAPI(self, request, strval=None , username = None ):
  48         self.oarserver['uri'] = \
  49                             OARGETParser.OARrequests_uri_dict[request]['uri']
  50         headers = {}
  51         data = json.dumps({})
  52         logger.debug("OARrestapi \tGETRequestToOARRestAPI %s" %(request))
  53         if strval:
  54             self.oarserver['uri'] = self.oarserver['uri'].\
  55                                             replace("id",str(strval))
  56             logger.debug("OARrestapi: \t  GETRequestToOARRestAPI  \
  57                             self.oarserver['uri'] %s strval %s" \
  58                             %(self.oarserver['uri'], strval))
  59         if username:
  60             headers['X-REMOTE_IDENT'] = username
  61         try :
  62             #seems that it does not work if we don't add this
  63             headers['content-length'] = '0'
  64
  65             conn = HTTPConnection(self.oarserver['ip'], \
  66                                                 self.oarserver['port'])
  67             conn.request("GET", self.oarserver['uri'], data, headers)
  68             resp = ( conn.getresponse()).read()
  69             conn.close()
  70         except HTTPException, error :
  71             logger.log_exc("GET_OAR_SRVR : Problem with OAR server : %s " \
  72                                                                     %(error))
  73             #raise ServerError("GET_OAR_SRVR : Could not reach OARserver")
  74         try:
  75             js_dict = json.loads(resp)
  76             return js_dict
  77
  78         except ValueError, error:
  79             logger.log_exc("Failed to parse Server Response: %s ERROR %s"\
  80                                                             %(js_dict, error))
  81             #raise ServerError("Failed to parse Server Response:" + js)
  82
  83
  84     def POSTRequestToOARRestAPI(self, request, datadict, username=None):
  85         """ Used to post a job on OAR , along with data associated
  86         with the job.
  87
  88         """
  89
  90         #first check that all params for are OK
  91         try:
  92             self.oarserver['uri'] = OAR_REQUEST_POST_URI_DICT[request]['uri']
  93
  94         except KeyError:
  95             logger.log_exc("OARrestapi \tPOSTRequestToOARRestAPI request not \
  96                              valid")
  97             return
  98         if datadict and 'strval' in datadict:
  99             self.oarserver['uri'] = self.oarserver['uri'].replace("id", \
 100                                                 str(datadict['strval']))
 101             del datadict['strval']
 102
 103         data = json.dumps(datadict)
 104         headers = {'X-REMOTE_IDENT':username, \
 105                 'content-type': POST_FORMAT['json']['content'], \
 106                 'content-length':str(len(data))}
 107         try :
 108
 109             conn = HTTPConnection(self.oarserver['ip'], \
 110                                         self.oarserver['port'])
 111             conn.request("POST", self.oarserver['uri'], data, headers)
 112             resp = (conn.getresponse()).read()
 113             conn.close()
 114         except NotConnected:
 115             logger.log_exc("POSTRequestToOARRestAPI NotConnected ERROR: \
 116                             data %s \r\n \t\n \t\t headers %s uri %s" \
 117                             %(data,headers,self.oarserver['uri']))
 118
 119             #raise ServerError("POST_OAR_SRVR : error")
 120
 121         try:
 122             answer = json.loads(resp)
 123             logger.debug("POSTRequestToOARRestAPI : answer %s" %(answer))
 124             return answer
 125
 126         except ValueError, error:
 127             logger.log_exc("Failed to parse Server Response: error %s answer \
 128                             %s" %(error, answer))
 129             #raise ServerError("Failed to parse Server Response:" + answer)
 130
 131
 132
 133 def AddOarNodeId(tuplelist, value):
 134     """ Adds Oar internal node id to the nodes attributes """
 135
 136     tuplelist.append(('oar_id', int(value)))
 137
 138
 139 def AddNodeNetworkAddr(dictnode, value):
 140     #Inserts new key. The value associated is a tuple list
 141     node_id = value
 142
 143     dictnode[node_id] = [('node_id', node_id),('hostname', node_id) ]
 144
 145     return node_id
 146
 147 def AddNodeSite(tuplelist, value):
 148     tuplelist.append(('site', str(value)))
 149
 150 def AddNodeRadio(tuplelist, value):
 151     tuplelist.append(('radio', str(value)))
 152
 153
 154 def AddMobility(tuplelist, value):
 155     if value is 0:
 156         tuplelist.append(('mobile', 'False'))
 157     else :
 158         tuplelist.append(('mobile', 'True'))
 159
 160 def AddPosX(tuplelist, value):
 161     tuplelist.append(('posx', value))
 162
 163 def AddPosY(tuplelist, value):
 164     tuplelist.append(('posy', value))
 165
 166 def AddPosZ(tuplelist, value):
 167     tuplelist.append(('posz', value))
 168
 169 def AddBootState(tuplelist, value):
 170     tuplelist.append(('boot_state', str(value)))
 171
 172 #Insert a new node into the dictnode dictionary
 173 def AddNodeId(dictnode, value):
 174     #Inserts new key. The value associated is a tuple list
 175     node_id = int(value)
 176
 177     dictnode[node_id] = [('node_id', node_id)]
 178     return node_id
 179
 180 def AddHardwareType(tuplelist, value):
 181     value_list = value.split(':')
 182     tuplelist.append(('archi', value_list[0]))
 183     tuplelist.append(('radio', value_list[1]))
 184
 185
 186 class OARGETParser:
 187     resources_fulljson_dict = {
 188         'network_address' : AddNodeNetworkAddr,
 189         'site': AddNodeSite,
 190         'radio': AddNodeRadio,
 191         'mobile': AddMobility,
 192         'x': AddPosX,
 193         'y': AddPosY,
 194         'z':AddPosZ,
 195         'archi':AddHardwareType,
 196         'state':AddBootState,
 197         'id' : AddOarNodeId,
 198         }
 199
 200
 201     def __init__(self, srv) :
 202         self.version_json_dict = {
 203             'api_version' : None , 'apilib_version' :None,\
 204             'api_timezone': None, 'api_timestamp': None, 'oar_version': None ,}
 205         self.config = Config()
 206         self.interface_hrn = self.config.SFA_INTERFACE_HRN
 207         self.timezone_json_dict = {
 208             'timezone': None, 'api_timestamp': None, }
 209         self.jobs_json_dict = {
 210             'total' : None, 'links' : [],\
 211             'offset':None , 'items' : [], }
 212         self.jobs_table_json_dict = self.jobs_json_dict
 213         self.jobs_details_json_dict = self.jobs_json_dict
 214         self.server = srv
 215         self.node_dictlist = {}
 216         self.raw_json = None
 217         self.site_dict = {}
 218         self.SendRequest("GET_version")
 219
 220
 221
 222
 223
 224     def ParseVersion(self) :
 225         #print self.raw_json
 226         #print >>sys.stderr, self.raw_json
 227         if 'oar_version' in self.raw_json :
 228             self.version_json_dict.update(api_version = \
 229                                                 self.raw_json['api_version'],
 230                             apilib_version = self.raw_json['apilib_version'],
 231                             api_timezone = self.raw_json['api_timezone'],
 232                             api_timestamp = self.raw_json['api_timestamp'],
 233                             oar_version = self.raw_json['oar_version'] )
 234         else :
 235             self.version_json_dict.update(api_version = self.raw_json['api'] ,
 236                             apilib_version = self.raw_json['apilib'],
 237                             api_timezone = self.raw_json['api_timezone'],
 238                             api_timestamp = self.raw_json['api_timestamp'],
 239                             oar_version = self.raw_json['oar'] )
 240
 241         print self.version_json_dict['apilib_version']
 242
 243
 244     def ParseTimezone(self) :
 245         api_timestamp = self.raw_json['api_timestamp']
 246         api_tz = self.raw_json['timezone']
 247         return api_timestamp, api_tz
 248
 249     def ParseJobs(self) :
 250         self.jobs_list = []
 251         print " ParseJobs "
 252         return self.raw_json
 253
 254     def ParseJobsTable(self) :
 255         print "ParseJobsTable"
 256
 257     def ParseJobsDetails (self):
 258         # currently, this function is not used a lot,
 259         #so i have no idea what be usefull to parse,
 260         #returning the full json. NT
 261         #logger.debug("ParseJobsDetails %s " %(self.raw_json))
 262         return self.raw_json
 263
 264
 265     def ParseJobsIds(self):
 266
 267         job_resources = ['wanted_resources', 'name', 'id', 'start_time', \
 268                         'state','owner','walltime','message']
 269
 270
 271         job_resources_full = ['launching_directory', 'links', \
 272             'resubmit_job_id', 'owner', 'events', 'message', \
 273             'scheduled_start', 'id', 'array_id',  'exit_code', \
 274             'properties', 'state','array_index', 'walltime', \
 275             'type', 'initial_request', 'stop_time', 'project',\
 276             'start_time',  'dependencies','api_timestamp','submission_time', \
 277             'reservation', 'stdout_file', 'types', 'cpuset_name', \
 278             'name',  'wanted_resources','queue','stderr_file','command']
 279
 280
 281         job_info = self.raw_json
 282         #logger.debug("OARESTAPI ParseJobsIds %s" %(self.raw_json))
 283         values = []
 284         try:
 285             for k in job_resources:
 286                 values.append(job_info[k])
 287             return dict(zip(job_resources, values))
 288
 289         except KeyError:
 290             logger.log_exc("ParseJobsIds KeyError ")
 291
 292
 293     def ParseJobsIdResources(self):
 294         """ Parses the json produced by the request
 295         /oarapi/jobs/id/resources.json.
 296         Returns a list of oar node ids that are scheduled for the
 297         given job id.
 298
 299         """
 300         job_resources = []
 301         for resource in self.raw_json['items']:
 302             job_resources.append(resource['id'])
 303
 304         #logger.debug("OARESTAPI \tParseJobsIdResources %s" %(self.raw_json))
 305         return job_resources
 306
 307     def ParseResources(self) :
 308         """ Parses the json produced by a get_resources request on oar."""
 309
 310         #logger.debug("OARESTAPI \tParseResources " )
 311         #resources are listed inside the 'items' list from the json
 312         self.raw_json = self.raw_json['items']
 313         self.ParseNodes()
 314
 315     def ParseReservedNodes(self):
 316         """  Returns an array containing the list of the reserved nodes """
 317
 318         #resources are listed inside the 'items' list from the json
 319         reservation_list = []
 320         print "ParseReservedNodes_%s" %(self.raw_json['items'])
 321         job = {}
 322         #Parse resources info
 323         for json_element in  self.raw_json['items']:
 324             #In case it is a real reservation (not asap case)
 325             if json_element['scheduled_start']:
 326                 job['t_from'] = json_element['scheduled_start']
 327                 job['t_until'] = int(json_element['scheduled_start']) + \
 328                                                        int(json_element['walltime'])
 329                 #Get resources id list for the job
 330                 job['resource_ids'] = \
 331                     [ node_dict['id'] for node_dict in json_element['resources'] ]
 332             else:
 333                 job['t_from'] = "As soon as possible"
 334                 job['t_until'] = "As soon as possible"
 335                 job['resource_ids'] = ["Undefined"]
 336
 337
 338             job['state'] = json_element['state']
 339             job['lease_id'] = json_element['id']
 340
 341
 342             job['user'] = json_element['owner']
 343             #logger.debug("OARRestapi \tParseReservedNodes job %s" %(job))
 344             reservation_list.append(job)
 345             #reset dict
 346             job = {}
 347         return reservation_list
 348
 349     def ParseRunningJobs(self):
 350         """ Gets the list of nodes currently in use from the attributes of the
 351         running jobs.
 352
 353         """
 354         logger.debug("OARESTAPI \tParseRunningJobs__________________________ ")
 355         #resources are listed inside the 'items' list from the json
 356         nodes = []
 357         for job in  self.raw_json['items']:
 358             for node in job['nodes']:
 359                 nodes.append(node['network_address'])
 360         return nodes
 361
 362
 363
 364     def ParseDeleteJobs(self):
 365         """ No need to parse anything in this function.A POST
 366         is done to delete the job.
 367
 368         """
 369         return
 370
 371     def ParseResourcesFull(self) :
 372         """ This method is responsible for parsing all the attributes
 373         of all the nodes returned by OAR when issuing a get resources full.
 374         The information from the nodes and the sites are separated.
 375         Updates the node_dictlist so that the dictionnary of the platform's
 376         nodes is available afterwards.
 377
 378         """
 379         logger.debug("OARRESTAPI ParseResourcesFull________________________ ")
 380         #print self.raw_json[1]
 381         #resources are listed inside the 'items' list from the json
 382         if self.version_json_dict['apilib_version'] != "0.2.10" :
 383             self.raw_json = self.raw_json['items']
 384         self.ParseNodes()
 385         self.ParseSites()
 386         return self.node_dictlist
 387
 388     def ParseResourcesFullSites(self) :
 389         """ UNUSED. Originally used to get information from the sites.
 390         ParseResourcesFull is used instead.
 391
 392         """
 393         if self.version_json_dict['apilib_version'] != "0.2.10" :
 394             self.raw_json = self.raw_json['items']
 395         self.ParseNodes()
 396         self.ParseSites()
 397         return self.site_dict
 398
 399
 400
 401     def ParseNodes(self):
 402         """ Parse nodes properties from OAR
 403         Put them into a dictionary with key = node id and value is a dictionary
 404         of the node properties and properties'values.
 405
 406         """
 407         node_id = None
 408         keys = self.resources_fulljson_dict.keys()
 409         keys.sort()
 410
 411         for dictline in self.raw_json:
 412             node_id = None
 413             # dictionary is empty and/or a new node has to be inserted
 414             node_id = self.resources_fulljson_dict['network_address'](\
 415                                 self.node_dictlist, dictline['network_address'])
 416             for k in keys:
 417                 if k in dictline:
 418                     if k == 'network_address':
 419                         continue
 420
 421                     self.resources_fulljson_dict[k](\
 422                                     self.node_dictlist[node_id], dictline[k])
 423
 424             #The last property has been inserted in the property tuple list,
 425             #reset node_id
 426             #Turn the property tuple list (=dict value) into a dictionary
 427             self.node_dictlist[node_id] = dict(self.node_dictlist[node_id])
 428             node_id = None
 429
 430     def slab_hostname_to_hrn(self, root_auth,  hostname):
 431         return root_auth + '.'+ hostname
 432
 433
 434
 435     def ParseSites(self):
 436         """ Returns a list of dictionnaries containing the sites' attributes."""
 437
 438         nodes_per_site = {}
 439         config = Config()
 440         #logger.debug(" OARrestapi.py \tParseSites  self.node_dictlist %s"\
 441                                                         #%(self.node_dictlist))
 442         # Create a list of nodes per site_id
 443         for node_id in self.node_dictlist:
 444             node  = self.node_dictlist[node_id]
 445
 446             if node['site'] not in nodes_per_site:
 447                 nodes_per_site[node['site']] = []
 448                 nodes_per_site[node['site']].append(node['node_id'])
 449             else:
 450                 if node['node_id'] not in nodes_per_site[node['site']]:
 451                     nodes_per_site[node['site']].append(node['node_id'])
 452
 453         #Create a site dictionary whose key is site_login_base (name of the site)
 454         # and value is a dictionary of properties, including the list
 455         #of the node_ids
 456         for node_id in self.node_dictlist:
 457             node  = self.node_dictlist[node_id]
 458             #node.update({'hrn':self.slab_hostname_to_hrn(self.interface_hrn, \
 459                                             #node['site'],node['hostname'])})
 460             node.update({'hrn':self.slab_hostname_to_hrn(self.interface_hrn, node['hostname'])})
 461             self.node_dictlist.update({node_id:node})
 462
 463             if node['site'] not in self.site_dict:
 464                 self.site_dict[node['site']] = {
 465                     'site':node['site'],
 466                     'node_ids':nodes_per_site[node['site']],
 467                     'latitude':"48.83726",
 468                     'longitude':"- 2.10336",'name':config.SFA_REGISTRY_ROOT_AUTH,
 469                     'pcu_ids':[], 'max_slices':None, 'ext_consortium_id':None,
 470                     'max_slivers':None, 'is_public':True, 'peer_site_id': None,
 471                     'abbreviated_name':"senslab", 'address_ids': [],
 472                     'url':"http,//www.senslab.info", 'person_ids':[],
 473                     'site_tag_ids':[], 'enabled': True,  'slice_ids':[],
 474                     'date_created': None, 'peer_id': None }
 475             #if node['site_login_base'] not in self.site_dict.keys():
 476                 #self.site_dict[node['site_login_base']] = {'login_base':node['site_login_base'],
 477                                                         #'node_ids':nodes_per_site[node['site_login_base']],
 478                                                         #'latitude':"48.83726",
 479                                                         #'longitude':"- 2.10336",'name':"senslab",
 480                                                         #'pcu_ids':[], 'max_slices':None, 'ext_consortium_id':None,
 481                                                         #'max_slivers':None, 'is_public':True, 'peer_site_id': None,
 482                                                         #'abbreviated_name':"senslab", 'address_ids': [],
 483                                                         #'url':"http,//www.senslab.info", 'person_ids':[],
 484                                                         #'site_tag_ids':[], 'enabled': True,  'slice_ids':[],
 485                                                         #'date_created': None, 'peer_id': None }
 486
 487
 488
 489
 490     OARrequests_uri_dict = {
 491         'GET_version':
 492                 {'uri':'/oarapi/version.json', 'parse_func': ParseVersion},
 493         'GET_timezone':
 494                 {'uri':'/oarapi/timezone.json' ,'parse_func': ParseTimezone },
 495         'GET_jobs':
 496                 {'uri':'/oarapi/jobs.json','parse_func': ParseJobs},
 497         'GET_jobs_id':
 498                 {'uri':'/oarapi/jobs/id.json','parse_func': ParseJobsIds},
 499         'GET_jobs_id_resources':
 500                 {'uri':'/oarapi/jobs/id/resources.json',\
 501                 'parse_func': ParseJobsIdResources},
 502         'GET_jobs_table':
 503                 {'uri':'/oarapi/jobs/table.json','parse_func': ParseJobsTable},
 504         'GET_jobs_details':
 505                 {'uri':'/oarapi/jobs/details.json',\
 506                 'parse_func': ParseJobsDetails},
 507         'GET_reserved_nodes':
 508                 {'uri':
 509                 '/oarapi/jobs/details.json?state=Running,Waiting,Launching',\
 510                 'parse_func':ParseReservedNodes},
 511         'GET_running_jobs':
 512                 {'uri':'/oarapi/jobs/details.json?state=Running',\
 513                 'parse_func':ParseRunningJobs},
 514         'GET_resources_full':
 515                 {'uri':'/oarapi/resources/full.json',\
 516                 'parse_func': ParseResourcesFull},
 517         'GET_sites':
 518                 {'uri':'/oarapi/resources/full.json',\
 519                 'parse_func': ParseResourcesFullSites},
 520         'GET_resources':
 521                 {'uri':'/oarapi/resources.json' ,'parse_func': ParseResources},
 522         'DELETE_jobs_id':
 523                 {'uri':'/oarapi/jobs/id.json' ,'parse_func': ParseDeleteJobs}
 524         }
 525
 526
 527
 528     def SendRequest(self, request, strval = None , username = None):
 529         """ Connects to OAR , sends the valid GET requests and uses
 530         the appropriate json parsing functions.
 531
 532         """
 533         if request in self.OARrequests_uri_dict :
 534             self.raw_json = self.server.GETRequestToOARRestAPI(request, \
 535                                                                 strval, \
 536                                                                 username)
 537             return self.OARrequests_uri_dict[request]['parse_func'](self)
 538         else:
 539             logger.error("OARRESTAPI OARGetParse __init__ : ERROR_REQUEST " \
 540                                                                  %(request))
 541