使用Godog编写API的Cucumber测试遇404及端口问题求助

核心问题分析 #

你遇到的问题根源是测试代码的请求目标与httptest.Server的实际地址不匹配：

• 调试模式下你大概率手动启动了本地8080端口的真实服务器，因此请求能正常响应；
• 运行go test时真实服务器未启动，而测试代码仍在请求localhost:8080，但httptest.Server要么没正确绑定该端口，要么你没使用它提供的URL发起请求，最终导致404或连接失败。

另外可以明确：httptest.Server是API测试的正确mock方案，问题出在使用方式上，无需更换方案。

具体修复步骤 #

1. 放弃硬编码地址，改用httptest.Server的URL #

httptest.Server启动后会自动分配随机端口（也可指定，但不推荐），必须用它的URL字段构造请求，而非硬写localhost:8080。

示例修正：

// 错误写法：硬编码固定地址
req, _ := http.NewRequest("POST", "http://localhost:8080/api/endpoint", body)

// 正确写法：使用test server提供的动态URL
req, _ := http.NewRequest("POST", ts.URL+"/api/endpoint", body)

2. 确保路由正确注册到httptest.Server的Handler #

检查测试代码是否把API路由注册到了test server的专属Handler上，而非全局的http.DefaultServeMux。

标准库路由的正确示例：

// 初始化API路由
router := mux.NewRouter()
router.HandleFunc("/api/endpoint", yourEndpointHandler).Methods("POST")

// 创建test server，传入你的路由作为Handler
ts := httptest.NewServer(router)
defer ts.Close()

// 用ts.URL发起请求
client := &http.Client{}
req, _ := http.NewRequest("POST", ts.URL+"/api/endpoint", strings.NewReader("test body"))
resp, err := client.Do(req)
// 后续断言逻辑

3. 实现Godog步骤间的上下文共享 #

如果你的Given/When/Then步骤分散在不同函数，要确保httptest.Server实例和客户端能在步骤间共享，避免每个步骤重复创建或引用错误地址。

可以借助Godog的ScenarioContext存储共享对象：

type testContext struct {
    ts       *httptest.Server
    client   *http.Client
    response *http.Response
}

func InitializeScenario(ctx *godog.ScenarioContext) {
    tc := &testContext{client: &http.Client{}}

    ctx.Before(func(ctx context.Context, sc *godog.Scenario) (context.Context, error) {
        // 前置步骤启动test server
        router := mux.NewRouter()
        router.HandleFunc("/api/endpoint", yourEndpointHandler).Methods("POST")
        tc.ts = httptest.NewServer(router)
        return context.WithValue(ctx, "testContext", tc), nil
    })

    ctx.After(func(ctx context.Context, sc *godog.Scenario, err error) (context.Context, error) {
        // 后置步骤关闭test server
        if tc.ts != nil {
            tc.ts.Close()
        }
        return ctx, nil
    })

    // When步骤示例：调用共享的testContext发起请求
    ctx.When("I send a POST request to /api/endpoint with body {string}", func(body string) error {
        tc := ctx.Value("testContext").(*testContext)
        req, err := http.NewRequest("POST", tc.ts.URL+"/api/endpoint", strings.NewReader(body))
        if err != nil {
            return err
        }
        tc.response, err = tc.client.Do(req)
        return err
    })
}

4. 彻底脱离外部真实服务器依赖 #

调试时能通是因为手动启动了真实服务器，但自动化测试必须完全自给自足，所有依赖（包括API服务器）都要通过test server提供，确保每次运行go test都能独立执行，不依赖外部环境。

额外排查点 #

• 检查API路由是否有前缀（如/v1），请求时需拼接完整路径；
• 确认defer ts.Close()放在了正确位置，避免test server被提前关闭；
• 用fmt.Println(ts.URL)打印test server的实际地址，验证与请求地址是否一致。

内容的提问来源于stack exchange，提问作者samueltry