memscope-rs 0.2.6

name: memscope-rs CI

on:
  push:
    branches: [master, dev]
    tags: ["v*"]
  pull_request:
    branches: [master]

# Permissions for CI operations
permissions:
  contents: read

env:
  CARGO_TERM_COLOR: always
  RUST_BACKTRACE: 1
  RUSTFLAGS: "-D warnings"
  # Keep installation and every cargo subprocess on the repository's version.
  RUSTUP_TOOLCHAIN: "1.92.0"

jobs:
  # Lint on every platform we ship: `#[cfg(target_os = ...)]` code is only compiled on
  # its own platform, so a Linux-only lint job cannot catch dead code in the macOS
  # branch (and vice versa). This is exactly how a non-macOS stub slipped through.
  quality:
    name: Code Quality (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest]
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ env.RUSTUP_TOOLCHAIN }}
          components: rustfmt, clippy

      - name: Verify toolchain
        shell: bash
        run: bash .github/scripts/verify-toolchain.sh

      - name: Cache dependencies
        uses: Swatinem/rust-cache@v2
        with:
          key: quality-${{ matrix.os }}-${{ hashFiles('**/Cargo.lock') }}

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

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

      - name: Check compilation
        run: cargo check --locked --workspace --all-targets --all-features

  test:
    name: Tests (${{ matrix.os }}, ${{ matrix.features.name }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
        features:
          - name: standard
            args: --features auto-signal,periodic
          - name: all-features
            args: --all-features

    steps:
      - uses: actions/checkout@v4

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

      - name: Verify toolchain
        shell: bash
        run: bash .github/scripts/verify-toolchain.sh

      - name: Cache dependencies
        uses: Swatinem/rust-cache@v2
        with:
          key: test-${{ matrix.os }}-${{ matrix.features.name }}-${{ env.RUSTUP_TOOLCHAIN }}-${{ hashFiles('**/Cargo.lock') }}

      - name: Install cargo-nextest
        uses: taiki-e/install-action@v2
        with:
          tool: cargo-nextest

      - name: Run library tests
        run: cargo nextest run --locked --workspace ${{ matrix.features.args }} --test-threads 1 -E 'kind(lib)'

      - name: Run integration tests
        run: cargo nextest run --locked --workspace ${{ matrix.features.args }} --test-threads 1 -E 'kind(test)'

      - name: Test examples
        run: |
          cargo build --locked --examples ${{ matrix.features.args }}

  benchmarks:
    name: Benchmarks
    runs-on: ubuntu-latest
    if: github.event_name == 'push' && github.ref == 'refs/heads/master'

    steps:
      - uses: actions/checkout@v4

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

      - name: Verify toolchain
        shell: bash
        run: bash .github/scripts/verify-toolchain.sh

      - name: Cache dependencies
        uses: Swatinem/rust-cache@v2
        with:
          key: bench-${{ hashFiles('**/Cargo.lock') }}

      - name: Run benchmarks
        env:
          QUICK_BENCH: "1"
        run: cargo bench --locked --bench comprehensive_benchmarks

      - name: Upload benchmark results
        uses: actions/upload-artifact@v4
        with:
          name: benchmark-results
          path: target/criterion/

  docs:
    name: Documentation
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

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

      - name: Verify toolchain
        shell: bash
        run: bash .github/scripts/verify-toolchain.sh

      - name: Cache dependencies
        uses: Swatinem/rust-cache@v2
        with:
          key: docs-${{ hashFiles('**/Cargo.lock') }}

      - name: Build documentation
        run: cargo doc --locked --workspace --all-features --no-deps

  security:
    name: Security Audit
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

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

      - name: Verify toolchain
        shell: bash
        run: bash .github/scripts/verify-toolchain.sh

      - name: Install cargo-audit
        run: cargo install cargo-audit --locked

      - name: Run security audit
        run: cargo audit || echo "Audit check completed (some warnings may be acceptable)"

      - name: Check licenses
        run: |
          cargo install cargo-license --locked
          cargo license --json | jq -r '.[] | select(.license != "MIT" and .license != "Apache-2.0" and .license != "BSD-3-Clause" and .license != "BSD-2-Clause") | .name + ": " + .license'

  coverage:
    name: Code Coverage
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest]
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ env.RUSTUP_TOOLCHAIN }}
          components: llvm-tools-preview

      - name: Verify toolchain
        shell: bash
        run: bash .github/scripts/verify-toolchain.sh

      - name: Cache dependencies
        uses: Swatinem/rust-cache@v2
        with:
          key: coverage-${{ matrix.os }}-${{ hashFiles('**/Cargo.lock') }}

      - name: Install cargo-llvm-cov
        run: cargo install cargo-llvm-cov --locked

      - name: Generate coverage
        run: cargo llvm-cov --locked --workspace --lcov --output-path lcov.info

      - name: Upload to codecov
        uses: codecov/codecov-action@v5
        with:
          files: lcov.info
          fail_ci_if_error: false