sfa/iotlab/OARrestapi.py

   1 """
   2 File used to handle issuing request to OAR and parse OAR's JSON responses.
   3 Contains the following classes:
   4 - JsonPage : handles multiple pages OAR answers.
   5 - OARRestapi : handles issuing POST or GET requests to OAR.
   6 - ParsingResourcesFull : dedicated to parsing OAR's answer to a get resources
   7 full request.
   8 - OARGETParser : handles parsing the Json answers to different GET requests.
   9
  10 """
  11 from httplib import HTTPConnection, HTTPException, NotConnected
  12 import json
  13 from sfa.util.config import Config
  14 from sfa.util.sfalogging import logger
  15 import os.path
  16
  17
  18 class JsonPage:
  19
  20     """Class used to manipulate json pages given by OAR.
  21
  22     In case the json answer from a GET request is too big to fit in one json
  23     page, this class provides helper methods to retrieve all the pages and
  24     store them in a list before putting them into one single json dictionary,
  25     facilitating the parsing.
  26
  27     """
  28
  29     def __init__(self):
  30         """Defines attributes to manipulate and parse the json pages.
  31
  32         """
  33         #All are boolean variables
  34         self.concatenate = False
  35         #Indicates end of data, no more pages to be loaded.
  36         self.end = False
  37         self.next_page = False
  38         #Next query address
  39         self.next_offset = None
  40         #Json page
  41         self.raw_json = None
  42
  43     def FindNextPage(self):
  44         """
  45         Gets next data page from OAR when the query's results are too big to
  46         be transmitted in a single page. Uses the "links' item in the json
  47         returned to check if an additionnal page has to be loaded. Updates
  48         object attributes next_page, next_offset, and end.
  49
  50         """
  51         if "links" in self.raw_json:
  52             for page in self.raw_json['links']:
  53                 if page['rel'] == 'next':
  54                     self.concatenate = True
  55                     self.next_page = True
  56                     self.next_offset = "?" + page['href'].split("?")[1]
  57                     return
  58
  59         if self.concatenate:
  60             self.end = True
  61             self.next_page = False
  62             self.next_offset = None
  63
  64             return
  65
  66         #Otherwise, no next page and no concatenate, must be a single page
  67         #Concatenate the single page and get out of here.
  68         else:
  69             self.next_page = False
  70             self.concatenate = True
  71             self.next_offset = None
  72             return
  73
  74     @staticmethod
  75     def ConcatenateJsonPages(saved_json_list):
  76         """
  77         If the json answer is too big to be contained in a single page,
  78         all the pages have to be loaded and saved before being appended to the
  79         first page.
  80
  81         :param saved_json_list: list of all the stored pages, including the
  82             first page.
  83         :type saved_json_list: list
  84         :returns: Returns a dictionary with all the pages saved in the
  85             saved_json_list. The key of the dictionary is 'items'.
  86         :rtype: dict
  87
  88
  89         .. seealso:: SendRequest
  90         .. warning:: Assumes the apilib is 0.2.10 (with the 'items' key in the
  91             raw json dictionary)
  92
  93         """
  94         #reset items list
  95
  96         tmp = {}
  97         tmp['items'] = []
  98
  99         for page in saved_json_list:
 100             tmp['items'].extend(page['items'])
 101         return tmp
 102
 103     def ResetNextPage(self):
 104         """
 105         Resets all the Json page attributes (next_page, next_offset,
 106         concatenate, end). Has to be done before getting another json answer
 107         so that the previous page status does not affect the new json load.
 108
 109         """
 110         self.next_page = True
 111         self.next_offset = None
 112         self.concatenate = False
 113         self.end = False
 114
 115
 116 class OARrestapi:
 117     """Class used to connect to the OAR server and to send GET and POST
 118     requests.
 119
 120     """
 121
 122     # classes attributes
 123
 124     OAR_REQUEST_POST_URI_DICT = {'POST_job': {'uri': '/oarapi/jobs.json'},
 125                                  'DELETE_jobs_id':
 126                                  {'uri': '/oarapi/jobs/id.json'},
 127                                  }
 128
 129     POST_FORMAT = {'json': {'content': "application/json", 'object': json}}
 130
 131     #OARpostdatareqfields = {'resource' :"/nodes=", 'command':"sleep", \
 132                             #'workdir':"/home/", 'walltime':""}
 133
 134     def __init__(self, config_file='/etc/sfa/oar_config.py'):
 135         self.oarserver = {}
 136         self.oarserver['uri'] = None
 137         self.oarserver['postformat'] = 'json'
 138
 139         try:
 140             execfile(config_file, self.__dict__)
 141
 142             self.config_file = config_file
 143             # path to configuration data
 144             self.config_path = os.path.dirname(config_file)
 145
 146         except IOError:
 147             raise IOError, "Could not find or load the configuration file: %s" \
 148                 % config_file
 149         #logger.setLevelDebug()
 150         self.oarserver['ip'] = self.OAR_IP
 151         self.oarserver['port'] = self.OAR_PORT
 152         self.jobstates = ['Terminated', 'Hold', 'Waiting', 'toLaunch',
 153                           'toError', 'toAckReservation', 'Launching',
 154                           'Finishing', 'Running', 'Suspended', 'Resuming',
 155                           'Error']
 156
 157         self.parser = OARGETParser(self)
 158
 159
 160     def GETRequestToOARRestAPI(self, request, strval=None,
 161                                next_page=None, username=None):
 162
 163         """Makes a GET request to OAR.
 164
 165         Fetch the uri associated with the resquest stored in
 166         OARrequests_uri_dict, adds the username if needed and if available, adds
 167         strval to the request uri if needed, connects to OAR and issues the GET
 168         request. Gets the json reply.
 169
 170         :param request: One of the known get requests that are keys in the
 171             OARrequests_uri_dict.
 172         :param strval: used when a job id has to be specified.
 173         :param next_page: used to tell OAR to send the next page for this
 174             Get request. Is appended to the GET uri.
 175         :param username: used when a username has to be specified, when looking
 176             for jobs scheduled by a particular user  for instance.
 177
 178         :type request: string
 179         :type strval: integer
 180         :type next_page: boolean
 181         :type username: string
 182         :returns: a json dictionary if OAR successfully processed the GET
 183             request.
 184
 185         .. seealso:: OARrequests_uri_dict
 186         """
 187         self.oarserver['uri'] = \
 188             OARGETParser.OARrequests_uri_dict[request]['uri']
 189         #Get job details with username
 190         if 'owner' in OARGETParser.OARrequests_uri_dict[request] and username:
 191             self.oarserver['uri'] += \
 192                 OARGETParser.OARrequests_uri_dict[request]['owner'] + username
 193         headers = {}
 194         data = json.dumps({})
 195         logger.debug("OARrestapi \tGETRequestToOARRestAPI %s" % (request))
 196         if strval:
 197             self.oarserver['uri'] = self.oarserver['uri'].\
 198                 replace("id", str(strval))
 199
 200         if next_page:
 201             self.oarserver['uri'] += next_page
 202
 203         if username:
 204             headers['X-REMOTE_IDENT'] = username
 205
 206         logger.debug("OARrestapi: \t  GETRequestToOARRestAPI  \
 207                         self.oarserver['uri'] %s strval %s"
 208                      % (self.oarserver['uri'], strval))
 209         try:
 210             #seems that it does not work if we don't add this
 211             headers['content-length'] = '0'
 212
 213             conn = HTTPConnection(self.oarserver['ip'],
 214                                   self.oarserver['port'])
 215             conn.request("GET", self.oarserver['uri'], data, headers)
 216             resp = (conn.getresponse()).read()
 217             conn.close()
 218
 219         except HTTPException, error:
 220             logger.log_exc("GET_OAR_SRVR : Problem with OAR server : %s "
 221                            % (error))
 222             #raise ServerError("GET_OAR_SRVR : Could not reach OARserver")
 223         try:
 224             js_dict = json.loads(resp)
 225             #print "\r\n \t\t\t js_dict keys" , js_dict.keys(), " \r\n", js_dict
 226             return js_dict
 227
 228         except ValueError, error:
 229             logger.log_exc("Failed to parse Server Response: %s ERROR %s"
 230                            % (js_dict, error))
 231             #raise ServerError("Failed to parse Server Response:" + js)
 232
 233
 234     def POSTRequestToOARRestAPI(self, request, datadict, username=None):
 235         """ Used to post a job on OAR , along with data associated
 236         with the job.
 237
 238         """
 239
 240         #first check that all params for are OK
 241         try:
 242             self.oarserver['uri'] = \
 243                 self.OAR_REQUEST_POST_URI_DICT[request]['uri']
 244
 245         except KeyError:
 246             logger.log_exc("OARrestapi \tPOSTRequestToOARRestAPI request not \
 247                              valid")
 248             return
 249         if datadict and 'strval' in datadict:
 250             self.oarserver['uri'] = self.oarserver['uri'].replace("id", \
 251                                                 str(datadict['strval']))
 252             del datadict['strval']
 253
 254         data = json.dumps(datadict)
 255         headers = {'X-REMOTE_IDENT':username, \
 256                 'content-type': self.POST_FORMAT['json']['content'], \
 257                 'content-length':str(len(data))}
 258         try :
 259
 260             conn = HTTPConnection(self.oarserver['ip'], \
 261                                         self.oarserver['port'])
 262             conn.request("POST", self.oarserver['uri'], data, headers)
 263             resp = (conn.getresponse()).read()
 264             conn.close()
 265         except NotConnected:
 266             logger.log_exc("POSTRequestToOARRestAPI NotConnected ERROR: \
 267                             data %s \r\n \t\n \t\t headers %s uri %s" \
 268                             %(data,headers,self.oarserver['uri']))
 269
 270             #raise ServerError("POST_OAR_SRVR : error")
 271
 272         try:
 273             answer = json.loads(resp)
 274             logger.debug("POSTRequestToOARRestAPI : answer %s" % (answer))
 275             return answer
 276
 277         except ValueError, error:
 278             logger.log_exc("Failed to parse Server Response: error %s  \
 279                             %s" %(error))
 280             #raise ServerError("Failed to parse Server Response:" + answer)
 281
 282
 283 class ParsingResourcesFull():
 284     """
 285     Class dedicated to parse the json response from a GET_resources_full from
 286     OAR.
 287
 288     """
 289     def __init__(self):
 290         """
 291         Set the parsing dictionary. Works like a switch case, if the key is
 292         found in the dictionary, then the associated function is called.
 293         This is used in ParseNodes to create an usable dictionary from
 294         the Json returned by OAR when issuing a GET resources full request.
 295
 296         .. seealso:: ParseNodes
 297
 298         """
 299         self.resources_fulljson_dict = {
 300         'network_address': self.AddNodeNetworkAddr,
 301         'site':  self.AddNodeSite,
 302         # 'radio':  self.AddNodeRadio,
 303         'mobile':  self.AddMobility,
 304         'x':  self.AddPosX,
 305         'y':  self.AddPosY,
 306         'z': self.AddPosZ,
 307         'archi': self.AddHardwareType,
 308         'state': self.AddBootState,
 309         'id': self.AddOarNodeId,
 310         }
 311
 312
 313
 314     def AddOarNodeId(self, tuplelist, value):
 315         """Adds Oar internal node id to the nodes' attributes.
 316
 317         Appends tuple ('oar_id', node_id) to the tuplelist. Used by ParseNodes.
 318
 319         .. seealso:: ParseNodes
 320
 321         """
 322
 323         tuplelist.append(('oar_id', int(value)))
 324
 325
 326     def AddNodeNetworkAddr(self, dictnode, value):
 327         """First parsing function to be called to parse the json returned by OAR
 328         answering a GET_resources (/oarapi/resources.json) request.
 329
 330         When a new node is found in the json, this function is responsible for
 331         creating a new entry in the dictionary for storing information on this
 332         specific node. The key is the node network address, which is also the
 333         node's hostname.
 334         The value associated with the key is a tuple list.It contains all
 335         the nodes attributes. The tuplelist will later be turned into a dict.
 336
 337         :param dictnode: should be set to the OARGETParser atribute
 338             node_dictlist. It will store the information on the nodes.
 339         :param value: the node_id is the network_address in the raw json.
 340         :type value: string
 341         :type dictnode: dictionary
 342
 343         .. seealso: ParseResources, ParseNodes
 344         """
 345
 346         node_id = value
 347         dictnode[node_id] = [('node_id', node_id),('hostname', node_id) ]
 348
 349         return node_id
 350
 351     def AddNodeSite(self, tuplelist, value):
 352         """Add the site's node to the dictionary.
 353
 354
 355         :param tuplelist: tuple list on which to add the node's site.
 356             Contains the other node attributes as well.
 357         :param value: value to add to the tuple list, in this case the node's
 358             site.
 359         :type tuplelist: list
 360         :type value: string
 361
 362         .. seealso:: AddNodeNetworkAddr
 363
 364         """
 365         tuplelist.append(('site', str(value)))
 366
 367     # def AddNodeRadio(tuplelist, value):
 368     #     """Add thenode's radio chipset type to the tuple list.
 369
 370     #     :param tuplelist: tuple list on which to add the node's mobility
 371                 # status. The tuplelist is the value associated with the node's
 372                 # id in the OARGETParser
 373     #          's dictionary node_dictlist.
 374     #     :param value: name of the radio chipset on the node.
 375     #     :type tuplelist: list
 376     #     :type value: string
 377
 378     #     .. seealso:: AddNodeNetworkAddr
 379
 380     #     """
 381     #     tuplelist.append(('radio', str(value)))
 382
 383
 384     def AddMobility(self, tuplelist, value):
 385         """Add if the node is a mobile node or not to the tuple list.
 386
 387         :param tuplelist: tuple list on which to add the node's mobility status.
 388             The tuplelist is the value associated with the node's id in the
 389             OARGETParser's dictionary node_dictlist.
 390         :param value: tells if a node is a mobile node or not. The value is found
 391             in the json.
 392
 393         :type tuplelist: list
 394         :type value: integer
 395
 396         .. seealso:: AddNodeNetworkAddr
 397
 398         """
 399         if value is 0:
 400             tuplelist.append(('mobile', 'False'))
 401         else:
 402             tuplelist.append(('mobile', 'True'))
 403
 404
 405     def AddPosX(self, tuplelist, value):
 406         """Add the node's position on the x axis.
 407
 408         :param tuplelist: tuple list on which to add the node's position . The
 409             tuplelist is the value associated with the node's id in the
 410             OARGETParser's dictionary node_dictlist.
 411         :param value: the position x.
 412
 413         :type tuplelist: list
 414         :type value: integer
 415
 416          .. seealso:: AddNodeNetworkAddr
 417
 418         """
 419         tuplelist.append(('posx', value ))
 420
 421
 422
 423     def AddPosY(self, tuplelist, value):
 424         """Add the node's position on the y axis.
 425
 426         :param tuplelist: tuple list on which to add the node's position . The
 427             tuplelist is the value associated with the node's id in the
 428             OARGETParser's dictionary node_dictlist.
 429         :param value: the position y.
 430
 431         :type tuplelist: list
 432         :type value: integer
 433
 434          .. seealso:: AddNodeNetworkAddr
 435
 436         """
 437         tuplelist.append(('posy', value))
 438
 439
 440
 441     def AddPosZ(self, tuplelist, value):
 442         """Add the node's position on the z axis.
 443
 444         :param tuplelist: tuple list on which to add the node's position . The
 445             tuplelist is the value associated with the node's id in the
 446             OARGETParser's dictionary node_dictlist.
 447         :param value: the position z.
 448
 449         :type tuplelist: list
 450         :type value: integer
 451
 452          .. seealso:: AddNodeNetworkAddr
 453
 454         """
 455
 456         tuplelist.append(('posz', value))
 457
 458
 459
 460     def AddBootState(tself, tuplelist, value):
 461         """Add the node's state, Alive or Suspected.
 462
 463         :param tuplelist: tuple list on which to add the node's state . The
 464             tuplelist is the value associated with the node's id in the
 465             OARGETParser 's dictionary node_dictlist.
 466         :param value: node's state.
 467
 468         :type tuplelist: list
 469         :type value: string
 470
 471          .. seealso:: AddNodeNetworkAddr
 472
 473         """
 474         tuplelist.append(('boot_state', str(value)))
 475
 476
 477     def AddHardwareType(self, tuplelist, value):
 478         """Add the node's hardware model and radio chipset type to the tuple
 479         list.
 480
 481         :param tuplelist: tuple list on which to add the node's architecture
 482             and radio chipset type.
 483         :param value: hardware type: radio chipset. The value contains both the
 484             architecture and the radio chipset, separated by a colon.
 485         :type tuplelist: list
 486         :type value: string
 487
 488         .. seealso:: AddNodeNetworkAddr
 489
 490         """
 491
 492         value_list = value.split(':')
 493         tuplelist.append(('archi', value_list[0]))
 494         tuplelist.append(('radio', value_list[1]))
 495
 496
 497 class OARGETParser:
 498     """Class providing parsing methods associated to specific GET requests.
 499
 500     """
 501
 502     def __init__(self, srv):
 503         self.version_json_dict = {
 504             'api_version': None, 'apilib_version': None,
 505             'api_timezone': None, 'api_timestamp': None, 'oar_version': None}
 506         self.config = Config()
 507         self.interface_hrn = self.config.SFA_INTERFACE_HRN
 508         self.timezone_json_dict = {
 509             'timezone': None, 'api_timestamp': None, }
 510         #self.jobs_json_dict = {
 511             #'total' : None, 'links' : [],\
 512             #'offset':None , 'items' : [], }
 513         #self.jobs_table_json_dict = self.jobs_json_dict
 514         #self.jobs_details_json_dict = self.jobs_json_dict
 515         self.server = srv
 516         self.node_dictlist = {}
 517
 518         self.json_page = JsonPage()
 519         self.parsing_resourcesfull = ParsingResourcesFull()
 520         self.site_dict = {}
 521         self.jobs_list = []
 522         self.SendRequest("GET_version")
 523
 524
 525     def ParseVersion(self):
 526         """Parses the OAR answer to the GET_version ( /oarapi/version.json.)
 527
 528         Finds the OAR apilib version currently used. Has an impact on the json
 529         structure returned by OAR, so the version has to be known before trying
 530         to parse the jsons returned after a get request has been issued.
 531         Updates the attribute version_json_dict.
 532
 533         """
 534
 535         if 'oar_version' in self.json_page.raw_json:
 536             self.version_json_dict.update(
 537                 api_version=self.json_page.raw_json['api_version'],
 538                 apilib_version=self.json_page.raw_json['apilib_version'],
 539                 api_timezone=self.json_page.raw_json['api_timezone'],
 540                 api_timestamp=self.json_page.raw_json['api_timestamp'],
 541                 oar_version=self.json_page.raw_json['oar_version'])
 542         else:
 543             self.version_json_dict.update(
 544                 api_version=self.json_page.raw_json['api'],
 545                 apilib_version=self.json_page.raw_json['apilib'],
 546                 api_timezone=self.json_page.raw_json['api_timezone'],
 547                 api_timestamp=self.json_page.raw_json['api_timestamp'],
 548                 oar_version=self.json_page.raw_json['oar'])
 549
 550         print self.version_json_dict['apilib_version']
 551
 552
 553     def ParseTimezone(self):
 554         """Get the timezone used by OAR.
 555
 556         Get the timezone from the answer to the GET_timezone request.
 557         :return: api_timestamp and api timezone.
 558         :rype: integer, integer
 559
 560         .. warning:: unused.
 561         """
 562         api_timestamp = self.json_page.raw_json['api_timestamp']
 563         api_tz = self.json_page.raw_json['timezone']
 564         return api_timestamp, api_tz
 565
 566     def ParseJobs(self):
 567         """Called when a GET_jobs request has been issued to OAR.
 568
 569         Corresponds to /oarapi/jobs.json uri. Currently returns the raw json
 570         information dict.
 571         :returns: json_page.raw_json
 572         :rtype: dictionary
 573
 574         .. warning:: Does not actually parse the information in the json. SA
 575             15/07/13.
 576
 577         """
 578         self.jobs_list = []
 579         print " ParseJobs "
 580         return self.json_page.raw_json
 581
 582     def ParseJobsTable(self):
 583         """In case we need to use the job table in the future.
 584
 585         Associated with the GET_jobs_table : '/oarapi/jobs/table.json uri.
 586         .. warning:: NOT USED. DOES NOTHING.
 587         """
 588         print "ParseJobsTable"
 589
 590     def ParseJobsDetails(self):
 591         """Currently only returns the same json in self.json_page.raw_json.
 592
 593         .. todo:: actually parse the json
 594         .. warning:: currently, this function is not used a lot, so I have no
 595             idea what could  be useful to parse, returning the full json. NT
 596         """
 597
 598         #logger.debug("ParseJobsDetails %s " %(self.json_page.raw_json))
 599         return self.json_page.raw_json
 600
 601
 602     def ParseJobsIds(self):
 603         """Associated with the GET_jobs_id OAR request.
 604
 605         Parses the json dict (OAR answer) to the GET_jobs_id request
 606         /oarapi/jobs/id.json.
 607
 608
 609         :returns: dictionary whose keys are listed in the local variable
 610             job_resources and values that are in the json dictionary returned
 611             by OAR with the job information.
 612         :rtype: dict
 613
 614         """
 615         job_resources = ['wanted_resources', 'name', 'id', 'start_time',
 616                          'state', 'owner', 'walltime', 'message']
 617
 618         # Unused variable providing the contents of the json dict returned from
 619         # get job resources full request
 620         job_resources_full = [
 621             'launching_directory', 'links',
 622             'resubmit_job_id', 'owner', 'events', 'message',
 623             'scheduled_start', 'id', 'array_id', 'exit_code',
 624             'properties', 'state', 'array_index', 'walltime',
 625             'type', 'initial_request', 'stop_time', 'project',
 626             'start_time',  'dependencies', 'api_timestamp', 'submission_time',
 627             'reservation', 'stdout_file', 'types', 'cpuset_name',
 628             'name', 'wanted_resources', 'queue', 'stderr_file', 'command']
 629
 630
 631         job_info = self.json_page.raw_json
 632         #logger.debug("OARESTAPI ParseJobsIds %s" %(self.json_page.raw_json))
 633         values = []
 634         try:
 635             for k in job_resources:
 636                 values.append(job_info[k])
 637             return dict(zip(job_resources, values))
 638
 639         except KeyError:
 640             logger.log_exc("ParseJobsIds KeyError ")
 641
 642
 643     def ParseJobsIdResources(self):
 644         """ Parses the json produced by the request
 645         /oarapi/jobs/id/resources.json.
 646         Returns a list of oar node ids that are scheduled for the
 647         given job id.
 648
 649         """
 650         job_resources = []
 651         for resource in self.json_page.raw_json['items']:
 652             job_resources.append(resource['id'])
 653
 654         return job_resources
 655
 656     def ParseResources(self):
 657         """ Parses the json produced by a get_resources request on oar."""
 658
 659         #logger.debug("OARESTAPI \tParseResources " )
 660         #resources are listed inside the 'items' list from the json
 661         self.json_page.raw_json = self.json_page.raw_json['items']
 662         self.ParseNodes()
 663
 664     def ParseReservedNodes(self):
 665         """  Returns an array containing the list of the jobs scheduled
 666         with the reserved nodes if available.
 667
 668         :returns: list of job dicts, each dict containing the following keys:
 669             t_from, t_until, resources_ids (of the reserved nodes for this job).
 670             If the information is not available, default values will be set for
 671             these keys. The other keys are : state, lease_id and user.
 672         :rtype: list
 673
 674         """
 675
 676         #resources are listed inside the 'items' list from the json
 677         reservation_list = []
 678         job = {}
 679         #Parse resources info
 680         for json_element in self.json_page.raw_json['items']:
 681             #In case it is a real reservation (not asap case)
 682             if json_element['scheduled_start']:
 683                 job['t_from'] = json_element['scheduled_start']
 684                 job['t_until'] = int(json_element['scheduled_start']) + \
 685                     int(json_element['walltime'])
 686                 #Get resources id list for the job
 687                 job['resource_ids'] = [node_dict['id'] for node_dict
 688                                        in json_element['resources']]
 689             else:
 690                 job['t_from'] = "As soon as possible"
 691                 job['t_until'] = "As soon as possible"
 692                 job['resource_ids'] = ["Undefined"]
 693
 694             job['state'] = json_element['state']
 695             job['lease_id'] = json_element['id']
 696
 697             job['user'] = json_element['owner']
 698             #logger.debug("OARRestapi \tParseReservedNodes job %s" %(job))
 699             reservation_list.append(job)
 700             #reset dict
 701             job = {}
 702         return reservation_list
 703
 704     def ParseRunningJobs(self):
 705         """ Gets the list of nodes currently in use from the attributes of the
 706         running jobs.
 707
 708         :returns: list of hostnames, the nodes that are currently involved in
 709             running jobs.
 710         :rtype: list
 711
 712
 713         """
 714         logger.debug("OARESTAPI \tParseRunningJobs_________________ ")
 715         #resources are listed inside the 'items' list from the json
 716         nodes = []
 717         for job in self.json_page.raw_json['items']:
 718             for node in job['nodes']:
 719                 nodes.append(node['network_address'])
 720         return nodes
 721
 722     def ChangeRawJsonDependingOnApilibVersion(self):
 723         """
 724         Check if the OAR apilib version is different from 0.2.10, in which case
 725         the Json answer is also dict instead as a plain list.
 726
 727         .. warning:: the whole code is assuming the json contains a 'items' key
 728         .. seealso:: ConcatenateJsonPages, ParseJobs, ParseReservedNodes,
 729             ParseJobsIdResources, ParseResources, ParseRunningJobs
 730         .. todo:: Clean the whole code. Either suppose the  apilib will always
 731             provide the 'items' key, or handle different options.
 732         """
 733
 734         if self.version_json_dict['apilib_version'] != "0.2.10":
 735             self.json_page.raw_json = self.json_page.raw_json['items']
 736
 737     def ParseDeleteJobs(self):
 738         """ No need to parse anything in this function.A POST
 739         is done to delete the job.
 740
 741         """
 742         return
 743
 744     def ParseResourcesFull(self):
 745         """ This method is responsible for parsing all the attributes
 746         of all the nodes returned by OAR when issuing a get resources full.
 747         The information from the nodes and the sites are separated.
 748         Updates the node_dictlist so that the dictionnary of the platform's
 749         nodes is available afterwards.
 750
 751         :returns: node_dictlist, a list of dictionaries about the nodes and
 752             their properties.
 753         :rtype: list
 754
 755         """
 756         logger.debug("OARRESTAPI ParseResourcesFull___________ ")
 757         #print self.json_page.raw_json[1]
 758         #resources are listed inside the 'items' list from the json
 759         self.ChangeRawJsonDependingOnApilibVersion()
 760         self.ParseNodes()
 761         self.ParseSites()
 762         return self.node_dictlist
 763
 764     def ParseResourcesFullSites(self):
 765         """ Called by GetSites which is unused.
 766         Originally used to get information from the sites, with for each site
 767         the list of nodes it has, along with their properties.
 768
 769         :return: site_dict, dictionary of sites
 770         :rtype: dict
 771
 772         .. warning:: unused
 773         .. seealso:: GetSites (IotlabTestbedAPI)
 774
 775         """
 776         self.ChangeRawJsonDependingOnApilibVersion()
 777         self.ParseNodes()
 778         self.ParseSites()
 779         return self.site_dict
 780
 781
 782     def ParseNodes(self):
 783         """ Parse nodes properties from OAR
 784         Put them into a dictionary with key = node id and value is a dictionary
 785         of the node properties and properties'values.
 786
 787         """
 788         node_id = None
 789         _resources_fulljson_dict = \
 790             self.parsing_resourcesfull.resources_fulljson_dict
 791         keys = _resources_fulljson_dict.keys()
 792         keys.sort()
 793
 794         for dictline in self.json_page.raw_json:
 795             node_id = None
 796             # dictionary is empty and/or a new node has to be inserted
 797             node_id = _resources_fulljson_dict['network_address'](
 798                 self.node_dictlist, dictline['network_address'])
 799             for k in keys:
 800                 if k in dictline:
 801                     if k == 'network_address':
 802                         continue
 803
 804                     _resources_fulljson_dict[k](
 805                         self.node_dictlist[node_id], dictline[k])
 806
 807             #The last property has been inserted in the property tuple list,
 808             #reset node_id
 809             #Turn the property tuple list (=dict value) into a dictionary
 810             self.node_dictlist[node_id] = dict(self.node_dictlist[node_id])
 811             node_id = None
 812
 813     @staticmethod
 814     def iotlab_hostname_to_hrn(root_auth,  hostname):
 815         """
 816         Transforms a node hostname into a SFA hrn.
 817
 818         :param root_auth: Name of the root authority of the SFA server. In
 819             our case, it is set to iotlab.
 820         :param hostname: node's hotname, given by OAR.
 821         :type root_auth: string
 822         :type hostname: string
 823         :returns: inserts the root_auth and '.' before the hostname.
 824         :rtype: string
 825
 826         """
 827         return root_auth + '.' + hostname
 828
 829     def ParseSites(self):
 830         """ Returns a list of dictionnaries containing the sites' attributes."""
 831
 832         nodes_per_site = {}
 833         config = Config()
 834         #logger.debug(" OARrestapi.py \tParseSites  self.node_dictlist %s"\
 835                                                         #%(self.node_dictlist))
 836         # Create a list of nodes per site_id
 837         for node_id in self.node_dictlist:
 838             node = self.node_dictlist[node_id]
 839
 840             if node['site'] not in nodes_per_site:
 841                 nodes_per_site[node['site']] = []
 842                 nodes_per_site[node['site']].append(node['node_id'])
 843             else:
 844                 if node['node_id'] not in nodes_per_site[node['site']]:
 845                     nodes_per_site[node['site']].append(node['node_id'])
 846
 847         #Create a site dictionary whose key is site_login_base
 848         # (name of the site) and value is a dictionary of properties,
 849         # including the list of the node_ids
 850         for node_id in self.node_dictlist:
 851             node = self.node_dictlist[node_id]
 852             node.update({'hrn': self.iotlab_hostname_to_hrn(self.interface_hrn,
 853                                                             node['hostname'])})
 854             self.node_dictlist.update({node_id: node})
 855
 856             if node['site'] not in self.site_dict:
 857                 self.site_dict[node['site']] = {
 858                     'site': node['site'],
 859                     'node_ids': nodes_per_site[node['site']],
 860                     'latitude': "48.83726",
 861                     'longitude': "- 2.10336",
 862                     'name': config.SFA_REGISTRY_ROOT_AUTH,
 863                     'pcu_ids': [], 'max_slices': None,
 864                     'ext_consortium_id': None,
 865                     'max_slivers': None, 'is_public': True,
 866                     'peer_site_id': None,
 867                     'abbreviated_name': "iotlab", 'address_ids': [],
 868                     'url': "https://portal.senslab.info", 'person_ids': [],
 869                     'site_tag_ids': [], 'enabled': True,  'slice_ids': [],
 870                     'date_created': None, 'peer_id': None
 871                 }
 872
 873     OARrequests_uri_dict = {
 874         'GET_version':
 875         {'uri': '/oarapi/version.json', 'parse_func': ParseVersion},
 876
 877         'GET_timezone':
 878         {'uri': '/oarapi/timezone.json', 'parse_func': ParseTimezone},
 879
 880         'GET_jobs':
 881         {'uri': '/oarapi/jobs.json', 'parse_func': ParseJobs},
 882
 883         'GET_jobs_id':
 884         {'uri': '/oarapi/jobs/id.json', 'parse_func': ParseJobsIds},
 885
 886         'GET_jobs_id_resources':
 887         {'uri': '/oarapi/jobs/id/resources.json',
 888         'parse_func': ParseJobsIdResources},
 889
 890         'GET_jobs_table':
 891         {'uri': '/oarapi/jobs/table.json', 'parse_func': ParseJobsTable},
 892
 893         'GET_jobs_details':
 894         {'uri': '/oarapi/jobs/details.json', 'parse_func': ParseJobsDetails},
 895
 896         'GET_reserved_nodes':
 897         {'uri':
 898         '/oarapi/jobs/details.json?state=Running,Waiting,Launching',
 899         'owner': '&user=', 'parse_func': ParseReservedNodes},
 900
 901         'GET_running_jobs':
 902         {'uri': '/oarapi/jobs/details.json?state=Running',
 903         'parse_func': ParseRunningJobs},
 904
 905         'GET_resources_full':
 906         {'uri': '/oarapi/resources/full.json',
 907         'parse_func': ParseResourcesFull},
 908
 909         'GET_sites':
 910         {'uri': '/oarapi/resources/full.json',
 911         'parse_func': ParseResourcesFullSites},
 912
 913         'GET_resources':
 914         {'uri': '/oarapi/resources.json', 'parse_func': ParseResources},
 915
 916         'DELETE_jobs_id':
 917         {'uri': '/oarapi/jobs/id.json', 'parse_func': ParseDeleteJobs}}
 918
 919
 920     def SendRequest(self, request, strval=None, username=None):
 921         """ Connects to OAR , sends the valid GET requests and uses
 922         the appropriate json parsing functions.
 923
 924         :returns: calls to the appropriate parsing function, associated with the
 925             GET request
 926         :rtype: depends on the parsing function called.
 927
 928         .. seealso:: OARrequests_uri_dict
 929         """
 930         save_json = None
 931
 932         self.json_page.ResetNextPage()
 933         save_json = []
 934
 935         if request in self.OARrequests_uri_dict:
 936             while self.json_page.next_page:
 937                 self.json_page.raw_json = self.server.GETRequestToOARRestAPI(
 938                     request,
 939                     strval,
 940                     self.json_page.next_offset,
 941                     username)
 942                 self.json_page.FindNextPage()
 943                 if self.json_page.concatenate:
 944                     save_json.append(self.json_page.raw_json)
 945
 946             if self.json_page.concatenate and self.json_page.end:
 947                 self.json_page.raw_json = \
 948                     self.json_page.ConcatenateJsonPages(save_json)
 949
 950             return self.OARrequests_uri_dict[request]['parse_func'](self)
 951         else:
 952             logger.error("OARRESTAPI OARGetParse __init__ : ERROR_REQUEST "
 953                          % (request))