7 releases (4 breaking)

new 0.11.2 Jun 10, 2024
0.11.1 Jun 8, 2024
0.10.0 Sep 28, 2023
0.9.0 Mar 21, 2023
0.7.0 May 24, 2022

#668 in Testing

Download history 938/week @ 2024-02-14 1266/week @ 2024-02-21 810/week @ 2024-02-28 815/week @ 2024-03-06 850/week @ 2024-03-13 1145/week @ 2024-03-20 808/week @ 2024-03-27 805/week @ 2024-04-03 704/week @ 2024-04-10 835/week @ 2024-04-17 638/week @ 2024-04-24 1121/week @ 2024-05-01 1243/week @ 2024-05-08 1729/week @ 2024-05-15 3634/week @ 2024-05-22 4410/week @ 2024-05-29

11,332 downloads per month
Used in 23 crates (via bolero)

MIT license

21KB
469 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–1.1MB
~22K SLoC