sfa/senslab/OARrestapi.py

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