Enum FuzzCommand

enum FuzzCommand {
    Init {
        package: String,
        template: Template,
    },
    List {
        crates: bool,
    },
    Verify,
    Build {
        targets: Vec<String>,
        toolchain: Option<String>,
        extra: Vec<String>,
    },
    Run {
        target: String,
        artifact: Option<PathBuf>,
        toolchain: Option<String>,
        extra: Vec<String>,
    },
    Clean {
        targets: Vec<String>,
        keep_corpus: bool,
        keep_artifacts: bool,
        keep_coverage: bool,
    },
    Fmt {
        target: String,
        input: PathBuf,
        toolchain: Option<String>,
        extra: Vec<String>,
    },
    Cmin {
        target: String,
        toolchain: Option<String>,
        extra: Vec<String>,
    },
    Tmin {
        target: String,
        test_case: PathBuf,
        toolchain: Option<String>,
        extra: Vec<String>,
    },
    Coverage {
        target: String,
        with_html_report: bool,
        only_report: bool,
        toolchain: Option<String>,
        extra: Vec<String>,
    },
    Onefuzz {
        config_path: PathBuf,
        out_dir: PathBuf,
        target: Vec<String>,
        toolchain: Option<String>,
    },
    Dump,
}

Variants

Init

Onboard a new fuzz target corresponding to a particular crate

Fields

package: String

Crate name to spin up fuzzing infrastructure for

template: Template

Fuzzer template to init with

List

List all available fuzz targets in the repo

Fields

crates: bool

List all available fuzz crates in the repo.

A fuzz crate can contain multiple fuzz targets.

This option is mainly useful when running in CI, as it can be used to generate an “exclude list” of fuzz crates, which we skip building on platforms that libfuzzer-sys doesn’t support (notably: musl).

Verify

Verify the Cargo.toml and directory structures of in-tree fuzzing crates.

Build

Build fuzz targets.

Fields

targets: Vec<String>

Fuzzing targets to build. If not specified, builds all available targets.

toolchain: Option<String>

The Rust toolchain to use. Defaults to the environment’s default toolchain.

extra: Vec<String>

Extra args to forward to each cargo fuzz build invocation.

Run

Run fuzz targets.

Fields

target: String

Fuzzing target to run.

artifact: Option<PathBuf>

Path to specific repro case

toolchain: Option<String>

The Rust toolchain to use. Defaults to the environment’s default toolchain.

extra: Vec<String>

Extra args to forward to cargo fuzz run.

Clean

Clean local fuzzing artifacts/corpus/coverage

Fields

targets: Vec<String>

Fuzzing targets to clean. If not specified, cleans all available targets.

keep_corpus: bool

Don’t delete corpus directories

keep_artifacts: bool

Don’t delete artifact directories

keep_coverage: bool

Don’t delete coverage directories

Fmt

Print the std::fmt::Debug output for an input.

Fields

target: String

Fuzzing target the input corresponds to.

input: PathBuf

Path to input file.

toolchain: Option<String>

The Rust toolchain to use. Defaults to the environment’s default toolchain.

extra: Vec<String>

Extra args to forward to cargo fuzz fmt.

Cmin

Minify a corpus.

Fields

target: String

Fuzzing target to minify the corpus of.

toolchain: Option<String>

The Rust toolchain to use. Defaults to the environment’s default toolchain.

extra: Vec<String>

Extra args to forward to cargo fuzz cmin.

Tmin

Minify a test case.

Fields

target: String

Fuzzing target the test case corresponds to.

test_case: PathBuf

Path to test case file.

toolchain: Option<String>

The Rust toolchain to use. Defaults to the environment’s default toolchain.

extra: Vec<String>

Extra args to forward to cargo fuzz tmin.

Coverage

Run program on the generated corpus and generate coverage information.

Fields

target: String

Fuzzing target the corpus corresponds to.

with_html_report: bool

Also generate an HTML coverage report using lcov and genhtml.

only_report: bool

Skip rebuilding + collecting new coverage data.

toolchain: Option<String>

The Rust toolchain to use. Defaults to the environment’s default toolchain.

extra: Vec<String>

Extra args to forward to cargo fuzz coverage.

Onefuzz

Build fuzzers and construct a Onefuzz-ready drop folder.

Fields

config_path: PathBuf

Path to the OneFuzz configuration file.

out_dir: PathBuf

Output directory to emit files to.

target: Vec<String>

Specific targets to include. If left blank, includes all available targets.

toolchain: Option<String>

The Rust toolchain to use. Defaults to the environment’s default toolchain.

Dump

(debug) Dump raw debug info about all available fuzz targets

Trait Implementations

impl FromArgMatches for FuzzCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for FuzzCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand