如何编写表驱动测试实现Dbconn函数100%覆盖率并修复测试失败

问题背景 #

尝试为Go语言的数据库连接函数编写表驱动测试，但测试仅能达到75%覆盖率，且执行测试时失败报错，需要实现100%覆盖率的正确测试代码。

原数据库连接函数代码 #

func Dbconn() (*sql.DB, error) {
    db, err := sql.Open("postgres", "postgres:root@tcp(localhost:5432)/customer_complaints?multistatements=true")
    if err != nil {
        return nil, err
    }
    return db, nil
}

当前测试用例代码 #

package models

import (
    "database/sql"
    "reflect"
    "testing"

    _ "github.com/lib/pq"
)

func TestDbconn(t *testing.T) {
    db, _ := sql.Open("postgres", "postgres:root@tcp(localhost:5432)/customer_complaints?multistatements=true")
    tests := []struct {
        name    string
        want    *sql.DB
        wantErr bool
    }{
        {
            name:    "Success connection",
            want:    db,
            wantErr: false,
        },
    }
    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            got, err := Dbconn()
            if (err != nil) != tt.wantErr {
                t.Errorf("Dbconn() error = %v, wantErr %v", err, tt.wantErr)
                return
            }
            if !reflect.DeepEqual(got, tt.want) {
                t.Errorf("Dbconn() = %v, want %v", got, tt.want)
            }
        })
    }
}

测试执行报错信息 #

go test -v --cover
=== RUN   TestDbconn
=== RUN   TestDbconn/Success_connection
db_test.go:32: Dbconn() = &{{{} {} 0} {postgres:root@tcp(localhost:5432)/customer_complaints?multistatements=true 0x8d4730} {{} {} 0} {0 0} [] map[] 0 0 0xc0000824e0 false map[] map[] 0 0 0 0 <nil> 0 0 0 0 0x50f1a0}, want &{{{} {} 0} {postgres:root@tcp(localhost:5432)/customer_complaints?multistatements=true 0x8d4730} {{} {} 0} {0 0} [] map[] 0 0 0xc000082420 false map[] map[] 0 0 0 0 <nil> 0 0 0 0 0x50f1a0}
--- FAIL: TestDbconn (0.00s)
    --- FAIL: TestDbconn/Success_connection (0.00s)
        coverage: 75.0% of statements exit status 1

问题分析 #

1. 测试失败原因：用reflect.DeepEqual比较两个*sql.DB实例不合理，每次调用sql.Open都会创建新的DB对象，内部内存地址等状态不同，导致深层相等性检查失败。
2. 覆盖率不足原因：仅覆盖了连接成功的分支，未覆盖sql.Open返回错误的分支，因此覆盖率仅75%。

修复方案 #

第一步：重构原函数 #

将硬编码的DSN改为参数传入，方便测试时灵活切换有效/无效连接字符串，触发不同代码分支：

func Dbconn(dsn string) (*sql.DB, error) {
    db, err := sql.Open("postgres", dsn)
    if err != nil {
        return nil, err
    }
    return db, nil
}

第二步：编写正确的测试代码 #

调整测试逻辑，不再比较DB实例的深层相等，而是验证状态正确性，同时添加错误分支测试用例：

package models

import (
    "database/sql"
    "testing"

    _ "github.com/lib/pq"
)

func TestDbconn(t *testing.T) {
    validDSN := "postgres:root@tcp(localhost:5432)/customer_complaints?multistatements=true"
    invalidDSN := "invalid-dsn-for-test"

    tests := []struct {
        name    string
        dsn     string
        wantErr bool
    }{
        {
            name:    "成功连接数据库",
            dsn:     validDSN,
            wantErr: false,
        },
        {
            name:    "无效DSN导致连接失败",
            dsn:     invalidDSN,
            wantErr: true,
        },
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            got, err := Dbconn(tt.dsn)
            
            // 验证错误状态是否符合预期
            if (err != nil) != tt.wantErr {
                t.Errorf("Dbconn() error = %v, wantErr %v", err, tt.wantErr)
                return
            }

            // 成功场景：DB实例不能为nil
            if !tt.wantErr && got == nil {
                t.Error("Dbconn() 成功连接时返回了nil DB实例")
            }

            // 失败场景：DB实例必须为nil
            if tt.wantErr && got != nil {
                t.Error("Dbconn() 连接失败时返回了非nil DB实例")
            }
        })
    }
}

修复说明 #

• 重构函数后，测试可以通过传入不同DSN覆盖所有代码分支，实现100%覆盖率。
• 放弃比较*sql.DB实例的深层相等，改为验证实例状态和错误状态，符合数据库连接测试的合理逻辑。

内容的提问来源于stack exchange，提问作者Venukishore.R