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