Ent项目持续集成(CI)实践指南-优快云博客

Ent项目持续集成(CI)实践指南

ent ent: 是一个基于 Go 语言的轻量级 ORM 库，用于处理关系型数据库。适合开发者使用 ent 进行数据库访问和操作。项目地址: https://gitcode.com/gh_mirrors/en/ent

什么是持续集成(CI)

持续集成(Continuous Integration)是现代软件开发中确保代码质量的重要实践。通过CI流程，开发团队可以在每次代码变更时自动运行一系列验证检查，包括但不限于：

代码编译验证
代码风格检查
单元测试执行
安全扫描
其他自动化质量保证措施

对于使用Ent框架的项目来说，由于其特有的代码生成机制和数据库迁移特性，需要一些专门的CI验证策略。

Ent项目CI的核心检查项

1. 验证生成的代码已提交

Ent框架高度依赖代码生成功能，最佳实践要求将生成的代码一并提交到版本控制系统中，这样做有两个重要原因：

代码可读性：生成的代码与业务代码一起提交，便于代码审查和项目浏览时获得完整的功能视图
环境一致性：避免"在我机器上能运行"的问题，确保团队成员使用完全相同的代码库

实现方案

方案一：使用专用CI工具

name: EntCI
on:
  push:
    branches:
      - master
  pull_request:
    paths:
      - 'ent/*'
jobs:
  ent:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3.0.1
      - uses: actions/setup-go@v3
        with:
          go-version: 1.18
      - uses: ent/contrib/ci@master

方案二：使用Bash脚本

go generate ./...
status=$(git status --porcelain)
if [ -n "$status" ]; then
    echo "需要执行'go generate ./...'并提交变更"
    echo "$status"
    exit 1
fi

2. 迁移文件Lint检查

当Ent项目使用版本化迁移管理数据库变更时，迁移文件的Lint检查变得尤为重要：

SQL有效性验证：在测试数据库容器中重放迁移目录，确保所有SQL语句有效且顺序正确
迁移目录完整性：确保迁移历史未被意外修改，并行开发的迁移被正确合并
高风险变更检测：提前发现可能导致生产环境数据问题的变更
数据依赖变更检测：识别可能在部署时失败需要特别关注的变更

实现方案

针对不同数据库的Lint检查配置示例：

MySQL配置示例

name: Atlas CI
on:
  push:
    branches:
      - master
  pull_request:
    paths:
      - 'ent/migrate/migrations/*'
jobs:
  lint:
    services:
      mysql:
        image: mysql:8.0.29
        env:
          MYSQL_ROOT_PASSWORD: pass
          MYSQL_DATABASE: test
        ports:
          - 3306:3306
        options: >-
          --health-cmd "mysqladmin ping -ppass"
          --health-interval 10s
          --health-start-period 10s
          --health-timeout 5s
          --health-retries 10
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3.0.1
        with:
          fetch-depth: 0
      - uses: ariga/atlas-action@v0
        with:
          dir: ent/migrate/migrations
          dir-format: golang-migrate
          dev-url: mysql://root:pass@localhost:3306/test

PostgreSQL配置示例

services:
  postgres:
    image: postgres:10
    env:
      POSTGRES_DB: test
      POSTGRES_PASSWORD: pass
    ports:
      - 5432:5432
    options: >-
      --health-cmd pg_isready
      --health-interval 10s
      --health-timeout 5s
      --health-retries 5