ci.yml

# 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: CI

on:
  push:
    branches:
      - main
  pull_request:
    paths:
      - '**'                              # Include all files and directories in the repository by default.
      - '!.github/ISSUE_TEMPLATE/**'      # Exclude files and directories that don't impact tests or code like templates, metadata, and documentation.
      - '!dev/release/**'
      - '!website/**'
      - '!.asf.yml'
      - '!.gitattributes'
      - '!.gitignore'
      - '!CONTRIBUTING.md'
      - '!CHANGELOG.md'
      - '!LICENSE'
      - '!NOTICE'
      - '!README.md'

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Setup Rust toolchain
        uses: ./.github/actions/setup-builder

      - name: Install lint tools
        # Keep versions in sync with the local install targets in Makefile.
        uses: taiki-e/install-action@7f4eb899022d8fe70b20c4f3de697aa85c309026 # v2.85.11
        with:
          tool: taplo@0.9.3,cargo-machete@0.7.0

      - name: Check License Header
        uses: apache/skywalking-eyes/header@61275cc80d0798a405cb070f7d3a8aaf7cf2c2c1 # v0.8.0

      - name: Check toml format
        run: taplo fmt --check

      - name: Cargo format
        run: make check-fmt

      - name: Check diff
        run: git diff --exit-code

      - name: Check Cargo.lock is up-to-date
        run: cargo update --workspace --locked

      - name: Cargo Machete
        run: cargo machete

      - name: Check typos
        uses: crate-ci/typos@8a48f81b6c64dcfea44b3633223084c4be58ac5f # v1.49.0

  clippy:
    needs: lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Setup Rust toolchain
        uses: ./.github/actions/setup-builder

      - name: Cargo clippy
        run: make check-clippy

  build:
    needs: lint
    runs-on: ${{ matrix.os }}
    env:
      CARGO_INCREMENTAL: "0"
      CARGO_PROFILE_DEV_DEBUG: "0"
    strategy:
      max-parallel: 15
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Setup Rust toolchain
        uses: ./.github/actions/setup-builder

      - name: Cache Rust artifacts
        uses: swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2
        with:
          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

      - name: Build
        run: make build

  # Checks each crate individually to catch missing feature declarations that
  # are otherwise masked by Cargo's feature unification across the workspace.
  check_standalone:
    needs: lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Setup Rust toolchain
        uses: ./.github/actions/setup-builder

      - name: Cache Rust artifacts
        uses: swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2
        with:
          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

      - name: Check each crate standalone
        run: |
          for pkg in $(cargo metadata --no-deps --format-version=1 | jq -r '.packages[].name'); do
            echo "Checking $pkg..."
            cargo check -p "$pkg" --all-targets || exit 1
          done

  # Verifies the core iceberg crate compiles without default features, ensuring
  # optional functionality is properly gated behind feature flags.
  build_with_no_default_features:
    needs: lint
    runs-on: ${{ matrix.os }}
    env:
      CARGO_INCREMENTAL: "0"
      CARGO_PROFILE_DEV_DEBUG: "0"
    strategy:
      max-parallel: 15
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Setup Rust toolchain
        uses: ./.github/actions/setup-builder

      - name: Cache Rust artifacts
        uses: swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2
        with:
          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

      - name: Build
        run: cargo build -p iceberg --no-default-features

  tests:
    needs: lint
    runs-on: ubuntu-latest
    env:
      CARGO_INCREMENTAL: "0"
      CARGO_PROFILE_DEV_DEBUG: "0"
    strategy:
      max-parallel: 15
      matrix:
        test-suite:
          - { name: "default", args: "--all-targets --all-features --workspace" }
          - { name: "doc", args: "--doc --all-features --workspace" }
    name: Tests (${{ matrix.test-suite.name }})
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Setup Rust toolchain
        uses: ./.github/actions/setup-builder

      - name: Cache Rust artifacts
        uses: swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2
        with:
          key: ${{ matrix.test-suite.name }}
          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

      - name: Install cargo-nextest
        if: matrix.test-suite.name == 'default'
        uses: taiki-e/install-action@7f4eb899022d8fe70b20c4f3de697aa85c309026 # v2.85.11
        with:
          tool: cargo-nextest

      - name: Start Docker containers
        if: matrix.test-suite.name == 'default'
        run: make docker-up

      - name: Run tests
        shell: bash
        env:
          # HuggingFace Hub integration tests self-skip when these are unset
          # (e.g. PRs from forks); see crates/storage/opendal/tests/file_io_hf_test.rs
          HF_TOKEN: ${{ secrets.HF_TOKEN }}
          HF_BUCKET: ${{ secrets.HF_BUCKET }}
          HF_DATASET: ${{ secrets.HF_DATASET }}
        run: |
          if [ "${{ matrix.test-suite.name }}" = "default" ]; then
            cargo nextest run ${{ matrix.test-suite.args }}
          else
            cargo test --no-fail-fast ${{ matrix.test-suite.args }}
          fi

      - name: Stop Docker containers
        if: always() && matrix.test-suite.name == 'default'
        run: make docker-down

  msrv:
    name: Verify MSRV
    needs: lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false
      - name: Get MSRV
        id: get-msrv
        uses: ./.github/actions/get-msrv
      - name: Setup MSRV Rust toolchain
        uses: ./.github/actions/setup-builder
        with:
          rust-version: ${{ steps.get-msrv.outputs.msrv }}
      - name: Setup Nightly Rust toolchain
        uses: ./.github/actions/setup-builder
      - name: Check MSRV
        run: make check-msrv