Go語言單元測(cè)試怎么實(shí)現(xiàn)服務(wù)請(qǐng)求和接口返回

這篇“Go語言單元測(cè)試怎么實(shí)現(xiàn)服務(wù)請(qǐng)求和接口返回”文章的知識(shí)點(diǎn)大部分人都不太理解，所以小編給大家總結(jié)了以下內(nèi)容，內(nèi)容詳細(xì)，步驟清晰，具有一定的借鑒價(jià)值，希望大家閱讀完這篇文章能有所收獲，下面我們一起來看看這篇“Go語言單元測(cè)試怎么實(shí)現(xiàn)服務(wù)請(qǐng)求和接口返回”文章吧。

httptest

在Web開發(fā)場(chǎng)景下的單元測(cè)試，如果涉及到HTTP請(qǐng)求推薦大家使用Go標(biāo)準(zhǔn)庫 net/http/httptest 進(jìn)行測(cè)試，能夠顯著提高測(cè)試效率。

在這一小節(jié)，我們以常見的gin框架為例，演示如何為 http server 編寫單元測(cè)試。

假設(shè)我們的業(yè)務(wù)邏輯是搭建一個(gè)http server端，對(duì)外提供HTTP服務(wù)。我們編寫了一個(gè)helloHandler函數(shù)，用來處理用戶請(qǐng)求。

// gin.go
package httptest_demo
import (
 "fmt"
 "net/http"
 "github.com/gin-gonic/gin"
)
// Param 請(qǐng)求參數(shù)
type Param struct {
 Name string `json:"name"`
}
// helloHandler /hello請(qǐng)求處理函數(shù)
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
}

現(xiàn)在我們需要為helloHandler函數(shù)編寫單元測(cè)試，這種情況下我們就可以使用httptest這個(gè)工具mock一個(gè)HTTP請(qǐng)求和響應(yīng)記錄器，讓我們的 server 端接收并處理我們 mock 的HTTP請(qǐng)求，同時(shí)使用響應(yīng)記錄器來記錄 server 端返回的響應(yīng)內(nèi)容。

單元測(cè)試的示例代碼如下：

// 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) {
 // 定義兩個(gè)測(cè)試用例
 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一個(gè)HTTP請(qǐng)求
   req := httptest.NewRequest(
    "POST",                      // 請(qǐng)求方法
    "/hello",                    // 請(qǐng)求URL
    strings.NewReader(tt.param), // 請(qǐng)求參數(shù)
   )
   // mock一個(gè)響應(yīng)記錄器
   w := httptest.NewRecorder()
   // 讓server端處理mock請(qǐng)求并記錄返回的響應(yīng)內(nèi)容
   r.ServeHTTP(w, req)
   // 校驗(yàn)狀態(tài)碼是否符合預(yù)期
   assert.Equal(t, http.StatusOK, w.Code)
   // 解析并檢驗(yàn)響應(yīng)內(nèi)容是否復(fù)合預(yù)期
   var resp map[string]string
   err := json.Unmarshal([]byte(w.Body.String()), &resp)
   assert.Nil(t, err)
   assert.Equal(t, tt.expect, resp["msg"])
  })
 }
}

執(zhí)行單元測(cè)試，查看測(cè)試結(jié)果

? go test -v
=== RUN   Test_helloHandler
[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.
[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
 - using env:   export GIN_MODE=release
 - using code:  gin.SetMode(gin.ReleaseMode)
[GIN-debug] POST   /hello                    --> golang-unit-test-demo/httptest_demo.helloHandler (3 handlers)
=== RUN   Test_helloHandler/base_case
[GIN] 2021/09/14 - 22:00:04 | 200 |     164.839µs |       192.0.2.1 | POST     "/hello"
=== RUN   Test_helloHandler/bad_case
[GIN] 2021/09/14 - 22:00:04 | 200 |      23.723µs |       192.0.2.1 | POST     "/hello"
--- PASS: Test_helloHandler (0.00s)
    --- PASS: Test_helloHandler/base_case (0.00s)
    --- PASS: Test_helloHandler/bad_case (0.00s)
PASS
ok      golang-unit-test-demo/httptest_demo     0.055s

通過這個(gè)示例我們就掌握了如何使用httptest在HTTP Server服務(wù)中為請(qǐng)求處理函數(shù)編寫單元測(cè)試了。

gock

上面的示例介紹了如何在HTTP Server服務(wù)類場(chǎng)景下為請(qǐng)求處理函數(shù)編寫單元測(cè)試，那么如果我們是在代碼中請(qǐng)求外部API的場(chǎng)景（比如通過API調(diào)用其他服務(wù)獲取返回值）又該怎么編寫單元測(cè)試呢？

例如，我們有以下業(yè)務(wù)邏輯代碼，依賴外部API：http://your-api.com/post提供的數(shù)據(jù)。

// api.go
// ReqParam API請(qǐng)求參數(shù)
type ReqParam struct {
 X int `json:"x"`
}
// Result API返回結(jié)果
type Result struct {
 Value int `json:"value"`
}
func GetResultByAPI(x, y int) int {
 p := &ReqParam{X: x}
 b, _ := json.Marshal(p)
 // 調(diào)用其他服務(wù)的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
 }
 // 這里是對(duì)API返回的數(shù)據(jù)做一些邏輯處理
 return ret.Value + y
}

在對(duì)類似上述這類業(yè)務(wù)代碼編寫單元測(cè)試的時(shí)候，如果不想在測(cè)試過程中真正去發(fā)送請(qǐng)求或者依賴的外部接口還沒有開發(fā)完成時(shí)，我們可以在單元測(cè)試中對(duì)依賴的API進(jìn)行mock。

這里推薦使用gock這個(gè)庫。

安裝

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

使用示例

使用gock對(duì)外部API進(jìn)行mock，即mock指定參數(shù)返回約定好的響應(yīng)內(nèi)容。下面的代碼中mock了兩組數(shù)據(jù)，組成了兩個(gè)測(cè)試用例。

// api_test.go
package gock_demo
import (
 "testing"
 "github.com/stretchr/testify/assert"
 "gopkg.in/h3non/gock.v1"
)
func TestGetResultByAPI(t *testing.T) {
 defer gock.Off() // 測(cè)試執(zhí)行后刷新掛起的mock
 // mock 請(qǐng)求外部api時(shí)傳參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})
 // 調(diào)用我們的業(yè)務(wù)函數(shù)
 res := GetResultByAPI(1, 1)
 // 校驗(yàn)返回結(jié)果是否符合預(yù)期
 assert.Equal(t, res, 101)
 // mock 請(qǐng)求外部api時(shí)傳參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})
 // 調(diào)用我們的業(yè)務(wù)函數(shù)
 res = GetResultByAPI(2, 2)
 // 校驗(yàn)返回結(jié)果是否符合預(yù)期
 assert.Equal(t, res, 202)
 assert.True(t, gock.IsDone()) // 斷言mock被觸發(fā)
}

執(zhí)行上面寫好的單元測(cè)試，看一下測(cè)試結(jié)果。

? go test -v
=== RUN   TestGetResultByAPI
--- PASS: TestGetResultByAPI (0.00s)
PASS
ok      golang-unit-test-demo/gock_demo 0.054s

測(cè)試結(jié)果和預(yù)期的完全一致。

以上就是關(guān)于“Go語言單元測(cè)試怎么實(shí)現(xiàn)服務(wù)請(qǐng)求和接口返回”這篇文章的內(nèi)容，相信大家都有了一定的了解，希望小編分享的內(nèi)容對(duì)大家有幫助，若想了解更多相關(guān)的知識(shí)內(nèi)容，請(qǐng)關(guān)注億速云行業(yè)資訊頻道。