Merge pull request #103 from Intergration-Automation-Testing/dev

Dev

Author: JE-Chen

.idea/workspace.xml

@@ -1,12 +1,12 @@
-# Rename to build stable version
-# This is stable version
+# Rename to build dev version
+# This is dev version
 [build-system]
-requires = ["setuptools>=61.0"]
+requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "je_auto_control"
-version = "0.0.139"
+name = "je_auto_control_dev"
+version = "0.0.77"
 authors = [
     { name = "JE-Chen", email = "[email protected]" },
 ]

stable.toml dev.tomlstable.toml renamed to dev.toml

@@ -96,31 +96,25 @@
 from je_auto_control.wrapper.auto_control_screen import screenshot
 # import screen
 from je_auto_control.wrapper.auto_control_screen import screen_size
+# Shell command
+from je_auto_control.utils.shell_process.shell_exec import ShellManager
+from je_auto_control.utils.shell_process.shell_exec import default_shell_manager
+# Start exe
+from je_auto_control.utils.start_exe.start_another_process import start_exe
 
 __all__ = [
     "click_mouse", "mouse_keys_table", "get_mouse_position", "press_mouse", "release_mouse",
     "mouse_scroll", "set_mouse_position", "special_mouse_keys_table",
     "keyboard_keys_table", "press_keyboard_key", "release_keyboard_key", "type_keyboard", "check_key_is_press",
-    "write", "hotkey",
-    "screen_size", "screenshot",
-    "locate_all_image", "locate_image_center", "locate_and_click",
-    "CriticalExit",
-    "AutoControlException", "AutoControlKeyboardException",
+    "write", "hotkey", "start_exe",
+    "screen_size", "screenshot", "locate_all_image", "locate_image_center", "locate_and_click",
+    "CriticalExit", "AutoControlException", "AutoControlKeyboardException",
     "AutoControlMouseException", "AutoControlCantFindKeyException",
-    "AutoControlScreenException", "ImageNotFoundException",
-    "AutoControlJsonActionException", "AutoControlRecordException",
-    "AutoControlActionNullException", "AutoControlActionException",
-    "record", "stop_record",
-    "read_action_json", "write_action_json",
-    "execute_action", "execute_files", "executor", "add_command_to_executor",
-    "multiprocess_timeout", "test_record_instance",
-    "screenshot",
-    "pil_screenshot",
-    "generate_html", "generate_html_report",
-    "generate_json", "generate_json_report",
-    "generate_xml", "generate_xml_report",
-    "get_dir_files_as_list", "create_project_dir",
-    "start_autocontrol_socket_server",
-    "callback_executor", "package_manager",
-    "get_special_table"
+    "AutoControlScreenException", "ImageNotFoundException", "AutoControlJsonActionException",
+    "AutoControlRecordException", "AutoControlActionNullException", "AutoControlActionException", "record",
+    "stop_record", "read_action_json", "write_action_json", "execute_action", "execute_files", "executor",
+    "add_command_to_executor", "multiprocess_timeout", "test_record_instance", "screenshot", "pil_screenshot",
+    "generate_html", "generate_html_report", "generate_json", "generate_json_report", "generate_xml",
+    "generate_xml_report", "get_dir_files_as_list", "create_project_dir", "start_autocontrol_socket_server",
+    "callback_executor", "package_manager", "get_special_table", "ShellManager", "default_shell_manager",
 ]

je_auto_control/__init__.py

@@ -1,13 +1,13 @@
 import typing
 from sys import stderr
 
-from je_auto_control.utils.project.create_project_structure import create_project_dir
+from je_auto_control.utils.shell_process.shell_exec import ShellManager
+from je_auto_control.utils.start_exe.start_another_process import start_exe
 from je_auto_control.utils.exception.exception_tags import get_bad_trigger_method, get_bad_trigger_function
 from je_auto_control.utils.exception.exceptions import CallbackExecutorException
 # executor
 from je_auto_control.utils.executor.action_executor import execute_action
 from je_auto_control.utils.executor.action_executor import execute_files
-from je_auto_control.utils.project.create_project_structure import create_project_dir
 # file process
 from je_auto_control.utils.file_process.get_dir_file_list import get_dir_files_as_list
 # html report
@@ -25,6 +25,7 @@
 from je_auto_control.utils.json.json_file import write_action_json
 from je_auto_control.utils.package_manager.package_manager_class import \
     package_manager
+from je_auto_control.utils.project.create_project_structure import create_project_dir
 # socket server
 from je_auto_control.utils.socket_server.auto_control_socket_server import start_autocontrol_socket_server
 # test record
@@ -111,7 +112,11 @@ def __init__(self):
             "add_package_to_executor": package_manager.add_package_to_executor,
             "add_package_to_callback_executor": package_manager.add_package_to_callback_executor,
             # project
-            "create_project": create_project_dir
+            "create_project": create_project_dir,
+            # Shell
+            "shell_command": ShellManager().exec_shell,
+            # Another process
+            "execute_process": start_exe,
         }
 
     def callback_function(

je_auto_control/utils/callback/callback_function_executor.py

@@ -59,3 +59,5 @@
 # Callback executor
 get_bad_trigger_method: str = "get bad trigger method, only accept kwargs and args"
 get_bad_trigger_function: str = "get bad trigger function only accept function in event_dict"
+# Can't find file
+can_not_find_file: str = "Can not find file"

je_auto_control/utils/exception/exception_tags.py

@@ -1,10 +1,10 @@
+import builtins
 import sys
-import time
 import types
-import builtins
 from inspect import getmembers, isbuiltin
 
-from je_auto_control.utils.project.create_project_structure import create_project_dir
+from je_auto_control.utils.start_exe.start_another_process import start_exe
+from je_auto_control.utils.shell_process.shell_exec import ShellManager
 from je_auto_control.utils.exception.exception_tags import action_is_null_error, add_command_exception_tag, \
     executor_list_error
 from je_auto_control.utils.exception.exception_tags import cant_execute_action_error
@@ -18,6 +18,7 @@
 from je_auto_control.utils.generate_report.generate_xml_report import generate_xml_report
 from je_auto_control.utils.json.json_file import read_action_json
 from je_auto_control.utils.package_manager.package_manager_class import package_manager
+from je_auto_control.utils.project.create_project_structure import create_project_dir
 from je_auto_control.utils.test_record.record_test_class import record_action_to_list, test_record_instance
 from je_auto_control.wrapper.auto_control_image import locate_all_image, locate_and_click, locate_image_center
 from je_auto_control.wrapper.auto_control_keyboard import check_key_is_press
@@ -82,7 +83,11 @@ def __init__(self):
             "add_package_to_executor": package_manager.add_package_to_executor,
             "add_package_to_callback_executor": package_manager.add_package_to_callback_executor,
             # project
-            "create_project": create_project_dir
+            "create_project": create_project_dir,
+            # Shell
+            "shell_command": ShellManager().exec_shell,
+            # Another process
+            "execute_process": start_exe,
         }
         # get all builtin function and add to event dict
         for function in getmembers(builtins, isbuiltin):

je_auto_control/utils/executor/action_executor.py

@@ -0,0 +1,127 @@
+import queue
+import shlex
+import subprocess
+import sys
+from threading import Thread
+
+
+class ShellManager(object):
+
+    def __init__(
+            self,
+            shell_encoding: str = "utf-8",
+            program_buffer: int = 10240000,
+    ):
+        """
+        :param shell_encoding: shell command read output encoding
+        :param program_buffer: buffer size
+        """
+        self.read_program_error_output_from_thread = None
+        self.read_program_output_from_thread = None
+        self.still_run_shell: bool = True
+        self.process = None
+        self.run_output_queue: queue = queue.Queue()
+        self.run_error_queue: queue = queue.Queue()
+        self.program_encoding: str = shell_encoding
+        self.program_buffer: int = program_buffer
+
+    def exec_shell(self, shell_command: [str, list]) -> None:
+        """
+        :param shell_command: shell command will run
+        :return: if error return result and True else return result and False
+        """
+        try:
+            self.exit_program()
+            if sys.platform in ["win32", "cygwin", "msys"]:
+                args = shell_command
+            else:
+                args = shlex.split(shell_command)
+            self.process = subprocess.Popen(
+                args=args,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+                shell=True,
+            )
+            self.still_run_shell = True
+            # program output message queue thread
+            self.read_program_output_from_thread = Thread(
+                target=self.read_program_output_from_process,
+                daemon=True
+            )
+            self.read_program_output_from_thread.start()
+            # program error message queue thread
+            self.read_program_error_output_from_thread = Thread(
+                target=self.read_program_error_output_from_process,
+                daemon=True
+            )
+            self.read_program_error_output_from_thread.start()
+        except Exception as error:
+            print(repr(error), file=sys.stderr)
+
+    # tkinter_ui update method
+    def pull_text(self) -> None:
+        try:
+            if not self.run_error_queue.empty():
+                error_message = self.run_error_queue.get_nowait()
+                error_message = str(error_message).strip()
+                if error_message:
+                    print(error_message, file=sys.stderr)
+            if not self.run_output_queue.empty():
+                output_message = self.run_output_queue.get_nowait()
+                output_message = str(output_message).strip()
+                if output_message:
+                    print(output_message)
+        except queue.Empty:
+            pass
+        if self.process.returncode == 0:
+            self.exit_program()
+        elif self.process.returncode is not None:
+            self.exit_program()
+        if self.still_run_shell:
+            # poll return code
+            self.process.poll()
+
+    # exit program change run flag to false and clean read thread and queue and process
+    def exit_program(self) -> None:
+        self.still_run_shell = False
+        if self.read_program_output_from_thread is not None:
+            self.read_program_output_from_thread = None
+        if self.read_program_error_output_from_thread is not None:
+            self.read_program_error_output_from_thread = None
+        self.print_and_clear_queue()
+        if self.process is not None:
+            self.process.terminate()
+            print(f"Shell command exit with code {self.process.returncode}")
+            self.process = None
+
+    def print_and_clear_queue(self) -> None:
+        try:
+            for std_output in iter(self.run_output_queue.get_nowait, None):
+                std_output = str(std_output).strip()
+                if std_output:
+                    print(std_output)
+            for std_err in iter(self.run_error_queue.get_nowait, None):
+                std_err = str(std_err).strip()
+                if std_err:
+                    print(std_err, file=sys.stderr)
+        except queue.Empty:
+            pass
+        self.run_output_queue = queue.Queue()
+        self.run_error_queue = queue.Queue()
+
+    def read_program_output_from_process(self) -> None:
+        while self.still_run_shell:
+            program_output_data = self.process.stdout.raw.read(
+                self.program_buffer) \
+                .decode(self.program_encoding)
+            self.run_output_queue.put_nowait(program_output_data)
+
+    def read_program_error_output_from_process(self) -> None:
+        while self.still_run_shell:
+            program_error_output_data = self.process.stderr.raw.read(
+                self.program_buffer) \
+                .decode(self.program_encoding)
+            self.run_error_queue.put_nowait(program_error_output_data)
+
+
+default_shell_manager = ShellManager()

je_auto_control/utils/shell_process/__init__.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+
+from je_auto_control.utils.exception.exception_tags import can_not_find_file
+from je_auto_control.utils.exception.exceptions import AutoControlException
+
+from je_auto_control.utils.shell_process.shell_exec import ShellManager
+
+
+def start_exe(exe_path: str):
+    exe_path = Path(exe_path)
+    if exe_path.exists() and exe_path.is_file():
+        process_manager = ShellManager()
+        process_manager.exec_shell(str(exe_path))
+    else:
+        raise AutoControlException(can_not_find_file)