# redismock

**Repository Path**: mirrors_reMarkable/redismock

## Basic Information

- **Project Name**: redismock
- **Description**: Redis client Mock
- **Primary Language**: Unknown
- **License**: BSD-2-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-07-30
- **Last Updated**: 2025-10-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Forked from [go-redis/redismock](https://github.com/go-redis/redismock) since it looks unmaintained
Needed support for [ExpectSetArgs](https://github.com/go-redis/redismock/pull/34)

# Redis client Mock

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

## Install

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

```go
go get github.com/reMarkable/redismock/v8
```

## Quick Start

RedisClient
```go
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
```go
clusterClient, clusterMock := redismock.NewClusterMock()
```

## Unsupported Command

RedisClient:

- `Subscribe` / `PSubscribe`


RedisCluster

- `Subscribe` / `PSubscribe`
- `Pipeline` / `TxPipeline`
- `Watch`
- `DBSize`