| commit | 6c8d2e91cee5a97265993c9351a6691249cd3789 | [log] [tgz] |
|---|---|---|
| author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Wed Oct 06 03:04:33 2021 +0000 |
| committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Wed Oct 06 03:04:33 2021 +0000 |
| tree | 7232be51c9c5eeb220a396170f6ec1dfb5dbd3f8 | |
| parent | be09447d05682f7f5b9b1e917d4e8f8958b270ee [diff] | |
| parent | 46b261073c125b8f94e3ee81fe08f90d5c560573 [diff] |
Snap for 7796944 from 46b261073c125b8f94e3ee81fe08f90d5c560573 to tm-release Change-Id: Ic9180e9fec3a5e7a23be7d8bd0cbd5a90cd85852
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.