Repository navigation
502 lines (442 loc) · 20 KB
/
Copy pathdeploy-test.yml
File metadata and controls
502 lines (442 loc) · 20 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# ============================================================
# THVote 测试环境 CI/CD 工作流
#
# 触发条件:
# - 推送到 main / zfq_dev 分支
# - PR 合并到上述分支
# - 手动触发 (workflow_dispatch)
#
# 本工作流仅负责后端,不会触发前端构建。
# 前端由 Touhou-Vote 仓库独立构建部署。
# ============================================================
name: Test & Deploy Backend
on:
push:
branches:
- main
- zfq_dev
paths:
- 'src/**'
- 'alembic/**' # 迁移改动必须触发部署(deploy 阶段会 alembic upgrade head)
- 'pyproject.toml'
- 'Dockerfile'
- 'scripts/**'
- 'docker/**'
- '.github/workflows/deploy-test.yml'
pull_request:
branches:
- main
- zfq_dev
workflow_dispatch:
inputs:
skip_tests:
description: '跳过测试'
required: false
default: 'false'
type: boolean
deploy_prod:
description: '同时部署到生产环境'
required: false
default: 'false'
type: boolean
env:
REGISTRY: ghcr.io
IMAGE_NAME: patchyvideo/thvote
jobs:
# ==================== 代码检查 ====================
lint:
name: 代码检查
runs-on: ubuntu-latest
steps:
- name: 检出代码
uses: actions/checkout@v4
- name: 设置 Python
uses: actions/setup-python@v5
with:
# 固定 3.12:与 Dockerfile 一致。setup-python 读 pyproject 的
# requires-python>=3.12 会选最新稳定版(曾漂到 3.14/3.15),
# 而 redisvl 等依赖并不总有对应 wheel。
python-version: '3.12'
- name: 安装工具
run: |
python -m pip install --upgrade pip==26.2.2
pip install flake8 black isort mypy
pip install -e .
- name: 代码风格检查
run: flake8 src/ --max-line-length=88
# ==================== 运行测试 ====================
test:
name: 运行测试
runs-on: ubuntu-latest
needs: lint
if: github.event_name != 'workflow_dispatch' || inputs.skip_tests != 'true'
services:
postgres:
image: postgres:15-alpine
env:
POSTGRES_USER: test_user
POSTGRES_PASSWORD: test_pass
POSTGRES_DB: thvote_test
ports:
- 5432:5432
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
redis:
image: redis:7-alpine
ports:
- 6379:6379
options: >-
--health-cmd "redis-cli ping"
--health-interval 10s
--health-timeout 5s
--health-retries 5
steps:
- name: 检出代码
uses: actions/checkout@v4
- name: 设置 Python
uses: actions/setup-python@v5
with:
# 固定 3.12:与 Dockerfile 一致。setup-python 读 pyproject 的
# requires-python>=3.12 会选最新稳定版(曾漂到 3.14/3.15),
# 而 redisvl 等依赖并不总有对应 wheel。
python-version: '3.12'
- name: 安装依赖
run: |
python -m pip install --upgrade pip==26.2.2
pip install -e '.[test]'
pip install pytest pytest-asyncio httpx
python -c "import certifi; assert tuple(map(int, certifi.__version__.split('.')[:2])) >= (2026, 10), certifi.__version__"
- name: 检查测试目录
id: check_tests
run: |
if [ -d "tests/" ] && [ -n "$(ls -A tests/ 2>/dev/null)" ]; then
echo "exist=true" >> $GITHUB_OUTPUT
else
echo "exist=false" >> $GITHUB_OUTPUT
fi
- name: 应用 Alembic 迁移(针对真实 Postgres,作为迁移脚本的烟雾测试)
if: steps.check_tests.outputs.exist == 'true'
env:
DATABASE_URL: postgresql+asyncpg://test_user:test_pass@localhost:5432/thvote_test
REDIS_URL: redis://localhost:6379/0
JWT_SECRET_KEY: test-secret-key
VOTE_START_ISO: '2026-01-01T00:00:00+08:00'
VOTE_END_ISO: '2026-12-31T23:59:59+08:00'
run: |
alembic upgrade head
alembic current
- name: 运行测试
if: steps.check_tests.outputs.exist == 'true'
env:
DATABASE_URL: postgresql+asyncpg://test_user:test_pass@localhost:5432/thvote_test
REDIS_URL: redis://localhost:6379/0
JWT_SECRET_KEY: test-secret-key
VOTE_START_ISO: '2026-01-01T00:00:00+08:00'
VOTE_END_ISO: '2026-12-31T23:59:59+08:00'
run: pytest --cov=src --cov-report=xml tests/
- name: 上传覆盖率
if: steps.check_tests.outputs.exist == 'true'
uses: codecov/codecov-action@v4
with:
files: ./coverage.xml
fail_ci_if_error: false
- name: 无测试文件
if: steps.check_tests.outputs.exist == 'false'
run: echo "tests/ 目录不存在或为空,跳过测试执行"
# ==================== 构建后端镜像 ====================
build-backend:
name: 构建后端镜像
runs-on: ubuntu-latest
needs: [lint, test]
# push 触发,或手动 workflow_dispatch(用于重新部署 / 应用 Nacos 配置变更)。
# 显式校验依赖结果:test 被 skip(skip_tests=true)时仍允许构建。
if: ${{ !cancelled() && needs.lint.result == 'success' && (needs.test.result == 'success' || needs.test.result == 'skipped') && (github.event_name == 'push' || github.event_name == 'workflow_dispatch') }}
outputs:
backend-tag: ${{ steps.meta.outputs.tags }}
backend-digest: ${{ steps.build.outputs.digest }}
steps:
- name: 检出代码
uses: actions/checkout@v4
- name: 设置 Docker Buildx
uses: docker/setup-buildx-action@v3
- name: 登录容器仓库
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: 提取元数据
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}-backend
tags: |
type=ref,event=branch
type=sha,prefix={{branch}}-
type=raw,value=test,enable=${{ github.ref_name != 'main' }}
type=raw,value=prod,enable=${{ github.ref_name == 'main' }}
- name: 构建并推送后端镜像
id: build
uses: docker/build-push-action@v5
with:
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
cache-from: type=gha
cache-to: type=gha,mode=max
target: production
# ==================== 部署到测试服务器 ====================
deploy-test:
name: 部署到测试环境
runs-on: ubuntu-latest
needs: [build-backend]
# push 到 main/zfq_dev,或在任意分支手动 workflow_dispatch(手动触发常用于
# 改完 Nacos 配置后强制重建容器使其生效,见下方 --force-recreate)。
if: ${{ needs.build-backend.result == 'success' && ((github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/zfq_dev')) || github.event_name == 'workflow_dispatch') }}
environment: test
steps:
- name: 检出部署配置
uses: actions/checkout@v4
with:
sparse-checkout: |
docker
sparse-checkout-cone-mode: false
- name: 上传 compose 模板到服务器
uses: appleboy/scp-action@v0.1.7
with:
host: ${{ secrets.TEST_SERVER_HOST }}
username: ${{ secrets.TEST_SERVER_USER }}
key: ${{ secrets.TEST_SERVER_SSH_KEY }}
source: "docker/docker-compose.prod.yml"
target: "${{ vars.TEST_SERVER_DIR || '/opt/thvote/test' }}"
strip_components: 1
- name: 部署到测试服务器
uses: appleboy/ssh-action@v1
env:
NACOS_SERVER_ADDRS: ${{ secrets.NACOS_SERVER_ADDRS }}
NACOS_NAMESPACE: ${{ secrets.TEST_NACOS_NAMESPACE }}
NACOS_USERNAME: ${{ secrets.TEST_NACOS_USERNAME }}
NACOS_PASSWORD: ${{ secrets.TEST_NACOS_PASSWORD }}
# 用本次构建产出的不可变 digest,避免浮动 :prod/:test tag 在拉取时取到旧镜像
BACKEND_IMAGE: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}-backend@${{ needs.build-backend.outputs.backend-digest }}
REGISTRY: ${{ env.REGISTRY }}
GITHUB_ACTOR: ${{ github.actor }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
host: ${{ secrets.TEST_SERVER_HOST }}
username: ${{ secrets.TEST_SERVER_USER }}
key: ${{ secrets.TEST_SERVER_SSH_KEY }}
envs: NACOS_SERVER_ADDRS,NACOS_NAMESPACE,NACOS_USERNAME,NACOS_PASSWORD,BACKEND_IMAGE,REGISTRY,GITHUB_ACTOR,GITHUB_TOKEN
script: |
set -e
DEPLOY_DIR="${{ vars.TEST_SERVER_DIR || '/opt/thvote/test' }}"
mkdir -p "$DEPLOY_DIR/logs"
cd "$DEPLOY_DIR"
echo "$GITHUB_TOKEN" | docker login "$REGISTRY" -u "$GITHUB_ACTOR" --password-stdin
# 创建外部网络(如果不存在)
if ! docker network ls | grep -q "thvote-net"; then
docker network create thvote-net
echo "已创建网络 thvote-net"
fi
# 写入 .env
{
echo "NACOS_ENABLED=true"
echo "NACOS_SERVER_ADDRS=${NACOS_SERVER_ADDRS}"
echo "NACOS_NAMESPACE=${NACOS_NAMESPACE}"
echo "NACOS_GROUP=DEFAULT_GROUP"
echo "NACOS_DATA_ID=thvote_be"
echo "NACOS_USERNAME=${NACOS_USERNAME}"
echo "NACOS_PASSWORD=${NACOS_PASSWORD}"
echo "BACKEND_IMAGE=${BACKEND_IMAGE}"
} > .env
# 更新 docker-compose.yml(从仓库上传的模板)
cp docker-compose.prod.yml docker-compose.yml
echo "docker-compose.yml 已从仓库模板更新"
# 拉取镜像
# 拉失败必须硬红(不再 || true 静默用旧镜像):重试一次后仍失败则终止部署
docker pull "${BACKEND_IMAGE}" || { sleep 5; docker pull "${BACKEND_IMAGE}"; } || { echo "镜像拉取失败,终止"; exit 1; }
# 仅当 redis 未运行时才启动
if docker ps --format '{{.Names}}' | grep -q '^thvote-redis$'; then
echo "redis 正在运行,跳过启动"
else
docker-compose up -d redis
fi
# 前置检查:Nacos 容器必须在跑(DATABASE_URL 等配置全由它下发;
# DB 是外部实例,本机没有 thvote-postgres 容器,不在此检查)。
# 2026-08-13 事故:主机重启后 mynacos(restart=no)未被拉起,后端
# 拿不到配置 crash-loop 六天,此处曾是等一个不存在容器的死循环。
if ! docker ps --format '{{.Names}}' | grep -q '^mynacos$'; then
echo "Nacos 容器(mynacos)未运行,后端将拿不到任何配置。请先 docker start mynacos。终止部署。"
exit 1
fi
echo "nacos 就绪"
# 应用 Alembic 迁移(DATABASE_URL 由 Nacos 下发)
echo "执行 alembic upgrade head ..."
docker run --rm --network thvote-net -e NACOS_ENABLED=true -e NACOS_SERVER_ADDRS="${NACOS_SERVER_ADDRS}" -e NACOS_NAMESPACE="${NACOS_NAMESPACE}" -e NACOS_GROUP=DEFAULT_GROUP -e NACOS_DATA_ID=thvote_be -e NACOS_USERNAME="${NACOS_USERNAME}" -e NACOS_PASSWORD="${NACOS_PASSWORD}" "${BACKEND_IMAGE}" alembic upgrade head
# 启动后端(--force-recreate:即使镜像未变也重建容器,
# 这样手动触发 + 改完 Nacos 配置后能重启进程让新配置生效)
docker-compose up -d --force-recreate backend
# 等待健康检查
for i in $(seq 1 40); do
BACKEND_HEALTH="$(docker inspect -f '{{.State.Health.Status}}' thvote-backend 2>/dev/null || true)"
if [ "$BACKEND_HEALTH" = "healthy" ]; then
echo "后端就绪"
break
fi
if [ "$BACKEND_HEALTH" = "unhealthy" ]; then
echo "后端已进入 unhealthy 状态"
docker-compose logs backend | tail -50
exit 1
fi
echo "等待后端启动... ($i/40), 当前状态: ${BACKEND_HEALTH:-starting}"
sleep 3
done
# 最终验证
BACKEND_HEALTH="$(docker inspect -f '{{.State.Health.Status}}' thvote-backend 2>/dev/null || true)"
if [ "$BACKEND_HEALTH" != "healthy" ]; then
echo "后端健康检查失败,当前状态: ${BACKEND_HEALTH:-unknown}"
docker-compose logs backend | tail -50
exit 1
fi
docker image prune -f
echo "后端部署完成,地址: http://localhost:18000"
# ==================== 部署到生产服务器 ====================
# 触发方式:workflow_dispatch + 勾选 deploy_prod=true。
# 硬性要求:build-backend 与 deploy-test 都成功后才允许执行——生产用的就是
# 测试环境刚验证过的那个 digest,不存在"另build一份"的漂移。
# 依赖(redis/nacos)不在本文件里:生产机 /opt/thvote/prod/docker-compose.deps.yml
# 单独维护,否则 CI 每次覆盖 docker-compose.yml 会把 nacos 冲掉。
deploy-prod:
name: 部署到生产环境
runs-on: ubuntu-latest
needs: [build-backend, deploy-test]
if: ${{ needs.build-backend.result == 'success' && needs.deploy-test.result == 'success' && github.event_name == 'workflow_dispatch' && inputs.deploy_prod }}
steps:
- name: 检出部署配置
uses: actions/checkout@v4
with:
sparse-checkout: |
docker
sparse-checkout-cone-mode: false
- name: 上传 compose 模板到生产服务器
uses: appleboy/scp-action@v0.1.7
with:
host: ${{ secrets.PROD_SERVER_HOST }}
username: ${{ secrets.PROD_SERVER_USER }}
key: ${{ secrets.PROD_SERVER_SSH_KEY }}
source: "docker/docker-compose.prod.yml"
target: "${{ vars.PROD_SERVER_DIR || '/opt/thvote/prod' }}"
strip_components: 1
- name: 部署到生产服务器
uses: appleboy/ssh-action@v1
env:
NACOS_SERVER_ADDRS: ${{ secrets.PROD_NACOS_SERVER_ADDRS }}
NACOS_NAMESPACE: ${{ secrets.PROD_NACOS_NAMESPACE }}
NACOS_USERNAME: ${{ secrets.PROD_NACOS_USERNAME }}
NACOS_PASSWORD: ${{ secrets.PROD_NACOS_PASSWORD }}
# 与 deploy-test 同一个不可变 digest
BACKEND_IMAGE: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}-backend@${{ needs.build-backend.outputs.backend-digest }}
REGISTRY: ${{ env.REGISTRY }}
GITHUB_ACTOR: ${{ github.actor }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
host: ${{ secrets.PROD_SERVER_HOST }}
username: ${{ secrets.PROD_SERVER_USER }}
key: ${{ secrets.PROD_SERVER_SSH_KEY }}
envs: NACOS_SERVER_ADDRS,NACOS_NAMESPACE,NACOS_USERNAME,NACOS_PASSWORD,BACKEND_IMAGE,REGISTRY,GITHUB_ACTOR,GITHUB_TOKEN
script: |
set -e
DEPLOY_DIR="${{ vars.PROD_SERVER_DIR || '/opt/thvote/prod' }}"
mkdir -p "$DEPLOY_DIR/logs"
cd "$DEPLOY_DIR"
echo "$GITHUB_TOKEN" | docker login "$REGISTRY" -u "$GITHUB_ACTOR" --password-stdin
# redis 由 docker-compose.deps.yml 维护(与 CI 覆盖的 docker-compose.yml 分离)
if ! docker ps --format '{{.Names}}' | grep -q '^thvote-redis$'; then
docker compose -f docker-compose.deps.yml up -d redis
fi
# Nacos 必须先跑:后端在 import 阶段就要读配置,读不到会 crash-loop
if ! docker ps --format '{{.Names}}' | grep -q '^mynacos$'; then
echo "Nacos 容器(mynacos)未运行,后端将拿不到任何配置。请先启动 mynacos。终止部署。"
exit 1
fi
echo "nacos 就绪"
# .env 只放 Nacos 连接信息 + 镜像地址,业务配置全在 Nacos
umask 077
{
echo "NACOS_ENABLED=true"
echo "NACOS_SERVER_ADDRS=${NACOS_SERVER_ADDRS}"
echo "NACOS_NAMESPACE=${NACOS_NAMESPACE}"
echo "NACOS_GROUP=DEFAULT_GROUP"
echo "NACOS_DATA_ID=thvote_be"
echo "NACOS_USERNAME=${NACOS_USERNAME}"
echo "NACOS_PASSWORD=${NACOS_PASSWORD}"
echo "BACKEND_IMAGE=${BACKEND_IMAGE}"
} > .env
chmod 600 .env
# 仅覆盖 compose;deps 文件不动
cp docker-compose.prod.yml docker-compose.yml
# 拉取镜像;失败必须硬红(不回退到旧镜像)
docker pull "${BACKEND_IMAGE}" || { sleep 5; docker pull "${BACKEND_IMAGE}"; } || { echo "镜像拉取失败,终止"; exit 1; }
# 应用 Alembic 迁移(DATABASE_URL 由 Nacos 下发)
echo "执行 alembic upgrade head ..."
docker run --rm --network thvote-net -e NACOS_ENABLED=true -e NACOS_SERVER_ADDRS="${NACOS_SERVER_ADDRS}" -e NACOS_NAMESPACE="${NACOS_NAMESPACE}" -e NACOS_GROUP=DEFAULT_GROUP -e NACOS_DATA_ID=thvote_be -e NACOS_USERNAME="${NACOS_USERNAME}" -e NACOS_PASSWORD="${NACOS_PASSWORD}" "${BACKEND_IMAGE}" alembic upgrade head
# 启动后端(--force-recreate:即使镜像未变也重建,便于 Nacos 配置变更后重启)
docker compose up -d --force-recreate backend
# 等待健康检查
for i in $(seq 1 40); do
BACKEND_HEALTH="$(docker inspect -f '{{.State.Health.Status}}' thvote-backend 2>/dev/null || true)"
if [ "$BACKEND_HEALTH" = "healthy" ]; then
echo "后端就绪"
break
fi
if [ "$BACKEND_HEALTH" = "unhealthy" ]; then
echo "后端已进入 unhealthy 状态"
docker compose logs backend | tail -50
exit 1
fi
echo "等待后端启动... ($i/40), 当前状态: ${BACKEND_HEALTH:-starting}"
sleep 3
done
BACKEND_HEALTH="$(docker inspect -f '{{.State.Health.Status}}' thvote-backend 2>/dev/null || true)"
if [ "$BACKEND_HEALTH" != "healthy" ]; then
echo "后端健康检查失败,当前状态: ${BACKEND_HEALTH:-unknown}"
docker compose logs backend | tail -50
exit 1
fi
# 冒烟:P-1 文档关闭 + P-4 测试旁路已删
for PATH_ in /docs /openapi.json /redoc; do
CODE_="$(curl -s -o /dev/null -w '%{http_code}' "http://127.0.0.1:18000${PATH_}")"
if [ "$CODE_" != "404" ]; then
echo "P-1 未生效:${PATH_} 返回 ${CODE_}(应为 404)"
exit 1
fi
done
LOGIN_CODE="$(curl -s -o /dev/null -w '%{http_code}' -X POST "http://127.0.0.1:18000/api/v1/user/login-phone" -H 'Content-Type: application/json' -d '{"phone":"19900000001","code":"888888"}')"
if [ "$LOGIN_CODE" = "200" ]; then
echo "P-4 未生效:测试旁路账号仍能登录"
exit 1
fi
echo "冒烟通过:/docs 404,旁路登录 ${LOGIN_CODE}"
docker image prune -f
echo "生产部署完成,地址: http://localhost:18000"
# ==================== 通知 ====================
notify:
name: 通知
runs-on: ubuntu-latest
needs: [deploy-test]
if: always()
steps:
- name: 成功
if: needs.deploy-test.result == 'success' || needs.deploy-test.result == 'skipped'
run: |
echo "测试环境后端部署完成"
echo "镜像: ${{ needs.build-backend.outputs.backend-tag }}"
echo "后端: http://${{ secrets.TEST_SERVER_HOST }}:8000"
- name: 失败
if: needs.deploy-test.result == 'failure'
run: |
echo "测试环境后端部署失败"
exit 1