valkey/.github/workflows/ci.yml

name: CI

on:
  push:
    paths-ignore:
      - '**/*.md'
      - '**/00-RELEASENOTES'
      - '**/COPYING'
  pull_request:
    paths-ignore:
      - '**/*.md'
      - '**/00-RELEASENOTES'
      - '**/COPYING'

concurrency:
  group: ci-${{ github.head_ref || github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  test-ubuntu-latest:
    runs-on: ubuntu-latest
    steps:
      - name: Install libbacktrace
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          repository: ianlancetaylor/libbacktrace
          ref: b9e40069c0b47a722286b94eb5231f7f05c08713
          path: libbacktrace
      - run: cd libbacktrace && ./configure && make && sudo make install
      - name: Checkout Valkey
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: make
        # Fail build if there are warnings
        # build with TLS just for compilation coverage
        run: |
          sudo apt-get install pkg-config libgtest-dev libgmock-dev
          make -j4 all-with-unit-tests SERVER_CFLAGS='-Werror' BUILD_TLS=yes USE_LIBBACKTRACE=yes
      - name: test
        run: |
          sudo apt-get install tcl8.6 tclx
          ./runtest --verbose --tags -slow --dump-logs
      - name: module api test
        run: CFLAGS='-Werror' ./runtest-moduleapi --verbose --dump-logs
      - name: validate commands.def up to date
        run: |
          touch src/commands/ping.json
          make commands.def
          dirty="$(git diff)"
          if [[ ! -z "$dirty" ]]; then echo "$dirty"; exit 1; fi
      - name: unit tests
        run: |
          ./src/unit/valkey-unit-gtests

  test-ubuntu-latest-compatibility:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        server:
          - {version: "7.2.11", file: "valkey-7.2.11-noble-x86_64.tar.gz"}
          - {version: "8.0.6", file: "valkey-8.0.6-noble-x86_64.tar.gz"}
          - {version: "8.1.4", file: "valkey-8.1.4-noble-x86_64.tar.gz"}
    steps:
      - name: Install gtest
        run: |
          sudo apt-get install pkg-config libgtest-dev libgmock-dev
      - name: Install libbacktrace
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          repository: ianlancetaylor/libbacktrace
          ref: b9e40069c0b47a722286b94eb5231f7f05c08713
          path: libbacktrace
      - run: cd libbacktrace && ./configure && make && sudo make install
      - name: Checkout Valkey
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: make
        # Fail build if there are warnings
        # build with TLS just for compilation coverage
        run: make -j4 all-with-unit-tests SERVER_CFLAGS='-Werror' BUILD_TLS=yes USE_LIBBACKTRACE=yes

      - name: Install old server (${{ matrix.server.version }}) for compatibility testing
        run: |
          mkdir -p tests/tmp
          cd tests/tmp
          wget https://download.valkey.io/releases/${{ matrix.server.file }}
          tar -xvf ${{ matrix.server.file }}

      - name: Run compatibility tests against ${{ matrix.server.version }}
        run: |
          sudo apt-get install -y tcl8.6 tclx
          ./runtest --verbose --tags "-slow needs:other-server" --dump-logs \
            --other-server-path tests/tmp/valkey-${{ matrix.server.version }}-noble-x86_64/bin/valkey-server

      - name: Module API tests against ${{ matrix.server.version }}
        run: |
          CFLAGS='-Werror' ./runtest-moduleapi --tags needs:other-server --verbose --dump-logs \
            --other-server-path tests/tmp/valkey-${{ matrix.server.version }}-noble-x86_64/bin/valkey-server

  test-ubuntu-latest-cmake-tls:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: cmake and make
        run: |
          sudo apt-get install -y cmake libssl-dev
          mkdir -p build-release
          cd build-release
          cmake -DCMAKE_BUILD_TYPE=Release .. -DBUILD_TLS=yes -DBUILD_UNIT_GTESTS=yes
          make -j$(nproc)
      - name: test
        run: |
          sudo apt-get install -y tcl8.6 tclx tcl-tls
          ./utils/gen-test-certs.sh
          ./build-release/runtest --verbose --tags -slow --dump-logs --tls
      - name: unit tests
        run: |
          ./build-release/bin/valkey-unit-gtests

  test-sanitizer-address:
    runs-on: ubuntu-latest
    steps:
      - name: Install libbacktrace
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          repository: ianlancetaylor/libbacktrace
          ref: b9e40069c0b47a722286b94eb5231f7f05c08713
          path: libbacktrace
      - run: cd libbacktrace && ./configure && make && sudo make install
      - name: Checkout Valkey
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: make
        # build with TLS module just for compilation coverage
        run: |
          sudo apt-get install pkg-config libgtest-dev libgmock-dev
          make -j4 all-with-unit-tests SANITIZER=address SERVER_CFLAGS='-Werror' BUILD_TLS=module USE_LIBBACKTRACE=yes
      - name: testprep
        run: sudo apt-get install tcl8.6 tclx -y
      - name: test
        run: ./runtest --verbose --tags -slow --dump-logs
      - name: module api test
        run: CFLAGS='-Werror' ./runtest-moduleapi --verbose --dump-logs
      - name: unit tests
        run: |
          ./src/unit/valkey-unit-gtests

  test-rdma:
    runs-on: ubuntu-latest
    steps:
      - name: Install libbacktrace
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          repository: ianlancetaylor/libbacktrace
          ref: b9e40069c0b47a722286b94eb5231f7f05c08713
          path: libbacktrace
      - run: cd libbacktrace && ./configure && make && sudo make install
      - name: Checkout Valkey
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: prepare-development-libraries
        run: sudo apt-get install librdmacm-dev libibverbs-dev
      - name: make-rdma-module
        run: make -j4 BUILD_RDMA=module USE_LIBBACKTRACE=yes
      - name: make-rdma-builtin
        run: |
          make distclean
          make -j4 BUILD_RDMA=yes USE_LIBBACKTRACE=yes
      - name: clone-rxe-kmod
        run: |
          mkdir -p tests/rdma/rxe
          git clone https://github.com/pizhenwei/rxe.git tests/rdma/rxe
          make -C tests/rdma/rxe
      - name: clear-kernel-log
        run: sudo dmesg -c > /dev/null
      - name: test
        run: sudo ./runtest-rdma --install-rxe
      - name: show-kernel-log
        run: sudo dmesg -c

  test-tls-only:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: generate-test-certificates
        run: ./utils/gen-test-certs.sh
      - name: install-test-dependencies
        run: sudo apt-get install -y tcl8.6 tclx tcl-tls
      - name: make-tls-module
        run: make -j4 BUILD_TLS=module SERVER_CFLAGS='-Werror'
      - name: test-tls-module
        run: ./runtest --verbose --single unit/tls --dump-logs --tls-module
      - name: make-tls-builtin
        run: |
          make distclean
          make -j4 BUILD_TLS=yes SERVER_CFLAGS='-Werror'
      - name: test-tls-builtin
        run: ./runtest --verbose --single unit/tls --dump-logs --tls

  build-debian-old:
    runs-on: ubuntu-latest
    container: debian:bullseye
    steps:
      - name: Install libbacktrace
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          repository: ianlancetaylor/libbacktrace
          ref: b9e40069c0b47a722286b94eb5231f7f05c08713
          path: libbacktrace
      - name: Build libbacktrace
        run: |
          apt-get update && apt-get install -y build-essential
          cd libbacktrace && ./configure && make && make install
      - name: Checkout Valkey
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: make
        run: make -j4 SERVER_CFLAGS='-Werror' USE_LIBBACKTRACE=yes

  build-macos-latest:
    runs-on: macos-latest
    steps:
      - name: Install libbacktrace
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          repository: ianlancetaylor/libbacktrace
          ref: b9e40069c0b47a722286b94eb5231f7f05c08713
          path: libbacktrace
      - run: cd libbacktrace && ./configure && make && sudo make install
      - name: Checkout Valkey
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: Install build dependencies
        run: brew install llvm googletest
      - name: make
        # Build with additional upcoming features
        run: |
          export PATH="/opt/homebrew/opt/llvm/bin:$PATH"
          export CC=/opt/homebrew/opt/llvm/bin/clang
          export CXX=/opt/homebrew/opt/llvm/bin/clang++
          export AR=/opt/homebrew/opt/llvm/bin/llvm-ar
          export RANLIB=/opt/homebrew/opt/llvm/bin/llvm-ranlib
          make -j3 all-with-unit-tests SERVER_CFLAGS='-Werror' USE_LIBBACKTRACE=yes LIBBACKTRACE_PREFIX=/usr/local

  build-32bit:
    runs-on: ubuntu-latest
    steps:
      - name: Install libbacktrace
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          repository: ianlancetaylor/libbacktrace
          ref: b9e40069c0b47a722286b94eb5231f7f05c08713
          path: libbacktrace
      - name: Build libbacktrace (32-bit)
        run: |
          sudo apt-get update
          sudo apt-get install libc6-dev-i386 libstdc++-11-dev-i386-cross gcc-multilib g++-multilib
          cd libbacktrace && ./configure CFLAGS="-m32" --prefix=/usr/local/libbacktrace32 && make && sudo make install
      - name: Checkout Valkey
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: Install gtest
        run: |
          sudo apt-get update
          sudo apt-get install libgtest-dev
          mkdir -p /tmp/gtest32
          cd /tmp/gtest32
          cmake -B build32 \
              -DCMAKE_BUILD_TYPE=Release \
              -DCMAKE_C_FLAGS="-m32" \
              -DCMAKE_CXX_FLAGS="-m32" \
              -DCMAKE_EXE_LINKER_FLAGS="-m32" \
              /usr/src/googletest
          cmake --build build32 --parallel
          sudo cp build32/lib/*.a /usr/lib32/
          cd $GITHUB_WORKSPACE
      - name: make
        # Fast float requires C++ 32-bit libraries to compile on 64-bit ubuntu
        # machine i.e. "-cross" suffixed version. Cross-compiling c++ to 32-bit
        # also requires multilib support for g++ compiler i.e. "-multilib"
        # suffixed version of g++. g++-multilib generally includes libstdc++.
        # *cross version as well, but it is also added explicitly just in case.
        run: |
          make -j4 SERVER_CFLAGS='-Werror' 32bit USE_LIBBACKTRACE=yes LIBBACKTRACE_PREFIX=/usr/local/libbacktrace32 \
            GTEST_CFLAGS="-I/usr/src/googletest/googletest/include -I/usr/src/googletest/googlemock/include" \
            GTEST_LIBS="/usr/lib32/libgtest.a /usr/lib32/libgmock.a"
      - name: unit tests
        run: |
          ./src/unit/valkey-unit-gtests

  build-libc-malloc:
    runs-on: ubuntu-latest
    steps:
      - name: Install libbacktrace
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          repository: ianlancetaylor/libbacktrace
          ref: b9e40069c0b47a722286b94eb5231f7f05c08713
          path: libbacktrace
      - run: cd libbacktrace && ./configure && make && sudo make install
      - name: Checkout Valkey
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: make
        run: make -j4 SERVER_CFLAGS='-Werror' MALLOC=libc USE_LIBBACKTRACE=yes

  build-almalinux8-jemalloc:
    runs-on: ubuntu-latest
    container: almalinux:8
    steps:
      - name: Install libbacktrace
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          repository: ianlancetaylor/libbacktrace
          ref: b9e40069c0b47a722286b94eb5231f7f05c08713
          path: libbacktrace
      - name: Build libbacktrace
        run: |
          dnf -y install epel-release gcc gcc-c++ make procps-ng which git cmake
          cd libbacktrace && ./configure && make && make install
      - name: Checkout Valkey
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: make
        run: make -j4 SERVER_CFLAGS='-Werror' USE_LIBBACKTRACE=yes

  format-yaml:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

      - name: Set up Go
        uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # v6.2.0
        with:
          go-version: "1.22.4"

      - name: Setup YAML formatter
        run: |
          go install github.com/google/yamlfmt/cmd/yamlfmt@latest

      - name: Run yamlfmt
        id: yamlfmt
        run: |
          yamlfmt -lint -conf .config/format.yml .
          # Capture the diff output
          DIFF=$(git diff)
          if [ ! -z "$DIFF" ]; then
            # Encode the diff in Base64 to ensure it's handled as a single line
            ENCODED_DIFF=$(echo "$DIFF" | base64 -w 0)
            echo "diff=$ENCODED_DIFF" >> $GITHUB_OUTPUT
          fi
        shell: bash

      - name: Check for formatting changes
        if: ${{ steps.yamlfmt.outputs.diff }}
        run: |
          echo "ERROR: YAML file is not formatted properly. Here is the diff: "
          # Decode the Base64 diff to display it
          echo "${{ steps.clang-format.outputs.diff }}" | base64 --decode
          exit 1
        shell: bash