# auto-test-platform

**Repository Path**: cyq0625/auto-test-platform

## Basic Information

- **Project Name**: auto-test-platform
- **Description**: 一个功能完整的自动化测试平台，支持 UI 测试、接口测试、App 自动化测试（开发中），采用前后端分离架构，支持 Docker 一键部署。
- **Primary Language**: Java
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2026-04-18
- **Last Updated**: 2026-04-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SKY 自动化测试平台

一个功能完整的自动化测试平台，支持 UI 测试、接口测试、App 自动化测试，采用前后端分离架构，支持 Docker 一键部署。

![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20MacOS-blue)
![Docker](https://img.shields.io/badge/docker-supported-blue)
![License](https://img.shields.io/badge/license-MIT-green)

## 快速开始（推荐）

### Docker 一键部署（推荐）

**1. 克隆项目**

```bash
git clone git clone https://gitee.com/liangzs30/auto-test-platform.git
cd sky-auto-test-platform
```

**2. 配置邮箱（可选）**

编辑 `docker-compose.yml`，修改邮件配置：

```yaml
environment:
  MAIL_HOST: smtp.qq.com
  MAIL_PORT: 465
  MAIL_USERNAME: your-email@qq.com
  MAIL_PASSWORD: your-auth-code
```

**3. 启动服务**

- **Windows 用户**: 双击运行 `docker/start.bat`
- **Linux/Mac 用户**: 
  ```bash
  chmod +x docker/start.sh
  ./docker/start.sh
  ```

**4. 访问平台**

打开浏览器访问：**http://localhost**

| 用户名 | 密码 | 角色 |
|--------|------|------|
| admin | Sky@123 | 管理员 |
| tester | Sky@123 | 普通用户 |

> **重要**: 首次登录后，建议立即修改默认密码！

详细部署文档请查看：[Docker 部署指南](docker/README.md)

---

## 系统截图

### 登录页面

![登录页面](docs/images/login.png)

### 首页

![首页](docs/images/index.png)

### 测试报告

![测试报告](docs/images/report.png)

---

## 功能特性

### 1. 项目管理
- 创建/编辑/删除项目
- 项目成员管理与权限控制
- 多环境配置（开发/测试/生产）
- 域名管理与应用管理
- 通知管理（邮件/企业微信/飞书）

### 2. 测试用例管理

**接口测试**
- 支持 HTTP/HTTPS 请求
- 多步骤编排与断言验证
- 参数化与数据驱动
- 响应提取与变量引用

**UI 测试**
- 关键字驱动测试
- 元素库管理
- 浏览器自动化（Chrome/Firefox/Edge）
- 截图与录屏

**App 测试**
- 支持 Android/iOS
- Appium 驱动
- 真机/模拟器测试

### 3. 关键字驱动
- 系统内置关键字（执行代码、打印日志等）
- 用户自定义关键字
- Python 代码扩展
- 关键字组合调用

### 4. 公共变量
- 项目级变量管理
- 支持多种数据类型（字符串/数字/布尔/JSON）
- 变量加密存储
- 跨用例共享

### 5. 测试任务
- 手动/定时执行
- 失败重试机制
- 分布式执行
- 执行机负载均衡

### 6. 测试报告
- 实时报告生成
- 详细步骤日志
- 截图/录屏回放
- 统计分析与趋势图

### 7. 执行机管理
- 执行机注册与心跳检测
- 状态监控
- 标签调度
- 支持分布式部署

---

## 技术架构

### 后端
- **框架**: Spring Boot 2.7.18
- **ORM**: MyBatis Plus
- **数据库**: MySQL 8.0
- **缓存**: Redis

### 前端
- **框架**: Vue 3 + Composition API
- **UI 库**: Element Plus
- **图表**: ECharts
- **构建**: Vite

### 执行机
- **语言**: Python 3.8+
- **UI 测试**: Playwright
- **App 测试**: Appium
- **接口测试**: Requests

---

## 项目结构

```
sky-auto-test-platform/
├── backend/                    # 后端 SpringBoot 项目
│   ├── pom.xml
│   └── src/main/
│       ├── java/com/test/platform/
│       │   ├── config/         # 配置类
│       │   ├── controller/     # 控制器
│       │   ├── service/        # 服务层
│       │   ├── mapper/         # DAO 层
│       │   ├── entity/         # 实体类
│       │   ├── dto/            # 数据传输对象
│       │   └── common/         # 通用类
│       └── resources/
│           ├── application.yml # 配置文件
│           └── db/schema.sql   # 数据库脚本
├── frontend/                   # 前端 Vue 项目
│   ├── package.json
│   ├── vite.config.js
│   └── src/
│       ├── api/                # API 接口
│       ├── views/              # 页面组件
│       ├── components/         # 公共组件
│       ├── router/             # 路由配置
│       └── utils/              # 工具类
├── executor/                   # Python 执行机
│   ├── executor_client.py      # 执行机客户端
│   └── requirements.txt        # Python 依赖
├── docker/                     # Docker 部署配置
│   ├── README.md               # Docker 部署文档
│   ├── start.sh                # Linux/Mac 启动脚本
│   ├── start.bat               # Windows 启动脚本
│   └── init-db/                # 数据库初始化脚本
├── docker-compose.yml          # Docker Compose 配置
└── README.md                   # 项目说明文档
```

---

## 本地开发部署（可选）

如需本地开发部署，请参考以下步骤：

### 1. 数据库初始化

```bash
mysql -u root -p < docker/init-db/01.init.sql
```

### 2. 启动后端

```bash
cd backend
mvn clean install
mvn spring-boot:run
```

访问：http://localhost:8080/api

### 3. 启动前端

```bash
cd frontend
npm install
npm run dev
```

访问：http://localhost:3000

### 4. 启动执行机

```bash
cd executor
pip install -r requirements.txt
playwright install chromium

# 配置执行机（在平台注册后获取 executor_code 和 executor_secret）
python executor_client.py
```

---

## 常用命令

### Docker 部署

```bash
# 查看服务状态
docker-compose ps

# 查看日志
docker-compose logs -f

# 停止服务
docker-compose down

# 重启服务
docker-compose restart

# 更新代码并重启
git pull
docker-compose down
docker-compose up -d

# 重置数据（慎用）
docker-compose down -v
docker-compose up -d
```

---

## 服务端口说明

| 服务 | 端口 | 说明 |
|------|------|------|
| frontend | 80 | 前端 Web 界面 |
| backend | 8080 | 后端 API 服务 |
| mysql | 3306 | MySQL 数据库 |
| executor | 8889 | 执行机服务 |

---

## 默认账号

| 用户名 | 密码 | 角色 |
|--------|------|------|
| admin | Sky@123 | 管理员 |
| tester | Sky@123 | 普通用户 |

> **安全提醒**: 首次登录后请立即修改默认密码！

---

## 文档

- [Docker 部署指南](docker/README.md) - Docker 一键部署详细文档
- [操作手册](http://localhost/guide) - 平台操作使用手册

---

## 常见问题

### 1. Docker 启动失败

检查 Docker 和 Docker Compose 是否正确安装：
```bash
docker --version
docker-compose --version
```

### 2. 数据库连接失败

确认 MySQL 容器已启动：
```bash
docker-compose ps
docker-compose logs mysql
```

### 3. 前端页面无法访问

检查前端容器日志：
```bash
docker-compose logs frontend
```

### 4. 执行机离线

- 确认执行机配置正确（executor_code 和 executor_secret）
- 检查网络连通性
- 查看执行机日志

---

## 开发计划

- [ ] 完整的用户认证和授权
- [ ] 测试任务调度器优化
- [ ] 报告详情和日志查看增强
- [ ] 用例导入导出功能
- [ ] Webhook 通知集成
- [ ] 更多内置关键字

---

## License

MIT License

---

## 技术支持

如有问题请提 Issue 或联系开发团队。