package/storage
1
0
Fork 0
mirror of https://github.com/gofiber/storage.git synced 2025-10-05 16:48:25 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: consume the testredis module in valkey

Browse Source
This commit is contained in:
Manuel de la Peña
2025-04-30 13:21:16 +02:00
parent 5b7af066bb
commit 892e6fec63
5 changed files with 377 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

195
valkey/valkey_test.go
View File

@@ -1,17 +1,55 @@
package valkey
import (
"crypto/tls"
"log"
"os"
"testing"
"time"
"github.com/stretchr/testify/require"
testredis "github.com/gofiber/storage/testhelpers/redis"
)
var testStore = New(Config{
Reset: true,
})
const (
// valkeyImage is the default image used for running Valkey in tests.
valkeyImage = "valkey/valkey:8"
valkeyImageEnvVar = "TEST_VALKEY_IMAGE"
)
// newConfigFromContainer creates a Redis configuration using Testcontainers.
// It configures the container based on the provided options and returns a Config
// that can be used to connect to the container.
// The container is cleaned up when the test completes.
func newConfigFromContainer(t testing.TB, opts ...testredis.Option) Config {
t.Helper()
img := valkeyImage
if imgFromEnv := os.Getenv(valkeyImageEnvVar); imgFromEnv != "" {
img = imgFromEnv
}
// Force Valkey image when running outside of GitHub Actions
opts = append(opts, testredis.WithImage(img))
redisCtr := testredis.Start(t, opts...)
cfg := Config{
Reset: true,
TLSConfig: redisCtr.TLSConfig,
InitAddress: redisCtr.Addrs,
URL: redisCtr.URL,
}
return cfg
}
// newTestStore creates a new Redis storage instance backed by Testcontainers.
// It configures the container based on the provided options and returns a Storage
// instance connected to the container. The caller is responsible for calling
// Close() on the returned Storage when done.
func newTestStore(t testing.TB, opts ...testredis.Option) *Storage {
return New(newConfigFromContainer(t, opts...))
}
func Test_Valkey_Set(t *testing.T) {
var (
@@ -19,6 +57,9 @@ func Test_Valkey_Set(t *testing.T) {
val = []byte("doe")
)
testStore := newTestStore(t)
defer testStore.Close()
err := testStore.Set(key, val, 0)
require.NoError(t, err)
}
@@ -29,6 +70,9 @@ func Test_Valkey_Set_Override(t *testing.T) {
val = []byte("doe")
)
testStore := newTestStore(t)
defer testStore.Close()
err := testStore.Set(key, val, 0)
require.NoError(t, err)
@@ -42,6 +86,9 @@ func Test_Valkey_Get(t *testing.T) {
val = []byte("doe")
)
testStore := newTestStore(t)
defer testStore.Close()
err := testStore.Set(key, val, 0)
require.NoError(t, err)
@@ -57,6 +104,9 @@ func Test_Valkey_Set_Expiration(t *testing.T) {
exp = 1 * time.Second
)
testStore := newTestStore(t)
defer testStore.Close()
err := testStore.Set(key, val, exp)
require.NoError(t, err)
@@ -66,12 +116,18 @@ func Test_Valkey_Set_Expiration(t *testing.T) {
func Test_Valkey_Get_Expired(t *testing.T) {
key := "john"
testStore := newTestStore(t)
defer testStore.Close()
result, err := testStore.Get(key)
require.NoError(t, err)
require.Zero(t, len(result))
}
func Test_Valkey_Get_NotExist(t *testing.T) {
testStore := newTestStore(t)
defer testStore.Close()
result, err := testStore.Get("notexist")
require.NoError(t, err)
require.Zero(t, len(result))
@@ -83,6 +139,9 @@ func Test_Valkey_Delete(t *testing.T) {
val = []byte("doe")
)
testStore := newTestStore(t)
defer testStore.Close()
err := testStore.Set(key, val, 0)
require.NoError(t, err)
@@ -97,6 +156,9 @@ func Test_Valkey_Delete(t *testing.T) {
func Test_Valkey_Reset(t *testing.T) {
val := []byte("doe")
testStore := newTestStore(t)
defer testStore.Close()
err := testStore.Set("john1", val, 0)
require.NoError(t, err)
@@ -116,99 +178,123 @@ func Test_Valkey_Reset(t *testing.T) {
}
func Test_Valkey_Close(t *testing.T) {
testStore := newTestStore(t)
require.Nil(t, testStore.Close())
}
func Test_Valkey_Conn(t *testing.T) {
testStore := newTestStore(t)
defer testStore.Close()
require.True(t, testStore.Conn() != nil)
}
func Test_Valkey_WithTLS(t *testing.T) {
cer, err := tls.LoadX509KeyPair("/home/runner/work/storage/storage/tls/client.crt", "/home/runner/work/storage/storage/tls/client.key")
if err != nil {
log.Println(err)
testFn := func(t *testing.T, secureURL bool, mtlsDisabled bool) {
t.Helper()
testStore := newTestStore(t, testredis.WithTLS(secureURL, mtlsDisabled))
defer testStore.Close()
var (
key = "clark"
val = []byte("kent")
)
err := testStore.Set(key, val, 0)
require.NoError(t, err)
result, err := testStore.Get(key)
require.NoError(t, err)
require.Equal(t, val, result)
err = testStore.Delete(key)
require.NoError(t, err)
}
tlsCfg := &tls.Config{
MinVersion: tls.VersionTLS12,
CurvePreferences: []tls.CurveID{tls.CurveP521, tls.CurveP384, tls.CurveP256},
InsecureSkipVerify: true,
Certificates: []tls.Certificate{cer},
CipherSuites: []uint16{
tls.TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,
tls.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,
tls.TLS_RSA_WITH_AES_256_GCM_SHA384,
tls.TLS_RSA_WITH_AES_256_CBC_SHA,
},
}
storeTLS := New(Config{
InitAddress: []string{"localhost:6380"},
TLSConfig: tlsCfg,
t.Run("insecure-url/mtls-disabled", func(t *testing.T) {
testFn(t, false, true)
})
var (
key = "clark"
val = []byte("kent")
)
t.Run("insecure-url/mtls-enabled", func(t *testing.T) {
testFn(t, false, false)
})
err = storeTLS.Set(key, val, 0)
require.NoError(t, err)
t.Run("secure-url/mtls-disabled", func(t *testing.T) {
testFn(t, true, true)
})
result, err := storeTLS.Get(key)
require.NoError(t, err)
require.Equal(t, val, result)
err = storeTLS.Delete(key)
require.NoError(t, err)
require.Nil(t, storeTLS.Close())
t.Run("secure-url/mtls-enabled", func(t *testing.T) {
testFn(t, true, false)
})
}
func Test_Valkey_With_HostPort(t *testing.T) {
store := New(Config{
InitAddress: []string{"localhost:6379"},
})
testStore := newTestStore(t, testredis.WithHostPort())
defer testStore.Close()
var (
key = "bruce"
val = []byte("wayne")
)
err := store.Set(key, val, 0)
err := testStore.Set(key, val, 0)
require.NoError(t, err)
result, err := store.Get(key)
result, err := testStore.Get(key)
require.NoError(t, err)
require.Equal(t, val, result)
err = store.Delete(key)
err = testStore.Delete(key)
require.NoError(t, err)
require.Nil(t, store.Close())
require.Nil(t, testStore.Close())
}
func Test_Valkey_With_URL(t *testing.T) {
store := New(Config{
URL: "redis://localhost:6379",
})
testStore := newTestStore(t, testredis.WithAddress(), testredis.WithURL(false))
defer testStore.Close()
var (
key = "bruce"
val = []byte("wayne")
)
err := store.Set(key, val, 0)
err := testStore.Set(key, val, 0)
require.NoError(t, err)
result, err := store.Get(key)
result, err := testStore.Get(key)
require.NoError(t, err)
require.Equal(t, val, result)
err = store.Delete(key)
err = testStore.Delete(key)
require.NoError(t, err)
require.Nil(t, store.Close())
require.Nil(t, testStore.Close())
}
func Test_Valkey_With_TLS_URL(t *testing.T) {
testStore := newTestStore(t, testredis.WithTLS(true, false), testredis.WithAddress(), testredis.WithURL(true))
defer testStore.Close()
var (
key = "bruce"
val = []byte("wayne")
)
err := testStore.Set(key, val, 0)
require.NoError(t, err)
result, err := testStore.Get(key)
require.NoError(t, err)
require.Equal(t, val, result)
err = testStore.Delete(key)
require.NoError(t, err)
require.Nil(t, testStore.Close())
}
func Test_Valkey_Cluster(t *testing.T) {
t.Skip("TODO: Replace with containerized cluster when testcontainers-go Valkey module supports clustering")
// TODO: Replace with containerized cluster when testcontainers-go Valkey module supports clustering
store := New(Config{
InitAddress: []string{
"localhost:7000",
@@ -238,6 +324,9 @@ func Test_Valkey_Cluster(t *testing.T) {
}
func Benchmark_Valkey_Set(b *testing.B) {
testStore := newTestStore(b)
defer testStore.Close()
b.ReportAllocs()
b.ResetTimer()
@@ -250,6 +339,9 @@ func Benchmark_Valkey_Set(b *testing.B) {
}
func Benchmark_Valkey_Get(b *testing.B) {
testStore := newTestStore(b)
defer testStore.Close()
err := testStore.Set("john", []byte("doe"), 0)
require.NoError(b, err)
@@ -264,6 +356,9 @@ func Benchmark_Valkey_Get(b *testing.B) {
}
func Benchmark_Valkey_SetAndDelete(b *testing.B) {
testStore := newTestStore(b)
defer testStore.Close()
b.ReportAllocs()
b.ResetTimer()