你如何测试在 Go 中调用另一个 API 端点的服务？

Question

我有一个使用无限循环创建的简单服务来定期调用某个 HTTP API，在包aservice 中实现。我在那里创建了一个 Service 结构。通常，为了运行该服务，我公开了一个 StartService 方法，该方法用于同步运行该服务。然后，包的用户可以使用 goroutine 运行它。我的问题是，你如何为这种场景编写测试？

您是否运行整个系统并“模拟”API？我听说使用 3rd 方服务的代码不需要测试，但是整个 aservice 包可能只包含 StartService 和 Shutdown 方法。其余的是未导出的函数/方法，因此无法单独测试。如果是这样，那我根本不能写任何测试？

Answer 1

使用 Go，您将在模拟外部 http 请求时获得很棒的体验。长话短说，只需用 net/http/httptest 包中的服务器 url 替换基本 url。 您可以模仿 Google 模拟其外部请求的方式，例如在 google maps here 中探索测试。

server := mockServer(200, response)
defer server.Close()
c, _ := NewClient(WithAPIKey(apiKey), WithBaseURL(server.URL))
r := &DirectionsRequest{
    Origin:      "Google Sydney",
    Destination: "Glebe Pt Rd, Glebe",
    Mode:        TravelModeTransit,
}

resp, _, err := c.Directions(context.Background(), r) 
// your assertions goes here


 // Create a mock HTTP Server that will return a response with HTTP code and body.
func mockServer(code int, body string) *httptest.Server {
    server := mockServerForQuery("", code, body)
    return server.s
}

func mockServerForQuery(query string, code int, body string) *countingServer {
    server := &countingServer{}

    server.s = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        if query != "" && r.URL.RawQuery != query {
            dmp := diffmatchpatch.New()
            diffs := dmp.DiffMain(query, r.URL.RawQuery, false)
            log.Printf("Query != Expected Query: %s", dmp.DiffPrettyText(diffs))
            server.failed = append(server.failed, r.URL.RawQuery)
            http.Error(w, "fail", 999)
            return
        }
        server.successful++

        w.WriteHeader(code)
        w.Header().Set("Content-Type", "application/json; charset=UTF-8")
        fmt.Fprintln(w, body)
    }))

    return server
}