TBC/docs/QUICKSTART.md
jiawei.chen d05f4796a6 release: v1.1.0 - 安全加固与稳定性修复
🔒 Security:
- 修复 API Key 泄露,移除 platform_db.json 明文存储
- 限制 CORS 允许来源,不再全开放
- 添加路径校验防止目录穿越攻击
- Git 命令使用列表传参防止注入
- os.killpg 添加异常处理

🐛 Bug Fixes:
- 生产环境禁用 Flask debug 模式
- 修复 SSE 连接泄漏(useTaskLogs + ReposView)
- 修复 fetch 静默吞错误,添加 console.error 日志
- 补全 _run_ui_fix 函数签名
- 修复 .coveragerc source 配置
- _load_db 添加文件锁和 Queue maxsize
- SSE log_queues 使用 WeakValueDictionary

🔧 Refactor:
- BaseAPI → APIClient 统一命名
- 删除后端死代码和重复 import
- 删除 business_backup 备份代码
- 删除 conftest_metrics 死代码

📝 Docs:
- 新增 CHANGELOG.md 和 CHANGELIST.md
- 更新 QUICKSTART.md 添加安全注意事项
- 更新 CONFIG.md 添加安全加固和性能优化
2026-07-15 16:51:08 +08:00

132 lines
2.9 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# TestAgent 快速开始
## 前置条件
- Python 3.9+
- Node.js 18+ (pnpm)
- Git
## 1. 环境配置
```bash
# 创建 .env 文件
cat > .env << 'EOF'
OPENAI_API_KEY=sk-xxx
OPENAI_BASE_URL=https://llmgateway.d-robotics.cc/v1
TEST_USERNAME=your_username
TEST_PASSWORD=your_password
EOF
# 安装 Python 依赖
pip install -r requirements.txt
```
## 2. 前端构建
```bash
cd frontend
pnpm install
pnpm build
cd ..
```
## 3. 启动 Web 平台
```bash
python3 -m backend
# 访问 http://localhost:5002
```
## 4. CLI 命令行
```bash
# 扫描仓库并生成测试
python3 main.py run -r https://github.com/user/repo.git
# 精确回归(只对变更代码生成测试)
python3 main.py diff -r https://github.com/user/repo.git -a HEAD~3
# 仅 DDD 领域分析(不调用 LLM)
python3 main.py analyze -r https://github.com/user/repo.git
```
## 5. Web 平台页面
| 页面 | 路由 | 功能 |
|------|------|------|
| 控制台 | `/dashboard` | 统计概览 + 快速操作入口 |
| 仓库管理 | `/repos` | 添加 Git 仓库 → 扫描/分析/生成/回归 |
| 任务管理 | `/tasks` | 实时 SSE 日志流 + 停止/删除 |
| 测试报告 | `/reports` | 报告列表 + 详情 + 日志回放 |
| 已有用例 | `/existing` | 运行 D-Cloud 903 用例 + Robogo 13 场景 |
## 6. 仓库管理使用流程
```
1. 输入 Git 仓库 URL + 分支
2. 点击「扫描」→ 自动 clone + AST 分析 + DDD 建模
3. 展开仓库卡片 → 点击「生成测试」→ LLM 自动生成测试
4. 或点击「全流程」→ 一键完成扫描+分析+生成
```
## 7. 已有用例使用流程
### D-Cloud
```
1. 选择模块(如 E2E 全量测试)
2. 选择具体测试用例
3. 点击运行
```
### Robogo
```
1. 选择产品(Robogo 全量巡检 / 数据闭环)
2. 点击「配置并启动」
3. 填写产品/环境/范围/账号/密码
4. 点击「启动巡检」
```
## 8. API Key 配置
API Key 已固定在 `.env` 文件中,页面无需手动输入。
```bash
# .env
OPENAI_API_KEY=sk-your-api-key-here
OPENAI_BASE_URL=https://ai-api.d-robotics.cc/v1
```
## 9. 安全注意事项
### API Key 管理
- **切勿**将 API Key 硬编码在代码中或提交到 Git 仓库
- 使用 `.env` 文件管理敏感信息,并确保 `.env` 在 `.gitignore` 中
- 生产环境建议通过环境变量注入,而非文件
### 生产环境部署
- 确保 Flask `debug=False`(已在 `backend/__main__.py` 中设置)
- 配置适当的 CORS 白名单,不要开放 `origins='*'`
- 使用 HTTPS 保护 API 通信
- 定期清理 `platform_db.json` 中的敏感数据
## 10. 常见问题
### SSE 日志不显示
- 检查浏览器控制台是否有网络错误
- 确保后端服务正常运行
- 刷新页面后重试
### 前端构建失败
```bash
cd frontend
rm -rf node_modules pnpm-lock.yaml
pnpm install
pnpm build
```
### 数据库文件损坏
```bash
# 备份后重建
mv platform_db.json platform_db.json.bak
# 重启后端服务会自动创建新的数据库文件
```