ci.yml

name: CI

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

permissions:
  contents: read

env:
  CARGO_TERM_COLOR: always
  RUST_BACKTRACE: 1

jobs:
  test:
    name: Test
    runs-on: ubuntu-latest
    steps:
      - name: Free disk space
        run: |
          sudo rm -rf /usr/share/dotnet
          sudo rm -rf /opt/ghc
          sudo rm -rf /usr/local/share/boost
          sudo rm -rf "$AGENT_TOOLSDIRECTORY"
          df -h

      - uses: actions/checkout@v7

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Install native database client libraries
        run: |
          sudo apt-get update
          sudo apt-get install -y pkg-config libmysqlclient-dev libpq-dev libsqlite3-dev

      - name: Cache cargo registry
        uses: actions/cache@v6
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
          key: ${{ runner.os }}-cargo-test-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-cargo-test-

      - name: Run tests
        run: cargo test --workspace

      - name: Run tests with all features
        run: cargo test --workspace --all-features

      - name: Run tests with no default features
        run: cargo test --workspace --no-default-features


  lint:
    name: Lint
    runs-on: ubuntu-latest
    steps:
      - name: Free disk space
        run: |
          sudo rm -rf /usr/share/dotnet
          sudo rm -rf /opt/ghc
          sudo rm -rf /usr/local/share/boost
          sudo rm -rf "$AGENT_TOOLSDIRECTORY"
          df -h

      - uses: actions/checkout@v7

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt, clippy

      - name: Install native database client libraries
        run: |
          sudo apt-get update
          sudo apt-get install -y pkg-config libmysqlclient-dev libpq-dev libsqlite3-dev

      - name: Cache cargo registry
        uses: actions/cache@v6
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
          key: ${{ runner.os }}-cargo-lint-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-cargo-lint-

      - name: Check formatting
        run: cargo fmt --all -- --check

      - name: Run clippy
        run: cargo clippy --workspace --all-features --all-targets -- -D warnings

  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - name: Free disk space
        run: |
          sudo rm -rf /usr/share/dotnet
          sudo rm -rf /opt/ghc
          sudo rm -rf /usr/local/share/boost
          sudo rm -rf "$AGENT_TOOLSDIRECTORY"
          df -h

      - uses: actions/checkout@v7

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Install native database client libraries
        run: |
          sudo apt-get update
          sudo apt-get install -y pkg-config libmysqlclient-dev libpq-dev libsqlite3-dev

      - name: Cache cargo registry
        uses: actions/cache@v6
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
          key: ${{ runner.os }}-cargo-build-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-cargo-build-

      - name: Build
        run: cargo build --workspace

      - name: Build with all features
        run: cargo build --workspace --all-features

      - name: Build release
        run: cargo build --workspace --release

  docs:
    name: Documentation
    runs-on: ubuntu-latest
    steps:
      - name: Free disk space
        run: |
          sudo rm -rf /usr/share/dotnet
          sudo rm -rf /opt/ghc
          sudo rm -rf /usr/local/share/boost
          sudo rm -rf "$AGENT_TOOLSDIRECTORY"
          df -h

      - uses: actions/checkout@v7

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Install native database client libraries
        run: |
          sudo apt-get update
          sudo apt-get install -y pkg-config libmysqlclient-dev libpq-dev libsqlite3-dev

      - name: Cache cargo registry
        uses: actions/cache@v6
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
          key: ${{ runner.os }}-cargo-docs-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-cargo-docs-

      - name: Build documentation
        run: cargo doc --workspace --all-features --no-deps
        env:
          RUSTDOCFLAGS: -D warnings


  coverage:
    name: Coverage
    runs-on: ubuntu-latest
    steps:
      - name: Free disk space
        run: |
          sudo rm -rf /usr/share/dotnet
          sudo rm -rf /opt/ghc
          sudo rm -rf /usr/local/share/boost
          sudo rm -rf "$AGENT_TOOLSDIRECTORY"
          df -h

      - uses: actions/checkout@v7

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          components: llvm-tools-preview

      - name: Install native database client libraries
        run: |
          sudo apt-get update
          sudo apt-get install -y pkg-config libmysqlclient-dev libpq-dev libsqlite3-dev

      - name: Cache cargo registry
        uses: actions/cache@v6
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
          key: ${{ runner.os }}-cargo-coverage-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-cargo-coverage-

      # tarpaulin's default ptrace engine segfaults under multi-threaded tokio
      # integration tests on GHA. cargo-llvm-cov uses LLVM instrumentation instead.
      - name: Install cargo-llvm-cov
        uses: taiki-e/install-action@cargo-llvm-cov

      - name: Run coverage
        run: |
          mkdir -p coverage
          # cargo-rustapi spawns nested `cargo` builds in integration tests;
          # those subprocesses are not useful to instrument for line coverage.
          cargo llvm-cov clean --workspace
          cargo llvm-cov --workspace --exclude cargo-rustapi --no-report
          cargo llvm-cov report --lcov --output-path coverage/lcov.info
          cargo llvm-cov report --html --output-dir coverage/html
          cargo llvm-cov report --cobertura --output-path coverage/cobertura.xml
          cargo llvm-cov report --summary-only | tee coverage/summary.txt

      - name: Upload coverage report
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: coverage-report
          path: |
            coverage/html
            coverage/lcov.info
            coverage/cobertura.xml
            coverage/summary.txt
          if-no-files-found: ignore
          retention-days: 30

      - name: Coverage summary
        if: always()
        run: |
          {
            echo "## Coverage"
            echo "Engine: **cargo-llvm-cov** (LLVM). Download the **coverage-report** artifact for HTML/LCOV."
            echo ""
            if [ -f coverage/summary.txt ]; then
              echo '```'
              cat coverage/summary.txt
              echo '```'
            fi
          } >> "$GITHUB_STEP_SUMMARY"