Go单测测试 — 数据库 CRUD 的 Mock 测试
今天继续跟着李文周大佬的博客学习Go的单元测试,最近在实践中也总结了一些如何用表格驱动的方式使用 gock Mock测试外部接口调用。以及怎么对GORM做mock测试,这些等这篇学完基础后,后面再单独写文章给大家介绍。
这是Go语言单元测试系列教程的第3篇,介绍了如何使用go-sqlmock
和miniredis
工具进行MySQL
和Redis
的mock
测试。
在上一篇《Go单元测试--模拟服务请求和接口返回》中,我们介绍了如何使用httptest和gock工具进行网络测试。
除了网络依赖之外,我们在开发中也会经常用到各种数据库,比如常见的MySQL和Redis等。本文就分别举例来演示如何在编写单元测试的时候对MySQL和Redis进行mock。
go-sqlmock
sqlmock 是一个实现 sql/driver
的mock库。它不需要建立真正的数据库连接就可以在测试中模拟任何 sql 驱动程序的行为。使用它可以很方便的在编写单元测试的时候mock sql语句的执行结果。
安装
go get github.com/DATA-DOG/go-sqlmock
使用示例
这里使用的是go-sqlmock
官方文档中提供的基础示例代码。在下面的代码中,我们实现了一个recordStats
函数用来记录用户浏览商品时产生的相关数据。具体实现的功能是在一个事务中进行以下两次SQL操作:
在
products
表中将当前商品的浏览次数+1在
product_viewers
表中记录浏览当前商品的用户id
// app.go
package mainimport "database/sql"// recordStats 记录用户浏览产品信息
func recordStats(db *sql.DB, userID, productID int64) (err error) {// 开启事务// 操作views和product_viewers两张表tx, err := db.Begin()if err != nil {return}defer func() {switch err {case nil:err = tx.Commit()default:tx.Rollback()}}()// 更新products表if _, err = tx.Exec("UPDATE products SET views = views + 1"); err != nil {return}// product_viewers表中插入一条数据if _, err = tx.Exec("INSERT INTO product_viewers (user_id, product_id) VALUES (?, ?)",userID, productID); err != nil {return}return
}func main() {// 注意:测试的过程中并不需要真正的连接db, err := sql.Open("mysql", "root@/blog")if err != nil {panic(err)}defer db.Close()// userID为1的用户浏览了productID为5的产品if err = recordStats(db, 1 /*some user id*/, 5 /*some product id*/); err != nil {panic(err)}
}
现在我们需要为代码中的recordStats
函数编写单元测试,但是又不想在测试过程中连接真实的数据库进行测试。这个时候我们就可以像下面示例代码中那样使用sqlmock
工具去mock数据库操作。
package mainimport ("fmt""testing""github.com/DATA-DOG/go-sqlmock"
)// TestShouldUpdateStats sql执行成功的测试用例
func TestShouldUpdateStats(t *testing.T) {// mock一个*sql.DB对象,不需要连接真实的数据库db, mock, err := sqlmock.New()if err != nil {t.Fatalf("an error '%s' was not expected when opening a stub database connection", err)}defer db.Close()// mock执行指定SQL语句时的返回结果mock.ExpectBegin()mock.ExpectExec("UPDATE products").WillReturnResult(sqlmock.NewResult(1, 1))mock.ExpectExec("INSERT INTO product_viewers").WithArgs(2, 3).WillReturnResult(sqlmock.NewResult(1, 1))mock.ExpectCommit()// 将mock的DB对象传入我们的函数中if err = recordStats(db, 2, 3); err != nil {t.Errorf("error was not expected while updating stats: %s", err)}// 确保期望的结果都满足if err := mock.ExpectationsWereMet(); err != nil {t.Errorf("there were unfulfilled expectations: %s", err)}
}// TestShouldRollbackStatUpdatesOnFailure sql执行失败回滚的测试用例
func TestShouldRollbackStatUpdatesOnFailure(t *testing.T) {db, mock, err := sqlmock.New()if err != nil {t.Fatalf("an error '%s' was not expected when opening a stub database connection", err)}defer db.Close()mock.ExpectBegin()mock.ExpectExec("UPDATE products").WillReturnResult(sqlmock.NewResult(1, 1))mock.ExpectExec("INSERT INTO product_viewers").WithArgs(2, 3).WillReturnError(fmt.Errorf("some error"))mock.ExpectRollback()// now we execute our methodif err = recordStats(db, 2, 3); err == nil {t.Errorf("was expecting an error, but there was none")}// we make sure that all expectations were metif err := mock.ExpectationsWereMet(); err != nil {t.Errorf("there were unfulfilled expectations: %s", err)}
}
上面的代码中,定义了一个执行成功的测试用例和一个执行失败回滚的测试用例,确保我们代码中的每个逻辑分支都能被测试到,提高单元测试覆盖率的同时也保证了代码的健壮性。
执行单元测试,看一下最终的测试结果。
❯ go test -v
=== RUN TestShouldUpdateStats
--- PASS: TestShouldUpdateStats (0.00s)
=== RUN TestShouldRollbackStatUpdatesOnFailure
--- PASS: TestShouldRollbackStatUpdatesOnFailure (0.00s)
PASS
ok golang-unit-test-demo/sqlmock_demo 0.011s
可以看到两个测试用例的结果都符合预期,单元测试通过。
在很多使用ORM工具的场景下,也可以使用go-sqlmock
库mock数据库操作进行测试。
miniredis
除了经常用到MySQL外,Redis在日常开发中也会经常用到。接下来的这一小节,我们将一起学习如何在单元测试中mock Redis的相关操作。
miniredis是一个纯go实现的用于单元测试的redis server。它是一个简单易用的、基于内存的redis替代品,它具有真正的TCP接口,你可以把它当成是redis版本的net/http/httptest
。
当我们为一些包含Redis操作的代码编写单元测试时就可以使用它来mock Redis操作。
安装
go get github.com/alicebob/miniredis/v2
使用示例
这里以github.com/go-redis/redis
库为例,编写了一个包含若干Redis操作的DoSomethingWithRedis
函数。
// redis_op.go
package miniredis_demoimport ("context""github.com/go-redis/redis/v8" // 注意导入版本"strings""time"
)const (KeyValidWebsite = "app:valid:website:list"
)func DoSomethingWithRedis(rdb *redis.Client, key string) bool {// 这里可以是对redis操作的一些逻辑ctx := context.TODO()if !rdb.SIsMember(ctx, KeyValidWebsite, key).Val() {return false}val, err := rdb.Get(ctx, key).Result()if err != nil {return false}if !strings.HasPrefix(val, "https://") {val = "https://" + val}// 设置 blog key 五秒过期if err := rdb.Set(ctx, "blog", val, 5*time.Second).Err(); err != nil {return false}return true
}
下面的代码是我使用miniredis
库为DoSomethingWithRedis
函数编写的单元测试代码,其中miniredis
不仅支持mock常用的Redis操作,还提供了很多实用的帮助函数,例如检查key的值是否与预期相等的s.CheckGet()
和帮助检查key过期时间的s.FastForward()
。
// redis_op_test.gopackage miniredis_demoimport ("github.com/alicebob/miniredis/v2""github.com/go-redis/redis/v8""testing""time"
)func TestDoSomethingWithRedis(t *testing.T) {// mock一个redis servers, err := miniredis.Run()if err != nil {panic(err)}defer s.Close()// 准备数据s.Set("q1mi", "liwenzhou.com")s.SAdd(KeyValidWebsite, "q1mi")// 连接mock的redis serverrdb := redis.NewClient(&redis.Options{Addr: s.Addr(), // mock redis server的地址})// 调用函数ok := DoSomethingWithRedis(rdb, "q1mi")if !ok {t.Fatal()}// 可以手动检查redis中的值是否复合预期if got, err := s.Get("blog"); err != nil || got != "https://liwenzhou.com" {t.Fatalf("'blog' has the wrong value")}// 也可以使用帮助工具检查s.CheckGet(t, "blog", "https://liwenzhou.com")// 过期检查s.FastForward(5 * time.Second) // 快进5秒if s.Exists("blog") {t.Fatal("'blog' should not have existed anymore")}
}
执行执行测试,查看单元测试结果:
❯ go test -v
=== RUN TestDoSomethingWithRedis
--- PASS: TestDoSomethingWithRedis (0.00s)
PASS
ok golang-unit-test-demo/miniredis_demo 0.052s
miniredis
基本上支持绝大多数的Redis命令,大家可以通过查看文档了解更多用法。
当然除了使用miniredis
搭建本地redis server这种方法外,还可以使用各种打桩工具对具体方法进行打桩。在编写单元测试时具体使用哪种mock方式还是要根据实际情况来决定。
总结
在日常工作开发中为代码编写单元测试时如何处理数据库的依赖是最常见的问题,本文介绍了如何使用go-sqlmock
和miniredis
工具mock相关依赖。
在下一篇中,我们将更进一步,详细介绍如何在编写单元测试时mock接口实现。
相关阅读
Go单元测试基础
Go单元测试--模拟服务请求和接口返回
- END -
扫码关注公众号「网管叨bi叨」
给网管个星标,第一时间吸我的知识
Go单测测试 — 数据库 CRUD 的 Mock 测试相关推荐
- Spring MVC如何测试Controller(使用springmvc mock测试)
在springmvc中一般的测试用例都是测试service层,今天我来演示下如何使用springmvc mock直接测试controller层代码. 1.什么是mock测试? mock测试就是在测试过 ...
- JAVA测试类注解以及Mock测试
我们在项目中,经常要编写一个测试类XXXXXTest,其中一般会用到以下注解: 一.常用注解 1. @RunWith(PowerMockRunner.class) JUnit将会调用@RunWith中 ...
- mock测试 (mock-test 模仿测试)
mock测试就是在测试过程中,对于某些不容易构造(如 HttpServletRequest 必须在Servlet 容器中才能构造出来)或者不容易获取的对象(如 JDBC 中的ResultSet 对象) ...
- 可能是全网最好的 Spock 单测入门文章!
Spock 是非常简洁规范的单元测试框架,网上很多资料都不齐全,例子也很难懂.我自己经过一段时间的学习,梳理了这篇文章,不仅讲解层次递进,而且还有非常简洁明了的例子,小白都能懂! 快速入门 Spock ...
- 测试过程中为什么要做接口Mock测试,以及如何做
文章目录 关于Mock测试 什么是Mock测试? 为什么要进行Mock测试? Mock对象适用场景 Mock测试的优势 Mock测试存在的问题 Mock测试方式 Mock Server-Moco fi ...
- 使用junit+mockito进行mock测试实例
刚开始做网站的时候,测试都是这样的(比如测试修改用户信息的表单逻辑):设置断点,启动运行程序,登陆,点击点击点击然后进入到测试的页面,输入测试数据,进入断点--..一个大的程序启动又慢,还要登陆,还要 ...
- 电脑软件超时、MOCK测试方案
大家好,我是谭叔. 今天,谭叔跟大家分享我在测试电脑软件(程序)时,模拟超时环境的N种尝试,以及电脑软件(程序)的MOCK测试方案. 超时环境 在日常测试工作中,弱网环境.超时请求等异常测试,是必不可 ...
- mockito mock测试框架
1.简介 mock,[mɒk],adj. 虚拟的,模拟的. 如果你的代码对另一个类或者接口有依赖,mock测试能够帮你模拟这些依赖,从而完成测试. 使用场景: 类A有一个方法fun(B b),它依赖于 ...
- Spring boot Mybatis-Plus数据库单测实战(三种方式)
单元测试长久以来是热门话题,本文不会讨论需不需要写单测,可以看看参考资料1,我个人认为写好单测应该是每个优秀开发者必备的技能,关于写单测的好处在这里我就不展开讨论了,快速进入本文着重讨论的话题,如 ...
最新文章
- ASP.NET HTTP 运行时
- kafka源码分析之二客户端分析
- 照猫画虎,分分钟学会的Matplotlib技巧:反转轴、绘制双轴和定制刻度
- 微软开源 Scalar,提升操作巨型 Git 仓库的速度
- python接口自动化(四十)- logger 日志 - 下(超详解)
- 项目风险管理课程学习
- 1206. 设计跳表
- php mysql异常捕获_PHP中try{}catch{}的用法及异常处理.对数据库的事物支持
- Java的搜索引擎框架
- 在VMware Update Manager(VUM)里添加HP的补丁源
- 嵌入式和单片机,两者的区别
- 2021西安ec final游记
- Diligent调查发现,董事会成员是安全和公司治理的关键环节
- html 恶意广告,电脑自动弹出恶意广告怎么处理
- k3s证书过期的处理 以及 修改k3s证书有效期为10年(或自定义时间)
- commons-lang3 简介、中文文档、中英对照文档 下载
- python实现俄罗斯方块小游戏
- Qt Quick 3D模块初探
- Java设计安全的登录接口
- 思维导图软件PersonalBrain 6.0.6.4破解版使用