rust-compile.yml

on:
  push:
    branches: [ main ]
  pull_request:
    paths:
      # When we change pyproject.toml, we want to ensure that the maturin builds still work
      - test-data/**
      - crates/**
      - Cargo.*

      # And when we change this workflow itself...
      - .github/workflows/rust-compile.yml

name: Rust

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

env:
  RUST_LOG: info
  RUST_BACKTRACE: 1
  RUSTFLAGS: "-D warnings"
  CARGO_TERM_COLOR: always
  DEFAULT_FEATURES: tokio,serde,reqwest,sparse,sysinfo,resolvo,gateway

jobs:
  check-rustdoc-links:
    name: Check intra-doc links
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive
      - uses: actions-rust-lang/setup-rust-toolchain@v1
      - run: |
          for package in $(cargo metadata --no-deps --format-version=1 | jq -r '.packages[] | .name'); do
            cargo rustdoc -p "$package" --all-features -- -D warnings -W unreachable-pub
          done

  format_and_lint:
    name: Format and Lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive
      - uses: actions-rust-lang/setup-rust-toolchain@v1
        with:
          components: clippy, rustfmt
      - name: Run rustfmt
        uses: actions-rust-lang/rustfmt@v1
      - name: Run clippy
        run: cargo clippy --all-targets

  build:
    name: ${{ matrix.name }}
    runs-on: ${{ matrix.os }}
    needs: [ format_and_lint ]
    strategy:
      fail-fast: false
      matrix:
        include:
          - { name: "Linux-x86_64",      target: x86_64-unknown-linux-musl,        os: ubuntu-latest }
          - { name: "Linux-aarch64",     target: aarch64-unknown-linux-musl,       os: ubuntu-latest, skip-tests: true }
          - { name: "Linux-arm",         target: arm-unknown-linux-musleabi,       os: ubuntu-latest, use-cross: true, skip-tests: true }

          # - { name: "Linux-mips",        target: mips-unknown-linux-musl,          os: ubuntu-latest, use-cross: true, skip-tests: true }
          # - { name: "Linux-mipsel",      target: mipsel-unknown-linux-musl,        os: ubuntu-latest, use-cross: true, skip-tests: true }
          # - { name: "Linux-mips64",      target: mips64-unknown-linux-muslabi64,   os: ubuntu-latest, use-cross: true, skip-tests: true }
          # - { name: "Linux-mips64el",    target: mips64el-unknown-linux-muslabi64, os: ubuntu-latest, use-cross: true, skip-tests: true }

#          - { name: "Linux-powerpc",     target: powerpc-unknown-linux-gnu,        os: ubuntu-latest, use-cross: true, skip-tests: true }
          - { name: "Linux-powerpc64",   target: powerpc64-unknown-linux-gnu,      os: ubuntu-latest, use-cross: true, skip-tests: true }
          - { name: "Linux-powerpc64le", target: powerpc64le-unknown-linux-gnu,    os: ubuntu-latest, use-cross: true, skip-tests: true }

          - { name: "Linux-s390x",       target: s390x-unknown-linux-gnu,          os: ubuntu-latest, use-cross: true, skip-tests: true }

          - { name: "macOS-x86_64",      target: x86_64-apple-darwin,              os: macOS-latest }
          - { name: "macOS-aarch64",     target: aarch64-apple-darwin,             os: macOS-latest,                  skip-tests: true }

          - { name: "Windows-x86_64",    target: x86_64-pc-windows-msvc,           os: windows-latest }
          - { name: "Windows-aarch64",   target: aarch64-pc-windows-msvc,          os: windows-latest,                  skip-tests: true }
    steps:
      - name: Checkout source code
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Install Rust toolchain
        uses: actions-rust-lang/setup-rust-toolchain@v1
        with:
          target: ${{ matrix.target }}
          components: rustfmt
          cache: false

      - uses: taiki-e/setup-cross-toolchain-action@v1
        if: matrix.target != 'x86_64-unknown-linux-musl'
        with:
          target: ${{ matrix.target }}

      - if: matrix.target == 'x86_64-unknown-linux-musl'
        run: |
          sudo apt install musl-tools gcc g++
          sudo ln -s /usr/bin/musl-gcc /usr/bin/musl-g++

      - uses: Swatinem/rust-cache@v2

      - name: Show version information (Rust, cargo, GCC)
        shell: bash
        run: |
          gcc --version || true
          rustup -V
          rustup toolchain list
          cargo -V
          rustc -V

      - name: Use rustls on musl targets.
        id: build-options
        if: contains(matrix.target, '-musl') || startsWith(matrix.target, 'powerpc') || startsWith(matrix.target, 's390x')
        run: |
          echo "CARGO_BUILD_OPTIONS=${CARGO_BUILD_OPTIONS} --no-default-features --features rustls-tls" >> $GITHUB_OUTPUT

      - name: Build
        run: >
          cargo build 
          --all-targets  
          --features ${{ env.DEFAULT_FEATURES }}
          --target ${{ matrix.target }}
          ${{ steps.build-options.outputs.CARGO_BUILD_OPTIONS}}

      - name: Disable testing the tools crate if cross compiling
        id: test-options
        if: ${{ !matrix.skip-tests }}
        run: |
          echo "CARGO_TEST_OPTIONS=${CARGO_TEST_OPTIONS} --exclude tools" >> $GITHUB_OUTPUT

      - name: Install cargo nextest
        if: ${{ !matrix.skip-tests }}
        uses: taiki-e/install-action@v2
        with:
          tool: cargo-nextest

      - name: Run tests
        if: ${{ !matrix.skip-tests }}
        run: >
          cargo nextest run
          --workspace 
          --features ${{ env.DEFAULT_FEATURES }} 
          --target ${{ matrix.target }}
          ${{ steps.build-options.outputs.CARGO_BUILD_OPTIONS}} 
          ${{ steps.test-options.outputs.CARGO_TEST_OPTIONS}} 

      - name: Run doctests
        if: ${{ !matrix.skip-tests }}
        run: >
          cargo test --doc