test-pioneer-dev 0.0.36__tar.gz

test_pioneer_dev-0.0.36/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 JE-Chen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

test_pioneer_dev-0.0.36/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.2
+Name: test_pioneer_dev
+Version: 0.0.36
+Summary: AutomationEditor for multi automation
+Author-email: JE-Chen <jechenmailman@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/Integration-Automation/TestPioneer
+Project-URL: Code, https://github.com/Integration-Automation/TestPioneer
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Environment :: MacOS X
+Classifier: Environment :: X11 Applications
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: je_auto_control
+Requires-Dist: je_web_runner
+Requires-Dist: je_load_density
+Requires-Dist: je_api_testka
+Requires-Dist: je-mail-thunder
+Requires-Dist: automation-file
+Requires-Dist: psutil
+
+# TestPioneer
+ 

test_pioneer_dev-0.0.36/README.md

@@ -0,0 +1,2 @@
+# TestPioneer
+ 

test_pioneer_dev-0.0.36/pyproject.toml

@@ -0,0 +1,43 @@
+# Rename to build stable version
+# This is stable version
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "test_pioneer_dev"
+version = "0.0.36"
+authors = [
+    { name = "JE-Chen", email = "jechenmailman@gmail.com" },
+]
+description = "AutomationEditor for multi automation"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+dependencies = [
+    "je_auto_control", "je_web_runner",
+    "je_load_density", "je_api_testka", "je-mail-thunder",
+    "automation-file", "psutil"
+]
+classifiers = [
+    "Programming Language :: Python :: 3.9",
+    "Development Status :: 2 - Pre-Alpha",
+    "Environment :: Win32 (MS Windows)",
+    "Environment :: MacOS X",
+    "Environment :: X11 Applications",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent"
+]
+
+[project.urls]
+Homepage = "https://github.com/Integration-Automation/TestPioneer"
+Code = "https://github.com/Integration-Automation/TestPioneer"
+
+[project.readme]
+file = "README.md"
+content-type = "text/markdown"
+
+[tool.setuptools]
+license-files = ["LICENSE"]
+
+[tool.setuptools.packages]
+find = { namespaces = false }

test_pioneer_dev-0.0.36/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

test_pioneer_dev-0.0.36/test_pioneer/__init__.py

@@ -0,0 +1,3 @@
+from test_pioneer.executor.pioneer_executor import execute_yaml
+
+__all__ = ["execute_yaml"]

test_pioneer_dev-0.0.36/test_pioneer/__main__.py

@@ -0,0 +1,19 @@
+import argparse
+
+from test_pioneer import execute_yaml
+from test_pioneer.exception.exceptions import ExecutorException
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument(
+        "-e", "--execute_yaml",
+        type=str, help="choose yaml file to execute"
+    )
+    args = parser.parse_args()
+    args = vars(args)
+    if args.get("execute_yaml"):
+        execute_yaml(args.get("execute_yaml"))
+    else:
+        raise ExecutorException(
+            f"execute_yaml have no argument right way to use: python -m test_pioneer. -e filepath")

test_pioneer_dev-0.0.36/test_pioneer/exception/exceptions.py

@@ -0,0 +1,14 @@
+class ExecutorException(Exception):
+    pass
+
+
+class YamlException(Exception):
+    pass
+
+
+class WrongInputException(Exception):
+    pass
+
+
+class ProjectException(Exception):
+    pass

test_pioneer_dev-0.0.36/test_pioneer/exception/tags.py

@@ -0,0 +1,3 @@
+wrong_yaml_tag = "Wrong yaml tag format"
+wrong_input = "Wrong input"
+cant_save_yaml_error = "Can't save yaml error"

test_pioneer_dev-0.0.36/test_pioneer/executor/pioneer_executor.py

@@ -0,0 +1,228 @@
+import io
+import time
+import webbrowser
+from pathlib import Path
+from typing import Union, Tuple
+
+import je_load_density
+import je_api_testka
+import je_auto_control
+import je_web_runner
+import yaml
+
+from test_pioneer.exception.exceptions import WrongInputException, YamlException, ExecutorException
+from test_pioneer.logging.loggin_instance import TestPioneerHandler, step_log_check, test_pioneer_logger
+from test_pioneer.process.execute_process import ExecuteProcess
+from test_pioneer.process.process_manager import process_manager_instance
+
+
+def check_with(step: dict, enable_logging: bool) -> Tuple[bool,
+    Union[je_auto_control.execute_files, je_web_runner.execute_files,
+    je_api_testka.execute_files, je_load_density.execute_files, None]]:
+    if step.get("with", None) is None:
+        step_log_check(
+            enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+            message=f"Step need with tag")
+        return False, None
+    with_tag = step.get("with")
+    if not isinstance(with_tag, str):
+        step_log_check(
+            enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+            message=f"The 'with' parameter is not an str type: {with_tag}")
+        return False, None
+    try:
+        step_log_check(
+            enable_logging=enable_logging, logger=test_pioneer_logger, level="info",
+            message=f"Run with: {step.get('with')}, path: {step.get('run')}")
+        execute_with = {
+            "gui-runner": je_auto_control.execute_files,
+            "web-runner": je_web_runner.execute_files,
+            "api-runner": je_api_testka.execute_files,
+            "load-runner": je_load_density.execute_files
+        }.get(with_tag)
+        if execute_with is None:
+            step_log_check(
+                enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+                message=f"with using the wrong runner tag: {step.get('with')}")
+            return False, None
+    except ExecutorException as error:
+        step_log_check(
+            enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+            message=f"Run with: {step.get('with')}, path: {step.get('run')}, error: {repr(error)}")
+        return False, None
+    return True, execute_with
+
+
+def execute_yaml(stream: str, yaml_type: str = "File"):
+    if yaml_type == "File":
+        file = open(stream, "r").read()
+        yaml_data = yaml.safe_load(stream=file)
+    elif yaml_type == "String":
+        yaml_data = yaml.safe_load(stream=stream)
+    else:
+        raise WrongInputException("Wrong input: " + repr(stream))
+    # Variable
+    enable_logging: bool = False
+    # Pre check
+    if isinstance(yaml_data, dict) is False:
+        raise YamlException(f"Not a dict: {yaml_data}")
+    if "pioneer_log" in yaml_data.keys():
+        enable_logging = True
+        filename = yaml_data.get("pioneer_log")
+        file_handler = TestPioneerHandler(filename=filename)
+        test_pioneer_logger.addHandler(file_handler)
+
+    try:
+
+        if "jobs" not in yaml_data.keys():
+            raise YamlException("No jobs tag")
+        if isinstance(yaml_data.get("jobs"), dict) is False:
+            raise YamlException("jobs not a dict")
+        steps = yaml_data.get("jobs").get("steps", None)
+        if steps is None or len(steps) <= 0:
+            raise YamlException("Steps tag is empty")
+
+        pre_check_failed: bool = False
+
+        # Pre-check name have duplicate or not
+        for step in steps:
+            if step.get("name", None) is None:
+                step_log_check(
+                    enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+                    message=f"Step need name tag")
+                break
+            name = step.get("name")
+            if name in process_manager_instance.name_set:
+                step_log_check(
+                    enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+                    message=f"job name duplicated: {name}")
+                pre_check_failed = True
+                break
+            else:
+                process_manager_instance.name_set.add(name)
+
+        for step in steps:
+            if pre_check_failed:
+                break
+            name = step.get("name")
+
+            if "run" in step.keys():
+                check_with_data = check_with(step, enable_logging=enable_logging)
+                if check_with_data[0] is False:
+                    break
+                else:
+                    execute_with = check_with_data[1]
+                file = step.get("run")
+                if file is None:
+                    step_log_check(
+                        enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+                        message=f"run param need file path: {step.get('run')}")
+                    break
+                if Path(file).is_file() is False and Path(file).is_dir() is False:
+                    step_log_check(
+                        enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+                        message=f"not file path or dir: {step.get('run')}")
+                    break
+                execute_with(file)
+
+            if "open_url" in step.keys():
+                if not isinstance(step.get("open_url"), str):
+                    step_log_check(
+                        enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+                        message=f"The 'open_url' parameter is not an str type: {step.get('open_url')}")
+                    break
+                step_log_check(
+                    enable_logging=enable_logging, logger=test_pioneer_logger, level="info",
+                    message=f"Open url: {step.get('open_url')}")
+                try:
+                    open_url = step.get("open_url")
+                    url_open_method = step.get("url_open_method")
+                    url_open_method = {
+                        "open": webbrowser.open,
+                        "open_new": webbrowser.open_new,
+                        "open_new_tab": webbrowser.open_new_tab,
+                    }.get(url_open_method)
+                    if url_open_method is None:
+                        step_log_check(
+                            enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+                            message=f"Using wrong url_open_method tag: {step.get('with')}")
+                        break
+                    url_open_method(url=open_url)
+                except ExecutorException as error:
+                    step_log_check(
+                        enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+                        message=f"Open URL {step.get('open_url')}, error: {repr(error)}")
+
+            if "wait" in step.keys():
+                if not isinstance(step.get("wait"), int):
+                    step_log_check(
+                        enable_logging=enable_logging, logger=test_pioneer_logger, level="info",
+                        message=f"The 'wait' parameter is not an int type: {step.get('wait')}")
+                    break
+                step_log_check(
+                    enable_logging=enable_logging, logger=test_pioneer_logger, level="info",
+                    message=f"Wait seconds: {step.get('wait')}")
+                time.sleep((step.get("wait")))
+
+            if "open_program" in step.keys():
+                if not isinstance(step.get("open_program"), str):
+                    step_log_check(
+                        enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+                        message=f"The 'open_program' parameter is not an str type: {step.get('open_program')}")
+                    break
+                step_log_check(
+                    enable_logging=enable_logging, logger=test_pioneer_logger, level="info",
+                    message=f"Open program: {step.get('open_program')}")
+
+                redirect_stdout = None
+                redirect_error = None
+
+                if "redirect_stdout" in step.keys():
+                    if not isinstance(step.get("redirect_stdout"), str):
+                        step_log_check(
+                            enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+                            message=f"The 'redirect_stdout' parameter is not an str type: {step.get('redirect_stdout')}")
+                        break
+                    step_log_check(
+                        enable_logging=enable_logging, logger=test_pioneer_logger, level="info",
+                        message=f"Redirect stdout to: {step.get('redirect_stdout')}")
+                    redirect_stdout = step.get("redirect_stdout")
+
+                if "redirect_stderr" in step.keys():
+                    if not isinstance(step.get("redirect_stderr"), str):
+                        step_log_check(
+                            enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+                            message=f"The 'redirect_stderr' parameter is not an str type: {step.get('redirect_stderr')}")
+                        break
+                    step_log_check(
+                        enable_logging=enable_logging, logger=test_pioneer_logger, level="info",
+                        message=f"Redirect stderr to: {step.get('redirect_stderr')}")
+                    redirect_error = step.get("redirect_stdout")
+
+                execute_process = ExecuteProcess()
+                process_manager_instance.process_dict.update({name: execute_process})
+
+                if redirect_error:
+                    execute_process.redirect_stdout = redirect_stdout
+
+                if redirect_error:
+                    execute_process.redirect_stderr = redirect_error
+
+                execute_process.start_process(step.get("open_program"))
+
+            if "close_program" in step.keys():
+                if not isinstance(step.get("close_program"), str):
+                    step_log_check(
+                        enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+                        message=f"The 'close_program' parameter is not an str type: {step.get('close_program')}")
+                    break
+                step_log_check(
+                    enable_logging=enable_logging, logger=test_pioneer_logger, level="info",
+                    message=f"Close program: {step.get('close_program')}")
+                close_program = step.get("close_program")
+                process_manager_instance.close_process(close_program)
+    except Exception as error:
+        step_log_check(
+            enable_logging=enable_logging, logger=test_pioneer_logger, level="error",
+            message=f"Error: {repr(error)}")
+        raise error

test_pioneer_dev-0.0.36/test_pioneer/logging/loggin_instance.py

@@ -0,0 +1,28 @@
+import logging
+from logging.handlers import RotatingFileHandler
+
+
+class TestPioneerHandler(RotatingFileHandler):
+
+    def __init__(self, filename: str = "TestPioneer.log", mode="w",
+                 maxBytes: int = 1073741824, backupCount: int = 0):
+        super().__init__(filename=filename, mode=mode, maxBytes=maxBytes, backupCount=backupCount)
+        self.formatter = logging.Formatter('%(asctime)s | %(name)s | %(levelname)s | %(message)s')
+        self.setLevel(logging.DEBUG)
+        logging.root.setLevel(logging.DEBUG)
+
+    def emit(self, record: logging.LogRecord) -> None:
+        super().emit(record)
+
+test_pioneer_logger = logging.getLogger("TestPioneer")
+
+
+def step_log_check(enable_logging: bool = False, logger: logging.Logger = None,
+                   level: str = "info", message: str = None):
+    if enable_logging and logger:
+        logger_level = {
+            "info": logger.info,
+            "error": logger.error,
+        }.get(level, None)
+        if logger_level is not None:
+            logger_level(message)

test_pioneer_dev-0.0.36/test_pioneer/process/execute_process.py

@@ -0,0 +1,48 @@
+import shlex
+import subprocess
+import sys
+from typing import Union
+
+import psutil
+
+
+class ExecuteProcess(object):
+    def __init__(
+            self,
+            redirect_stdout: Union[str, subprocess.PIPE] = subprocess.PIPE,
+            redirect_stderr: Union[str, subprocess.PIPE] = subprocess.PIPE,
+    ):
+        super().__init__()
+        self.process: [subprocess.Popen, None] = None
+        self.redirect_stdout: str = redirect_stdout
+        self.redirect_stderr: str = redirect_stderr
+
+    def start_process(self, shell_command):
+        if sys.platform in ["win32", "cygwin", "msys"]:
+            args = shell_command
+        else:
+            args = shlex.split(shell_command)
+        if self.redirect_stdout:
+            stdout_file = open(self.redirect_stdout, "w")
+        else:
+            stdout_file = subprocess.PIPE
+        if self.redirect_stderr:
+            stderr_file = open(self.redirect_stderr, "w")
+        else:
+            stderr_file = subprocess.PIPE
+        self.process = subprocess.Popen(
+            args=args,
+            stdout=stdout_file,
+            stderr=stderr_file,
+            shell=True,
+        )
+
+    # exit program change run flag to false and clean read thread and queue and process
+    def exit_program(self):
+        try:
+            process = psutil.Process(self.process.pid)
+            for proc in process.children(recursive=True):
+                proc.kill()
+            process.kill()
+        except psutil.NoSuchProcess:
+            pass

test_pioneer_dev-0.0.36/test_pioneer/process/process_manager.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from typing import Set, Dict, TYPE_CHECKING
+
+from test_pioneer.logging.loggin_instance import test_pioneer_logger
+
+if TYPE_CHECKING:
+    from test_pioneer.process.execute_process import ExecuteProcess
+
+
+class ProcessManager(object):
+
+    def __init__(self):
+        self.name_set: Set[str] = set()
+        self.process_dict: Dict[str, ExecuteProcess] = dict()
+
+    def close_process(self, job_name):
+        execute_process = self.process_dict.get(job_name, None)
+        if execute_process is None:
+            test_pioneer_logger.error(f"Process not found {job_name}")
+        else:
+            execute_process.exit_program()
+
+
+process_manager_instance = ProcessManager()

test_pioneer_dev-0.0.36/test_pioneer/project/create_project_structure.py

@@ -0,0 +1,42 @@
+from pathlib import Path
+from threading import Lock
+
+from test_pioneer.exception.exceptions import ProjectException
+from test_pioneer.exception.tags import cant_save_yaml_error
+from test_pioneer.logging.loggin_instance import test_pioneer_logger
+from test_pioneer.project.template.template import template_1_str
+
+
+def create_dir(dir_name: str) -> None:
+    """
+    :param dir_name: create dir use dir name
+    :return: None
+    """
+    Path(dir_name).mkdir(
+        parents=True,
+        exist_ok=True
+    )
+
+
+def create_template(parent_name: str, project_path: str = None) -> None:
+    if project_path is None:
+        project_path: str = str(Path.cwd())
+    template_dir = Path(project_path + "/" + parent_name)
+    lock = Lock()
+    if template_dir.exists() and template_dir.is_dir():
+        lock.acquire()
+        try:
+            with open(str(template_dir) + "/" + parent_name + ".yml", "w+") as file_to_write:
+                file_to_write.write(template_1_str)
+        except ProjectException:
+            raise ProjectException(cant_save_yaml_error)
+        finally:
+            lock.release()
+
+
+def create_template_dir(project_path: str = None, parent_name: str = ".TestPioneer") -> None:
+    test_pioneer_logger.info(f"create_template_dir, project_path: {project_path}, parent_name: {parent_name}")
+    if project_path is None:
+        project_path: str = str(Path.cwd())
+    create_dir(project_path + "/" + parent_name)
+    create_template(parent_name)

test_pioneer_dev-0.0.36/test_pioneer/project/template/template.py

@@ -0,0 +1,14 @@
+template_1_str: str = \
+"""
+pioneer_log: "test_pioneer.log"
+jobs:
+    steps:
+        - name: run_test_script_1
+          run: test/test1.json
+          with: gui-runner
+        - name: wait_seconds
+          wait: 5
+        - name: run_test_script_1
+          run: test/test1.json
+          with: gui-runner
+"""

test_pioneer_dev-0.0.36/test_pioneer_dev.egg-info/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.2
+Name: test_pioneer_dev
+Version: 0.0.36
+Summary: AutomationEditor for multi automation
+Author-email: JE-Chen <jechenmailman@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/Integration-Automation/TestPioneer
+Project-URL: Code, https://github.com/Integration-Automation/TestPioneer
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Environment :: MacOS X
+Classifier: Environment :: X11 Applications
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: je_auto_control
+Requires-Dist: je_web_runner
+Requires-Dist: je_load_density
+Requires-Dist: je_api_testka
+Requires-Dist: je-mail-thunder
+Requires-Dist: automation-file
+Requires-Dist: psutil
+
+# TestPioneer
+ 

test_pioneer_dev-0.0.36/test_pioneer_dev.egg-info/SOURCES.txt

@@ -0,0 +1,24 @@
+LICENSE
+README.md
+pyproject.toml
+test_pioneer/__init__.py
+test_pioneer/__main__.py
+test_pioneer/exception/__init__.py
+test_pioneer/exception/exceptions.py
+test_pioneer/exception/tags.py
+test_pioneer/executor/__init__.py
+test_pioneer/executor/pioneer_executor.py
+test_pioneer/logging/__init__.py
+test_pioneer/logging/loggin_instance.py
+test_pioneer/process/__init__.py
+test_pioneer/process/execute_process.py
+test_pioneer/process/process_manager.py
+test_pioneer/project/__init__.py
+test_pioneer/project/create_project_structure.py
+test_pioneer/project/template/__init__.py
+test_pioneer/project/template/template.py
+test_pioneer_dev.egg-info/PKG-INFO
+test_pioneer_dev.egg-info/SOURCES.txt
+test_pioneer_dev.egg-info/dependency_links.txt
+test_pioneer_dev.egg-info/requires.txt
+test_pioneer_dev.egg-info/top_level.txt

test_pioneer_dev-0.0.36/test_pioneer_dev.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

test_pioneer_dev-0.0.36/test_pioneer_dev.egg-info/requires.txt

@@ -0,0 +1,7 @@
+je_auto_control
+je_web_runner
+je_load_density
+je_api_testka
+je-mail-thunder
+automation-file
+psutil

test_pioneer_dev-0.0.36/test_pioneer_dev.egg-info/top_level.txt

@@ -0,0 +1 @@
+test_pioneer