TBC/README.md

228 lines
7.6 KiB
Markdown
Raw 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.

# AutoFlow — D-Robotics Unified Automation Testing Platform
AutoFlow 是 D-Robotics(地瓜机器人)的统一自动化测试平台,整合了两大测试能力:
| 来源 | 产品 | 描述 |
|------|------|------|
| **data-loop-automation** | D-Cloud (视觉感知工作台) | 16 个业务模块的 E2E/API/UI/Flow 测试,819+ 个测试用例(含 40 条 E2E) |
| **test** | Robogo / 数据闭环 | 全链路 UI 巡检 + 飞书机器人 + 定时调度 |
## 技术栈
| 层级 | 技术 | 用途 |
|------|------|------|
| **后端** | Python 3.10+ + Flask | REST API、任务调度、SSE 实时日志 |
| **测试框架** | Pytest + Playwright | UI 自动化、API 测试、E2E 测试 |
| **前端** | React 19 + Vite + TailwindCSS 4 | 仪表盘、任务管理、报告中心、E2E 测试面板 |
| **消息** | Feishu Lark Bot | 飞书机器人命令触发 & 告警推送 |
| **容器** | Docker + Docker Compose | 一键部署 |
## 快速开始
> 完整部署指南:[DEPLOY.md](DEPLOY.md)
### 环境要求
- Python 3.10 – 3.12
- Node.js >= 18
- pnpm (推荐) 或 npm
### 安装
```bash
# 1. 进入项目目录
cd unified-test-platform
# 2. 配置环境变量
cp .env.example .env
# 编辑 .env 填入实际值
# 3. 安装 Python 依赖
python3.11 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
# 4. 安装 Playwright 浏览器
playwright install chromium
# 5. 构建前端
cd frontend
pnpm install
pnpm build
cd ..
```
### 启动
```bash
# 方式一:直接启动 Flask 后端(含前端)
python -m backend.app
# 方式二:开发模式(前端热重载)
# 终端 1: 启动后端
python -m backend.app
# 终端 2: 启动前端开发服务器
cd frontend && pnpm dev
# 访问 http://localhost:5173 (带 API 代理)
# 方式三:Docker
docker compose build
docker compose up -d
```
访问 `http://127.0.0.1:5001`
### 运行测试
```bash
# 运行全部 D-Cloud 测试(856 个)
pytest tests/ -v
# 运行全部 E2E 测试(40 个)
pytest tests/ -m e2e -v
# 运行特定模块
pytest tests/data_generation/ -v
# 按 marker 运行
pytest -m smoke -v
pytest -m "api and data_space" -v
# 运行单个测试
pytest "tests/data_generation/tests/test_data_generation_full_pipeline.py::TestDataGenerationPipeline::test_full_pipeline_create_stop_delete" -v
# 运行 Robogo 巡检场景
python scenarios/run_all.py
# 启动飞书机器人
python bot/bot.py
# 生成覆盖率报告
pytest --cov=tests --cov=scenarios --cov-report=html
```
## 项目结构
```
unified-test-platform/
├── backend/ # Flask 后端 (API + 调度器 + SSE)
│ └── app.py # 主应用入口
├── frontend/ # React + Vite 前端
│ └── src/
│ ├── App.tsx
│ └── components/
│ ├── layout/ # PlatformSwitcher, Sidebar, navConfig
│ ├── dashboard/ # DCloudDashboard, RobogoDashboard
│ ├── tasks/ # 任务管理视图
│ ├── reports/ # 报告中心视图
│ └── test/ # TestModuleView, E2ETestView
├── tests/ # D-Cloud E2E 测试 (Pytest)
│ ├── base/ # POM 基类 + 10 个 Mixins
│ ├── utils/ # API 客户端、断言、Waiter
│ └── */ # 16 个业务测试模块
├── scenarios/ # Robogo 场景脚本
├── framework/ # 核心自动化框架
│ ├── core/ # BasePage, BaseUI, BaseAPI
│ ├── business/ # 页面对象 & 服务层
│ └── config/ # 场景级配置
├── bot/ # 飞书机器人
├── config/ # 统一配置管理
├── specs/ # 测试规格文档
├── swagger/ # API 文档
├── test_cases/ # 测试用例清单
├── docs/ # 文档中心
└── scripts/ # 工具脚本
```
## 前端架构:二合一平台切换
平台通过 **React Router** 实现单页应用内两个产品视图的切换:
| 路由 | 平台 | 功能 |
|------|------|------|
| `/dcloud` | D-Cloud (ToB) | 16 个模块卡片仪表盘,点击进入模块测试 |
| `/dcloud/e2e` | E2E 全量测试 | API 全链路(8条) + UI 点击(3条) + 分步测试(3个) |
| `/dcloud/:module` | 模块测试页 | 一键运行 pytest,SSE 实时日志流 |
| `/robogo` | Robogo (ToC) | 全链路巡检仪表盘,趋势图、健康度分析 |
| `/robogo/tasks` | 任务管理 | 创建/调度/停止任务,SSE 实时日志 |
| `/robogo/reports` | 报告中心 | 历史报告列表 + 详情 + 截图 |
顶部 **PlatformSwitcher** 组件实现 D-Cloud / Robogo 一键切换,侧边栏根据当前平台显示不同导航。
### E2E 测试面板
`/dcloud/e2e` 页面包含三个测试区域:
**API 全链路(8条)** — 每条可单独运行,精确指定 pytest 测试路径:
- 任务全链路、任务结果、任务评测、LORA、系统提示词、工作流、数据空间、跨模块组合
**UI 点击测试(3条)** — 浏览器可见操作(`headless=false`),每条可单独运行:
- 任务创建、数据空间、跨模块导航
**分步测试(3个)** — 创建→去平台验证→清理,每步独立执行:
- 系统提示词、数据生成任务、数据空间
## D-Cloud 测试模块
| 模块 | Pytest Marker | 描述 |
|------|-------------|------|
| e2e | `e2e` | 跨模块端到端全链路测试(40 个用例) |
| workbench | `workbench` | 核心工作流 |
| data_generation | `data_generation` | 数据生成管线 |
| data_space | `data_space or dataspace` | 数据空间 |
| data_set | `dataset` | 数据集管理 |
| model_workshop | `model_workshop` | 模型训练与部署 |
| model_square | `model_square` | 模型广场 |
| monitor | `monitor` | 实时监控 |
| image_manage | `image_manage` | 图像管理 |
| mirror_center | `mirror_center` | 镜像中心 |
| cloud_desktop | `cloud_desktop` | 云端桌面 |
| dev_machine | `dev_machine` | 开发机 |
| device_manage | `device_manage` | 设备管理 |
| material_library | `material_library` | 素材库 |
| prompt_library | `prompt_library` | 提示词库 |
| lora_finetune | `lora_finetune` | LoRA 微调 |
## API 端点
| Method | Endpoint | 说明 |
|--------|----------|------|
| GET | `/api/health` | 健康检查 |
| GET | `/api/products` | 产品列表 |
| GET | `/api/dcloud-modules` | D-Cloud 模块列表(16 个) |
| GET/POST | `/api/tasks` | 任务列表 / 创建任务 |
| DELETE | `/api/tasks/<id>` | 删除任务 |
| POST | `/api/tasks/<id>/stop` | 停止任务 |
| GET | `/api/tasks/<id>/logs` | SSE 日志流 |
| GET | `/api/reports` | 报告列表 |
| GET | `/api/reports/<id>` | 报告详情 |
| GET | `/api/dashboard/stats` | 仪表盘统计 |
| GET | `/api/run-e2e-step` | E2E 分步测试(SSE 流) |
## 任务类型
| 类型 | 说明 | 执行方式 |
|------|------|---------|
| `scenario` | Robogo/数据闭环场景 | `python scenarios/run_all.py` |
| `dcloud_module` | 单个 D-Cloud 模块 | `pytest tests/<module>/ -v` |
| `dcloud_module` + `test` | 指定单个测试 | `pytest <test_path> -v` |
| `dcloud_e2e` | 全部 E2E 测试 | `pytest tests/ -m e2e -v` |
| `dcloud_all` | 全部 D-Cloud 测试 | `pytest tests/ -v` |
支持参数:`env`、`scope`、`headless`、`run_count`、`retry_on_fail`、`schedule_type`。
## 测试规模
| 维度 | 数量 |
|------|------|
| 测试文件 | 68 个 |
| 收集到的测试 | 856 个(含参数化) |
| E2E 测试 | 40 个(`-m e2e`) |
| 业务模块 | 16 个 |
## License
Internal use — D-Robotics
---
**AutoFlow v2.0** — 从双平台到统一平台