bolero-generator 0.13.5

value generator for testing and fuzzing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use crate::TypeGenerator;
use core::ops::{Bound, RangeBounds};

pub struct Driver {
    pub(crate) depth: usize,
    pub(crate) max_depth: usize,
}

impl Default for Driver {
    #[inline]
    fn default() -> Self {
        Self::new(&crate::driver::Options::default())
    }
}

impl Driver {
    #[inline]
    pub fn new(options: &crate::driver::Options) -> Self {
        Self {
            depth: 0,
            max_depth: options.max_depth_or_default(),
        }
    }
}

macro_rules! produce {
    ($name:ident, $ty:ident) => {
        #[inline(always)]
        fn $name(&mut self, min: Bound<&$ty>, max: Bound<&$ty>) -> Option<$ty> {
            let value: $ty = shim::any();
            shim::assume((min, max).contains(&value));
            Some(value)
        }
    };
}

impl crate::Driver for Driver {
    produce!(gen_u8, u8);

    produce!(gen_i8, i8);

    produce!(gen_u16, u16);

    produce!(gen_i16, i16);

    produce!(gen_u32, u32);

    produce!(gen_i32, i32);

    produce!(gen_u64, u64);

    produce!(gen_i64, i64);

    produce!(gen_u128, u128);

    produce!(gen_i128, i128);

    produce!(gen_usize, usize);

    produce!(gen_isize, isize);

    produce!(gen_f32, f32);

    produce!(gen_f64, f64);

    #[inline(always)]
    fn produce<T: TypeGenerator>(&mut self) -> Option<T> {
        let value = T::generate(self);
        shim::assume(value.is_some());
        value
    }

    #[inline(always)]
    fn gen_char(&mut self, min: Bound<&char>, max: Bound<&char>) -> Option<char> {
        let value = shim::any();
        shim::assume((min, max).contains(&value));
        Some(value)
    }

    #[inline(always)]
    fn gen_bool(&mut self, _probability: Option<f32>) -> Option<bool> {
        Some(shim::any())
    }

    #[inline(always)]
    fn gen_from_bytes<Hint, Gen, T>(&mut self, _hint: Hint, mut produce: Gen) -> Option<T>
    where
        Hint: FnOnce() -> (usize, Option<usize>),
        Gen: FnMut(&[u8]) -> Option<(usize, T)>,
    {
        // TODO make this configurable
        const MAX_LEN: usize = 256;

        let bytes = shim::any::<[u8; MAX_LEN]>();
        let len = shim::any::<usize>();
        shim::assume(len <= MAX_LEN);

        let value = produce(&bytes[..len]).map(|v| v.1);
        shim::assume(value.is_some());
        value
    }

    #[inline(always)]
    fn gen_variant(&mut self, variants: usize, base_case: usize) -> Option<usize> {
        if self.depth == self.max_depth {
            return Some(base_case);
        }

        let selected: usize = shim::any();
        shim::assume(selected < variants);
        Some(selected)
    }

    #[inline(always)]
    fn depth(&self) -> usize {
        self.depth
    }

    #[inline(always)]
    fn set_depth(&mut self, depth: usize) {
        self.depth = depth;
    }

    #[inline(always)]
    fn max_depth(&self) -> usize {
        self.max_depth
    }
}

/// Make a shim for when kani isn't available
#[cfg(not(kani))]
#[allow(dead_code)]
mod shim {
    pub fn any<T>() -> T {
        todo!()
    }

    pub fn assume(cond: bool) {
        // no-op
        let _ = cond;
    }
}

#[cfg(kani)]
use ::kani as shim;