gin-contrib Session测试在GitLab CI中随机失败问题求助

背景 #

我基于gin-contrib/sessions实现登录逻辑，登录处理器中显式设置了Session选项，本地测试完全正常，但在GitLab CI环境中执行测试时会随机失败。

登录处理器代码 #

func (h *handler) login(c *gin.Context, u model.Participant) {
    // [登录验证逻辑已简化]
    dbuser := u.Login(h.db, c)

    // 初始化Session
    session := sessions.Default(c)
    session.Options(sessions.Options{
        MaxAge:   3600,
        Path:     "/",
        HttpOnly: true,
        Secure:   true,
    })
    session.Set("id", dbuser.ID)
    session.Set("name", dbuser.Name)
    if err := session.Save(); err != nil {
        c.HTML(http.StatusBadRequest, "index.html", gin.H{"error": err.Error()})
        return
    }

    c.Redirect(http.StatusFound, "/dashboard")
}

测试函数代码 #

// LoginCookie 仅用于测试场景
func LoginCookie(router *gin.Engine, t *testing.T) []string {
    t.Log("执行登录...")
    w := httptest.NewRecorder()
    req, _ := http.NewRequest("POST", "/login", strings.NewReader("name=bob&password=j"))
    req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
    router.ServeHTTP(w, req)

    assert.Equal(t, 302, w.Code)
    assert.Equal(t, "/dashboard", w.Header().Get("location"))
    assert.Equal(t, true, strings.Contains(w.Header().Get("Set-Cookie"), "mysession"))
    t.Log("登录成功")
    return w.Header().Values("Set-Cookie")
}

GitLab CI配置 #

format:
  stage: test
  services:
    - name: harbor.uni-muenster.de/proxy-docker/library/postgres:16
      alias: postgres
  variables:
    POSTGRES_DB: cvmlsannotationserver_test
    POSTGRES_USER: cvmlsannotationserver_test
    POSTGRES_PASSWORD: cvmlsannotationserver_test
  image: harbor.uni-muenster.de/proxy-docker/library/golang:latest
  script:
  - go fmt $(go list ./... | grep -v /vendor/)
  - go vet $(go list ./... | grep -v /vendor/)
  - ANNOTATIONSERVER_DSN=postgres://cvmlsannotationserver_test:cvmlsannotationserver_test@postgres:5432/cvmlsannotationserver_test?sslmode=disable go test -race $(go list ./... | grep -v /vendor/)

问题分析与解决办法 #

1. Secure选项的环境兼容问题 #

你设置了Secure: true，该选项要求Cookie仅能通过HTTPS传输，但测试用httptest发起的是HTTP请求，无HTTPS环境。本地测试可能因localhost的兼容性豁免正常执行，但CI环境严格遵循规则，导致Cookie无法写入，触发断言失败。

解决：根据环境动态控制Secure选项：

import "os"

// ...

sessionOpts := sessions.Options{
    MaxAge:   3600,
    Path:     "/",
    HttpOnly: true,
    Secure:   os.Getenv("TEST_ENV") != "true", // 测试环境下关闭Secure
}
session.Options(sessionOpts)

在CI脚本中添加环境变量：

script:
  # ...
  - TEST_ENV=true ANNOTATIONSERVER_DSN=... go test -race ...

2. 数据库初始化竞态 #

CI启用了-race竞态检测，测试数据加载与登录测试可能存在并发冲突：登录测试启动时，数据库测试数据尚未完全写入，导致用户不存在，登录失败。

解决：

• 确保测试数据加载为同步阻塞执行（例如在TestMain中完成数据初始化，再启动所有测试）
• 给登录测试添加重试逻辑：

import "time"

// ...

func LoginCookie(router *gin.Engine, t *testing.T) []string {
    var w *httptest.ResponseRecorder
    var req *http.Request
    var err error

    // 最多重试3次，应对数据初始化延迟
    for i := 0; i < 3; i++ {
        t.Logf("执行登录（第%d次尝试）...", i+1)
        w = httptest.NewRecorder()
        req, err = http.NewRequest("POST", "/login", strings.NewReader("name=bob&password=j"))
        if err != nil {
            t.Fatal(err)
        }
        req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
        router.ServeHTTP(w, req)

        if w.Code == 302 && strings.Contains(w.Header().Get("Set-Cookie"), "mysession") {
            break
        }
        time.Sleep(500 * time.Millisecond)
    }

    assert.Equal(t, 302, w.Code)
    assert.Equal(t, "/dashboard", w.Header().Get("location"))
    assert.True(t, strings.Contains(w.Header().Get("Set-Cookie"), "mysession"))
    t.Log("登录成功")
    return w.Header().Values("Set-Cookie")
}

3. Session存储的并发冲突 #

如果使用内存Session存储，-race模式下可能出现多测试共享存储的并发问题，导致Session保存失败。

解决：测试时为每个测试用例创建独立的Session存储实例，避免跨测试共享状态。

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