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