Upgrade AgentOSCMD def (flag to send logs to the ORC and encoding of the CMD window)

Sources/pyOpenRPA/Agent/__Agent__.py

@@ -24,10 +24,20 @@ def OSFileTextDataStrCreate(inFilePathStr, inFileDataStr, inEncodingStr = "utf-8
     A2O.LogListSend(inGSettings=inGSettings, inLogList=[lMessageStr])
 
 # Send CMD to OS. Result return to log + Orchestrator by the A2O connection
-def OSCMD(inCMDStr, inRunAsyncBool=True, inGSettings = None):
+def OSCMD(inCMDStr, inRunAsyncBool=True, inGSettings = None, inSendOutputToOrchestratorLogsBool = True, inCMDEncodingStr = "cp1251"):
+    """
+    Execute CMD on the Agent daemonic process
+
+    :param inCMDStr: command to execute on the Agent session
+    :param inRunAsyncBool: True - Agent processor don't wait execution; False - Agent processor wait cmd execution
+    :param inGSettings: Agent global settings dict
+    :param inSendOutputToOrchestratorLogsBool: True - catch cmd execution output and send it to the Orchestrator logs; Flase - else case; Default True
+    :param inCMDEncodingStr: Set the encoding of the DOS window on the Agent server session. Windows is beautiful :) . Default is "cp1251" early was "cp866" - need test
+    :return:
+    """
     lResultStr = ""
     # Subdef to listen OS result
-    def _CMDRunAndListenLogs(inCMDStr, inGSettings = None):
+    def _CMDRunAndListenLogs(inCMDStr, inSendOutputToOrchestratorLogsBool, inCMDEncodingStr,  inGSettings = None):
         lL = inGSettings.get("Logger",None) if type(inGSettings) is dict else None
         lResultStr = ""
         lOSCMDKeyStr = str(uuid.uuid4())[0:4].upper()
@@ -43,11 +53,11 @@ def OSCMD(inCMDStr, inRunAsyncBool=True, inGSettings = None):
             lOutputLineBytes = lCMDProcess.stdout.readline()
             if lOutputLineBytes == b"":
                 lListenBool = False
-            lStr = lOutputLineBytes.decode('cp866')
+            lStr = lOutputLineBytes.decode(inCMDEncodingStr) # was cp866, on win server don't work properly - set cp1251
             if lStr.endswith("\n"): lStr = lStr[:-1]
             lMessageStr = f"{lOSCMDKeyStr}: {lStr}"
             if lL: lL.info(lMessageStr)
-            A2O.LogListSend(inGSettings=inGSettings, inLogList=[lMessageStr])
+            if inSendOutputToOrchestratorLogsBool: A2O.LogListSend(inGSettings=inGSettings, inLogList=[lMessageStr])
             lResultStr+=lStr
         lMessageStr = f"{lOSCMDKeyStr}: # # # # AGENT CMD Process has been FINISHED # # # # "
         if lL: lL.info(lMessageStr)
@@ -55,11 +65,11 @@ def OSCMD(inCMDStr, inRunAsyncBool=True, inGSettings = None):
         return lResultStr
     # New call
     if inRunAsyncBool:
-        lThread = threading.Thread(target=_CMDRunAndListenLogs, kwargs={"inCMDStr":inCMDStr, "inGSettings":inGSettings})
+        lThread = threading.Thread(target=_CMDRunAndListenLogs, kwargs={"inCMDStr":inCMDStr, "inGSettings":inGSettings, "inSendOutputToOrchestratorLogsBool":inSendOutputToOrchestratorLogsBool, "inCMDEncodingStr":inCMDEncodingStr })
         lThread.start()
         lResultStr="ActivityList has been started in async mode - no output is available here."
     else:
-        lResultStr = _CMDRunAndListenLogs(inCMDStr=inCMDStr, inGSettings=inGSettings)
+        lResultStr = _CMDRunAndListenLogs(inCMDStr=inCMDStr, inGSettings=inGSettings, inSendOutputToOrchestratorLogsBool = inSendOutputToOrchestratorLogsBool, inCMDEncodingStr = inCMDEncodingStr)
     #lCMDCode = "cmd /c " + inCMDStr
     #subprocess.Popen(lCMDCode)
     #lResultCMDRun = 1  # os.system(lCMDCode)

Sources/pyOpenRPA/Orchestrator/__Orchestrator__.py

@@ -44,20 +44,24 @@ def AgentActivityItemAdd(inGSettings, inHostNameStr, inUserStr, inActivityItemDi
     lThisAgentDict["ActivityList"].append(inActivityItemDict)
 
 
-def AgentOSCMD(inGSettings, inHostNameStr, inUserStr, inCMDStr, inRunAsyncBool=True):
+def AgentOSCMD(inGSettings, inHostNameStr, inUserStr, inCMDStr, inRunAsyncBool=True, inSendOutputToOrchestratorLogsBool=True, inCMDEncodingStr="cp1251"):
     """
     Send CMD to OS thought the pyOpenRPA.Agent daemon. Result return to log + Orchestrator by the A2O connection
 
     :param inGSettings: Global settings dict (singleton)
-    :param inHostNameStr:
-    :param inUserStr:
-    :param inCMDStr:
-    :param inRunAsyncBool:
+    :param inHostNameStr: Agent host name in upper case (example "RPA01", "RPA_99" and so on). Active agent session you can see on the orchestrator dashboard as Orchestrator admin
+    :param inUserStr: Agent user name in upper case (example "UserRPA"). Active agent session you can see on the orchestrator dashboard as Orchestrator admin
+    :param inCMDStr: command to execute on the Agent session
+    :param inRunAsyncBool: True - Agent processor don't wait execution; False - Agent processor wait cmd execution
+    :param inSendOutputToOrchestratorLogsBool: True - catch cmd execution output and send it to the Orchestrator logs; Flase - else case; Default True
+    :param inCMDEncodingStr: Set the encoding of the DOS window on the Agent server session. Windows is beautiful :) . Default is "cp1251" early was "cp866" - need test
+
     """
+
     lActivityItemDict = {
         "Def":"OSCMD", # def alias (look pyOpeRPA.Agent gSettings["ProcessorDict"]["AliasDefDict"])
         "ArgList":[], # Args list
-        "ArgDict":{"inCMDStr":inCMDStr,"inRunAsyncBool":inRunAsyncBool}, # Args dictionary
+        "ArgDict":{"inCMDStr":inCMDStr,"inRunAsyncBool":inRunAsyncBool, "inSendOutputToOrchestratorLogsBool": inSendOutputToOrchestratorLogsBool, "inCMDEncodingStr": inCMDEncodingStr}, # Args dictionary
         "ArgGSettings": "inGSettings", # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
         "ArgLogger": None # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
     }