rodski 5.7.1__tar.gz

rodski-5.7.1/MANIFEST.in

@@ -0,0 +1,19 @@
+include rodski/LICENSE
+include rodski/README.md
+
+recursive-include rodski/schemas *.xsd
+recursive-include rodski/config *.yaml *.json
+
+prune rodski/tests
+prune rodski/docs
+prune rodski/examples
+prune rodski/scripts
+prune rodski/images
+prune rodski/rodski_docs
+
+exclude rodski/.flake8
+exclude rodski/bandit.yaml
+exclude rodski/mypy.ini
+exclude rodski/pytest.ini
+exclude rodski/selftest.py
+exclude rodski/requirements.txt

rodski-5.7.1/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: rodski
+Version: 5.7.1
+Summary: RodSki - XML-driven keyword automation testing framework for AI agents
+Author: Lightning Strike Team
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/user/RodSki
+Project-URL: Repository, https://github.com/user/RodSki
+Keywords: testing,automation,keyword-driven,xml,playwright,appium,ai-agent,test-framework
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: xmlschema>=2.5.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: tqdm>=4.65.0
+Requires-Dist: psutil>=5.9.0
+Requires-Dist: requests>=2.31.0
+Provides-Extra: web
+Requires-Dist: playwright>=1.40.0; extra == "web"
+Provides-Extra: mobile
+Requires-Dist: Appium-Python-Client>=3.0.0; extra == "mobile"
+Provides-Extra: gui
+Requires-Dist: PyQt6>=6.6.0; extra == "gui"
+Provides-Extra: vision
+Requires-Dist: pillow>=10.0.0; extra == "vision"
+Provides-Extra: llm
+Requires-Dist: anthropic>=0.18.0; extra == "llm"
+Requires-Dist: openai>=1.12.0; extra == "llm"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.12.0; extra == "dev"
+Provides-Extra: all
+Requires-Dist: rodski[gui,llm,mobile,vision,web]; extra == "all"
+
+# 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-5.7.1/README.md

@@ -0,0 +1,93 @@
+# RodSki
+
+**RodSki** 是面向 AI Agent 的跨平台确定性测试执行引擎，基于 XML 活文档协议，支持 Web（Playwright）、Android（Appium）、iOS（Appium）和桌面应用（PyWinAuto）的自动化测试执行。
+
+> Agent 负责思考，RodSki 负责稳定执行。
+
+## 特性
+
+- **结构化 XML 协议** — model / case / data 活文档，Agent 可读可写
+- **多平台确定性执行** — Web / Android / iOS / Desktop 统一关键字
+- **视觉定位能力** — OmniParser + LLM 语义定位（可选 AI 能力层）
+- **Agent 友好 CLI** — run / validate / explain / dry-run，JSON 结构化输出
+- **活文档模式** — Agent 写 XML → RodSki 执行 → 结果反馈 → Agent 分析
+- **智能等待** — 自动处理元素加载延迟，零配置开箱即用
+- **智能诊断** — AI 辅助失败分析与恢复建议（可选）
+
+## 快速开始
+
+```bash
+# 安装
+pip install -r requirements.txt
+
+# 执行测试
+rodski run case/ --output-format json
+
+# 解释用例（自然语言）
+rodski explain case/login.xml
+
+# 干跑模式（仅验证不执行）
+rodski run case/ --dry-run
+
+# 详细输出
+rodski run case/ --verbose
+```
+
+## 架构概览
+
+```
+Agent (探索/决策) → XML (活文档) → RodSki (执行) → JSON (结果) → Agent (分析)
+```
+
+RodSki 作为 Agent 工具链中的执行层，提供确定性、可重复的测试执行能力。Agent 通过 XML 协议描述测试意图，RodSki 负责跨平台执行并以 JSON 格式返回结构化结果，供 Agent 进一步分析和决策。
+
+## 项目结构
+
+```
+RodSki/
+├── rodski/              # 核心框架
+│   ├── core/            # 执行引擎（关键字、解析器、诊断）
+│   ├── drivers/         # 平台驱动（Playwright/Appium/PyWinAuto）
+│   ├── llm/             # LLM 能力层（可选）
+│   ├── vision/          # 视觉定位（可选）
+│   ├── rodski_cli/      # CLI 子命令
+│   ├── config/          # 配置文件
+│   └── docs/            # 框架文档
+├── rodski-demo/         # 官方示例
+└── .pb/                 # 项目管理文档
+```
+
+## 文档
+
+| 文档 | 说明 |
+|------|------|
+| [Agent 集成指南](rodski/docs/AGENT_INTEGRATION.md) | Agent 接入主入口 |
+| [用例编写指南](rodski/docs/TEST_CASE_WRITING_GUIDE.md) | XML 用例编写规范 |
+| [核心设计约束](rodski/docs/CORE_DESIGN_CONSTRAINTS.md) | 框架不可违反的设计约束 |
+| [关键字参考](rodski/docs/SKILL_REFERENCE.md) | 全部关键字语法说明 |
+| [架构说明](rodski/docs/ARCHITECTURE.md) | 框架内部架构 |
+| [视觉定位](rodski/docs/VISION_LOCATION.md) | OmniParser 视觉定位能力 |
+
+## 智能等待
+
+RodSki 内置智能等待机制，自动处理 UI 元素的加载延迟，无需手动添加等待步骤。
+
+- **零配置** — 默认启用，开箱即用
+- **性能优化** — 元素就绪时立即执行，不浪费时间
+- **自动重试** — 元素未加载时自动重试（默认 30 次 x 300ms = 9 秒）
+- **可配置** — 支持自定义重试次数和间隔
+
+配置项位于 `rodski/config/config.json`：
+
+```json
+{
+  "smart_wait_enabled": true,
+  "smart_wait_max_retries": 30,
+  "smart_wait_retry_interval": 0.3,
+  "smart_wait_log_retry": true
+}
+```
+
+## License
+
+MIT License - 详见 [LICENSE](rodski/LICENSE)

rodski-5.7.1/pyproject.toml

@@ -0,0 +1,98 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rodski"
+version = "5.7.1"
+description = "RodSki - XML-driven keyword automation testing framework for AI agents"
+readme = {file = "rodski/README.md", content-type = "text/markdown"}
+license = "MIT"
+requires-python = ">=3.9"
+authors = [
+    {name = "Lightning Strike Team"},
+]
+keywords = [
+    "testing", "automation", "keyword-driven", "xml", "playwright",
+    "appium", "ai-agent", "test-framework",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Software Development :: Quality Assurance",
+]
+
+dependencies = [
+    "xmlschema>=2.5.0",
+    "pyyaml>=6.0.0",
+    "tqdm>=4.65.0",
+    "psutil>=5.9.0",
+    "requests>=2.31.0",
+]
+
+[project.optional-dependencies]
+web = ["playwright>=1.40.0"]
+mobile = ["Appium-Python-Client>=3.0.0"]
+gui = ["PyQt6>=6.6.0"]
+vision = ["pillow>=10.0.0"]
+llm = ["anthropic>=0.18.0", "openai>=1.12.0"]
+dev = ["pytest>=7.4.0", "pytest-cov>=4.1.0", "pytest-mock>=3.12.0"]
+all = ["rodski[web,mobile,gui,vision,llm]"]
+
+[project.scripts]
+rodski = "rodski.cli_main:main"
+
+[project.urls]
+Homepage = "https://github.com/user/RodSki"
+Repository = "https://github.com/user/RodSki"
+
+[tool.setuptools.packages.find]
+include = ["rodski", "rodski.*"]
+exclude = [
+    "rodski.tests", "rodski.tests.*",
+    "rodski.docs", "rodski.docs.*",
+    "rodski.examples", "rodski.examples.*",
+    "rodski.scripts", "rodski.scripts.*",
+    "rodski.images", "rodski.images.*",
+    "rodski.rodski_docs", "rodski.rodski_docs.*",
+]
+
+[tool.setuptools.package-data]
+rodski = [
+    "schemas/*.xsd",
+    "config/*.yaml",
+    "config/*.json",
+]
+
+[tool.black]
+line-length = 120
+target-version = ['py39']
+exclude = '''
+/(
+    \.git
+  | \.venv
+  | venv
+  | build
+  | dist
+)/
+'''
+
+[tool.isort]
+profile = "black"
+line_length = 120
+
+[tool.coverage.run]
+source = ["rodski"]
+omit = ["*/tests/*", "*/demo_*/*"]
+
+[tool.coverage.report]
+fail_under = 80
+precision = 2

rodski-5.7.1/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-5.7.1/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-5.7.1/rodski/__init__.py

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

rodski-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-5.7.1/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-5.7.1/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-5.7.1/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
+}