12 releases (breaking)

0.10.0 Sep 28, 2023
0.9.0 Mar 21, 2023
0.8.0 Oct 27, 2022
0.7.0 May 24, 2022
0.2.0 Oct 16, 2019

#424 in Testing

Download history 1399/week @ 2023-10-28 1290/week @ 2023-11-04 971/week @ 2023-11-11 613/week @ 2023-11-18 1031/week @ 2023-11-25 879/week @ 2023-12-02 1214/week @ 2023-12-09 811/week @ 2023-12-16 588/week @ 2023-12-23 735/week @ 2023-12-30 1098/week @ 2024-01-06 861/week @ 2024-01-13 999/week @ 2024-01-20 1117/week @ 2024-01-27 920/week @ 2024-02-03 789/week @ 2024-02-10

3,932 downloads per month
Used in 20 crates (via bolero)

MIT license

375KB
9K SLoC

C++ 8K SLoC // 0.1% comments Rust 512 SLoC // 0.0% comments Python 63 SLoC // 0.2% comments C 25 SLoC // 0.4% comments Shell 18 SLoC // 0.1% comments

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.2MB
~25K SLoC