使用简单的 http 处理程序测试所有路径

Question

我正试图在这个简单的 http 处理程序文件上获得 100% 的代码覆盖率。

文件写入默认响应 headers 如果成功，然后 returns 200 和 "Pong" 我在下面测试过。但是，也有可能写入默认值 headers 会产生错误，在这种情况下，预期会出现带有内部错误 body 的 500 响应。

我正在努力弄清楚如何在测试中触发 500 响应案例。如果出于某种原因将 writeDefaultHeaders 函数调用的第二个参数更改为 "html"，则该案例将失败，例如，因为 html 在我的服务中不是受支持的响应内容类型。

在代码中模拟此调用/命中此错误分支的惯用方法是什么？

谢谢。

ping_handler_test.go

package main

import (
    "net/http"
    "net/http/httptest"
    "testing"
)

func Test200PingHandler(t *testing.T) {
    req, _ := http.NewRequest("GET", "/ping", nil)
    w := httptest.NewRecorder()

    PingHandler(w, req)

    if w.Code != http.StatusOK {
        t.Errorf("Ping Handler Status Code is NOT 200; got %v", w.Code)
    }

    if w.Body.String() != "Pong" {
        t.Errorf("Ping Handler Response Body is NOT Pong; got %v", w.Body.String())
    }
}

// This fails as it is the same setup as the passing success case
func Test500PingHandler(t *testing.T) {
    req, _ := http.NewRequest("GET", "/ping", nil)
    w := httptest.NewRecorder()

    PingHandler(w, req)

    if w.Code != http.StatusInternalServerError {
        t.Errorf("Ping Handler Status Code is NOT 500; got %v", w.Code)
    }

    if w.Body.String() != "Internal Server Error" {
        t.Errorf("Ping Handler Response Body is NOT Internal Server Error; got %v", w.Body.String())
    }
}

func BenchmarkPingHandler(b *testing.B) {
    for i := 0; i < b.N; i++ {
        req, _ := http.NewRequest("GET", "/ping", nil)
        w := httptest.NewRecorder()

        PingHandler(w, req)
    }
}

ping_handler.go

package main

import (
    "fmt"
    "net/http"
)

func PingHandler(w http.ResponseWriter, r *http.Request) {
    err := writeDefaultHeaders(w, "text")
    if err != nil {
        handleException(w, err)
        return
    }

    fmt.Fprintf(w, "Pong")
}

func writeDefaultHeaders(w http.ResponseWriter, contentType string) error {
    w.Header().Set("X-Frame-Options", "DENY")
    w.Header().Set("X-Content-Type-Options", "nosniff")
    w.Header().Set("X-XSS-Protection", "1;mode=block")

    switch contentType {
    case "text":
        w.Header().Set("Content-Type", "text/plain; charset=utf-8")
        return nil
    case "json":
        w.Header().Set("Content-Type", "application/json; charset=UTF-8")
        return nil
    default:
        return errors.New("Attempting to render an unknown content type")
    }
}

编辑另一个例子：

json_response, err := json.Marshal(response)
if err != nil {
    handleException(w, err)
    return
}

在这种情况下，如何测试 json.Marshal 返回错误？

Answer 1

除非我遗漏了某些东西，否则出现错误的方法是删除硬编码的 "text" 并将您作为 contentType 传递的任何内容作为请求中的内容。从请求中解析出来，然后将其传递给 writeDefaultHeaders。通过案例是 "text" 或 "json"，其他一切都应该给你你的错误，假设 handleException 按预期工作（你没有显示它）

示例（当然你不希望 "Content-Type" header 看起来像这样）

package main

import (
    "net/http"
    "net/http/httptest"
    "testing"
)

func Test200PingHandler(t *testing.T) {
    req, _ := http.NewRequest("GET", "/ping", nil)
    req.Header().Set("Content-Type", "text")
    //req.Header().Set("Content-Type", "json")
    w := httptest.NewRecorder()

    PingHandler(w, req)

    if w.Code != http.StatusOK {
        t.Errorf("Ping Handler Status Code is NOT 200; got %v", w.Code)
    }

    if w.Body.String() != "Pong" {
        t.Errorf("Ping Handler Response Body is NOT Pong; got %v", w.Body.String())
    }
}

// This fails as it is the same setup as the passing success case
func Test500PingHandler(t *testing.T) {
    req, _ := http.NewRequest("GET", "/ping", nil)
    req.Header().Set("Content-Type", "fail")
    w := httptest.NewRecorder()

    PingHandler(w, req)

    if w.Code != http.StatusInternalServerError {
        t.Errorf("Ping Handler Status Code is NOT 500; got %v", w.Code)
    }

    if w.Body.String() != "Internal Server Error" {
        t.Errorf("Ping Handler Response Body is NOT Internal Server Error; got %v", w.Body.String())
    }
}

主要

package main

import (
    "fmt"
    "net/http"
)

func PingHandler(w http.ResponseWriter, r *http.Request) {
    err := writeDefaultHeaders(w, req.Header().Get("Content-Type"))
    if err != nil {
        handleException(w, err)
        return
    }

    fmt.Fprintf(w, "Pong")
}

func writeDefaultHeaders(w http.ResponseWriter, contentType string) error {
    w.Header().Set("X-Frame-Options", "DENY")
    w.Header().Set("X-Content-Type-Options", "nosniff")
    w.Header().Set("X-XSS-Protection", "1;mode=block")

    switch contentType {
    case "text":
        w.Header().Set("Content-Type", "text/plain; charset=utf-8")
        return nil
    case "json":
        w.Header().Set("Content-Type", "application/json; charset=UTF-8")
        return nil
    default:
        return errors.New("Attempting to render an unknown content type")
    }
}

Answer 2

如您所写，此代码在 PingHandler 中永远不会到达：

if err != nil {
    handleException(w, err)
    return
}

因为你唯一 return 错误的地方是当 writeDefaultHeaders 传递了文本或 json 以外的东西时，并且在 PingHandler 中你硬编码 "text"，所以 ping 处理程序永远不会调用 handleException，错误处理是多余的。在 writeDefaultHeaders.

中没有其他地方可能 return 错误

如果你想测试 handleException，要看到它 return 是一个正确的 500 错误（这就是你在 Test500PingHandler 中的 asserting/testing），只需在测试文件中构造一个 PingHandlerFail 函数，它设置一个不正确的 responseType 并使用它 - 没有其他方法可以触发您的错误代码。

func PingHandlerFail(w http.ResponseWriter, r *http.Request) {
    err := writeDefaultHeaders(w, "foo")
    if err != nil {
        handleException(w, err)
        return
    }
    fmt.Fprintf(w, "Pong")
}

或者，更改 PingHandler 以根据某些请求条件设置 contentType，例如请求是否以 .json 结尾（您可能需要这样做才能提供 json 或文本），以便您可以以某种方式触发错误 - 目前，由于 PingHandler 除了文本之外从不提供任何服务，因此错误代码是多余的并且结果无法测试。

Answer 3

What is the idiomatic way to mock this call / hit this error branch in the code?

通常为了测试你想使用 public 接口并为你的代码提供一个实现（NewMyThing(hw HeaderWriter)）或者使用一些其他机制（比如 DefaultHeaderWriter 你可以在你的测试中换掉）。

由于此代码是私有的，因此您可以只使用一个变量：

var writeDefaultHeaders = func(w http.ResponseWriter, contentType string) error {
    w.Header().Set("X-Frame-Options", "DENY")
    w.Header().Set("X-Content-Type-Options", "nosniff")
    w.Header().Set("X-XSS-Protection", "1;mode=block")

    switch contentType {
    case "text":
        w.Header().Set("Content-Type", "text/plain; charset=utf-8")
        return nil
    case "json":
        w.Header().Set("Content-Type", "application/json; charset=UTF-8")
        return nil
    default:
        return errors.New("Attempting to render an unknown content type")
    }
}

func PingHandler(w http.ResponseWriter, r *http.Request) {
    err := writeDefaultHeaders(w, "text")
    if err != nil {
        handleException(w, err)
        return
    }

    fmt.Fprintf(w, "Pong")
}

然后在你的测试中换掉它：

func Test500PingHandler(t *testing.T) {
    writeDefaultHeaders = headerWriterFunc(func(w http.ResponseWriter, contentType string) error {
        return fmt.Errorf("ERROR")
    })
    // ...
}

您可能想在完成后将其设置回去。

在我看来，像这样换掉一个函数并不是好的测试实践。测试应该针对 public API，这样您就可以修改代码，而不必在每次进行单个更改时都重写测试。

接口示例：

type Marshaler interface {
    Marshal(v interface{}) ([]byte, error)
}

type jsonMarshaler struct{}

func (_ *jsonMarshaler) Marshal(v interface{}) ([]byte, error) {
    return json.Marshal(v)
}

var marshaler Marshaler = (*jsonMarshaler)(nil)

然后：

json_response, err := marshaler.Marshal(response)

使用简单的 http 处理程序测试所有路径

Go simple http handler testing all paths

testing

tdd

unit-testing

go