Introduces test matrix based on Redis versions [8.0-M1, 7.4.1, 7.2.6, 6.2.16]

.github/CONTRIBUTING.md

@@ -25,6 +25,47 @@ Jedis unit tests use many Redis instances, so we use a ```Makefile``` to prepare
 Start unit tests with ```make test```.
 Set up test environments with ```make start```, tear down those environments with ```make stop``` and clean up the environment files with ```make cleanup```.
 
+
+# Jedis Test Environment Using Docker
+
+This guide explains how to bootstrap and manage a test environment for Jedis using Docker Compose.
+
+## Workflow Steps
+1. **Bring up the test environment** (examples provided below).
+2. **Run tests** (via IDE, Maven, etc.).
+3. **Destroy the test environment** using `docker compose down`.
+
+### Important Note
+The default test environment uses the temporary work folder `./redis-env-work`.  
+Some tests might leave Redis nodes in an inconsistent state, so this folder should be cleaned or removed before bootstrapping the environment again.
+
+
+## Bootstrap test env using Docker
+- **Redis 8.0-M01**
+```
+rm -rf ./redis-env-work
+export REDIS_VERSION=8.0-M01
+docker compose --env-file src/test/resources/env/.env -f src/test/resources/env/docker-compose.yml up
+```
+- **Redis 7.4.1**
+```
+rm -rf ./redis-env-work
+export REDIS_VERSION=7.4.1
+docker compose --env-file src/test/resources/env/.env -f src/test/resources/env/docker-compose.yml up
+```
+- **Redis 7.2.6**
+```
+rm -rf ./redis-env-work
+export REDIS_VERSION=7.2.6
+docker compose --env-file src/test/resources/env/.env -f src/test/resources/env/docker-compose.yml up
+```
+- **Redis 6.2.16**
+  - **NOTE :** 6.2.16 uses a dedicated .env.v6.12.16 file, since some of the redis configuration settings are not supported in 6.2.16
+```
+rm -rf ./redis-env-work
+docker compose --env-file src/test/resources/env/.env.v6.12.16 -f src/test/resources/env/docker-compose.yml up
+```
+
 # Some rules of Jedis source code
 
 ## Code Convention

.github/workflows/integration.yml

@@ -51,6 +51,7 @@ jobs:
           mvn javadoc:jar
       - name: Run tests
         run: |
+          export TEST_ENV_PROVIDER=local
           make test
         env:
           JVM_OPTS: -Xmx3200m

.github/workflows/test-on-docker.yml

@@ -0,0 +1,128 @@
+---
+
+name: Build and Test using containerized environment
+
+on:
+  push:
+    paths-ignore:
+      - 'docs/**'
+      - '**/*.md'
+      - '**/*.rst'
+    branches:
+      - master
+      - '[0-9].*'
+  pull_request:
+    branches:
+      - master
+      - '[0-9].*'
+  schedule:
+    - cron: '0 1 * * *' # nightly build
+  workflow_dispatch:
+    inputs:
+      specific_test:
+        description: 'Run specific test(s) (optional)'
+        required: false
+        default: ''
+jobs:
+
+  build:
+    name: Build and Test
+    runs-on: ubuntu-latest
+    env:
+      REDIS_ENV_WORK_DIR: ${{ github.workspace }}/redis-env-work
+      REDIS_ENV_CONF_DIR: ${{ github.workspace }}/src/test/resources/env
+      CLIENT_LIBS_IMAGE_PREFIX: "redislabs/client-libs-test"
+    strategy:
+      fail-fast: false
+      matrix:
+        redis_version:
+          - "8.0-M01"
+          - "7.4.1"
+          - "7.2.6"
+          - "6.2.16"
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up publishing to maven central
+        uses: actions/setup-java@v2
+        with:
+          java-version: '8'
+          distribution: 'temurin'
+      - name: System setup
+        run: |
+          sudo apt update
+          sudo apt install -y make
+          make compile-module
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.m2/repository
+            /var/cache/apt
+          key: jedis-${{hashFiles('**/pom.xml')}}
+      # Set up Docker Compose environment
+      - name: Set up Docker Compose environment
+        run: |
+          mkdir -m 777 $REDIS_ENV_WORK_DIR
+          export REDIS_VERSION="${{ matrix.redis_version }}"
+          export COMPOSE_ENV_FILES="src/test/resources/env/.env"
+          if [[ "${{ matrix.redis_version }}" == "6.2.16" ]]; then
+           COMPOSE_ENV_FILES+=",src/test/resources/env/.env.v${{ matrix.redis_version }}"
+          fi
+          docker compose -f src/test/resources/env/docker-compose.yml up -d
+      - name: Maven offline
+        run: |
+          mvn -q dependency:go-offline
+      - name: Build docs
+        run: |
+          mvn javadoc:jar
+      # Run Tests
+      - name: Run Maven tests
+        run: |
+          export TEST_ENV_PROVIDER=docker
+          export TEST_WORK_FOLDER=$REDIS_ENV_WORK_DIR
+          echo $TEST_WORK_FOLDER
+          if [ -z "$TESTS" ]; then
+            mvn clean compile test
+          else
+            mvn -Dtest=$SPECIFIC_TEST clean compile test
+          fi
+        env:
+          TESTS: ${{ github.event.inputs.specific_test || '' }}
+      - name: Publish Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: always()
+        with:
+          files: |
+            target/surefire-reports/**/*.xml
+      # Collect logs on failure
+      - name: Collect logs on failure
+        if: failure()  # This runs only if the previous steps failed
+        run: |
+           echo "Collecting logs from $WORK_DIR..."
+           ls -la $REDIS_ENV_WORK_DIR
+      # Upload logs as artifacts
+      - name: Upload logs on failure
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+           name: redis-env-work-logs
+           path: ${{ env.REDIS_ENV_WORK_DIR }}
+      # Bring down the Docker Compose test environment
+      - name: Tear down Docker Compose environment
+        if: always()
+        run: |
+          docker compose $COMPOSE_ENV_FILES -f src/test/resources/env/docker-compose.yml down
+        continue-on-error: true
+      # Upload code coverage
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          fail_ci_if_error: false
+          token: ${{ secrets.CODECOV_TOKEN }}
+      - name: Upload test results to Codecov
+        if: ${{ github.event_name == 'schedule' || (github.event_name == 'push') || github.event_name == 'workflow_dispatch'}}
+        uses: codecov/test-results-action@v1
+        with:
+          fail_ci_if_error: false
+          files: ./target/surefire-reports/TEST*
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -11,7 +11,9 @@ build/
 bin/
 tags
 .idea
+.run
 *.aof
 *.rdb
 redis-git
 appendonlydir/
+.DS_Store