hardware-address 0.3.0

name: CI

on:
  push:
    branches:
      - main
    paths-ignore:
      - 'README'
      - 'COPYRIGHT'
      - 'LICENSE-*'
      - '**.md'
      - '**.txt'
  pull_request:
    paths-ignore:
      - 'README'
      - 'COPYRIGHT'
      - 'LICENSE-*'
      - '**.md'
      - '**.txt'
  workflow_dispatch:
  schedule: 
    - cron: "0 1 1 * *"

env:
  CARGO_TERM_COLOR: always
  RUSTFLAGS: -Dwarnings
  RUST_BACKTRACE: 1
  nightly: nightly
  stable: stable

jobs:
  # Check formatting
  rustfmt:
    name: rustfmt
    strategy:
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    runs-on: ${{ matrix.os }}
    steps:
    - uses: actions/checkout@v6
    - name: Install Rust
      # --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
      run: rustup update stable --no-self-update && rustup default stable
    - name: Check formatting
      run: cargo fmt --all -- --check


  # Apply clippy lints
  clippy:
    name: clippy
    strategy:
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    runs-on: ${{ matrix.os }}
    steps:
    - uses: actions/checkout@v6
    - name: Install Rust
      # --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
      run: rustup update stable --no-self-update && rustup default stable
    - name: Install cargo-hack
      run: cargo install cargo-hack
    - name: Apply clippy lints
      run: cargo hack clippy --each-feature --exclude-no-default-features

  # Run tests on some extra platforms
  cross:
    name: cross
    strategy:
      matrix:
        target:
          - aarch64-unknown-linux-gnu
          - aarch64-linux-android
          - aarch64-unknown-linux-musl
          - i686-linux-android
          - x86_64-linux-android
          - i686-pc-windows-gnu
          - x86_64-pc-windows-gnu
          - i686-unknown-linux-gnu
          - powerpc64-unknown-linux-gnu
          # - mips64-unknown-linux-gnuabi64
          - riscv64gc-unknown-linux-gnu
          - wasm32-unknown-unknown
          - wasm32-unknown-emscripten
          - wasm32-wasip1
          - wasm32-wasip1-threads
          - wasm32-wasip2
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Cache cargo build and registry
        uses: actions/cache@v5
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-cross-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-cross-
      - name: Install Rust
        run: rustup update stable && rustup default stable
      - name: cargo build --target ${{ matrix.target }}
        run: |
          rustup target add ${{ matrix.target }}
          cargo build --target ${{ matrix.target }} 

  build:
    name: build
    strategy:
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    runs-on: ${{ matrix.os }}
    steps:
    - uses: actions/checkout@v6
    - name: Cache cargo build and registry
      uses: actions/cache@v5
      with:
        path: |
          ~/.cargo/registry
          ~/.cargo/git
          target
        key: ${{ runner.os }}-build-${{ hashFiles('**/Cargo.lock') }}
        restore-keys: |
          ${{ runner.os }}-build-
    - name: Install Rust
      # --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
      run: rustup update stable --no-self-update && rustup default stable
    - name: Install cargo-hack
      run: cargo install cargo-hack
    - name: Cache ~/.cargo
      uses: actions/cache@v5
      with:
        path: ~/.cargo
        key: ${{ runner.os }}-coverage-dotcargo
    - name: Run build
      run: cargo hack build --feature-powerset --exclude-no-default-features
  
  test:
    name: test
    strategy:
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    runs-on: ${{ matrix.os }}
    steps:
    - uses: actions/checkout@v6
    - name: Cache cargo build and registry
      uses: actions/cache@v5
      with:
        path: |
          ~/.cargo/registry
          ~/.cargo/git
          target
        key: ${{ runner.os }}-test-${{ hashFiles('**/Cargo.lock') }}
        restore-keys: |
          ${{ runner.os }}-test-
    - name: Install Rust
      # --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
      run: rustup update stable --no-self-update && rustup default stable
    - name: Install cargo-hack
      run: cargo install cargo-hack
    - name: Cache ~/.cargo
      uses: actions/cache@v5
      with:
        path: ~/.cargo
        key: ${{ runner.os }}-coverage-dotcargo
    - name: Run test
      run: cargo hack test --feature-powerset --exclude-no-default-features

  coverage:
    name: coverage
    runs-on: ubuntu-latest
    needs:
      - rustfmt
      - clippy
      - build
      - cross
      - test
    steps:
      - uses: actions/checkout@v6
      - name: Install Rust
        run: rustup update nightly && rustup default nightly
      - name: Install cargo-tarpaulin
        # Pin the tarpaulin version so CI and local runs track the same
        # set of lines. Different tarpaulin versions can produce different
        # totals (especially around macro-expanded code), which caused
        # codecov numbers to drift from local runs.
        uses: taiki-e/install-action@v2
        with:
          tool: cargo-tarpaulin@0.35.2
      - name: Cache cargo registry
        # Intentionally do NOT cache `target/`. Tarpaulin's instrumented
        # artifacts can get reused across runs even when src/ or tests/
        # change, which leaves stale `.gcno`-style hit data in the cache
        # and causes CI to under-report coverage vs local runs.
        uses: actions/cache@v5
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
          key: ${{ runner.os }}-coverage-registry-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-coverage-registry-
      - name: Print rustc / tarpaulin versions
        run: |
          rustc --version
          cargo tarpaulin --version
      - name: Force clean build
        # Belt-and-suspenders: even without a `target/` cache, make sure
        # tarpaulin always re-instruments this crate from source.
        run: cargo clean -p hardware-address
      - name: Run tarpaulin
        env:
          RUSTFLAGS: "--cfg tarpaulin"
        # `--exclude python --exclude wasm`: the binding subcrates
        # depend on `hardware-address` with their respective binding
        # features (`pyo3`, `wasm-bindgen`) enabled. Under `--workspace`,
        # cargo's feature unification would turn those on in the root
        # crate as well — and linking a test binary that references
        # pyo3's `extension-module` Python symbols (`PyBool_Type`,
        # `_Py_TrueStruct`, …) fails because those symbols are only
        # provided by the Python interpreter at load time. Excluding
        # both subcrates avoids the feature-unification trap; binding
        # coverage is handled by pytest and `wasm-pack test`.
        run: cargo tarpaulin -p hardware-address --features serde,arbitrary,quickcheck --run-types lib --run-types tests --run-types doctests --workspace --exclude python --exclude wasm --out xml
      - name: Upload coverage report artifact
        # Lets us download the exact cobertura.xml the CI produced and
        # diff it locally against a local tarpaulin run — useful when
        # codecov's reported number and local runs disagree.
        if: always()
        uses: actions/upload-artifact@v7
        with:
          name: cobertura-xml
          path: cobertura.xml
          if-no-files-found: warn
          retention-days: 14
      - name: Upload to codecov.io
        uses: codecov/codecov-action@v6
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          slug: ${{ github.repository }}
          fail_ci_if_error: true