如何在 Golang 的单元测试中测试 net.Conn？答案

【问题标题】：How does one test net.Conn in unit tests in Golang?如何在 Golang 的单元测试中测试 net.Conn？
【发布时间】：2015-08-21 17:05:01
【问题描述】：

我目前正在考虑为 Go 中的 net.Conn 接口以及在该功能之上构建的其他函数创建一些单元测试，我想知道在 Go 中进行单元测试的最佳方法是什么谷歌去？我的代码如下：

conn, _:=net.Dial("tcp", "127.0.0.1:8080")
...
fmt.Fprintf(conn, "test")
...
buffer:=make([]byte, 100)
conn.Read(buffer)

测试此代码和使用这些函数的代码启动一个单独的 goroutine 以像服务器一样运行的最有效方法是使用 net.http.httptest package 还是其他方式？

【问题讨论】：

建议阅读实际net 库的测试源。过去，我通过这样做获得了很多技巧。其次，正如您已经提到的，使用 httptest 包。
在单元测试中有几个mocking的库，看看这篇文章的提示stackoverflow.com/questions/19167970/mock-functions-in-golang

标签： unit-testing testing tcp go

【解决方案1】：

虽然这将取决于您的特定案例的实现细节，但一般的方法是启动一个服务器（在一个单独的 goroutine 中，正如您已经暗示的那样），并监听传入的连接。

例如，让我们启动一个服务器并验证我们从连接中读取的内容确实是我们从客户端发送的内容：

func TestConn(t *testing.T) {
    message := "Hi there!\n"

    go func() {
        conn, err := net.Dial("tcp", ":3000")
        if err != nil {
            t.Fatal(err)
        }
        defer conn.Close()

        if _, err := fmt.Fprintf(conn, message); err != nil {
            t.Fatal(err)
        }
    }()

    l, err := net.Listen("tcp", ":3000")
    if err != nil {
        t.Fatal(err)
    }
    defer l.Close()
    for {
        conn, err := l.Accept()
        if err != nil {
            return
        }
        defer conn.Close()

        buf, err := ioutil.ReadAll(conn)
        if err != nil {
            t.Fatal(err)
        }

        fmt.Println(string(buf[:]))
        if msg := string(buf[:]); msg != message {
            t.Fatalf("Unexpected message:\nGot:\t\t%s\nExpected:\t%s\n", msg, message)
        }
        return // Done
    }

}

请注意，这里我不是在 goroutine 中启动服务器，否则测试用例很可能在侦听器运行测试之前完成。

【讨论】：

【解决方案2】：

您也许可以使用 net.Pipe 做您需要的事情，它基本上为您提供了连接的两端（想想，在 .Accept() 之后）

server, client := net.Pipe()
go func() {
  // Do some stuff
  server.Close()
}()

// Do some stuff
client.Close()

【讨论】：

这是在不启动服务器的情况下测试 tcp 连接的最佳答案。恕我直言，应该是被接受或至少获得更多投票的答案。谢谢！
是的，这是天才！您不需要实际使用 TCP 的开销。理论上，您可以使用此设计并行化您的测试运行，因为它不会从操作系统保留全局端口。
您还可以查看“google.golang.org/grpc/test/bufconn” - 它在 net.Dialer 中实现内存中的 net.Listener，其中连接是“管道”，但与 net.Dialer 不同。管道它们也被缓冲，这使得它们在某些情况下更容易使用。
您能否举例说明如何在此示例中使用这种方法测试 WebSocket 连接（大猩猩）。
与net.pipestackoverflow.com/questions/36932741/…相关的例子

【解决方案3】：

另一个选项是counterfeiter 包，它允许您从接口创建模拟，然后您可以存根您需要的任何调用。我已经成功地使用它来存根 net.Conn 实例，我正在测试 Geode 的 protobuf 客户端。

例如 - https://github.com/gemfire/geode-go-client/blob/master/connector/protobuf_test.go

【讨论】：