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

目录
  • 前言
  • httptest
  • gock
    • 安装
    • 使用示例
  • 总结

前言

这是Go单元测试从入门到放弃系列教程的第1篇,介绍了如何使用httptestgock工具进行网络测试。

在上一篇《Go单元测试从入门到放弃—0.单元测试基础》中,我们介绍了Go语言编写单元测试的基础内容。

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

httptest

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

在这一小节,我们以常见的gin框架为例,演示如何为 http server 编写单元测试。

假设我们的业务逻辑是搭建一个http server端,对外提供HTTP服务。我们编写了一个helloHandler函数,用来处理用户请求。

// 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 端返回的响应内容。

单元测试的示例代码如下:

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

执行单元测试,查看测试结果

❯ 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

通过这个示例我们就掌握了如何使用httptest在HTTP Server服务中为请求处理函数编写单元测试了。

gock

上面的示例介绍了如何在HTTP Server服务类场景下为请求处理函数编写单元测试,那么如果我们是在代码中请求外部API的场景(比如通过API调用其他服务获取返回值)又该怎么编写单元测试呢?

例如,我们有以下业务逻辑代码,依赖外部API:http://your-api.com/post提供的数据。

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

这里推荐使用gock这个库。

安装

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

使用示例

使用gock对外部API进行mock,即mock指定参数返回约定好的响应内容。下面的代码中mock了两组数据,组成了两个测试用例。

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

执行上面写好的单元测试,看一下测试结果。

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

测试结果和预期的完全一致。

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

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

总结

在日常工作开发中为代码编写单元测试时如何处理外部依赖是最常见的问题,本文介绍了如何使用httptestgock工具mock相关依赖。

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

(0)

相关推荐

  • 深入理解Golang的单元测试和性能测试

    前言 大家做开发的应该都知道,在开发程序中很重要的一点是测试,我们如何保证代码的质量,如何保证每个函数是可运行,运行结果是正确的,又如何保证写出来的代码性能是好的,我们知道单元测试的重点在于发现程序设计或实现的逻辑错误,使问题及早暴露,便于问题的定位解决,而性能测试的重点在于发现程序设计上的一些问题,让线上的程序能够在高并发的情况下还能保持稳定.本小节将带着这一连串的问题来讲解Go语言中如何来实现单元测试和性能测试. go语言中自带有一个轻量级的测试框架testing和自带的go test命令来

  • Go语言基础单元测试与性能测试示例详解

    目录 概述 单元测试 代码说明如下 问题 注意 性能测试 基本使用 自定义测试时间 概述 测试不是Go语言独有的,其实在很多语言都有测试,例如:Go.Java.Python- 要想成为一名合格的大牛,这是程序员必须具备的一项技能,特别是一些大公司,这是加分的一项,主要有如下优点: 代码可以随时测试,保证代码不会产生错误 写出更加高效的代码 testing文档 Testing_flags文档 单元测试 格式:func TestXXX(t *testing.T) //add.go package c

  • Golang单元测试与覆盖率的实例讲解

    1 概述 C/C++和Java(以及大多数的主流编程语言)都有自己成熟的单元测试框架,前者如Check,后者如JUnit,但这些编程框架本质上仍是第三方产品,为了执行单元测试,我们不得不从头开始搭建测试工程,并且需要依赖于第三方工具才能生成单元测试的覆盖率. 相比之下,Go语言官方则提供了语言级的单元测试支持,即testing包,而且仅通过go工具本身就可以方便地生成覆盖率数据,也就是说,单元测试是Go语言的自带属性,除了好好设计自己的单元测试用例外,开发者不需要操心工程搭建的任何细节.没错,G

  • Go语言单元测试基础从入门到放弃

    目录 Go语言测试 go test工具 单元测试函数 格式 单元测试示例 go test -v go test -run 回归测试 跳过某些测试用例 子测试 表格驱动测试 介绍 示例 并行测试 使用工具生成测试代码 测试覆盖率 testify/assert 安装 使用示例 总结 Go语言测试 这是Go单测从入门到放弃系列教程的第0篇,主要讲解在Go语言中如何做单元测试以及介绍了表格驱动测试.回归测试,并且介绍了常用的断言工具. go test工具 Go语言中的测试依赖go test命令.编写测试

  • 使用Go进行单元测试的实现

    简介 日常开发中, 测试是不能缺少的. Go 标准库中有一个叫做 testing 的测试框架, 可以用于单元测试和性能测试. 它是和命令 go test 集成使用的. 测试文件是以后缀 _test.go 命名的, 通常和被测试的文件放在同一个包中. 单元测试 单元测试的格式形如: func TestAbs(t *testing.T) { got := Abs(-1) if got != 1 { t.Errorf("Abs(-1) = %d; want 1", got) } } 在 ut

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

    目录 前言 httptest gock 安装 使用示例 总结 前言 这是Go单元测试从入门到放弃系列教程的第1篇,介绍了如何使用httptest和gock工具进行网络测试. 在上一篇<Go单元测试从入门到放弃—0.单元测试基础>中,我们介绍了Go语言编写单元测试的基础内容. 而实际工作中的业务场景往往会比较复杂,无论我们的代码是作为server端对外提供服务或者还是我们依赖别人提供的网络服务(调用别人提供的API接口)的场景,我们通常都不想在测试过程中真正的建立网络连接.本文就专门介绍如何在上

  • java后台调用HttpURLConnection类模拟浏览器请求实例(可用于接口调用)

    一般在项目开发中难免遇到外部接口的调用,本文实例讲述了java后台调用HttpURLConnection类模拟浏览器请求的方法.可用于接口调用.分享给大家供大家参考.具体实现方法如下: 复制代码 代码如下: package com.cplatform.movie.back.test; import java.io.BufferedReader; import java.io.DataOutputStream; import java.io.InputStreamReader; import ja

  • django实现web接口 python3模拟Post请求方式

    作为抛砖引玉,用python3实现百度云语音解析,首先需要模拟Post请求把音频压缩文件丢给百度解析. 但是遇到一个问题客户端怎麽丢数据都是返回错误,后来在本地用django搭建了一个接口模拟一下,发现还是有地方弄错了! 研究这玩意有啥用? 1.用python做自动化运维,客户端发送收集好的信息(模拟post发送) 2.前后端分离,django只提供数据,前端用vuejs,nodejs实现 3.3端 立体通信 上代码: url.py from django.conf.urls import ur

  • php模拟post提交请求调用接口示例解析

    php模拟post提交请求,调用接口 /** * 模拟post进行url请求 * @param string $url * @param string $param */ function request_post($url = '', $param = '') { if (empty($url) || empty($param)) { return false; } $postUrl = $url; $curlPost = $param; $ch = curl_init();//初始化curl

  • 实例详解jQuery Mockjax 插件模拟 Ajax 请求

    1. 原理 jquery-mockjax是用于mock 前台ajax向后台请求的返回数据. 原理很简单 在你js代码要发送ajax请求的地方断点一下,然后比较在[引入jquery-mockjax] 和 [没有引入jquery-mockjax]的情况下$.ajax.toString()的值情况. 很明显,引入jquery-mockjax时,这个mock库会对jquery提供的ajax函数做替换.这样就很容易能mock起来. 在实际的开发过程中,前端后台协商好了统一的接口,就各自开始自己的任务了.这

  • 使用MUI框架构建App请求http接口实例代码

    简介 最近在看Dcloud的MUI框架,MUI封装了android.ios等多个平台的原生接口,达到开发一个项目,采取不同打包方式,生产多种平台的app. 无可厚非,对于从事java web开发的工程师,带来了极大的福音,再也不用去花太多时间去学习原生的android.ios语言,大大缩短了app开发的学习周期和成本. 当然,既然是做了封装处理,肯定性能上面不如原生.但是Dcloud官方声称MUI是最接近原生App体验的前端框架,并且在一些低端机上的表现也比较理想,想必也做了不少优化处理,另一方

  • PHP socket 模拟POST 请求实例代码

    我们用到最多的模拟POST请求几乎都是使用php curl来实现了,没考虑到PHP socket也可以实现,今天看到朋友写了一文章,下面我来给大家分享一下PHP socket模拟POST请求实例. 以前模拟post请求俺都用PHP curl扩展实现来着,没想过PHP socket也可以实现.最近翻了下相关资料才发现原来没有那么高深,只是以前一直没有完全理解post的原理和本质而已,其实就是发送给目的程序一个标志为post的协议串如下: POST /目的程序url HTTP/1.1 Accept:

  • 模拟HTTP请求实现网页自动操作及数据采集的方法

    前言 网页可分为信息提供和业务操作类,信息提供如新闻.股票行情之类的网站.业务操作如网上营业厅.OA之类的.当然,也有很多网站同时具有这两种性质,像微博.豆瓣.淘宝这类网站,既提供信息,也实现某些业务. 普通上网方式一般都是手动操作(这个不需要解释:D).但有时候人工手动操作的方式可能就无法胜任了,如爬取网络上大量数据,实时监测某个页面的变化,批量操作业务(如批量发微博,批量淘宝购物).刷单等.由于操作量大,而且都是重复的操作,人工操作效率低下,且易出错.这时候就可以使用软件来自动操作了. 本人

  • php curl模拟post请求和提交多维数组的示例代码

    下面一段代码给大家介绍php curl模拟post请求的示例代码,具体代码如下: <?php $uri = "http://www.cnblogs.com/test.php";//这里换成自己的服务器的地址 // 参数数组 $data = array ( 'name' => 'tanteng' // 'password' => 'password' ); $ch = curl_init (); // print_r($ch); curl_setopt ( $ch, C

  • PHP模拟http请求的方法详解

    本文实例讲述了PHP模拟http请求的方法.分享给大家供大家参考,具体如下: 方法一:利用php的socket编程来直接给接口发送数据来模拟post的操作. 建立两个文件post.php,getpost.php post.php内容如下: <?php $flag = 0; $params = ''; $errno = ''; $errstr = ''; //要post的数据 $argv = array( 'var1'=>'abc', 'var2'=>'how are you , my f

随机推荐