如何模拟在Golang测试中进行外部调用的中间件？

Question

TLDR：有一个go-chi中间件正在进行外部调用以授权请求。我需要嘲笑它的作用。

详细信息：

我有个测试：

func Test_HTTP_UserSet_Create_InvalidAction(t *testing.T) {
    requestBody :=
        `{
            "name": "test",
            "action": "TEST"
        }`

    req, _ := http.NewRequest("POST", "/1234/users", bytes.NewBuffer([]byte(requestBody)))

    recorder := setupInvalidActionRecorder(t, req)

    if status := recorder.Code; status != http.StatusBadRequest {
        t.Errorf("Status code expected to be %d but got %d", http.StatusBadRequest, status)
        return
    }
}

上面的setupUnknownErrorRecorder是：

func setupUnknownErrorRecorder(t *testing.T, request *http.Request) *httptest.ResponseRecorder {
    recorder := httptest.NewRecorder()

    c := resty.New()

    resource := users.NewResource(
        httpClient.NewHttpClient(log, &config.Server{}, &logger.LogRecord{}, c),
    )

    resource.Routes().ServeHTTP(recorder, request)

    return recorder
}

我得到的结果是：

=== RUN   Test_HTTP_UserSet_Create_InvalidAction
    invalidAction_test.go:71: Status code expected to be 400 but got 401
--- FAIL: Test_HTTP_UserSet_Create_InvalidAction (0.00s)

这个结果是预期的，因为服务器正在使用我传递给NewResource的客户端NewResource进行外部调用。

有一个go-chi中间件正在使用这个客户端进行外部调用。

我的问题是:我怎样才能让这个http电话总是返回200，而没有真正的打电话。也就是怎么嘲弄这个电话？

编辑：上面的httpClient接口是：

type HttpClient struct {
    logger          *logger.Logger
    config          *config.Server
    instrumentation *instrumentation
    record          *logger.LogRecord
    restyClient     *resty.Client
}

func NewHttpClient(
    logger *logger.Logger,
    config *config.Server,
    record *logger.LogRecord,
    restyClient *resty.Client,
) HttpClient {
    return HttpClient{
        instrumentation: newInstrumentation(logger, record),
        config:          config,
        logger:          logger,
        record:          record,
        restyClient:     restyClient,
    }
}

Answer 1

可测试代码的一个非常基本的规则是，您不能只在其他服务中创建新服务。您需要注入它，如果已经没有resty.New返回的任何内容，则需要准备一个接口。这样你就可以在测试中注入你的模拟。

然后，您可以使用https://pkg.go.dev/github.com/stretchr/testify/mock生成模拟，并表示模拟服务应该返回的值是什么。

评论后的最新情况：

type HttpClient struct {
    logger          *logger.Logger
    config          *config.Server
    instrumentation *instrumentation
    record          *logger.LogRecord
    restyClient     *resty.Client // <- this is the thing you want to change from a pointer to resty.Client to an interface
}

检查代码中使用的restyClient方法，并创建包含它们的新接口，如下所示：

type MyRestyClient interface {
   FirstUsedMethod(..)
   
   ...
}

并将restyClient声明交换为

type HttpClient struct {
    ...
    restyClient     MyRestyClient

在此之后，您可以使用我之前通过命令粘贴的链接中的嘲弄来为您生成一个模拟。

稍后，您只需在测试中安装模拟：

restyMock := new(RestyMock)
restyMock.On("MethodYouExpect").Return(returnValueOfYourChoice)

然后你在测试下把准备好的模拟注入到你的服务中。