From 0d30ed9a0fcabad39167865a944d150463386b5a Mon Sep 17 00:00:00 2001 From: lanyuanxiaoyao Date: Thu, 7 May 2026 12:43:08 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E6=96=B0=E5=A2=9E=E5=BC=80=E5=8F=91=20?= =?UTF-8?q?CI=20=E6=B5=81=E7=A8=8B=EF=BC=8C=E9=87=8D=E6=9E=84=20test.yml?= =?UTF-8?q?=20=E6=94=AF=E6=8C=81=E5=88=86=E5=B1=82=E6=B5=8B=E8=AF=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 新增 ci.yml，在 push（dev/main）和 PR 时触发快速检查（lint + 全量测试） 重构 test.yml，新增 full 参数控制是否运行 MySQL 和 E2E 测试 release.yml 调用 test.yml 时传 full: true，行为与重构前一致 同步更新 ci-test-gate spec --- .github/workflows/ci.yml | 14 ++++ .github/workflows/release.yml | 2 + .github/workflows/test.yml | 71 +++++++++++++--- openspec/specs/ci-test-gate/spec.md | 123 +++++++++++++++++++++------- 4 files changed, 171 insertions(+), 39 deletions(-) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..b33dd48 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,14 @@ +name: CI + +on: + push: + branches: [dev, main] + pull_request: + +permissions: + contents: read + +jobs: + check: + name: Check + uses: ./.github/workflows/test.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 069e3c1..efc140b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -41,6 +41,8 @@ jobs: name: Test Gate needs: prepare uses: ./.github/workflows/test.yml + with: + full: true build-web: name: Build Web Asset diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index acb3cde..6b19c5d 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -2,13 +2,48 @@ name: Test (Full) on: workflow_call: + inputs: + full: + description: "Run full test suite including MySQL and E2E" + required: false + default: false + type: boolean permissions: contents: read jobs: - test-gate: - name: Test Gate + check: + name: Check + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v5 + with: + lfs: true + + - name: Setup Go + uses: actions/setup-go@v6 + with: + go-version-file: go.work + cache-dependency-path: | + backend/go.sum + versionctl/go.sum + + - name: Setup Bun + uses: oven-sh/setup-bun@v2 + + - name: Lint + run: make lint + + - name: Test + run: make test + + mysql: + name: MySQL Tests + if: inputs.full + needs: check runs-on: ubuntu-latest services: @@ -41,18 +76,32 @@ jobs: backend/go.sum versionctl/go.sum - - name: Setup Bun - uses: oven-sh/setup-bun@v2 - - - name: Lint - run: make lint - - - name: Test - run: make test - - name: MySQL tests run: cd backend && go test -tags=mysql ./tests/mysql/... -v -count=1 + e2e: + name: E2E Tests + if: inputs.full + needs: check + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v5 + with: + lfs: true + + - name: Setup Go + uses: actions/setup-go@v6 + with: + go-version-file: go.work + cache-dependency-path: | + backend/go.sum + versionctl/go.sum + + - name: Setup Bun + uses: oven-sh/setup-bun@v2 + - name: Install Playwright browsers run: cd frontend && bunx playwright install --with-deps chromium diff --git a/openspec/specs/ci-test-gate/spec.md b/openspec/specs/ci-test-gate/spec.md index a5c4eca..7555ee4 100644 --- a/openspec/specs/ci-test-gate/spec.md +++ b/openspec/specs/ci-test-gate/spec.md @@ -8,57 +8,124 @@ ### Requirement: 独立可复用测试 workflow -系统 SHALL 提供独立的全流程测试 workflow（`test.yml`），使用 `workflow_call` 触发器，可在 release 和其他 CI 场景中被引用。 +系统 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 引用 +#### Scenario: 被其他 workflow 引用（快速模式） -- **WHEN** 其他 workflow 的 job 通过 `uses: ./.github/workflows/test.yml` 引用此 workflow -- **THEN** test workflow SHALL 正常执行所有测试步骤 -- **THEN** 引用方可通过 job 的 `needs` 依赖等待测试结果 +- **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 在单个 ubuntu runner 上按顺序执行完整的测试链：lint → 默认测试 → MySQL 测试 → E2E 测试。 +测试 workflow SHALL 将测试步骤拆分为 `check`、`mysql`、`e2e` 三个独立 job，通过 `full` 参数和 `needs` 依赖控制执行。 -#### Scenario: Lint 步骤 +#### Scenario: check job（始终执行） -- **WHEN** 测试 workflow 执行 lint 步骤 -- **THEN** SHALL 执行 `make lint` -- **THEN** lint SHALL 覆盖 backend golangci-lint、frontend typecheck + eslint + prettier、versionctl golangci-lint -- **THEN** lint 失败时 SHALL 阻止后续步骤执行 +- **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: 默认测试步骤 +#### Scenario: mysql job（仅 full=true） -- **WHEN** 测试 workflow 执行默认测试步骤 -- **THEN** SHALL 执行 `make test` -- **THEN** SHALL 覆盖 backend 核心测试、frontend Vitest 单元/组件测试、desktop 测试和 versionctl 测试 -- **THEN** 默认测试 SHALL NOT 覆盖 MySQL 专项测试或 frontend E2E 测试 -- **THEN** 测试失败时 SHALL 阻止后续步骤执行 - -#### Scenario: MySQL 测试步骤 - -- **WHEN** 测试 workflow 执行 MySQL 测试步骤 +- **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` -- **THEN** MySQL 测试 SHALL 使用默认连接配置（localhost:13306），与 `testhelper.go` 中的默认值匹配 -- **THEN** 测试失败时 SHALL 阻止后续步骤执行 -#### Scenario: E2E 测试步骤 +#### Scenario: mysql job 跳过 -- **WHEN** 测试 workflow 执行 E2E 测试步骤 -- **THEN** SHALL 先安装 Playwright Chromium 浏览器：`cd frontend && bunx playwright install --with-deps chromium` +- **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** E2E 测试 SHALL 自动启动 Go 后端（端口 19026）和 Vite dev server（端口 5173） - **THEN** Playwright SHALL 使用 CI 模式（`forbidOnly: true`、`retries: 2`） -- **THEN** 测试失败时 SHALL 返回非零退出码 + +#### 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 工具链依赖