sisyphus-api-engine 2.2.0__tar.gz

sisyphus_api_engine-2.2.0/.cursor/commands/sisyphus-api-engine.md

@@ -0,0 +1,54 @@
+# Sisyphus-api-engine 开发执行准则
+
+你现在是一名专注于自动化测试引擎的核心开发工程师。请严格遵循以下工作流与质量控制协议进行 Sisyphus-api-engine 的任务开发：
+
+## 1. 核心参考上下文
+
+在执行任何代码编写前，必须深度对齐以下文档：
+
+- **进度依据**：`docs/开发任务清单.md`（明确当前待办项与优先级）。
+- **业务逻辑**：`docs/Sisyphus-X需求文档.md`（确保功能符合全局设计）。
+- **协议规范**：`docs/Sisyphus-api-engine JSON 输出规范.md` 与 `YAML 输入规范.md`。
+
+## 2. 闭环开发与原子化验证
+
+每完成一个子功能或 Bug 修复，必须立即执行以下闭环流程，严禁“带病”推进：
+
+1. **同步测试补全**：
+
+- 单元测试用例：编写脚本并存放在 `tests/unit/`。
+- YAML测试用例：编写集成测试并存放在 `tests/yaml/`。
+- 严禁使用占位符或无效 Mock 数据
+
+2. **执行全量验证**：
+
+```bash
+# 运行全量单元测试
+sisyphus-api-engine --cases tests/unit/
+# 运行全量 YAML 业务案例
+sisyphus-api-engine --cases tests/yaml/
+
+```
+
+3. **准入原则**：只有当上述测试结果均为 **100% Pass** 时，方可进入提交环节。
+
+## 3. GitHub 原子化提交规范
+
+在任务完成且测试通过后，必须进行规范化的代码提交：
+
+- **提交原则**：坚持**原子化提交**（每次提交仅包含一个逻辑改动或一个任务清单项）。
+- **Commit 信息格式**：`<emoji> <type>(<scope>): <subject>`
+- **常用类型参考**：
+- ✨ `:sparkles: feat`: 实现新功能（对应任务清单中的新项）
+- 🐛 `:bug: fix`: 修复 Bug
+- 📝 `:memo: docs`: 文档更新
+- ♻️ `:recycle: refactor`: 代码重构
+- ✅ `:white_check_mark: test`: 增加或修改测试用例
+- ⚡️ `:zap: perf`: 性能优化
+
+- **示例**：`✨ feat(engine): 实现 YAML 动态变量解析功能`
+
+## 4. 任务状态闭环
+
+- **更新进度**：提交代码后，同步更新 `docs/开发任务清单.md` 中的任务状态。
+- **禁止越级**：严禁在当前任务未完成提交前启动清单中的下一个任务。

sisyphus_api_engine-2.2.0/.gitignore

@@ -0,0 +1,44 @@
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+
+# 虚拟环境
+.venv/
+venv/
+env/
+
+# 编辑器 / IDE
+# .vscode/
+.idea/
+*.code-workspace
+
+# macOS
+.DS_Store
+
+# 构建产物
+build/
+dist/
+*.egg-info/
+
+# 测试 / 覆盖率
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+
+# Ruff / Pyright / 其他缓存
+.ruff_cache/
+.pyright/
+.mypy_cache/
+.cache/
+
+# 日志
+logs/
+*.log
+
+# 本地临时文件
+*.swp
+*.swo
+*~
+

sisyphus_api_engine-2.2.0/.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.0
+    hooks:
+      - id: ruff
+      - id: ruff-format
+
+  - repo: https://github.com/microsoft/pyright
+    rev: v1.1.390
+    hooks:
+      - id: pyright
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+

sisyphus_api_engine-2.2.0/.sisyphus/config.yaml

@@ -0,0 +1,17 @@
+profiles:
+  dev:
+    base_url: "http://dev.example.com"
+    variables:
+      api_key: "dev-key-please-change"
+
+  prod:
+    base_url: "https://api.example.com"
+    variables:
+      api_key: "prod-key-please-change"
+
+active_profile: "dev"
+
+variables:
+  common_headers:
+    User-Agent: "sisyphus-api-engine/2.2.0"
+

sisyphus_api_engine-2.2.0/.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "cSpell.words": [
+    "apirun",
+    "pydantic",
+    "pypi",
+    "pypirc",
+    "pyproject",
+    "pytest",
+    "teststeps"
+  ]
+}

sisyphus_api_engine-2.2.0/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+## [2.2.0] - 2026-02-26
+
+### 变更
+
+- 发布：将核心执行器重构线作为 PyPI 新版本 `2.2.0` 发布，对应当前仓库代码。
+- 文档：更新 README 中的版本说明与发布策略，标记 2.2.0 为最新稳定版，并保留历史 2.1.0 信息。
+- 版本管理：`pyproject.toml` 中版本号由 `0.2.0` 升级为 `2.2.0`，用于对齐现有 PyPI 版本序列。
+
+## [0.2.0] - 2026-02-26
+
+### 变更
+
+- 文档：根据《sisyphus-api-engine 需求规格说明书》与《开发任务清单》重写 `README.md`，明确技术栈（Python 3.12 + uv + Ruff + Pyright）与当前功能边界。
+- 基础设施：补充 `.gitignore`、`.sisyphus/config.yaml`、`LICENSE`、`MANIFEST.in`、`.pre-commit-config.yaml` 等项目必需文件。
+- 工具链：更新 `pyproject.toml` 中的 Python 版本约束与开发依赖，统一使用 uv + Ruff + Pyright 的现代化开发流程。
+- 版本管理：将内部版本号从 `0.1.0` 提升到 `0.2.0`，为后续核心能力与高级特性开发预留演进空间。
+
+## [0.1.0] - 2026-02-26
+
+### 新增
+
+- 项目初始化，从 Sisyphus-X 主项目中独立
+- 核心数据模型 (CaseModel, Config, StepDefinition)
+- YAML 用例加载与校验
+- HTTP 请求执行器
+- CLI 入口 (`sisyphus` 命令)
+- 支持 text / json / allure / html 输出格式
+- 项目目录结构重组为 `apirun/` 包

sisyphus_api_engine-2.2.0/CLAUDE.md

@@ -0,0 +1,189 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## 项目概述
+
+sisyphus-api-engine 是 YAML 驱动的接口自动化测试引擎，为 Sisyphus-X 平台提供核心执行器能力。当前仓库是「轻量核心版」，聚焦核心链路：
+
+**YAML → Pydantic 模型 → 场景运行器 → HTTP 请求 → JSON 输出**
+
+高级特性（数据库、数据驱动、断言引擎、WebSocket 推送等）按任务清单逐步实现。
+
+## 常用命令
+
+### 环境管理
+```bash
+# 创建虚拟环境（Python 3.12+）
+uv venv -p 3.12 .venv
+source .venv/bin/activate  # macOS / Linux
+
+# 安装依赖
+uv sync
+
+# 开发模式安装（含 dev 依赖）
+uv pip install -e ".[dev]"
+```
+
+### 代码质量检查
+```bash
+# 代码格式化（Ruff）
+uv run ruff format .
+
+# 静态检查（Ruff）
+uv run ruff check .
+
+# 类型检查（Pyright）
+uv run pyright
+```
+
+### 测试执行
+```bash
+# 运行所有单元测试
+uv run python -m pytest tests/unit -v
+
+# 运行单个 YAML 用例并输出 JSON
+sisyphus --case tests/yaml/simple_get.yaml -O json
+
+# 批量执行目录下所有 YAML 用例
+sisyphus --cases tests/yaml/ -O json
+```
+
+### Pre-commit 钩子
+```bash
+# 安装 pre-commit 钩子（推荐）
+pre-commit install
+```
+
+## 核心架构
+
+### 数据流
+
+```
+YAML 用例
+  ↓
+load_case() → Pydantic 模型校验
+  ↓
+run_case() → 场景运行器
+  ↓
+execute_request_step() → HTTP 请求执行
+  ↓
+JSON 输出（符合内部规范）
+```
+
+### 关键模块
+
+| 模块 | 文件 | 职责 |
+|------|------|------|
+| **数据模型** | `apirun/core/models.py` | 所有 YAML 结构的 Pydantic 模型定义 |
+| **场景运行器** | `apirun/core/runner.py` | `load_case()` 加载 YAML，`run_case()` 执行用例 |
+| **请求执行器** | `apirun/executor/request.py` | HTTP 请求发送与响应处理 |
+| **变量渲染** | `apirun/utils/variables.py` | `{{var}}` / `{{func()}}` 模板递归渲染 |
+| **内置函数** | `apirun/utils/functions.py` | `random()`, `timestamp()` 等模板函数 |
+| **CLI 入口** | `apirun/cli.py` | `sisyphus` 命令实现 |
+
+### 变量系统
+
+**渲染规则**（`apirun/utils/variables.py`）：
+- `{{var_name}}` → 从 `variables` 字典读取
+- `{{func_name(arg1, arg2)}}` → 调用内置函数（见 `BUILTIN_FUNCTIONS`）
+- 支持递归渲染 dict / list / str 结构
+
+**变量优先级**：
+1. `config.variables`（场景级）
+2. `config.environment.variables`（环境级，覆盖场景级）
+
+### 关键类型设计
+
+**`StepDefinition.keyword_type`** 决定步骤类型：
+- `request` → HTTP 请求（当前已实现）
+- `assertion` → 独立断言步骤（预留）
+- `extract` → 变量提取步骤（预留）
+- `db` → 数据库操作（预留）
+- `custom` → 自定义关键字（预留）
+
+**YAML 模型字段别名**：
+- `RequestStepParams.json` 使用 `alias="json"`（避免与 Python 内置冲突）
+
+## 开发约定
+
+### 代码风格
+- **Python 版本**: 3.12+
+- **代码风格**: Google Python Style（Ruff 配置）
+- **注释语言**: 统一使用中文，解释「意图」而非「语法」
+- **类型注解**: 尽量补全，保持 Pyright 通过
+- **行长度**: 100 字符（`ruff.line-length = 100`）
+
+### 测试要求
+- 单元测试位于 `tests/unit/`
+- YAML 集成用例位于 `tests/yaml/`
+- 新增/修改功能时需同步补充测试
+
+### 提交规范
+建议使用前缀：
+- `feat:` - 新功能
+- `fix:` - Bug 修复
+- `refactor:` - 重构
+- `docs:` - 文档更新
+- `test:` - 测试相关
+- `chore:` - 构建/工具链
+
+## 配置文件
+
+### `.sisyphus/config.yaml`
+统一环境配置：
+```yaml
+profiles:
+  dev:
+    base_url: "http://dev.example.com"
+    variables:
+      api_key: "dev-key"
+  prod:
+    base_url: "https://api.example.com"
+    variables:
+      api_key: "prod-key"
+
+active_profile: "dev"
+
+variables:
+  common_headers:
+    User-Agent: "sisyphus-api-engine/0.2.0"
+```
+
+### CLI 输出格式
+- `-O text`（默认）：人类可读文本输出
+- `-O json`：机器可读 JSON（符合 `docs/Sisyphus-api-engine JSON 输出规范.md`）
+- `-O allure` / `-O html`：预留
+
+## 版本说明
+
+- **当前版本**: `0.2.0`（核心执行器重构线）
+- **PyPI 已发布版本**: `2.1.0`（完整引擎，与当前仓库解耦）
+- **版本变更记录**: 见 `CHANGELOG.md`
+
+## 扩展点
+
+### 添加新的内置函数
+在 `apirun/utils/functions.py` 中：
+1. 实现函数（签名参考现有函数）
+2. 注册到 `BUILTIN_FUNCTIONS` 字典
+
+### 自定义关键字
+继承 `apirun/keyword.Keyword` 基类：
+```python
+from apirun.keyword import Keyword
+
+class MyKeyword(Keyword):
+    name = "my_keyword"
+
+    def execute(self, **kwargs):
+        # 实现逻辑
+        return result
+```
+
+## 重要文档
+
+- 需求规格说明：`docs/Sisyphus-api-engine需求文档.md`
+- YAML 输入规范：`docs/Sisyphus-api-engine YAML 输入规范.md`
+- JSON 输出规范：`docs/Sisyphus-api-engine JSON 输出规范.md`
+- 开发任务清单：`docs/开发任务清单.md`

sisyphus_api_engine-2.2.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 koco-co
+
+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.
+

sisyphus_api_engine-2.2.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include CHANGELOG.md
+include LICENSE
+
+recursive-include docs *.md
+
+recursive-exclude .venv *
+recursive-exclude .git *
+