search

go-redis / redismock

Redis client Mock
https://redis.uptrace.dev
BSD 2-Clause "Simplified" License
271 stars 59 forks source link
go-redis mock redis-mock

readme

Redis client Mock

Provide mock test for redis query, Compatible with github.com/redis/go-redis/v9

Install

Confirm that you are using redis.Client the version is github.com/redis/go-redis/v9

go get github.com/go-redis/redismock/v9

Quick Start

RedisClient

var ctx = context.TODO()

func NewsInfoForCache(redisDB *redis.Client, newsID int) (info string, err error) {
    cacheKey := fmt.Sprintf("news_redis_cache_%d", newsID)
    info, err = redisDB.Get(ctx, cacheKey).Result()
    if err == redis.Nil {
        // info, err = call api()
        info = "test"
        err = redisDB.Set(ctx, cacheKey, info, 30 * time.Minute).Err()
    }
    return
}

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

    newsID := 123456789
    key := fmt.Sprintf("news_redis_cache_%d", newsID)

    // mock ignoring `call api()`

    mock.ExpectGet(key).RedisNil()
    mock.Regexp().ExpectSet(key, `[a-z]+`, 30 * time.Minute).SetErr(errors.New("FAIL"))

    _, err := NewsInfoForCache(db, newsID)
    if err == nil || err.Error() != "FAIL" {
        t.Error("wrong error")
    }

    if err := mock.ExpectationsWereMet(); err != nil {
        t.Error(err)
    }
}

RedisCluster

clusterClient, clusterMock := redismock.NewClusterMock()

Unsupported Command

RedisClient:

RedisCluster