Go 单元测试之HTTP请求与API测试

news2025/4/20 15:07:57

文章目录

    • 一、httptest
      • 1.1 前置代码准备
      • 1.2 介绍
      • 1.3 基本用法
    • 二、gock
      • 2.1介绍
      • 2.2 安装
      • 2.3 基本使用
      • 2.4 举个例子
        • 2.4.1 前置代码
        • 2.4.2 测试用例

一、httptest

1.1 前置代码准备

假设我们的业务逻辑是搭建一个http server端，对外提供HTTP服务。用来处理用户登录请求，用户需要输入邮箱，密码。

package main

import (
	regexp "github.com/dlclark/regexp2"
	"github.com/gin-gonic/gin"
	"net/http"
)

type UserHandler struct {
	emailExp    *regexp.Regexp
	passwordExp *regexp.Regexp
}

func (u *UserHandler) RegisterRoutes(server *gin.Engine) {
	ug := server.Group("/user")
	ug.POST("/login", u.Login)
}
func NewUserHandler() *UserHandler {
	const (
		emailRegexPattern    = "^\\w+([-+.]\\w+)*@\\w+([-.]\\w+)*\\.\\w+([-.]\\w+)*$"
		passwordRegexPattern = `^(?=.*[A-Za-z])(?=.*\d)(?=.*[$@$!%*#?&])[A-Za-z\d$@$!%*#?&]{8,}$`
	)
	emailExp := regexp.MustCompile(emailRegexPattern, regexp.None)
	passwordExp := regexp.MustCompile(passwordRegexPattern, regexp.None)
	return &UserHandler{
		emailExp:    emailExp,
		passwordExp: passwordExp,
	}
}

type LoginRequest struct {
	Email string `json:"email"`
	Pwd   string `json:"pwd"`
}

func (u *UserHandler) Login(ctx *gin.Context) {
	var req LoginRequest
	if err := ctx.ShouldBindJSON(&req); err != nil {
		ctx.JSON(http.StatusBadRequest, gin.H{"msg": "参数不正确!"})
		return
	}

	// 校验邮箱和密码是否为空
	if req.Email == "" || req.Pwd == "" {
		ctx.JSON(http.StatusBadRequest, gin.H{"msg": "邮箱或密码不能为空"})
		return
	}

	// 正则校验邮箱
	ok, err := u.emailExp.MatchString(req.Email)
	if err != nil {
		ctx.JSON(http.StatusInternalServerError, gin.H{"msg": "系统错误!"})
		return
	}
	if !ok {
		ctx.JSON(http.StatusBadRequest, gin.H{"msg": "邮箱格式不正确"})
		return
	}

	// 校验密码格式
	ok, err = u.passwordExp.MatchString(req.Pwd)
	if err != nil {
		ctx.JSON(http.StatusInternalServerError, gin.H{"msg": "系统错误!"})
		return
	}
	if !ok {
		ctx.JSON(http.StatusBadRequest, gin.H{"msg": "密码必须大于8位，包含数字、特殊字符"})
		return
	}

	// 校验邮箱和密码是否匹配特定的值来确定登录成功与否
	if req.Email != "123@qq.com" || req.Pwd != "hello#world123" {
		ctx.JSON(http.StatusBadRequest, gin.H{"msg": "邮箱或密码不匹配!"})
		return
	}

	ctx.JSON(http.StatusOK, gin.H{"msg": "登录成功!"})
}

func InitWebServer(userHandler *UserHandler) *gin.Engine {
	server := gin.Default()
	userHandler.RegisterRoutes(server)
	return server
}

func main() {
	uh := &UserHandler{}
	server := InitWebServer(uh)
	server.Run(":8080") // 在8080端口启动服务器
}

1.2 介绍

在 Web 开发场景下，单元测试经常需要模拟 HTTP 请求和响应。使用 httptest 可以让我们在测试代码中创建一个 HTTP 服务器实例，并定义特定的请求和响应行为，从而模拟真实世界的网络交互，在Go语言中，一般都推荐使用Go标准库 net/http/httptest 进行测试。

1.3 基本用法

使用 httptest 的基本步骤如下：

  1. 导入 net/http/httptest 包。
  2. 创建一个 httptest.Server 实例，并指定你想要的服务器行为。
  3. 在测试代码中使用 httptest.NewRequest 创建一个模拟的 HTTP 请求，并将其发送到 httptest.Server。
  4. 检查响应内容或状态码是否符合预期。

以下是一个简单的 httptest 用法示例

package main

import (
	"bytes"
	"github.com/gin-gonic/gin"
	"github.com/stretchr/testify/assert"
	"net/http"
	"net/http/httptest"
	"testing"
)

func TestUserHandler_Login(t *testing.T) {
	// 定义测试用例
	testCases := []struct {
		name     string
		reqBody  string
		wantCode int
		wantBody string
	}{
		{
			name:     "登录成功",
			reqBody:  `{"email": "123@qq.com", "pwd": "hello#world123"}`,
			wantCode: http.StatusOK,
			wantBody: `{"msg": "登录成功!"}`,
		},
		{
			name:     "参数不正确",
			reqBody:  `{"email": "123@qq.com", "pwd": "hello#world123",}`,
			wantCode: http.StatusBadRequest,
			wantBody: `{"msg": "参数不正确!"}`,
		},
		{
			name:     "邮箱或密码为空",
			reqBody:  `{"email": "", "pwd": ""}`,
			wantCode: http.StatusBadRequest,
			wantBody: `{"msg": "邮箱或密码不能为空"}`,
		},
		{
			name:     "邮箱格式不正确",
			reqBody:  `{"email": "invalidemail", "pwd": "hello#world123"}`,
			wantCode: http.StatusBadRequest,
			wantBody: `{"msg": "邮箱格式不正确"}`,
		},
		{
			name:     "密码格式不正确",
			reqBody:  `{"email": "123@qq.com", "pwd": "invalidpassword"}`,
			wantCode: http.StatusBadRequest,
			wantBody: `{"msg": "密码必须大于8位，包含数字、特殊字符"}`,
		},
		{
			name:     "邮箱或密码不匹配",
			reqBody:  `{"email": "123123@qq.com", "pwd": "hello#world123"}`,
			wantCode: http.StatusBadRequest,
			wantBody: `{"msg": "邮箱或密码不匹配!"}`,
		},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			// 创建一个 gin 的上下文
			server := gin.Default()
			h := NewUserHandler()
			h.RegisterRoutes(server)
			// mock 创建一个 http 请求
			req, err := http.NewRequest(
				http.MethodPost,                     // 请求方法
				"/user/login",                       // 请求路径
				bytes.NewBuffer([]byte(tc.reqBody)), // 请求体
			)
			// 断言没有错误
			assert.NoError(t, err)
			// 设置请求头
			req.Header.Set("Content-Type", "application/json")
			// 创建一个响应
			resp := httptest.NewRecorder()
			// 服务端处理请求
			server.ServeHTTP(resp, req)
			// 断言响应码和响应体
			assert.Equal(t, tc.wantCode, resp.Code)
			// 断言 JSON 字符串是否相等
			assert.JSONEq(t, tc.wantBody, resp.Body.String())
		})
	}
}

在这个例子中，我们创建了一个简单的 HTTP 请求，TestUserHandler_Login 函数定义了一个测试函数，用于测试用户登录功能的不同情况。

  1. testCases 列表定义了多个测试用例，每个测试用例包含了测试名称、请求体、期望的 HTTP 状态码和期望的响应体内容。
  2. 使用 for 循环遍历测试用例列表，每次循环创建一个新的测试子函数，并在其中模拟 HTTP 请求发送给登录接口。
  3. 在每个测试子函数中，先创建一个 Gin 的默认上下文和用户处理器 UserHandler，然后注册路由并创建一个模拟的 HTTP 请求。
  4. 通过 httptest.NewRecorder() 创建一个响应记录器，使用 server.ServeHTTP(resp, req) 处理模拟请求，得到响应结果。
  5. 最后使用断言来验证实际响应的 HTTP 状态码和响应体是否与测试用例中的期望一致。

最后,使用Goland 运行测试,结果如下:

二、gock

2.1介绍

gock 可以帮助你在测试过程中模拟 HTTP 请求和响应，这对于测试涉及外部 API 调用的应用程序非常有用。它可以让你轻松地定义模拟请求，并验证你的应用程序是否正确处理了这些请求。

GitHub 地址：github.com/h2non/gock

2.2 安装

你可以通过以下方式安装 gock：

go get -u github.com/h2non/gock

导入 gock 包：

import "github.com/h2non/gock"

2.3 基本使用

gock 的基本用法如下：

  1. 启动拦截器：在测试开始前，使用 gock.New 函数启动拦截器，并指定你想要拦截的域名和端口。
  2. 定义拦截规则：你可以使用 gock.Intercept 方法来定义拦截规则，比如拦截特定的 URL、方法、头部信息等。
  3. 设置响应：你可以使用 gock.NewJson、gock.NewText 等方法来设置拦截后的响应内容。
  4. 运行测试：在定义了拦截规则和响应后，你可以运行测试，gock 会拦截你的 HTTP 请求，并返回你设置的响应。

2.4 举个例子

2.4.1 前置代码

如果我们是在代码中请求外部API的场景（比如通过API调用其他服务获取返回值）又该怎么编写单元测试呢？

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

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

2.4.2 测试用例

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

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

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1601973.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

抢抓新机遇，助力资源暴增，CBTC上海储能展邀您报名参加

抢抓新机遇，助力资源暴增，CBTC上海储能展邀您报名参加

伴随全球能源革命提速，推动能源革命、构建新型电力系统成为全球共识。新型储能作为协调“源网荷储”互动、平衡电力动态供需的核心环节，已成为实现“碳达峰、碳中和”国家战略的重要支撑。经历“十三五”国家多维政策的持续孕育，“十四五”新…
阅读更多...
“打呼噜”用英语怎么说？柯桥成人英语培训

“打呼噜”用英语怎么说？柯桥成人英语培训

泓畅教育：#18757519765# 失眠的英文表达，一般有以下几种： 1. 如果只是偶尔睡不着，最简单的表达就是： 例句： I cant sleep. Are you still up? 我睡不着。你睡了吗？ I cant fall asleep. …
阅读更多...
LeetCode 179 in Python. Largest Number (最大数)

LeetCode 179 in Python. Largest Number (最大数)

寻找最大数的逻辑简单，但如何对两数比较组成更大的整数是一个重点。例如示例2中如何区分3与30谁放在前面以及3与34谁放在前面是一个难点，本文通过采用functools中的自定义排序规则cmp_to_key()来判断上述情况，并给出代码实现。 示例&#xf…
阅读更多...
CTFshow-PWN-前置基础（pwn17）

CTFshow-PWN-前置基础（pwn17）

有些命令好像有点不一样？ 不要一直等，可能那样永远也等不到flag nc 上后，经过简单测试，1 和 4 并没有什么重要信息 3 会陷入一个等待，题目有说明不要一直等 ，而 5 是退出，因此猜测突破口在 2 键…
阅读更多...
基于springboot实现知识管理系统项目【项目源码+论文说明】

基于springboot实现知识管理系统项目【项目源码+论文说明】

基于springboot实现知识管理系统演示 摘要 随着信息互联网信息的飞速发展，无纸化作业变成了一种趋势，针对这个问题开发一个专门适应师生作业交流形式的网站。本文介绍了知识管理系统的开发全过程。通过分析企业对于知识管理系统的需求，创建了…
阅读更多...
FANUC发那科机器人示教器维修A05B-2490-C176

FANUC发那科机器人示教器维修A05B-2490-C176

维修的fanuc发那科产品包括：发那科cnc数控系统,发那科伺服驱动器和伺服电机维修,发那科机器人维修，以及fanuc主轴驱动模块维修,发那科模块电源维修,数控系统电路板维修等。 1 发那科示教器液晶屏不好、花屏、白屏、黑屏、闪屏、竖线、摔破 2 FANUC示教…
阅读更多...
[leetcode] 55. 跳跃游戏

[leetcode] 55. 跳跃游戏

文章目录 题目描述解题方法模拟java代码复杂度分析 相似题目 题目描述 给你一个非负整数数组 nums ，你最初位于数组的 第一个下标 。数组中的每个元素代表你在该位置可以跳跃的最大长度。 判断你是否能够到达最后一个下标，如果可以，返回 tr…
阅读更多...
Redis中的订阅发布(一)

Redis中的订阅发布(一)

订阅发布 概述 Redis的发布与订阅功能由PUBLISH、SUBSCRIBE、PSUBSCRIBE等命令组成。通过执行SUBSCRIBER命令，客户端可以订阅一个或多个频道，从而成为这些频道的订阅者(subscribe)： 每当有其他客户端向被订阅的频道发送消息(message)时&…
阅读更多...
springboot源码解析(一):启动过程

springboot源码解析(一):启动过程

springboot源码解析(一):启动过程 1、springboot的入口程序 SpringBootApplication public class StartupApplication {public static void main(String[] args) {SpringApplication.run(StartupApplication.class, args);} }当程序开始执行之后，会调用SpringAppli…
阅读更多...
蓝桥杯第十五届javab组个人总结

蓝桥杯第十五届javab组个人总结

javab组 额今天早上打完了得对自己此次比赛做总结，无论是明年还参赛还是研究生蓝桥杯，体验感有点差，第一题其实一开始想手算但怕进位导致不准确还是让代码跑了，但跑第202420242024个数（被20和24整除）一直把…
阅读更多...
开展在即！中银富登邀您共赴雄安2024数字城市展览会（雄安建博会）

开展在即！中银富登邀您共赴雄安2024数字城市展览会（雄安建博会）

中银富登村镇银行：雄安新区金融创新的领航者 在即将举办的2024雄安数字城市建设展览会上，中银富登村镇银行将以其在金融创新和普惠金融服务领域的卓越表现，成为展会的一大亮点。作为雄安新区首家全国性银行业金融机构总部，中银富…
阅读更多...
谈谈微前端

谈谈微前端

相关问题 为什么要用微前端微前端的优缺点 回答关键点 独立开发 独立运行 独立部署 自治 微前端是一种架构理念，它将较大的前端应用拆分为若干个可以独立交付的前端应用。这样的好处是每个应用大小及复杂度相对可控。在合理拆分应用的前提下，微前端能…
阅读更多...
SQL--约束

SQL--约束

文章目录 约束约束的分类：按照约束的作用效果不同唯一约束主键约束外键约束检查约束非空约束默认值约束 按照是否跟随列和字段属性来创建约束行级约束表级约束 创建约束创建唯一约束创建完表之后创建唯一约束创建表的同时创建唯一约束行级约束表级约束 约束 CONSTR…
阅读更多...
高标准化及可扩展的产品能力，助力声通科技运营效率不断提升

高标准化及可扩展的产品能力，助力声通科技运营效率不断提升

高标准化及可扩展的产品能力对企业发展具有重要意义，有助于企业提高运营效率、增强市场竞争力，并推动企业实现规模化发展。上海声通信息科技股份有限公司（下文称：声通科技或公司）作为我国领先的企业级全栈交互式人工智…
阅读更多...
GIS数据制备，空间分析与高级建模教程

GIS数据制备，空间分析与高级建模教程

原文链接：GIS数据制备，空间分析与高级建模教程https://mp.weixin.qq.com/s?__bizMzUzNTczMDMxMg&mid2247601619&idx6&sn0231cde04d3657377587bd8015faf0e9&chksmfa820c34cdf58522df5a6eb2f44ee60630fd2d1132aa4517928a86591cc602da93aa…
阅读更多...
常见的垃圾回收器（下）

常见的垃圾回收器（下）

文章目录 G1ShenandoahZGC 常见垃圾回收期（上） G1 参数1： -XX:UseG1GC 打开G1的开关，JDK9之后默认不需要打开 参数2：-XX:MaxGCPauseMillis毫秒值 最大暂停的时间 回收年代和算法 ● 年轻代老年代 ● 复制算法 优点…
阅读更多...
测试用例的编写

测试用例的编写

🍅 视频学习：文末有免费的配套视频可观看 🍅 点击文末小卡片 ，免费获取软件测试全套资料，资料在手，涨薪更快 软件测试用例得出软件测试用例的内容，其次，按照软件测试写作方法&#x…
阅读更多...
nextjs渲染篇

nextjs渲染篇

1 服务器组件 默认情况下，Next.js 使用服务器组件。 1.1 服务器组件是如何呈现的？ 在服务器上，Next.js 使用 React 的 API 来编排渲染。渲染工作被拆分为多个块：按单个路段和Suspense 每个区块分两个步骤呈现： Re…
阅读更多...
程序中调用DB存储过程记得异常处理时尝试回滚可能存在的事务

程序中调用DB存储过程记得异常处理时尝试回滚可能存在的事务

程序中调用DB过程要注意这种情况： 有些存储过程需要执行比较久，在数据库中直接跑本身没有出错，但从程序中调用该存储过程会由于超时进入程序异常处理，这时数据库后台依然在跑着该存储过程，如果该存储过程中有启用事务…
阅读更多...
选择生产制造项目管理系统？全面解析功能与实际应用！

选择生产制造项目管理系统？全面解析功能与实际应用！

生产效率和项目规划是制造企业亟需解决的难题，想要从容的应对这些挑战，离不开好用的生产制造项目管理系统。下面我们全面解析什么才能称得上是好用的生产制造项目管理系统。 一、好用的生产制造项目管理系统 什么样的项目管理系统才能算是好用呢&#x…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023