Go 语言中对 Redis 和 SQL 操作进行单元测试

在这篇博客文章中，我们将探讨如何在 Go 语言中使用 RedisMock 库和 SQLMock 库进行单元测试。我们将通过一个简单的示例项目展示如何为数据库操作编写单元测试，并确保我们的代码按预期工作。

项目结构

我们的项目包含以下文件：

  • sql.go：包含数据库操作的实现。
  • sql_test.go：包含数据库操作的单元测试。
  • redis.go：包含 Redis 操作的实现。
  • redis_test.go：包含 Redis 操作的单元测试。

数据库操作实现 sql.go

首先，我们定义了一个 User 结构体和一个 Data 结构体，用于封装数据库操作。

package main

import (
    "context"
    "time"

    "gorm.io/gorm"
)

type User struct {
    ID       int       `gorm:"primaryKey column:id"`
    Birthday time.Time `gorm:"column:birthday"`
    Username string    `gorm:"column:username"`
}

func (u User) TableName() string {
    return "users"
}

type Data struct {
    DB *gorm.DB
}

func (d *Data) Create(ctx context.Context, user *User) error {
    return d.DB.Create(user).Error
}

func (d *Data) Get(ctx context.Context, id int) (*User, error) {
    var user User
    err := d.DB.Where("`id` = ?", id).First(&user).Error
    return &user, err
}

func (d *Data) Update(ctx context.Context, user *User) error {
    return d.DB.Save(user).Error
}

func (d *Data) Delete(ctx context.Context, id int) error {
    return d.DB.Where(`id = ?`, id).Delete(User{}).Error
}

数据库操作单元测试 sql_test.go

接下来，我们使用 SQLMock 库为数据库操作编写单元测试。

package main

import (
    "context"
    "testing"
    "time"

    "github.com/DATA-DOG/go-sqlmock"
    "github.com/stretchr/testify/assert"
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

func initTestDB() (*gorm.DB, sqlmock.Sqlmock, error) {
    db, mock, err := sqlmock.New(sqlmock.QueryMatcherOption(sqlmock.QueryMatcherEqual))
    if err != nil {
        return nil, nil, err
    }

    mock.ExpectQuery("SELECT VERSION()").WillReturnRows(sqlmock.NewRows([]string{"version"}).AddRow("8.0.23"))

    gormDB, err := gorm.Open(mysql.New(mysql.Config{
        Conn: db,
    }))
    if err != nil {
        return nil, nil, err
    }

    return gormDB, mock, nil
}

func TestData_Create(t *testing.T) {
    gormDB, mock, err := initTestDB()
    assert.NoError(t, err)

    birthday, err := time.Parse("2006-01-02", "2021-01-01")
    assert.NoError(t, err)

    user := &User{
        ID:       1,
        Birthday: birthday,
        Username: "test",
    }

    mock.ExpectBegin()
    mock.ExpectExec("INSERT INTO `users` (`birthday`,`username`,`id`) VALUES (?,?,?)").
        WithArgs(user.Birthday, user.Username, user.ID).
        WillReturnResult(sqlmock.NewResult(1, 1))
    mock.ExpectCommit()

    data := &Data{DB: gormDB}

    err = data.Create(context.Background(), user)
    assert.NoError(t, err)

    assert.NoError(t, mock.ExpectationsWereMet())
}

func TestData_Get(t *testing.T) {
    gormDB, mock, err := initTestDB()
    assert.NoError(t, err)

    userID := 1
    birthday, err := time.Parse("2006-01-02", "2021-01-01")
    assert.NoError(t, err)

    rows := sqlmock.NewRows([]string{"id", "birthday", "username"}).
        AddRow(userID, birthday, "test")

    mock.ExpectQuery("SELECT * FROM `users` WHERE `id` = ? ORDER BY `users`.`id` LIMIT ?").
        WithArgs(userID, 1).
        WillReturnRows(rows)

    data := &Data{DB: gormDB}

    user, err := data.Get(context.Background(), userID)
    assert.NoError(t, err)

    assert.Equal(t, userID, user.ID)
    assert.Equal(t, birthday, user.Birthday)
    assert.Equal(t, "test", user.Username)

    assert.NoError(t, mock.ExpectationsWereMet())
}

func TestData_Update(t *testing.T) {
    gormDB, mock, err := initTestDB()
    assert.NoError(t, err)

    birthday, err := time.Parse("2006-01-02", "2021-01-01")
    assert.NoError(t, err)

    user := &User{
        ID:       1,
        Birthday: birthday,
        Username: "test",
    }

    mock.ExpectBegin()
    mock.ExpectExec("UPDATE `users` SET `birthday`=?,`username`=? WHERE `id` = ?").
        WithArgs(user.Birthday, user.Username, user.ID).
        WillReturnResult(sqlmock.NewResult(1, 1))
    mock.ExpectCommit()

    data := &Data{DB: gormDB}

    err = data.Update(context.Background(), user)
    assert.NoError(t, err)
    assert.NoError(t, mock.ExpectationsWereMet())
}

func TestData_Delete(t *testing.T) {
    gormDB, mock, err := initTestDB()
    assert.NoError(t, err)

    userID := 1

    mock.ExpectBegin()
    mock.ExpectExec("DELETE FROM `users` WHERE id = ?").
        WithArgs(userID).
        WillReturnResult(sqlmock.NewResult(1, 1))
    mock.ExpectCommit()

    data := &Data{DB: gormDB}

    err = data.Delete(context.Background(), userID)
    assert.NoError(t, err)

    assert.NoError(t, mock.ExpectationsWereMet())
}

Redis 操作实现 redis.go

我们还定义了一个 SessionStore 结构体，用于封装 Redis 操作。

package main

import (
    "context"
    "time"

    "github.com/redis/go-redis/v9"
)

type SessionStore struct {
    redisClient redis.UniversalClient
}

func NewSessionStore(redisClient redis.UniversalClient) *SessionStore {
    return &SessionStore{redisClient: redisClient}
}

func (s *SessionStore) GetSession(ctx context.Context, key string) (string, error) {
    return s.redisClient.Get(ctx, key).Result()
}

func (s *SessionStore) SetSession(ctx context.Context, key, value string, expiration time.Duration) error {
    return s.redisClient.Set(ctx, key, value, expiration).Err()
}

Redis 操作单元测试 redis_test.go

最后，我们使用 Redismock 库为 Redis 操作编写单元测试。

import (
    "context"
    "testing"
    "time"

    "github.com/go-redis/redismock/v9"
    "github.com/stretchr/testify/assert"
)

func TestSessionStore_GetSession(t *testing.T) {
    db, mock := redismock.NewClientMock()

    store := NewSessionStore(db)

    key := "test-key"
    value := "test-value"
    mock.ExpectGet(key).SetVal(value)

    result, err := store.GetSession(context.Background(), key)

    assert.Nil(t, err)
    assert.Equal(t, value, result)
    assert.NoError(t, mock.ExpectationsWereMet())
}

func TestSessionStore_SetSession(t *testing.T) {
    db, mock := redismock.NewClientMock()

    store := NewSessionStore(db)

    key := "test-key"
    value := "test-value"
    expiration := 10 * time.Minute
    mock.ExpectSet(key, value, expiration).SetVal("OK")

    err := store.SetSession(context.Background(), key, value, expiration)
    assert.NoError(t, err)
    assert.NoError(t, mock.ExpectationsWereMet())
}

执行单元测试

通过go test -v ./...对当前项目进行单元测试。结果如下：

image.png

总结

通过本文，我们展示了如何使用 SQLMock 和 Redismock 库为 Go 语言中的数据库和 Redis 操作编写单元测试。希望这篇文章能帮助你更好地理解和应用这些工具，提高代码的可靠性和可维护性。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 219,188评论 6赞 508
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 93,464评论 3赞 395
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 165,562评论 0赞 356
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,893评论 1赞 295
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,917评论 6赞 392
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,708评论 1赞 305
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,430评论 3赞 420
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 39,342评论 0赞 276
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,801评论 1赞 317
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,976评论 3赞 337
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,115评论 1赞 351
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,804评论 5赞 346
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,458评论 3赞 331
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,008评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,135评论 1赞 272
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 48,365评论 3赞 373
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 45,055评论 2赞 355