13 releases (breaking)

new 0.11.0 Jun 8, 2024
0.10.0 Sep 28, 2023
0.9.0 Mar 20, 2023
0.8.0 Oct 27, 2022
0.2.0 Oct 16, 2019

#743 in Testing

Download history 821/week @ 2024-02-14 1271/week @ 2024-02-21 687/week @ 2024-02-28 555/week @ 2024-03-06 657/week @ 2024-03-13 853/week @ 2024-03-20 686/week @ 2024-03-27 621/week @ 2024-04-03 627/week @ 2024-04-10 668/week @ 2024-04-17 559/week @ 2024-04-24 874/week @ 2024-05-01 1101/week @ 2024-05-08 1619/week @ 2024-05-15 3496/week @ 2024-05-22 4169/week @ 2024-05-29

10,632 downloads per month
Used in 26 crates (2 directly)

MIT license

340KB
7K SLoC

C 6.5K SLoC // 0.2% comments Rust 440 SLoC // 0.0% comments Shell 32 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.3MB
~26K SLoC