| commit | 7af64a7d777abefb1ec24cf2c27750488c13f25b | [log] [tgz] |
|---|---|---|
| author | Android Build Coastguard Worker <[email protected]> | Mon May 09 06:19:39 2022 +0000 |
| committer | Android Build Coastguard Worker <[email protected]> | Mon May 09 06:19:39 2022 +0000 |
| tree | 252a378bfaad1976f5f9ecf366574d7e62e75985 | |
| parent | cd8af3e64e6dea5a50044b692c2230e537a5e2a8 [diff] | |
| parent | 5187f941e4737e1d721ac600acefe66a8f4d1a46 [diff] |
Snap for 8558685 from 5187f941e4737e1d721ac600acefe66a8f4d1a46 to tm-frc-networking-release Change-Id: I9c5d7c35f4430845b8bd879543baa6fb51544335
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, }
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.