opencroc 0.6.1 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.zh-CN.md CHANGED
@@ -1,340 +1,414 @@
1
- <p align="center">
2
- <img src="assets/banner.png" alt="OpenCroc 横幅" width="820" />
3
- </p>
4
-
5
- <h1 align="center">OpenCroc</h1>
6
-
7
- <p align="center">
8
- <strong>AI 原生 E2E 测试框架:读取你的源码、自动生成测试、并可自愈失败。</strong>
9
- </p>
10
-
11
- <p align="center">
12
- <a href="https://www.npmjs.com/package/opencroc"><img src="https://img.shields.io/npm/v/opencroc?color=green" alt="npm version" /></a>
13
- <a href="https://github.com/opencroc/opencroc/actions/workflows/ci.yml"><img src="https://github.com/opencroc/opencroc/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI" /></a>
14
- <a href="https://github.com/opencroc/opencroc/blob/main/LICENSE"><img src="https://img.shields.io/github/license/opencroc/opencroc" alt="MIT License" /></a>
15
- <a href="https://opencroc.com"><img src="https://img.shields.io/badge/docs-opencroc.com-blue" alt="Documentation" /></a>
16
- </p>
17
-
18
- <p align="center">
19
- <a href="README.en.md">English</a> | <a href="README.zh-CN.md">简体中文</a> | <a href="README.ja.md">日本語</a>
20
- </p>
21
-
22
- ---
23
-
24
- ## OpenCroc 是什么?
25
-
26
- OpenCroc 是一个构建在 [Playwright](https://playwright.dev) 之上的 **AI 原生端到端测试框架**。你不需要手写大量脚本,OpenCroc 会**读取后端源码**(模型、控制器、DTO),并自动生成完整 E2E 测试套件,包括 API 调用链、种子数据、请求体与断言。
27
-
28
- 当测试失败时,OpenCroc 不只是报错,而是会沿完整请求链路**定位根因**、**生成修复补丁**,并**自动回归验证**修复结果。
29
-
30
- ### 核心能力
31
-
32
- | 能力 | 说明 |
33
- |---|---|
34
- | **源码感知测试生成** | 通过 [ts-morph](https://ts-morph.com) 解析 Sequelize/TypeORM 模型、Express/NestJS 控制器、DTO 装饰器,识别 API 面 |
35
- | **AI 配置生成** | 使用 LLM 生成请求模板、种子数据、参数映射,并通过三层校验(schema -> semantic -> dry-run) |
36
- | **智能调用链规划** | 构建 API 依赖 DAG,做拓扑排序并以贪心策略提升覆盖率 |
37
- | **日志驱动完成判定** | 超越 `networkidle`,通过后端日志(`api_exec end`)确认请求真正完成 |
38
- | **失败链路归因** | 从网络异常 -> 慢接口 -> 后端日志逐层追踪,定位根因 |
39
- | **可控自愈机制** | `backup -> AI patch -> dry-run -> apply -> re-run -> verify -> rollback`,每步有安全闸门 |
40
- | **影响面分析** | 基于外键关系做 BFS 传播分析,自动输出 Mermaid 图 |
41
-
42
- ## 快速开始
43
-
44
- ### 前置要求
45
-
46
- - Node.js >= 18
47
- - 使用 Express/NestJS + Sequelize/TypeORM 的后端项目
48
-
49
- ### 安装
50
-
51
- ```bash
52
- npm install opencroc --save-dev
53
- ```
54
-
55
- ### 初始化
56
-
57
- ```bash
58
- npx opencroc init
59
- ```
60
-
61
- 该命令会:
62
- 1. 扫描项目结构
63
- 2. 识别 ORM 与后端框架
64
- 3. 生成默认 `opencroc.config.ts`
65
- 4. 生成一套示例测试
66
-
67
- ### 生成测试
68
-
69
- ```bash
70
- # 为单个模块生成测试
71
- npx opencroc generate --module=knowledge-base
72
-
73
- # 为所有模块生成测试
74
- npx opencroc generate --all
75
-
76
- # 仅预览,不落盘
77
- npx opencroc generate --all --dry-run
78
- ```
79
-
80
- ### 运行测试
81
-
82
- ```bash
83
- # 运行全部生成的测试
84
- npx opencroc test
85
-
86
- # 运行指定模块
87
- npx opencroc test --module=knowledge-base
88
-
89
- # 启用自愈运行
90
- npx opencroc test --self-heal
91
- ```
92
-
93
- ### 校验 AI 配置
94
-
95
- ```bash
96
- # 校验所有生成配置
97
- npx opencroc validate --all
98
-
99
- # 比较两份报告差异
100
- npx opencroc compare --baseline=report-a.json --current=report-b.json
101
- ```
102
-
103
- ## 架构
104
-
105
- ```
106
- ┌─────────────────────────────────────────────────────────────┐
107
- │ CLI / Orchestrator │
108
- ├──────────┬──────────┬──────────┬──────────┬─────────────────┤
109
- │ Source │ Chain │ Test │ Execution│ Self-Healing │
110
- │ Parser │ Planner │Generator │ Engine │ Engine │
111
- │ │ │ │ │ │
112
- ts-morph │ DAG + │ Template │Playwright│ AI Attribution │
113
- │ Model │ Topo │ + AI │ + Log │ + Controlled │
114
- Controller│ Sort + │ Config │ Driven │ Fix + Verify │
115
- DTO │ Greedy │ Merge │ Assert │ + Rollback │
116
- ├──────────┴──────────┴──────────┴──────────┴─────────────────┤
117
- │ Observation Bus (Network + Backend Logs) │
118
- ├──────────────────────────────────────────────────────────────┤
119
- │ Report Engine (HTML / JSON / Markdown) │
120
- └──────────────────────────────────────────────────────────────┘
121
- ```
122
-
123
- ### 6 阶段流水线
124
-
125
- ```
126
- Source Scan -> ER Diagram -> API Analysis -> Chain Planning -> Test Generation -> Failure Analysis
127
- │ │ │ │ │ │
128
- ts-morph Mermaid Dependency Topological Playwright + Root Cause +
129
- parsing erDiagram DAG builder + greedy AI body/seed Impact map
130
- ```
131
-
132
- ## 工作原理
133
-
134
- ### 1. 源码解析
135
-
136
- OpenCroc 基于 [ts-morph](https://ts-morph.com) 做静态分析:
137
-
138
- - **Models**:从 Sequelize `Model.init()` / TypeORM `@Entity()` 提取表名、字段类型、索引、外键
139
- - **Controllers**:从 Express `router.get/post/put/delete` 提取路由、HTTP 方法、路径参数
140
- - **DTOs**:从 `@IsString()`、`@IsNumber()`、`@IsOptional()` 装饰器提取校验规则
141
-
142
- ### 2. AI 配置生成
143
-
144
- 每个模块都会调用 LLM(OpenAI / 智谱 / 任意 OpenAI 兼容 API)生成:
145
-
146
- - **请求体模板**:字段级精确的 POST/PUT payload
147
- - **种子数据**:`beforeAll` 的初始化步骤与正确调用顺序
148
- - **参数映射**:路径参数别名(`/:id` -> `categoryId`)
149
- - **ID 别名**:避免多资源链路中的 ID 冲突
150
-
151
- 每份配置都要通过 **3 层校验**:
152
- 1. **Schema 校验**:JSON 结构完整性
153
- 2. **语义校验**:字段值是否与源码元数据一致
154
- 3. **Dry-run 校验**:TypeScript 编译检查
155
-
156
- 若校验失败,会在落盘前自动修复(最多 3 轮)。
157
-
158
- ### 3. 日志驱动完成判定
159
-
160
- 不依赖脆弱的 `networkidle`:
161
-
162
- ```
163
- Frontend Request -> Backend api_exec start log -> Backend processing -> api_exec end log
164
-
165
- OpenCroc polls end logs to confirm completion
166
- ```
167
-
168
- 这能覆盖“前端看起来空闲、后端仍在处理”的场景。
169
-
170
- ### 4. 自愈闭环
171
-
172
- ```
173
- Test Failure
174
- -> AI Attribution (LLM + heuristic fallback)
175
- -> Generate Fix Patch
176
- -> Dry-Run Validation
177
- -> Apply Patch (with backup)
178
- -> Re-run Failed Tests
179
- -> Verify Fix
180
- -> Commit or Rollback
181
- ```
182
-
183
- ## 真实项目验证
184
-
185
- OpenCroc 已在一套**生产级 RBAC 系统**(多租户企业权限管理)上完成验证,涵盖 100+ Sequelize 模型、75+ Express 控制器、以及模型文件内嵌的关联声明:
186
-
187
- ```
188
- $ npx tsx examples/rbac-system/smoke-test.ts
189
-
190
- Modules : 5 (default, aigc, data-platform, integration, workflow)
191
- ER Diagrams : 5
192
- [default] 102 tables, 65 relations
193
- [aigc] 6 tables, 0 relations
194
- [data-platform] 4 tables, 0 relations
195
- [integration] 14 tables, 0 relations
196
- [workflow] 2 tables, 0 relations
197
- Chain Plans : 5
198
- [aigc] 78 chains, 150 steps
199
- Generated Files: 78
200
- Duration : 1153ms
201
- ```
202
-
203
- 关键发现:
204
- - 从扁平模型布局中正确提取了 **102 张表** 和 **65 条外键关系**
205
- - 无需独立 association 文件,直接检测模型文件中的**嵌入式关联**(`.belongsTo()` / `.hasMany()`)
206
- - 5 个模块共生成 **78 个测试文件**,耗时仅 1 秒出头
207
- - 同时兼容扁平(`models/*.ts`)和嵌套(`models/module/*.ts`)目录结构
208
-
209
- ## 配置示例
210
-
211
- ```typescript
212
- // opencroc.config.ts
213
- import { defineConfig } from 'opencroc';
214
-
215
- export default defineConfig({
216
- // 后端源码路径
217
- backend: {
218
- modelsDir: 'src/models',
219
- controllersDir: 'src/controllers',
220
- servicesDir: 'src/services',
221
- },
222
-
223
- // 目标应用
224
- baseUrl: 'http://localhost:3000',
225
- apiBaseUrl: 'http://localhost:3000/api',
226
-
227
- // AI 配置
228
- ai: {
229
- provider: 'openai', // 'openai' | 'zhipu' | 'custom'
230
- apiKey: process.env.AI_API_KEY,
231
- model: 'gpt-4o-mini',
232
- },
233
-
234
- // 测试执行
235
- execution: {
236
- workers: 4,
237
- timeout: 30_000,
238
- retries: 1,
239
- },
240
-
241
- // 日志驱动完成判定(需后端埋点)
242
- logCompletion: {
243
- enabled: true,
244
- endpoint: '/internal/test-logs',
245
- pollIntervalMs: 500,
246
- timeoutMs: 10_000,
247
- },
248
-
249
- // 自愈
250
- selfHealing: {
251
- enabled: false,
252
- fixScope: 'config-only', // 'config-only' | 'config-and-source'
253
- maxFixRounds: 3,
254
- dryRunFirst: true,
255
- },
256
- });
257
- ```
258
-
259
- ## 支持的技术栈
260
-
261
- | 层级 | 已支持 | 规划中 |
262
- |---|---|---|
263
- | **ORM** | Sequelize, TypeORM, Prisma, Drizzle | — |
264
- | **Framework** | Express | NestJS, Fastify, Koa |
265
- | **Test Runner** | Playwright | — |
266
- | **LLM** | OpenAI, ZhiPu (GLM), Ollama (local) | Anthropic |
267
- | **Database** | MySQL, PostgreSQL | SQLite, MongoDB |
268
-
269
- ## 对比
270
-
271
- | 功能 | OpenCroc | Playwright | Metersphere | auto-playwright |
272
- |---|---|---|---|---|
273
- | 源码感知生成 | ✅ | ❌ | ❌ | ❌ |
274
- | AI 配置生成 + 校验 | ✅ | ❌ | ❌ | ❌ |
275
- | 日志驱动完成判定 | ✅ | ❌ | ❌ | ❌ |
276
- | 失败链路归因 | ✅ | ❌ | 部分 | ❌ |
277
- | 自愈 + 回滚 | ✅ | ❌ | ❌ | ❌ |
278
- | API 依赖 DAG | ✅ | ❌ | ❌ | ❌ |
279
- | 零配置测试生成 | ✅ | 仅 codegen | 手工 | NL->action |
280
- | 影响面分析 | ✅ | ❌ | ❌ | ❌ |
281
-
282
- ## Roadmap
283
-
284
- - [x] 6-stage source-to-test pipeline
285
- - [x] AI configuration generation with 3-layer validation
286
- - [x] Controlled self-healing loop
287
- - [x] Log-driven completion detection
288
- - [x] Failure chain attribution + impact analysis
289
- - [x] TypeORM / Prisma adapter
290
- - [x] Ollama local LLM support
291
- - [x] Real-world validation (102 tables, 65 relations, 78 generated tests)
292
- - [x] GitHub Actions / GitLab CI integration
293
- - [x] VS Code extension scaffold
294
- - [x] Plugin system
295
- - [x] HTML / JSON / Markdown report generation
296
- - [x] NestJS controller parser
297
- - [x] Visual dashboard (opencroc.com)
298
- - [x] Drizzle ORM adapter
299
-
300
- ## 发布快照
301
-
302
- - 当前稳定版本:`0.6.1`
303
- - npm `latest` 标签:`0.6.1`
304
- - Roadmap 状态:已全部完成
305
- - 全量质量门禁:Windows 下 23 个测试文件 / 184 个测试稳定通过
306
-
307
- ### 版本节奏
308
-
309
- - `0.3.x`:插件系统、CI 模板、报告系统、VS Code 脚手架、CI 稳定化
310
- - `0.4.x`:NestJS 控制器解析
311
- - `0.5.x`:Drizzle ORM 适配器
312
- - `0.6.x`:可视化 dashboard 与 Windows 下 Vitest 稳定性收口
313
-
314
- ### 发布验证
315
-
316
- ```bash
317
- npm run lint
318
- npm run typecheck
319
- npm test
320
- npm view opencroc version dist-tags --json
321
- ```
322
-
323
- ## 文档
324
-
325
- 访问 **[opencroc.com](https://opencroc.com)** 查看完整文档,或阅读:
326
-
327
- - [Architecture Guide](docs/architecture.md)
328
- - [Configuration Reference](docs/configuration.md)
329
- - [Backend Instrumentation Guide](docs/backend-instrumentation.md)
330
- - [AI Provider Setup](docs/ai-providers.md)
331
- - [Self-Healing Guide](docs/self-healing.md)
332
- - [Troubleshooting](docs/troubleshooting.md)
333
-
334
- ## 贡献
335
-
336
- 欢迎贡献代码与文档。请查看 [CONTRIBUTING.md](CONTRIBUTING.md)。
337
-
338
- ## License
339
-
340
- [MIT](LICENSE) © 2026 OpenCroc Contributors
1
+ <p align="center">
2
+ <img src="assets/banner.png" alt="OpenCroc 横幅" width="820" />
3
+ </p>
4
+
5
+ <h1 align="center">OpenCroc</h1>
6
+
7
+ <p align="center">
8
+ <strong>AI 原生 E2E 测试框架:读取你的源码、自动生成测试、并可自愈失败。</strong>
9
+ </p>
10
+
11
+ <p align="center">
12
+ <a href="https://www.npmjs.com/package/opencroc"><img src="https://img.shields.io/npm/v/opencroc?color=green" alt="npm version" /></a>
13
+ <a href="https://github.com/opencroc/opencroc/actions/workflows/ci.yml"><img src="https://github.com/opencroc/opencroc/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI" /></a>
14
+ <a href="https://github.com/opencroc/opencroc/blob/main/LICENSE"><img src="https://img.shields.io/github/license/opencroc/opencroc" alt="MIT License" /></a>
15
+ <a href="https://opencroc.com"><img src="https://img.shields.io/badge/docs-opencroc.com-blue" alt="Documentation" /></a>
16
+ </p>
17
+
18
+ <p align="center">
19
+ <a href="README.en.md">English</a> | <a href="README.zh-CN.md">简体中文</a> | <a href="README.ja.md">日本語</a>
20
+ </p>
21
+
22
+ ---
23
+
24
+ ## OpenCroc 是什么?
25
+
26
+ OpenCroc 是一个构建在 [Playwright](https://playwright.dev) 之上的 **AI 原生端到端测试框架**。你不需要手写大量脚本,OpenCroc 会**读取后端源码**(模型、控制器、DTO),并自动生成完整 E2E 测试套件,包括 API 调用链、种子数据、请求体与断言。
27
+
28
+ 当测试失败时,OpenCroc 不只是报错,而是会沿完整请求链路**定位根因**、**生成修复补丁**,并**自动回归验证**修复结果。
29
+
30
+ ### 核心能力
31
+
32
+ | 能力 | 说明 |
33
+ |---|---|
34
+ | **源码感知测试生成** | 通过 [ts-morph](https://ts-morph.com) 解析 Sequelize/TypeORM 模型、Express/NestJS 控制器、DTO 装饰器,识别 API 面 |
35
+ | **AI 配置生成** | 使用 LLM 生成请求模板、种子数据、参数映射,并通过三层校验(schema -> semantic -> dry-run) |
36
+ | **智能调用链规划** | 构建 API 依赖 DAG,做拓扑排序并以贪心策略提升覆盖率 |
37
+ | **日志驱动完成判定** | 超越 `networkidle`,通过后端日志(`api_exec end`)确认请求真正完成 |
38
+ | **失败链路归因** | 从网络异常 -> 慢接口 -> 后端日志逐层追踪,定位根因 |
39
+ | **可控自愈机制** | `backup -> AI patch -> dry-run -> apply -> re-run -> verify -> rollback`,每步有安全闸门 |
40
+ | **影响面分析** | 基于外键关系做 BFS 传播分析,自动输出 Mermaid 图 |
41
+
42
+ ## 快速开始
43
+
44
+ ### 前置要求
45
+
46
+ - Node.js >= 18
47
+ - 使用 Express/NestJS + Sequelize/TypeORM 的后端项目
48
+
49
+ ### 安装
50
+
51
+ ```bash
52
+ npm install opencroc --save-dev
53
+ ```
54
+
55
+ ### 初始化
56
+
57
+ ```bash
58
+ npx opencroc init
59
+ ```
60
+
61
+ 该命令会:
62
+ 1. 扫描项目结构
63
+ 2. 识别 ORM 与后端框架
64
+ 3. 生成默认 `opencroc.config.ts`
65
+ 4. 生成一套示例测试
66
+
67
+ ### 生成测试
68
+
69
+ ```bash
70
+ # 为单个模块生成测试
71
+ npx opencroc generate --module=knowledge-base
72
+
73
+ # 为所有模块生成测试
74
+ npx opencroc generate --all
75
+
76
+ # 仅预览,不落盘
77
+ npx opencroc generate --all --dry-run
78
+ ```
79
+
80
+ ### 运行测试
81
+
82
+ ```bash
83
+ # 运行全部生成的测试
84
+ npx opencroc test
85
+
86
+ # 运行指定模块
87
+ npx opencroc test --module=knowledge-base
88
+
89
+ # 启用自愈运行
90
+ npx opencroc test --self-heal
91
+ ```
92
+
93
+ ### 校验 AI 配置
94
+
95
+ ```bash
96
+ # 校验所有生成配置
97
+ npx opencroc validate --all
98
+
99
+ # 比较两份报告差异
100
+ npx opencroc compare --baseline=report-a.json --current=report-b.json
101
+ ```
102
+
103
+ ### 启动 OpenCroc Studio
104
+
105
+ OpenCroc Studio 是一个**像素风鳄鱼办公室** + 实时**知识图谱** UI。它在本地启动一个 Web 服务器,可视化展示项目结构、Agent 状态和测试结果。
106
+
107
+ ```bash
108
+ # 启动 Studio(自动打开浏览器 http://localhost:8765)
109
+ npx opencroc serve
110
+
111
+ # 自定义端口
112
+ npx opencroc serve --port 3000
113
+
114
+ # 不自动打开浏览器
115
+ npx opencroc serve --no-open
116
+
117
+ # 指定 host(如远程访问)
118
+ npx opencroc serve --host 0.0.0.0 --port 8765
119
+ ```
120
+
121
+ Studio 功能:
122
+ - **知识图谱画布** — 项目模型、控制器、API 关系的可交互图谱(拖拽、缩放、悬停提示)
123
+ - **像素鳄鱼办公室** — 6 只 AI 鳄鱼 Agent(解析鳄 🐊、分析鳄 🐊、测试鳄 🐊、修复鳄 🐊、规划鳄 🐊、汇报鳄 🐊),带实时状态动画
124
+ - **实时 WebSocket** — Agent 状态和图谱变化即时推送到浏览器
125
+ - **模块侧边栏** — 一目了然浏览已发现的模块和 Agent 状态
126
+ - **REST API** `GET /api/project`(图谱数据)、`GET /api/agents`(Agent 状态)、`POST /api/project/refresh`(重新扫描)
127
+
128
+ ### 完整流水线(一条命令)
129
+
130
+ ```bash
131
+ # 一键运行:generate → execute → analyze → heal → report
132
+ npx opencroc run
133
+
134
+ # 带选项
135
+ npx opencroc run --module=users --self-heal --report html,json
136
+ ```
137
+
138
+ ### CI/CD 集成
139
+
140
+ ```bash
141
+ # 生成 GitHub Actions 工作流
142
+ npx opencroc ci --platform github
143
+
144
+ # 生成 GitLab CI 管道
145
+ npx opencroc ci --platform gitlab --self-heal
146
+ ```
147
+
148
+ ### Dashboard 与报告
149
+
150
+ ```bash
151
+ # 生成可视化 Dashboard
152
+ npx opencroc dashboard
153
+
154
+ # 生成多格式报告
155
+ npx opencroc report --format html,json,markdown
156
+ ```
157
+
158
+ ## 架构
159
+
160
+ ```
161
+ ┌─────────────────────────────────────────────────────────────┐
162
+ │ OpenCroc Studio (localhost:8765) │
163
+ │ 像素鳄鱼办公室 + 知识图谱 + WebSocket │
164
+ ├─────────────────────────────────────────────────────────────┤
165
+ │ CLI / Orchestrator │
166
+ ├──────────┬──────────┬──────────┬──────────┬─────────────────┤
167
+ │ Source │ Chain │ Test │ Execution│ Self-Healing │
168
+ │ Parser │ Planner │Generator │ Engine │ Engine │
169
+ │ │ │ │ │ │
170
+ ts-morph │ DAG + │ Template │Playwright│ AI Attribution │
171
+ │ Model │ Topo │ + AI │ + Log │ + Controlled │
172
+ │ Controller│ Sort + │ Config │ Driven │ Fix + Verify │
173
+ DTO │ Greedy │ Merge │ Assert │ + Rollback │
174
+ ├──────────┴──────────┴──────────┴──────────┴─────────────────┤
175
+ │ Observation Bus (Network + Backend Logs) │
176
+ ├──────────────────────────────────────────────────────────────┤
177
+ │ Report Engine (HTML / JSON / Markdown)
178
+ └──────────────────────────────────────────────────────────────┘
179
+ ```
180
+
181
+ ### 6 阶段流水线
182
+
183
+ ```
184
+ Source Scan -> ER Diagram -> API Analysis -> Chain Planning -> Test Generation -> Failure Analysis
185
+ │ │ │ │ │ │
186
+ ts-morph Mermaid Dependency Topological Playwright + Root Cause +
187
+ parsing erDiagram DAG builder + greedy AI body/seed Impact map
188
+ ```
189
+
190
+ ## 工作原理
191
+
192
+ ### 1. 源码解析
193
+
194
+ OpenCroc 基于 [ts-morph](https://ts-morph.com) 做静态分析:
195
+
196
+ - **Models**:从 Sequelize `Model.init()` / TypeORM `@Entity()` 提取表名、字段类型、索引、外键
197
+ - **Controllers**:从 Express `router.get/post/put/delete` 提取路由、HTTP 方法、路径参数
198
+ - **DTOs**:从 `@IsString()`、`@IsNumber()`、`@IsOptional()` 装饰器提取校验规则
199
+
200
+ ### 2. AI 配置生成
201
+
202
+ 每个模块都会调用 LLM(OpenAI / 智谱 / 任意 OpenAI 兼容 API)生成:
203
+
204
+ - **请求体模板**:字段级精确的 POST/PUT payload
205
+ - **种子数据**:`beforeAll` 的初始化步骤与正确调用顺序
206
+ - **参数映射**:路径参数别名(`/:id` -> `categoryId`)
207
+ - **ID 别名**:避免多资源链路中的 ID 冲突
208
+
209
+ 每份配置都要通过 **3 层校验**:
210
+ 1. **Schema 校验**:JSON 结构完整性
211
+ 2. **语义校验**:字段值是否与源码元数据一致
212
+ 3. **Dry-run 校验**:TypeScript 编译检查
213
+
214
+ 若校验失败,会在落盘前自动修复(最多 3 轮)。
215
+
216
+ ### 3. 日志驱动完成判定
217
+
218
+ 不依赖脆弱的 `networkidle`:
219
+
220
+ ```
221
+ Frontend Request -> Backend api_exec start log -> Backend processing -> api_exec end log
222
+
223
+ OpenCroc polls end logs to confirm completion
224
+ ```
225
+
226
+ 这能覆盖“前端看起来空闲、后端仍在处理”的场景。
227
+
228
+ ### 4. 自愈闭环
229
+
230
+ ```
231
+ Test Failure
232
+ -> AI Attribution (LLM + heuristic fallback)
233
+ -> Generate Fix Patch
234
+ -> Dry-Run Validation
235
+ -> Apply Patch (with backup)
236
+ -> Re-run Failed Tests
237
+ -> Verify Fix
238
+ -> Commit or Rollback
239
+ ```
240
+
241
+ ## 真实项目验证
242
+
243
+ OpenCroc 已在一套**生产级 RBAC 系统**(多租户企业权限管理)上完成验证,涵盖 100+ Sequelize 模型、75+ Express 控制器、以及模型文件内嵌的关联声明:
244
+
245
+ ```
246
+ $ npx tsx examples/rbac-system/smoke-test.ts
247
+
248
+ Modules : 5 (default, aigc, data-platform, integration, workflow)
249
+ ER Diagrams : 5
250
+ [default] 102 tables, 65 relations
251
+ [aigc] 6 tables, 0 relations
252
+ [data-platform] 4 tables, 0 relations
253
+ [integration] 14 tables, 0 relations
254
+ [workflow] 2 tables, 0 relations
255
+ Chain Plans : 5
256
+ [aigc] 78 chains, 150 steps
257
+ Generated Files: 78
258
+ Duration : 1153ms
259
+ ```
260
+
261
+ 关键发现:
262
+ - 从扁平模型布局中正确提取了 **102 张表** 和 **65 条外键关系**
263
+ - 无需独立 association 文件,直接检测模型文件中的**嵌入式关联**(`.belongsTo()` / `.hasMany()`)
264
+ - 5 个模块共生成 **78 个测试文件**,耗时仅 1 秒出头
265
+ - 同时兼容扁平(`models/*.ts`)和嵌套(`models/module/*.ts`)目录结构
266
+
267
+ ## 配置示例
268
+
269
+ ```typescript
270
+ // opencroc.config.ts
271
+ import { defineConfig } from 'opencroc';
272
+
273
+ export default defineConfig({
274
+ // 后端源码路径
275
+ backend: {
276
+ modelsDir: 'src/models',
277
+ controllersDir: 'src/controllers',
278
+ servicesDir: 'src/services',
279
+ },
280
+
281
+ // 目标应用
282
+ baseUrl: 'http://localhost:3000',
283
+ apiBaseUrl: 'http://localhost:3000/api',
284
+
285
+ // AI 配置
286
+ ai: {
287
+ provider: 'openai', // 'openai' | 'zhipu' | 'custom'
288
+ apiKey: process.env.AI_API_KEY,
289
+ model: 'gpt-4o-mini',
290
+ },
291
+
292
+ // 测试执行
293
+ execution: {
294
+ workers: 4,
295
+ timeout: 30_000,
296
+ retries: 1,
297
+ },
298
+
299
+ // 日志驱动完成判定(需后端埋点)
300
+ logCompletion: {
301
+ enabled: true,
302
+ endpoint: '/internal/test-logs',
303
+ pollIntervalMs: 500,
304
+ timeoutMs: 10_000,
305
+ },
306
+
307
+ // 自愈
308
+ selfHealing: {
309
+ enabled: false,
310
+ fixScope: 'config-only', // 'config-only' | 'config-and-source'
311
+ maxFixRounds: 3,
312
+ dryRunFirst: true,
313
+ },
314
+ });
315
+ ```
316
+
317
+ ## 支持的技术栈
318
+
319
+ | 层级 | 已支持 | 规划中 |
320
+ |---|---|---|
321
+ | **ORM** | Sequelize, TypeORM, Prisma, Drizzle | — |
322
+ | **Framework** | Express | NestJS, Fastify, Koa |
323
+ | **Test Runner** | Playwright | — |
324
+ | **LLM** | OpenAI, ZhiPu (GLM), Ollama (local) | Anthropic |
325
+ | **Database** | MySQL, PostgreSQL | SQLite, MongoDB |
326
+
327
+ ## 对比
328
+
329
+ | 功能 | OpenCroc | Playwright | Metersphere | auto-playwright |
330
+ |---|---|---|---|---|
331
+ | 源码感知生成 | ✅ | ❌ | ❌ | ❌ |
332
+ | AI 配置生成 + 校验 | ✅ | ❌ | ❌ | ❌ |
333
+ | 日志驱动完成判定 | ✅ | ❌ | ❌ | ❌ |
334
+ | 失败链路归因 | ✅ | ❌ | 部分 | ❌ |
335
+ | 自愈 + 回滚 | ✅ | ❌ | ❌ | ❌ |
336
+ | API 依赖 DAG | ✅ | ❌ | ❌ | ❌ |
337
+ | 零配置测试生成 | ✅ | 仅 codegen | 手工 | NL->action |
338
+ | 影响面分析 | ✅ | ❌ | ❌ | ❌ |
339
+
340
+ ## Roadmap
341
+
342
+ - [x] 6-stage source-to-test pipeline
343
+ - [x] AI configuration generation with 3-layer validation
344
+ - [x] Controlled self-healing loop
345
+ - [x] Log-driven completion detection
346
+ - [x] Failure chain attribution + impact analysis
347
+ - [x] TypeORM / Prisma adapter
348
+ - [x] Ollama local LLM support
349
+ - [x] Real-world validation (102 tables, 65 relations, 78 generated tests)
350
+ - [x] GitHub Actions / GitLab CI integration
351
+ - [x] VS Code extension scaffold
352
+ - [x] Plugin system
353
+ - [x] HTML / JSON / Markdown report generation
354
+ - [x] NestJS controller parser
355
+ - [x] Visual dashboard (opencroc.com)
356
+ - [x] Drizzle ORM adapter
357
+ - [x] AI Config Suggester + Enhanced DTO-aware Suggester
358
+ - [x] Auto-Fixer(4 策略:接口路径匹配、DTO 字段填充、种子依赖排序、参数映射修复)
359
+ - [x] 三层配置验证(schema → semantic → dry-run)
360
+ - [x] DTO Parser(ts-morph 接口解析 + express-validator 规则提取)
361
+ - [x] Baseline Comparator(Playwright 报告 diff + 回归检测)
362
+ - [x] 模块配置预设加载器
363
+ - [x] LLM 增强链路规划器
364
+ - [x] Runtime 基础设施(Playwright 配置生成、认证 Setup、Teardown、网络监控)
365
+ - [x] 全流程编排管道
366
+ - [x] 高级报告系统(检查清单、工单生成、Token 追踪)
367
+ - [x] OpenCroc Studio — 像素鳄鱼办公室 + 知识图谱 UI(`opencroc serve`)
368
+
369
+ ## 发布快照
370
+
371
+ - 当前稳定版本:`1.3.0`
372
+ - npm `latest` 标签:`1.3.0`
373
+ - Roadmap 状态:M1 Studio 已交付
374
+ - 全量质量门禁:34 个测试文件 / 373 个测试通过(Node.js 20.x & 22.x)
375
+
376
+ ### 版本节奏
377
+
378
+ - `0.3.x`:插件系统、CI 模板、报告系统、VS Code 脚手架、CI 稳定化
379
+ - `0.4.x`:NestJS 控制器解析
380
+ - `0.5.x`:Drizzle ORM 适配器
381
+ - `0.6.x`:可视化 dashboard 与 Windows 下 Vitest 稳定性收口
382
+ - `0.7.x – 0.9.x`:Runtime 基础设施(Playwright 生成器、认证、日志驱动检测、规则引擎)
383
+ - `1.0.0`:全流程编排管道
384
+ - `1.1.0`:高级自愈(对话循环、可控修复器、自动修复 PR 生成)
385
+ - `1.2.0`:高级报告系统 + Sprint 0-3 迁移完成
386
+ - `1.3.0`:OpenCroc Studio M1 — Fastify 服务器、知识图谱 API、像素鳄鱼办公室前端
387
+
388
+ ### 发布验证
389
+
390
+ ```bash
391
+ npm run lint
392
+ npm run typecheck
393
+ npm test
394
+ npm view opencroc version dist-tags --json
395
+ ```
396
+
397
+ ## 文档
398
+
399
+ 访问 **[opencroc.com](https://opencroc.com)** 查看完整文档,或阅读:
400
+
401
+ - [Architecture Guide](docs/architecture.md)
402
+ - [Configuration Reference](docs/configuration.md)
403
+ - [Backend Instrumentation Guide](docs/backend-instrumentation.md)
404
+ - [AI Provider Setup](docs/ai-providers.md)
405
+ - [Self-Healing Guide](docs/self-healing.md)
406
+ - [Troubleshooting](docs/troubleshooting.md)
407
+
408
+ ## 贡献
409
+
410
+ 欢迎贡献代码与文档。请查看 [CONTRIBUTING.md](CONTRIBUTING.md)。
411
+
412
+ ## License
413
+
414
+ [MIT](LICENSE) © 2026 OpenCroc Contributors