您的位置:首页 > 教程 > 其他脚本 > Go语言单元测试模拟服务请求和接口返回

Go语言单元测试模拟服务请求和接口返回

2022-06-21 17:53:34 来源:易采站长站 作者:

Go语言单元测试模拟服务请求和接口返回

目录
前言httptestgock安装使用示例总结

9Fg站长之家-易采站长站-Easck.Com

前言

这是Go单元测试从入门到放弃系列教程的第1篇,介绍了如何使用httptestgock工具进行网络测试。9Fg站长之家-易采站长站-Easck.Com

在上一篇《Go单元测试从入门到放弃—0.单元测试基础》中,我们介绍了Go语言编写单元测试的基础内容。9Fg站长之家-易采站长站-Easck.Com

而实际工作中的业务场景往往会比较复杂,无论我们的代码是作为server端对外提供服务或者还是我们依赖别人提供的网络服务(调用别人提供的API接口)的场景,我们通常都不想在测试过程中真正的建立网络连接。本文就专门介绍如何在上述两种场景下mock网络测试。9Fg站长之家-易采站长站-Easck.Com

9Fg站长之家-易采站长站-Easck.Com

httptest

在Web开发场景下的单元测试,如果涉及到HTTP请求推荐大家使用Go标准库 net/http/httptest 进行测试,能够显著提高测试效率。9Fg站长之家-易采站长站-Easck.Com

在这一小节,我们以常见的gin框架为例,演示如何为>

假设我们的业务逻辑是搭建一个http server端,对外提供HTTP服务。我们编写了一个helloHandler函数,用来处理用户请求。9Fg站长之家-易采站长站-Easck.Com

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

现在我们需要为helloHandler函数编写单元测试,这种情况下我们就可以使用httptest这个工具mock一个HTTP请求和响应记录器,让我们的 server 端接收并处理我们 mock 的HTTP请求,同时使用响应记录器来记录 server 端返回的响应内容。9Fg站长之家-易采站长站-Easck.Com

单元测试的示例代码如下:9Fg站长之家-易采站长站-Easck.Com

// 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"])
  })
 }
}

执行单元测试,查看测试结果9Fg站长之家-易采站长站-Easck.Com

❯ go test -v9Fg站长之家-易采站长站-Easck.Com
=== RUN   Test_helloHandler9Fg站长之家-易采站长站-Easck.Com
[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.9Fg站长之家-易采站长站-Easck.Com
[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.9Fg站长之家-易采站长站-Easck.Com
 - using env:   export GIN_MODE=release9Fg站长之家-易采站长站-Easck.Com
 - using code:  gin.SetMode(gin.ReleaseMode)9Fg站长之家-易采站长站-Easck.Com
[GIN-debug] POST   /hello                    --> golang-unit-test-demo/httptest_demo.helloHandler (3 handlers)9Fg站长之家-易采站长站-Easck.Com
=== RUN   Test_helloHandler/base_case9Fg站长之家-易采站长站-Easck.Com
[GIN] 2021/09/14 - 22:00:04 | 200 |     164.839µs |       192.0.2.1 | POST     "/hello"9Fg站长之家-易采站长站-Easck.Com
=== RUN   Test_helloHandler/bad_case9Fg站长之家-易采站长站-Easck.Com
[GIN] 2021/09/14 - 22:00:04 | 200 |      23.723µs |       192.0.2.1 | POST     "/hello"9Fg站长之家-易采站长站-Easck.Com
--- PASS: Test_helloHandler (0.00s)9Fg站长之家-易采站长站-Easck.Com
    --- PASS: Test_helloHandler/base_case (0.00s)9Fg站长之家-易采站长站-Easck.Com
    --- PASS: Test_helloHandler/bad_case (0.00s)9Fg站长之家-易采站长站-Easck.Com
PASS9Fg站长之家-易采站长站-Easck.Com
ok      golang-unit-test-demo/httptest_demo     0.055s9Fg站长之家-易采站长站-Easck.Com

通过这个示例我们就掌握了如何使用httptest在HTTP Server服务中为请求处理函数编写单元测试了。9Fg站长之家-易采站长站-Easck.Com

9Fg站长之家-易采站长站-Easck.Com

gock

上面的示例介绍了如何在HTTP>

例如,我们有以下业务逻辑代码,依赖外部API:http://your-api.com/post提供的数据。9Fg站长之家-易采站长站-Easck.Com

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

在对类似上述这类业务代码编写单元测试的时候,如果不想在测试过程中真正去发送请求或者依赖的外部接口还没有开发完成时,我们可以在单元测试中对依赖的API进行mock。9Fg站长之家-易采站长站-Easck.Com

这里推荐使用gock这个库。9Fg站长之家-易采站长站-Easck.Com

9Fg站长之家-易采站长站-Easck.Com

安装

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

9Fg站长之家-易采站长站-Easck.Com

使用示例

使用gock对外部API进行mock,即mock指定参数返回约定好的响应内容。下面的代码中mock了两组数据,组成了两个测试用例。9Fg站长之家-易采站长站-Easck.Com

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

执行上面写好的单元测试,看一下测试结果。9Fg站长之家-易采站长站-Easck.Com

❯ go test -v9Fg站长之家-易采站长站-Easck.Com
=== RUN   TestGetResultByAPI9Fg站长之家-易采站长站-Easck.Com
--- PASS: TestGetResultByAPI (0.00s)9Fg站长之家-易采站长站-Easck.Com
PASS9Fg站长之家-易采站长站-Easck.Com
ok      golang-unit-test-demo/gock_demo 0.054s9Fg站长之家-易采站长站-Easck.Com

测试结果和预期的完全一致。9Fg站长之家-易采站长站-Easck.Com

在这个示例中,为了让大家能够清晰的了解gock的使用,我特意没有使用表格驱动测试。给大家留一个小作业:自己动手把这个单元测试改写成表格驱动测试的风格,就当做是对最近两篇教程的复习和测验。9Fg站长之家-易采站长站-Easck.Com

​这里网管来当下课代表,大家可以把这个作业在公众号私信发我,一起交流下答案。如果想摸鱼也可以直接找我要答案,不过不给白嫖哦,必须来个三连:)。9Fg站长之家-易采站长站-Easck.Com

9Fg站长之家-易采站长站-Easck.Com

总结

在日常工作开发中为代码编写单元测试时如何处理外部依赖是最常见的问题,本文介绍了如何使用httptestgock工具mock相关依赖。9Fg站长之家-易采站长站-Easck.Com

后面我们将更进一步,详细介绍针对依赖MySQL和Redis的场景如何编写单元测试,更多关于Go单元测试模拟服务请求和接口返回的资料请关注易采站长站其它相关文章!9Fg站长之家-易采站长站-Easck.Com

如有侵权,请联系QQ:279390809 电话:15144810328

相关文章

  • 使用Go基于WebSocket构建千万级视频直播弹幕系统的代码详解

    使用Go基于WebSocket构建千万级视频直播弹幕系统的代码详解

    (1)业务复杂度介绍 开门见山,假设一个直播间同时500W人在线,那么1秒钟1000条弹幕,那么弹幕系统的推送频率就是: 500W * 1000条/秒=50亿条/秒 ,想想B站2019跨年晚会那次弹幕系统得是
    2020-07-08
  • golang中import cycle not allowed解决的一种思路

    golang中import cycle not allowed解决的一种思路

    发现问题 项目中碰到了一些问题,使用了指针函数的思路来解决相应问题 在实际项目中,因为两个项目互相引了对方的一些方法,导致了循环引用的错误,原本可以使用http的请求来解
    2019-11-10
  • 从go语言中找&和*区别详解

    从go语言中找&和*区别详解

    *和的区别 : 是取地址符号 , 即取得某个变量的地址 , 如 ; a*是指针运算符 , 可以表示一个变量是指针类型 , 也可以表示一个指针变量所指向的存储单元 , 也就是这个地址所存储的值 . 从
    2020-06-23
  • Go语言中利用http发起Get和Post请求的方法示例

    Go语言中利用http发起Get和Post请求的方法示例

    关于 HTTP 协议 HTTP(即超文本传输协议)是现代网络中最常见和常用的协议之一,设计它的目的是保证客户机和服务器之间的通信。 HTTP 的工作方式是客户机与服务器之间的 “请求-应答
    2019-11-10
  • golang如何实现mapreduce单进程版本详解

    golang如何实现mapreduce单进程版本详解

    前言 MapReduce作为hadoop的编程框架,是工程师最常接触的部分,也是除去了网络环境和集群配 置之外对整个Job执行效率影响很大的部分,所以很有必要深入了解整个过程。元旦放假的第一天
    2019-11-10
  • Go打包二进制文件的实现

    Go打包二进制文件的实现

    背景 众所周知,go语言可打包成目标平台二进制文件是其一大优势,如此go项目在服务器不需要配置go环境和依赖就可跑起来。 操作 需求:打包部署到centos7 笔者打包环境:mac os 方法:
    2020-03-11
  • GO语言实现简单的目录复制功能

    GO语言实现简单的目录复制功能

    本文实例讲述了GO语言实现简单的目录复制功能。分享给大家供大家参考。具体实现方法如下: 创建一个独立的 goroutine 遍历文件,主进程负责写入数据。程序会复制空目录,也可以设
    2019-11-10
  • golang中定时器cpu使用率高的现象详析

    golang中定时器cpu使用率高的现象详析

    前言: 废话少说,上线一个用golang写的高频的任务派发系统,上线跑着很稳定,但有个缺点就是当没有任务的时候,cpu的消耗也在几个百分点。 平均值在3%左右的cpu使用率。你没有任务
    2019-11-10