Database 如何在没有sqlmock的情况下模拟db ping

发布于04月01日

我想了解如何重构我的代码，例如使用mock.Mock来模拟db.Ping().我想先了解一下没有框架的概念.

下面是我要测试的代码:

func Connect() (*sql.DB, error) {

    db, err := sql.Open("mysql", "root:secret@tcp(s-maria-db)/s_db")

    if err != nil {
        return nil, err
    }

    for i := 0; i < 60; i++ {
        // I am hoping to mock this portion
        if err := db.Ping(); err == nil {
            break
        }
        time.Sleep(time.Second)
    }

    return db, nil
}

我try 了这个帖子How to mock a ping command，但这并没有真正回答这个问题.如果是这样，我就不理解解决方案，因为它适用于我的代码.

推荐答案

您需要使用一个单独的函数来执行ping操作，并且它需要接受一个接口，这样您就可以有条件地传入真实的*sql.DB或模拟的.这是因为您不能重写 struct 上的方法.

// Connect opens a connection to the database.
func Connect() (*sql.DB, error) {
    return sql.Open("mysql", "root:secret@tcp(s-maria-db)/s_db")
}

// Pinger defines an interface for pinging.
type Pinger interface {
    Ping() error
}

// Ping attempts to ping the database, trying several times before failing.
func Ping(p Pinger) error {
    const maxAttempts = 60
    var err error
    for i := 0; i < maxAttempts; i++ {
        if err = p.Ping(); err == nil {
            return nil
        }
        if i < maxAttempts - 1 {
            time.Sleep(time.Second)
        }
    }
    return err
}

func main() {
    if err := run(); err != nil {
        log.Fatal(err)
    }
}

func run() error {
    db, err := Connect()
    if err != nil {
        return fmt.Errorf("connecting to db: %w", err)
    }
    defer db.Close()

    if err = Ping(db); err != nil {
        return fmt.Errorf("pinging db: %w", err)
    }
    
    ...
}

type mockDB struct {
    mock.Mock
}

func (m *mockDB) Ping() error {
    args := m.Called()
    return args.Error(0)
}

func TestPing(t *testing.T) {
    db := &mockDB{}
    db.On("Ping").Return(...)

    err := Ping(db)

    ...
    db.AssertExpectations(t)
}