chore: 合并 dev-ci-optimize 至 master
This commit is contained in:
151
openspec/specs/ci-test-gate/spec.md
Normal file
151
openspec/specs/ci-test-gate/spec.md
Normal file
@@ -0,0 +1,151 @@
|
||||
# CI Test Gate
|
||||
|
||||
## Purpose
|
||||
|
||||
定义 CI 全流程测试门禁,作为 release 和未来其他 CI 流程的前序质量检查,覆盖 lint、默认测试、MySQL 测试和 E2E 测试。
|
||||
|
||||
## Requirements
|
||||
|
||||
### Requirement: 独立可复用测试 workflow
|
||||
|
||||
系统 SHALL 提供独立的全流程测试 workflow(`test.yml`),使用 `workflow_call` 触发器,通过 `full` 布尔参数控制测试分层执行。
|
||||
|
||||
#### Scenario: workflow_call 触发器
|
||||
|
||||
- **WHEN** 查看 `.github/workflows/test.yml` 的触发器配置
|
||||
- **THEN** SHALL 使用 `on: workflow_call` 触发器
|
||||
- **THEN** SHALL 声明 `inputs.full` 布尔参数,默认值为 `false`
|
||||
- **THEN** SHALL NOT 使用 `push`、`pull_request` 等其他触发器
|
||||
|
||||
#### Scenario: 被其他 workflow 引用(快速模式)
|
||||
|
||||
- **WHEN** 其他 workflow 的 job 通过 `uses: ./.github/workflows/test.yml` 引用此 workflow 且未传 `full` 或传 `full: false`
|
||||
- **THEN** test workflow SHALL 仅执行 `check` job(lint + 全量测试)
|
||||
- **THEN** test workflow SHALL NOT 执行 MySQL 测试和 E2E 测试
|
||||
|
||||
#### Scenario: 被其他 workflow 引用(完整模式)
|
||||
|
||||
- **WHEN** 其他 workflow 的 job 引用此 workflow 且传 `full: true`
|
||||
- **THEN** test workflow SHALL 执行 `check`、`mysql`、`e2e` 三个 job
|
||||
- **THEN** `mysql` 和 `e2e` job SHALL 在 `check` job 成功后并行执行
|
||||
|
||||
### Requirement: 全流程测试步骤编排
|
||||
|
||||
测试 workflow SHALL 将测试步骤拆分为 `check`、`mysql`、`e2e` 三个独立 job,通过 `full` 参数和 `needs` 依赖控制执行。
|
||||
|
||||
#### Scenario: check job(始终执行)
|
||||
|
||||
- **WHEN** 测试 workflow 被调用(无论 `full` 值)
|
||||
- **THEN** `check` job SHALL 始终执行
|
||||
- **THEN** SHALL 在 `check` job 内按顺序执行:checkout(含 LFS)→ setup Go → setup Bun → `make lint` → `make test`
|
||||
- **THEN** `make lint` SHALL 覆盖 backend golangci-lint、frontend typecheck + eslint + prettier、versionctl golangci-lint
|
||||
- **THEN** `make test` SHALL 覆盖 backend 核心测试、frontend Vitest 单元/组件测试、desktop 测试和 versionctl 测试
|
||||
- **THEN** `make test` SHALL NOT 覆盖 MySQL 专项测试或 frontend E2E 测试
|
||||
- **THEN** lint 或测试失败时 SHALL 阻止后续步骤执行
|
||||
|
||||
#### Scenario: mysql job(仅 full=true)
|
||||
|
||||
- **WHEN** 测试 workflow 被调用且 `full=true`,且 `check` job 成功
|
||||
- **THEN** `mysql` job SHALL 执行
|
||||
- **THEN** SHALL checkout 仓库代码
|
||||
- **THEN** SHALL 安装 Go 工具链(使用 `go.work` 文件指定版本,缓存覆盖 `backend/go.sum` 和 `versionctl/go.sum`)
|
||||
- **THEN** SHALL 使用 GitHub Actions `services:` 声明 MySQL 8.0 容器
|
||||
- **THEN** MySQL 容器 SHALL 映射端口 `13306:3306`
|
||||
- **THEN** MySQL 容器 SHALL 配置 `MYSQL_DATABASE=nex_test`、`MYSQL_USER=nex_test`、`MYSQL_PASSWORD=testpass`
|
||||
- **THEN** SHALL 执行 `cd backend && go test -tags=mysql ./tests/mysql/... -v -count=1`
|
||||
|
||||
#### Scenario: mysql job 跳过
|
||||
|
||||
- **WHEN** 测试 workflow 被调用且 `full=false`
|
||||
- **THEN** `mysql` job SHALL NOT 执行
|
||||
|
||||
#### Scenario: e2e job(仅 full=true)
|
||||
|
||||
- **WHEN** 测试 workflow 被调用且 `full=true`,且 `check` job 成功
|
||||
- **THEN** `e2e` job SHALL 执行
|
||||
- **THEN** SHALL checkout 仓库代码(含 LFS)
|
||||
- **THEN** SHALL 安装 Go 工具链(使用 `go.work` 文件指定版本,缓存覆盖 `backend/go.sum` 和 `versionctl/go.sum`)
|
||||
- **THEN** SHALL 安装 Bun 运行时
|
||||
- **THEN** SHALL 安装 Playwright Chromium 浏览器:`cd frontend && bunx playwright install --with-deps chromium`
|
||||
- **THEN** SHALL 执行 `cd frontend && bun run test:e2e`
|
||||
- **THEN** Playwright SHALL 使用 CI 模式(`forbidOnly: true`、`retries: 2`)
|
||||
|
||||
#### Scenario: e2e job 跳过
|
||||
|
||||
- **WHEN** 测试 workflow 被调用且 `full=false`
|
||||
- **THEN** `e2e` job SHALL NOT 执行
|
||||
|
||||
#### Scenario: mysql 和 e2e 并行执行
|
||||
|
||||
- **WHEN** `full=true` 且 `check` job 成功
|
||||
- **THEN** `mysql` job 和 `e2e` job SHALL 并行执行
|
||||
- **THEN** 两个 job 之间 SHALL NOT 有 `needs` 依赖关系
|
||||
|
||||
#### Scenario: check 失败阻止后续 job
|
||||
|
||||
- **WHEN** `check` job 中 lint 或测试任一失败
|
||||
- **THEN** `mysql` 和 `e2e` job SHALL NOT 执行
|
||||
|
||||
### Requirement: 开发 CI 自动触发
|
||||
|
||||
系统 SHALL 在 `push`(`dev` 和 `main` 分支)和所有 `pull_request` 事件时自动触发快速质量检查。
|
||||
|
||||
#### Scenario: push 到 dev 分支触发 CI
|
||||
|
||||
- **WHEN** 代码推送到 `dev` 分支
|
||||
- **THEN** SHALL 触发 CI workflow
|
||||
- **THEN** CI workflow SHALL 调用 `test.yml`(`full=false`)
|
||||
- **THEN** SHALL 仅执行 lint 和全量单元/集成测试
|
||||
|
||||
#### Scenario: push 到 main 分支触发 CI
|
||||
|
||||
- **WHEN** 代码推送到 `main` 分支
|
||||
- **THEN** SHALL 触发 CI workflow
|
||||
- **THEN** CI workflow SHALL 调用 `test.yml`(`full=false`)
|
||||
|
||||
#### Scenario: Pull Request 触发 CI
|
||||
|
||||
- **WHEN** 创建或更新 Pull Request
|
||||
- **THEN** SHALL 触发 CI workflow
|
||||
- **THEN** CI workflow SHALL 调用 `test.yml`(`full=false`)
|
||||
|
||||
#### Scenario: CI workflow 极简设计
|
||||
|
||||
- **WHEN** 查看 `.github/workflows/ci.yml`
|
||||
- **THEN** SHALL 仅包含触发器配置和一个 job 引用 `test.yml`
|
||||
- **THEN** SHALL NOT 定义任何直接执行的步骤
|
||||
- **THEN** SHALL NOT 传递 `full: true`
|
||||
|
||||
### Requirement: 发布流水线使用完整测试模式
|
||||
|
||||
`release.yml` 调用 `test.yml` 时 SHALL 显式传递 `full: true`,确保发布流程执行完整测试。
|
||||
|
||||
#### Scenario: release 调用 test.yml 传 full: true
|
||||
|
||||
- **WHEN** 发布流水线的 `test-gate` job 引用 `test.yml`
|
||||
- **THEN** SHALL 传递 `with: full: true`
|
||||
- **THEN** 发布流水线 SHALL 执行 `check`、`mysql`、`e2e` 三个 job
|
||||
- **THEN** 测试行为 SHALL 与重构前一致
|
||||
|
||||
### Requirement: 测试 workflow 工具链依赖
|
||||
|
||||
测试 workflow SHALL 在单个 ubuntu runner 上准备完整的工具链环境。
|
||||
|
||||
#### Scenario: 工具链安装
|
||||
|
||||
- **WHEN** 测试 workflow 开始执行
|
||||
- **THEN** SHALL checkout 仓库代码并拉取 Git LFS 文件
|
||||
- **THEN** SHALL 安装 Go 工具链(使用 `go.work` 文件指定版本)
|
||||
- **THEN** SHALL 安装 Bun 运行时
|
||||
- **THEN** Go 模块缓存 SHALL 覆盖 `backend/go.sum` 和 `versionctl/go.sum`
|
||||
|
||||
### Requirement: 测试 workflow 资源隔离
|
||||
|
||||
测试 workflow 中的各测试步骤 SHALL 使用隔离的资源,不干扰主环境。
|
||||
|
||||
#### Scenario: E2E 临时资源隔离
|
||||
|
||||
- **WHEN** E2E 测试运行
|
||||
- **THEN** Go 后端 SHALL 使用临时目录的独立数据库文件(`/tmp/nex-e2e/test.db`)
|
||||
- **THEN** Go 后端 SHALL 使用临时目录的日志目录(`/tmp/nex-e2e/log/`)
|
||||
- **THEN** 临时资源 SHALL 在测试结束后自动清理
|
||||
@@ -8,12 +8,12 @@
|
||||
|
||||
### Requirement: Tag 驱动发布流水线
|
||||
|
||||
系统 SHALL 仅在符合 `vX.Y.Z` 格式的 Git tag 上触发发布流水线,普通分支 push SHALL NOT 创建发布。发布流水线 SHALL 使用 `./versionctl` 而非 `./backend/cmd/versionctl` 调用版本管理工具。
|
||||
系统 SHALL 仅在符合 `vX.Y.Z` 格式的 Git tag 上触发发布流水线,普通分支 push SHALL NOT 创建发布。发布流水线 SHALL 使用 `./versionctl` 而非 `./backend/cmd/versionctl` 调用版本管理工具。发布流水线 SHALL 在进入构建阶段前完成全流程测试验证,测试未通过 SHALL NOT 执行任何构建。
|
||||
|
||||
#### Scenario: 有效发布 tag
|
||||
|
||||
- **WHEN** 仓库收到 `v1.2.3` tag push
|
||||
- **THEN** 发布流水线 SHALL 启动版本校验、构建和 Release 组装步骤
|
||||
- **THEN** 发布流水线 SHALL 启动版本校验、全流程测试、构建和 Release 组装步骤
|
||||
- **AND** 版本校验步骤 SHALL 使用 `go run ./versionctl print` 和 `go run ./versionctl verify-tag` 获取并验证版本
|
||||
|
||||
#### Scenario: 普通分支推送
|
||||
@@ -21,6 +21,19 @@
|
||||
- **WHEN** 仓库收到非 tag 的分支 push
|
||||
- **THEN** 系统 SHALL NOT 创建 GitHub Release
|
||||
|
||||
#### Scenario: 测试门禁阻止构建
|
||||
|
||||
- **WHEN** 发布流水线中全流程测试步骤(lint、默认测试、MySQL 测试、E2E 测试)任一失败
|
||||
- **THEN** 发布流水线 SHALL NOT 执行任何平台构建
|
||||
- **THEN** 发布流水线 SHALL NOT 创建 Draft Release
|
||||
- **AND** 系统 SHALL NOT 产生可直接公开的成功发布结果
|
||||
|
||||
#### Scenario: 测试通过后并行构建
|
||||
|
||||
- **WHEN** 全流程测试全部通过
|
||||
- **THEN** web、Linux、Windows、macOS 构建 SHALL 并行执行
|
||||
- **AND** 所有构建 job SHALL 依赖 `prepare` 和 `test-gate`
|
||||
|
||||
### Requirement: 发布流水线 Go 模块缓存覆盖
|
||||
|
||||
发布流水线 SHALL 在所有 Go module 的 go.sum 文件存在时正确设置 Go 模块缓存路径,确保新增的 `versionctl` module 依赖也被缓存。
|
||||
@@ -198,7 +211,7 @@
|
||||
|
||||
#### Scenario: 发布成功时创建 Draft Release
|
||||
|
||||
- **WHEN** 版本校验通过且 server、web、desktop 的全部目标发布资产构建完成
|
||||
- **WHEN** 版本校验通过、全流程测试通过且 server、web、desktop 的全部目标发布资产构建完成
|
||||
- **THEN** 系统 SHALL 创建或更新与该 tag 对应的 GitHub Draft Release
|
||||
- **AND** 系统 SHALL 上传 server、web 与 desktop 的全部发布资产
|
||||
- **AND** 系统 SHALL 上传 `SHA256SUMS`
|
||||
@@ -211,7 +224,7 @@
|
||||
|
||||
#### Scenario: 构建失败时阻止完成发布
|
||||
|
||||
- **WHEN** 任一目标发布资产构建失败、打包失败、校验失败、artifact 上传为空或版本校验失败
|
||||
- **WHEN** 任一目标发布资产构建失败、打包失败、校验失败、artifact 上传为空、版本校验失败或全流程测试失败
|
||||
- **THEN** 发布流水线 SHALL 失败
|
||||
- **AND** 系统 SHALL NOT 产生可直接公开的成功发布结果
|
||||
|
||||
|
||||
Reference in New Issue
Block a user