14 releases (breaking)

0.12.0 Nov 27, 2024
0.11.0 Jun 8, 2024
0.10.0 Sep 28, 2023
0.9.0 Mar 21, 2023
0.2.0 Oct 16, 2019

#898 in Testing

Download history 5130/week @ 2024-08-16 4828/week @ 2024-08-23 3858/week @ 2024-08-30 4931/week @ 2024-09-06 4300/week @ 2024-09-13 3234/week @ 2024-09-20 3797/week @ 2024-09-27 1913/week @ 2024-10-04 2453/week @ 2024-10-11 2353/week @ 2024-10-18 3708/week @ 2024-10-25 4541/week @ 2024-11-01 3920/week @ 2024-11-08 2769/week @ 2024-11-15 4235/week @ 2024-11-22 4687/week @ 2024-11-29

16,440 downloads per month
Used in 27 crates (via bolero)

MIT license

380KB
9K SLoC

C++ 8K SLoC // 0.1% comments Rust 570 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–5.5MB
~30K SLoC