Skip to content

Have ci check #[cfg(fuzzing)] code for errors #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Techcable wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Have ci check #[cfg(fuzzing)] code for errors #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,22 @@ jobs:
# 3-OS clippy matrix; this runs on Linux for the feature dimension only.
- run: cargo hack --feature-powerset --depth 2 check --all-targets


fuzz-check:
name: fuzz harness (cfg check)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
# Checks the `#[cfg(fuzzing)]` code without actually running cargo-fuzz.
# Ordinary cargo check/clippy/test never set that cfg,
# so type errors would go unnoticed until fuzz.yml
# runs its daily schedule.
- run: cargo check --all-features --lib
env:
RUSTFLAGS: --cfg fuzzing

test:
name: test (${{ matrix.os }})
runs-on: ${{ matrix.os }}
Expand Down
13 changes: 10 additions & 3 deletions justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@
# `just --list` shows all recipes.

# Fast everyday gate: fmt, clippy (all features), tests (all features,
# including the real-subprocess/`--include-ignored` ones). Not a full CI
# mirror — use `just ci` before opening a PR for that.
# including the real-subprocess/`--include-ignored` ones), and the
# `#[cfg(fuzzing)]` type-check. Not a full CI mirror — use `just ci` before
# opening a PR for that.
check:
cargo fmt --all --check
cargo clippy --all-targets --all-features -- -D warnings
cargo test --all-features -- --include-ignored
just fuzz-check

# Full local mirror of the CI workflow's stable-toolchain jobs: fmt, clippy in
# the three feature configurations the CI matrix checks, the feature-powerset
Expand All @@ -22,7 +24,7 @@ check:
# services/tokens (coverage/coveralls, cargo-deny, public-api diff,
# semver-checks) — see the optional recipes below for the ones that can still
# run locally.
ci: fmt-check clippy-all hack test-all doc-all typos
ci: fmt-check clippy-all hack test-all doc-all typos fuzz-check

# Mirrors the CI `fmt` job.
fmt-check:
Expand Down Expand Up @@ -109,6 +111,11 @@ test-musl:
cargo test -- --include-ignored && \
cargo test --no-default-features -- --include-ignored'

# Mirrors the fuzz-check CI job. Type-checks the `#[cfg(fuzzing)]` code
# without actually running `cargo-fuzz` or requiring a nightly toolchain.
fuzz-check:
RUSTFLAGS="--cfg fuzzing" cargo check --all-features --lib

# Mirrors the CI `typos` job. Requires the `typos` CLI
# (`cargo install typos-cli`). Config/allow-list is `_typos.toml`.
typos:
Expand Down