Merge branch 'main' into update-dependencies-workflows

Author: gaby

.github/workflows/benchmark.yml

@@ -56,11 +56,6 @@ jobs:
         with:
           # NOTE: Keep this in sync with the version from go.mod
           go-version: "1.24.x"
-      - name: Install Go (For clickhouse)
-        uses: actions/setup-go@v6
-        if: ${{ matrix.package == 'clickhouse' }}
-        with:
-          go-version: "1.25.x"
 
       - name: Setup Node.js
         uses: actions/setup-node@v6
@@ -72,15 +67,26 @@ jobs:
           .github/scripts/initialize-wrangler.sh
           cd cloudflarekv && npx wrangler dev &
           npx wait-on tcp:8787
-      - name: Install etcd
-        if: ${{ matrix.package == 'etcd' }}
+
+      - name: Install Coherence
+        if: ${{ matrix.package == 'coherence' }}
+        run: |
+          docker run -d -p 1408:1408 -p 30000:30000 ghcr.io/oracle/coherence-ce:22.06.5
+          sleep 30
+
+      - name: Setup Redis
+        if: ${{ matrix.package == 'rueidis' || matrix.package == 'valkey' }}
+        uses: shogo82148/actions-setup-redis@v1
+        with:
+          redis-version: '7.x'
+          auto-start: 'false'
+
+      - name: Run Redis
+        if: ${{ matrix.package == 'rueidis' || matrix.package == 'valkey' }}
         run: |
-          docker run -d --name Etcd-server \
-            --publish 2379:2379 \
-            --publish 2380:2380 \
-            --env ALLOW_NONE_AUTHENTICATION=yes \
-            --env ETCD_ADVERTISE_CLIENT_URLS=http://etcd-server:2379 \
-            bitnami/etcd:latest
+          redis-server --port 6379 &
+          sleep 15
+
       - name: Install MSSQL
         if: ${{ matrix.package == 'mssql' }}
         run: |
@@ -116,6 +122,7 @@ jobs:
           TEST_CLICKHOUSE_IMAGE: "clickhouse/clickhouse-server:23-alpine"
           TEST_COUCHBASE_IMAGE: "couchbase:enterprise-7.6.5"
           TEST_DYNAMODB_IMAGE: amazon/dynamodb-local:latest
+          TEST_ETCD_IMAGE: gcr.io/etcd-development/etcd:v3.6.6
           TEST_MEMCACHED_IMAGE: "memcached:latest"
           TEST_MINIO_IMAGE: "docker.io/minio/minio:latest"
           TEST_MONGODB_IMAGE: "docker.io/mongo:7"

.github/workflows/test-etcd.yml

@@ -17,20 +17,16 @@ jobs:
       matrix:
         go-version:
           - 1.24.x
+          - 1.25.x
     steps:
-      - name: Fetch Repository
-        uses: actions/checkout@v6
-      - name: Install etcd
-        run: |
-          docker run -d --name Etcd-server \
-            --publish 2379:2379 \
-            --publish 2380:2380 \
-            --env ALLOW_NONE_AUTHENTICATION=yes \
-            --env ETCD_ADVERTISE_CLIENT_URLS=http://etcd-server:2379 \
-            milvus-io/etcd:latest
-      - name: Install Go
-        uses: actions/setup-go@v6
-        with:
-          go-version: '${{ matrix.go-version }}'
-      - name: Run Test
-        run: cd ./etcd && go test ./... -v -race
+      -   name: Fetch Repository
+          uses: actions/checkout@v6
+
+      -   name: Install Go
+          uses: actions/setup-go@v6
+          with:
+              go-version: '${{ matrix.go-version }}'
+      -   name: Run Test
+          env:
+              TEST_ETCD_IMAGE: gcr.io/etcd-development/etcd:v3.6.6
+          run: cd ./etcd && go test ./... -v -race

badger/go.mod

@@ -18,7 +18,7 @@ require (
 	github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/golang/snappy v1.0.0 // indirect
-	github.com/google/flatbuffers v25.9.23+incompatible // indirect
+	github.com/google/flatbuffers v23.5.26+incompatible // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/klauspost/compress v1.18.1 // indirect
 	github.com/pkg/errors v0.9.1 // indirect

etcd/etcd_test.go

@@ -3,24 +3,51 @@ package etcd
 import (
 	"context"
 	"os"
+	"sync"
 	"testing"
 	"time"
 
 	"github.com/stretchr/testify/require"
+
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/modules/etcd"
 )
 
-var testStore *Storage
+const (
+	// etcdImage is the default image used for running etcd in tests.
+	etcdImage              = "gcr.io/etcd-development/etcd:v3.6.6"
+	etcdImageEnvVar string = "TEST_ETCD_IMAGE"
+)
 
-func TestMain(m *testing.M) {
-	testStore = New(Config{
-		Endpoints: []string{"localhost:2379"},
-	})
+func newTestStore(t testing.TB) *Storage {
+	t.Helper()
+
+	img := etcdImage
+	if imgFromEnv := os.Getenv(etcdImageEnvVar); imgFromEnv != "" {
+		img = imgFromEnv
+	}
+
+	ctx := context.Background()
+
+	// create a 1-node cluster
+	c, err := etcd.Run(ctx, img)
+
+	// for benchmarks, we do not want to cleanup the container
+	switch t.(type) {
+	case *testing.B:
+		// do not cleanup the container for benchmarks
+	default:
+		testcontainers.CleanupContainer(t, c)
+	}
 
-	code := m.Run()
+	require.NoError(t, err)
+
+	hostPort, err := c.ClientEndpoint(ctx)
+	require.NoError(t, err)
 
-	_ = testStore.Reset()
-	_ = testStore.Close()
-	os.Exit(code)
+	return New(Config{
+		Endpoints: []string{hostPort},
+	})
 }
 
 func TestSetEtcd_ShouldReturnNoError(t *testing.T) {
@@ -29,18 +56,27 @@ func TestSetEtcd_ShouldReturnNoError(t *testing.T) {
 		val = []byte("doe")
 	)
 
+	testStore := newTestStore(t)
+	defer testStore.Close()
+
 	err := testStore.Set(key, val, 0)
 	require.NoError(t, err)
 }
 
 func TestGetEtcd_ShouldReturnNil_WhenDocumentNotFound(t *testing.T) {
+	testStore := newTestStore(t)
+	defer testStore.Close()
+
 	val, err := testStore.Get("not_found_key")
 
 	require.NoError(t, err)
 	require.Zero(t, len(val))
 }
 
 func TestSetAndGet_GetShouldReturn_SettedValueWithoutError(t *testing.T) {
+	testStore := newTestStore(t)
+	defer testStore.Close()
+
 	err := testStore.Set("test", []byte("fiber_test_value"), 0)
 	require.NoError(t, err)
 
@@ -56,6 +92,9 @@ func TestSetWithContext(t *testing.T) {
 		val = []byte("doe")
 	)
 
+	testStore := newTestStore(t)
+	defer testStore.Close()
+
 	ctx, cancel := context.WithCancel(context.Background())
 	cancel()
 
@@ -69,6 +108,9 @@ func TestSetAndGetWithContext(t *testing.T) {
 		val = []byte("doe")
 	)
 
+	testStore := newTestStore(t)
+	defer testStore.Close()
+
 	ctx, cancel := context.WithCancel(context.Background())
 	cancel()
 
@@ -81,6 +123,9 @@ func TestSetAndGetWithContext(t *testing.T) {
 }
 
 func TestSetAndGet_GetShouldReturnNil_WhenTTLExpired(t *testing.T) {
+	testStore := newTestStore(t)
+	defer testStore.Close()
+
 	err := testStore.Set("test", []byte("fiber_test_value"), 3*time.Second)
 	require.NoError(t, err)
 
@@ -93,6 +138,9 @@ func TestSetAndGet_GetShouldReturnNil_WhenTTLExpired(t *testing.T) {
 }
 
 func TestSetAndDelete_DeleteShouldReturn_NoError(t *testing.T) {
+	testStore := newTestStore(t)
+	defer testStore.Close()
+
 	err := testStore.Set("test", []byte("fiber_test_value"), 0)
 	require.NoError(t, err)
 
@@ -104,6 +152,9 @@ func TestSetAndDelete_DeleteShouldReturn_NoError(t *testing.T) {
 }
 
 func TestDeleteWithContext(t *testing.T) {
+	testStore := newTestStore(t)
+	defer testStore.Close()
+
 	err := testStore.Set("test", []byte("fiber_test_value"), 0)
 	require.NoError(t, err)
 
@@ -119,6 +170,9 @@ func TestDeleteWithContext(t *testing.T) {
 }
 
 func TestSetAndReset_ResetShouldReturn_NoError(t *testing.T) {
+	testStore := newTestStore(t)
+	defer testStore.Close()
+
 	err := testStore.Set("test", []byte("fiber_test_value"), 0)
 	require.NoError(t, err)
 
@@ -130,6 +184,9 @@ func TestSetAndReset_ResetShouldReturn_NoError(t *testing.T) {
 }
 
 func TestResetWithContext(t *testing.T) {
+	testStore := newTestStore(t)
+	defer testStore.Close()
+
 	err := testStore.Set("test", []byte("fiber_test_value"), 0)
 	require.NoError(t, err)
 
@@ -145,49 +202,94 @@ func TestResetWithContext(t *testing.T) {
 }
 
 func TestClose_CloseShouldReturn_NoError(t *testing.T) {
+	testStore := newTestStore(t)
 	err := testStore.Close()
 	require.NoError(t, err)
 }
 
 func TestGetConn_ReturnsNotNill(t *testing.T) {
+	testStore := newTestStore(t)
+	defer testStore.Close()
+
 	require.True(t, testStore.Conn() != nil)
 }
 
+//
+// Benchmarking
+//
+// Please note that this is not thread-safe:
+// Each benchmark reuses the same etcd store instance,
+// setting and deleting keys between benchmarks.
+// If you add more benchmarks, make sure to delete the key after the benchmark.
+
+var (
+	benchmarkStore *Storage
+	benchmarkOnce  sync.Once
+)
+
+func getBenchmarkStore(b *testing.B) *Storage {
+	benchmarkOnce.Do(func() {
+		benchmarkStore = newTestStore(b)
+	})
+
+	return benchmarkStore
+}
+
 func Benchmark_Etcd_Set(b *testing.B) {
+	key := "john1"
+	testStore := getBenchmarkStore(b)
+
 	b.ReportAllocs()
 	b.ResetTimer()
 
 	var err error
 	for i := 0; i < b.N; i++ {
-		err = testStore.Set("john", []byte("doe"), 0)
+		err = testStore.Set(key, []byte("doe"), 0)
 	}
 
 	require.NoError(b, err)
+
+	// Clean up the key after benchmark
+	require.NoError(b, testStore.Delete(key))
 }
 
 func Benchmark_Etcd_Get(b *testing.B) {
-	err := testStore.Set("john", []byte("doe"), 0)
+	key := "john2"
+	testStore := getBenchmarkStore(b)
+
+	err := testStore.Set(key, []byte("doe"), 0)
 	require.NoError(b, err)
 
 	b.ReportAllocs()
 	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-		_, err = testStore.Get("john")
+		_, err = testStore.Get(key)
 	}
 
 	require.NoError(b, err)
+
+	// Clean up after benchmark
+	require.NoError(b, testStore.Delete(key))
 }
 
 func Benchmark_Etcd_SetAndDelete(b *testing.B) {
+	key := "john3"
+	testStore := getBenchmarkStore(b)
+
 	b.ReportAllocs()
 	b.ResetTimer()
 
 	var err error
 	for i := 0; i < b.N; i++ {
-		_ = testStore.Set("john", []byte("doe"), 0)
-		err = testStore.Delete("john")
+		_ = testStore.Set(key, []byte("doe"), 0)
+		err = testStore.Delete(key)
 	}
 
 	require.NoError(b, err)
+
+	// Clean up after benchmark
+	b.StopTimer()
+	_ = testStore.Delete(key)
+	b.StartTimer()
 }