这是Go语言单元测试从零到溜系列教程的第2篇，介绍了如何使用go-sqlmock和miniredis工具进行MySQL和Redis的mock测试。

在上一篇《Go单测从零到溜系列1—网络测试》中，我们介绍了如何使用httptest和gock工具进行网络测试。 除了网络依赖之外，我们在开发中也会经常用到各种数据库，比如常见的MySQL和Redis等。本文就分别举例来演示如何在编写单元测试的时候对MySQL和Redis进行mock。

《Go单测从零到溜系列》的示例代码已上传至Github，点击👉🏻https://github.com/Q1mi/golang-unit-test-demo 查看完整源代码。

go-sqlmock

sqlmock 是一个实现 sql/driver 的mock库。它不需要建立真正的数据库连接就可以在测试中模拟任何 sql 驱动程序的行为。使用它可以很方便的在编写单元测试的时候mock sql语句的执行结果。

安装

  1. go get github.com/DATA-DOG/go-sqlmock

使用示例

这里使用的是go-sqlmock官方文档中提供的基础示例代码。 在下面的代码中，我们实现了一个recordStats函数用来记录用户浏览商品时产生的相关数据。具体实现的功能是在一个事务中进行以下两次SQL操作：

  1. 在products表中将当前商品的浏览次数+1
  2. 在product_viewers表中记录浏览当前商品的用户id
  1. // app.go
  2. package main
  4. import "database/sql"
  6. // recordStats 记录用户浏览产品信息
  7. func recordStats(db *sql.DB, userID, productID int64) (err error) {
  8.     // 开启事务
  9.     // 操作views和product_viewers两张表
  10.     tx, err := db.Begin()
  11.     if err != nil {
  12.         return
  13.     }
  15.     defer func() {
  16.         switch err {
  17.         case nil:
  18.             err = tx.Commit()
  19.         default:
  20.             tx.Rollback()
  21.         }
  22.     }()
  24.     // 更新products表
  25.     if _, err = tx.Exec("UPDATE products SET views = views + 1"); err != nil {
  26.         return
  27.     }
  28.     // product_viewers表中插入一条数据
  29.     if _, err = tx.Exec(
  30.         "INSERT INTO product_viewers (user_id, product_id) VALUES (?, ?)",
  31.         userID, productID); err != nil {
  32.         return
  33.     }
  34.     return
  35. }
  37. func main() {
  38.     // 注意：测试的过程中并不需要真正的连接
  39.     db, err := sql.Open("mysql", "root@/blog")
  40.     if err != nil {
  41.         panic(err)
  42.     }
  43.     defer db.Close()
  44.     // userID为1的用户浏览了productID为5的产品
  45.     if err = recordStats(db, 1 /*some user id*/, 5 /*some product id*/); err != nil {
  46.         panic(err)
  47.     }
  48. }

现在我们需要为代码中的recordStats函数编写单元测试，但是又不想在测试过程中连接真实的数据库进行测试。这个时候我们就可以像下面示例代码中那样使用sqlmock工具去mock数据库操作。

  1. package main
  3. import (
  4.     "fmt"
  5.     "testing"
  7.     "github.com/DATA-DOG/go-sqlmock"
  8. )
  10. // TestShouldUpdateStats sql执行成功的测试用例
  11. func TestShouldUpdateStats(t *testing.T) {
  12.     // mock一个*sql.DB对象，不需要连接真实的数据库
  13.     db, mock, err := sqlmock.New()
  14.     if err != nil {
  15.         t.Fatalf("an error '%s' was not expected when opening a stub database connection", err)
  16.     }
  17.     defer db.Close()
  19.     // mock执行指定SQL语句时的返回结果
  20.     mock.ExpectBegin()
  21.     mock.ExpectExec("UPDATE products").WillReturnResult(sqlmock.NewResult(1, 1))
  22.     mock.ExpectExec("INSERT INTO product_viewers").WithArgs(2, 3).WillReturnResult(sqlmock.NewResult(1, 1))
  23.     mock.ExpectCommit()
  25.     // 将mock的DB对象传入我们的函数中
  26.     if err = recordStats(db, 2, 3); err != nil {
  27.         t.Errorf("error was not expected while updating stats: %s", err)
  28.     }
  30.     // 确保期望的结果都满足
  31.     if err := mock.ExpectationsWereMet(); err != nil {
  32.         t.Errorf("there were unfulfilled expectations: %s", err)
  33.     }
  34. }
  36. // TestShouldRollbackStatUpdatesOnFailure sql执行失败回滚的测试用例
  37. func TestShouldRollbackStatUpdatesOnFailure(t *testing.T) {
  38.     db, mock, err := sqlmock.New()
  39.     if err != nil {
  40.         t.Fatalf("an error '%s' was not expected when opening a stub database connection", err)
  41.     }
  42.     defer db.Close()
  44.     mock.ExpectBegin()
  45.     mock.ExpectExec("UPDATE products").WillReturnResult(sqlmock.NewResult(1, 1))
  46.     mock.ExpectExec("INSERT INTO product_viewers").
  47.         WithArgs(2, 3).
  48.         WillReturnError(fmt.Errorf("some error"))
  49.     mock.ExpectRollback()
  51.     // now we execute our method
  52.     if err = recordStats(db, 2, 3); err == nil {
  53.         t.Errorf("was expecting an error, but there was none")
  54.     }
  56.     // we make sure that all expectations were met
  57.     if err := mock.ExpectationsWereMet(); err != nil {
  58.         t.Errorf("there were unfulfilled expectations: %s", err)
  59.     }
  60. }

上面的代码中，定义了一个执行成功的测试用例和一个执行失败回滚的测试用例，确保我们代码中的每个逻辑分支都能被测试到，提高单元测试覆盖率的同时也保证了代码的健壮性。

执行单元测试，看一下最终的测试结果。

  1. ❯ go test -v
  2. === RUN   TestShouldUpdateStats
  3. --- PASS: TestShouldUpdateStats (0.00s)
  4. === RUN   TestShouldRollbackStatUpdatesOnFailure
  5. --- PASS: TestShouldRollbackStatUpdatesOnFailure (0.00s)
  6. PASS
  7. 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操作。

安装

  1. go get github.com/alicebob/miniredis/v2

使用示例

这里以github.com/go-redis/redis库为例，编写了一个包含若干Redis操作的DoSomethingWithRedis函数。

  1. // redis_op.go
  2. package miniredis_demo
  4. import (
  5.     "context"
  6.     "github.com/go-redis/redis/v8" // 注意导入版本
  7.     "strings"
  8.     "time"
  9. )
  11. const (
  12.     KeyValidWebsite = "app:valid:website:list"
  13. )
  15. func DoSomethingWithRedis(rdb *redis.Client, key string) bool {
  16.     // 这里可以是对redis操作的一些逻辑
  17.     ctx := context.TODO()
  18.     if !rdb.SIsMember(ctx, KeyValidWebsite, key).Val() {
  19.         return false
  20.     }
  21.     val, err := rdb.Get(ctx, key).Result()
  22.     if err != nil {
  23.         return false
  24.     }
  25.     if !strings.HasPrefix(val, "https://") {
  26.         val = "https://" + val
  27.     }
  28.     // 设置 blog key 五秒过期
  29.     if err := rdb.Set(ctx, "blog", val, 5*time.Second).Err(); err != nil {
  30.         return false
  31.     }
  32.     return true
  33. }

下面的代码是我使用miniredis库为DoSomethingWithRedis函数编写的单元测试代码，其中miniredis不仅支持mock常用的Redis操作，还提供了很多实用的帮助函数，例如检查key的值是否与预期相等的s.CheckGet()和帮助检查key过期时间的s.FastForward()。

  1. // redis_op_test.go
  3. package miniredis_demo
  5. import (
  6.     "github.com/alicebob/miniredis/v2"
  7.     "github.com/go-redis/redis/v8"
  8.     "testing"
  9.     "time"
  10. )
  12. func TestDoSomethingWithRedis(t *testing.T) {
  13.     // mock一个redis server
  14.     s, err := miniredis.Run()
  15.     if err != nil {
  16.         panic(err)
  17.     }
  18.     defer s.Close()
  20.     // 准备数据
  21.     s.Set("q1mi", "liwenzhou.com")
  22.     s.SAdd(KeyValidWebsite, "q1mi")
  24.     // 连接mock的redis server
  25.     rdb := redis.NewClient(&redis.Options{
  26.         Addr: s.Addr(), // mock redis server的地址
  27.     })
  29.     // 调用函数
  30.     ok := DoSomethingWithRedis(rdb, "q1mi")
  31.     if !ok {
  32.         t.Fatal()
  33.     }
  35.     // 可以手动检查redis中的值是否复合预期
  36.     if got, err := s.Get("blog"); err != nil || got != "https://liwenzhou.com" {
  37.         t.Fatalf("'blog' has the wrong value")
  38.     }
  39.     // 也可以使用帮助工具检查
  40.     s.CheckGet(t, "blog", "https://liwenzhou.com")
  42.     // 过期检查
  43.     s.FastForward(5 * time.Second) // 快进5秒
  44.     if s.Exists("blog") {
  45.         t.Fatal("'blog' should not have existed anymore")
  46.     }
  47. }

执行执行测试，查看单元测试结果：

  1. ❯ go test -v
  2. === RUN   TestDoSomethingWithRedis
  3. --- PASS: TestDoSomethingWithRedis (0.00s)
  4. PASS
  5. ok      golang-unit-test-demo/miniredis_demo    0.052s

miniredis基本上支持绝大多数的Redis命令，大家可以通过查看文档了解更多用法。

当然除了使用miniredis搭建本地redis server这种方法外，还可以使用各种打桩工具对具体方法进行打桩。在编写单元测试时具体使用哪种mock方式还是要根据实际情况来决定。

总结

在日常工作开发中为代码编写单元测试时如何处理数据库的依赖是最常见的问题，本文介绍了如何使用go-sqlmock和miniredis工具mock相关依赖。 在下一篇中，我们将更进一步，详细介绍如何在编写单元测试时mock接口。