pytest-dsl 0.5.0__tar.gz → 0.6.0__tar.gz

{pytest_dsl-0.5.0/pytest_dsl.egg-info → pytest_dsl-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-dsl
-Version: 0.5.0
+Version: 0.6.0
 Summary: A DSL testing framework based on pytest
 Author: Chen Shuanglin
 License: MIT
@@ -60,7 +60,7 @@ for i in range(1, 3) do
     [打印],内容: "循环次数: ${i}"
 end
 
-@teardown do
+teardown do
     [打印],内容: "测试完成!"
 end
 ```
@@ -147,7 +147,7 @@ pytest-dsl允许在DSL文件中直接定义自定义关键字，类似于编程
 @name: "自定义关键字示例"
 
 # 定义一个简单的关键字（函数）
-@keyword 拼接字符串 (前缀, 后缀="默认后缀") do
+function 拼接字符串 (前缀, 后缀="默认后缀") do
     # 直接使用关键字参数
     [打印],内容: "拼接前缀: ${前缀} 和后缀: ${后缀}"
 
@@ -186,7 +186,7 @@ end
 @author: Felix
 @date: 2024-06-11
 
-@keyword 拼接字符串 (前缀, 后缀="我是默认值哦") do
+function 拼接字符串 (前缀, 后缀="我是默认值哦") do
     # 直接使用关键字参数
     [打印],内容:'拼接前缀: ${前缀} 和后缀: ${后缀}'
 
@@ -198,7 +198,7 @@ end
     return ${结果变量}
 end
 
-@keyword 计算长度 (文本) do
+function 计算长度 (文本) do
     # 在实际场景中，可能会使用更复杂的逻辑
     [打印],内容:'计算文本: ${文本} 的长度'
     长度 = 10  # 为简化示例，这里使用固定值
@@ -277,7 +277,7 @@ end
 [断言],条件:'${拼接结果} == "你好, 世界"',消息:'字符串拼接不匹配'
 [断言],条件:'${文本长度} == 10',消息:'长度不匹配'
 
-@teardown do
+teardown do
     [打印],内容:'自定义关键字测试完成'
 end
 ```
@@ -429,7 +429,7 @@ def call_microservice(**kwargs):
 │   └── api_tests/     # DSL测试文件目录
 │       ├── login.dsl
 │       └── users.dsl
-├── vars/              # 变量文件
+├── config/              # 变量文件
 │   ├── dev.yaml       # 开发环境配置
 │   └── prod.yaml      # 生产环境配置
 └── pytest.ini         # pytest配置
@@ -505,6 +505,8 @@ pytest-dsl-server --api-key your_secret_key
 
 ### 远程关键字语法
 
+#### 方式一：DSL中导入（适合临时使用）
+
 ```python
 # 导入远程关键字服务器
 @remote: "http://keyword-server:8270/" as machineone
@@ -515,6 +517,34 @@ machineone|[打印],内容: "这是通过远程服务器执行的关键字"
 结果 = machineone|[拼接字符串],前缀: "Hello, ",后缀: "Remote World!"
 ```
 
+#### 方式二：YAML配置自动加载（推荐用于全局配置）
+
+在`config/vars.yaml`或其他YAML配置文件中添加：
+
+```yaml
+# 远程服务器配置
+remote_servers:
+  main_server:
+    url: "http://localhost:8270/"
+    alias: "main"
+    api_key: "your_api_key_here"  # 可选
+    sync_config:                  # 可选
+      sync_global_vars: true
+      sync_yaml_vars: true
+
+  backup_server:
+    url: "http://backup-host:8270/"
+    alias: "backup"
+```
+
+然后在DSL中直接使用：
+
+```python
+# 无需@remote导入，直接使用YAML中配置的服务器
+main|[打印],内容: "使用主服务器"
+backup|[打印],内容: "使用备用服务器"
+```
+
 ### 远程关键字测试示例
 
 ```python
@@ -529,13 +559,104 @@ machineone|[打印],内容: "这是通过远程服务器执行的关键字"
 
 # 基本打印测试
 machineone|[打印],内容: "这是通过远程服务器执行的关键字"
+```
+
+## 无缝变量传递功能
+
+pytest-dsl提供了革命性的无缝变量传递功能，客户端的变量会自动传递到服务端，服务端使用时完全透明，无需任何前缀或特殊语法。
+
+### 功能特性
+
+- **🔄 无缝传递**：客户端变量自动传递到远程服务器，服务端使用时无需前缀
+- **🛡️ 智能过滤**：自动过滤敏感信息（password、secret、key等）
+- **⚡ 零配置**：无需复杂的同步设置，开箱即用
+- **🎯 优先级保持**：保持变量访问优先级（本地 > 同步）
+- **🔒 完全隔离**：不同服务器的变量完全隔离，互不影响
+
+### 基本使用
+
+**客户端配置 (vars.yaml)**：
+```yaml
+# 全局变量
+g_base_url: "https://api.example.com"
+
+# HTTP客户端配置
+http_clients:
+  default:
+    base_url: "${g_base_url}"
+    timeout: 30
+
+# 测试数据
+test_data:
+  username: "testuser"
+  email: "test@example.com"
+
+# 敏感信息（会被自动过滤）
+password: "secret123"
+api_key: "sk-1234567890"
+```
+
+**DSL测试脚本**：
+```python
+# 导入远程关键字服务器（连接时自动传递变量）
+@remote: "http://localhost:8270/" as remote_server
+
+# 远程关键字直接使用客户端变量，无需前缀！
+remote_server|[HTTP请求], 客户端: "default", 配置: '''
+request:
+  method: GET
+  url: ${g_base_url}/api/data
+  headers:
+    X-User: ${test_data.username}
+    X-Email: ${test_data.email}
+'''
+
+# 全局变量也可以直接使用
+remote_server|[打印], 内容: "API地址: ${g_base_url}"
+```
+
+### 配置选项
+
+可以通过sync_config参数控制传递行为：
+
+```python
+# 自定义传递配置
+sync_config = {
+    'sync_global_vars': True,   # 是否传递全局变量
+    'sync_yaml_vars': True,     # 是否传递YAML配置变量
+}
+
+# 使用自定义配置连接
+client = RemoteKeywordClient(sync_config=sync_config)
+```
+
+### 应用场景
+
+1. **🌐 跨环境测试**：客户端配置自动传递到不同环境的远程服务器
+2. **🔧 配置统一管理**：HTTP客户端、数据库连接等配置在客户端统一管理
+3. **🏢 企业级部署**：测试配置集中管理，远程执行节点自动获取
+4. **🔒 安全隔离**：敏感信息自动过滤，确保安全性
+5. **⚡ 性能优化**：计算密集型任务在远程高性能服务器执行，配置无缝传递
 
 # 随机数生成测试
 随机数 = [生成随机数],最小值: 1,最大值: 100
 machineone|[打印],内容: "远程生成的随机数: ${随机数}"
 ```
 
-> **注意**：当前远程关键字模式在HTTP请求关键字上支持的不是太好，后续会优化关键字实现，提升远程关键字的功能和稳定性。
+### 远程关键字功能特性
+
+远程关键字功能已经完全支持所有内置关键字，包括：
+
+- ✅ **HTTP请求关键字**：完整支持变量捕获、会话管理和响应保存
+- ✅ **断言关键字**：支持各种断言操作
+- ✅ **全局变量管理**：远程和本地环境独立的全局变量空间
+- ✅ **JSON操作**：JSON提取和断言功能
+- ✅ **工具关键字**：随机数生成、字符串操作等
+- ✅ **时间关键字**：时间获取和格式化
+
+详细的使用指南和开发文档请参考：
+- 📖 [远程关键字使用指南](./docs/remote-keywords-usage.md)
+- 🛠️ [远程关键字开发指南](./docs/remote-keywords-development.md)
 
 ### 远程关键字服务安全性
 
@@ -576,12 +697,20 @@ machineone|[打印],内容: "远程生成的随机数: ${随机数}"
 
 ## 进阶文档
 
+### 核心功能文档
 - [完整DSL语法指南](./docs/自动化关键字DSL语法设计.md)
 - [创建自定义关键字](./pytest_dsl/docs/custom_keywords.md)
 - [HTTP测试关键字](./docs/api.md)
 - [断言关键字详解](./docs/assertion_keywords.md)
 - [HTTP断言重试机制](./docs/http_assertion_retry.md)
-- [远程关键字语法示例](./docs/remote_syntax_example.md)
+
+### 远程关键字文档
+- 📖 [远程关键字使用指南](./docs/remote-keywords-usage.md) - 如何使用远程关键字功能
+- 🛠️ [远程关键字开发指南](./docs/remote-keywords-development.md) - 如何开发支持远程模式的关键字
+- 🔧 [远程服务器Hook机制指南](./docs/remote-hooks-guide.md) - 如何使用hook机制扩展远程服务器功能和实现自定义授权
+- ⚙️ [YAML远程服务器配置指南](./docs/yaml_remote_servers.md) - 如何通过YAML配置自动加载远程服务器
+- 🔄 [YAML变量无缝传递功能](./docs/yaml_vars_seamless_sync.md) - 如何实现客户端YAML变量的无缝传递
+- [远程关键字语法示例](./docs/remote_syntax_example.md) - 基础语法示例
 
 ## 贡献与支持
 

{pytest_dsl-0.5.0 → pytest_dsl-0.6.0}/README.md

@@ -29,7 +29,7 @@ for i in range(1, 3) do
     [打印],内容: "循环次数: ${i}"
 end
 
-@teardown do
+teardown do
     [打印],内容: "测试完成!"
 end
 ```
@@ -116,7 +116,7 @@ pytest-dsl允许在DSL文件中直接定义自定义关键字，类似于编程
 @name: "自定义关键字示例"
 
 # 定义一个简单的关键字（函数）
-@keyword 拼接字符串 (前缀, 后缀="默认后缀") do
+function 拼接字符串 (前缀, 后缀="默认后缀") do
     # 直接使用关键字参数
     [打印],内容: "拼接前缀: ${前缀} 和后缀: ${后缀}"
 
@@ -155,7 +155,7 @@ end
 @author: Felix
 @date: 2024-06-11
 
-@keyword 拼接字符串 (前缀, 后缀="我是默认值哦") do
+function 拼接字符串 (前缀, 后缀="我是默认值哦") do
     # 直接使用关键字参数
     [打印],内容:'拼接前缀: ${前缀} 和后缀: ${后缀}'
 
@@ -167,7 +167,7 @@ end
     return ${结果变量}
 end
 
-@keyword 计算长度 (文本) do
+function 计算长度 (文本) do
     # 在实际场景中，可能会使用更复杂的逻辑
     [打印],内容:'计算文本: ${文本} 的长度'
     长度 = 10  # 为简化示例，这里使用固定值
@@ -246,7 +246,7 @@ end
 [断言],条件:'${拼接结果} == "你好, 世界"',消息:'字符串拼接不匹配'
 [断言],条件:'${文本长度} == 10',消息:'长度不匹配'
 
-@teardown do
+teardown do
     [打印],内容:'自定义关键字测试完成'
 end
 ```
@@ -398,7 +398,7 @@ def call_microservice(**kwargs):
 │   └── api_tests/     # DSL测试文件目录
 │       ├── login.dsl
 │       └── users.dsl
-├── vars/              # 变量文件
+├── config/              # 变量文件
 │   ├── dev.yaml       # 开发环境配置
 │   └── prod.yaml      # 生产环境配置
 └── pytest.ini         # pytest配置
@@ -474,6 +474,8 @@ pytest-dsl-server --api-key your_secret_key
 
 ### 远程关键字语法
 
+#### 方式一：DSL中导入（适合临时使用）
+
 ```python
 # 导入远程关键字服务器
 @remote: "http://keyword-server:8270/" as machineone
@@ -484,6 +486,34 @@ machineone|[打印],内容: "这是通过远程服务器执行的关键字"
 结果 = machineone|[拼接字符串],前缀: "Hello, ",后缀: "Remote World!"
 ```
 
+#### 方式二：YAML配置自动加载（推荐用于全局配置）
+
+在`config/vars.yaml`或其他YAML配置文件中添加：
+
+```yaml
+# 远程服务器配置
+remote_servers:
+  main_server:
+    url: "http://localhost:8270/"
+    alias: "main"
+    api_key: "your_api_key_here"  # 可选
+    sync_config:                  # 可选
+      sync_global_vars: true
+      sync_yaml_vars: true
+
+  backup_server:
+    url: "http://backup-host:8270/"
+    alias: "backup"
+```
+
+然后在DSL中直接使用：
+
+```python
+# 无需@remote导入，直接使用YAML中配置的服务器
+main|[打印],内容: "使用主服务器"
+backup|[打印],内容: "使用备用服务器"
+```
+
 ### 远程关键字测试示例
 
 ```python
@@ -498,13 +528,104 @@ machineone|[打印],内容: "这是通过远程服务器执行的关键字"
 
 # 基本打印测试
 machineone|[打印],内容: "这是通过远程服务器执行的关键字"
+```
+
+## 无缝变量传递功能
+
+pytest-dsl提供了革命性的无缝变量传递功能，客户端的变量会自动传递到服务端，服务端使用时完全透明，无需任何前缀或特殊语法。
+
+### 功能特性
+
+- **🔄 无缝传递**：客户端变量自动传递到远程服务器，服务端使用时无需前缀
+- **🛡️ 智能过滤**：自动过滤敏感信息（password、secret、key等）
+- **⚡ 零配置**：无需复杂的同步设置，开箱即用
+- **🎯 优先级保持**：保持变量访问优先级（本地 > 同步）
+- **🔒 完全隔离**：不同服务器的变量完全隔离，互不影响
+
+### 基本使用
+
+**客户端配置 (vars.yaml)**：
+```yaml
+# 全局变量
+g_base_url: "https://api.example.com"
+
+# HTTP客户端配置
+http_clients:
+  default:
+    base_url: "${g_base_url}"
+    timeout: 30
+
+# 测试数据
+test_data:
+  username: "testuser"
+  email: "test@example.com"
+
+# 敏感信息（会被自动过滤）
+password: "secret123"
+api_key: "sk-1234567890"
+```
+
+**DSL测试脚本**：
+```python
+# 导入远程关键字服务器（连接时自动传递变量）
+@remote: "http://localhost:8270/" as remote_server
+
+# 远程关键字直接使用客户端变量，无需前缀！
+remote_server|[HTTP请求], 客户端: "default", 配置: '''
+request:
+  method: GET
+  url: ${g_base_url}/api/data
+  headers:
+    X-User: ${test_data.username}
+    X-Email: ${test_data.email}
+'''
+
+# 全局变量也可以直接使用
+remote_server|[打印], 内容: "API地址: ${g_base_url}"
+```
+
+### 配置选项
+
+可以通过sync_config参数控制传递行为：
+
+```python
+# 自定义传递配置
+sync_config = {
+    'sync_global_vars': True,   # 是否传递全局变量
+    'sync_yaml_vars': True,     # 是否传递YAML配置变量
+}
+
+# 使用自定义配置连接
+client = RemoteKeywordClient(sync_config=sync_config)
+```
+
+### 应用场景
+
+1. **🌐 跨环境测试**：客户端配置自动传递到不同环境的远程服务器
+2. **🔧 配置统一管理**：HTTP客户端、数据库连接等配置在客户端统一管理
+3. **🏢 企业级部署**：测试配置集中管理，远程执行节点自动获取
+4. **🔒 安全隔离**：敏感信息自动过滤，确保安全性
+5. **⚡ 性能优化**：计算密集型任务在远程高性能服务器执行，配置无缝传递
 
 # 随机数生成测试
 随机数 = [生成随机数],最小值: 1,最大值: 100
 machineone|[打印],内容: "远程生成的随机数: ${随机数}"
 ```
 
-> **注意**：当前远程关键字模式在HTTP请求关键字上支持的不是太好，后续会优化关键字实现，提升远程关键字的功能和稳定性。
+### 远程关键字功能特性
+
+远程关键字功能已经完全支持所有内置关键字，包括：
+
+- ✅ **HTTP请求关键字**：完整支持变量捕获、会话管理和响应保存
+- ✅ **断言关键字**：支持各种断言操作
+- ✅ **全局变量管理**：远程和本地环境独立的全局变量空间
+- ✅ **JSON操作**：JSON提取和断言功能
+- ✅ **工具关键字**：随机数生成、字符串操作等
+- ✅ **时间关键字**：时间获取和格式化
+
+详细的使用指南和开发文档请参考：
+- 📖 [远程关键字使用指南](./docs/remote-keywords-usage.md)
+- 🛠️ [远程关键字开发指南](./docs/remote-keywords-development.md)
 
 ### 远程关键字服务安全性
 
@@ -545,12 +666,20 @@ machineone|[打印],内容: "远程生成的随机数: ${随机数}"
 
 ## 进阶文档
 
+### 核心功能文档
 - [完整DSL语法指南](./docs/自动化关键字DSL语法设计.md)
 - [创建自定义关键字](./pytest_dsl/docs/custom_keywords.md)
 - [HTTP测试关键字](./docs/api.md)
 - [断言关键字详解](./docs/assertion_keywords.md)
 - [HTTP断言重试机制](./docs/http_assertion_retry.md)
-- [远程关键字语法示例](./docs/remote_syntax_example.md)
+
+### 远程关键字文档
+- 📖 [远程关键字使用指南](./docs/remote-keywords-usage.md) - 如何使用远程关键字功能
+- 🛠️ [远程关键字开发指南](./docs/remote-keywords-development.md) - 如何开发支持远程模式的关键字
+- 🔧 [远程服务器Hook机制指南](./docs/remote-hooks-guide.md) - 如何使用hook机制扩展远程服务器功能和实现自定义授权
+- ⚙️ [YAML远程服务器配置指南](./docs/yaml_remote_servers.md) - 如何通过YAML配置自动加载远程服务器
+- 🔄 [YAML变量无缝传递功能](./docs/yaml_vars_seamless_sync.md) - 如何实现客户端YAML变量的无缝传递
+- [远程关键字语法示例](./docs/remote_syntax_example.md) - 基础语法示例
 
 ## 贡献与支持
 

{pytest_dsl-0.5.0 → pytest_dsl-0.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pytest-dsl"
-version = "0.5.0"
+version = "0.6.0"
 description = "A DSL testing framework based on pytest"
 readme = "README.md"
 requires-python = ">=3.9"

{pytest_dsl-0.5.0 → pytest_dsl-0.6.0}/pytest_dsl/cli.py

@@ -13,8 +13,9 @@ from pathlib import Path
 from pytest_dsl.core.lexer import get_lexer
 from pytest_dsl.core.parser import get_parser
 from pytest_dsl.core.dsl_executor import DSLExecutor
-from pytest_dsl.core.yaml_vars import yaml_vars
+from pytest_dsl.core.yaml_loader import load_yaml_variables_from_args
 from pytest_dsl.core.auto_directory import SETUP_FILE_NAME, TEARDOWN_FILE_NAME, execute_hook_file
+from pytest_dsl.core.plugin_discovery import load_all_plugins
 
 
 def read_file(filename):
@@ -27,35 +28,26 @@ def parse_args():
     """解析命令行参数"""
     parser = argparse.ArgumentParser(description='执行DSL测试文件')
     parser.add_argument('path', help='要执行的DSL文件路径或包含DSL文件的目录')
-    parser.add_argument('--yaml-vars', action='append', default=[], 
+    parser.add_argument('--yaml-vars', action='append', default=[],
                        help='YAML变量文件路径，可以指定多个文件 (例如: --yaml-vars vars1.yaml --yaml-vars vars2.yaml)')
     parser.add_argument('--yaml-vars-dir', default=None,
                        help='YAML变量文件目录路径，将加载该目录下所有.yaml文件')
-    
+
     return parser.parse_args()
 
 
 def load_yaml_variables(args):
     """从命令行参数加载YAML变量"""
-    # 加载单个YAML文件
-    if args.yaml_vars:
-        yaml_vars.load_yaml_files(args.yaml_vars)
-        print(f"已加载YAML变量文件: {', '.join(args.yaml_vars)}")
-    
-    # 加载目录中的YAML文件
-    if args.yaml_vars_dir:
-        yaml_vars_dir = args.yaml_vars_dir
-        try:
-            yaml_vars.load_from_directory(yaml_vars_dir)
-            print(f"已加载YAML变量目录: {yaml_vars_dir}")
-            loaded_files = yaml_vars.get_loaded_files()
-            if loaded_files:
-                dir_files = [f for f in loaded_files if Path(f).parent == Path(yaml_vars_dir)]
-                if dir_files:
-                    print(f"目录中加载的文件: {', '.join(dir_files)}")
-        except NotADirectoryError:
-            print(f"YAML变量目录不存在: {yaml_vars_dir}")
-            sys.exit(1)
+    # 使用统一的加载函数，包含远程服务器自动连接功能
+    try:
+        load_yaml_variables_from_args(
+            yaml_files=args.yaml_vars,
+            yaml_vars_dir=args.yaml_vars_dir,
+            project_root=os.getcwd()  # CLI模式下使用当前工作目录作为项目根目录
+        )
+    except Exception as e:
+        print(f"加载YAML变量失败: {str(e)}")
+        sys.exit(1)
 
 
 def execute_dsl_file(file_path, lexer, parser, executor):
@@ -85,14 +77,17 @@ def main():
     """命令行入口点"""
     args = parse_args()
     path = args.path
-    
-    # 加载YAML变量
+
+    # 加载内置关键字插件
+    load_all_plugins()
+
+    # 加载YAML变量（包括远程服务器自动连接）
     load_yaml_variables(args)
-    
+
     lexer = get_lexer()
     parser = get_parser()
     executor = DSLExecutor()
-    
+
     # 检查路径是文件还是目录
     if os.path.isfile(path):
         # 执行单个文件
@@ -102,32 +97,32 @@ def main():
     elif os.path.isdir(path):
         # 执行目录中的所有DSL文件
         print(f"执行目录: {path}")
-        
+
         # 先执行目录的setup文件（如果存在）
         setup_file = os.path.join(path, SETUP_FILE_NAME)
         if os.path.exists(setup_file):
             execute_hook_file(Path(setup_file), True, path)
-        
+
         # 查找并执行所有DSL文件
         dsl_files = find_dsl_files(path)
         if not dsl_files:
             print(f"目录中没有找到DSL文件: {path}")
             sys.exit(1)
-            
+
         print(f"找到 {len(dsl_files)} 个DSL文件")
-        
+
         # 执行所有DSL文件
         failures = 0
         for file_path in dsl_files:
             success = execute_dsl_file(file_path, lexer, parser, executor)
             if not success:
                 failures += 1
-        
+
         # 最后执行目录的teardown文件（如果存在）
         teardown_file = os.path.join(path, TEARDOWN_FILE_NAME)
         if os.path.exists(teardown_file):
             execute_hook_file(Path(teardown_file), False, path)
-        
+
         # 如果有失败的测试，返回非零退出码
         if failures > 0:
             print(f"总计 {failures}/{len(dsl_files)} 个测试失败")
@@ -140,4 +135,4 @@ def main():
 
 
 if __name__ == '__main__':
-    main() 
+    main()