atomic-time 1.0.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 (platform-independent, one OS is enough)
  rustfmt:
    name: rustfmt
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v7
    - name: Install Rust
      run: rustup update stable && rustup default stable && rustup component add rustfmt
    - 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@v7
    - 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 && rustup component add clippy
    - name: Install cargo-hack
      run: cargo install cargo-hack
    - name: Apply clippy lints
      run: cargo hack clippy --each-feature

  # 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
          - 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@v7
      - name: Cache cargo build and registry
        uses: actions/cache@v6
        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@v7
    - name: Cache cargo build and registry
      uses: actions/cache@v6
      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: Run build
      run: cargo hack build --feature-powerset
  
  test:
    name: test
    strategy:
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    runs-on: ${{ matrix.os }}
    steps:
    - uses: actions/checkout@v7
    - name: Cache cargo build and registry
      uses: actions/cache@v6
      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: Run test
      run: cargo hack test --feature-powerset
  
  sanitizer:
    name: sanitizer
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - name: Cache cargo build and registry
        uses: actions/cache@v6
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-sanitizer-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-sanitizer-
      - name: Install Rust
        run: |
          bash ci/rustup_install_retry.sh nightly --component rust-src
          rustup default nightly
      - name: ASAN / LSAN / MSAN / TSAN
        run: bash ci/sanitizer.sh

  miri-tb:
    name: miri-tb-${{ matrix.target }}
    strategy:
      matrix:
        include:
          - os: ubuntu-latest
            target: x86_64-unknown-linux-gnu
          - os: ubuntu-latest
            target: aarch64-unknown-linux-gnu
          - os: ubuntu-latest
            target: i686-unknown-linux-gnu
          - os: ubuntu-latest
            target: powerpc64-unknown-linux-gnu
          - os: ubuntu-latest
            target: s390x-unknown-linux-gnu
          - os: ubuntu-latest
            target: riscv64gc-unknown-linux-gnu
          - os: macos-latest
            target: aarch64-apple-darwin
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v7
      - name: Cache cargo build and registry
        uses: actions/cache@v6
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-miri-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-miri-
      - name: Miri
        run: |
          bash ci/miri_tb.sh "${{ matrix.target }}"

  miri-sb:
    name: miri-sb-${{ matrix.target }}
    strategy:
      matrix:
        include:
          - os: ubuntu-latest
            target: x86_64-unknown-linux-gnu
          - os: ubuntu-latest
            target: aarch64-unknown-linux-gnu
          - os: ubuntu-latest
            target: i686-unknown-linux-gnu
          - os: ubuntu-latest
            target: powerpc64-unknown-linux-gnu
          - os: ubuntu-latest
            target: s390x-unknown-linux-gnu
          - os: ubuntu-latest
            target: riscv64gc-unknown-linux-gnu
          - os: macos-latest
            target: aarch64-apple-darwin
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v7
      - name: Cache cargo build and registry
        uses: actions/cache@v6
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-miri-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-miri-
      - name: Miri
        run: |
          bash ci/miri_sb.sh "${{ matrix.target }}"
  
  # valgrind
  valgrind:
    name: valgrind
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - name: Cache cargo build and registry
        uses:  actions/cache@v6
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ubuntu-latest-valgrind-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ubuntu-latest-valgrind-

      - name: Install Rust stable
        run: rustup update stable --no-self-update && rustup default stable
      - name: Install Valgrind
        run: |
          sudo apt-get update -y
          sudo apt-get install -y valgrind
      # Compile tests
      - name: cargo build atomic_duraion
        run: cargo build --bin atomic_duration
        working-directory: integration

      # Run with valgrind
      - name: Run valgrind atomic_duration
        run: valgrind --error-exitcode=1 --leak-check=full --show-leak-kinds=all ./target/debug/atomic_duration
        working-directory: integration
      
      # Compile tests
      - name: cargo build atomic_option_duration
        run: cargo build --bin atomic_option_duration
        working-directory: integration

      # Run with valgrind
      - name: Run valgrind atomic_option_duration
        run: valgrind --error-exitcode=1 --leak-check=full --show-leak-kinds=all ./target/debug/atomic_option_duration
        working-directory: integration
      
      # Compile tests
      - name: cargo build atomic_system_time
        run: cargo build --bin atomic_system_time
        working-directory: integration

      # Run with valgrind
      - name: Run valgrind atomic_system_time
        run: valgrind --error-exitcode=1 --leak-check=full --show-leak-kinds=all ./target/debug/atomic_system_time
        working-directory: integration
      
      # Compile tests
      - name: cargo build atomic_option_system_time
        run: cargo build --bin atomic_option_system_time
        working-directory: integration

      # Run with valgrind
      - name: Run valgrind atomic_option_system_time
        run: valgrind --error-exitcode=1 --leak-check=full --show-leak-kinds=all ./target/debug/atomic_option_system_time
        working-directory: integration
      
      # Compile tests
      - name: cargo build atomic_instant
        run: cargo build --bin atomic_instant
        working-directory: integration

      # Run with valgrind
      - name: Run valgrind atomic_instant
        run: valgrind --error-exitcode=1 --leak-check=full --show-leak-kinds=all ./target/debug/atomic_instant
        working-directory: integration
      
      # Compile tests
      - name: cargo build atomic_option_instant
        run: cargo build --bin atomic_option_instant
        working-directory: integration

      # Run with valgrind
      - name: Run valgrind atomic_option_instant
        run: valgrind --error-exitcode=1 --leak-check=full --show-leak-kinds=all ./target/debug/atomic_option_instant
        working-directory: integration

  no-std:
    name: no-std
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - name: Install Rust
        run: rustup update stable && rustup default stable
      - name: Install target
        run: rustup target add thumbv7em-none-eabihf
      - name: Check no-std
        run: |
          cargo check --target thumbv7em-none-eabihf --no-default-features
          cargo check --target thumbv7em-none-eabihf --no-default-features --features serde

  msrv:
    name: msrv
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - name: Install Rust
        run: rustup toolchain install 1.85.0 --profile minimal
      - name: Check MSRV
        run: |
          cargo +1.85.0 check --lib --all-features
          cargo +1.85.0 check --lib --no-default-features --features serde

  docs:
    name: docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - name: Install Rust
        run: rustup update stable && rustup default stable
      - name: Build documentation
        run: RUSTDOCFLAGS="-Dwarnings" cargo doc --all-features --no-deps

  coverage:
    name: coverage
    runs-on: ubuntu-latest
    needs:
      - rustfmt
      - clippy
      - build
      - cross
      - test
      - sanitizer
      - miri-tb
      - miri-sb
      - no-std
      - msrv
      - docs
    steps:
      - uses: actions/checkout@v7
      - name: Install Rust
        run: |
          bash ci/rustup_install_retry.sh nightly --component llvm-tools-preview
          rustup default nightly
      - name: Install cargo-llvm-cov
        run: cargo install cargo-llvm-cov --version 0.8.7 --locked
      - name: Cache cargo build and registry
        uses: actions/cache@v6
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-coverage-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-coverage-
      - name: Run coverage
        run: |
          cargo +nightly llvm-cov clean --workspace
          cargo +nightly llvm-cov --workspace --all-features --doctests --lcov --output-path lcov.info
      - name: Upload to codecov.io
        uses: codecov/codecov-action@v7
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          slug: ${{ github.repository }}
          fail_ci_if_error: true
          files: ./lcov.info
          disable_search: true
          use_pypi: true
          version: v11.3.1
          use_legacy_upload_endpoint: true