为带有超时的单元测试创​​建一个deadlineExceededError：true

php小编小新在这里为大家介绍一个有关单元测试的技巧：为带有超时的单元测试创建一个deadlineExceededError：true。在进行单元测试时，有时可能会遇到测试执行超时的情况，这时我们可以通过设置deadlineExceededError为true来解决这个问题。这个技巧可以帮助我们更好地控制和管理测试的执行时间，确保测试的准确性和可靠性。接下来，我们将详细介绍如何使用这个技巧来提升单元测试的效率和可靠性。

问题内容

我正在尝试在我的项目中创建一个单元测试，在其中模拟 http 客户端并设置客户端必须返回的响应。 我需要这样的行为，因为我的代码需要做出相应的行为，以防 http 客户端因超时而失败：因此我需要模拟 http 客户端以返回一个 deadlineexceedederror 并从中进行单元测试。

到目前为止，我尝试的是以 client.do 返回的方式模拟客户端 do 函数：

getdofunc = func(*http.request) (*http.response, error) {
    return nil, &url.error{
        op:  "post",
        err: context.deadlineexceeded,
    }
}

它可以工作，但不完全，这意味着当我以这种模拟行为执行代码时，返回的错误类型是：

error(*net/url.error) *{op: "post", url: "", err: error(context.deadlineexceedederror) {}}

这又是正确的，但不完全。为什么？因为如果我运行代码并且发生真正的超时，我会得到更完整的东西：

error(*net/url.Error) *{Op: "Post", URL: "http://localhost:4500/scan/", Err: error(*net/http.httpError) *{err: "context deadline exceeded (Client.Timeout exceeded while awaiting headers)", timeout: true}}

最让我感兴趣的是timeout: true。如果我设法告诉我的模拟返回它，我可以断言这一点，我发现这比仅断言返回的错误是 deadlineexceedederror 类型更完整。

解决方法

为了避免测试过于复杂，我建议您采用这种方法。首先，首先定义您的错误：

type timeouterror struct {
    err     string
    timeout bool
}

func (e *timeouterror) error() string {
    return e.err
}

func (e *timeouterror) timeout() bool {
    return e.timeout
}

这样，timeouterror就同时实现了error()和timeout接口。
然后您必须为 http 客户端定义模拟：

type mockclient struct{}

func (m *mockclient) do(req *http.request) (*http.response, error) {
    return nil, &timeouterror{
        err:     "context deadline exceeded (client.timeout exceeded while awaiting headers)",
        timeout: true,
    }
}

这只是返回上面定义的错误和 nil 作为 http.response。最后，让我们看看如何编写示例单元测试：

func TestSlowServer(t *testing.T) {
    r := httptest.NewRequest(http.MethodGet, "http://example.com", nil)
    client := &mockClient{}

    _, err := client.Do(r)

    fmt.Println(err.Error())
}

如果您调试此测试并在 err 变量上使用调试器暂停，您将看到想要的结果。
通过这种方法，您可以实现所需的功能，而无需带来任何额外的复杂性。让我知道是否适合您！

以上是为带有超时的单元测试创​​建一个deadlineExceededError：true的详细内容。更多信息请关注PHP中文网其他相关文章！