在 Go 中测试构造函数

Question

如何为我的Client 结构测试我的NewClient 构造函数？

package busybus

import (
    "bufio"
    "net"
)

type Client struct {
    counter  integer
    conn     net.Conn
    bufin    *bufio.Reader
    bufout   *bufio.Writer
    messages chan string
    state    string
}

func NewClient(conn net.Conn, messages chan string) *Client {
    return &Client{
        counter:  0,
        conn:     conn,
        bufin:    bufio.NewReader(conn),
        bufout:   bufio.NewWriter(conn),
        messages: messages,
        state:    "waiting",

    }
}

我尝试了一些这样的测试：

package busybus

import (
    "net"
    "testing"
)

func TestNewClient(t *testing.T) {
    ln, _ := net.Listen("tcp", ":65535")
    conn, _ := ln.Accept()
    messages := make(chan string)

    client := NewClient(conn, messages)
    if client.conn != conn {
        t.Errorf("NewClient(%q, %q).conn == %q, want %q", conn, messages, client.conn, conn)
    }
}

但是由于ln.Accept，这在测试运行期间挂起，无论如何这似乎是一个完全错误的方法......有什么建议我可以测试这个构造函数吗？

Answer 1

有些代码非常简短，以至于确保测试正确比确保代码本身正确更复杂。 你的构造函数就是这样的代码。

我要做的要么根本不测试它，要么只是调用它（使用net.Conn 的一些虚拟实现）以确保它在调用时不会冒烟（因此称为烟雾测试）。

稍后您可以将其作为更大测试（集成测试）的一部分进行测试，您可以在其中连接一个真实的服务器，并使用您的客户端结构与之对话。

如果您发现由于此构造函数导致的错误，请首先添加一个测试来演示该问题，然后修复它。然后您将进行测试:-)

测试应该检查构造函数是否“按预期工作”。检查client.conn 的值几乎不会检查任何预期的行为，因为未导出字段的值不是行为。它只是检查结构和构造函数是如何实现的，而不是它实现了什么。测试什么，而不是如何。

顺便说一句，您可以在客户端中嵌入 *ReadWriter。

client.buf = bufio.NewReadWriter(...)

Answer 2

除了@bjarke-ebert 所说的。

Go 中没有构造函数，它们只是普通函数。像测试任何其他功能一样测试它们。如果一个功能太复杂而无法测试，那么可能有一种方法可以更改设计以使其更易于测试。

根据我的经验，过多检查内部实现细节的测试（例如问题中的测试）很难维护，因为它们需要不断更新。