pytest-dsl 0.1.0__py3-none-any.whl

pytest_dsl/examples/http/retry_assertions_only.auto

@@ -0,0 +1,52 @@
+@name: 只使用retry_assertions的断言重试示例
+@description: 不使用断言级别的retry标记，只使用独立的retry_assertions配置块
+@tags: [HTTP, API, 断言重试]
+@author: Felix
+@date: 2024-06-15
+
+# 使用全局retry_assertions配置所有断言
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/1
+        asserts:
+            - ["status", "eq", 200]
+            - ["response_time", "lt", 500]  # 可能会失败，因为请求延迟约1秒
+        # 全局重试配置
+        retry_assertions:
+            count: 2
+            interval: 1
+            all: true  # 重试所有断言
+    ''',步骤名称:"全局断言重试配置示例"
+
+# 使用特定断言索引重试
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/1
+        asserts:
+            - ["status", "eq", 200]          # 索引0
+            - ["response_time", "lt", 500]   # 索引1，需要重试
+        # 只重试指定索引的断言
+        retry_assertions:
+            count: 3
+            interval: 0.5
+            indices: [1]  # 只重试response_time断言
+    ''',步骤名称:"特定断言索引重试示例"
+
+# 使用特定断言配置
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/1
+        asserts:
+            - ["status", "eq", 200]          # 索引0
+            - ["response_time", "lt", 500]   # 索引1，使用特定配置
+            - ["body", "contains", "url"]    # 索引2
+        # 为特定断言提供自定义配置
+        retry_assertions:
+            specific:
+                "1": {  # 索引1的特定配置
+                    count: 4,
+                    interval: 0.3
+                }
+    ''',步骤名称:"特定断言配置重试示例"
+
+[打印],内容:'测试完成!' 

pytest_dsl/examples/http/retry_config_only.auto

@@ -0,0 +1,49 @@
+@name: 只使用全局配置的断言重试示例
+@description: 测试只使用retry_assertions配置的断言重试功能
+@tags: [HTTP, API, 断言重试]
+@author: Felix
+@date: 2024-06-15
+
+# 使用全局retry_assertions配置
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/1
+        asserts:
+            - ["status", "eq", 200]
+            - ["response_time", "lt", 500]
+        retry_assertions:
+            count: 2
+            interval: 1
+            all: true
+    ''',步骤名称:"全局断言重试示例"
+
+# 使用indices指定重试断言
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/1
+        asserts:
+            - ["status", "eq", 200]
+            - ["response_time", "lt", 500]
+        retry_assertions:
+            count: 3
+            interval: 0.5
+            indices: [1]
+    ''',步骤名称:"指定索引重试示例"
+
+# 使用specific为特定断言配置不同参数
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/1
+        asserts:
+            - ["status", "eq", 200]
+            - ["response_time", "lt", 500]
+            - ["body", "contains", "url"]
+        retry_assertions:
+            specific:
+                "1": {
+                    count: 4,
+                    interval: 0.3
+                }
+    ''',步骤名称:"特定断言配置示例"
+
+[打印],内容:'测试完成!' 

pytest_dsl/examples/http/retry_debug.auto

@@ -0,0 +1,22 @@
+@name: 断言重试调试示例
+@description: 使用更严格的断言条件测试断言重试功能
+@tags: [HTTP, API, 断言重试, 调试]
+@author: Felix
+@date: 2024-06-15
+
+[打印],内容:'开始测试断言重试功能 - 故意设置极低的响应时间限制'
+
+# 使用非常低的响应时间限制确保断言失败
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/1
+        asserts:
+            - ["status", "eq", 200]  # 这个会通过
+            - ["response_time", "lt", 50]  # 设置极低的值确保失败，1秒的延迟应该会超过50ms
+        retry_assertions:
+            count: 2
+            interval: 0.5
+            all: true
+    ''',步骤名称:"故意触发断言失败的示例"
+
+[打印],内容:'测试完成 - 如果执行到这里，说明重试逻辑正常工作' 

pytest_dsl/examples/http/retry_with_fix.auto

@@ -0,0 +1,21 @@
+@name: 全局断言重试示例
+@description: 使用全局retry_assertions配置测试断言重试功能
+@tags: [HTTP, API, 断言重试]
+@author: Felix
+@date: 2024-06-15
+
+# 使用全局retry_assertions配置
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/1
+        asserts:
+            - ["status", "eq", 200]
+            - ["response_time", "lt", 1000]
+        # 全局重试配置
+        retry_assertions:
+            count: 2
+            interval: 1
+            indices: [1]  # 只重试response_time断言
+    ''',步骤名称:"全局重试配置示例"
+
+[打印],内容:'测试完成!' 

pytest_dsl/examples/http/simple_retry.auto

@@ -0,0 +1,20 @@
+@name: 简单断言重试示例
+@description: 测试断言重试功能的基本使用
+@tags: [HTTP, API, 断言重试]
+@author: Felix
+@date: 2024-06-01
+
+# 使用独立的retry_assertions配置
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/1
+        asserts:
+            - ["status", "eq", 200]
+            - ["response_time", "lt", 5000]
+        retry_assertions:
+            count: 2
+            interval: 1
+            all: true
+    ''',步骤名称:"简单断言重试示例"
+
+[打印],内容:'测试完成!' 

pytest_dsl/examples/http/vars.yaml

@@ -0,0 +1,55 @@
+# HTTP客户端配置
+http_clients:
+  default:  # 默认客户端配置
+    base_url: https://httpbin.org
+    headers:
+      User-Agent: pytest-dsl-client/1.0
+      Accept: application/json
+    timeout: 30
+    verify_ssl: true
+    session: true
+  
+  jsonplaceholder:  # JSONPlaceholder API客户端
+    base_url: https://jsonplaceholder.typicode.com
+    headers:
+      User-Agent: pytest-dsl-client/1.0
+      Accept: application/json
+    timeout: 15
+    verify_ssl: true
+    session: true
+    retry:
+      max_retries: 2
+      retry_interval: 1
+      retry_on_status: [500, 502, 503, 504]
+
+# HTTP请求模板
+http_templates:
+  json_post:
+    method: POST
+    request:
+      headers:
+        Content-Type: application/json
+      json: {}
+    asserts:
+      - ["status", "in", [200, 201]]
+
+  api_auth:
+    method: POST
+    url: /auth/login
+    request:
+      headers:
+        Content-Type: application/json
+      json:
+        username: ""
+        password: ""
+    captures:
+      token: ["jsonpath", "$.token"]
+    asserts:
+      - ["status", "eq", 200]
+      - ["jsonpath", "$.token", "exists"]
+
+# 测试数据
+api_test_data:
+  username: test_user
+  password: password123
+  user_id: 10 

pytest_dsl/examples/http_clients.yaml

@@ -0,0 +1,48 @@
+http_clients:
+  hmac_auth:
+    base_url: https://httpbin.org
+    headers:
+      User-Agent: pytest-dsl-client/1.0
+      Accept: application/json
+    timeout: 30
+    verify_ssl: true
+    session: true
+    auth:
+      type: custom
+      provider_name: hmac_aws_auth
+  
+  jwt_auth:
+    base_url: https://httpbin.org
+    headers:
+      User-Agent: pytest-dsl-client/1.0
+      Accept: application/json
+    timeout: 30
+    verify_ssl: true
+    session: true
+    auth:
+      type: custom
+      provider_name: jwt_refresh_auth
+  
+  wechat_auth:
+    base_url: https://httpbin.org
+    headers:
+      User-Agent: pytest-dsl-client/1.0
+      Accept: application/json
+    timeout: 30
+    verify_ssl: true
+    session: true
+    auth:
+      type: custom
+      provider_name: wechat_miniapp_auth
+  
+  multi_step_auth:
+    base_url: https://httpbin.org
+    headers:
+      User-Agent: pytest-dsl-client/1.0
+      Accept: application/json
+    timeout: 30
+    verify_ssl: true
+    session: true
+    auth:
+      type: custom
+      provider_name: multi_step_auth 

pytest_dsl/examples/keyword_example.py

@@ -0,0 +1,70 @@
+"""
+示例: 如何在您的项目中创建自定义关键字
+
+将该文件放在您项目的 keywords 目录下，
+例如: my_project/keywords/my_keywords.py
+
+pytest-dsl 会自动导入这些关键字。
+"""
+
+from pytest_dsl.core.keyword_manager import keyword_manager
+
+# 示例1: 简单关键字
+@keyword_manager.register('打印消息', [
+    {'name': '消息', 'mapping': 'message', 'description': '要打印的消息内容'},
+])
+def print_message(**kwargs):
+    """打印一条消息到控制台
+    
+    Args:
+        message: 要打印的消息
+        context: 测试上下文 (自动传入)
+    """
+    message = kwargs.get('message', '')
+    print(f"自定义关键字消息: {message}")
+    return True
+
+# 示例2: 带返回值的关键字
+@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
+
+# 示例3: 操作上下文的关键字
+@keyword_manager.register('保存到上下文', [
+    {'name': '键名', 'mapping': 'key', 'description': '保存在上下文中的键名'},
+    {'name': '值', 'mapping': 'value', 'description': '要保存的值'},
+])
+def save_to_context(**kwargs):
+    """将值保存到测试上下文中
+    
+    Args:
+        key: 键名
+        value: 要保存的值
+        context: 测试上下文 (自动传入)
+    """
+    key = kwargs.get('key')
+    value = kwargs.get('value')
+    context = kwargs.get('context')
+    
+    if key and context:
+        context.set(key, value)
+        return True
+    return False 

pytest_dsl/examples/test_assert.py

@@ -0,0 +1,16 @@
+"""装饰器测试示例
+
+该示例展示如何使用auto_dsl装饰器创建测试类
+"""
+
+from pytest_dsl.core.auto_decorator import auto_dsl
+
+
+# 同时使用多个目录的测试类
+@auto_dsl("./assert")
+class TestAssert:
+    """断言测试类
+    
+    该类使用auto_dsl装饰器，测试assert目录下的.auto文件。
+    """
+    pass

pytest_dsl/examples/test_http.py

@@ -0,0 +1,168 @@
+"""装饰器测试示例
+
+该示例展示如何使用auto_dsl装饰器创建测试类
+"""
+
+from pytest_dsl.core.auto_decorator import auto_dsl
+from pytest_dsl.core.auth_provider import register_auth_provider, CustomAuthProvider
+import requests
+import json
+import logging
+import sys
+
+# 配置日志输出
+logging.basicConfig(
+    level=logging.DEBUG,  # 设置为DEBUG级别
+    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
+    stream=sys.stdout
+)
+logger = logging.getLogger("CSRF_AUTH_DEBUG")
+
+
+@auto_dsl("./http")
+class TestHttp:
+    """HTTP测试类
+    
+    该类使用auto_dsl装饰器，测试http目录下的.auto文件。
+    """
+    pass
+
+# 定义自定义认证提供者
+class HMACAuthProvider(CustomAuthProvider):
+    def apply_auth(self, request_kwargs):
+        if "headers" not in request_kwargs:
+            request_kwargs["headers"] = {}
+        request_kwargs["headers"]["Authorization"] = "HMAC-SHA256 test_signature"
+        request_kwargs["headers"]["X-Amz-Date"] = "20240501T120000Z"
+        return request_kwargs
+
+class JWTAuthProvider(CustomAuthProvider):
+    def apply_auth(self, request_kwargs):
+        if "headers" not in request_kwargs:
+            request_kwargs["headers"] = {}
+        request_kwargs["headers"]["Authorization"] = "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example_token"
+        return request_kwargs
+
+class WeChatAuthProvider(CustomAuthProvider):
+    def apply_auth(self, request_kwargs):
+        if "headers" not in request_kwargs:
+            request_kwargs["headers"] = {}
+        request_kwargs["headers"]["X-Wx-Openid"] = "test_openid"
+        request_kwargs["headers"]["X-Wx-Session-Key"] = "test_session_key"
+        return request_kwargs
+
+class MultiStepAuthProvider(CustomAuthProvider):
+    def apply_auth(self, request_kwargs):
+        if "headers" not in request_kwargs:
+            request_kwargs["headers"] = {}
+        request_kwargs["headers"]["Authorization"] = "Bearer multi_step_token"
+        return request_kwargs
+
+class CSRFLoginAuthProvider(CustomAuthProvider):
+    """CSRF登录认证提供者
+    
+    该提供者实现了一个需要先登录获取CSRF令牌，然后在后续请求中使用该令牌的认证流程。
+    为了适应httpbin.org的测试，这里模拟了CSRF认证流程。
+    """
+    def __init__(self):
+        self._csrf_token = None
+        self._session = requests.Session()
+        logger.setLevel(logging.DEBUG)  # 设置日志级别为DEBUG
+        
+    def apply_auth(self, request_kwargs):
+        # 确保headers存在
+        if "headers" not in request_kwargs:
+            request_kwargs["headers"] = {}
+            
+        # 如果还没有CSRF令牌，先登录获取
+        if not self._csrf_token:
+            self._login()
+            
+        # 添加CSRF令牌到请求头
+        request_kwargs["headers"]["X-Csrf-Token"] = self._csrf_token
+        
+        # 设置Content-Type头
+        # 如果请求中有JSON数据
+        if "json" in request_kwargs:
+            request_kwargs["headers"]["Content-Type"] = "application/json"
+            logger.debug(f"请求体 (JSON): {json.dumps(request_kwargs['json'])}")
+        # 如果请求中有表单数据
+        elif "data" in request_kwargs:
+            # 如果data是字典，默认为表单数据
+            if isinstance(request_kwargs["data"], dict):
+                if "Content-Type" not in request_kwargs["headers"]:
+                    request_kwargs["headers"]["Content-Type"] = "application/x-www-form-urlencoded"
+            logger.debug(f"请求体 (form): {request_kwargs['data']}")
+        
+        # 调试信息：打印请求信息
+        method = request_kwargs.get('method', 'GET')
+        url = request_kwargs.get('url', '')
+        logger.debug(f"发送请求: {method} {url}")
+        logger.debug(f"请求头: {json.dumps(request_kwargs.get('headers', {}))}")
+        
+        return request_kwargs
+    
+    def clean_auth_state(self, request_kwargs=None):
+        """清理CSRF认证状态
+        
+        清理CSRF认证相关的状态，包括令牌和会话。
+        
+        Args:
+            request_kwargs: 请求参数
+            
+        Returns:
+            更新后的请求参数
+        """
+        # 重置CSRF令牌
+        logger.debug("清理CSRF认证状态")
+        self._csrf_token = None
+        
+        # 如果有会话，清理会话
+        if self._session:
+            self._session.cookies.clear()
+            logger.debug("已清理CSRF会话cookie")
+            
+        # 处理请求参数
+        if request_kwargs:
+            if "headers" not in request_kwargs:
+                request_kwargs["headers"] = {}
+                
+            # 移除CSRF相关头
+            csrf_headers = ['X-Csrf-Token', 'X-CSRF-Token', 'csrf-token', 'CSRF-Token']
+            for header in csrf_headers:
+                if header in request_kwargs["headers"]:
+                    request_kwargs["headers"].pop(header)
+                    logger.debug(f"已移除请求头: {header}")
+                    
+        # 标记会话已管理
+        self.manage_session = True
+                    
+        return request_kwargs if request_kwargs else {}
+        
+    def _login(self):
+        """执行登录流程获取CSRF令牌
+        
+        由于httpbin.org没有实际的登录系统，这里模拟一个登录流程
+        """
+        # 对于测试目的，生成一个模拟的CSRF令牌
+        self._csrf_token = "csrf_token_12345678"
+        logger.debug(f"生成CSRF令牌: {self._csrf_token}")
+
+        # 如果使用真实API，可以使用类似下面的代码
+        # 1. 获取登录页面，提取CSRF令牌
+        # login_page = self._session.get("https://httpbin.org/headers")
+        # login_page.raise_for_status()
+        
+        # 2. 执行登录请求
+        # login_response = self._session.post(
+        #     "https://httpbin.org/anything",
+        #     json={"username": "test_user", "password": "test_password"}
+        # )
+        # login_response.raise_for_status()
+
+# 注册自定义认证提供者
+register_auth_provider("hmac_aws_auth", HMACAuthProvider)
+register_auth_provider("jwt_refresh_auth", JWTAuthProvider)
+register_auth_provider("wechat_miniapp_auth", WeChatAuthProvider)
+register_auth_provider("multi_step_auth", MultiStepAuthProvider)
+register_auth_provider("csrf_login_auth", CSRFLoginAuthProvider)

pytest_dsl/keywords/__init__.py

@@ -0,0 +1,10 @@
+"""
+自动导入所有关键字模块以注册关键字
+"""
+from . import system_keywords
+from . import global_keywords  # 全局变量关键字
+from . import assertion_keywords
+from . import http_keywords  # HTTP请求关键字
+
+# 可以在这里添加更多关键字模块的导入
+__all__ = ['system_keywords', 'global_keywords', 'assertion_keywords', 'http_keywords']