.github/actions/setup/action.yaml

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

name: Setup Rust Builder
description: "Prepare Rust Build Environment"
inputs:
  need-rocksdb:
    description: "This setup needs rocksdb or not"
  need-foundationdb:
    description: "This setup needs foundationdb or not"
  need-nextest:
    description: "This setup needs nextest or not"
  need-protoc:
    description: "This setup needs protoc or not"
  need-deny:
    description: "This setup needs cargo-deny or not"
  github-token:
    description: "Github Token"
    default: ""

runs:
  using: "composite"
  steps:
    - name: Setup rust related environment variables
      shell: bash
      run: |
        # Disable full debug symbol generation to speed up CI build and keep memory down
        # "1" means line tables only, which is useful for panic tracebacks.
        # About `force-frame-pointers`, here's the discussion history: https://github.com/apache/opendal/issues/3756
        echo "RUSTFLAGS=-C force-frame-pointers=yes -C debuginfo=1" >> $GITHUB_ENV
        # Enable backtraces
        echo "RUST_BACKTRACE=1" >> $GITHUB_ENV
        # Enable logging
        echo "RUST_LOG=opendal=trace" >> $GITHUB_ENV
        # Enable sparse index
        echo "CARGO_REGISTRIES_CRATES_IO_PROTOCOL=sparse" >> $GITHUB_ENV
        # Make sure rust has been setup
        cargo version

    # Make sure all required lib has been installed.
    - name: Setup Linux
      if: runner.os == 'Linux'
      shell: bash
      run: sudo apt-get install libgflags-dev libsnappy-dev zlib1g-dev libbz2-dev liblz4-dev libzstd-dev

    - name: Setup Protoc
      if: inputs.need-protoc == 'true'
      shell: bash
      run: |
        set -euo pipefail

        PROTOC_VERSION="23.4"
        PROTOC_ROOT="${RUNNER_TEMP}/protoc/${PROTOC_VERSION}"

        case "${RUNNER_OS}-${RUNNER_ARCH}" in
          Linux-X64)
            PROTOC_PLATFORM="linux-x86_64"
            ;;
          Linux-ARM64)
            PROTOC_PLATFORM="linux-aarch_64"
            ;;
          macOS-X64)
            PROTOC_PLATFORM="osx-x86_64"
            ;;
          macOS-ARM64)
            PROTOC_PLATFORM="osx-aarch_64"
            ;;
          Windows-X64)
            PROTOC_PLATFORM="win64"
            ;;
          *)
            echo "Unsupported runner: ${RUNNER_OS}-${RUNNER_ARCH}" >&2
            exit 1
            ;;
        esac

        echo "PROTOC_VERSION=${PROTOC_VERSION}" >> "${GITHUB_ENV}"
        echo "PROTOC_ROOT=${PROTOC_ROOT}" >> "${GITHUB_ENV}"
        echo "PROTOC_PLATFORM=${PROTOC_PLATFORM}" >> "${GITHUB_ENV}"

    - name: Cache Protoc
      if: inputs.need-protoc == 'true'
      id: cache-protoc
      uses: actions/cache@v4
      with:
        path: ${{ runner.temp }}/protoc/${{ env.PROTOC_VERSION }}
        key: protoc-${{ env.PROTOC_VERSION }}-${{ runner.os }}-${{ runner.arch }}

    - name: Install Protoc (Unix)
      if: inputs.need-protoc == 'true' && runner.os != 'Windows' && steps.cache-protoc.outputs.cache-hit != 'true'
      shell: bash
      run: |
        set -euo pipefail

        PROTOC_ZIP="protoc-${PROTOC_VERSION}-${PROTOC_PLATFORM}.zip"
        PROTOC_URL="https://github.com/protocolbuffers/protobuf/releases/download/v${PROTOC_VERSION}/${PROTOC_ZIP}"

        mkdir -p "${PROTOC_ROOT}"
        curl -fsSL -o "${RUNNER_TEMP}/${PROTOC_ZIP}" "${PROTOC_URL}"
        unzip -q "${RUNNER_TEMP}/${PROTOC_ZIP}" -d "${PROTOC_ROOT}"

    - name: Install Protoc (Windows)
      if: inputs.need-protoc == 'true' && runner.os == 'Windows' && steps.cache-protoc.outputs.cache-hit != 'true'
      shell: pwsh
      run: |
        $ErrorActionPreference = 'Stop'

        $protocZip = "protoc-$env:PROTOC_VERSION-$env:PROTOC_PLATFORM.zip"
        $protocUrl = "https://github.com/protocolbuffers/protobuf/releases/download/v$env:PROTOC_VERSION/$protocZip"
        $zipPath = Join-Path $env:RUNNER_TEMP $protocZip
        $dest = $env:PROTOC_ROOT

        New-Item -ItemType Directory -Force -Path $dest | Out-Null
        Invoke-WebRequest -Uri $protocUrl -OutFile $zipPath
        Expand-Archive -Path $zipPath -DestinationPath $dest -Force

    - name: Add Protoc to PATH
      if: inputs.need-protoc == 'true'
      shell: bash
      run: |
        set -euo pipefail
        echo "${PROTOC_ROOT}/bin" >> "${GITHUB_PATH}"
        export PATH="${PROTOC_ROOT}/bin:${PATH}"
        protoc --version

    - name: Install cargo-nextest
      if: inputs.need-nextest == 'true'
      uses: taiki-e/install-action@v2
      with:
        tool: cargo-nextest@0.9.72

    - name: Install cargo-deny
      if: inputs.need-deny == 'true'
      uses: taiki-e/install-action@v2
      with:
        tool: cargo-deny@0.14.22

    - name: Setup rocksdb on linux
      if: runner.os == 'Linux' && inputs.need-rocksdb == 'true'
      shell: bash
      run: |
        # Set rocksdb lib path
        echo "ROCKSDB_LIB_DIR=/tmp/rocksdb/lib" >> $GITHUB_ENV

    - name: Cache rocksdb
      id: cache-rocksdb
      uses: actions/cache@v4
      if: runner.os == 'Linux' && inputs.need-rocksdb == 'true'
      with:
        path: /tmp/rocksdb
        key: r2-rocksdb-8.1.1

    - name: Build rocksdb if not cached
      if: steps.cache-rocksdb.outputs.cache-hit != 'true' && runner.os == 'Linux' && inputs.need-rocksdb == 'true'
      shell: bash
      run: |
        set -e

        cd /tmp
        curl https://github.com/facebook/rocksdb/archive/refs/tags/v8.1.1.tar.gz -L -o rocksdb.tar.gz
        tar -xzf rocksdb.tar.gz
        cd rocksdb-8.1.1

        mkdir /tmp/rocksdb
        cmake -DCMAKE_INSTALL_PREFIX=/tmp/rocksdb -DPORTABLE=1
        make -j$(nproc)
        make install

        cd ..
        rm -rf /tmp/rocksdb-8.1.1

    - name: Cache foundationdb
      id: cache-foundationdb
      uses: actions/cache@v4
      if: runner.os == 'Linux' && inputs.need-foundationdb == 'true'
      with:
        path: /etc/foundationdb
        key: r0-foundationdb-7.1.17

    - name: Build foundationdb if not cached
      if: steps.cache-foundationdb.outputs.cache-hit != 'true' && runner.os == 'Linux' && inputs.need-foundationdb == 'true'
      shell: bash
      run: |
        set -e

        cd /tmp

        curl https://github.com/apple/foundationdb/releases/download/7.1.17/foundationdb-clients_7.1.17-1_amd64.deb -L -o foundationdb-clients_7.1.17-1_amd64.deb
        curl https://github.com/apple/foundationdb/releases/download/7.1.17/foundationdb-server_7.1.17-1_amd64.deb -L -o foundationdb-server_7.1.17-1_amd64.deb

        sudo dpkg -i foundationdb-clients_7.1.17-1_amd64.deb foundationdb-server_7.1.17-1_amd64.deb

        rm foundationdb-clients_7.1.17-1_amd64.deb
        rm foundationdb-server_7.1.17-1_amd64.deb