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 :
 161         tuplelist.append(('mobile', int(value)))
 162
 163 def AddPosX(tuplelist, value):
 164     tuplelist.append(('posx', value))
 165
 166
 167 def AddPosY(tuplelist, value):
 168     tuplelist.append(('posy', value))
 169
 170 def AddBootState(tuplelist, value):
 171     tuplelist.append(('boot_state', str(value)))
 172
 173 #Insert a new node into the dictnode dictionary
 174 def AddNodeId(dictnode, value):
 175     #Inserts new key. The value associated is a tuple list
 176     node_id = int(value)
 177
 178     dictnode[node_id] = [('node_id', node_id)]
 179     return node_id
 180
 181
 182
 183 class OARGETParser:
 184
 185
 186     resources_fulljson_dict = {
 187         'network_address' : AddNodeNetworkAddr,
 188         'site': AddNodeSite,
 189         'radio': AddNodeRadio,
 190         'mobile': AddMobility,
 191         'posx': AddPosX,
 192         'posy': AddPosY,
 193         'state':AddBootState,
 194         'id' : AddOarNodeId,
 195         }
 196
 197
 198     def __init__(self, srv) :
 199         self.version_json_dict = {
 200             'api_version' : None , 'apilib_version' :None,\
 201             'api_timezone': None, 'api_timestamp': None, 'oar_version': None ,}
 202         self.config = Config()
 203         self.interface_hrn = self.config.SFA_INTERFACE_HRN
 204         self.timezone_json_dict = {
 205             'timezone': None, 'api_timestamp': None, }
 206         self.jobs_json_dict = {
 207             'total' : None, 'links' : [],\
 208             'offset':None , 'items' : [], }
 209         self.jobs_table_json_dict = self.jobs_json_dict
 210         self.jobs_details_json_dict = self.jobs_json_dict
 211         self.server = srv
 212         self.node_dictlist = {}
 213         self.raw_json = None
 214         self.site_dict = {}
 215         self.SendRequest("GET_version")
 216
 217
 218
 219
 220
 221     def ParseVersion(self) :
 222         #print self.raw_json
 223         #print >>sys.stderr, self.raw_json
 224         if 'oar_version' in self.raw_json :
 225             self.version_json_dict.update(api_version = \
 226                                                 self.raw_json['api_version'],
 227                             apilib_version = self.raw_json['apilib_version'],
 228                             api_timezone = self.raw_json['api_timezone'],
 229                             api_timestamp = self.raw_json['api_timestamp'],
 230                             oar_version = self.raw_json['oar_version'] )
 231         else :
 232             self.version_json_dict.update(api_version = self.raw_json['api'] ,
 233                             apilib_version = self.raw_json['apilib'],
 234                             api_timezone = self.raw_json['api_timezone'],
 235                             api_timestamp = self.raw_json['api_timestamp'],
 236                             oar_version = self.raw_json['oar'] )
 237
 238         print self.version_json_dict['apilib_version']
 239
 240
 241     def ParseTimezone(self) :
 242         api_timestamp = self.raw_json['api_timestamp']
 243         api_tz = self.raw_json['timezone']
 244         return api_timestamp, api_tz
 245
 246     def ParseJobs(self) :
 247         self.jobs_list = []
 248         print " ParseJobs "
 249         return self.raw_json
 250
 251     def ParseJobsTable(self) :
 252         print "ParseJobsTable"
 253
 254     def ParseJobsDetails (self):
 255         # currently, this function is not used a lot,
 256         #so i have no idea what be usefull to parse,
 257         #returning the full json. NT
 258         logger.debug("ParseJobsDetails %s " %(self.raw_json))
 259         return self.raw_json
 260
 261
 262     def ParseJobsIds(self):
 263
 264         job_resources = ['wanted_resources', 'name', 'id', 'start_time', \
 265                         'state','owner','walltime','message']
 266
 267
 268         job_resources_full = ['launching_directory', 'links', \
 269             'resubmit_job_id', 'owner', 'events', 'message', \
 270             'scheduled_start', 'id', 'array_id',  'exit_code', \
 271             'properties', 'state','array_index', 'walltime', \
 272             'type', 'initial_request', 'stop_time', 'project',\
 273             'start_time',  'dependencies','api_timestamp','submission_time', \
 274             'reservation', 'stdout_file', 'types', 'cpuset_name', \
 275             'name',  'wanted_resources','queue','stderr_file','command']
 276
 277
 278         job_info = self.raw_json
 279         logger.debug("OARESTAPI ParseJobsIds %s" %(self.raw_json))
 280         values = []
 281         try:
 282             for k in job_resources:
 283                 values.append(job_info[k])
 284             return dict(zip(job_resources, values))
 285
 286         except KeyError:
 287             logger.log_exc("ParseJobsIds KeyError ")
 288
 289
 290     def ParseJobsIdResources(self):
 291         """ BROKEN since oar 2.5
 292         Parses the json produced by the request
 293         /oarapi/jobs/id/resources.json.
 294         Returns a list of oar node ids that are scheduled for the
 295         given job id.
 296
 297         """
 298         job_resources = []
 299         for resource in self.raw_json['items']:
 300             job_resources.append(resource['id'])
 301
 302         logger.debug("OARESTAPI \tParseJobsIdResources %s" %(self.raw_json))
 303         return job_resources
 304
 305     def ParseResources(self) :
 306         """ Parses the json produced by a get_resources request on oar."""
 307
 308         logger.debug("OARESTAPI \tParseResources " )
 309         #resources are listed inside the 'items' list from the json
 310         self.raw_json = self.raw_json['items']
 311         self.ParseNodes()
 312
 313     def ParseReservedNodes(self):
 314         """  Returns an array containing the list of the reserved nodes """
 315
 316         #resources are listed inside the 'items' list from the json
 317         reservation_list = []
 318         print "ParseReservedNodes_%s" %(self.raw_json['items'])
 319         job = {}
 320         #Parse resources info
 321         for json_element in  self.raw_json['items']:
 322             job['t_from'] = json_element['scheduled_start']
 323             #Get resources id list for the job
 324             job['resource_ids'] = \
 325                 [ node_dict['id'] for node_dict in json_element['resources'] ]
 326
 327             job['state'] = json_element['state']
 328             job['lease_id'] = json_element['id']
 329             job['t_until'] = json_element['scheduled_start'] + \
 330                                                     json_element['walltime']
 331             job['user'] = json_element['owner']
 332             logger.debug("ParseReservedNodes________job %s" %(job))
 333             reservation_list.append(job)
 334             #reset dict
 335             job = {}
 336         return reservation_list
 337
 338     def ParseRunningJobs(self):
 339         """ Gets the list of nodes currently in use from the attributes of the
 340         running jobs.
 341
 342         """
 343         logger.debug("OARESTAPI \tParseRunningJobs__________________________ ")
 344         #resources are listed inside the 'items' list from the json
 345         nodes = []
 346         for job in  self.raw_json['items']:
 347             for node in job['nodes']:
 348                 nodes.append(node['network_address'])
 349         return nodes
 350
 351
 352
 353     def ParseDeleteJobs(self):
 354         """ No need to parse anything in this function.A POST
 355         is done to delete the job.
 356
 357         """
 358         return
 359
 360     def ParseResourcesFull(self) :
 361         """ This method is responsible for parsing all the attributes
 362         of all the nodes returned by OAR when issuing a get resources full.
 363         The information from the nodes and the sites are separated.
 364         Updates the node_dictlist so that the dictionnary of the platform's
 365         nodes is available afterwards.
 366
 367         """
 368         logger.debug("OARRESTAPI ParseResourcesFull________________________ ")
 369         #print self.raw_json[1]
 370         #resources are listed inside the 'items' list from the json
 371         if self.version_json_dict['apilib_version'] != "0.2.10" :
 372             self.raw_json = self.raw_json['items']
 373         self.ParseNodes()
 374         self.ParseSites()
 375         return self.node_dictlist
 376
 377     def ParseResourcesFullSites(self) :
 378         """ UNUSED. Originally used to get information from the sites.
 379         ParseResourcesFull is used instead.
 380
 381         """
 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.site_dict
 387
 388
 389
 390     def ParseNodes(self):
 391         """ Parse nodes properties from OAR
 392         Put them into a dictionary with key = node id and value is a dictionary
 393         of the node properties and properties'values.
 394
 395         """
 396         node_id = None
 397         keys = self.resources_fulljson_dict.keys()
 398         keys.sort()
 399
 400         for dictline in self.raw_json:
 401             node_id = None
 402             # dictionary is empty and/or a new node has to be inserted
 403             node_id = self.resources_fulljson_dict['network_address'](\
 404                                 self.node_dictlist, dictline['network_address'])
 405             for k in keys:
 406                 if k in dictline:
 407                     if k == 'network_address':
 408                         continue
 409
 410                     self.resources_fulljson_dict[k](\
 411                                     self.node_dictlist[node_id], dictline[k])
 412
 413             #The last property has been inserted in the property tuple list,
 414             #reset node_id
 415             #Turn the property tuple list (=dict value) into a dictionary
 416             self.node_dictlist[node_id] = dict(self.node_dictlist[node_id])
 417             node_id = None
 418
 419
 420     def hostname_to_hrn(self, root_auth, login_base, hostname):
 421         return PlXrn(auth = root_auth, \
 422                              hostname = login_base + '_' + hostname).get_hrn()
 423
 424
 425     def ParseSites(self):
 426         """ Returns a list of dictionnaries containing the sites' attributes."""
 427
 428         nodes_per_site = {}
 429         config = Config()
 430         logger.debug(" OARrestapi.py \tParseSites  self.node_dictlist %s"\
 431                                                         %(self.node_dictlist))
 432         # Create a list of nodes per site_id
 433         for node_id in self.node_dictlist.keys():
 434             node  = self.node_dictlist[node_id]
 435
 436             if node['site'] not in nodes_per_site:
 437                 nodes_per_site[node['site']] = []
 438                 nodes_per_site[node['site']].append(node['node_id'])
 439             else:
 440                 if node['node_id'] not in nodes_per_site[node['site']]:
 441                     nodes_per_site[node['site']].append(node['node_id'])
 442
 443         #Create a site dictionary with key is site_login_base (name of the site)
 444         # and value is a dictionary of properties, including the list
 445         #of the node_ids
 446         for node_id in self.node_dictlist.keys():
 447             node  = self.node_dictlist[node_id]
 448             node.update({'hrn':self.hostname_to_hrn(self.interface_hrn, \
 449                                             node['site'],node['hostname'])})
 450
 451             self.node_dictlist.update({node_id:node})
 452
 453             if node['site'] not in self.site_dict:
 454                 self.site_dict[node['site']] = {
 455                     'site':node['site'],
 456                     'node_ids':nodes_per_site[node['site']],
 457                     'latitude':"48.83726",
 458                     'longitude':"- 2.10336",'name':config.SFA_REGISTRY_ROOT_AUTH,
 459                     'pcu_ids':[], 'max_slices':None, 'ext_consortium_id':None,
 460                     'max_slivers':None, 'is_public':True, 'peer_site_id': None,
 461                     'abbreviated_name':"senslab", 'address_ids': [],
 462                     'url':"http,//www.senslab.info", 'person_ids':[],
 463                     'site_tag_ids':[], 'enabled': True,  'slice_ids':[],
 464                     'date_created': None, 'peer_id': None }
 465             #if node['site_login_base'] not in self.site_dict.keys():
 466                 #self.site_dict[node['site_login_base']] = {'login_base':node['site_login_base'],
 467                                                         #'node_ids':nodes_per_site[node['site_login_base']],
 468                                                         #'latitude':"48.83726",
 469                                                         #'longitude':"- 2.10336",'name':"senslab",
 470                                                         #'pcu_ids':[], 'max_slices':None, 'ext_consortium_id':None,
 471                                                         #'max_slivers':None, 'is_public':True, 'peer_site_id': None,
 472                                                         #'abbreviated_name':"senslab", 'address_ids': [],
 473                                                         #'url':"http,//www.senslab.info", 'person_ids':[],
 474                                                         #'site_tag_ids':[], 'enabled': True,  'slice_ids':[],
 475                                                         #'date_created': None, 'peer_id': None }
 476
 477
 478
 479
 480     OARrequests_uri_dict = {
 481         'GET_version':
 482                 {'uri':'/oarapi/version.json', 'parse_func': ParseVersion},
 483         'GET_timezone':
 484                 {'uri':'/oarapi/timezone.json' ,'parse_func': ParseTimezone },
 485         'GET_jobs':
 486                 {'uri':'/oarapi/jobs.json','parse_func': ParseJobs},
 487         'GET_jobs_id':
 488                 {'uri':'/oarapi/jobs/id.json','parse_func': ParseJobsIds},
 489         'GET_jobs_id_resources':
 490                 {'uri':'/oarapi/jobs/id/resources.json',\
 491                 'parse_func': ParseJobsIdResources},
 492         'GET_jobs_table':
 493                 {'uri':'/oarapi/jobs/table.json','parse_func': ParseJobsTable},
 494         'GET_jobs_details':
 495                 {'uri':'/oarapi/jobs/details.json',\
 496                 'parse_func': ParseJobsDetails},
 497         'GET_reserved_nodes':
 498                 {'uri':
 499                 '/oarapi/jobs/details.json?state=Running,Waiting,Launching',\
 500                 'parse_func':ParseReservedNodes},
 501         'GET_running_jobs':
 502                 {'uri':'/oarapi/jobs/details.json?state=Running',\
 503                 'parse_func':ParseRunningJobs},
 504         'GET_resources_full':
 505                 {'uri':'/oarapi/resources/full.json',\
 506                 'parse_func': ParseResourcesFull},
 507         'GET_sites':
 508                 {'uri':'/oarapi/resources/full.json',\
 509                 'parse_func': ParseResourcesFullSites},
 510         'GET_resources':
 511                 {'uri':'/oarapi/resources.json' ,'parse_func': ParseResources},
 512         'DELETE_jobs_id':
 513                 {'uri':'/oarapi/jobs/id.json' ,'parse_func': ParseDeleteJobs}
 514         }
 515
 516
 517
 518     def SendRequest(self, request, strval = None , username = None):
 519         """ Connects to OAR , sends the valid GET requests and uses
 520         the appropriate json parsing functions.
 521
 522         """
 523         if request in self.OARrequests_uri_dict :
 524             self.raw_json = self.server.GETRequestToOARRestAPI(request, \
 525                                                                 strval, \
 526                                                                 username)
 527             return self.OARrequests_uri_dict[request]['parse_func'](self)
 528         else:
 529             logger.error("OARRESTAPI OARGetParse __init__ : ERROR_REQUEST " \
 530                                                                  %(request))
 531