Go代码如何单元测试与 Elasticsearch 交互

单元测试与 Elasticsearch 交互的 Go 代码至关重要。本文探讨了如何使用存根 HTTP 响应对与 Elasticsearch 客户端交互的代码进行单元测试。通过更改客户端创建函数以接受 HTTP 客户端并编写实现 Elastic.Doer 接口的存根 HTTP 客户端，可以模拟 Elastic.Client 并提供存根响应。这使开发人员能够隔离和测试特定代码路径，从而提高代码质量和可靠性。

我有一个应用程序，它定义了 type 客户端结构 {}，它与我的代码中的各种其他客户端进行通信，这些客户端与 github、elasticsearch 等服务进行通信。

现在我的一个包中有以下 es 代码

type SinkService interface {
    Write(context, index, mapping, doc)
}

type ESSink struct {
   client *elastic.Client
}

func NewESSink() *ESSink {}

 // checks if the index exists and writes the doc
func (s *ESSink) Write(context, index, mapping, doc) {}

我在运行整个应用程序的主客户端中使用此方法，如 c.es.write(...)。现在，如果我想编写 client_test.go，我可以简单地制作一个 mockessink 并将其与一些存根代码一起使用，但这不会覆盖我的 es 代码中编写的行。

如何对我的 es 代码进行单元测试？我的 essink 使用 elastic.client。我该如何嘲笑它？

我想嵌入一些模拟 es 客户端，它可以为我提供存根响应，这样我就可以通过这种方式测试我的 essink.write 方法。

解决方案

根据您的问题，我假设您使用的是 github.com/olivere/elastic，并且您希望能够使用存根 http 响应进行测试。当我第一次看到这个问题时，我也从未编写过使用 es 客户端的 go 测试代码。所以，除了回答这个问题之外，我还分享一下我是如何从 godocs 中找到答案的。

首先，我们可以看到 elastic.NewClient 接受客户端选项函数。所以我检查了该库提供了什么样的客户端选项函数。结果该库提供了接受 elastic.Doer 的 elastic.SetHttpClient。 doer 是 http.client 可以实现的接口。从这里开始，答案就清晰了。

所以，你必须：

1. 更改您的 func newessink() 以接受 http 客户端或弹性客户端。
2. 编写存根http客户端（实现elastic.doer）。

essink

type essink struct {
    client *elastic.client
}

func newessink(client *elastic.client) *essink {
    return &essink{client: client}
}

存根 httpclient

package stubs

import "net/http"

type httpclient struct {
    response *http.response
    error    error
}

func (c *httpclient) do(*http.request) (*http.response, error) {
    return c.response, c.error
}

您的测试代码

func TestWrite(t *testing.T) {
    // set the body and error according to your test case
    stubHttpClient := stubs.HTTPClient{ 
        Response: &http.Response{Body: ...},
        Error: ...,
    }

    elasticClient := elastic.NewClient(elastic.SetHttpClient(stubHttpClient))
    esSink := NewESSink(elasticClient)
    esSink.Write(...)
}

在您的生产代码中，您可以在设置 es http 客户端时使用 http.client{}。

今天关于《Go代码如何单元测试与 Elasticsearch 交互》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！