pytest-dsl 0.1.0__py3-none-any.whl

pytest_dsl/examples/http/file_reference_test.auto

@@ -0,0 +1,111 @@
+@name: 外部文件引用测试
+@description: 演示如何在HTTP请求中使用外部文件引用
+@tags: [HTTP, 文件引用, 示例]
+@author: Felix
+@date: 2024-04-08
+
+# 设置测试变量
+username = "张三"
+email = "zhangsan@example.com"
+password = "test123456"
+age = 28
+city = "上海"
+theme = "light"
+skills = "Java,Go,React"
+role = "开发工程师"
+current_date = "2024-04-08T12:00:00Z"
+
+# 示例1: 使用简单文件引用语法加载静态JSON
+[打印],内容:'1. 测试简单文件引用语法 - 静态JSON'
+
+[HTTP请求],客户端:'default',配置:'''
+        method: POST
+        url: https://httpbin.org/post
+        request:
+            headers:
+                Content-Type: application/json
+            json: "@file:pytest_dsl/examples/http/data/user_data.json"
+        captures:
+            user_name: ["jsonpath", "$.json.user.name"]
+            user_email: ["jsonpath", "$.json.user.email"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.json.user.name", "eq", "测试用户"]
+    ''',步骤名称: "使用静态JSON文件发送请求"
+
+[打印],内容:'捕获的用户名: ${user_name}'
+[打印],内容:'捕获的邮箱: ${user_email}'
+
+# 示例2: 使用简单文件模板语法加载带变量的JSON
+[打印],内容:'2. 测试简单文件引用语法 - 带变量的JSON模板'
+
+[HTTP请求],客户端:'default',配置:'''
+        method: POST
+        url: https://httpbin.org/post
+        request:
+            headers:
+                Content-Type: application/json
+            json: "@file_template:pytest_dsl/examples/http/data/user_template.json"
+        captures:
+            user_name: ["jsonpath", "$.json.user.name"]
+            user_email: ["jsonpath", "$.json.user.email"]
+            metadata_date: ["jsonpath", "$.json.metadata.created_at"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.json.user.name", "eq", "${username}"]
+            - ["jsonpath", "$.json.metadata.created_at", "eq", "${current_date}"]
+    ''',步骤名称: "使用带变量的JSON模板文件发送请求"
+
+[打印],内容:'用户名被替换为: ${user_name}'
+[打印],内容:'创建日期被替换为: ${metadata_date}'
+
+# 示例3: 使用详细文件引用语法
+[打印],内容:'3. 测试详细文件引用语法'
+
+[HTTP请求],客户端:'default',配置:'''
+        method: POST
+        url: https://httpbin.org/post
+        request:
+            headers:
+                Content-Type: application/json
+            json:
+                file_ref:
+                    path: "pytest_dsl/examples/http/data/user_data.json"
+                    type: "json"
+                    template: false
+                    encoding: "utf-8"
+        captures:
+            skills: ["jsonpath", "$.json.user.skills"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.json.user.skills", "length", 4]
+    ''',步骤名称: "使用详细文件引用语法发送请求"
+
+[打印],内容:'捕获的技能列表: ${skills}'
+
+# 示例4: 将外部文件引用与请求JSON部分合并
+[打印],内容:'4. 测试将外部文件与请求JSON合并'
+
+[HTTP请求],客户端:'default',配置:'''
+        method: POST
+        url: https://httpbin.org/post
+        request:
+            headers:
+                Content-Type: application/json
+            json:
+                file_ref:
+                    path: "pytest_dsl/examples/http/data/user_template.json"
+                    template: true
+                extra_field: "附加字段"
+                timestamp: ${current_date}
+        captures:
+            request_json: ["jsonpath", "$.json"]
+        asserts:
+            - ["status", "eq", 200]
+    ''',步骤名称: "合并外部文件与请求JSON"
+
+[打印],内容:'请求JSON已合并: ${request_json}'
+
+@teardown do
+    [打印],内容:'外部文件引用测试完成!'
+end 

pytest_dsl/examples/http/http_advanced.auto

@@ -0,0 +1,91 @@
+@name: HTTP请求关键字高级示例
+@description: "展示HTTP请求关键字的高级用法包括会话管理，和客户端配置"
+@tags: [HTTP, API, 高级, 示例]
+@author: Felix
+@date: 2024-04-01
+
+# 本例使用httpbin.org作为测试API
+
+# 创建并使用会话示例
+[HTTP请求],会话:'test_session',配置:'''
+        method: GET
+        url: https://httpbin.org/cookies/set
+        request:
+            params:
+                session_id: abcd1234
+                user: testuser
+        asserts:
+            - ["status", "eq", 200]
+    '''
+
+# 验证会话中的Cookie已保存
+[HTTP请求],会话:'test_session',配置:'''
+        method: GET
+        url: https://httpbin.org/cookies
+        captures:
+            session_id: ["jsonpath", "$.cookies.session_id"]
+            user: ["jsonpath", "$.cookies.user"]
+        asserts:
+            - ["jsonpath", "$.cookies.session_id", "eq", "abcd1234"]
+            - ["jsonpath", "$.cookies.user", "eq", "testuser"]
+    '''
+
+[打印],内容:'会话Cookie - session_id: ${session_id}, user: ${user}'
+
+# 使用请求头
+[HTTP请求],配置:'''
+        method: GET
+        url: https://httpbin.org/headers
+        request:
+            headers:
+                Custom-Header: test-value
+                User-Agent: pytest-dsl-client
+        captures:
+            custom_header: ["jsonpath", "$.headers.Custom-Header"]
+            user_agent: ["jsonpath", "$.headers.User-Agent"]
+        asserts:
+            - ["jsonpath", "$.headers.Custom-Header", "eq", "test-value"]
+    '''
+
+[打印],内容:'请求头 - Custom-Header: ${custom_header}, User-Agent: ${user_agent}'
+
+# 使用响应对象
+[HTTP请求],配置:'''
+        method: POST
+        url: https://httpbin.org/anything
+        request:
+            json:
+                message: 测试消息
+                timestamp: 1234567890
+        captures:
+            json_data: ["jsonpath", "$.json"]
+        save_response: full_response
+    '''
+
+# 正则表达式提取示例
+[HTTP请求],配置:'''
+        method: GET
+        url: https://httpbin.org/html
+        captures:
+            title: ["regex", "<h1>(.*?)</h1>"]
+        asserts:
+            - ["regex", "<h1>(.*?)</h1>", "matches", ".*Melville.*"]
+    '''
+
+[打印],内容:'HTML标题: ${title}'
+
+# XPath提取示例
+[HTTP请求],配置:'''
+        method: GET
+        url: https://httpbin.org/html
+        captures:
+            p_text: ["xpath", "//p/text()"]
+        asserts:
+            - ["status", "eq", 200]
+    '''
+
+[打印],内容:'段落文本: ${p_text}'
+
+@teardown do
+    [打印],内容:'HTTP高级测试完成!'
+end 

pytest_dsl/examples/http/http_example.auto

@@ -0,0 +1,147 @@
+@name: HTTP请求关键字示例
+@description: 演示HTTP请求关键字的基本用法
+@tags: [HTTP, API, 示例]
+@author: Felix
+@date: 2024-04-01
+
+# 基本GET请求示例
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://jsonplaceholder.typicode.com/posts/1
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.id", "eq", 1]
+            - ["body", "matches", "^.*"]
+            - ["jsonpath", "$.title", "exists"]
+    ''',步骤名称: "使用默认客户端获取博客信息"
+
+# 带参数的GET请求
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://jsonplaceholder.typicode.com/posts
+        request:
+            params:
+                userId: 1
+        captures:
+            first_post_id: ["jsonpath", "$[0].id"]
+            data_length: ["jsonpath", "$", "length"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$", "type", "array"]
+            - ["jsonpath", "$", "length", "gte", 8]
+    '''
+
+# 显示捕获的变量
+[打印],内容:'第一篇文章ID: ${first_post_id}, 文章总数: ${data_length}'
+
+# POST请求示例
+[HTTP请求],客户端:'default',配置:'''
+        method: POST
+        url: https://jsonplaceholder.typicode.com/posts
+        request:
+            headers:
+                Content-Type: application/json
+            json:
+                title: 测试标题
+                body: 测试内容
+                userId: 1
+        captures:
+            new_post_id: ["jsonpath", "$.id"]
+        asserts:
+            - ["status", "eq", 201]
+            - ["jsonpath", "$.title", "eq", "测试标题"]
+            - ["jsonpath", "$.id", "exists"]
+    '''
+
+[打印],内容:'新创建的文章ID: ${new_post_id}'
+
+# 使用响应时间断言
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://jsonplaceholder.typicode.com/posts
+        captures:
+            response_time: ["response_time"]
+        asserts:
+            - ["response_time", "lt", 3000]  # 响应时间小于3000ms
+    '''
+
+[打印],内容:'请求响应时间: ${response_time}ms'
+
+# 断言重试功能演示 - 模拟数据处理API
+[打印],内容:'开始测试断言重试功能 - 模拟数据处理场景'
+
+# 步骤1: 创建一个任务（模拟启动数据处理）
+[HTTP请求],客户端:'default',配置:'''
+        method: POST
+        url: https://httpbin.org/post
+        request:
+            headers:
+                Content-Type: application/json
+            json:
+                task_type: "data_analysis"
+                dataset_id: "sample123"
+                parameters: {
+                    "analysis_depth": "detailed",
+                    "include_graphs": true
+                }
+        captures:
+            task_id: ["jsonpath", "$.json.dataset_id"]
+            timestamp: ["jsonpath", "$.headers.Host"]
+        asserts:
+            - ["status", "eq", 200]
+    '''
+
+[打印],内容:'已创建分析任务，任务ID: ${task_id}'
+
+# 步骤2: 查询任务状态 - 使用断言重试功能等待"完成"状态
+# 由于这是模拟场景，我们使用 httpbin.org/delay/2 来模拟处理延迟
+# 在实际场景中，API可能需要一段时间才能返回预期结果
+
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/2
+        request:
+            params:
+                task_id: ${task_id}
+                _: ${timestamp}  # 添加时间戳防止缓存
+        captures:
+            url: ["jsonpath", "$.url"]
+            task_details: ["jsonpath", "$.args"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.args.task_id", "eq", "${task_id}"]  # 这个断言一定会通过
+            - ["response_time", "lt", 1000]  # 这个断言可能失败，因为延迟是2秒
+    ''',断言重试次数: 3,断言重试间隔: 1
+
+[打印],内容:'任务查询完成，URL: ${url}'
+[打印],内容:'任务详情: ${task_details}'
+
+# 步骤3: 演示更复杂的断言重试场景 - 使用随机数模拟不确定结果
+[打印],内容:'开始测试断言重试功能 - 随机结果场景'
+
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://www.random.org/integers/
+        request:
+            params:
+                num: 1
+                min: 1
+                max: 10
+                col: 1
+                base: 10
+                format: plain
+        captures:
+            random_number: ["body"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["body", "matches", "^[0-9]+$"]  # 确认结果是数字
+            # 下面的断言大概有50%的几率成功，50%的几率失败，需要重试
+            - ["body", "lt", 6]  # 断言随机数小于6
+    ''',断言重试次数: 5,断言重试间隔: 2
+
+[打印],内容:'获取的随机数: ${random_number}'
+[打印],内容:'断言重试测试完成!'
+
+@teardown do
+    [打印],内容:'HTTP请求测试完成!'
+end 

pytest_dsl/examples/http/http_length_test.auto

@@ -0,0 +1,55 @@
+@name: HTTP请求长度捕获测试
+@description: 测试HTTP请求关键字中的长度捕获功能
+@tags: [HTTP, API, 长度捕获, 示例]
+@author: Felix
+@date: 2024-04-01
+
+# 测试捕获数组长度
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://jsonplaceholder.typicode.com/users
+        captures:
+            # 测试直接捕获数组长度
+            users_count: ["jsonpath", "$", "length"]
+            # 测试嵌套数组长度
+            first_user_company: ["jsonpath", "$[0].company"]
+            # 测试字符串长度
+            first_user_name: ["jsonpath", "$[0].name"]
+            first_name_length: ["jsonpath", "$[0].name", "length"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$", "type", "array"]
+    '''
+
+# 显示捕获结果
+[打印],内容:'用户总数: ${users_count}'
+[打印],内容:'第一个用户公司信息: ${first_user_company}'
+[打印],内容:'第一个用户名: ${first_user_name}'
+[打印],内容:'用户名长度: ${first_name_length}'
+
+# 测试捕获嵌套对象的字段数量
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://jsonplaceholder.typicode.com/posts/1
+        captures:
+            # 测试对象字段数量
+            post_fields_count: ["jsonpath", "$", "length"]
+            # 测试对象中特定字段的长度
+            title: ["jsonpath", "$.title"]
+            title_length: ["jsonpath", "$.title", "length"]
+            body: ["jsonpath", "$.body"]
+            body_length: ["jsonpath", "$.body", "length"]
+        asserts:
+            - ["status", "eq", 200]
+    '''
+
+# 显示捕获结果
+[打印],内容:'帖子字段数量: ${post_fields_count}'
+[打印],内容:'标题: ${title}'
+[打印],内容:'标题长度: ${title_length}'
+[打印],内容:'正文: ${body}'
+[打印],内容:'正文长度: ${body_length}'
+
+@teardown do
+    [打印],内容:'HTTP请求长度捕获测试完成!'
+end 

pytest_dsl/examples/http/http_retry_assertions.auto

@@ -0,0 +1,91 @@
+@name: HTTP请求断言重试配置示例
+@description: 演示新的retry_assertions配置式断言重试功能
+@tags: [HTTP, API, 断言重试, 示例]
+@author: Felix
+@date: 2024-06-15
+
+# 示例1: 使用旧版全局配置重试所有断言
+[打印],内容:'示例1: 使用旧版全局配置重试所有断言'
+
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/2
+        retry:
+            count: 3
+            interval: 1
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.url", "contains", "httpbin.org"]
+            - ["response_time", "lt", 1000]  # 这个断言可能会失败，因为请求延迟约2秒
+    ''',步骤名称: "旧版全局断言重试示例"
+
+# 示例2: 使用indices指定重试特定断言
+[打印],内容:'示例2: 使用indices指定重试特定断言'
+
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://www.random.org/integers/
+        request:
+            params:
+                num: 1
+                min: 1
+                max: 10
+                col: 1
+                base: 10
+                format: plain
+        captures:
+            random_number: ["body"]
+        asserts:
+            - ["status", "eq", 200]             # 索引0
+            - ["body", "matches", "^[0-9]+$"]   # 索引1
+            - ["body", "lt", 6]                 # 索引2 - 需要重试
+            - ["response_time", "lt", 10000]    # 索引3
+        retry_assertions:
+            count: 5
+            interval: 2
+            indices: [2]  # 只重试索引为2的断言（即body < 6）
+    ''',步骤名称:"特定断言重试示例"
+
+[打印],内容:'获取的随机数: ${random_number}'
+
+# 示例3: 使用specific为不同断言设置不同的重试参数
+[打印],内容:'示例3: 使用specific为不同断言设置不同的重试参数'
+
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/1
+        asserts:
+            - ["status", "eq", 200]                # 索引0
+            - ["response_time", "lt", 800]         # 索引1
+            - ["jsonpath", "$.headers.Host", "eq", "httpbin.org"]  # 索引2
+            - ["jsonpath", "$.url", "contains", "httpbin.org"]     # 索引3
+        retry_assertions:
+            count: 2         # 默认重试次数
+            interval: 1      # 默认重试间隔
+            indices: [1, 2]  # 只重试索引1和2的断言
+            specific:
+                "2": {       # 为索引2的断言设置特定参数
+                    count: 4,
+                    interval: 0.5
+                }
+            # 注意：索引3不会重试，因为没有包含在indices中
+    ''',步骤名称:"混合断言重试策略示例"
+
+# 示例4: 使用all=true重试所有断言
+[打印],内容:'示例4: 使用all=true重试所有断言'
+
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/status/200
+        asserts:
+            - ["status", "eq", 200]
+            - ["response_time", "lt", 100]  # 可能会失败
+        retry_assertions:
+            count: 3
+            interval: 1.5
+            all: true  # 重试所有断言
+    ''',步骤名称:"全局断言重试示例"
+
+@teardown do
+    [打印],内容:'断言重试测试完成!'
+end 

pytest_dsl/examples/http/http_retry_assertions_enhanced.auto

@@ -0,0 +1,94 @@
+@name: HTTP请求增强断言重试示例
+@description: 演示新的独立断言重试配置结构
+@tags: [HTTP, API, 断言重试, 增强配置]
+@author: Felix
+@date: 2024-06-01
+
+# 示例1: 使用独立的retry_assertions配置
+[打印],内容:'示例1: 使用独立的retry_assertions配置'
+
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/2
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.url", "contains", "httpbin.org"]
+            - ["response_time", "lt", 1000]  # 这个断言可能会失败，因为请求延迟约2秒
+        retry_assertions:
+            count: 3
+            interval: 1
+            all: true
+    ''',步骤名称: "独立断言重试配置示例"
+
+# 示例2: 对指定索引的断言进行重试
+[打印],内容:'示例2: 对指定索引的断言进行重试'
+
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://www.random.org/integers/
+        request:
+            params:
+                num: 1
+                min: 1
+                max: 10
+                col: 1
+                base: 10
+                format: plain
+        captures:
+            random_number: ["body"]
+        asserts:
+            - ["status", "eq", 200]                # 索引0
+            - ["body", "matches", "^[0-9]+$"]      # 索引1
+            - ["body", "lt", 6]                    # 索引2 - 需要重试
+            - ["response_time", "lt", 10000]       # 索引3
+        retry_assertions:
+            count: 5
+            interval: 2
+            indices: [2]  # 只重试索引为2的断言（即body < 6）
+    ''',步骤名称:"指定索引断言重试示例"
+
+[打印],内容:'获取的随机数: ${random_number}'
+
+# 示例3: 为特定断言指定不同的重试策略
+[打印],内容:'示例3: 为特定断言指定不同的重试策略'
+
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/delay/1
+        asserts:
+            - ["status", "eq", 200]                # 索引0
+            - ["response_time", "lt", 800]         # 索引1
+            - ["jsonpath", "$.headers.Host", "eq", "httpbin.org"]  # 索引2
+        retry_assertions:
+            # 全局设置
+            count: 2
+            interval: 1
+            # 针对特定断言的设置
+            specific:
+                "1": {  # 对索引1的断言使用特定配置
+                    count: 4,
+                    interval: 0.5
+                }
+            # 不重试索引0的断言
+            indices: [1, 2]
+    ''',步骤名称:"混合断言重试策略示例"
+
+# 示例4: 只使用新式配置
+[打印],内容:'示例4: 只使用新式配置'
+
+[HTTP请求],客户端:'default',配置:'''
+        method: GET
+        url: https://httpbin.org/status/200
+        asserts:
+            - ["status", "eq", 200]
+            - ["response_time", "lt", 5000]
+        # 使用新的独立重试配置
+        retry_assertions:
+            count: 3
+            interval: 1.5
+            all: true
+    ''',步骤名称:"纯配置式重试示例"
+
+@teardown do
+    [打印],内容:'增强断言重试测试完成!'
+end 

pytest_dsl/examples/http/http_with_yaml.auto

@@ -0,0 +1,58 @@
+@name: 使用YAML变量的HTTP请求示例
+@description: 演示如何使用YAML变量文件中的客户端配置和模板
+@tags: [HTTP, API, YAML, 模板]
+@author: Felix
+@date: 2024-04-01
+
+# 注意：运行此测试用例需要使用 --yaml-vars 命令行参数指定vars.yaml文件
+# 例如：pytest-dsl --yaml-vars pytest_dsl/examples/http/vars.yaml pytest_dsl/examples/http/http_with_yaml.auto
+
+# 使用命名客户端配置
+[HTTP请求],客户端:'jsonplaceholder',配置:'''
+        method: GET
+        url: /users/${api_test_data.user_id}
+        captures:
+            username: ["jsonpath", "$.username"]
+            email: ["jsonpath", "$.email"]
+            company_name: ["jsonpath", "$.company.name"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.id", "eq", ${api_test_data.user_id}]
+    '''
+
+[打印],内容:'用户信息 - 用户名: ${username}, 邮箱: ${email}, 公司: ${company_name}'
+
+# 使用模板
+[HTTP请求],客户端:'jsonplaceholder',模板:'json_post',配置:'''
+        url: /posts
+        request:
+            json:
+                title: 使用模板创建的文章
+                body: 这是使用模板创建的测试文章内容
+                userId: ${api_test_data.user_id}
+        captures:
+            new_post_id: ["jsonpath", "$.id"]
+    '''
+
+[打印],内容:'使用模板创建的文章ID: ${new_post_id}'
+
+# 使用默认客户端（httpbin.org）
+[HTTP请求],配置:'''
+        method: GET
+        url: /get
+        request:
+            params:
+                user_id: ${api_test_data.user_id}
+                username: ${api_test_data.username}
+        captures:
+            args: ["jsonpath", "$.args"]
+        asserts:
+            - ["status", "eq", 200]
+            - ["jsonpath", "$.args.user_id", "eq", "${api_test_data.user_id}"]
+    '''
+
+[打印],内容:'请求参数: ${args}'
+
+@teardown do
+    [打印],内容:'YAML变量和模板测试完成!'
+end 

pytest_dsl/examples/http/new_retry_test.auto

@@ -0,0 +1,22 @@
+@name: 新的断言重试示例
+@description: 测试修改后的断言重试机制
+@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", 100]  # 强制失败，设置为很小的值
+        retry_assertions:
+            count: 2
+            interval: 1
+            all: true
+    ''',步骤名称:"全局断言重试示例"
+
+[打印],内容:'测试完成!'