pytest-auto-api2-cli 0.2.0__py3-none-any.whl

utils/other_tools/get_local_ip.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+# @Time    : 2022/5/10 18:54
+# @Author  : 余少琪
+# @Email   : 1603453211@qq.com
+# @File    :
+# @describe:
+"""
+
+import socket
+
+
+def get_host_ip():
+    """
+    查询本机ip地址
+    :return:
+    """
+    _s = None
+    try:
+        _s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+        _s.connect(('8.8.8.8', 80))
+        l_host = _s.getsockname()[0]
+    finally:
+        _s.close()
+
+    return l_host

utils/other_tools/install_tool/install_requirements.py

@@ -0,0 +1,91 @@
+#!/usr/bin/python3
+# -*- coding: utf-8 -*-
+"""
+# @Time    : 2022/5/10 14:02
+# @Author  : 余少琪
+# @Email   : 1603453211@qq.com
+# @File    : install_requirements
+# @describe: 判断程序是否每次会更新依赖库，如有更新，则自动安装
+"""
+import os
+import chardet
+from common.setting import ensure_path_sep
+from utils.logging_tool.log_control import INFO
+from utils import config
+
+os.system("pip3 install chardet")
+
+
+class InstallRequirements:
+    """ 自动识别安装最新的依赖库 """
+
+    def __init__(self):
+        self.version_library_comparisons_path = ensure_path_sep("\\utils\\other_tools\\install_tool\\") \
+                                                + "version_library_comparisons.txt"
+        self.requirements_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) \
+                                 + os.sep + "requirements.txt"
+
+        self.mirror_url = config.mirror_source
+        # 初始化时，获取最新的版本库
+
+        # os.system("pip freeze > {0}".format(self.requirements_path))
+
+    def read_version_library_comparisons_txt(self):
+        """
+        获取版本比对默认的文件
+        @return:
+        """
+        with open(self.version_library_comparisons_path, 'r', encoding="utf-8") as file:
+            return file.read().strip(' ')
+
+    @classmethod
+    def check_charset(cls, file_path):
+        """获取文件的字符集"""
+        with open(file_path, "rb") as file:
+            data = file.read(4)
+            charset = chardet.detect(data)['encoding']
+        return charset
+
+    def read_requirements(self):
+        """获取安装文件"""
+        file_data = ""
+        with open(
+                self.requirements_path,
+                'r',
+                encoding=self.check_charset(self.requirements_path)
+        ) as file:
+
+            for line in file:
+                if "" in line:
+                    line = line.replace("", "")
+                file_data += line
+
+        with open(
+                self.requirements_path,
+                "w",
+                encoding=self.check_charset(self.requirements_path)
+        ) as file:
+            file.write(file_data)
+
+        return file_data
+
+    def text_comparison(self):
+        """
+        版本库比对
+        @return:
+        """
+        read_version_library_comparisons_txt = self.read_version_library_comparisons_txt()
+        read_requirements = self.read_requirements()
+        if read_version_library_comparisons_txt == read_requirements:
+            INFO.logger.info("程序中未检查到更新版本库，已为您跳过自动安装库")
+        # 程序中如出现不同的文件，则安装
+        else:
+            INFO.logger.info("程序中检测到您更新了依赖库，已为您自动安装")
+            os.system(f"pip3 install -r {self.requirements_path}")
+            with open(self.version_library_comparisons_path, "w",
+                      encoding=self.check_charset(self.requirements_path)) as file:
+                file.write(read_requirements)
+
+
+if __name__ == '__main__':
+    InstallRequirements().text_comparison()

utils/other_tools/jsonpath_date_replace.py

@@ -0,0 +1,28 @@
+#!/usr/bin/python3
+# -*- coding: utf-8 -*-
+"""
+# @Time    : 2022/5/23 18:27
+# @Author  : 余少琪
+# @Email   : 1603453211@qq.com
+# @File    : jsonpath_date_replace
+# @describe:
+"""
+
+
+def jsonpath_replace(change_data, key_name, data_switch=None):
+    """处理jsonpath数据"""
+    _new_data = key_name + ''
+    for i in change_data:
+        if i == '$':
+            pass
+        elif data_switch is None and i == "data":
+            _new_data += '.data'
+        elif i[0] == '[' and i[-1] == ']':
+            _new_data += "[" + i[1:-1] + "]"
+        else:
+            _new_data += '[' + '"' + i + '"' + "]"
+    return _new_data
+
+
+if __name__ == '__main__':
+    jsonpath_replace(change_data=['$', 'data', 'id'], key_name='self.__yaml_case')

utils/other_tools/models.py

@@ -0,0 +1,269 @@
+import types
+from enum import Enum, unique
+from typing import Text, Dict, Callable, Union, Optional, List, Any
+from dataclasses import dataclass
+from pydantic import BaseModel, Field
+
+
+class NotificationType(Enum):
+    """ 自动化通知方式 """
+    DEFAULT = '0'
+    DING_TALK = '1'
+    WECHAT = '2'
+    EMAIL = '3'
+    FEI_SHU = '4'
+
+
+@dataclass
+class TestMetrics:
+    """ 用例执行数据 """
+    passed: int
+    failed: int
+    broken: int
+    skipped: int
+    total: int
+    pass_rate: float
+    time: Text
+
+
+class RequestType(Enum):
+    """
+    request请求发送，请求参数的数据类型
+    """
+    JSON = "JSON"
+    PARAMS = "PARAMS"
+    DATA = "DATA"
+    FILE = 'FILE'
+    EXPORT = "EXPORT"
+    NONE = "NONE"
+
+
+class TestCaseEnum(Enum):
+    URL = ("url", True)
+    HOST = ("host", True)
+    METHOD = ("method", True)
+    DETAIL = ("detail", True)
+    IS_RUN = ("is_run", True)
+    HEADERS = ("headers", True)
+    REQUEST_TYPE = ("requestType", True)
+    DATA = ("data", True)
+    DE_CASE = ("dependence_case", True)
+    DE_CASE_DATA = ("dependence_case_data", False)
+    CURRENT_RE_SET_CACHE = ("current_request_set_cache", False)
+    SQL = ("sql", False)
+    ASSERT_DATA = ("assert", True)
+    SETUP_SQL = ("setup_sql", False)
+    TEARDOWN = ("teardown", False)
+    TEARDOWN_SQL = ("teardown_sql", False)
+    SLEEP = ("sleep", False)
+
+
+class Method(Enum):
+    GET = "GET"
+    POST = "POST"
+    PUT = "PUT"
+    PATCH = "PATCH"
+    DELETE = "DELETE"
+    HEAD = "HEAD"
+    OPTION = "OPTION"
+
+
+def load_module_functions(module) -> Dict[Text, Callable]:
+    """ 获取 module中方法的名称和所在的内存地址 """
+    module_functions = {}
+
+    for name, item in vars(module).items():
+        if isinstance(item, types.FunctionType):
+            module_functions[name] = item
+    return module_functions
+
+
+@unique
+class DependentType(Enum):
+    """
+    数据依赖相关枚举
+    """
+    RESPONSE = 'response'
+    REQUEST = 'request'
+    SQL_DATA = 'sqlData'
+    CACHE = "cache"
+
+
+class Assert(BaseModel):
+    jsonpath: Text
+    type: Text
+    value: Any
+    AssertType: Union[None, Text] = None
+
+
+class DependentData(BaseModel):
+    dependent_type: Text
+    jsonpath: Text
+    set_cache: Optional[Text] = None
+    replace_key: Optional[Text] = None
+
+
+class DependentCaseData(BaseModel):
+    case_id: Text
+    # dependent_data: List[DependentData]
+    dependent_data: Union[None, List[DependentData]] = None
+
+
+class ParamPrepare(BaseModel):
+    dependent_type: Text
+    jsonpath: Text
+    set_cache: Text
+
+
+class SendRequest(BaseModel):
+    dependent_type: Text
+    jsonpath: Optional[Text] = None
+    cache_data: Optional[Text] = None
+    set_cache: Optional[Text] = None
+    replace_key: Optional[Text] = None
+
+
+class TearDown(BaseModel):
+    case_id: Text
+    param_prepare: Optional[List["ParamPrepare"]] = None
+    send_request: Optional[List["SendRequest"]] = None
+
+
+class CurrentRequestSetCache(BaseModel):
+    type: Text
+    jsonpath: Text
+    name: Text
+
+
+class TestCase(BaseModel):
+    url: Text
+    method: Text
+    detail: Text
+    # assert_data: Union[Dict, Text] = Field(..., alias="assert")
+    assert_data: Union[Dict, Text]
+    headers: Union[None, Dict, Text] = {}
+    requestType: Text
+    is_run: Union[None, bool, Text] = None
+    data: Any = None
+    dependence_case: Union[None, bool] = False
+    dependence_case_data: Optional[Union[None, List["DependentCaseData"], Text]] = None
+    sql: Optional[List] = None
+    setup_sql: Optional[List] = None
+    status_code: Optional[int] = None
+    teardown_sql: Optional[List] = None
+    teardown: Union[List["TearDown"], None] = None
+    current_request_set_cache: Optional[List["CurrentRequestSetCache"]] = None
+    sleep: Optional[Union[int, float]] = None
+
+
+class ResponseData(BaseModel):
+    url: Text
+    is_run: Union[None, bool, Text]
+    detail: Text
+    response_data: Text
+    request_body: Any
+    method: Text
+    sql_data: Dict
+    yaml_data: "TestCase"
+    headers: Dict
+    cookie: Dict
+    assert_data: Dict
+    res_time: Union[int, float]
+    status_code: int
+    teardown: Optional[List["TearDown"]] = None
+    teardown_sql: Union[None, List] = None
+    body: Any
+
+
+class DingTalk(BaseModel):
+    webhook: Union[Text, None]
+    secret: Union[Text, None]
+
+
+class MySqlDB(BaseModel):
+    switch: bool = False
+    host: Union[Text, None] = None
+    user: Union[Text, None] = None
+    password: Union[Text, None] = None
+    port: Union[int, None] = 3306
+
+
+class Webhook(BaseModel):
+    webhook: Union[Text, None]
+
+
+class Email(BaseModel):
+    send_user: Union[Text, None]
+    email_host: Union[Text, None]
+    stamp_key: Union[Text, None]
+    # 收件人
+    send_list: Union[Text, None]
+
+
+class Config(BaseModel):
+    project_name: Text
+    env: Text
+    tester_name: Text
+    # Compatible with config values written as either 0 or "0"
+    notification_type: Union[Text, int] = '0'
+    excel_report: bool
+    ding_talk: "DingTalk"
+    mysql_db: "MySqlDB"
+    mirror_source: Text
+    wechat: "Webhook"
+    email: "Email"
+    lark: "Webhook"
+    real_time_update_test_cases: bool = False
+    host: Text
+    app_host: Union[Text, None]
+
+
+@unique
+class AllureAttachmentType(Enum):
+    """
+    allure 报告的文件类型枚举
+    """
+    TEXT = "txt"
+    CSV = "csv"
+    TSV = "tsv"
+    URI_LIST = "uri"
+
+    HTML = "html"
+    XML = "xml"
+    JSON = "json"
+    YAML = "yaml"
+    PCAP = "pcap"
+
+    PNG = "png"
+    JPG = "jpg"
+    SVG = "svg"
+    GIF = "gif"
+    BMP = "bmp"
+    TIFF = "tiff"
+
+    MP4 = "mp4"
+    OGG = "ogg"
+    WEBM = "webm"
+
+    PDF = "pdf"
+
+
+@unique
+class AssertMethod(Enum):
+    """断言类型"""
+    equals = "=="
+    less_than = "lt"
+    less_than_or_equals = "le"
+    greater_than = "gt"
+    greater_than_or_equals = "ge"
+    not_equals = "not_eq"
+    string_equals = "str_eq"
+    length_equals = "len_eq"
+    length_greater_than = "len_gt"
+    length_greater_than_or_equals = 'len_ge'
+    length_less_than = "len_lt"
+    length_less_than_or_equals = 'len_le'
+    contains = "contains"
+    contained_by = 'contained_by'
+    startswith = 'startswith'
+    endswith = 'endswith'

utils/other_tools/thread_tool.py

@@ -0,0 +1,91 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+# @Time   : 2022/3/28 10:52
+# @Author : 余少琪
+"""
+
+
+import time
+import threading
+
+
+class PyTimer:
+    """定时器类"""
+
+    def __init__(self, func, *args, **kwargs):
+        """构造函数"""
+
+        self.func = func
+        self.args = args
+        self.kwargs = kwargs
+        self.running = False
+
+    def _run_func(self):
+        """运行定时事件函数"""
+
+        _thread = threading.Thread(target=self.func, args=self.args, kwargs=self.kwargs)
+        _thread.setDaemon(True)
+        _thread.start()
+
+    def _start(self, interval, once):
+        """启动定时器的线程函数"""
+
+        interval = max(interval, 0.01)
+
+        if interval < 0.050:
+            _dt = interval / 10
+        else:
+            _dt = 0.005
+
+        if once:
+            deadline = time.time() + interval
+            while time.time() < deadline:
+                time.sleep(_dt)
+
+            # 定时时间到，调用定时事件函数
+            self._run_func()
+        else:
+            self.running = True
+            deadline = time.time() + interval
+            while self.running:
+                while time.time() < deadline:
+                    time.sleep(_dt)
+
+                # 更新下一次定时时间
+                deadline += interval
+
+                # 定时时间到，调用定时事件函数
+                if self.running:
+                    self._run_func()
+
+    def start(self, interval, once=False):
+        """启动定时器
+
+        interval    - 定时间隔，浮点型，以秒为单位，最高精度10毫秒
+        once        - 是否仅启动一次，默认是连续的
+        """
+
+        thread_ = threading.Thread(target=self._start, args=(interval, once))
+        thread_.setDaemon(True)
+        thread_.start()
+
+    def stop(self):
+        """停止定时器"""
+
+        self.running = False
+
+
+def do_something(name, gender='male'):
+    """执行"""
+    print(time.time(), '定时时间到，执行特定任务')
+    print('name:%s, gender:%s', name, gender)
+    time.sleep(5)
+    print(time.time(), '完成特定任务')
+
+
+timer = PyTimer(do_something, 'Alice', gender='female')
+timer.start(0.5, once=False)
+
+input('按回车键结束\n')  # 此处阻塞住进程
+timer.stop()

utils/read_files_tools/__init__.py

@@ -0,0 +1 @@
+

utils/read_files_tools/case_automatic_control.py

@@ -0,0 +1,138 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+# @Time   : 2022/3/28 13:22
+# @Author : 浣欏皯鐞?
+"""
+import os
+from pathlib import Path
+from typing import Text
+
+from common.setting import data_dir_path, test_case_dir_path, resolve_project_path
+from utils.read_files_tools.get_all_files_path import get_all_files
+from utils.read_files_tools.testcase_template import write_testcase_file
+from utils.read_files_tools.yaml_control import GetYamlData
+
+
+class TestCaseAutomaticGeneration:
+    def __init__(self, *, data_dir: Text = None, test_dir: Text = None, force_write: bool = False):
+        self.yaml_case_data = None
+        self.file_path = None
+        self._data_dir = resolve_project_path(data_dir) if data_dir else data_dir_path()
+        self._test_dir = resolve_project_path(test_dir) if test_dir else test_case_dir_path()
+        self._force_write = force_write
+
+    @property
+    def case_date_path(self) -> Text:
+        """Return yaml testcase directory path."""
+        return self._data_dir
+
+    @property
+    def case_path(self) -> Text:
+        """Return generated pytest testcase directory path."""
+        return self._test_dir
+
+    @property
+    def allure_epic(self):
+        _allure_epic = self.yaml_case_data.get("case_common").get("allureEpic")
+        assert _allure_epic is not None, (
+            "鐢ㄤ緥涓?allureEpic 涓哄繀濉」锛岃妫€鏌ョ敤渚嬪唴瀹? 鐢ㄤ緥璺緞锛?%s'" % self.file_path
+        )
+        return _allure_epic
+
+    @property
+    def allure_feature(self):
+        _allure_feature = self.yaml_case_data.get("case_common").get("allureFeature")
+        assert _allure_feature is not None, (
+            "鐢ㄤ緥涓?allureFeature 涓哄繀濉」锛岃妫€鏌ョ敤渚嬪唴瀹? 鐢ㄤ緥璺緞锛?%s'" % self.file_path
+        )
+        return _allure_feature
+
+    @property
+    def allure_story(self):
+        _allure_story = self.yaml_case_data.get("case_common").get("allureStory")
+        assert _allure_story is not None, (
+            "鐢ㄤ緥涓?allureStory 涓哄繀濉」锛岃妫€鏌ョ敤渚嬪唴瀹? 鐢ㄤ緥璺緞锛?%s'" % self.file_path
+        )
+        return _allure_story
+
+    @property
+    def file_name(self) -> Text:
+        """
+        Convert current yaml file path to relative python path.
+        Example: Collect/collect_tool_list.yaml -> Collect/collect_tool_list.py
+        """
+        relative = os.path.relpath(self.file_path, self.case_date_path)
+        filename, ext = os.path.splitext(relative)
+        if ext.lower() not in {".yaml", ".yml"}:
+            return relative
+        return filename + ".py"
+
+    @property
+    def get_test_class_title(self):
+        """Generate class name from case filename."""
+        _file_name = os.path.split(self.file_name)[1][:-3]
+        _name = _file_name.split("_")
+        for index in range(len(_name)):
+            _name[index] = _name[index].capitalize()
+        return "".join(_name)
+
+    @property
+    def func_title(self) -> Text:
+        """Generate test function name from case filename."""
+        return os.path.split(self.file_name)[1][:-3]
+
+    @property
+    def spilt_path(self):
+        path = self.file_name.split(os.sep)
+        path[-1] = "test_" + path[-1]
+        return path
+
+    @property
+    def get_case_path(self):
+        """Return generated target testcase file absolute path."""
+        return os.path.join(self.case_path, *self.spilt_path)
+
+    @property
+    def case_ids(self):
+        return [key for key in self.yaml_case_data.keys() if key != "case_common"]
+
+    @property
+    def get_file_name(self):
+        return self.spilt_path[-1]
+
+    def mk_dir(self) -> None:
+        """Create target test directory if missing."""
+        case_dir_path = os.path.split(self.get_case_path)[0]
+        if not os.path.exists(case_dir_path):
+            os.makedirs(case_dir_path)
+
+    def get_case_automatic(self) -> None:
+        """Generate pytest test files from all yaml cases."""
+        data_path = Path(self.case_date_path)
+        if not data_path.exists():
+            raise FileNotFoundError(f"YAML data directory does not exist: {data_path}")
+
+        file_paths = get_all_files(file_path=str(data_path), yaml_data_switch=True)
+        for file in file_paths:
+            if "proxy_data.yaml" in file:
+                continue
+
+            self.yaml_case_data = GetYamlData(file).get_yaml_data()
+            self.file_path = file
+            self.mk_dir()
+            write_testcase_file(
+                allure_epic=self.allure_epic,
+                allure_feature=self.allure_feature,
+                class_title=self.get_test_class_title,
+                func_title=self.func_title,
+                case_path=self.get_case_path,
+                case_ids=self.case_ids,
+                file_name=self.get_file_name,
+                allure_story=self.allure_story,
+                force_write=self._force_write,
+            )
+
+
+if __name__ == "__main__":
+    TestCaseAutomaticGeneration().get_case_automatic()

utils/read_files_tools/clean_files.py

@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+# @Time   : 2022/4/7 11:56
+# @Author : 余少琪
+"""
+
+import os
+
+
+def del_file(path):
+    """删除目录下的文件"""
+    list_path = os.listdir(path)
+    for i in list_path:
+        c_path = os.path.join(path, i)
+        if os.path.isdir(c_path):
+            del_file(c_path)
+        else:
+            os.remove(c_path)