Golang测试框架Goconvey的使用详解与实践指南

go install github.com/smartystreets/goconvey@latest

goconvey -host=0.0.0.0 -port=8080 -depth=3

// math.go
package math
 
func Add(a, b int) int { return a + b }

// math_test.go
package math
 
import (
    "testing"
    . "github.com/smartystreets/goconvey/convey"
)
 
func TestAdd(t *testing.T) {
    Convey("Given two integers", t, func() {
        a, b := 2, 3
        Convey("When Add is called", func() {
            got := Add(a, b)
            Convey("Then the result should equal 5", func() {
                So(got, ShouldEqual, 5)
            })
        })
    })
}

So(result, ShouldEqual, 42)           // 相等
So(err, ShouldBeNil)                   // 无错误
So(list, ShouldContain, "apple")       // 包含
So(resp.Body, ShouldNotBeBlank)         // 非空
So(fn, ShouldPanic)                    // 期望 panic
So(time.Since(t), ShouldHappenWithin, 100*time.Millisecond) // 性能断言

func TestTable(t *testing.T) {
    cases := []struct {
        a, b, want int
    }{
        {1, 2, 3},
        {0, 0, 0},
        {-1, 1, 0},
    }
 
    Convey("Table driven test", t, func() {
        for _, c := range cases {
            c := c // capture range var
            Convey(fmt.Sprintf("Add(%d,%d)", c.a, c.b), func() {
                So(Add(c.a, c.b), ShouldEqual, c.want)
            })
        }
    })
}

Convey("Parallel suite", t, func() {
    Convey("Task 1", func(c C) {
        c.So(doWork(), ShouldBeNil)
    })
})

func TestMain(m *testing.M) {
    // 全局 Setup
    db := setupDB()
    code := m.Run()
    teardownDB(db)
    os.Exit(code)
}
 
func TestOrder(t *testing.T) {
    Convey("Given a clean order table", t, func() {
        db := mustGetTestDB()
        MustExec(db, "TRUNCATE orders")
        
        Reset(func() { // 每个 Convey 分支结束后执行
            MustExec(db, "TRUNCATE orders")
        })
 
        Convey("When insert an order", func() {
            id := InsertOrder(db, Order{Amount: 99})
            Convey("Then it should be queryable", func() {
                o, err := GetOrder(db, id)
                So(err, ShouldBeNil)
                So(o.Amount, ShouldEqual, 99)
            })
        })
    })
}

// handler_test.go
package handler
 
import (
    "net/http"
    "net/http/httptest"
    "testing"
 
    "github.com/gin-gonic/gin"
    . "github.com/smartystreets/goconvey/convey"
)
 
func TestCreateUser(t *testing.T) {
    gin.SetMode(gin.TestMode)
    router := setupRouter() // 返回 *gin.Engine
 
    Convey("POST /api/v1/users", t, func() {
        Convey("Given valid JSON body", func() {
            body := `{"name":"alice","age":18}`
            req := httptest.NewRequest(http.MethodPost, "/api/v1/users", strings.NewReader(body))
            req.Header.Set("Content-Type", "application/json")
            w := httptest.NewRecorder()
 
            Convey("When server handles the request", func() {
                router.ServeHTTP(w, req)
 
                Convey("Then response should be 201 and return user ID", func() {
                    So(w.Code, ShouldEqual, http.StatusCreated)
                    So(w.Body.String(), ShouldContainSubstring, `"id":`)
                })
            })
        })
 
        Convey("Given invalid age", func() {
            body := `{"name":"alice","age":-1}`
            req := httptest.NewRequest(http.MethodPost, "/api/v1/users", strings.NewReader(body))
            req.Header.Set("Content-Type", "application/json")
            w := httptest.NewRecorder()
 
            Convey("When server handles the request", func() {
                router.ServeHTTP(w, req)
 
                Convey("Then response should be 400", func() {
                    So(w.Code, ShouldEqual, http.StatusBadRequest)
                    So(w.Body.String(), ShouldContainSubstring, "age must be positive")
                })
            })
        })
    })
}

# .github/workflows/test.yml
name: CI
 
on: [push, pull_request]
 
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version: '1.22'
 
      - name: Install goconvey
        run: go install github.com/smartystreets/goconvey@latest
 
      - name: Run tests with coverage
        run: |
          goconvey -packages=1 -coverprofile=coverage.out ./...
          go tool cover -func=coverage.out | tee coverage.txt
 
      - name: Upload coverage
        uses: codecov/codecov-action@v4
        with:
          file: ./coverage.out