rodski 5.7.1__py3-none-any.whl

rodski/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lightning Strike Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rodski/README.md

@@ -0,0 +1,56 @@
+# RodSki - 自动化测试框架
+
+基于关键字驱动的现代化自动化测试框架，Python 重写版本。
+
+## 特性
+
+- 🎯 关键字驱动 - 简单易用的测试语法
+- 🔧 模型驱动 - 模型与数据分离
+- 🌐 多驱动支持 - Playwright (Web) + PyWinAuto (Desktop) + Appium (Mobile)
+- 📊 XML 用例 - 结构化测试定义
+- 🔌 RESTful API - 接口测试支持
+
+## 快速开始
+
+📖 **[5分钟快速入门指南](docs/user-guides/QUICKSTART.md)** - 新手必读！
+
+### 安装
+
+```bash
+pip install -r requirements.txt
+playwright install chromium
+```
+
+### CLI 运行
+
+```bash
+python3 cli_main.py run examples/product/DEMO/demo_site/case/demo_case.xml
+```
+
+## 项目结构
+
+```
+rodski/
+├── core/          # 核心引擎
+├── drivers/       # 驱动层
+├── api/           # API 测试
+├── config/        # 配置
+├── data/          # 测试数据
+├── examples/      # 示例用例
+└── docs/          # 文档
+```
+
+## 开发
+
+### 环境要求
+
+- Python 3.8+
+- Playwright
+
+### 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 许可证
+
+MIT License

rodski/__init__.py

@@ -0,0 +1,2 @@
+"""RodSki Test Framework"""
+__version__ = "5.7.1"

rodski/api/rest_helper.py

@@ -0,0 +1,116 @@
+"""RESTful API 测试辅助工具"""
+import json
+import logging
+from typing import Any, Dict, List, Optional
+from jsonschema import validate, ValidationError
+import requests
+from requests.adapters import HTTPAdapter
+from urllib3.util.retry import Retry
+
+logger = logging.getLogger(__name__)
+
+
+class RestHelper:
+    """REST API 测试辅助类"""
+
+    @staticmethod
+    def _get_session(max_retries: int = 3, pool_connections: int = 10, pool_maxsize: int = 10) -> requests.Session:
+        """获取配置了连接池和重试的 Session"""
+        session = requests.Session()
+        retry_strategy = Retry(
+            total=max_retries,
+            backoff_factor=0.3,
+            status_forcelist=[429, 500, 502, 503, 504],
+        )
+        adapter = HTTPAdapter(max_retries=retry_strategy, pool_connections=pool_connections, pool_maxsize=pool_maxsize)
+        session.mount("http://", adapter)
+        session.mount("https://", adapter)
+        return session
+
+    @staticmethod
+    def validate_json_schema(data: Dict, schema: Dict) -> bool:
+        """验证 JSON Schema"""
+        try:
+            validate(instance=data, schema=schema)
+            return True
+        except ValidationError:
+            return False
+
+    @staticmethod
+    def jsonpath_extract(data: Dict, path: str) -> Any:
+        """简单 JSONPath 提取（支持点号路径）"""
+        keys = path.strip('$.').split('.')
+        current = data
+        for key in keys:
+            if isinstance(current, dict):
+                current = current.get(key)
+            else:
+                return None
+        return current
+
+    @staticmethod
+    def send_request(
+        method: str,
+        url: str,
+        headers: Optional[Dict[str, str]] = None,
+        body: Any = None,
+        timeout: float = 30.0,
+        max_retries: int = 3,
+        use_session: bool = True,
+        cookies: Optional[Dict[str, str]] = None,
+    ) -> requests.Response:
+        """发送 HTTP 请求"""
+        method = method.upper()
+        kwargs: Dict[str, Any] = {"headers": headers, "timeout": timeout}
+        if body is not None:
+            kwargs["json"] = body
+        if cookies:
+            kwargs["cookies"] = cookies
+
+        try:
+            logger.debug(f"Sending {method} request to {url}")
+            if use_session:
+                session = RestHelper._get_session(max_retries=max_retries)
+                response = session.request(method, url, **kwargs)
+            else:
+                response = requests.request(method, url, **kwargs)
+            logger.debug(f"Response: {response.status_code} in {response.elapsed.total_seconds():.3f}s")
+            return response
+        except requests.exceptions.Timeout as e:
+            logger.error(f"Request timeout: {url}")
+            raise
+        except requests.exceptions.ConnectionError as e:
+            logger.error(f"Connection error: {url}")
+            raise
+        except requests.exceptions.RequestException as e:
+            logger.error(f"Request failed: {url} - {str(e)}")
+            raise
+
+    @staticmethod
+    def assert_response_time(response: requests.Response, max_ms: float) -> bool:
+        """断言响应时间（毫秒）"""
+        elapsed_ms = response.elapsed.total_seconds() * 1000
+        return elapsed_ms <= max_ms
+
+    @staticmethod
+    def extract_headers(response: requests.Response, header_name: str) -> Optional[str]:
+        """提取响应头"""
+        return response.headers.get(header_name)
+
+    @staticmethod
+    def compare_responses(
+        resp1: Dict,
+        resp2: Dict,
+        ignore_fields: Optional[List[str]] = None,
+    ) -> bool:
+        """比较两个响应（忽略指定字段）"""
+        ignore_fields = ignore_fields or []
+
+        def _strip(d: Any) -> Any:
+            if isinstance(d, dict):
+                return {k: _strip(v) for k, v in d.items() if k not in ignore_fields}
+            if isinstance(d, list):
+                return [_strip(i) for i in d]
+            return d
+
+        return _strip(resp1) == _strip(resp2)

rodski/cli_main.py

@@ -0,0 +1,106 @@
+#!/usr/bin/env python3
+"""RodSki CLI 入口"""
+import sys
+import argparse
+import traceback
+from .rodski_cli import run, model, config, log, report, profile, docs
+
+from rodski import __version__ as VERSION
+
+
+def format_error(e, verbose=False):
+    """格式化错误信息，提高可读性"""
+    error_type = type(e).__name__
+    error_msg = str(e)
+
+    # 常见错误的友好提示
+    hints = {
+        FileNotFoundError: "请检查文件路径是否正确",
+        PermissionError: "请检查文件权限或以管理员身份运行",
+        ConnectionError: "请检查网络连接或目标服务是否可用",
+        TimeoutError: "操作超时，请检查网络或增加超时时间",
+        KeyboardInterrupt: "用户中断执行",
+        ImportError: "缺少依赖包，请运行: pip install -r requirements.txt",
+    }
+
+    hint = hints.get(type(e), "")
+    lines = [f"错误 [{error_type}]: {error_msg}"]
+    if hint:
+        lines.append(f"提示: {hint}")
+    if verbose:
+        lines.append("")
+        lines.append("详细堆栈信息:")
+        lines.append(traceback.format_exc())
+    return "\n".join(lines)
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog="rodski",
+        description="RodSki - 关键字驱动测试框架",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="示例:\n"
+               "  ski run case/                        执行测试用例\n"
+               "  ski run case/ --dry-run               验证用例但不执行\n"
+               "  ski run case/ --verbose               详细输出模式\n"
+               "  ski run case/ --step-by-step          单步执行模式\n"
+               "  ski run case/ --pause-on-error        错误时暂停\n"
+               "  ski run case/ --interactive           交互模式\n"
+               "  ski config list                           查看配置\n"
+    )
+    parser.add_argument("--version", action="version", version=f"RodSki {VERSION}")
+    parser.add_argument("--verbose", action="store_true", help="详细输出模式")
+
+    subparsers = parser.add_subparsers(dest="command", help="子命令")
+
+    # run 子命令
+    run.setup_parser(subparsers)
+
+    # model 子命令
+    model.setup_parser(subparsers)
+
+    # config 子命令
+    config.setup_parser(subparsers)
+
+    # log 子命令
+    log.setup_parser(subparsers)
+
+    # report 子命令
+    report.setup_parser(subparsers)
+
+    # profile 子命令
+    profile.setup_parser(subparsers)
+
+    # docs 子命令
+    docs.setup_parser(subparsers)
+
+    args = parser.parse_args()
+
+    if not args.command:
+        parser.print_help()
+        return 0
+
+    # 执行对应子命令
+    handlers = {
+        "run": run.handle,
+        "model": model.handle,
+        "config": config.handle,
+        "log": log.handle,
+        "report": report.handle,
+        "profile": profile.handle,
+        "docs": docs.handle
+    }
+
+    verbose = getattr(args, "verbose", False)
+
+    try:
+        return handlers[args.command](args)
+    except KeyboardInterrupt:
+        print("\n操作已被用户中断", file=sys.stderr)
+        return 130
+    except Exception as e:
+        print(format_error(e, verbose=verbose), file=sys.stderr)
+        return 1
+
+if __name__ == "__main__":
+    sys.exit(main())

rodski/config/android_config.json

@@ -0,0 +1,8 @@
+{
+  "platformName": "Android",
+  "deviceName": "Android Emulator",
+  "automationName": "UiAutomator2",
+  "appPackage": "com.example.app",
+  "appActivity": ".MainActivity",
+  "serverUrl": "http://localhost:4723"
+}

rodski/config/config.json

@@ -0,0 +1,25 @@
+{
+  "driver": "web",
+  "browser": "chromium",
+  "headless": false,
+  "timeout": 60,
+  "retry": 0,
+  "retry_delay": 1.0,
+  "retry_on_errors": [
+    "ElementNotFound",
+    "Timeout",
+    "StaleElement"
+  ],
+  "log_level": "INFO",
+  "log_dir": "logs",
+  "report_format": "html",
+  "auto_screenshot_on_failure": true,
+  "auto_screenshot_on_step": true,
+  "screenshot_dir": "screenshots",
+  "smart_wait_enabled": true,
+  "smart_wait_max_retries": 30,
+  "smart_wait_retry_interval": 0.3,
+  "smart_wait_log_retry": true,
+  "element_wait_timeout": 0.5,
+  "element_retry_interval": 0.1
+}

rodski/config/default_config.yaml

@@ -0,0 +1,96 @@
+# RodSki 默认配置 - Iteration-04 异常处理与智能恢复
+
+execution:
+  # 最大重试次数（全局）
+  max_retries: 3
+  # 是否启用智能恢复
+  recovery_enabled: true
+  # 单次恢复最大尝试次数
+  recovery_max_attempts: 2
+  # 失败时自动截图
+  screenshot_on_failure: true
+  # 浏览器实例最大步数（超过后自动回收）
+  browser_restart_interval: 50
+  # 恢复动作之间等待秒数
+  recovery_wait_seconds: 1
+
+verification:
+  # AI 视觉验证模型
+  model: claude
+  # AI 请求超时（秒）
+  timeout: 30
+  # 模型名称（空表示提供者默认值）
+  model_name: ""
+  # API 密钥环境变量名
+  api_key_env: ANTHROPIC_API_KEY
+  # 代理地址（空表示官方地址）
+  base_url: ""
+
+diagnosis:
+  # 是否启用 AI 辅助诊断
+  ai_enabled: true
+  # 诊断超时（秒）
+  timeout: 30
+  # AI 视觉分析失败时是否回退到规则诊断
+  fallback_to_rules: true
+
+recovery:
+  # 恢复动作注册表（可扩展自定义动作）
+  actions: {}
+    # custom_action: "my_module.custom_handler"
+
+snapshot:
+  # 是否启用执行快照（断点续跑）
+  enabled: false
+  # 快照存放目录
+  snapshot_dir: "snapshots"
+  # 每次步骤执行后保存快照（可能导致性能下降）
+  save_on_every_step: false
+
+result:
+  # 记录步骤执行时间
+  record_step_timing: true
+  # 捕获失败上下文（页面源码、控制台日志等）
+  capture_failure_context: true
+  # 在结果中嵌入诊断信息
+  embed_diagnosis: true
+
+metadata:
+  # 从用例中提取元数据
+  extract_from_case: true
+  # 在 CLI 中显示元数据
+  show_in_cli: true
+
+statistics:
+  # 结果目录
+  result_dir: "result"
+  # 不稳定用例阈值（失败率）
+  flaky_threshold: 0.3
+  # 显示最慢用例数量
+  top_slow_count: 10
+
+execution:
+  # 最大重试次数（全局）
+  max_retries: 3
+  # 是否启用智能恢复
+  recovery_enabled: true
+  # 单次恢复最大尝试次数
+  recovery_max_attempts: 2
+  # 失败时自动截图
+  screenshot_on_failure: true
+  # 浏览器实例最大步数（超过后自动回收）
+  browser_restart_interval: 50
+  # 恢复动作之间等待秒数
+  recovery_wait_seconds: 1
+  # 允许条件执行
+  allow_conditions: true
+  # 允许循环执行
+  allow_loops: true
+  # 允许动态步骤注入
+  allow_dynamic_steps: true
+  # 循环最大迭代次数
+  loop_max_iterations: 1000
+  # 动态步骤配置
+  dynamic_step:
+    # 每个触发点最大动态步骤数
+    max_per_trigger: 10

rodski/config/ios_config.json

@@ -0,0 +1,7 @@
+{
+  "platformName": "iOS",
+  "deviceName": "iPhone 14",
+  "automationName": "XCUITest",
+  "bundleId": "com.example.app",
+  "serverUrl": "http://localhost:4723"
+}

rodski/config/llm_config.yaml

@@ -0,0 +1,58 @@
+# RodSki LLM 统一配置
+# 所有 LLM 相关配置集中在此文件
+
+# 默认 provider
+provider: claude
+
+# Provider 配置
+providers:
+  claude:
+    model: claude-opus-4-6
+    base_url: "http://code.casstime.ai"  # 可选代理地址
+    api_key_env: ANTHROPIC_API_KEY
+    timeout: 10
+    max_tokens: 1024
+
+  openai:
+    model: gpt-5.4
+    base_url: "http://code.casstime.ai"
+    api_key_env: OPENAI_API_KEY
+    timeout: 10
+    max_tokens: 2000
+
+# 能力配置
+capabilities:
+  vision_locator:
+    provider: claude  # 可覆盖默认 provider
+  screenshot_verifier:
+    provider: claude
+  test_reviewer:
+    provider: openai
+    temperature: 0.1
+    max_tokens: 2000
+    enable_vision: true
+    max_screenshots: 10
+    system_prompt: |
+      你是一个专业的自动化测试结果审查员。
+      你的任务是根据测试用例定义、执行日志和截图，判断测试是否真正成功。
+
+      判断标准：
+      1. 所有步骤是否按预期执行
+      2. 截图中的界面状态是否符合预期
+      3. 是否有异常、错误或警告
+      4. 最终结果是否达到测试目标
+
+      输出格式：
+      {
+        "verdict": "PASS|FAIL|SUSPICIOUS",
+        "confidence": 0.0-1.0,
+        "reason": "判断理由",
+        "issues": ["发现的问题列表"]
+      }
+
+# OmniParser 配置
+omniparser:
+  url: "http://14.103.175.167:7862/parse/"
+  box_threshold: 0.18
+  iou_threshold: 0.7
+  timeout: 5

rodski/config/reviewer_config.yaml

@@ -0,0 +1,31 @@
+# DEPRECATED: 配置已迁移到 llm_config.yaml。本文件仅作为向后兼容保留。
+# LLM Reviewer 配置
+
+# API 配置
+api_base: "http://code.casstime.ai"
+api_key: "sk-f3tf9sUywnTBNbkQesLsaEE5Abtz1vZX88Sqvqm5MG7cGg3w"
+model: "gpt-5.4"
+temperature: 0.1
+max_tokens: 2000
+
+# 审查配置
+review:
+  enable_vision: true
+  max_screenshots: 10
+  system_prompt: |
+    你是一个专业的自动化测试结果审查员。
+    你的任务是根据测试用例定义、执行日志和截图，判断测试是否真正成功。
+    
+    判断标准：
+    1. 所有步骤是否按预期执行
+    2. 截图中的界面状态是否符合预期
+    3. 是否有异常、错误或警告
+    4. 最终结果是否达到测试目标
+    
+    输出格式：
+    {
+      "verdict": "PASS|FAIL|SUSPICIOUS",
+      "confidence": 0.0-1.0,
+      "reason": "判断理由",
+      "issues": ["发现的问题列表"]
+    }

rodski/config/vision_config.yaml

@@ -0,0 +1,14 @@
+# DEPRECATED: 配置已迁移到 llm_config.yaml。本文件仅作为向后兼容保留。
+omniparser:
+  url: http://14.103.175.167:7862/parse/
+  box_threshold: 0.18
+  iou_threshold: 0.7
+  timeout: 5
+
+llm:
+  provider: claude  # claude / openai / qwen
+  model: claude-opus-4-6
+  base_url: ""  # 留空使用默认，或填代理地址
+  api_key_env: ANTHROPIC_API_KEY  # 环境变量名
+  timeout: 10
+  max_tokens: 1024

rodski/core/__init__.py

@@ -0,0 +1,36 @@
+"""Core package — lazy imports to avoid heavy optional dependencies at import time"""
+
+__all__ = [
+    'KeywordEngine',
+    'TaskExecutor',
+    'ConfigManager',
+    'Logger',
+    'RodskiXmlValidator',
+    'XmlSchemaValidationError',
+    'DriverFactory',
+]
+
+
+def __getattr__(name):
+    if name == 'KeywordEngine':
+        from .keyword_engine import KeywordEngine
+        return KeywordEngine
+    if name == 'TaskExecutor':
+        from .task_executor import TaskExecutor
+        return TaskExecutor
+    if name == 'ConfigManager':
+        from .config_manager import ConfigManager
+        return ConfigManager
+    if name == 'Logger':
+        from .logger import Logger
+        return Logger
+    if name == 'RodskiXmlValidator':
+        from .xml_schema_validator import RodskiXmlValidator
+        return RodskiXmlValidator
+    if name == 'XmlSchemaValidationError':
+        from .exceptions import XmlSchemaValidationError
+        return XmlSchemaValidationError
+    if name == 'DriverFactory':
+        from .driver_factory import DriverFactory
+        return DriverFactory
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

rodski/core/assertion/__init__.py

@@ -0,0 +1,16 @@
+"""视觉断言模块 — lazy imports to avoid requiring cv2 at import time."""
+
+__all__ = ["BaseAssertion", "ImageMatcher", "VideoAnalyzer"]
+
+
+def __getattr__(name):
+    if name == 'BaseAssertion':
+        from .base_assertion import BaseAssertion
+        return BaseAssertion
+    if name == 'ImageMatcher':
+        from .image_matcher import ImageMatcher
+        return ImageMatcher
+    if name == 'VideoAnalyzer':
+        from .video_analyzer import VideoAnalyzer
+        return VideoAnalyzer
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

rodski/core/assertion/base_assertion.py

@@ -0,0 +1,35 @@
+"""断言基类 - 定义断言接口"""
+from abc import ABC, abstractmethod
+from typing import Dict, Any
+from pathlib import Path
+
+
+class BaseAssertion(ABC):
+    """视觉断言基类
+
+    所有断言实现必须继承此类并实现 match 方法。
+    """
+
+    @abstractmethod
+    def match(self, *args, **kwargs) -> Dict[str, Any]:
+        """执行断言匹配
+
+        Returns:
+            结构化结果字典，至少包含:
+            - matched: bool  是否匹配成功
+            - similarity: float  匹配度
+            - threshold: float  阈值
+        """
+        pass
+
+    @staticmethod
+    def resolve_reference_path(reference: str, module_dir: Path) -> Path:
+        """将相对路径解析为绝对路径
+
+        预期图片路径相对于 `images/assert/` 目录。
+        """
+        images_dir = module_dir / "images" / "assert"
+        ref_path = Path(reference)
+        if ref_path.is_absolute():
+            return ref_path
+        return images_dir / reference