17 releases (9 breaking)

0.10.1 Mar 4, 2024
0.10.0 Sep 28, 2023
0.9.0 Mar 21, 2023
0.8.0 Oct 27, 2022
0.2.0 Oct 16, 2019

#34 in Testing

Download history 2213/week @ 2023-12-07 1535/week @ 2023-12-14 616/week @ 2023-12-21 719/week @ 2023-12-28 1293/week @ 2024-01-04 1826/week @ 2024-01-11 1344/week @ 2024-01-18 1229/week @ 2024-01-25 2003/week @ 2024-02-01 1695/week @ 2024-02-08 2178/week @ 2024-02-15 1623/week @ 2024-02-22 1673/week @ 2024-02-29 1558/week @ 2024-03-07 1163/week @ 2024-03-14 2451/week @ 2024-03-21

7,001 downloads per month
Used in 24 crates (23 directly)

MIT license

540KB
13K SLoC

C 5.5K SLoC // 0.1% comments Rust 5.5K SLoC // 0.0% comments C++ 2K SLoC // 0.1% comments Shell 86 SLoC // 0.2% comments Python 15 SLoC // 0.2% 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

~7.5MB
~148K SLoC