CloudApiRequest 1.2.0__py3-none-any.whl

cloud/CloudSignUtil.py

@@ -0,0 +1,152 @@
+import hashlib
+import time
+
+from cloud.CloudLogUtil import log
+
+
+class CloudSignUtil:
+    """
+    cloud签名工具类 - 基于MD5的签名算法
+    鉴权方式：MD5({enterpriseId}+{timestamp}+{token})
+    """
+    
+    @staticmethod
+    def _generate_md5_hash(sign_string):
+        """
+        生成MD5签名的内部方法
+        :param sign_string: 签名字符串
+        :return: 32位小写MD5签名
+        """
+        return hashlib.md5(sign_string.encode('utf-8')).hexdigest()
+    
+    @staticmethod
+    def generate_md5_signature(enterprise_id, timestamp, token):
+        """
+        生成MD5签名（按企业编号）
+        :param enterprise_id: 企业ID
+        :param timestamp: 时间戳
+        :param token: 访问token
+        :return: 32位小写MD5签名
+        """
+        # 构建签名字符串：{enterpriseId}+{timestamp}+{token}
+        sign_string = f"{enterprise_id}{timestamp}{token}"
+        return CloudSignUtil._generate_md5_hash(sign_string)
+    
+    @staticmethod
+    def generate_md5_signature_by_validate_type(validate_type, enterprise_id, department_id, timestamp, token):
+        """
+        根据验证类型生成MD5签名
+        :param validate_type: 验证类型 (1=部门编号, 2=企业编号)
+        :param enterprise_id: 企业ID
+        :param department_id: 部门编号
+        :param timestamp: 时间戳
+        :param token: 访问token
+        :return: 32位小写MD5签名
+        """
+        if validate_type == 1:
+            # validateType=1时，sign=MD5({departmentId}+{timestamp}+{部门token值})
+            sign_string = f"{department_id}{timestamp}{token}"
+        else:
+            # validateType=2时，sign=MD5({enterpriseId}+{timestamp}+{企业token值})
+            sign_string = f"{enterprise_id}{timestamp}{token}"
+        
+        signature = CloudSignUtil._generate_md5_hash(sign_string)
+        log.info(f"签名计算: validateType={validate_type}, sign_string={sign_string}, signature={signature}")
+        
+        return signature
+    
+    @staticmethod
+    def generate_headers(method, url, params, enterprise_id, token, body=None):
+        """
+        生成云服务请求头 - 基于MD5签名
+        :param method: 请求方法
+        :param url: 请求URL
+        :param params: 查询参数
+        :param enterprise_id: 企业ID
+        :param token: 访问token
+        :param body: 请求体（用于POST/PUT请求）
+        :return: 请求头字典
+        """
+        # 获取当前时间戳（秒级）
+        timestamp = int(time.time())
+        
+        # 生成MD5签名
+        signature = CloudSignUtil.generate_md5_signature(enterprise_id, timestamp, token)
+        
+        # 构建请求头
+        headers = {
+            'Authorization': f"Cloud {token}:{signature}",
+            'X-Timestamp': str(timestamp),
+            'Content-Type': 'application/json',
+            'User-Agent': 'CloudAPISDK/1.0'
+        }
+        
+        # 添加企业ID到请求头（如果需要）
+        headers['X-Enterprise-Id'] = str(enterprise_id)
+        
+        return headers
+    
+    @staticmethod
+    def generate_params_with_signature(enterprise_id, token, additional_params=None):
+        """
+        生成带签名的请求参数
+        :param enterprise_id: 企业ID
+        :param token: 访问token
+        :param additional_params: 额外参数
+        :return: 包含签名的参数字典
+        """
+        # 获取当前时间戳（秒级）
+        timestamp = int(time.time())
+        
+        # 检查验证类型
+        validate_type = 2  # 默认按企业编号验证
+        department_id = None
+        
+        if additional_params:
+            validate_type = int(additional_params.get('validateType', 2))
+            department_id = additional_params.get('departmentId')
+        
+        # 根据验证类型生成签名
+        if validate_type == 1 and department_id:
+            # 按部门编号验证
+            signature = CloudSignUtil.generate_md5_signature_by_validate_type(
+                validate_type, enterprise_id, department_id, timestamp, token
+            )
+        else:
+            # 按企业编号验证
+            signature = CloudSignUtil.generate_md5_signature(enterprise_id, timestamp, token)
+        
+        # 构建基础参数
+        params = {
+            'enterpriseId': enterprise_id,
+            'timestamp': timestamp,
+            'sign': signature
+        }
+        
+        # 添加额外参数
+        if additional_params:
+            params.update(additional_params)
+        
+        return params
+    
+    @staticmethod
+    def validate_signature(enterprise_id, timestamp, token, received_signature):
+        """
+        验证签名
+        :param enterprise_id: 企业ID
+        :param timestamp: 时间戳
+        :param token: 访问token
+        :param received_signature: 接收到的签名
+        :return: 验证结果
+        """
+        # 生成期望的签名
+        expected_signature = CloudSignUtil.generate_md5_signature(enterprise_id, timestamp, token)
+        
+        # 比较签名
+        is_valid = expected_signature == received_signature
+        
+        log.info(f"签名验证结果: {is_valid}")
+        log.info(f"期望签名: {expected_signature}")
+        log.info(f"接收签名: {received_signature}")
+        
+        return is_valid 

cloud/CloudYamlUtil.py

@@ -0,0 +1,224 @@
+import re
+import yaml
+import json
+from cloud.CloudLogUtil import log
+from cloud.CloudApiConfig import config
+
+
+class CloudPlaceholderYaml:
+    """
+    用于替换yaml文件中的占位符
+    """
+
+    def __init__(self, yaml_str=None, reString=None, attrObj=config, methObj=None, gloObj=config):
+        if yaml_str:
+            self.yaml_str = json.dumps(yaml_str)
+        else:
+            self.yaml_str = str(reString)
+
+        self.attrObj = attrObj
+        
+        # 修复methObj的初始化逻辑
+        if methObj is not None:
+            self.methObj = methObj
+        elif hasattr(config, 'methObj') and config.methObj is not None:
+            self.methObj = config.methObj
+        else:
+            # 如果都没有，创建一个默认的CloudDataGenerator实例
+            from cloud.CloudApiConfig import CloudDataGenerator
+            self.methObj = CloudDataGenerator()
+            log.warning("methObj未配置，使用默认的CloudDataGenerator实例")
+        
+        self.gloObj = gloObj
+
+    def replace(self):
+        # 定义正则表达式模式
+        # 用于匹配 ${attr} 和 #{method} 这样的占位符
+        # $() #() 如果不匹配则报错
+        pattern_attr = re.compile(r'\$\{(\w+)\}')
+        pattern_method = re.compile(r'\#\{(.*?)\}')
+        pattern_glo = re.compile(r'\$\$\{(\w+)\}')
+
+        # 定义全局替换函数
+        def replace_glo(match):
+            # 获取占位符中的属性名
+            attr_name = match.group(1)
+            # 如果对象中有该属性，则返回该属性的值
+            if hasattr(self.gloObj, attr_name):
+                # 获取属性的值
+                attr_value = getattr(self.gloObj, attr_name)
+                # 如果属性的值是字符串，则返回该字符串
+                if isinstance(attr_value, str):
+                    return str(attr_value)
+                # 如果属性的值是可调用对象，则返回方法名
+                elif callable(attr_value):
+                    return match.group(0)
+                # 如果属性的值是字典，则返回该字典的字符串表示
+                elif isinstance(attr_value, dict):
+                    return str(attr_value)
+                # 如果属性的值是列表，则返回该列表的字符串表示
+                elif isinstance(attr_value, list):
+                    return str(",".join(str(x) for x in attr_value))
+                # 否则，返回属性的值（将其转换为字符串）
+                else:
+                    return str(attr_value)
+            # 否则返回原字符串
+            return match.group(0)
+
+        # 定义替换函数
+        def replace_attr(match):
+            # 获取占位符中的属性名
+            attr_name = match.group(1)
+            # 如果对象中有该属性，则返回该属性的值
+            if hasattr(self.attrObj, attr_name):
+                # 获取属性的值
+                attr_value = getattr(self.attrObj, attr_name)
+                # 如果属性的值是字符串，则返回该字符串
+                if isinstance(attr_value, str):
+                    return str(attr_value)
+                # 如果属性的值是可调用对象，则返回方法名
+                elif callable(attr_value):
+                    return match.group(0)
+                # 如果属性的值是字典，则返回该字典的字符串表示
+                elif isinstance(attr_value, dict):
+                    return str(attr_value)
+                # 如果属性的值是列表，则返回该列表的字符串表示
+                elif isinstance(attr_value, list):
+                    return str(",".join(str(x) for x in attr_value))
+                # 否则，返回属性的值（将其转换为字符串）
+                else:
+                    return str(attr_value)
+            # 否则返回原字符串
+            return match.group(0)
+
+        # 定义替换函数
+        def replace_method(match):
+            # 获取占位符中的方法名
+            method_name = match.group(1)
+            args = None
+            if '(' in match.group(1):
+                # 获取占位符中的方法名
+                method_name = match.group(1).split('(')[0]
+                # 获取参数列表
+                args_str = match.group(1).split('(')[1][:-1]
+                args = [arg.strip() for arg in args_str.split(',')]
+
+            # 如果对象中有该方法，并且该方法是可调用的，则返回该方法的返回值
+            if hasattr(self.methObj, method_name):
+                # 获取方法
+                method = getattr(self.methObj, method_name)
+                # 如果方法是可调用对象，则调用该方法并返回其返回值的字符串表示
+                if callable(method):
+                    try:
+                        if args:
+                            method_value = method(*args)
+                        else:
+                            method_value = method()
+                        if isinstance(method_value, str):
+                            return str(method_value)
+                        else:
+                            return str(method_value)
+                    except Exception as e:
+                        log.error(f"调用方法 {method_name} 时出错: {e}")
+                        return match.group(0)
+                # 否则，返回方法的字符串表示
+                else:
+                    return str(method)
+            else:
+                log.warning(f"方法 {method_name} 在 methObj 中不存在，methObj类型: {type(self.methObj)}")
+                log.warning(f"methObj 可用方法: {[attr for attr in dir(self.methObj) if not attr.startswith('_')]}")
+            # 否则返回原字符串
+            return match.group(0)
+
+        # 判断是否有需要替换的再进行替换
+        log.info(f"开始替换str中的占位符: {self.yaml_str}")
+        log.info(f"使用的methObj: {type(self.methObj)}")
+        # 先进行全局替换
+        replaced_str = pattern_glo.sub(replace_glo, self.yaml_str)
+        # 替换占位符中的属性
+        replaced_str = pattern_attr.sub(replace_attr, replaced_str)
+        # 替换占位符中的方法
+        replaced_str = pattern_method.sub(replace_method, replaced_str)
+        self.replaced_str = replaced_str
+        log.info("替换后的str内容为：{}".format(replaced_str))
+        return self
+
+    def jsonLoad(self):
+        # 先将单引号替换为双引号，None替换为null
+        temp_str = self.replaced_str.replace("'", "\"").replace('None', 'null')
+        
+        # 在解析之前，检测并保护JSON字符串参数
+        # 查找模式："key": "{...}" 或 "key": "[...]"
+        # 将内部的引号转义，使其成为合法的JSON字符串
+        def escape_json_string_values(match):
+            key = match.group(1)
+            json_str = match.group(2)
+            # 转义内部的双引号
+            escaped_json_str = json_str.replace('"', '\\"')
+            return f'"{key}": "{escaped_json_str}"'
+        
+        # 匹配 "key": "{...}" 或 "key": "[...]" 的模式
+        # 使用非贪婪匹配，并且只匹配value部分被双引号包裹的情况
+        # .*? 可以匹配包含双引号的内容
+        pattern = r'"(\w+)"\s*:\s*"(\{.*?\}|\[.*?\])"'
+        temp_str = re.sub(pattern, escape_json_string_values, temp_str)
+        log.info(f"转义后的字符串: {temp_str[:300]}")
+        
+        try:
+            # 尝试直接解析
+            parsed_result = json.loads(temp_str)
+            log.info("替换后jsonLoad的str内容为：{}".format(parsed_result))
+            return parsed_result
+        except json.JSONDecodeError as e:
+            # 如果直接解析失败，尝试旧的替换逻辑（兼容旧用例）
+            log.warning(f"JSON解析失败: {e}, 尝试旧的替换逻辑")
+            try:
+                replaced_str = self.replaced_str.replace('"[', '[').replace(']"', ']').replace('"{', '{').replace('}"', '}').replace("'", "\"").replace('None','null')
+                replaced_str = json.loads(replaced_str)
+                log.info("替换后jsonLoad的str内容为：{}".format(replaced_str))
+                return replaced_str
+            except:
+                log.info(f'*************替换失败-YAML,请检查格式{replaced_str}******************')
+
+    def textLoad(self):
+        return json.loads(self.replaced_str)
+
+
+class CloudReadYaml:
+    """
+    用于读取yaml文件的工具类
+    """
+
+    def __init__(self, yaml_file):
+        self.yaml_file = yaml_file
+
+    def load_yaml(self):
+        """
+        读取yaml文件，并返回其中的数据
+        :return: dict
+        """
+        with open(self.yaml_file, encoding='utf-8') as f:
+            data = yaml.safe_load(f)
+        return data if data is not None else {}  # 如果data为None，则返回空字典
+
+    def get(self, key, default=None):
+        """
+        获取yaml文件中的数据
+        :param key: 数据的键
+        :param default: 如果获取失败，则返回该默认值
+        :return: dict
+        """
+        # 读取yaml文件
+        data = self.load_yaml()
+        # 获取数据
+        return data.get(key, default) if data is not None else default
+
+    def get_all(self):
+        """
+        获取yaml文件中的所有数据
+        :return: dict
+        """
+        # 读取yaml文件
+        data = self.load_yaml()
+        # 如果data为None，则返回空字典
+        return data if data is not None else {} 

cloud/__init__.py

@@ -0,0 +1,9 @@
+from cloud.CloudAPIRequest import CloudAPIRequest
+from cloud.CloudApiConfig import config, CloudDataGenerator
+from cloud.CloudRequestUtil import CloudHttpClient
+
+# 创建config实例
+config = config()
+# 初始化配置实例
+config.methObj = CloudDataGenerator()
+config.Session = CloudHttpClient() 

cloud/cli.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Cloud API SDK 命令行工具
+"""
+
+import argparse
+import sys
+import os
+from cloud_api_sdk import config, CloudAPIRequest
+
+
+def main():
+    """
+    主函数
+    """
+    parser = argparse.ArgumentParser(description='Cloud API SDK 测试工具')
+    parser.add_argument('testcase', help='测试用例文件路径')
+    parser.add_argument('--base-url', help='基础URL')
+    parser.add_argument('--access-key-id', help='访问密钥ID')
+    parser.add_argument('--access-key-secret', help='访问密钥Secret')
+    parser.add_argument('--cloud-password', help='云服务密码')
+    parser.add_argument('--env', default='test', help='运行环境')
+    parser.add_argument('--common-path', help='公共用例路径')
+    parser.add_argument('--assert-fail', default='stop', choices=['stop', 'continue'], help='断言失败处理模式')
+    
+    args = parser.parse_args()
+    
+    # 配置环境
+    if args.base_url:
+        config.baseUrl = args.base_url
+    if args.access_key_id:
+        config.accessKeyId = args.access_key_id
+    if args.access_key_secret:
+        config.accessKeySecret = args.access_key_secret
+    if args.cloud_password:
+        config.CloudPassword = args.cloud_password
+    if args.common_path:
+        config.commonTestCasePath = args.common_path
+    config.assertFail = args.assert_fail
+    config.tEnv = args.env
+    
+    # 检查测试用例文件是否存在
+    if not os.path.exists(args.testcase):
+        print(f"错误: 测试用例文件 {args.testcase} 不存在")
+        sys.exit(1)
+    
+    # 执行测试
+    try:
+        class TestRunner:
+            pass
+        
+        test_runner = TestRunner()
+        CloudAPIRequest().doRequest(args.testcase, test_runner)
+        print("测试执行完成")
+    except Exception as e:
+        print(f"测试执行失败: {e}")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main() 

cloudapirequest-1.2.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+ 
+Copyright (c) [2025] [天润-测试]
+ 
+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.

cloudapirequest-1.2.0.dist-info/METADATA

@@ -0,0 +1,21 @@
+Metadata-Version: 2.1
+Name: CloudApiRequest
+Version: 1.2.0
+Summary: 天润cloud接口测试库
+Home-page: https://www.ti-net.com.cn/
+Author: 天润-测试
+Author-email: wangwd@ti-net.com.cn
+License: MIT
+Requires-Python: >=3.7
+License-File: LICENSE
+Requires-Dist: Faker==18.4.0
+Requires-Dist: jsonpath==0.82
+Requires-Dist: pytz==2023.3
+Requires-Dist: PyYAML==6.0
+Requires-Dist: requests==2.28.2
+Requires-Dist: allure-pytest==2.13.2
+Requires-Dist: allure-python-commons==2.13.2
+Requires-Dist: requests-toolbelt==1.0.0
+Requires-Dist: pycryptodome==3.17
+Requires-Dist: pytest-assume==2.4.3
+

cloudapirequest-1.2.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+cloud/CloudAPIRequest.py,sha256=J0DyxwvoW2ZeDmcD3mxRLEMt_enMHVgNANUYi0nOup4,24528
+cloud/CloudApiConfig.py,sha256=s4VjgJT8cwCU2IZdZm5u5pgRxs8gp9ia5kW6P9txUWI,13027
+cloud/CloudLogUtil.py,sha256=EXnU6QXFxl_npCcJgQvhtlG8uR57NmbOovFjVMHPOpQ,935
+cloud/CloudRequestUtil.py,sha256=bsbI74p1iu4weXbDKqwhXvH1KwezvxYXdrXBMc9L3sE,4827
+cloud/CloudSignUtil.py,sha256=dyUESxWYgcvTt-nOnI3mEboVispEF0cl_vX-1d3kUOU,5493
+cloud/CloudYamlUtil.py,sha256=-WoOBSVsTQG9nbeEPocwh4eFV0Iilj1IcqXGYw5DYxs,9787
+cloud/__init__.py,sha256=RgNAN_vKhCHnwcBy0hc1ttrr5x58bO_u6TNICZDSfFw,306
+cloud/cli.py,sha256=VId1s29djJu7QrkXJc2je4fRV030vqD3nwuI23AN8Ig,1986
+cloudapirequest-1.2.0.dist-info/LICENSE,sha256=hMjjUYpALQY0E8hzysmZszKwYy2mt8tUvAFQfIIbwV4,1099
+cloudapirequest-1.2.0.dist-info/METADATA,sha256=pc5iBoOAtKXd2kRJeKZqISUUvcGYuXTs1yj06T0LwTQ,608
+cloudapirequest-1.2.0.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+cloudapirequest-1.2.0.dist-info/top_level.txt,sha256=lBiHHi76sKOBY-DmE0iDypxZxv-TTCnvHeiFleC_PuA,6
+cloudapirequest-1.2.0.dist-info/RECORD,,

cloudapirequest-1.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.3.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

cloudapirequest-1.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+cloud