Merge pull request #70 from Integrated-Testing-Environment/dev

JE-Chen · web-flow · commit 2b812289a349 · 2023-03-31T16:50:56.000+08:00
Dev
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -103,6 +103,10 @@ jobs:
       - run:
           command: python ./test/gui_test/image/locate_image_center.py
           name: locate_image_center_test
+      # callback test
+      - run:
+          command: python ./test/unit_test/callback/callback_test.py
+          name: callback_test
 
       # integrated_test
       # can't run this because circle ci bug
@@ -210,7 +214,10 @@ jobs:
       - run:
           command: python ./test/unit_test/argparse/argparse_test.py
           name: argparse_test
-
+      # callback test
+      - run:
+          command: python ./test/unit_test/callback/callback_test.py
+          name: callback_test
 
       # integrated_test
       # can't run this because circle ci bug
diff --git a/.github/workflows/auto-control-github-actions_dev.yml b/.github/workflows/auto-control-github-actions_dev.yml
@@ -74,4 +74,7 @@ jobs:
         run: python ./test/unit_test/argparse/argparse_test.py
         # html report test
       - name: html_report_test
-        run: python ./test/unit_test/generate_report/html_report_test.py
+        run: python ./test/unit_test/generate_report/html_report_test.py
+        # call back test
+      - name: call back test
+        run: python ./test/unit_test/callback/callback_test.py
diff --git a/.github/workflows/auto-control-github-actions_stable.yml b/.github/workflows/auto-control-github-actions_stable.yml
@@ -74,4 +74,7 @@ jobs:
         run: python ./test/unit_test/argparse/argparse_test.py
         # html report test
       - name: html_report_test
-        run: python ./test/unit_test/generate_report/html_report_test.py
+        run: python ./test/unit_test/generate_report/html_report_test.py
+        # call back test
+      - name: call back test
+        run: python ./test/unit_test/callback/callback_test.py
diff --git a/.idea/Python_JEAutoControl.iml b/.idea/Python_JEAutoControl.iml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@
 
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/db0f6e626a614f67bf2b6b1f54325a24)](https://www.codacy.com/gh/JE-Chen/AutoControl/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=JE-Chen/AutoControl&amp;utm_campaign=Badge_Grade)
 
-[![CircleCI](https://circleci.com/gh/JE-Chen/AutoControl/tree/main.svg?style=svg)](https://circleci.com/gh/JE-Chen/AutoControl/tree/main)
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/Integrated-Testing-Environment/AutoControl/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/Integrated-Testing-Environment/AutoControl/tree/main)
 
 [![AutoControl GitHub Actions Dev](https://github.com/JE-Chen/AutoControl/actions/workflows/auto-control-github-actions_dev.yml/badge.svg)](https://github.com/JE-Chen/AutoControl/actions/workflows/auto-control-github-actions_dev.yml)
 
diff --git a/dev.toml b/dev.toml
@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "je_auto_control_dev"
-version = "0.0.55"
+version = "0.0.56"
 authors = [
     { name = "JE-Chen", email = "zenmailman@gmail.com" },
 ]
diff --git a/je_auto_control/__init__.py b/je_auto_control/__init__.py
@@ -69,6 +69,8 @@
 # xml
 from je_auto_control.utils.generate_report.generate_xml_report import generate_xml
 from je_auto_control.utils.generate_report.generate_xml_report import generate_xml_report
+# callback
+from je_auto_control.utils.callback.callback_function_executor import callback_executor
 
 __all__ = [
     "click_mouse", "mouse_table", "position", "press_mouse", "release_mouse",
@@ -92,5 +94,6 @@
     "generate_html", "generate_html_report",
     "generate_json", "generate_json_report",
     "generate_xml", "generate_xml_report",
-    "get_dir_files_as_list", "create_template_dir", "start_autocontrol_socket_server"
+    "get_dir_files_as_list", "create_template_dir", "start_autocontrol_socket_server",
+    "callback_executor"
 ]
diff --git a/je_auto_control/utils/callback/__init__.py b/je_auto_control/utils/callback/__init__.py
diff --git a/je_auto_control/utils/callback/callback_function_executor.py b/je_auto_control/utils/callback/callback_function_executor.py
@@ -0,0 +1,146 @@
+import typing
+from sys import stderr
+
+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.file_process.create_project_structure import create_template_dir
+# file process
+from je_auto_control.utils.file_process.get_dir_file_list import get_dir_files_as_list
+# html report
+from je_auto_control.utils.generate_report.generate_html_report import generate_html
+from je_auto_control.utils.generate_report.generate_html_report import generate_html_report
+from je_auto_control.utils.generate_report.generate_json_report import generate_json
+from je_auto_control.utils.generate_report.generate_json_report import generate_json_report
+# xml
+from je_auto_control.utils.generate_report.generate_xml_report import generate_xml
+from je_auto_control.utils.generate_report.generate_xml_report import generate_xml_report
+# utils image
+from je_auto_control.utils.image.screenshot import pil_screenshot
+# json
+from je_auto_control.utils.json.json_file import read_action_json
+from je_auto_control.utils.json.json_file import write_action_json
+# socket server
+from je_auto_control.utils.socket_server.auto_control_socket_server import start_autocontrol_socket_server
+# test record
+from je_auto_control.utils.test_record.record_test_class import test_record_instance
+# import image
+from je_auto_control.wrapper.auto_control_image import locate_all_image
+from je_auto_control.wrapper.auto_control_image import locate_and_click
+from je_auto_control.wrapper.auto_control_image import locate_image_center
+from je_auto_control.wrapper.auto_control_keyboard import check_key_is_press
+from je_auto_control.wrapper.auto_control_keyboard import hotkey
+# import keyboard
+from je_auto_control.wrapper.auto_control_keyboard import keys_table
+from je_auto_control.wrapper.auto_control_keyboard import press_key
+from je_auto_control.wrapper.auto_control_keyboard import release_key
+from je_auto_control.wrapper.auto_control_keyboard import type_key
+from je_auto_control.wrapper.auto_control_keyboard import write
+# import mouse
+from je_auto_control.wrapper.auto_control_mouse import click_mouse
+from je_auto_control.wrapper.auto_control_mouse import mouse_table
+from je_auto_control.wrapper.auto_control_mouse import position
+from je_auto_control.wrapper.auto_control_mouse import press_mouse
+from je_auto_control.wrapper.auto_control_mouse import release_mouse
+from je_auto_control.wrapper.auto_control_mouse import scroll
+from je_auto_control.wrapper.auto_control_mouse import set_position
+from je_auto_control.wrapper.auto_control_mouse import special_table
+# test_record
+from je_auto_control.wrapper.auto_control_record import record
+from je_auto_control.wrapper.auto_control_record import stop_record
+from je_auto_control.wrapper.auto_control_screen import screenshot
+# import screen
+from je_auto_control.wrapper.auto_control_screen import size
+
+
+class CallbackFunctionExecutor(object):
+
+    def __init__(self):
+        self.event_dict: dict = {
+            # mouse
+            "mouse_left": click_mouse,
+            "mouse_right": click_mouse,
+            "mouse_middle": click_mouse,
+            "click_mouse": click_mouse,
+            "mouse_table": mouse_table,
+            "position": position,
+            "press_mouse": press_mouse,
+            "release_mouse": release_mouse,
+            "scroll": scroll,
+            "set_position": set_position,
+            "special_table": special_table,
+            # keyboard
+            "keys_table": keys_table,
+            "type_key": type_key,
+            "press_key": press_key,
+            "release_key": release_key,
+            "check_key_is_press": check_key_is_press,
+            "write": write,
+            "hotkey": hotkey,
+            # image
+            "locate_all_image": locate_all_image,
+            "locate_image_center": locate_image_center,
+            "locate_and_click": locate_and_click,
+            # screen
+            "size": size,
+            "screenshot": screenshot,
+            # test record
+            "set_record_enable": test_record_instance.set_record_enable,
+            # only generate
+            "generate_html": generate_html,
+            "generate_json": generate_json,
+            "generate_xml": generate_xml,
+            # generate report
+            "generate_html_report": generate_html_report,
+            "generate_json_report": generate_json_report,
+            "generate_xml_report": generate_xml_report,
+            # record
+            "record": record,
+            "stop_record": stop_record,
+            "execute_action": execute_action,
+            "execute_files": execute_files,
+            "create_template_dir": create_template_dir,
+            "get_dir_files_as_list": get_dir_files_as_list,
+            "pil_screenshot": pil_screenshot,
+            "read_action_json": read_action_json,
+            "write_action_json": write_action_json,
+            "start_autocontrol_socket_server": start_autocontrol_socket_server,
+
+        }
+
+    def callback_function(
+            self,
+            trigger_function_name: str,
+            callback_function: typing.Callable,
+            callback_function_param: dict,
+            callback_param_method: str = "kwargs",
+            **kwargs
+    ):
+        """
+        :param trigger_function_name: what function we want to trigger only accept function in event_dict
+        :param callback_function: what function we want to callback
+        :param callback_function_param: callback function's param only accept dict 
+        :param callback_param_method: what type param will use on callback function only accept kwargs and args
+        :param kwargs: trigger_function's param
+        :return: 
+        """
+        try:
+            if trigger_function_name not in self.event_dict.keys():
+                raise CallbackExecutorException(get_bad_trigger_function)
+            execute_return_value = self.event_dict.get(trigger_function_name)(**kwargs)
+            if callback_param_method not in ["kwargs", "args"]:
+                raise CallbackExecutorException(get_bad_trigger_method)
+            if callback_param_method == "kwargs":
+                callback_function(**callback_function_param)
+            else:
+                callback_function(*callback_function_param.values())
+            return execute_return_value
+        except Exception as error:
+            print(repr(error), file=stderr)
+
+
+callback_executor = CallbackFunctionExecutor()
+
+
diff --git a/je_auto_control/utils/exception/exception_tags.py b/je_auto_control/utils/exception/exception_tags.py
@@ -56,3 +56,6 @@
 # XML
 cant_read_xml_error: str = "can't read xml"
 xml_type_error: str = "xml type error"
+# 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"
diff --git a/je_auto_control/utils/exception/exceptions.py b/je_auto_control/utils/exception/exceptions.py
@@ -97,3 +97,8 @@ class XMLException(AutoControlException):
 
 class XMLTypeException(XMLException):
     pass
+
+
+# Execute callback
+class CallbackExecutorException(AutoControlException):
+    pass
diff --git a/je_auto_control/utils/executor/action_executor.py b/je_auto_control/utils/executor/action_executor.py
@@ -25,6 +25,7 @@
 from je_auto_control.utils.generate_report.generate_xml_report import generate_xml
 from je_auto_control.utils.generate_report.generate_xml_report import generate_xml_report
 
+
 class Executor(object):
 
     def __init__(self):
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "je_auto_control"
-version = "0.0.122"
+version = "0.0.123"
 authors = [
     { name = "JE-Chen", email = "zenmailman@gmail.com" },
 ]
diff --git a/test/unit_test/callback/callback_test.py b/test/unit_test/callback/callback_test.py
@@ -0,0 +1,12 @@
+from je_auto_control import callback_executor
+
+# trigger_function will first to execute, but return value need to wait everything done
+# so this test will first print("test") then print(size_function_return_value)
+print(
+    callback_executor.callback_function(
+        trigger_function_name="size",
+        callback_function=print,
+        callback_param_method="args",
+        callback_function_param={"": "test"}
+    )
+)

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"`
`6`	`6`
`7`	`7`	`[project]`
`8`	`8`	`name = "je_auto_control_dev"`
`9`		`-version = "0.0.55"`
	`9`	`+version = "0.0.56"`
`10`	`10`	`authors = [`
`11`	`11`	`{ name = "JE-Chen", email = "zenmailman@gmail.com" },`
`12`	`12`	`]`