Add redisxtest

redis/cache/redispipebp/init_test.go

@@ -5,14 +5,14 @@ import (
 	"os"
 	"testing"
 
-	"github.com/alicebob/miniredis/v2"
 	"github.com/joomcode/redispipe/redis"
 	"github.com/joomcode/redispipe/redisconn"
 
 	"github.com/reddit/baseplate.go/mqsend"
 	"github.com/reddit/baseplate.go/tracing"
 
 	"github.com/reddit/baseplate.go/redis/cache/redisx"
+	"github.com/reddit/baseplate.go/redis/cache/redisx/redisxtest"
 )
 
 var (
@@ -38,21 +38,18 @@ func TestMain(m *testing.M) {
 		panic(err)
 	}
 
-	s, err := miniredis.Run()
+	redisCluster, err := redisxtest.NewMockRedisCluster()
 	if err != nil {
 		panic(err)
 	}
-	defer s.Close()
+	defer redisCluster.Close()
 
-	sender, err := redisconn.Connect(context.TODO(), s.Addr(), redisconn.Opts{})
+	var clientTeardown func()
+	client, clientTeardown, err = redisxtest.NewMockRedisClient(context.TODO(), redisCluster.Addr(), redisconn.Opts{})
 	if err != nil {
 		panic(err)
 	}
-	defer sender.Close()
-
-	client = redisx.BaseSync{
-		SyncCtx: redis.SyncCtx{S: sender},
-	}
+	defer clientTeardown()
 
 	flushRedis()
 	os.Exit(m.Run())

redis/cache/redisx/redisxtest/doc.go

@@ -0,0 +1,4 @@
+// Package redisxtest provides utilities for baseplate.go/redids/cache/redisx testing.
+//
+// This includes functions for mocking redis instances.
+package redisxtest

redis/cache/redisx/redisxtest/redisxtest.go

@@ -0,0 +1,64 @@
+package redisxtest
+
+import (
+	"context"
+
+	"github.com/alicebob/miniredis/v2"
+	"github.com/joomcode/redispipe/redis"
+	"github.com/joomcode/redispipe/redisconn"
+
+	"github.com/reddit/baseplate.go/redis/cache/redisx"
+)
+
+// MockRedisCluster wraps a local version of redis
+type MockRedisCluster struct {
+	redisCluster *miniredis.Miniredis
+}
+
+func NewMockRedisCluster() (mockRedisCluster MockRedisCluster, err error) {
+	redisCluster, err := miniredis.Run()
+	if err != nil {
+		return MockRedisCluster{}, err
+	}
+
+	return MockRedisCluster{
+		redisCluster: redisCluster,
+	}, nil
+}
+
+// Addr returns address of mock redis cluster e.g. '127.0.0.1:12345'.
+func (mrc *MockRedisCluster) Addr() string {
+	return mrc.redisCluster.Addr()
+}
+
+// Close shuts down the MockRedisCluster
+func (mrc *MockRedisCluster) Close() error {
+	mrc.redisCluster.Close()
+	return nil
+}
+
+// NewMockRedisClient sets up a client and sender to a mock redis cluster
+func NewMockRedisClient(
+	ctx context.Context,
+	address string,
+	opts redisconn.Opts,
+) (client redisx.BaseSync, teardown func(), err error) {
+
+	// Create connection
+	conn, err := redisconn.Connect(ctx, address, opts)
+	if err != nil {
+		return redisx.BaseSync{}, nil, err
+	}
+
+	// Create client
+	client = redisx.BaseSync{
+		SyncCtx: redis.SyncCtx{S: conn},
+	}
+
+	// Teardown closure
+	teardown = func() {
+		conn.Close()
+	}
+
+	return client, teardown, nil
+}