具有 ORM 交互的单元测试 Go 函数答案

【问题标题】：Unit Testing Go Functions having ORM interactions具有 ORM 交互的单元测试 Go 函数
【发布时间】：2019-02-12 10:58:46
【问题描述】：

我写了一个函数：

func AllItems(w http.ResponseWriter, r *http.Request) {
    db, err := gorm.Open("sqlite3", "test.db")
    if err != nil {
        panic("failed to connect database")
    }
    defer db.Close()

    var items [] Item
    db.Find(&items)
    fmt.Println("{}", items)

    json.NewEncoder(w).Encode(items)
}

我想对此进行单元测试。理想情况下，单元测试意味着函数的每一行都需要测试。我不确定我应该如何测试数据库连接是否打开，然后它是否显示数据库的所有内容。我应该如何测试这段代码？

此函数是简单 CRUD 应用程序的 GET 端点。代码是here。

【问题讨论】：

不确定如何在 Go 中执行此操作，评论只是一个旁注。也许在内存中使用 sqlite3 可能更好用 (:memory:)。

标签： unit-testing go mocking testify

【解决方案1】：

重构您的代码并将其分解为更小的、可测试的函数，您可以将依赖项传递给这些函数。还为依赖项创建接口以简化测试。

例如：

type myDatabaseInterface interface {
    Find(interface{}) // this signature should match the real db.Find()
}

func AllItems(w http.ResponseWriter, r *http.Request) {
    db, err := gorm.Open("sqlite3", "test.db")
    if err != nil {
        panic("failed to connect database")
    }
    defer db.Close()
    items := findItems(db)
    json.NewEncoder(w).Encode(items)
}

func find(db myDatabaseInterface) ([]Item) {
    var items []Item
    db.Find(&items)
    return items
}

然后您可以为您的依赖项创建模拟并在您的测试中使用它们：

type mock struct {}

// mock should implement myDatabaseInterface to be able to pass it to the function
func (m *mock) Find(interface{}) {
    // implement the mock to satisfy your test
}

func Test_find(t *testing.T) {
    m := mock{}
    res := find(m)
    // do testing
}

而不是每次处理请求时都调用Open，也许你应该在外面打开它并让它对你的函数可用。这样处理程序就变得如此之小，无需真正对其进行测试：

func makeAllItemsHandler(db myDatabaseInterface) func(http.ResponseWriter, *http.Request) {
    return func(http.ResponseWriter, *http.Request) {
        items := findItems(db)
        json.NewEncoder(w).Encode(items)
    }
}

然后，您可以在设置应用程序时一劳永逸地创建一个数据库，并将其传递给需要它的函数，从而消除函数中难以测试的代码。

【讨论】：