3 releases (breaking)

new 0.9.0 Mar 21, 2023
0.8.0 Oct 27, 2022
0.7.0 May 24, 2022

#464 in Testing

Download history 368/week @ 2022-11-28 617/week @ 2022-12-05 500/week @ 2022-12-12 408/week @ 2022-12-19 283/week @ 2022-12-26 303/week @ 2023-01-02 711/week @ 2023-01-09 517/week @ 2023-01-16 715/week @ 2023-01-23 724/week @ 2023-01-30 876/week @ 2023-02-06 469/week @ 2023-02-13 736/week @ 2023-02-20 1065/week @ 2023-02-27 964/week @ 2023-03-06 672/week @ 2023-03-13

3,480 downloads per month
Used in 14 crates (via bolero)

MIT license

17KB
454 lines

bolero

Build Status Latest version Documentation License

fuzz and property testing front-end for Rust

Book

A copy of the Bolero Book can be found here: http://camshaft.github.io/bolero

Quick Start

  1. Install subcommand and add a dependency

    $ cargo add --dev bolero
    $ cargo install -f cargo-bolero
    
  2. Write a test using bolero::check! macro:

    pub fn buggy_add(x: u32, y: u32) -> u32 {
        if x == 12976 && y == 14867 {
            return x.wrapping_sub(y);
        }
        return x.wrapping_add(y);
    }
    
    #[test]
    fn fuzz_add() {
        bolero::check!()
            .with_type()
            .cloned()
            .for_each(|(a, b)| buggy_add(a, b) == a.wrapping_add(b));
    }
    
  3. Run the test with cargo bolero

    $ cargo bolero test fuzz_add
    
    # ... some moments later ...
    
    ======================== Test Failure ========================
    
    Input:
    (
        12976,
        14867,
    )
    
    Error:
    test returned `false`
    
    ==============================================================
    

Linux Installation

cargo-bolero needs a couple of libraries installed to compile. If these libraries aren't available the requirement can be relaxed by executing cargo install cargo-bolero --no-default-features -f

Debian/Ubuntu

$ sudo apt install binutils-dev libunwind-dev

Dependencies

~0–1MB
~22K SLoC