⚡

Django验证循环Skill django-verification

Django验证循环是一个全面的质量保证流程，用于在代码合并或部署前对Django项目进行系统化验证。该技能涵盖环境检查、代码质量分析、数据库迁移验证、测试覆盖率评估、安全漏洞扫描、性能优化检查、配置审查等12个关键阶段。通过自动化脚本和检查清单，确保Django应用程序的稳定性、安全性和可维护性，特别适用于CI/CD流水线集成和团队协作开发场景。

DevOps 0 次安装 0 次浏览 更新于 2/27/2026

name: django-verification description: Django项目验证循环：发布或PR前的迁移、代码检查、带覆盖率的测试、安全扫描和部署就绪检查。

Django 验证循环

在PR前、重大变更后、部署前执行，确保Django应用程序的质量和安全性。

阶段1: 环境检查

# 检查Python版本
python --version  # 应与项目要求一致

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

# 检查环境变量
python -c "import os; import environ; print('DJANGO_SECRET_KEY已设置' if os.environ.get('DJANGO_SECRET_KEY') else '缺失: 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 Debug Toolbar输出（检查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('测试警告消息')
logger.error('测试错误消息')
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验证

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: 设置Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.11'

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

      - name: 安装依赖项
        run: |
          pip install -r requirements.txt
          pip install ruff black mypy pytest pytest-django pytest-cov bandit safety pip-audit

      - name: 代码质量检查
        run: |
          ruff check .
          black . --check
          isort . --check-only
          mypy .

      - name: 安全扫描
        run: |
          bandit -r . -f json -o bandit-report.json
          safety check --full-report
          pip-audit

      - name: 运行测试
        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: 上传覆盖率
        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

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