嘲弄方法

Question

我正在写一个小POC去上班，但我似乎无法弄清楚嘲弄的技巧。这是我到目前为止...

connect.go

package db

import (
    "database/sql"
    "encoding/json"
    "fmt"
    "io/ioutil"
    "strings"

    _ "github.com/lib/pq"
)

type config map[string]interface{}

type DbConn struct {
    db db
}

type db interface {
    getConnectionStringFromConfig(file string) (connStr string, err error)
}

func NewDbConn(d db) *DbConn {
    return &DbConn{db: d}
}

func getConnectionStringFromConfig(file string) (connStr string, err error) {
    var c config
    var bt []byte
    if bt, err = ioutil.ReadFile(file); err != nil {
        fmt.Printf("Error Reading config file: %v", err)
        return
    }
    fmt.Println("Finish reading file. Going to construct a connection string")
    if err = json.Unmarshal(bt, &c); err != nil {
        fmt.Printf("Error unmarshalling config file: %v", err)
        return
    }
    connStr = strings.TrimLeft(getConfigAsString(c), " ")
    return
}

func getConfigAsString(c config) (connStr string) {
    for k, v := range c {
        connStr += strings.Join([]string{" " + k, v.(string)}, "=")
    }
    return
}

// Connect database connection
func (dbConn DbConn) Connect() (conn *sql.DB, err error) {
    fmt.Println("Starting database connection...")
    connStr, err := getConnectionStringFromConfig("path/to/conf.json")
    if err != nil {
        return
    }
    conn, err = sql.Open("some_driver", connStr)
    return
}

connect_test.go

package db

import (
    "errors"
    "testing"
)

type dbConnMock struct {
    db dbMock
}

type dbMock interface {
    getConnectionStringFromConfig(file string) (connStr string, err error)
}

func (dbm dbConnMock) getConnectionStringFromConfig(file string) (connStr string, err error) {
    return "", errors.New("123")
}

// should not throw error when trying to open db connection
func TestDatabaseConnection(t *testing.T) {
    dbCon := &DbConn{}
    _, err := dbCon.Connect()
    if err != nil {
        t.Errorf("test failed. \n %d", err)
    }
}

func TestDatabaseConnectionFail(t *testing.T) {
    var dm dbMock
    dbCon := NewDbConn(dm)
    _, err := dbCon.Connect()
    if err == nil {
        t.Errorf("test failed. %d", err)
    }
}

如您所见，这是一个简单的数据库连接逻辑，我使用接口进行测试和模拟。我想覆盖100％的代码，所以我必须模拟某些方法。上面的代码虽然有效，但第二次测试失败了，可能是因为我试图嘲笑它时遗漏了一些东西。请帮忙..

Answer 1

你可以做一些事情。

---

Simple way

如果你想保持简单，你可以做的是让你的模拟结构有应该返回的字段，并在每个测试用例中你将这些字段设置为你的模拟应该为该测试用例返回的内容。

这样，您可以以不同的方式使您的模拟成功或失败。

此外，你不需要dbMock接口，因为dbConnMock实现了db接口，这就是你所需要的。

这是你的模拟看起来像：

type dbConnMock struct {
    FileCalled string

    connStr string
    err error
}

func (dbm dbConnMock) getConnectionStringFromConfig(file string) (connStr string, err error) {
    dbm.FileCalled = file
    return dbm.connStr, dbm.err
}

现在，您可以使用FileCalled验证是否使用期望参数调用了您的方法，并且可以使其具有您想要模拟的行为。

如果您还想确保只调用一次方法，您还可以添加一个计数器来查看它被调用的次数。

---

Using a mocking library

如果您不想担心编写该逻辑，可以使用一些库来为您执行此操作，例如testify/mock。

这是一个使用testify/mock如何使用简单模拟的示例：

type dbMock struct {
    mock.Mock
}

func (m *dbMock) getConnectionStringFromConfig(file string) (string, error) {
    args := m.Called(file)

    return args.String(0), args.Error(1)
}

func TestSomething(t *testing.T) {
    tests := []struct {
        description string

        connStr string
        err error

        expectedFileName string

        // add expected outputs and inputs of your tested function
    }{
        {
            description: "passing test",

            connStr: "valid connection string",
            err: nil,

            expectedFileName: "valid.json",
        },
        {
            description: "invalid file",

            connStr: "",
            err: errors.New("invalid file"),

            expectedFileName: "invalid.json",
        },
    }

    for _, test := range tests {
        t.Run(test.description, func(t *testing.T) {

            dbMock := &dbConnectionMock{}
            dbMock.
                On("getConnectionStringFromConfig", test.expectedFileName).
                Return(test.connStr, test.err).
                Once()

            thing := &Something{
                db: dbMock,
            }

            output, err := thing.doSomething()

            // assert that output and err are expected

            dbMock.AssertExpectations(t) // this will make sure that your mock is only used as expected in your test, depending on your `On` calls
        })
    }
}

此代码确保您的方法被调用一次并使用特定参数，并使其返回测试用例中指定的内容。