fix(tests): enable testing with Redis CE 8.0-M4 in CI (#3247)

* introduce github workflow for ci similar to the one in redis-py use prerelease for 8.0-M4 * Enable osscluster tests in CI * Add redis major version env Enable filtering test per redis major version Fix test for FT.SEARCH WITHSCORE, the default scorer has changed. fix Makefile syntax remove filter from github action fix makefile use the container name in Makefile * remove 1.20 from doctests * self review, cleanup, add comments * add comments, reorder prints, add default value for REDIS_MAJOR_VERSION
redis · Jan 31, 2025 · 1139bc3 · 1139bc3
1 parent 9f9fa22
commit 1139bc3
Show file tree

Hide file tree

Showing 16 changed files with 445 additions and 160 deletions.
diff --git a/.github/actions/run-tests/action.yml b/.github/actions/run-tests/action.yml
@@ -0,0 +1,62 @@
+name: 'Run go-redis tests'
+description: 'Runs go-redis tests against different Redis versions and configurations'
+inputs:
+  go-version:
+    description: 'Go version to use for running tests'
+    default: '1.23'
+  redis-version:
+    description: 'Redis version to test against'
+    required: true
+runs:
+  using: "composite"
+  steps:
+    - name: Set up ${{ inputs.go-version }}
+      uses: actions/setup-go@v5
+      with:
+        go-version: ${{ inputs.go-version }}
+
+    - name: Setup Test environment
+      env:
+        REDIS_VERSION: ${{ inputs.redis-version }}
+        CLIENT_LIBS_TEST_IMAGE: "redislabs/client-libs-test:${{ inputs.redis-version }}"
+      run: |
+        set -e
+        redis_major_version=$(echo "$REDIS_VERSION" | grep -oP '^\d+')
+        if (( redis_major_version < 8 )); then
+          echo "Using redis-stack for module tests"
+        else
+          echo "Using redis CE for module tests"
+        fi        
+        
+        # Mapping of redis version to redis testing containers
+        declare -A redis_version_mapping=(
+          ["8.0-M03"]="8.0-M04-pre"
+          ["7.4.2"]="rs-7.4.0-v2"
+          ["7.2.7"]="rs-7.2.0-v14"
+        )
+        
+        if [[ -v redis_version_mapping[$REDIS_VERSION] ]]; then
+          echo "REDIS_MAJOR_VERSION=${redis_major_version}" >> $GITHUB_ENV
+          echo "REDIS_IMAGE=redis:${{ inputs.redis-version }}" >> $GITHUB_ENV
+          echo "CLIENT_LIBS_TEST_IMAGE=redislabs/client-libs-test:${redis_version_mapping[$REDIS_VERSION]}" >> $GITHUB_ENV
+        else
+          echo "Version not found in the mapping."
+          exit 1
+        fi
+        sleep 10 # time to settle
+      shell: bash
+    - name: Set up Docker Compose environment with redis ${{ inputs.redis-version }}
+      run: docker compose --profile all up -d
+      shell: bash
+    - name: Run tests
+      env:
+        RCE_DOCKER: "true"
+        RE_CLUSTER: "false"
+      run: |
+        go test \
+        --ginkgo.skip-file="ring_test.go" \
+        --ginkgo.skip-file="sentinel_test.go" \
+        --ginkgo.skip-file="pubsub_test.go" \
+        --ginkgo.skip-file="gears_commands_test.go" \
+        --ginkgo.label-filter="!NonRedisEnterprise"
+      shell: bash
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -16,15 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        go-version: [1.19.x, 1.20.x, 1.21.x]
-
-    services:
-      redis:
-        image: redis/redis-stack-server:latest
-        options: >-
-          --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
-        ports:
-          - 6379:6379
+        go-version: [1.21.x, 1.22.x, 1.23.x]
 
     steps:
       - name: Set up ${{ matrix.go-version }}
@@ -50,39 +42,22 @@ jobs:
     strategy:
         fail-fast: false
         matrix:
-          redis_version:
-            - "8.0-M01"
-            - "7.4.1"
-            - "7.2.6"
-            - "6.2.16"
+          redis-version:
+            - "8.0-M03" # 8.0 milestone 4
+            - "7.4.2" # should use redis stack 7.4
+            - "7.2.7" # should redis stack 7.2
           go-version:
-            - "1.19.x"
-            - "1.20.x"
-            - "1.21.x"
+            - "1.22.x"
+            - "1.23.x"
 
     steps:
-      - name: Set up ${{ matrix.go-version }}
-        uses: actions/setup-go@v5
-        with:
-          go-version: ${{ matrix.go-version }}
 
       - name: Checkout code
         uses: actions/checkout@v4
-
-      # Set up Docker Compose environment
-      - name: Set up Docker Compose environment
-        run: |
-          docker compose --profile all up -d
-      
+
       - name: Run tests
-        env:
-          USE_CONTAINERIZED_REDIS: "true"
-          RE_CLUSTER: "true"
-        run: |
-          go test \
-          --ginkgo.skip-file="ring_test.go" \
-          --ginkgo.skip-file="sentinel_test.go" \
-          --ginkgo.skip-file="osscluster_test.go" \
-          --ginkgo.skip-file="pubsub_test.go" \
-          --ginkgo.skip-file="gears_commands_test.go" \
-          --ginkgo.label-filter='!NonRedisEnterprise'
+        uses: ./.github/actions/run-tests
+        with:
+          go-version: ${{matrix.go-version}}
+          redis-version: ${{ matrix.redis-version }}
+
diff --git a/.github/workflows/doctests.yaml b/.github/workflows/doctests.yaml
@@ -25,7 +25,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        go-version: [ "1.18", "1.19", "1.20", "1.21" ]
+        go-version: [ "1.21", "1.22", "1.23" ]
 
     steps:
       - name: Set up ${{ matrix.go-version }}

diff --git a/.github/workflows/test-redis-enterprise.yml b/.github/workflows/test-redis-enterprise.yml
@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        go-version: [1.21.x]
+        go-version: [1.23.x]
         re-build: ["7.4.2-54"]
 
     steps:
@@ -46,8 +46,8 @@ jobs:
 
       - name: Test
         env:
-          RE_CLUSTER: "1"
-          USE_CONTAINERIZED_REDIS: "1"
+          RE_CLUSTER: true
+          REDIS_MAJOR_VERSION: 7
         run: |
           go test \
           --ginkgo.skip-file="ring_test.go" \

diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,3 @@
-dockers/
 *.rdb
 testdata/*
 .idea/

diff --git a/Makefile b/Makefile
@@ -1,6 +1,8 @@
 GO_MOD_DIRS := $(shell find . -type f -name 'go.mod' -exec dirname {} \; | sort)
+export REDIS_MAJOR_VERSION := 7
 
 test: testdeps
+	docker start go-redis-redis-stack || docker run -d --name go-redis-redis-stack  -p 6379:6379 -e REDIS_ARGS="--enable-debug-command yes --enable-module-command yes" redis/redis-stack-server:latest
 	$(eval GO_VERSION := $(shell go version | cut -d " " -f 3 | cut -d. -f2))
 	set -e; for dir in $(GO_MOD_DIRS); do \
 	  if echo "$${dir}" | grep -q "./example" && [ "$(GO_VERSION)" = "19" ]; then \
@@ -19,6 +21,7 @@ test: testdeps
 	done
 	cd internal/customvet && go build .
 	go vet -vettool ./internal/customvet/customvet
+	docker stop go-redis-redis-stack
 
 testdeps: testdata/redis/src/redis-server
 
@@ -32,7 +35,7 @@ build:
 
 testdata/redis:
 	mkdir -p $@
-	wget -qO- https://download.redis.io/releases/redis-7.4-rc2.tar.gz  | tar xvz --strip-components=1 -C $@
+	wget -qO- https://download.redis.io/releases/redis-7.4.2.tar.gz  | tar xvz --strip-components=1 -C $@
 
 testdata/redis/src/redis-server: testdata/redis
 	cd $< && make all

diff --git a/bench_test.go b/bench_test.go
@@ -277,7 +277,7 @@ func BenchmarkXRead(b *testing.B) {
 
 func newClusterScenario() *clusterScenario {
 	return &clusterScenario{
-		ports:     []string{"8220", "8221", "8222", "8223", "8224", "8225"},
+		ports:     []string{"16600", "16601", "16602", "16603", "16604", "16605"},
 		nodeIDs:   make([]string, 6),
 		processes: make(map[string]*redisProcess, 6),
 		clients:   make(map[string]*redis.Client, 6),

diff --git a/commands_test.go b/commands_test.go
@@ -441,7 +441,6 @@ var _ = Describe("Commands", func() {
 		It("should Command", Label("NonRedisEnterprise"), func() {
 			cmds, err := client.Command(ctx).Result()
 			Expect(err).NotTo(HaveOccurred())
-			Expect(len(cmds)).To(BeNumerically("~", 240, 25))
 
 			cmd := cmds["mget"]
 			Expect(cmd.Name).To(Equal("mget"))

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,21 +1,140 @@
 ---
 
 services:
-
-  redis-stanalone:
-    image: redislabs/client-libs-test:8.0-M02
+  redis:
+    image: ${CLIENT_LIBS_TEST_IMAGE:-redislabs/client-libs-test:7.4.1}
     container_name: redis-standalone
     environment:
+      - TLS_ENABLED=yes
       - REDIS_CLUSTER=no
       - PORT=6379
       - TLS_PORT=6666
-
+    command: ${REDIS_EXTRA_ARGS:---enable-debug-command yes --enable-module-command yes --tls-auth-clients optional --save ""}
     ports:
       - 6379:6379
-      - 6380:6379
       - 6666:6666 # TLS port
     volumes:
-      - "./dockers/redis-standalone:/redis/work"
+      - "./dockers/standalone:/redis/work"
     profiles:
       - standalone
+      - sentinel
+      - all-stack
+      - all
+
+  cluster:
+    image: ${CLIENT_LIBS_TEST_IMAGE:-redislabs/client-libs-test:7.4.1}
+    container_name: redis-cluster
+    environment:
+      - NODES=6
+      - PORT=16600
+    command: "--cluster-enabled yes"
+    ports:
+      - "16600-16605:16600-16605"
+    volumes:
+      - "./dockers/cluster:/redis/work"
+    profiles:
+      - cluster
+      - all-stack
+      - all
+
+  sentinel:
+    image: ${REDIS_IMAGE:-redis:7.4.1}
+    container_name: redis-sentinel
+    depends_on:
+      - redis
+    entrypoint: "redis-sentinel /redis.conf --port 26379"
+    ports:
+      - 26379:26379
+    volumes:
+      - "./dockers/sentinel.conf:/redis.conf"
+    profiles:
+      - sentinel
+      - all-stack
       - all
+
+  sentinel2:
+    image: ${REDIS_IMAGE:-redis:7.4.1}
+    container_name: redis-sentinel2
+    depends_on:
+      - redis
+    entrypoint: "redis-sentinel /redis.conf --port 26380"
+    ports:
+      - 26380:26380
+    volumes:
+      - "./dockers/sentinel.conf:/redis.conf"
+    profiles:
+      - sentinel
+      - all-stack
+      - all
+
+  sentinel3:
+    image: ${REDIS_IMAGE:-redis:7.4.1}
+    container_name: redis-sentinel3
+    depends_on:
+      - redis
+    entrypoint: "redis-sentinel /redis.conf --port 26381"
+    ports:
+      - 26381:26381
+    volumes:
+      - "./dockers/sentinel.conf:/redis.conf"
+    profiles:
+      - sentinel
+      - all-stack
+      - all
+
+  redisRing1:
+    image: ${CLIENT_LIBS_TEST_IMAGE:-redislabs/client-libs-test:7.4.1}
+    container_name: redis-ring-1
+    environment:
+      - TLS_ENABLED=yes
+      - REDIS_CLUSTER=no
+      - PORT=6390
+    command: ${REDIS_EXTRA_ARGS:---enable-debug-command yes --enable-module-command yes --tls-auth-clients optional --save ""}
+    ports:
+      - 6390:6390
+    volumes:
+      - "./dockers/ring1:/redis/work"
+    profiles:
+      - ring
+      - cluster
+      - sentinel
+      - all-stack
+      - all
+
+  redisRing2:
+    image: ${CLIENT_LIBS_TEST_IMAGE:-redislabs/client-libs-test:7.4.1}
+    container_name: redis-ring-2
+    environment:
+      - TLS_ENABLED=yes
+      - REDIS_CLUSTER=no
+      - PORT=6391
+    command: ${REDIS_EXTRA_ARGS:---enable-debug-command yes --enable-module-command yes --tls-auth-clients optional --save ""}
+    ports:
+      - 6391:6391
+    volumes:
+      - "./dockers/ring2:/redis/work"
+    profiles:
+      - ring
+      - cluster
+      - sentinel
+      - all-stack
+      - all
+
+  redisRing3:
+    image: ${CLIENT_LIBS_TEST_IMAGE:-redislabs/client-libs-test:7.4.1}
+    container_name: redis-ring-3
+    environment:
+      - TLS_ENABLED=yes
+      - REDIS_CLUSTER=no
+      - PORT=6392
+    command: ${REDIS_EXTRA_ARGS:---enable-debug-command yes --enable-module-command yes --tls-auth-clients optional --save ""}
+    ports:
+      - 6392:6392
+    volumes:
+      - "./dockers/ring3:/redis/work"
+    profiles:
+      - ring
+      - cluster
+      - sentinel
+      - all-stack
+      - all
diff --git a/dockers/.gitignore b/dockers/.gitignore
@@ -0,0 +1 @@
+*/
diff --git a/dockers/sentinel.conf b/dockers/sentinel.conf
@@ -0,0 +1,5 @@
+sentinel resolve-hostnames yes
+sentinel monitor go-redis-test redis 6379 2
+sentinel down-after-milliseconds go-redis-test 5000
+sentinel failover-timeout go-redis-test 60000
+sentinel parallel-syncs go-redis-test 1