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