Merge pull request #193 from DMTF/Fix191-Auto-Task-Handling

Added new global config to automatically internalize task monitoring for select operations

Author: mraineri

redfish_utilities/accounts.py

@@ -9,23 +9,25 @@
 File : accounts.py
 
 Brief : This file contains the definitions and functionalities for managing
-        accounts on a Redfish Service
+        accounts on a Redfish service
 """
 
 from .messages import verify_response
+from .tasks import poll_task_monitor
+from . import config
 
 
 class RedfishAccountCollectionNotFoundError(Exception):
     """
-    Raised when the Account Service or Account Collection cannot be found
+    Raised when the account service or account collection cannot be found
     """
 
     pass
 
 
 class RedfishAccountNotFoundError(Exception):
     """
-    Raised when the Account Service or Account Collection cannot be found
+    Raised when the account service or account collection cannot be found
     """
 
     pass
@@ -52,7 +54,7 @@ def get_users(context):
 
     user_list = []
 
-    # Go through each Account in the Account Collection
+    # Go through each account in the account collection
     account_col = context.get(get_account_collection(context), None)
     for account_member in account_col.dict["Members"]:
         account = context.get(account_member["@odata.id"], None)
@@ -128,6 +130,8 @@ def add_user(context, user_name, password, role):
                     user_name
                 )
             )
+    if config.__auto_task_handling__:
+        response = poll_task_monitor(context, response, silent=True)
     verify_response(response)
     return response
 
@@ -154,6 +158,8 @@ def delete_user(context, user_name):
         # Some also do not allow for both Enabled and UserName to be modified simultaneously
         modify_user(context, user_name, new_enabled=False)
         return modify_user(context, user_name, new_name="")
+    if config.__auto_task_handling__:
+        response = poll_task_monitor(context, response, silent=True)
     verify_response(response)
     return response
 
@@ -203,6 +209,8 @@ def modify_user(
 
     # Update the user
     response = context.patch(user_uri, body=new_info, headers={"If-Match": user_info.getheader("ETag")})
+    if config.__auto_task_handling__:
+        response = poll_task_monitor(context, response, silent=True)
     verify_response(response)
     return response
 
@@ -218,17 +226,17 @@ def get_account_collection(context):
         The URI for the account collection
     """
 
-    # Get the Service Root to find the Account Service
+    # Get the service root to find the account service
     service_root = context.get("/redfish/v1")
     if "AccountService" not in service_root.dict:
-        # No Account Service
-        raise RedfishAccountCollectionNotFoundError("Service does not contain an Account Service")
+        # No account service
+        raise RedfishAccountCollectionNotFoundError("Service does not contain an account service")
 
-    # Get the Account Service to find the Account Collection
+    # Get the account service to find the account collection
     account_service = context.get(service_root.dict["AccountService"]["@odata.id"])
     if "Accounts" not in account_service.dict:
         # No Account Collection
-        raise RedfishAccountCollectionNotFoundError("Service does not contain an Account Collection")
+        raise RedfishAccountCollectionNotFoundError("Service does not contain an account collection")
 
     return account_service.dict["Accounts"]["@odata.id"]
 

redfish_utilities/config.py

@@ -9,9 +9,14 @@
 File : config.py
 
 Brief : This file contains configuration settings for the module; useful for
-        debugging issues encountered on live systems
+        debugging issues encountered on live systems or configuring global
+        options.
 """
 
 # Leverage known workarounds for non-conformant services, such as bypassing
 # unexpected 4XX responses, missing properties, and malformed URIs
 __workarounds__ = False
+
+# Automate task handling for POST/PATCH/PUT/DELETE operations that should
+# always be "fast"
+__auto_task_handling__ = False

redfish_utilities/tasks.py

@@ -16,14 +16,15 @@
 import time
 
 
-def poll_task_monitor(context, response):
+def poll_task_monitor(context, response, silent=False):
     """
     Monitors a task monitor until it's complete and prints out progress
     NOTE: This call will block until the task is complete
 
     Args:
         context: The Redfish client object with an open session
         response: The initial response from the operation that produced the task
+        silent: Indicates if the task progress is to be hidden
 
     Returns:
         The final response of the request
@@ -37,23 +38,24 @@ def poll_task_monitor(context, response):
     task_monitor = response
     while task_monitor.is_processing:
         # Print the progress
-        task_state = None
-        task_percent = None
-        try:
-            task_state = task_monitor.dict.get("TaskState", None)
-            task_percent = task_monitor.dict.get("PercentComplete", None)
-        except Exception:
-            # 202 responses are allowed to not have a response body
-            pass
-        if task_state is None:
-            task_state = "Running"
-        if task_percent is None:
-            progress_str = "Task is {}\r".format(task_state)
-        else:
-            progress_str = "Task is {}: {}% complete\r".format(task_state, task_percent)
-        sys.stdout.write("\x1b[2K")
-        sys.stdout.write(progress_str)
-        sys.stdout.flush()
+        if silent is False:
+            task_state = None
+            task_percent = None
+            try:
+                task_state = task_monitor.dict.get("TaskState", None)
+                task_percent = task_monitor.dict.get("PercentComplete", None)
+            except Exception:
+                # 202 responses are allowed to not have a response body
+                pass
+            if task_state is None:
+                task_state = "Running"
+            if task_percent is None:
+                progress_str = "Task is {}\r".format(task_state)
+            else:
+                progress_str = "Task is {}: {}% complete\r".format(task_state, task_percent)
+            sys.stdout.write("\x1b[2K")
+            sys.stdout.write(progress_str)
+            sys.stdout.flush()
 
         # Sleep for the requested time
         retry_time = response.retry_after
@@ -63,7 +65,8 @@ def poll_task_monitor(context, response):
 
         # Check the monitor for an update
         task_monitor = response.monitor(context)
-    sys.stdout.write("\x1b[2K")
-    print("Task is Done!")
+    if silent is False:
+        sys.stdout.write("\x1b[2K")
+        print("Task is Done!")
 
     return task_monitor

scripts/rf_accounts.py

@@ -54,6 +54,9 @@
 argget.add_argument("--debug", action="store_true", help="Creates debug file showing HTTP traces and exceptions")
 args = argget.parse_args()
 
+# Always let the calls for account management block until the underlying task is complete
+redfish_utilities.config.__auto_task_handling__ = True
+
 if args.debug:
     log_file = "rf_accounts-{}.log".format(datetime.datetime.now().strftime("%Y-%m-%d-%H%M%S"))
     log_format = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"