ci: setup miri #578
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Rust CI | |
| on: | |
| push: | |
| pull_request: | |
| schedule: | |
| - cron: "0 0 * * *" | |
| env: | |
| CARGO_TERM_COLOR: always | |
| CARGO_INCREMENTAL: 0 | |
| # See: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency. | |
| # This will ensure that only one commit will be running tests at a time on each PR. | |
| concurrency: | |
| group: ${{ github.ref }}-${{ github.workflow }} | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| # Run on external PRs and pushes to branches on the repo | |
| # This is to avoid double running on PRs from internal branches | |
| if: github.event_name == 'push' || github.event_name == 'schedule' || | |
| github.event.pull_request.head.repo.full_name != github.repository | |
| strategy: | |
| matrix: | |
| rust: [stable, nightly] | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| name: Build & test | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ matrix.rust }} | |
| - name: Cache Cargo registry | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Install cargo-nextest | |
| uses: taiki-e/install-action@v2 | |
| with: | |
| tool: nextest | |
| - name: Build | |
| run: cargo +${{ matrix.rust }} build | |
| - name: Test | |
| run: cargo +${{ matrix.rust }} nextest run --all-features | |
| # Nextest does not support doc tests as in stable Rust | |
| # they are not exposed in the same way as normal tests. | |
| # https://github.com/nextest-rs/nextest/issues/16 | |
| - name: Test docs | |
| run: cargo +${{ matrix.rust }} test --doc | |
| clippy: | |
| if: github.event_name == 'push' || github.event_name == 'schedule' || | |
| github.event.pull_request.head.repo.full_name != github.repository | |
| name: Clippy lint checks | |
| runs-on: ubuntu-latest | |
| needs: ["build"] | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: stable | |
| components: clippy | |
| - name: Cache Cargo registry | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Run clippy | |
| run: cargo clippy --no-deps -- -Dclippy::all -Wclippy::pedantic | |
| external-deps: | |
| if: github.event_name == 'push' || github.event_name == 'schedule' || | |
| github.event.pull_request.head.repo.full_name != github.repository | |
| name: Test with external dependencies | |
| runs-on: ubuntu-latest | |
| needs: ["build"] | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: nightly | |
| - name: Cache Cargo registry | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Install cargo-nextest | |
| uses: taiki-e/install-action@v2 | |
| with: | |
| tool: nextest | |
| - name: Build | |
| run: cargo build | |
| - name: Run the external dependencies | |
| run: docker compose up -d | |
| - name: Test | |
| run: cargo nextest run --all-features -- --include-ignored | |
| - name: Test docs | |
| run: cargo test --doc | |
| coverage: | |
| if: github.event_name == 'push' || github.event_name == 'schedule' || | |
| github.event.pull_request.head.repo.full_name != github.repository | |
| name: Test coverage checks | |
| runs-on: ubuntu-latest | |
| needs: ["build"] | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: nightly | |
| components: llvm-tools-preview | |
| - name: Cache Cargo registry | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Run the external dependencies | |
| run: docker compose up -d | |
| - name: Test | |
| run: cargo test --all-features --no-fail-fast -- --include-ignored | |
| env: | |
| RUSTFLAGS: "-Cinstrument-coverage" | |
| - name: Install grcov | |
| uses: baptiste0928/cargo-install@v3 | |
| with: | |
| crate: grcov | |
| # Remove --locked until this issue is fixed: https://github.com/mozilla/grcov/issues/1187 | |
| locked: false | |
| - name: Run grcov | |
| run: grcov . --binary-path target/debug/deps/ -s . -t lcov --branch --ignore-not-existing --ignore '../**' --ignore '/*' --ignore 'examples/**' -o coverage.lcov | |
| - uses: codecov/codecov-action@v4 | |
| with: | |
| files: ./coverage.lcov | |
| flags: rust | |
| fail_ci_if_error: true | |
| env: | |
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | |
| rustfmt: | |
| if: github.event_name == 'push' || github.event_name == 'schedule' || | |
| github.event.pull_request.head.repo.full_name != github.repository | |
| name: Code formatting checks | |
| runs-on: ubuntu-latest | |
| needs: ["build"] | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: nightly | |
| components: rustfmt | |
| - name: Cache Cargo registry | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Run fmt | |
| run: cargo fmt --all -- --check | |
| machete: | |
| if: github.event_name == 'push' || github.event_name == 'schedule' || | |
| github.event.pull_request.head.repo.full_name != github.repository | |
| name: Machete dependencies checks | |
| runs-on: ubuntu-latest | |
| needs: ["build"] | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: stable | |
| - name: Cache Cargo registry | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Run cargo-machete | |
| uses: bnjbvr/[email protected] | |
| minimal-versions: | |
| if: github.event_name == 'push' || github.event_name == 'schedule' || | |
| github.event.pull_request.head.repo.full_name != github.repository | |
| name: Minimal dependency versions build | |
| runs-on: ubuntu-latest | |
| needs: ["build"] | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: nightly | |
| - name: Install cargo-hack | |
| uses: taiki-e/install-action@cargo-hack | |
| - name: Cache Cargo registry | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Run cargo check with minimal versions | |
| run: | | |
| # Remove dev-dependencies from Cargo.toml to prevent the next `cargo update` | |
| # from determining minimal versions based on dev-dependencies. | |
| cargo hack --remove-dev-deps --workspace | |
| # Update Cargo.lock to minimal version dependencies. | |
| cargo update -Z minimal-versions | |
| cargo hack check --all-features --ignore-private | |
| miri: | |
| if: github.event_name == 'push' || github.event_name == 'schedule' || | |
| github.event.pull_request.head.repo.full_name != github.repository | |
| name: Miri test | |
| runs-on: ubuntu-latest | |
| needs: ["build"] | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: nightly | |
| components: miri | |
| - name: Install cargo-nextest | |
| uses: taiki-e/install-action@v2 | |
| with: | |
| tool: nextest | |
| - name: Cache Cargo registry | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Miri setup | |
| run: cargo miri setup | |
| - name: Miri test | |
| run: cargo miri nextest run -E 'not (test(db) | test(password_hash))' --no-fail-fast --all-features | |
| env: | |
| MIRIFLAGS: -Zmiri-disable-isolation |