单元测试 Postgres 数据库连接 golang

Question

即使是为了推动基本的项目结构，我也应该有 80% 的测试覆盖率。我有点困惑如何为以下代码编写单元测试以连接到 postgres db 并 ping postgres 进行健康检查。有人能帮助我吗。

var postgres *sql.DB

// ConnectToPostgres func to connect to postgres

func ConnectToPostgres(connStr string) (*sql.DB, error) {

    db, err := sql.Open("postgres", connStr)

    if err != nil {

        log.Println("postgres-client ", err)

        return nil, err

    }

    postgres = db

    return db, nil

}

// PostgresHealthCheck to ping database and check for errors

func PostgresHealthCheck() error {

    if err := postgres.Ping(); err != nil {

        return err

    }

    return nil

}

type PostgresRepo struct {

    db *sql.DB

}

// NewPostgresRepo 构造函数

func NewPostgresRepo(database *sql.DB) *PostgresRepo {

    return &PostgresRepo{

        db: database,

    }

}

Answer 1

你需要使用这个：https ://github.com/DATA-DOG/go-sqlmock它非常易于使用。这是一个使用模拟 SQL 测试控制器的示例：执行func (up UserProvider) GetUsers() ([]models.User, error) {    var users = make([]models.User, 0, 10)    rows, err := up.DatabaseProvider.Query("SELECT firstname, lastname, email, age FROM Users;")    if err != nil {        return nil, err    }    for rows.Next() {        var u models.User = models.User{}        err := rows.Scan(&u.Name, &u.Lastname, &u.Email, &u.Age)        if err != nil {            return nil, err        }        users = append(users, u)    }    if err := rows.Err(); err != nil {        return nil, err    }    return users, nil}测试func TestGetUsersOk(t *testing.T) {    db, mock := NewMock()    mock.ExpectQuery("SELECT firstname, lastname, email, age FROM Users;").        WillReturnRows(sqlmock.NewRows([]string{"firstname", "lastname", "email", "age"}).            AddRow("pepe", "guerra", "[e-mail]", 34))    subject := UserProvider{        DatabaseProvider: repositories.NewMockDBProvider(db, nil),    }    resp, err := subject.GetUsers()    assert.Nil(t, err)    assert.NotNil(t, resp)    assert.Equal(t, 1, len(resp))}func NewMock() (*sql.DB, sqlmock.Sqlmock) {    db, mock, err := sqlmock.New()    if err != nil {        log.Fatalf("an error '%s' was not expected when opening a stub database connection", err)    }    return db, mock}

Answer 2

我发现针对实时数据库编写测试可以实现更高质量的测试。Postgres 面临的挑战是没有可以替代的好的内存伪造品。我想出的是建立 postgres Docker 容器并在其中创建临时数据库。github.com/bitcomplete/sqltestutil包中的PostgresContainer类型正是这样做的：# Postgres version is "12"pg, _ := sqltestutil.StartPostgresContainer(context.Background(), "12")defer pg.Shutdown(ctx)db, err := sql.Open("postgres", pg.ConnectionString())// ... execute SQL根据文档，设置测试以便容器只启动一次是个好主意，因为启动可能需要几秒钟（如果需要下载图像则需要更多时间）。它提出了一些缓解该问题的方法。