django-verification

Django 验证循环

在PR前、重大更改后以及预部署时运行，以确保Django应用程序的质量和安全性。

何时激活

• 在打开Django项目的拉取请求之前
• 在重大模型更改、迁移更新或依赖升级之后
• 预部署验证（针对预发布或生产环境）
• 运行完整环境 → 代码检查 → 测试 → 安全 → 部署就绪流水线
• 验证迁移安全性和测试覆盖率

阶段1：环境检查

# 验证Python版本
python --version  # 应与项目要求匹配

# 检查虚拟环境
which python
pip list --outdated

# 验证环境变量
python -c "import os; import environ; print('DJANGO_SECRET_KEY set' if os.environ.get('DJANGO_SECRET_KEY') else 'MISSING: DJANGO_SECRET_KEY')"

如果环境配置错误，请停止并修复。

阶段2：代码质量与格式化

# 类型检查
mypy . --config-file pyproject.toml

# 使用ruff进行代码检查
ruff check . --fix

# 使用black进行格式化
black . --check
black .  # 自动修复

# 导入排序
isort . --check-only
isort .  # 自动修复

# Django特定检查
python manage.py check --deploy

常见问题：

• 公共函数缺少类型提示
• PEP 8格式违规
• 未排序的导入
• 生产配置中遗留了调试设置

阶段3：迁移

# 检查未应用的迁移
python manage.py showmigrations

# 创建缺失的迁移
python manage.py makemigrations --check

# 模拟迁移应用
python manage.py migrate --plan

# 应用迁移（测试环境）
python manage.py migrate

# 检查迁移冲突
python manage.py makemigrations --merge  # 仅当存在冲突时

报告：

• 待处理迁移数量
• 任何迁移冲突
• 模型更改但未创建迁移

阶段4：测试 + 覆盖率

# 使用pytest运行所有测试
pytest --cov=apps --cov-report=html --cov-report=term-missing --reuse-db

# 运行特定应用的测试
pytest apps/users/tests/

# 使用标记运行
pytest -m "not slow"  # 跳过慢速测试
pytest -m integration  # 仅集成测试

# 覆盖率报告
open htmlcov/index.html

报告：

• 总测试数：X通过，Y失败，Z跳过
• 总体覆盖率：XX%
• 每个应用的覆盖率细分

覆盖率目标：

组件	目标
模型	90%+
序列化器	85%+
视图	80%+
服务	90%+
总体	80%+

阶段5：安全扫描

# 依赖漏洞
pip-audit
safety check --full-report

# Django安全检查
python manage.py check --deploy

# Bandit安全代码检查
bandit -r . -f json -o bandit-report.json

# 密钥扫描（如果安装了gitleaks）
gitleaks detect --source . --verbose

# 环境变量检查
python -c "from django.core.exceptions import ImproperlyConfigured; from django.conf import settings; settings.DEBUG"

报告：

• 发现的易受攻击依赖
• 安全配置问题
• 检测到的硬编码密钥
• DEBUG模式状态（生产环境应为False）

阶段6：Django管理命令

# 检查模型问题
python manage.py check

# 收集静态文件
python manage.py collectstatic --noinput --clear

# 创建超级用户（如果测试需要）
echo "from apps.users.models import User; User.objects.create_superuser('admin@example.com', 'admin')" | python manage.py shell

# 数据库完整性
python manage.py check --database default

# 缓存验证（如果使用Redis）
python -c "from django.core.cache import cache; cache.set('test', 'value', 10); print(cache.get('test'))"

阶段7：性能检查

# Django调试工具栏输出（检查N+1查询）
# 在开发模式下以DEBUG=True运行并访问页面
# 在SQL面板中查找重复查询

# 查询计数分析
django-admin debugsqlshell  # 如果安装了django-debug-sqlshell

# 检查缺失的索引
python manage.py shell << EOF
from django.db import connection
with connection.cursor() as cursor:
    cursor.execute("SELECT table_name, index_name FROM information_schema.statistics WHERE table_schema = 'public'")
    print(cursor.fetchall())
EOF

报告：

• 每页查询数（典型页面应小于50）
• 缺失的数据库索引
• 检测到的重复查询

阶段8：静态资源

# 检查npm依赖（如果使用npm）
npm audit
npm audit fix

# 构建静态文件（如果使用webpack/vite）
npm run build

# 验证静态文件
ls -la staticfiles/
python manage.py findstatic css/style.css

阶段9：配置审查

# 在Python shell中运行以验证设置
python manage.py shell << EOF
from django.conf import settings
import os

# 关键检查
checks = {
    'DEBUG is False': not settings.DEBUG,
    'SECRET_KEY set': bool(settings.SECRET_KEY and len(settings.SECRET_KEY) > 30),
    'ALLOWED_HOSTS set': len(settings.ALLOWED_HOSTS) > 0,
    'HTTPS enabled': getattr(settings, 'SECURE_SSL_REDIRECT', False),
    'HSTS enabled': getattr(settings, 'SECURE_HSTS_SECONDS', 0) > 0,
    'Database configured': settings.DATABASES['default']['ENGINE'] != 'django.db.backends.sqlite3',
}

for check, result in checks.items():
    status = '✓' if result else '✗'
    print(f"{status} {check}")
EOF

阶段10：日志配置

# 测试日志输出
python manage.py shell << EOF
import logging
logger = logging.getLogger('django')
logger.warning('Test warning message')
logger.error('Test error message')
EOF

# 检查日志文件（如果已配置）
tail -f /var/log/django/django.log

阶段11：API文档（如果使用DRF）

# 生成模式
python manage.py generateschema --format openapi-json > schema.json

# 验证模式
# 检查schema.json是否为有效的JSON
python -c "import json; json.load(open('schema.json'))"

# 访问Swagger UI（如果使用drf-yasg）
# 在浏览器中访问 http://localhost:8000/swagger/

阶段12：差异审查

# 显示差异统计
git diff --stat

# 显示实际更改
git diff

# 显示更改的文件
git diff --name-only

# 检查常见问题
git diff | grep -i "todo\|fixme\|hack\|xxx"
git diff | grep "print("  # 调试语句
git diff | grep "DEBUG = True"  # 调试模式
git diff | grep "import pdb"  # 调试器

检查清单：

• 没有调试语句（print, pdb, breakpoint()）
• 关键代码中没有TODO/FIXME注释
• 没有硬编码的密钥或凭据
• 模型更改包含数据库迁移
• 配置更改已记录
• 外部调用存在错误处理
• 需要时进行事务管理

输出模板

DJANGO 验证报告
==========================

阶段1：环境检查
  ✓ Python 3.11.5
  ✓ 虚拟环境已激活
  ✓ 所有环境变量已设置

阶段2：代码质量
  ✓ mypy：无类型错误
  ✗ ruff：发现3个问题（已自动修复）
  ✓ black：无格式问题
  ✓ isort：导入已正确排序
  ✓ manage.py check：无问题

阶段3：迁移
  ✓ 无未应用的迁移
  ✓ 无迁移冲突
  ✓ 所有模型都有迁移

阶段4：测试 + 覆盖率
  测试：247通过，0失败，5跳过
  覆盖率：
    总体：87%
    users：92%
    products：89%
    orders：85%
    payments：91%

阶段5：安全扫描
  ✗ pip-audit：发现2个漏洞（需要修复）
  ✓ safety check：无问题
  ✓ bandit：无安全问题
  ✓ 未检测到密钥
  ✓ DEBUG = False

阶段6：Django命令
  ✓ collectstatic完成
  ✓ 数据库完整性正常
  ✓ 缓存后端可访问

阶段7：性能
  ✓ 未检测到N+1查询
  ✓ 数据库索引已配置
  ✓ 查询数量可接受

阶段8：静态资源
  ✓ npm audit：无漏洞
  ✓ 资源构建成功
  ✓ 静态文件已收集

阶段9：配置
  ✓ DEBUG = False
  ✓ SECRET_KEY已配置
  ✓ ALLOWED_HOSTS已设置
  ✓ HTTPS已启用
  ✓ HSTS已启用
  ✓ 数据库已配置

阶段10：日志
  ✓ 日志已配置
  ✓ 日志文件可写

阶段11：API文档
  ✓ 模式已生成
  ✓ Swagger UI可访问

阶段12：差异审查
  更改的文件：12
  +450, -120 行
  ✓ 无调试语句
  ✓ 无硬编码密钥
  ✓ 包含迁移

建议：警告：部署前请修复pip-audit漏洞

下一步：
1. 更新易受攻击的依赖
2. 重新运行安全扫描
3. 部署到预发布环境进行最终测试

预部署检查清单

• [ ] 所有测试通过
• [ ] 覆盖率 ≥ 80%
• [ ] 无安全漏洞
• [ ] 无未应用的迁移
• [ ] 生产设置中DEBUG = False
• [ ] SECRET_KEY已正确配置
• [ ] ALLOWED_HOSTS已正确设置
• [ ] 数据库备份已启用
• [ ] 静态文件已收集并提供
• [ ] 日志已配置并正常工作
• [ ] 错误监控（Sentry等）已配置
• [ ] CDN已配置（如适用）
• [ ] Redis/缓存后端已配置
• [ ] Celery工作进程正在运行（如适用）
• [ ] HTTPS/SSL已配置
• [ ] 环境变量已记录

持续集成

GitHub Actions示例

# .github/workflows/django-verification.yml
name: Django Verification

on: [push, pull_request]

jobs:
  verify:
    runs-on: ubuntu-latest
    services:
      postgres:
        image: postgres:14
        env:
          POSTGRES_PASSWORD: postgres
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5

    steps:
      - uses: actions/checkout@v3

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.11'

      - name: Cache pip
        uses: actions/cache@v3
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}

      - name: Install dependencies
        run: |
          pip install -r requirements.txt
          pip install ruff black mypy pytest pytest-django pytest-cov bandit safety pip-audit

      - name: Code quality checks
        run: |
          ruff check .
          black . --check
          isort . --check-only
          mypy .

      - name: Security scan
        run: |
          bandit -r . -f json -o bandit-report.json
          safety check --full-report
          pip-audit

      - name: Run tests
        env:
          DATABASE_URL: postgres://postgres:postgres@localhost:5432/test
          DJANGO_SECRET_KEY: test-secret-key
        run: |
          pytest --cov=apps --cov-report=xml --cov-report=term-missing

      - name: Upload coverage
        uses: codecov/codecov-action@v3

快速参考

检查项	命令
环境	python --version
类型检查	mypy .
代码检查	ruff check .
格式化	black . --check
迁移	python manage.py makemigrations --check
测试	pytest --cov=apps
安全	pip-audit && bandit -r .
Django检查	python manage.py check --deploy
收集静态文件	python manage.py collectstatic --noinput
差异统计	git diff --stat

请记住：自动化验证可以捕获常见问题，但不能替代手动代码审查和预发布环境中的测试。