Go語言單元測試模擬服務請求和接口返回

// gin.go
package httptest_demo
import (
 "fmt"
 "net/http"
 "github.com/gin-gonic/gin"
)
// Param 請求參數
type Param struct {
 Name string `json:"name"`
}
// helloHandler /hello請求處理函數
func helloHandler(c *gin.Context) {
 var p Param
 if err := c.ShouldBindJSON(&p); err != nil {
  c.JSON(http.StatusOK, gin.H{
   "msg": "we need a name",
  })
  return
 }
 c.JSON(http.StatusOK, gin.H{
  "msg": fmt.Sprintf("hello %s", p.Name),
 })
}
// SetupRouter 路由
func SetupRouter() *gin.Engine {
 router := gin.Default()
 router.POST("/hello", helloHandler)
 return router
}

// gin_test.go
package httptest_demo
import (
 "encoding/json"
 "net/http"
 "net/http/httptest"
 "strings"
 "testing"
 "github.com/stretchr/testify/assert"
)
func Test_helloHandler(t *testing.T) {
 // 定義兩個測試用例
 tests := []struct {
  name   string
  param  string
  expect string
 }{
  {"base case", `{"name": "liwenzhou"}`, "hello liwenzhou"},
  {"bad case", "", "we need a name"},
 }
 r := SetupRouter()
 for _, tt := range tests {
  t.Run(tt.name, func(t *testing.T) {
   // mock一個HTTP請求
   req := httptest.NewRequest(
    "POST",                      // 請求方法
    "/hello",                    // 請求URL
    strings.NewReader(tt.param), // 請求參數
   )
   // mock一個響應記錄器
   w := httptest.NewRecorder()
   // 讓server端處理mock請求並記錄返回的響應內容
   r.ServeHTTP(w, req)
   // 校驗狀態碼是否符合預期
   assert.Equal(t, http.StatusOK, w.Code)
   // 解析並檢驗響應內容是否復合預期
   var resp map[string]string
   err := json.Unmarshal([]byte(w.Body.String()), &resp)
   assert.Nil(t, err)
   assert.Equal(t, tt.expect, resp["msg"])
  })
 }
}

// api.go
// ReqParam API請求參數
type ReqParam struct {
 X int `json:"x"`
}
// Result API返回結果
type Result struct {
 Value int `json:"value"`
}
func GetResultByAPI(x, y int) int {
 p := &ReqParam{X: x}
 b, _ := json.Marshal(p)
 // 調用其他服務的API
 resp, err := http.Post(
  "http://your-api.com/post",
  "application/json",
  bytes.NewBuffer(b),
 )
 if err != nil {
  return -1
 }
 body, _ := ioutil.ReadAll(resp.Body)
 var ret Result
 if err := json.Unmarshal(body, &ret); err != nil {
  return -1
 }
 // 這裡是對API返回的數據做一些邏輯處理
 return ret.Value + y
}

go get -u gopkg.in/h2non/gock.v1

// api_test.go
package gock_demo
import (
 "testing"
 "github.com/stretchr/testify/assert"
 "gopkg.in/h2non/gock.v1"
)
func TestGetResultByAPI(t *testing.T) {
 defer gock.Off() // 測試執行後刷新掛起的mock
 // mock 請求外部api時傳參x=1返回100
 gock.New("http://your-api.com").
  Post("/post").
  MatchType("json").
  JSON(map[string]int{"x": 1}).
  Reply(200).
  JSON(map[string]int{"value": 100})
 // 調用我們的業務函數
 res := GetResultByAPI(1, 1)
 // 校驗返回結果是否符合預期
 assert.Equal(t, res, 101)
 // mock 請求外部api時傳參x=2返回200
 gock.New("http://your-api.com").
  Post("/post").
  MatchType("json").
  JSON(map[string]int{"x": 2}).
  Reply(200).
  JSON(map[string]int{"value": 200})
 // 調用我們的業務函數
 res = GetResultByAPI(2, 2)
 // 校驗返回結果是否符合預期
 assert.Equal(t, res, 202)
 assert.True(t, gock.IsDone()) // 斷言mock被觸發
}