Version 5.1.0.0

Author: rajeevkallur

src/redfish/__init__.py

@@ -1,7 +1,7 @@
 """ Redfish restful library """
 
 __all__ = ["rest", "ris", "hpilo"]
-__version__ = "5.0.0.0"
+__version__ = "5.1.0.0"
 
 import logging
 

src/redfish/hpilo/risblobstore2.py

@@ -25,6 +25,8 @@
 import string
 import struct
 import sys
+import time
+import os
 from ctypes import (
     POINTER,
     c_char_p,
@@ -176,7 +178,9 @@ def __init__(self, log_dir=None):
         lib = self.gethprestchifhandle()
         self.log_dir = log_dir
         self.channel = HpIlo(dll=lib, log_dir=log_dir)
-        self.max_retries = 3
+        self.max_retries = 40
+        self.max_read_retries = 3
+        self.delay = 0.25
 
     def __del__(self):
         """Blob store 2 close channel function"""
@@ -233,19 +237,31 @@ def get_info(self, key, namespace, retries=0):
         data = ptr[: lib.size_of_infoRequest()]
         data = bytearray(data)
 
-        resp = self._send_receive_raw(data)
+        while(retries <= self.max_retries):
+            """The Redfish request is submitted to iLO successfully in rest_immediate() function.
+            Here we are checking if iLO has processed the Redfish request and the response is 
+            written in the key in the volatile namespace in blob. 
+            If iLO has not processed the request and response is not written, we get BADPARAMETER error. 
+            Hence retry after 0.25 seconds."""
+            resp = self._send_receive_raw(data)
 
-        errorcode = struct.unpack("<I", bytes(resp[8:12]))[0]
-        if errorcode == BlobReturnCodes.BADPARAMETER:
-            if retries < self.max_retries:
-                self.get_info(key=key, namespace=namespace, retries=retries + 1)
-            else:
-                raise Blob2OverrideError(errorcode)
-        elif errorcode == BlobReturnCodes.NOTFOUND:
-            raise BlobNotFoundError(key, namespace)
+            #checking for errors in the received response
+            errorcode = struct.unpack("<I", bytes(resp[8:12]))[0]
 
-        if not (errorcode == BlobReturnCodes.SUCCESS or errorcode == BlobReturnCodes.NOTMODIFIED):
-            raise HpIloError(errorcode)
+            if errorcode == BlobReturnCodes.BADPARAMETER:
+                #if BADPARAMETER, delaying the execution by 0.25 seconds and retrying "send_receive_raw"
+                if retries < self.max_retries:
+                    time.sleep(self.delay)
+                    retries += 1
+                else:
+                    #if all retries are exhausted and an error is still received, raise Blob2override error.
+                    raise Blob2OverrideError(errorcode)
+            elif errorcode == BlobReturnCodes.NOTFOUND:
+                raise BlobNotFoundError(key, namespace)
+            elif not (errorcode == BlobReturnCodes.SUCCESS or errorcode == BlobReturnCodes.NOTMODIFIED):
+                raise HpIloError(errorcode)
+            else:
+                break
 
         response = resp[lib.size_of_responseHeaderBlob() :]
 
@@ -288,7 +304,7 @@ def read(self, key, namespace, retries=0):
             bytesread = struct.unpack("<I", bytes(recvpkt[readhead:(newreadsize)]))[0]
 
             if bytesread == 0:
-                if retries < self.max_retries:
+                if retries < self.max_read_retries:
                     data = self.read(key=key, namespace=namespace, retries=retries + 1)
                     return data
                 else:
@@ -431,16 +447,29 @@ def delete(self, key, namespace, retries=0):
         data = ptr[: lib.size_of_deleteRequest()]
         data = bytearray(data)
 
-        resp = self._send_receive_raw(data)
+        while(retries <= self.max_retries):
+            """The Redfish request is submitted to iLO successfully in rest_immediate() function.
+            Here we are checking if iLO has processed the Redfish request and the response is 
+            written in the key in the volatile namespace in blob. 
+            If iLO has not processed the request and response is not written, we get BADPARAMETER error. 
+            Hence retry after 0.25 seconds."""
+            resp = self._send_receive_raw(data)
 
-        errorcode = struct.unpack("<I", bytes(resp[8:12]))[0]
-        if errorcode == BlobReturnCodes.BADPARAMETER:
-            if retries < self.max_retries:
-                self.delete(key=key, namespace=namespace, retries=retries + 1)
+            #checking for errors in the received response
+            errorcode = struct.unpack("<I", bytes(resp[8:12]))[0]
+
+            if errorcode == BlobReturnCodes.BADPARAMETER:
+                #if error is BADPARAMETER, delaying the execution by 0.25 seconds and retrying "send_receive_raw"
+                if retries < self.max_retries:
+                    time.sleep(self.delay)
+                    retries += 1
+                else:
+                    #if all retries are exhausted and an error is still received, raise Blob2override error.
+                    raise Blob2OverrideError(errorcode)
+            elif not (errorcode == BlobReturnCodes.SUCCESS or errorcode == BlobReturnCodes.NOTMODIFIED):
+                raise HpIloError(errorcode)
             else:
-                raise Blob2OverrideError(errorcode)
-        elif not (errorcode == BlobReturnCodes.SUCCESS or errorcode == BlobReturnCodes.NOTMODIFIED):
-            raise HpIloError(errorcode)
+                break
 
         self.unloadchifhandle(lib)
 
@@ -889,6 +918,21 @@ def gethprestchifhandle():
         if libhandle:
             BlobStore2.setglobalhprestchifrandnumber(libhandle)
             return libhandle
+        else:
+            import site
+            site_packages = site.getsitepackages()
+            for package in site_packages:
+                try:
+                    if os.name != "nt":
+                        libpath = os.path.join(package, "ilorest", "chiflibrary", "ilorest_chif.so")
+                    else:
+                        libpath = os.path.join(package, "ilorest", "chiflibrary", "ilorest_chif.dll")
+                    libhandle = cdll.LoadLibrary(libpath)
+                except Exception as exp:
+                    excp = exp
+                if libhandle:
+                    BlobStore2.setglobalhprestchifrandnumber(libhandle)
+                    return libhandle
         raise ChifDllMissingError(excp)
 
     @staticmethod

src/redfish/ris/resp_handler.py

@@ -81,8 +81,6 @@ def output_resp(self, response, dl_reg=False, verbosity=1):
 
         if response.status < 300 and (response._rest_request.method == "GET" or not response.read):
             # for rawget
-            if verbosity == 0:
-                verbosity = 1
             print_handler(
                 self.verbosity_levels(
                     message=message_text, response_status=response.status, verbosity=verbosity, dl_reg=dl_reg
@@ -285,7 +283,7 @@ def verbosity_levels(
                 + "\n"
             )
         else:
-            return "" + message + "\n"
+            return ""
 
     # unused? (removal pending)
     @staticmethod

src/redfish/ris/ris.py

@@ -40,6 +40,8 @@
 import jsonpointer
 from jsonpointer import set_pointer
 from six.moves.urllib.parse import urlparse, urlunparse
+from six.moves.urllib.parse import ParseResult
+from six.moves.urllib.parse import quote
 
 from redfish.rest.containers import RestRequest, StaticRestResponse
 from redfish.ris.ris_threaded import LoadWorker
@@ -575,21 +577,20 @@ def _load(
         :type path_refresh: bool
         """
 
-        if path.endswith("?page=1") and not loadcomplete:
+        if (path.endswith("?page=1") or path.endswith(".json")) and not loadcomplete:
             # Don't download schemas in crawl unless we are loading absolutely everything
             return
         elif not includelogs and crawl:
             # Only include logs when asked as there can be an extreme amount of entries
             if "/log" in path.lower():
                 return
 
-        # TODO: need to find a better way to support non ascii characters
-        path = path.replace("|", "%7C")
-        # remove fragments
-        newpath = urlparse(path)
-        newpath = list(newpath[:])
-        newpath[-1] = ""
-        path = urlunparse(tuple(newpath))
+        # remove fragments and quote characters in path
+        p = urlparse(path)
+        p = ParseResult(
+            scheme=p.scheme, netloc=p.netloc, path=quote(p.path), params=p.params, query=p.query, fragment=""
+        )
+        path = urlunparse(p)
 
         if prevpath and prevpath != path:
             self.ctree[prevpath].update([path])
@@ -617,10 +618,8 @@ def _load(
 
         self.update_member(resp=resp, path=path, init=init)
 
-        fpath = (
-            lambda pa, path: path
-            if pa.endswith(self.typepath.defs.hrefstring) and pa.startswith((self.collstr, "Entries"))
-            else None
+        fpath = lambda pa, path: (
+            path if pa.endswith(self.typepath.defs.hrefstring) and pa.startswith((self.collstr, "Entries")) else None
         )
 
         if loadtype == "href":

src/redfish/ris/utils.py

@@ -115,6 +115,16 @@ def merge_dict(currdict, newdict):
 
         if isinstance(itemv1, Mapping) and isinstance(itemv2, Mapping):
             merge_dict(itemv1, itemv2)
+        elif isinstance(itemv1, list) and isinstance(itemv2, list):
+            j = 0
+            for i in itemv2:
+                if isinstance(i, dict):
+                    for k, v in i.items():
+                        if k not in [d.keys() for d in itemv1]:
+                            itemv1[j][k] = v
+                            j = j + 1
+                else:
+                    itemv1.append(i)
         else:
             currdict[k] = itemv2