Command Executor : Invalid response_data when executed script fails

* Modified command exec returned value in case of failure during execution. It now prints the response_data defined by the user
* Modified truncation method of the gRPC returned object to use ByteSize() to get the exact sizxe consumed within the buffer

Issue-ID: CCSDK-2501
Signed-off-by: Julien Fontaine <julien.fontaine@bell.ca>
Change-Id: Ie1db8db265623b5137ab3946ff4e3abda1c54a78

1 files changed, 24 insertions, 27 deletions

diff --git a/ms/command-executor/src/main/python/utils.py b/ms/command-executor/src/main/python/utils.py
index b98241629..180cd8c12 100644
--- a/ms/command-executor/src/main/python/utils.py
+++ b/ms/command-executor/src/main/python/utils.py
@@ -17,13 +17,12 @@ from google.protobuf.timestamp_pb2 import Timestamp
 
 import proto.CommandExecutor_pb2 as CommandExecutor_pb2
 import json
-from pympler import asizeof
 
 CDS_IS_SUCCESSFUL_KEY = "cds_is_successful"
 ERR_MSG_KEY = "err_msg"
 RESULTS_KEY = "results"
 RESULTS_LOG_KEY = "results_log"
-TRUNC_MSG_LEN = 3 * 1024 * 1024
+RESPONSE_MAX_SIZE = 4 * 1024 * 1024 # 4Mb
 
 def get_blueprint_id(request):
   blueprint_name = request.identifiers.blueprintName
@@ -34,44 +33,42 @@ def get_blueprint_id(request):
 def build_grpc_response(request_id, response):
   if response[CDS_IS_SUCCESSFUL_KEY]:
     status = CommandExecutor_pb2.SUCCESS
-    payload = json.dumps(response[RESULTS_KEY])
   else:
     status = CommandExecutor_pb2.FAILURE
-    # truncate error message if too heavy
-    if asizeof.asizeof(response[ERR_MSG_KEY]) > TRUNC_MSG_LEN:
-      response[ERR_MSG_KEY] = "{} [...]. Check command executor logs for more information.".format(response[ERR_MSG_KEY][:TRUNC_MSG_LEN])
-    payload = json.dumps(response[ERR_MSG_KEY])
 
-  # truncate cmd-exec logs if too heavy
-  response[RESULTS_LOG_KEY] = truncate_cmd_exec_logs(response[RESULTS_LOG_KEY])
+  response.pop(CDS_IS_SUCCESSFUL_KEY)
+  logs = response.pop(RESULTS_LOG_KEY)
+
+  # Payload should only contains response data returned from the executed script and/or the error message
+  payload = json.dumps(response)
 
   timestamp = Timestamp()
   timestamp.GetCurrentTime()
 
-  return CommandExecutor_pb2.ExecutionOutput(requestId=request_id,
-                                             response=response[RESULTS_LOG_KEY],
+  execution_output = CommandExecutor_pb2.ExecutionOutput(requestId=request_id,
+                                             response=logs,
                                              status=status,
                                              payload=payload,
                                              timestamp=timestamp)
 
-# build a ret data structure
-def build_ret_data(cds_is_successful, results={}, results_log=[], error=None):
+  return truncate_execution_output(execution_output)
+
+# build a ret data structure used to populate the ExecutionOutput
+def build_ret_data(cds_is_successful, results_log=[], error=None):
   ret_data = {
-            CDS_IS_SUCCESSFUL_KEY: cds_is_successful,
-            RESULTS_KEY: results,
-            RESULTS_LOG_KEY: results_log
-         }
+    CDS_IS_SUCCESSFUL_KEY: cds_is_successful,
+    RESULTS_LOG_KEY: results_log
+  }
   if error:
     ret_data[ERR_MSG_KEY] = error
   return ret_data
 
-def truncate_cmd_exec_logs(logs):
-    truncated_logs = []
-    truncated_logs_memsize = 0
-    for log in logs:
-        truncated_logs_memsize += asizeof.asizeof(log)
-        if truncated_logs_memsize > TRUNC_MSG_LEN:
-            truncated_logs.append("Execution logs exceeds the maximum size allowed. Check command executor logs to view the execute-command-logs.")
-            break
-        truncated_logs.append(log)
-    return truncated_logs
\ No newline at end of file
+# Truncate execution logs to make sure gRPC response doesn't exceed the gRPC buffer capacity
+def truncate_execution_output(execution_output):
+  sum_truncated_chars = 0
+  if execution_output.ByteSize() > RESPONSE_MAX_SIZE:
+    while execution_output.ByteSize() > RESPONSE_MAX_SIZE:
+        removed_item = execution_output.response.pop()
+        sum_truncated_chars += len(removed_item)
+    execution_output.response.append("[...] TRUNCATED CHARS : {}".format(sum_truncated_chars))
+  return execution_output
\ No newline at end of file