ci-check-app.yml

name: App - Check

on:
  workflow_call:
    inputs:
      test-args:
        description: 'The arguments to pass to the test command'
        type: string
        default: '--all-features --lib --bins'
      test-suites:
        description: 'Extra test suites to run'
        type: string
        default: ''
      rust-toolchain:
        description: 'The Rust version to use'
        type: string
        default: 'stable'
      rust-toolchain-formatting:
        description: 'The Rust version to use to check formatting'
        type: string
        default: 'stable'
      rust-toolchain-udeps:
        description: 'The Rust version to use to run udeps'
        type: string
        default: 'nightly'
      check-udeps:
        description: Enable checking for unusued dependencies
        type: boolean
        default: true
      rust-backtrace:
        description: 'The Rust backtrace settings'
        type: string
        default: 'full'
      install-protoc:
        description: 'Install protoc before running tests'
        type: boolean
        default: true
      use-sccache:
        # DEPRECATED / no-op: sccache had no persistent backend configured here
        # (its object store was never cached), so it provided no cross-run
        # benefit and disabled incremental compilation, which fights the
        # Swatinem/rust-cache target/ cache. The input is kept so existing
        # callers (and ci.yml) don't break; it no longer wires anything.
        description: '(deprecated, no-op) Run sccache-cache before running tests'
        type: boolean
        default: true
      use-mold:
        # Opt-in (default false): mold is a linker, so it only helps jobs that
        # link a binary — i.e. tests / tests-suites, not clippy (check-only) or
        # fmt (no compile). Keep this OFF for `cargo test --release` / LTO test
        # builds: mold can't read ThinLTO bitcode objects without the LLVM
        # plugin and the final link fails.
        description: 'Use the mold linker (clang driver) for the test jobs. Only for non-LTO debug test builds.'
        type: boolean
        default: false
      use-postgresql:
        description: 'Run postgresql before running tests'
        type: boolean
        default: false
      test-env-vars:
        description: 'The environment variables to set for the tests'
        type: string
        default: ''
      run-label:
        description: 'The run label to use for the actions'
        type: string
        default: 'ubuntu-latest'
      rust-cache-prefix:
        description: 'Prefix for Rust cache key (bump to invalidate all caches)'
        type: string
        default: 'v0-rust'
      rust-cache-save:
        description: 'Whether to save the Rust cache (set to false for PRs to only restore from main)'
        type: boolean
        default: true

env:
  RUST_BACKTRACE: ${{ inputs.rust-backtrace }}

permissions:
  contents: read

jobs:
  clippy:
    name: Clippy
    runs-on: ${{ inputs.run-label }}
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          token: ${{ secrets.PRIVATE_SUBMODULE_ACCESS_TOKEN || github.token }}
          submodules: recursive

      - name: Install Rust ${{ inputs.rust-toolchain }}
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ inputs.rust-toolchain }}
          components: clippy

      - name: Rust cache
        uses: Swatinem/rust-cache@23869a5bd66c73db3c0ac40331f3206eb23791dc # v2.9.1
        with:
          prefix-key: ${{ inputs.rust-cache-prefix }}
          shared-key: clippy
          save-if: ${{ inputs.rust-cache-save }}

      - name: Install Protoc
        if: ${{ inputs.install-protoc == true }}
        uses: arduino/setup-protoc@v3
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}

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

  formatting:
    name: Formatting
    runs-on: ${{ inputs.run-label }}
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          token: ${{ secrets.PRIVATE_SUBMODULE_ACCESS_TOKEN || github.token }}
          submodules: recursive
      - name: Install Rust ${{ inputs.rust-toolchain-formatting }}
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ inputs.rust-toolchain-formatting }}
          components: rustfmt

      # `cargo fmt -- --check` does not compile anything, so there is no target/
      # or dependency cache to restore here.
      - name: Check Formatting
        run: cargo fmt -- --check

  tests:
    name: Unit Tests
    runs-on: ${{ inputs.run-label }}
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          token: ${{ secrets.PRIVATE_SUBMODULE_ACCESS_TOKEN || github.token }}
          submodules: recursive

      - name: Install Rust ${{ inputs.rust-toolchain }}
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ inputs.rust-toolchain }}

      # Before the cache step so RUSTFLAGS is part of the Swatinem cache key.
      - name: Set up mold linker
        if: ${{ inputs.use-mold }}
        run: |
          sudo apt-get update -qq
          sudo apt-get install -y --no-install-recommends mold clang
          echo "RUSTFLAGS=${RUSTFLAGS:+$RUSTFLAGS }-C linker=clang -C link-arg=-fuse-ld=mold" >> "$GITHUB_ENV"

      - name: Rust cache
        uses: Swatinem/rust-cache@23869a5bd66c73db3c0ac40331f3206eb23791dc # v2.9.1
        with:
          prefix-key: ${{ inputs.rust-cache-prefix }}
          shared-key: tests
          save-if: ${{ inputs.rust-cache-save }}

      - name: Install Protoc
        if: ${{ inputs.install-protoc == true }}
        uses: arduino/setup-protoc@v3
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}

      - name: Unit Tests
        run: cargo test ${{ inputs.test-args }}

  tests-suites:
    name: Tests Suite "${{ matrix.element }}"
    if: (inputs.test-suites != '') && (inputs.test-suites != '[]')
    strategy:
      fail-fast: false
      matrix:
        element: ${{ fromJson(inputs.test-suites) }}
    runs-on: ${{ inputs.run-label }}
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          token: ${{ secrets.PRIVATE_SUBMODULE_ACCESS_TOKEN || github.token }}
          submodules: recursive

      - name: Parse and export environment variables
        run: |
          echo '${{ inputs.test-env-vars }}' | jq -r "to_entries|map(\"\(.key)=\(.value|tostring)\")|.[]" >> $GITHUB_ENV

      - name: Run Postgresql
        if: ${{ inputs.use-postgresql == true }}
        uses: ikalnytskyi/action-setup-postgres@v5

      - name: Install Rust ${{ inputs.rust-toolchain }}
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ inputs.rust-toolchain }}

      # Before the cache step so RUSTFLAGS is part of the Swatinem cache key.
      - name: Set up mold linker
        if: ${{ inputs.use-mold }}
        run: |
          sudo apt-get update -qq
          sudo apt-get install -y --no-install-recommends mold clang
          echo "RUSTFLAGS=${RUSTFLAGS:+$RUSTFLAGS }-C linker=clang -C link-arg=-fuse-ld=mold" >> "$GITHUB_ENV"

      - name: Rust cache
        uses: Swatinem/rust-cache@23869a5bd66c73db3c0ac40331f3206eb23791dc # v2.9.1
        with:
          prefix-key: ${{ inputs.rust-cache-prefix }}
          shared-key: tests-suites
          save-if: ${{ inputs.rust-cache-save }}

      - name: Install Protoc
        if: ${{ inputs.install-protoc == true }}
        uses: arduino/setup-protoc@v3
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}

      - name: Test Suite
        run: cargo test --test ${{ matrix.element }}

  unused-dependencies:
    name: Unused Dependencies
    runs-on: ${{ inputs.run-label }}
    if: ${{ inputs.check-udeps }}
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          token: ${{ secrets.PRIVATE_SUBMODULE_ACCESS_TOKEN || github.token }}
          submodules: recursive

      - name: Install Rust ${{ inputs.rust-toolchain-udeps }}
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ inputs.rust-toolchain-udeps }}

      - name: Rust cache
        uses: Swatinem/rust-cache@23869a5bd66c73db3c0ac40331f3206eb23791dc # v2.9.1
        with:
          prefix-key: ${{ inputs.rust-cache-prefix }}
          shared-key: unused-deps
          save-if: ${{ inputs.rust-cache-save }}

      - name: Install cargo-udeps
        run: cargo install cargo-udeps@0.1.43 --locked

      - name: Check Dependencies
        run: cargo udeps --all-targets

  license:
    name: Licenses
    runs-on: ${{ inputs.run-label }}
    steps:
      - uses: actions/checkout@v6
        with:
          token: ${{ secrets.PRIVATE_SUBMODULE_ACCESS_TOKEN || github.token }}
          submodules: recursive
      - uses: EmbarkStudios/cargo-deny-action@v2
        with:
          rust-version: ${{ inputs.rust-toolchain }}
          command: check licenses