| commit | 0633e81f7d7074b549eca0c85fd18e75f90452d4 | [log] [tgz] |
|---|---|---|
| author | James Farrell <[email protected]> | Tue Oct 08 21:25:25 2024 +0000 |
| committer | James Farrell <[email protected]> | Tue Oct 08 21:25:25 2024 +0000 |
| tree | 25f45f2d2a8988000c1dda122b5196a272b453d1 | |
| parent | a3c4858767d6d30cf61420c6a78d35036e28d3ec [diff] |
Migrate 25 crates to monorepo itoa percent-encoding untrusted arbitrary nix arc-swap arrayvec axum-core bindgen-cli cov-mark equivalent fixedbitset foreign-types foreign-types-shared fxhash http hyper kernlog lazycell libtest-mimic libz-sys merge merge_derive mls-rs mls-rs-crypto-traits Bug: http://b/339424309 Test: treehugger Change-Id: I0459c62c938add0dfd0abbb1fd38051c4258090a
The Arbitrary crate lets you construct arbitrary instances of a type.
This crate is primarily intended to be combined with a fuzzer like libFuzzer and cargo-fuzz or AFL, and to help you turn the raw, untyped byte buffers that they produce into well-typed, valid, structured values. This allows you to combine structure-aware test case generation with coverage-guided, mutation-based fuzzers.
Read the API documentation on docs.rs!
Say you're writing a color conversion library, and you have an Rgb struct to represent RGB colors. You might want to implement Arbitrary for Rgb so that you could take arbitrary Rgb instances in a test function that asserts some property (for example, asserting that RGB converted to HSL and converted back to RGB always ends up exactly where we started).
ArbitraryAutomatically deriving the Arbitrary trait is the recommended way to implement Arbitrary for your types.
Automatically deriving Arbitrary requires you to enable the "derive" cargo feature:
# Cargo.toml [dependencies] arbitrary = { version = "1", features = ["derive"] }
And then you can simply add #[derive(Arbitrary)] annotations to your types:
// rgb.rs use arbitrary::Arbitrary; #[derive(Arbitrary)] pub struct Rgb { pub r: u8, pub g: u8, pub b: u8, }
This can be particular handy if your structure uses a type that does not implement Arbitrary or you want to have more customization for particular fields.
#[derive(Arbitrary)] pub struct Rgba { // set `r` to Default::default() #[arbitrary(default)] pub r: u8, // set `g` to 255 #[arbitrary(value = 255)] pub g: u8, // Generate `b` with a custom function of type // // fn(&mut Unstructured) -> arbitrary::Result<T> // // where `T` is the field's type. #[arbitrary(with = arbitrary_b)] pub b: u8, // Generate `a` with a custom closure (shortuct to avoid a custom funciton) #[arbitrary(with = |u: &mut Unstructured| u.int_in_range(0..=64))] pub a: u8, } fn arbitrary_b(u: &mut Unstructured) -> arbitrary::Result<u8> { u.int_in_range(64..=128) }
Arbitrary By HandAlternatively, you can write an Arbitrary implementation by hand:
// rgb.rs use arbitrary::{Arbitrary, Result, Unstructured}; #[derive(Copy, Clone, Debug)] pub struct Rgb { pub r: u8, pub g: u8, pub b: u8, } impl<'a> Arbitrary<'a> for Rgb { fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self> { let r = u8::arbitrary(u)?; let g = u8::arbitrary(u)?; let b = u8::arbitrary(u)?; Ok(Rgb { r, g, b }) } }
Licensed under dual MIT or Apache-2.0 at your choice.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.