Go单测之mock网络

2010年03月26日

https://blog.csdn.net/hero_java/article/details/114242476

从httpmock 了解http.RoundTripper
https://blog.csdn.net/gaoce227/article/details/118393295

自己对外提供的api接口：

以gin框架为例，演示如何为http server编写单元测试

// gin.go
package main

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": "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
}

func main() {
	g := SetupRouter()
	g.Run() // listen and serve on 0.0.0.0:8080
}

curl -X POST \
  http://127.0.0.1:8080/hello \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'postman-token: ed1c03e8-7b65-637e-4dc5-35cf38bbe5ac' \
  -d '{
	"name": "Alex"
}'

当有传name参数时，返回hello $name，否则返回name参数缺失

使用Go标准库 net/http/httptest 进行测试

// gin_test.go
package main

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": "Alex"}`, "hello Alex"},
		{"bad case", "", "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"])
		})
	}
}

展示测试覆盖率,并生成覆盖统计文件到 count.out:

go test ./... -v -coverprofile=count.out

用go tool来分析 count.out 文件并生成想要的结果：

用 -func 生成每个函数的覆盖率

go tool cover -func=count.out

展示每一个函数单元测试的覆盖率,若100% 则测试完整,若0.0% 则没有测试

用 -html 生成 html 文件,以图形方式展示每个函数,每一行代码的覆盖率

go tool cover -html=count.out

会打开默认浏览器,图形化展示测试覆盖率

可切换当前库下的每个文件,看每一行代码是否测试执行。没有执行的显示为红色, 灰色是不需要测试的, 亮绿色是测试通过的

请求别人的接口：

对这类场景写单测时，不想在测试过程中真正去发送请求(或依赖的外部接口还未开发完成)，可以在单元测试中使用gock这个库，对依赖的API进行mock。

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

// api.go
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
)

// 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
}

func main() {

	fmt.Println("结果为:", GetResultByAPI(1, 2))

}

使用gock 对外部API进行mock，即带着参数，返回约定好的响应内容

// api_test.go
package main

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被触发
}

展示测试覆盖率,并生成覆盖统计文件到 count.out: