pytest-dsl 0.14.0__tar.gz → 0.15.1__tar.gz

{pytest_dsl-0.14.0/pytest_dsl.egg-info → pytest_dsl-0.15.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-dsl
-Version: 0.14.0
+Version: 0.15.1
 Summary: A DSL testing framework based on pytest
 Author: Chen Shuanglin
 License: MIT

{pytest_dsl-0.14.0 → pytest_dsl-0.15.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pytest-dsl"
-version = "0.14.0"
+version = "0.15.1"
 description = "A DSL testing framework based on pytest"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -49,6 +49,6 @@ pytest-dsl-list = "pytest_dsl.cli:main_list_keywords"
 "Bug Tracker" = "https://github.com/felix-1991/pytest-dsl/issues"
 
 
-# [[tool.uv.index]]
-# name = "tuna"
-# url = "https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple"
+[[tool.uv.index]]
+name = "tuna"
+url = "https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple"

pytest_dsl-0.15.1/pytest_dsl/__init__.py

@@ -0,0 +1,209 @@
+"""
+pytest-dsl - 基于pytest的DSL测试框架
+
+使用自定义的领域特定语言(DSL)来编写测试用例，使测试更加直观、易读和易维护。
+
+主要功能：
+- DSL语法解析和执行
+- 关键字管理和注册
+- Hook机制支持插件扩展
+- DSL格式校验
+- 远程关键字支持
+- 自定义关键字支持
+"""
+
+__version__ = "0.1.0"
+
+# 核心执行器
+from pytest_dsl.core.dsl_executor import DSLExecutor
+
+# 关键字管理器
+from pytest_dsl.core.keyword_manager import keyword_manager, KeywordManager
+
+# Hook系统
+from pytest_dsl.core.hookspecs import hookimpl, hookspec, DSLHookSpecs
+from pytest_dsl.core.hook_manager import hook_manager, DSLHookManager
+
+# DSL格式校验
+from pytest_dsl.core.validator import (
+    DSLValidator,
+    DSLValidationError,
+    validate_dsl,
+    check_dsl_syntax
+)
+
+# 自动装饰器
+from pytest_dsl.core.auto_decorator import auto_dsl
+
+# 核心工具类
+from pytest_dsl.core.parser import Node, get_parser
+from pytest_dsl.core.lexer import get_lexer
+from pytest_dsl.core.context import TestContext
+from pytest_dsl.core.global_context import global_context
+
+# 变量工具
+from pytest_dsl.core.variable_utils import VariableReplacer
+
+# 自定义关键字管理器
+from pytest_dsl.core.custom_keyword_manager import custom_keyword_manager
+
+# 关键字加载器
+from pytest_dsl.core.keyword_loader import (
+    keyword_loader, KeywordLoader,
+    load_all_keywords, categorize_keyword, get_keyword_source_info,
+    group_keywords_by_source, scan_project_custom_keywords
+)
+
+# 关键字工具
+from pytest_dsl.core.keyword_utils import (
+    KeywordInfo, KeywordListOptions, KeywordFormatter, KeywordLister,
+    keyword_lister, list_keywords, get_keyword_info, search_keywords,
+    generate_html_report
+)
+
+# 便捷导入的别名
+Executor = DSLExecutor
+Validator = DSLValidator
+HookManager = DSLHookManager
+KeywordLoader = KeywordLoader
+
+# 导出所有公共接口
+__all__ = [
+    # 版本信息
+    '__version__',
+
+    # 核心执行器
+    'DSLExecutor', 'Executor',
+
+    # 关键字管理
+    'keyword_manager', 'KeywordManager',
+    'custom_keyword_manager',
+
+    # 关键字加载器
+    'keyword_loader', 'KeywordLoader',
+    'load_all_keywords', 'categorize_keyword', 'get_keyword_source_info',
+    'group_keywords_by_source', 'scan_project_custom_keywords',
+
+    # 关键字工具
+    'KeywordInfo', 'KeywordListOptions', 'KeywordFormatter', 'KeywordLister',
+    'keyword_lister', 'list_keywords', 'get_keyword_info', 'search_keywords',
+    'generate_html_report',
+
+    # Hook系统
+    'hookimpl', 'hookspec', 'DSLHookSpecs',
+    'hook_manager', 'DSLHookManager', 'HookManager',
+
+    # DSL校验
+    'DSLValidator', 'Validator',
+    'DSLValidationError',
+    'validate_dsl',
+    'check_dsl_syntax',
+
+    # 自动装饰器
+    'auto_dsl',
+
+    # 核心组件
+    'Node', 'get_parser', 'get_lexer',
+    'TestContext', 'global_context',
+    'VariableReplacer',
+]
+
+# 快捷函数
+
+
+def create_executor(enable_hooks: bool = True) -> DSLExecutor:
+    """创建DSL执行器实例
+
+    Args:
+        enable_hooks: 是否启用hook机制
+
+    Returns:
+        DSL执行器实例
+    """
+    return DSLExecutor(enable_hooks=enable_hooks)
+
+
+def parse_dsl(content: str) -> Node:
+    """解析DSL内容为AST
+
+    Args:
+        content: DSL内容
+
+    Returns:
+        解析后的AST根节点
+    """
+    lexer = get_lexer()
+    parser = get_parser()
+    return parser.parse(content, lexer=lexer)
+
+
+def execute_dsl(content: str, context: dict = None, enable_hooks: bool = True) -> any:
+    """执行DSL内容的便捷函数
+
+    Args:
+        content: DSL内容
+        context: 执行上下文（可选）
+        enable_hooks: 是否启用hook机制
+
+    Returns:
+        执行结果
+    """
+    executor = create_executor(enable_hooks=enable_hooks)
+    if context:
+        executor.variables.update(context)
+        for key, value in context.items():
+            executor.test_context.set(key, value)
+
+    ast = parse_dsl(content)
+    return executor.execute(ast)
+
+
+def register_keyword(name: str, parameters: list = None, source_type: str = "external",
+                     source_name: str = "user_defined"):
+    """注册关键字的装饰器
+
+    Args:
+        name: 关键字名称
+        parameters: 参数列表
+        source_type: 来源类型
+        source_name: 来源名称
+
+    Returns:
+        装饰器函数
+    """
+    if parameters is None:
+        parameters = []
+
+    return keyword_manager.register_with_source(
+        name=name,
+        parameters=parameters,
+        source_type=source_type,
+        source_name=source_name
+    )
+
+
+# 版本兼容性检查
+def check_version_compatibility():
+    """检查版本兼容性"""
+    try:
+        import sys
+        if sys.version_info < (3, 7):
+            import warnings
+            warnings.warn(
+                "pytest-dsl 需要 Python 3.7 或更高版本",
+                UserWarning,
+                stacklevel=2
+            )
+    except Exception:
+        pass
+
+
+# 初始化时进行版本检查
+check_version_compatibility()
+
+# 自动初始化hook管理器
+try:
+    hook_manager.initialize()
+except Exception as e:
+    import warnings
+    warnings.warn(f"Hook管理器初始化失败: {e}", UserWarning, stacklevel=2)

pytest_dsl-0.15.1/pytest_dsl/cli.py

@@ -0,0 +1,371 @@
+"""
+pytest-dsl命令行入口
+
+提供独立的命令行工具，用于执行DSL文件。
+"""
+
+import sys
+import argparse
+import os
+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_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.keyword_loader import load_all_keywords
+from pytest_dsl.core.keyword_utils import list_keywords as utils_list_keywords
+
+
+def read_file(filename):
+    """读取 DSL 文件内容"""
+    with open(filename, 'r', encoding='utf-8') as f:
+        return f.read()
+
+
+def parse_args():
+    """解析命令行参数"""
+    import sys
+    argv = sys.argv[1:]  # 去掉脚本名
+
+    # 检查是否使用了子命令格式
+    if argv and argv[0] in ['run', 'list-keywords']:
+        # 使用新的子命令格式
+        parser = argparse.ArgumentParser(description='执行DSL测试文件')
+        subparsers = parser.add_subparsers(dest='command', help='可用命令')
+
+        # 执行命令
+        run_parser = subparsers.add_parser('run', help='执行DSL文件')
+        run_parser.add_argument(
+            'path',
+            help='要执行的DSL文件路径或包含DSL文件的目录'
+        )
+        run_parser.add_argument(
+            '--yaml-vars', action='append', default=[],
+            help='YAML变量文件路径，可以指定多个文件 '
+                 '(例如: --yaml-vars vars1.yaml '
+                 '--yaml-vars vars2.yaml)'
+        )
+        run_parser.add_argument(
+            '--yaml-vars-dir', default=None,
+            help='YAML变量文件目录路径，'
+                 '将加载该目录下所有.yaml文件'
+        )
+
+        # 关键字列表命令
+        list_parser = subparsers.add_parser(
+            'list-keywords',
+            help='罗列所有可用关键字和参数信息'
+        )
+        list_parser.add_argument(
+            '--format', choices=['text', 'json', 'html'],
+            default='json',
+            help='输出格式：json(默认)、text 或 html'
+        )
+        list_parser.add_argument(
+            '--output', '-o', type=str, default=None,
+            help='输出文件路径（json格式默认为keywords.json，html格式默认为keywords.html）'
+        )
+        list_parser.add_argument(
+            '--filter', type=str, default=None,
+            help='过滤关键字名称（支持部分匹配）'
+        )
+        list_parser.add_argument(
+            '--category',
+            choices=[
+                'builtin', 'plugin', 'custom',
+                'project_custom', 'remote', 'all'
+            ],
+            default='all',
+            help='关键字类别：builtin(内置)、plugin(插件)、custom(自定义)、'
+                 'project_custom(项目自定义)、remote(远程)、all(全部，默认)'
+        )
+        list_parser.add_argument(
+            '--include-remote', action='store_true',
+            help='是否包含远程关键字（默认不包含）'
+        )
+
+        return parser.parse_args(argv)
+    else:
+        # 向后兼容模式
+        parser = argparse.ArgumentParser(description='执行DSL测试文件')
+
+        # 检查是否是list-keywords的旧格式
+        if '--list-keywords' in argv:
+            parser.add_argument('--list-keywords', action='store_true')
+            parser.add_argument(
+                '--format', choices=['text', 'json', 'html'], default='json'
+            )
+            parser.add_argument(
+                '--output', '-o', type=str, default=None
+            )
+            parser.add_argument('--filter', type=str, default=None)
+            parser.add_argument(
+                '--category',
+                choices=[
+                    'builtin', 'plugin', 'custom',
+                    'project_custom', 'remote', 'all'
+                ],
+                default='all'
+            )
+            parser.add_argument(
+                '--include-remote', action='store_true'
+            )
+            parser.add_argument('path', nargs='?')  # 可选的路径参数
+            parser.add_argument(
+                '--yaml-vars', action='append', default=[]
+            )
+            parser.add_argument('--yaml-vars-dir', default=None)
+
+            args = parser.parse_args(argv)
+            args.command = 'list-keywords-compat'  # 标记为兼容模式
+        else:
+            # 默认为run命令的向后兼容模式
+            parser.add_argument('path', nargs='?')
+            parser.add_argument(
+                '--yaml-vars', action='append', default=[]
+            )
+            parser.add_argument('--yaml-vars-dir', default=None)
+
+            args = parser.parse_args(argv)
+            args.command = 'run-compat'  # 标记为兼容模式
+
+        return args
+
+
+def list_keywords(output_format='json', name_filter=None,
+                  category_filter='all', output_file=None,
+                  include_remote=False):
+    """罗列所有关键字信息（简化版，调用统一的工具函数）"""
+    print("正在加载关键字...")
+
+    # 使用统一的工具函数
+    try:
+        utils_list_keywords(
+            output_format=output_format,
+            name_filter=name_filter,
+            category_filter=category_filter,
+            include_remote=include_remote,
+            output_file=output_file,
+            print_summary=True
+        )
+    except Exception as e:
+        print(f"列出关键字失败: {e}")
+        raise
+
+
+def load_yaml_variables(args):
+    """从命令行参数加载YAML变量"""
+    # 使用统一的加载函数，包含远程服务器自动连接功能和hook支持
+    try:
+        # 尝试从环境变量获取环境名称
+        environment = (os.environ.get('PYTEST_DSL_ENVIRONMENT') or
+                       os.environ.get('ENVIRONMENT'))
+
+        load_yaml_variables_from_args(
+            yaml_files=args.yaml_vars,
+            yaml_vars_dir=args.yaml_vars_dir,
+            project_root=os.getcwd(),  # CLI模式下使用当前工作目录作为项目根目录
+            environment=environment
+        )
+    except Exception as e:
+        print(f"加载YAML变量失败: {str(e)}")
+        sys.exit(1)
+
+
+def execute_dsl_file(file_path, lexer, parser, executor):
+    """执行单个DSL文件"""
+    try:
+        print(f"执行文件: {file_path}")
+        dsl_code = read_file(file_path)
+        ast = parser.parse(dsl_code, lexer=lexer)
+        executor.execute(ast)
+        return True
+    except Exception as e:
+        print(f"执行失败 {file_path}: {e}")
+        return False
+
+
+def find_dsl_files(directory):
+    """查找目录中的所有DSL文件"""
+    dsl_files = []
+    for root, _, files in os.walk(directory):
+        for file in files:
+            if (file.endswith(('.dsl', '.auto')) and
+                    file not in [SETUP_FILE_NAME, TEARDOWN_FILE_NAME]):
+                dsl_files.append(os.path.join(root, file))
+    return dsl_files
+
+
+def run_dsl_tests(args):
+    """执行DSL测试的主函数"""
+    path = args.path
+
+    if not path:
+        print("错误: 必须指定要执行的DSL文件路径或目录")
+        sys.exit(1)
+
+    # 加载内置关键字插件（运行时总是包含远程关键字）
+    load_all_keywords(include_remote=True)
+
+    # 加载YAML变量（包括远程服务器自动连接）
+    load_yaml_variables(args)
+
+    # 支持hook机制的执行
+    from pytest_dsl.core.hookable_executor import hookable_executor
+
+    # 检查是否有hook提供的用例列表
+    hook_cases = hookable_executor.list_dsl_cases()
+    if hook_cases:
+        # 如果有hook提供的用例，优先执行这些用例
+        print(f"通过Hook发现 {len(hook_cases)} 个DSL用例")
+        failures = 0
+        for case in hook_cases:
+            case_id = case.get('id') or case.get('name', 'unknown')
+            try:
+                print(f"执行用例: {case.get('name', case_id)}")
+                hookable_executor.execute_dsl(str(case_id))
+                print(f"✓ 用例 {case.get('name', case_id)} 执行成功")
+            except Exception as e:
+                print(f"✗ 用例 {case.get('name', case_id)} 执行失败: {e}")
+                failures += 1
+
+        if failures > 0:
+            print(f"总计 {failures}/{len(hook_cases)} 个测试失败")
+            sys.exit(1)
+        else:
+            print(f"所有 {len(hook_cases)} 个测试成功完成")
+        return
+
+    # 如果没有hook用例，使用传统的文件执行方式
+    lexer = get_lexer()
+    parser = get_parser()
+    executor = DSLExecutor()
+
+    # 检查路径是文件还是目录
+    if os.path.isfile(path):
+        # 执行单个文件
+        success = execute_dsl_file(path, lexer, parser, executor)
+        if not success:
+            sys.exit(1)
+    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)} 个测试失败")
+            sys.exit(1)
+        else:
+            print(f"所有 {len(dsl_files)} 个测试成功完成")
+    else:
+        print(f"路径不存在: {path}")
+        sys.exit(1)
+
+
+def main():
+    """命令行入口点"""
+    args = parse_args()
+
+    # 处理子命令
+    if args.command == 'list-keywords':
+        list_keywords(
+            output_format=args.format,
+            name_filter=args.filter,
+            category_filter=args.category,
+            output_file=args.output,
+            include_remote=args.include_remote
+        )
+    elif args.command == 'run':
+        run_dsl_tests(args)
+    elif args.command == 'list-keywords-compat':
+        # 向后兼容：旧的--list-keywords格式
+        output_file = getattr(args, 'output', None)
+        include_remote = getattr(args, 'include_remote', False)
+        list_keywords(
+            output_format=args.format,
+            name_filter=args.filter,
+            category_filter=args.category,
+            output_file=output_file,
+            include_remote=include_remote
+        )
+    elif args.command == 'run-compat':
+        # 向后兼容：默认执行DSL测试
+        run_dsl_tests(args)
+    else:
+        # 如果没有匹配的命令，显示帮助
+        print("错误: 未知命令")
+        sys.exit(1)
+
+
+def main_list_keywords():
+    """关键字列表命令的专用入口点"""
+    parser = argparse.ArgumentParser(description='查看pytest-dsl可用关键字列表')
+    parser.add_argument(
+        '--format', choices=['text', 'json', 'html'],
+        default='json',
+        help='输出格式：json(默认)、text 或 html'
+    )
+    parser.add_argument(
+        '--output', '-o', type=str, default=None,
+        help='输出文件路径（json格式默认为keywords.json，html格式默认为keywords.html）'
+    )
+    parser.add_argument(
+        '--filter', type=str, default=None,
+        help='过滤关键字名称（支持部分匹配）'
+    )
+    parser.add_argument(
+        '--category',
+        choices=[
+            'builtin', 'plugin', 'custom', 'project_custom', 'remote', 'all'
+        ],
+        default='all',
+        help='关键字类别：builtin(内置)、plugin(插件)、custom(自定义)、'
+             'project_custom(项目自定义)、remote(远程)、all(全部，默认)'
+    )
+    parser.add_argument(
+        '--include-remote', action='store_true',
+        help='是否包含远程关键字（默认不包含）'
+    )
+
+    args = parser.parse_args()
+
+    list_keywords(
+        output_format=args.format,
+        name_filter=args.filter,
+        category_filter=args.category,
+        output_file=args.output,
+        include_remote=args.include_remote
+    )
+
+
+if __name__ == '__main__':
+    main()