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,161 @@
|
||||
# =============================================================================
|
||||
# 企微IT智能服务台 — 开发模式 Mock 登录
|
||||
# =============================================================================
|
||||
# ⚠️ 警告:此模块只在 DEV_MODE=true 时可用
|
||||
# - 仅供本地开发 / 集成测试使用
|
||||
# - 生产环境(DEV_MODE 未设置或 false)会直接 403
|
||||
# - 部署前必须确认 .env / .env.production 没有 DEV_MODE=true
|
||||
# 用法:
|
||||
# GET /api/dev/login?userid=dev-user-001&name=测试&role=user
|
||||
# GET /api/dev/users # 列出所有预设 dev 用户
|
||||
# =============================================================================
|
||||
|
||||
import logging
|
||||
import os
|
||||
from typing import Optional
|
||||
|
||||
import redis.asyncio as aioredis
|
||||
from fastapi import APIRouter, Depends, HTTPException, Query
|
||||
|
||||
from app.config import settings
|
||||
from app.dependencies import get_redis
|
||||
from app.services.token_service import TokenService
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
router = APIRouter(prefix="/api/dev", tags=["dev-mock"])
|
||||
|
||||
|
||||
def _dev_mode_enabled() -> bool:
|
||||
"""检查是否启用了开发模式。
|
||||
|
||||
三个检查源(任一为 true 即启用):
|
||||
1. 环境变量 DEV_MODE=true
|
||||
2. settings.dev_mode(从 .env.dev 读)
|
||||
3. DEBUG 模式 + 本地主机(最严格)
|
||||
"""
|
||||
env_val = os.getenv("DEV_MODE", "false").lower() == "true"
|
||||
if env_val:
|
||||
return True
|
||||
# 兜底:从 settings 读
|
||||
if hasattr(settings, "dev_mode") and getattr(settings, "dev_mode", False):
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# 预设 dev 用户(便于测试不同角色)
|
||||
# -----------------------------------------------------------------------------
|
||||
PRESET_DEV_USERS = [
|
||||
{"userid": "dev-user-001", "name": "张三(普通员工)", "role": "user", "department": "财务部"},
|
||||
{"userid": "dev-agent-001", "name": "李四(IT 坐席)", "role": "agent", "department": "信息技术部"},
|
||||
{"userid": "dev-supervisor-001", "name": "王五(部门主管)", "role": "supervisor", "department": "信息技术部"},
|
||||
{"userid": "dev-security-001", "name": "赵六(安全团队)", "role": "security", "department": "信息安全部"},
|
||||
{"userid": "dev-admin-001", "name": "钱七(系统管理员)", "role": "admin", "department": "信息技术部"},
|
||||
{"userid": "dev-multi-001", "name": "周八(多角色测试)", "role": "user,agent,supervisor", "department": "测试部"},
|
||||
]
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# GET /api/dev/login — Mock 登录(返回 token)
|
||||
# -----------------------------------------------------------------------------
|
||||
@router.get("/login")
|
||||
async def dev_login(
|
||||
userid: str = Query("dev-user-001", description="用户 ID(模拟企微 userid)"),
|
||||
name: str = Query("开发测试用户", description="用户姓名"),
|
||||
role: str = Query("user", description="角色:user/agent/admin/supervisor/security,多个用逗号分隔"),
|
||||
department: str = Query("信息技术部", description="部门"),
|
||||
avatar: Optional[str] = Query(None, description="头像 URL(可选)"),
|
||||
redis: aioredis.Redis = Depends(get_redis),
|
||||
):
|
||||
"""开发模式 Mock 登录。
|
||||
|
||||
用法:
|
||||
GET /api/dev/login?userid=dev-agent-001&name=李四&role=agent
|
||||
|
||||
返回:
|
||||
{
|
||||
"code": 0,
|
||||
"data": {
|
||||
"token": "abc123...",
|
||||
"user": { "userid": "...", "name": "...", "roles": [...] }
|
||||
}
|
||||
}
|
||||
"""
|
||||
if not _dev_mode_enabled():
|
||||
logger.warning("🚨 /api/dev/login 被调用但 DEV_MODE 未启用,返回 403")
|
||||
raise HTTPException(
|
||||
status_code=403,
|
||||
detail="DEV_MODE not enabled. Set DEV_MODE=true in .env.dev to use this endpoint."
|
||||
)
|
||||
|
||||
# 解析多角色
|
||||
roles = [r.strip() for r in role.split(",") if r.strip()]
|
||||
if not roles:
|
||||
roles = ["user"]
|
||||
|
||||
# 调 TokenService 创建 token(走完全真实的 token 流程)
|
||||
token_service = TokenService(redis)
|
||||
token = await token_service.create_token(
|
||||
employee_id=userid,
|
||||
name=name,
|
||||
roles=roles,
|
||||
department=department,
|
||||
avatar=avatar or "",
|
||||
login_source="dev",
|
||||
)
|
||||
|
||||
logger.info(f"🧪 [DEV] Mock 登录成功: userid={userid}, roles={roles}")
|
||||
|
||||
return {
|
||||
"code": 0,
|
||||
"message": "ok",
|
||||
"data": {
|
||||
"token": token,
|
||||
"user": {
|
||||
"userid": userid,
|
||||
"name": name,
|
||||
"department": department,
|
||||
"avatar": avatar or "",
|
||||
"roles": roles,
|
||||
"login_source": "dev",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# GET /api/dev/users — 列出所有预设 dev 用户
|
||||
# -----------------------------------------------------------------------------
|
||||
@router.get("/users")
|
||||
async def dev_list_users():
|
||||
"""列出所有预设 dev 用户(便于前端测试用)。"""
|
||||
if not _dev_mode_enabled():
|
||||
raise HTTPException(status_code=403, detail="DEV_MODE not enabled")
|
||||
|
||||
return {
|
||||
"code": 0,
|
||||
"message": "ok",
|
||||
"data": PRESET_DEV_USERS,
|
||||
}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# GET /api/dev/health — 检查 dev 模式状态
|
||||
# -----------------------------------------------------------------------------
|
||||
@router.get("/health")
|
||||
async def dev_health():
|
||||
"""检查 dev 模式是否启用 + 关键依赖。"""
|
||||
if not _dev_mode_enabled():
|
||||
raise HTTPException(status_code=403, detail="DEV_MODE not enabled")
|
||||
|
||||
return {
|
||||
"code": 0,
|
||||
"data": {
|
||||
"dev_mode": True,
|
||||
"env": os.getenv("APP_ENV", "unknown"),
|
||||
"database_url": os.getenv("DATABASE_URL", "not set")[:50] + "...",
|
||||
"redis_url": os.getenv("REDIS_URL", "not set"),
|
||||
"preset_users": len(PRESET_DEV_USERS),
|
||||
},
|
||||
}
|
||||
@@ -99,6 +99,23 @@ class Settings(BaseSettings):
|
||||
# 是否启用 Mock 登录（默认 false，生产环境必须关闭）
|
||||
mock_login_enabled: bool = False
|
||||
|
||||
# ----------------------------------------------------------------------
|
||||
# 开发模式配置(本地 docker-compose.dev.yml 用)
|
||||
# ----------------------------------------------------------------------
|
||||
# 是否启用开发模式(本地开发环境,启用后挂载 /api/dev/* Mock OAuth 路由)
|
||||
# ⚠️ 生产环境必须为 false / 不设置
|
||||
# 启用的副作用:
|
||||
# 1. 后端启动时挂载 /api/dev/login /users /health 三个 Mock 端点
|
||||
# 2. /api/dev/login 跳过企微 OAuth 直接生成 token
|
||||
# 3. 启动日志会大声警告 "🧪 DEV_MODE enabled"
|
||||
dev_mode: bool = False
|
||||
# 开发模式默认 userid(本地前端兜底用,实际由前端 /api/dev/login 传入)
|
||||
dev_default_userid: str = "dev-user-001"
|
||||
# 开发模式默认姓名
|
||||
dev_default_name: str = "开发测试用户"
|
||||
# 开发模式默认部门
|
||||
dev_default_dept: str = "信息技术部"
|
||||
|
||||
# ----------------------------------------------------------------------
|
||||
# 审批模板配置（企微审批应用）
|
||||
# ----------------------------------------------------------------------
|
||||
|
||||
@@ -37,6 +37,30 @@ logging.basicConfig(
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
# --------------------------------------------------------------------------
|
||||
# 开发模式判定(模块级 helper,避免在 create_app 内每次重复 import)
|
||||
# --------------------------------------------------------------------------
|
||||
def _is_dev_mode() -> bool:
|
||||
"""检查是否启用了开发模式(DEV_MODE=true)。
|
||||
|
||||
三个检查源(任一为 true 即启用):
|
||||
1. 环境变量 DEV_MODE=true(最高优先级,Docker 注入)
|
||||
2. settings.dev_mode(从 .env.dev 读)
|
||||
3. DEBUG 模式 + 本地主机(最严格)
|
||||
|
||||
注意:此函数与 backend/app/api/dev_auth.py 内的 _dev_mode_enabled() 逻辑一致,
|
||||
这里用于"是否挂载 dev_auth 路由",那里用于"端点内是否放行"。
|
||||
"""
|
||||
import os
|
||||
|
||||
env_val = os.getenv("DEV_MODE", "").lower() == "true"
|
||||
if env_val:
|
||||
return True
|
||||
if getattr(settings, "dev_mode", False):
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
# --------------------------------------------------------------------------
|
||||
# 应用生命周期管理（启动和关闭事件）
|
||||
# --------------------------------------------------------------------------
|
||||
@@ -492,6 +516,30 @@ def create_app() -> FastAPI:
|
||||
# 请求到达后端时 /api/ 已被 strip，因此此处不需要再加 /api 前缀
|
||||
app.include_router(api_router)
|
||||
|
||||
# ----------------------------------------------------------------------
|
||||
# 开发模式 Mock OAuth（仅 DEV_MODE=true 时挂载）
|
||||
# ----------------------------------------------------------------------
|
||||
# ⚠️ 生产环境严禁启用（DEV_MODE=false 或不设置）
|
||||
# 挂载的端点：
|
||||
# GET /api/dev/login — Mock 登录，跳过企微 OAuth 直接返回 token
|
||||
# GET /api/dev/users — 列出预设 dev 用户
|
||||
# GET /api/dev/health — dev 模式状态自检
|
||||
# 即使挂载了，每个端点内部也会再 _dev_mode_enabled() 二次校验
|
||||
# ----------------------------------------------------------------------
|
||||
if _is_dev_mode():
|
||||
from app.api.dev_auth import router as dev_auth_router
|
||||
app.include_router(dev_auth_router)
|
||||
logger.warning(
|
||||
"🧪 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n"
|
||||
"🧪 DEV_MODE 已启用 - Mock OAuth 端点已挂载\n"
|
||||
"🧪 仅供本地开发测试使用，生产环境必须关闭！\n"
|
||||
"🧪 端点列表：\n"
|
||||
"🧪 GET /api/dev/login - Mock 登录\n"
|
||||
"🧪 GET /api/dev/users - 列出预设用户\n"
|
||||
"🧪 GET /api/dev/health - dev 模式状态\n"
|
||||
"🧪 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
)
|
||||
|
||||
# ----------------------------------------------------------------------
|
||||
# 挂载 WebSocket 路由
|
||||
# ----------------------------------------------------------------------
|
||||
|
||||
Reference in New Issue
Block a user