如何为使用pgxpool的Go代码编写PostgreSQL相关单元测试

pgxpoolmock 类型不兼容问题修复 #

你遇到的类型无法转换问题核心原因是 生产代码直接依赖了*pgxpool.Pool具体实现类型，pgxpoolmock的实例和官方pgxpool的实例是两个完全独立的结构体，没有继承/实现关系，自然无法直接转换，按以下步骤即可解决：

• 第一步：基于业务用到的数据库操作，自定义抽象接口，不要直接耦合pgxpool的具体实现

  // 按你实际用到的方法补充接口签名，不需要把pgxpool所有方法都加进来
  type DBPool interface {
      Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
      Exec(ctx context.Context, sql string, args ...any) (pgconn.CommandTag, error)
      Acquire(ctx context.Context) (*pgxpool.Conn, error)
      Close()
  }
  

• 第二步：将生产代码中所有接收*pgxpool.Pool参数的位置，全部替换为上面定义的DBPool接口类型。官方*pgxpool.Pool天然实现了该接口，生产环境运行不需要做任何额外适配。
• 第三步：单元测试时直接将pgxpoolmock生成的mock实例作为DBPool接口传入业务代码即可，不需要做任何类型转换。

其他可选测试方案 #

如果你不想使用接口抽象+mock的方案，也可以选择以下两种更贴近真实运行场景的测试方案：

1. 临时PostgreSQL容器方案（推荐用于核心逻辑测试） #

使用testcontainers-go在测试启动时拉起一个轻量的PostgreSQL Docker容器，初始化测试库和表结构后拿到真实的*pgxpool.Pool实例直接用于测试，测试结束后自动销毁容器，完全不需要mock，不会出现mock逻辑和真实数据库行为不一致的问题，尤其适合测试复杂SQL、事务、索引相关逻辑。

2. go-mocket 驱动层mock方案 #

go-mocket是在数据库驱动层做拦截的mock工具，原生支持pgx v4/v5版本，不需要修改生产代码的依赖定义，只需要在测试初始化时开启mocket拦截，预设对应SQL的返回结果即可，代码改造成本极低。 #

内容的提问来源于stack exchange，提问作者Farhan Yusufzai