pytest-dsl 0.1.0__py3-none-any.whl

pytest_dsl/core/yaml_vars.py

@@ -0,0 +1,75 @@
+import os
+import yaml
+from typing import Dict, Any, List, Optional
+from pathlib import Path
+
+
+class YAMLVariableManager:
+    """管理YAML格式的变量文件"""
+
+    def __init__(self):
+        self._loaded_files: List[str] = []
+        self._variables: Dict[str, Any] = {}
+
+    def has_variable(self, name: str) -> bool:
+        """检查变量是否存在
+        
+        Args:
+            name: 变量名
+            
+        Returns:
+            bool: 变量是否存在
+        """
+        return name in self._variables
+
+    def load_yaml_file(self, file_path: str) -> None:
+        """加载单个YAML文件中的变量"""
+        if not os.path.exists(file_path):
+            raise FileNotFoundError(f"变量文件不存在: {file_path}")
+
+        with open(file_path, 'r', encoding='utf-8') as f:
+            try:
+                variables = yaml.safe_load(f)
+                if variables and isinstance(variables, dict):
+                    # 记录已加载的文件
+                    self._loaded_files.append(file_path)
+                    # 更新变量字典，新文件中的变量会覆盖旧的
+                    self._variables.update(variables)
+            except yaml.YAMLError as e:
+                raise ValueError(f"YAML文件格式错误 {file_path}: {str(e)}")
+
+    def load_yaml_files(self, file_paths: List[str]) -> None:
+        """批量加载多个YAML文件中的变量"""
+        for file_path in file_paths:
+            self.load_yaml_file(file_path)
+
+    def load_from_directory(self, directory: str, pattern: str = "*.yaml") -> None:
+        """从指定目录加载所有匹配的YAML文件"""
+        dir_path = Path(directory)
+        if not dir_path.exists() or not dir_path.is_dir():
+            raise NotADirectoryError(f"目录不存在: {directory}")
+
+        yaml_files = list(dir_path.glob(pattern))
+        for yaml_file in yaml_files:
+            self.load_yaml_file(str(yaml_file))
+
+    def get_variable(self, name: str) -> Optional[Any]:
+        """获取变量值"""
+        return self._variables.get(name)
+
+    def get_all_variables(self) -> Dict[str, Any]:
+        """获取所有已加载的变量"""
+        return self._variables.copy()
+
+    def get_loaded_files(self) -> List[str]:
+        """获取已加载的文件列表"""
+        return self._loaded_files.copy()
+
+    def clear(self) -> None:
+        """清除所有已加载的变量"""
+        self._variables.clear()
+        self._loaded_files.clear()
+
+
+# 创建全局YAML变量管理器实例
+yaml_vars = YAMLVariableManager() 

pytest_dsl/docs/custom_keywords.md

@@ -0,0 +1,140 @@
+# 创建自定义关键字
+
+## 概述
+
+pytest-dsl 允许用户在自己的项目中创建自定义关键字，无需修改插件本身的代码。这使得您可以针对自己的项目需求，扩展 DSL 的功能。
+
+## 自动扫描机制
+
+pytest-dsl 会自动扫描并导入以下位置的关键字：
+
+1. 内置关键字（插件自带的）
+2. 通过 `entry_points` 机制注册的第三方插件关键字
+3. **用户项目中的 `keywords` 目录下的关键字模块**
+
+## 目录结构
+
+要创建自定义关键字，只需在您的项目根目录下创建一个 `keywords` 目录，并在其中添加 Python 模块：
+
+```
+项目根目录/
+  ├── keywords/                 # 关键字根目录
+  │   ├── __init__.py          # 可选，如果要作为包导入
+  │   ├── my_keywords.py       # 顶层关键字模块
+  │   ├── another_module.py    # 顶层关键字模块
+  │   └── web/                 # 子目录（可选作为子包）
+  │       ├── __init__.py      # 可选，如果要作为子包导入
+  │       └── selenium_keywords.py  # 子目录中的关键字模块
+  ├── tests/                    # 测试目录
+  │   └── test_dsl.py          # 使用 pytest-dsl 运行的测试
+  └── pytest.ini               # pytest 配置文件
+```
+
+## 创建自定义关键字
+
+在 `keywords` 目录下的任何 Python 文件中，您都可以使用 `keyword_manager.register` 装饰器来注册自定义关键字。
+
+### 基本示例
+
+```python
+from pytest_dsl.core.keyword_manager import keyword_manager
+
+@keyword_manager.register('打印消息', [
+    {'name': '消息', 'mapping': 'message', 'description': '要打印的消息内容'},
+])
+def print_message(**kwargs):
+    """打印一条消息到控制台
+    
+    Args:
+        message: 要打印的消息
+        context: 测试上下文 (自动传入)
+    """
+    message = kwargs.get('message', '')
+    print(f"自定义关键字消息: {message}")
+    return True
+```
+
+### 带返回值的关键字
+
+```python
+@keyword_manager.register('生成随机数', [
+    {'name': '最小值', 'mapping': 'min_value', 'description': '随机数范围最小值'},
+    {'name': '最大值', 'mapping': 'max_value', 'description': '随机数范围最大值'},
+])
+def generate_random(**kwargs):
+    """生成指定范围内的随机整数
+    
+    Args:
+        min_value: 最小值
+        max_value: 最大值
+        context: 测试上下文 (自动传入)
+        
+    Returns:
+        随机整数
+    """
+    import random
+    min_value = int(kwargs.get('min_value', 1))
+    max_value = int(kwargs.get('max_value', 100))
+    
+    result = random.randint(min_value, max_value)
+    return result
+```
+
+## 参数说明
+
+在注册关键字时，您需要提供参数的定义列表：
+
+```python
+@keyword_manager.register('关键字名称', [
+    {'name': '中文参数名', 'mapping': '英文参数名', 'description': '参数描述'},
+    # 更多参数...
+])
+```
+
+- `name`: 中文参数名，用在 DSL 文件中调用该关键字时使用
+- `mapping`: 英文参数名，映射到函数参数名
+- `description`: 参数描述，用于生成文档
+
+## 使用上下文
+
+每个关键字函数都会自动接收一个 `context` 参数，这是测试运行时的上下文对象：
+
+```python
+@keyword_manager.register('保存到上下文', [
+    {'name': '键名', 'mapping': 'key', 'description': '保存在上下文中的键名'},
+    {'name': '值', 'mapping': 'value', 'description': '要保存的值'},
+])
+def save_to_context(**kwargs):
+    """将值保存到测试上下文中"""
+    key = kwargs.get('key')
+    value = kwargs.get('value')
+    context = kwargs.get('context')
+    
+    if key and context:
+        context.set(key, value)
+        return True
+    return False
+```
+
+## 在 DSL 中使用自定义关键字
+
+一旦您注册了自定义关键字，就可以在 DSL 文件中使用它们：
+
+```
+# 测试: 自定义关键字演示
+@name 自定义关键字测试
+@description 演示如何使用自定义关键字
+
+# 使用自定义关键字
+打印消息 消息="这是一条自定义消息"
+
+# 带返回值的关键字
+随机数 = 生成随机数 最小值=1 最大值=100
+
+# 打印结果
+打印消息 消息="生成的随机数是: ${随机数}"
+```
+
+## 更多示例
+
+查看 `pytest_dsl/examples/keyword_example.py` 文件获取更多示例。 

pytest_dsl/examples/__init__.py

@@ -0,0 +1,5 @@
+"""
+pytest-dsl示例模块
+
+包含框架使用的示例代码和资源文件。
+""" 

pytest_dsl/examples/assert/assertion_example.auto

@@ -0,0 +1,44 @@
+@name: 断言关键字示例
+@description: 演示不同断言关键字的使用方法
+@tags: [断言, JSON, 示例]
+@author: Felix
+@date: 2024-01-01
+
+# 基本断言示例
+[断言],条件:'1 + 1 == 2',消息:'基本算术断言失败'
+
+# 字符串断言
+str_value = "Hello, World!"
+[断言],条件:'${str_value} contains "Hello"',消息:'字符串包含断言失败'
+
+# 数字比较
+num1 = 10
+num2 = 5
+[数据比较],实际值:${num1},预期值:${num2},操作符:'>',消息:'数字比较断言失败'
+
+# 类型断言
+[类型断言],值:${str_value},类型:'string',消息:'类型断言失败'
+[类型断言],值:${num1},类型:'number',消息:'类型断言失败'
+
+# JSON数据处理
+json_data = '{"user": {"name": "张三", "age": 30, "roles": ["admin", "user"], "address": {"city": "北京", "country": "中国"}}}'
+
+# JSON提取示例
+username = [JSON提取],JSON数据:${json_data},JSONPath:'$.user.name',变量名:'username'
+[断言],条件:'${username} == "张三"',消息:'JSON提取断言失败'
+
+# JSON断言示例
+[JSON断言],JSON数据:${json_data},JSONPath:'$.user.age',预期值:30,操作符:'==',消息:'JSON断言失败：年龄不匹配'
+
+[JSON断言],JSON数据:${json_data},JSONPath:'$.user.roles[0]',预期值:'admin',消息:'JSON断言失败：角色不匹配'
+
+# 复杂JSON断言
+[JSON断言],JSON数据:${json_data},JSONPath:'$.user.address.city',预期值:'北京',消息:'JSON断言失败：城市不匹配'
+
+# 布尔值断言
+bool_value = True
+[断言],条件:'${bool_value} == True',消息:'布尔值断言失败'
+
+@teardown do
+    [打印],内容:'所有断言测试通过!'
+end 

pytest_dsl/examples/assert/boolean_test.auto

@@ -0,0 +1,34 @@
+@name: 布尔值断言测试
+@description: 测试断言关键字中的布尔值处理功能
+@tags: [断言, 布尔值, 示例]
+@author: Felix
+@date: 2024-01-01
+
+# 基本布尔值测试
+[断言],条件:'True == True',消息:'布尔值相等断言失败'
+[断言],条件:'False == False',消息:'布尔值相等断言失败'
+[断言],条件:'True != False',消息:'布尔值不等断言失败'
+
+# 字符串形式的布尔值测试
+true_string = 'True'
+false_string = 'False'
+[断言],条件:'${true_string} == True',消息:'字符串布尔值与布尔值相等断言失败'
+[断言],条件:'${false_string} == False',消息:'字符串布尔值与布尔值相等断言失败'
+
+# 使用数据比较关键字
+[数据比较],实际值:'True',预期值:True,消息:'布尔值数据比较失败'
+[数据比较],实际值:'false',预期值:False,消息:'小写布尔值数据比较失败'
+
+# 使用布尔值表达式
+[断言],条件:'True and True',消息:'布尔值AND表达式断言失败'
+[断言],条件:'True or False',消息:'布尔值OR表达式断言失败'
+[断言],条件:'not False',消息:'布尔值NOT表达式断言失败'
+
+# 变量布尔值表达式
+bool_true = True
+bool_false = False
+[断言],条件:'${bool_true} and not ${bool_false}',消息:'变量布尔值表达式断言失败'
+
+@teardown do
+    [打印],内容:'所有布尔值断言测试通过!'
+end 

pytest_dsl/examples/assert/expression_test.auto

@@ -0,0 +1,49 @@
+@name: 表达式断言测试
+@description: 测试断言关键字中的表达式支持功能
+@tags: [断言, 表达式, 示例]
+@author: Felix
+@date: 2024-01-01
+
+# 基本算术表达式
+[断言],条件:'1 + 1 == 2',消息:'基本加法断言失败'
+[断言],条件:'10 - 5 == 5',消息:'基本减法断言失败'
+[断言],条件:'3 * 4 == 12',消息:'基本乘法断言失败'
+[断言],条件:'20 / 4 == 5',消息:'基本除法断言失败'
+[断言],条件:'10 % 3 == 1',消息:'基本取模断言失败'
+
+# 复杂算术表达式
+[断言],条件:'(10 + 5) * 2 == 30',消息:'复合算术断言失败'
+[断言],条件:'10 + 5 * 2 == 20',消息:'优先级算术断言失败'
+
+# 表达式与变量结合
+base_value = 10
+multiplier = 2
+[断言],条件:'${base_value} * ${multiplier} == 20',消息:'变量表达式断言失败'
+
+# 字符串长度表达式
+text = "Hello, World!"
+[断言],条件:'len("${text}") == 13',消息:'字符串长度断言失败'
+
+# 复杂字符串操作
+[断言],条件:'"${text}".upper() contains "HELLO"',消息:'字符串方法断言失败'
+[断言],条件:'"${text}".split(",")[0] == "Hello"',消息:'字符串分割断言失败'
+
+# 直接算术表达式在左值
+[断言],条件:'5 + 5 > 8',消息:'左值表达式断言失败'
+[断言],条件:'5 + 5 < 20',消息:'左值表达式断言失败'
+
+# 直接函数调用
+[断言],条件:'len("test") == 4',消息:'函数调用断言失败'
+
+# 列表和字典操作
+[断言],条件:'len([1, 2, 3, 4]) == 4',消息:'列表长度断言失败'
+[断言],条件:'3 in [1, 2, 3, 4]',消息:'列表包含断言失败'
+[断言],条件:'"key" in {"key": "value"}',消息:'字典键断言失败'
+
+# 数据比较关键字与表达式结合
+[数据比较],实际值:'10 + 10',预期值:20,消息:'数据比较表达式失败'
+[数据比较],实际值:'len("Hello")',预期值:5,消息:'函数表达式比较失败'
+
+@teardown do
+    [打印],内容:'所有表达式断言测试通过!'
+end 

pytest_dsl/examples/http/__init__.py

@@ -0,0 +1,3 @@
+"""
+HTTP请求关键字示例模块
+""" 

pytest_dsl/examples/http/builtin_auth_test.auto

@@ -0,0 +1,79 @@
+@name: 内置认证测试
+@description: 演示内置认证提供者的使用
+@tags: [HTTP, API, 授权, 示例]
+@author: Felix
+@date: 2024-05-01
+
+# 内置认证测试示例
+# 演示内置认证提供者的使用
+
+# 测试Basic认证
+[HTTP请求],客户端:'basic_auth',配置:'''
+        method: GET
+        url: /headers
+        captures:
+            auth_header: ["jsonpath", "$.headers.Authorization"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.headers.Authorization", "startswith", "Basic "]
+    '''
+
+[打印],内容:'Basic认证头: ${auth_header}'
+
+# 测试Token认证
+[HTTP请求],客户端:'token_auth',配置:'''
+        method: GET
+        url: /headers
+        captures:
+            auth_header: ["jsonpath", "$.headers.Authorization"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.headers.Authorization", "eq", "Bearer test_token"]
+    '''
+
+[打印],内容:'Token认证头: ${auth_header}'
+
+# 测试API Key认证 (Header)
+[HTTP请求],客户端:'api_key_auth',配置:'''
+        method: GET
+        url: /headers
+        captures:
+            api_key: ["jsonpath", "$.headers.X-Api-Key"]
+            all_headers: ["jsonpath", "$.headers"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.headers.X-Api-Key", "eq", "test_api_key"]
+    '''
+
+[打印],内容:'API Key认证头: ${api_key}'
+[打印],内容:'所有响应头: ${all_headers}'
+
+# 测试API Key认证 (Query)
+[HTTP请求],客户端:'api_key_query_auth',配置:'''
+        method: GET
+        url: /anything
+        captures:
+            api_key: ["jsonpath", "$.args.api_key"]
+            all_args: ["jsonpath", "$.args"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.args.api_key", "eq", "test_api_key"]
+    '''
+
+[打印],内容:'API Key查询参数: ${api_key}'
+[打印],内容:'所有查询参数: ${all_args}'
+
+# 测试禁用认证
+[HTTP请求],客户端:'basic_auth',配置:'''
+        method: GET
+        url: /headers
+        disable_auth: true
+        captures:
+            all_headers: ["jsonpath", "$.headers"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.headers.Authorization", "not_exists"]
+    '''
+
+[打印],内容:'禁用认证后的响应头: ${all_headers}'
+[打印],内容:'内置认证测试完成' 

pytest_dsl/examples/http/csrf_auth_test.auto

@@ -0,0 +1,64 @@
+@name: CSRF登录授权测试
+@description: 演示CSRF登录授权提供者的使用
+@tags: [HTTP, API, 授权, CSRF, 示例]
+@author: Felix
+@date: 2024-05-20
+
+# CSRF登录授权测试示例
+# 演示CSRF登录授权提供者的使用
+
+# 测试CSRF登录认证
+[HTTP请求],客户端:'csrf_auth',配置:'''
+        method: GET
+        url: /headers
+        captures:
+            csrf_token: ["jsonpath", "$.headers.X-Csrf-Token"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.headers.X-Csrf-Token", "exists"]
+    '''
+
+[打印],内容:'CSRF令牌: ${csrf_token}'
+
+# 测试CSRF令牌过期后自动重新登录
+[HTTP请求],客户端:'csrf_auth',配置:'''
+        method: GET
+        url: /headers
+        headers:
+            X-Csrf-Token: expired_token  # 模拟过期令牌
+        captures:
+            csrf_token: ["jsonpath", "$.headers.X-Csrf-Token"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.headers.X-Csrf-Token", "exists"]
+    '''
+
+[打印],内容:'新的CSRF令牌: ${csrf_token}'
+
+# 测试需要CSRF令牌的POST请求
+[HTTP请求],客户端:'csrf_auth',配置:'''
+        method: POST
+        url: /anything
+        json:
+            test: "data"
+        captures:
+            headers: ["jsonpath", "$.headers"]
+            json: ["jsonpath", "$.json"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.headers.X-Csrf-Token", "exists"]
+    '''
+
+[打印],内容:'请求头: ${headers}'
+[打印],内容:'请求体: ${json}'
+
+# 测试禁用CSRF认证
+[HTTP请求],客户端:'csrf_auth',配置:'''
+        method: GET
+        url: /headers
+        disable_auth: true
+        asserts:
+            - ["status", "eq", 200]
+    '''
+
+[打印],内容:'CSRF登录授权测试完成' 

pytest_dsl/examples/http/custom_auth_test.auto

@@ -0,0 +1,76 @@
+@name: 自定义授权测试
+@description: 演示自定义授权提供者的使用
+@tags: [HTTP, API, 授权, 示例]
+@author: Felix
+@date: 2024-05-01
+
+# 自定义授权测试示例
+# 演示自定义授权提供者的使用
+
+# 测试HMAC签名授权
+[HTTP请求],客户端:'hmac_auth',配置:'''
+        method: GET
+        url: /headers
+        captures:
+            auth_header: ["jsonpath", "$.headers.Authorization"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.headers.Authorization", "exists"]
+            - ["jsonpath", "$.headers.X-Amz-Date", "exists"]
+    '''
+
+[打印],内容:'HMAC授权头: ${auth_header}'
+
+# 测试JWT刷新令牌授权
+[HTTP请求],客户端:'jwt_auth',配置:'''
+        method: GET
+        url: /headers
+        captures:
+            auth_header: ["jsonpath", "$.headers.Authorization"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.headers.Authorization", "startswith", "Bearer "]
+    '''
+
+[打印],内容:'JWT授权头: ${auth_header}'
+
+# 测试微信小程序授权
+[HTTP请求],客户端:'wechat_auth',配置:'''
+        method: GET
+        url: /headers
+        captures:
+            openid: ["jsonpath", "$.headers.X-Wx-Openid"]
+            session_key: ["jsonpath", "$.headers.X-Wx-Session-Key"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.headers.X-Wx-Openid", "exists"]
+            - ["jsonpath", "$.headers.X-Wx-Session-Key", "exists"]
+    '''
+
+[打印],内容:'微信OpenID: ${openid}'
+[打印],内容:'微信Session Key: ${session_key}'
+
+# 测试多步骤授权
+[HTTP请求],客户端:'multi_step_auth',配置:'''
+        method: GET
+        url: /headers
+        captures:
+            auth_header: ["jsonpath", "$.headers.Authorization"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.headers.Authorization", "startswith", "Bearer "]
+    '''
+
+[打印],内容:'多步骤授权头: ${auth_header}'
+
+# 测试禁用授权
+[HTTP请求],客户端:'multi_step_auth',配置:'''
+        method: GET
+        url: /headers
+        disable_auth: true
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.headers.Authorization", "not_exists"]
+    '''
+
+[打印],内容:'自定义授权测试完成'