feat(dev): 本地开发环境(docker-compose + Mock OAuth + 一键脚本)
解决改代码 30-60min 才能看到结果的痛点。本地拉起完整 stack, 改代码 → 1-2min 看到结果,无需服务器。 ## 交付物 ### Docker stack (docker-compose.dev.yml) - postgres:16-alpine 端口 5432 - redis:7-alpine 端口 6379 - backend 端口 8000,代码 volume mount + uvicorn --reload ### Dev 镜像 (backend/Dockerfile.dev) - 单阶段(无需 gcc / libpq-dev) - apt 源换阿里云(公司内网) - 装 pytest pytest-asyncio httpx watchfiles - CMD: uvicorn --reload ### 配置 (.env.dev, 强制 add 因 .env.* 在 .gitignore) 内容是 dev 占位符,无任何真实密钥: - DEV_MODE=true (启用 Mock OAuth) - WECOM_* 全部 dev_xxx 占位 - 集成系统 API 全 dev_ 占位(调用会失败但不影响主流程) ### Mock OAuth (backend/app/api/dev_auth.py) - GET /api/dev/login?userid=xxx&name=xxx&role=xxx 走完全真实的 TokenService.create_token(不绕过业务逻辑) - GET /api/dev/users 列出 6 个预设 dev 用户 - GET /api/dev/health dev 模式状态自检 - 6 预设用户覆盖所有角色(user/agent/supervisor/security/admin/多角色) - 每个端点 _dev_mode_enabled() 二次校验,生产环境访问 403 ### 集成改动 - backend/app/main.py: 加 _is_dev_mode() + DEV_MODE=true 时条件挂载 dev_auth 路由 + 启动时大声警告 - backend/app/config.py: Settings 加 dev_mode / dev_default_userid / dev_default_name / dev_default_dept 字段 ### PowerShell 脚本 - scripts/dev-start.ps1: 5 步验证(检查 Docker / .env / compose / 健康 / dev health),首次 2-5min build,后续秒起 - scripts/dev-stop.ps1: 停止,支持 -v 清数据卷 - scripts/dev-test.ps1: 一键跑 pytest(可选 -Frontend 跑 vitest) ## 阶段 - ✅ Phase 0 基础(本 commit) - ⏳ Phase 1 pytest(任务 #90) - 500 bug 回归测试已就绪 - ⏳ Phase 2 vitest - ⏳ Phase 3 playwright E2E ## 安全保证 - DEV_MODE 三个地方都校验(环境变量/settings/端点内) - 生产环境 /api/dev/* 端点根本不存在(未挂载) - .env.dev 是 dev 占位符,无敏感,可入 git
This commit is contained in:
Simon
@@ -0,0 +1,48 @@
|
||||
# =============================================================================
|
||||
# 企微IT智能服务台 — 本地开发环境 停止脚本
|
||||
# =============================================================================
|
||||
# 作用:停止 docker-compose.dev.yml 启动的所有容器(数据保留)
|
||||
# 用法:.\scripts\dev-stop.ps1
|
||||
# 数据会保留在 postgres_dev_data / redis_dev_data 卷里
|
||||
# 如需完全清空,加 -v 参数:.\scripts\dev-stop.ps1 -RemoveVolumes
|
||||
# =============================================================================
|
||||
|
||||
param(
|
||||
[switch]$RemoveVolumes # 加这个参数会删除数据卷(慎用!)
|
||||
)
|
||||
|
||||
$ErrorActionPreference = 'Stop'
|
||||
|
||||
$ScriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
|
||||
$ProjectRoot = Split-Path -Parent $ScriptDir
|
||||
Set-Location $ProjectRoot
|
||||
|
||||
Write-Host ""
|
||||
Write-Host "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" -ForegroundColor Yellow
|
||||
Write-Host " 停止本地开发环境" -ForegroundColor Yellow
|
||||
Write-Host "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" -ForegroundColor Yellow
|
||||
|
||||
if ($RemoveVolumes) {
|
||||
Write-Host ""
|
||||
Write-Host "⚠️ -v 参数已指定,将删除所有数据卷!" -ForegroundColor Red
|
||||
Write-Host " (postgres_dev_data / redis_dev_data 会被清空)" -ForegroundColor Red
|
||||
Write-Host ""
|
||||
$Confirm = Read-Host "确认删除?输入 yes 继续,其他键取消"
|
||||
if ($Confirm -ne "yes") {
|
||||
Write-Host "已取消" -ForegroundColor Gray
|
||||
exit 0
|
||||
}
|
||||
docker compose -f docker-compose.dev.yml down -v
|
||||
} else {
|
||||
docker compose -f docker-compose.dev.yml down
|
||||
}
|
||||
|
||||
if ($LASTEXITCODE -eq 0) {
|
||||
Write-Host "✅ 容器已停止" -ForegroundColor Green
|
||||
Write-Host ""
|
||||
Write-Host "📌 数据保留在卷里,下次 .\scripts\dev-start.ps1 自动恢复" -ForegroundColor Cyan
|
||||
Write-Host "📌 完全清理:.\scripts\dev-stop.ps1 -RemoveVolumes" -ForegroundColor Cyan
|
||||
} else {
|
||||
Write-Host "❌ 停止失败" -ForegroundColor Red
|
||||
exit 1
|
||||
}
|
||||
@@ -0,0 +1,164 @@
|
||||
# =============================================================================
|
||||
# 企微IT智能服务台 — 本地开发环境 一键测试脚本
|
||||
# =============================================================================
|
||||
# 作用:跑后端 pytest + 前端 vitest(可选)
|
||||
# 用法:在 PowerShell 中执行
|
||||
# .\scripts\dev-test.ps1 # 跑后端 pytest
|
||||
# .\scripts\dev-test.ps1 -Frontend # 也跑前端 vitest
|
||||
# .\scripts\dev-test.ps1 -BackendOnly # 只跑后端
|
||||
# 前置:docker compose -f docker-compose.dev.yml up -d 已运行
|
||||
# =============================================================================
|
||||
|
||||
param(
|
||||
[switch]$Frontend, # 加这个参数同时跑前端 vitest
|
||||
[switch]$BackendOnly, # 只跑后端
|
||||
[switch]$FrontendOnly, # 只跑前端
|
||||
[switch]$SkipBuild, # 跳过 backend build check
|
||||
[switch]$Verbose # 详细输出
|
||||
)
|
||||
|
||||
$ErrorActionPreference = 'Continue' # 测试失败不中断,继续跑其他
|
||||
$ScriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
|
||||
$ProjectRoot = Split-Path -Parent $ScriptDir
|
||||
Set-Location $ProjectRoot
|
||||
|
||||
Write-Host ""
|
||||
Write-Host "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" -ForegroundColor Cyan
|
||||
Write-Host " 企微IT智能服务台 — 本地测试套件" -ForegroundColor Cyan
|
||||
Write-Host "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" -ForegroundColor Cyan
|
||||
Write-Host "模式:" -ForegroundColor Gray -NoNewline
|
||||
if ($FrontendOnly) { Write-Host " 仅前端 vitest" -ForegroundColor Magenta }
|
||||
elseif ($BackendOnly) { Write-Host " 仅后端 pytest" -ForegroundColor Magenta }
|
||||
elseif ($Frontend) { Write-Host " 后端 pytest + 前端 vitest" -ForegroundColor Magenta }
|
||||
else { Write-Host " 仅后端 pytest(默认)" -ForegroundColor Magenta }
|
||||
Write-Host ""
|
||||
|
||||
$Script:TotalPassed = 0
|
||||
$Script:TotalFailed = 0
|
||||
$Script:TotalError = @()
|
||||
|
||||
# ==========================================================================
|
||||
# 第一步:环境检查
|
||||
# ==========================================================================
|
||||
if (-not $FrontendOnly) {
|
||||
Write-Host "[1/3] 检查后端依赖..." -ForegroundColor Yellow
|
||||
|
||||
# 检查 backend 目录
|
||||
if (-not (Test-Path "backend/pytest.ini")) {
|
||||
# 后端可能没 pytest.ini,检查是否有 tests/ 目录
|
||||
if (-not (Test-Path "backend/tests")) {
|
||||
Write-Host " ⚠️ backend/tests 目录不存在,跳过 pytest" -ForegroundColor Yellow
|
||||
$Script:TotalError += "后端无测试目录"
|
||||
}
|
||||
}
|
||||
|
||||
# 检查 docker 容器是否在跑
|
||||
$BackendStatus = docker ps --filter "name=dev_wecom_backend" --format "{{.Status}}" 2>$null
|
||||
if (-not $BackendStatus) {
|
||||
Write-Host " ❌ backend 容器未运行!" -ForegroundColor Red
|
||||
Write-Host " 请先执行:.\scripts\dev-start.ps1" -ForegroundColor Gray
|
||||
exit 1
|
||||
}
|
||||
Write-Host " ✅ backend 容器运行中: $BackendStatus" -ForegroundColor Green
|
||||
}
|
||||
|
||||
# ==========================================================================
|
||||
# 第二步:跑后端 pytest
|
||||
# ==========================================================================
|
||||
if (-not $FrontendOnly) {
|
||||
Write-Host ""
|
||||
Write-Host "[2/3] 跑后端 pytest..." -ForegroundColor Yellow
|
||||
|
||||
if (Test-Path "backend/tests") {
|
||||
$PytestArgs = @("pytest", "-v", "--tb=short", "--color=yes")
|
||||
if ($Verbose) { $PytestArgs += "-s" }
|
||||
|
||||
docker exec dev_wecom_backend @PytestArgs
|
||||
|
||||
if ($LASTEXITCODE -eq 0) {
|
||||
Write-Host " ✅ pytest 通过" -ForegroundColor Green
|
||||
$Script:TotalPassed++
|
||||
} else {
|
||||
Write-Host " ❌ pytest 失败(退出码 $LASTEXITCODE)" -ForegroundColor Red
|
||||
$Script:TotalFailed++
|
||||
$Script:TotalError += "后端 pytest 失败"
|
||||
}
|
||||
} else {
|
||||
Write-Host " ⏭️ 跳过(无 backend/tests)" -ForegroundColor Yellow
|
||||
}
|
||||
}
|
||||
|
||||
# ==========================================================================
|
||||
# 第三步:跑前端 vitest
|
||||
# ==========================================================================
|
||||
if ($Frontend -or $FrontendOnly) {
|
||||
Write-Host ""
|
||||
Write-Host "[3/3] 跑前端 vitest..." -ForegroundColor Yellow
|
||||
|
||||
$FrontendDirs = @("frontend-h5", "frontend-agent", "frontend-admin", "frontend-portal")
|
||||
foreach ($Dir in $FrontendDirs) {
|
||||
if (-not (Test-Path "$Dir/node_modules")) {
|
||||
Write-Host " ⏭️ 跳过 $Dir (未安装依赖)" -ForegroundColor Yellow
|
||||
continue
|
||||
}
|
||||
if (-not (Test-Path "$Dir/vitest.config.ts") -and -not (Test-Path "$Dir/vitest.config.js")) {
|
||||
Write-Host " ⏭️ 跳过 $Dir (无 vitest.config)" -ForegroundColor Yellow
|
||||
continue
|
||||
}
|
||||
|
||||
Write-Host " ▶ $Dir" -ForegroundColor Cyan
|
||||
Push-Location $Dir
|
||||
try {
|
||||
if ($Verbose) {
|
||||
pnpm test:run 2>&1 | Tee-Object -Variable VitestOutput
|
||||
} else {
|
||||
pnpm test:run 2>&1 | Out-Null
|
||||
}
|
||||
if ($LASTEXITCODE -eq 0) {
|
||||
Write-Host " ✅ $Dir 通过" -ForegroundColor Green
|
||||
$Script:TotalPassed++
|
||||
} else {
|
||||
Write-Host " ❌ $Dir 失败" -ForegroundColor Red
|
||||
$Script:TotalFailed++
|
||||
$Script:TotalError += "前端 $Dir vitest 失败"
|
||||
}
|
||||
} finally {
|
||||
Pop-Location
|
||||
}
|
||||
}
|
||||
} else {
|
||||
Write-Host ""
|
||||
Write-Host "[3/3] 跳过前端 vitest(加 -Frontend 参数启用)" -ForegroundColor Gray
|
||||
}
|
||||
|
||||
# ==========================================================================
|
||||
# 总结
|
||||
# ==========================================================================
|
||||
Write-Host ""
|
||||
Write-Host "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" -ForegroundColor Cyan
|
||||
Write-Host " 测试结果汇总" -ForegroundColor Cyan
|
||||
Write-Host "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" -ForegroundColor Cyan
|
||||
Write-Host " 通过模块: " -NoNewline -ForegroundColor White
|
||||
Write-Host $Script:TotalPassed -ForegroundColor Green
|
||||
Write-Host " 失败模块: " -NoNewline -ForegroundColor White
|
||||
if ($Script:TotalFailed -eq 0) {
|
||||
Write-Host $Script:TotalFailed -ForegroundColor Green
|
||||
} else {
|
||||
Write-Host $Script:TotalFailed -ForegroundColor Red
|
||||
}
|
||||
if ($Script:TotalError.Count -gt 0) {
|
||||
Write-Host ""
|
||||
Write-Host " 失败详情:" -ForegroundColor Yellow
|
||||
foreach ($Err in $Script:TotalError) {
|
||||
Write-Host " • $Err" -ForegroundColor Red
|
||||
}
|
||||
}
|
||||
Write-Host ""
|
||||
|
||||
if ($Script:TotalFailed -eq 0) {
|
||||
Write-Host "🎉 全部测试通过!" -ForegroundColor Green
|
||||
exit 0
|
||||
} else {
|
||||
Write-Host "⚠️ 有测试失败,请查看上方输出" -ForegroundColor Yellow
|
||||
exit 1
|
||||
}
|
||||
Reference in New Issue
Block a user