propfuzz 0.0.1

Combine property-based 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
146
147
148
149
150
151
152
153
154
155
156
157
158
159

// Copyright (c) The propfuzz Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0

/// Basic tests for propfuzz-macro.
use pretty_assertions::assert_eq;
use propfuzz::{prelude::*, traits::StructuredTarget};
use proptest::{
    collection::vec,
    test_runner::{FileFailurePersistence, TestError, TestRunner},
};

/// Basic test for foo.
///
/// This is a simple test which ensures that adding two numbers returns the expected result.
#[propfuzz]
fn add_two(a: u64, b: u64) {
    let sum = a.checked_add(b);
    assert_eq!(sum, a.checked_add(b));
}

#[test]
fn propfuzz_add_two() {
    assert_eq!(__PROPFUZZ__add_two.name(), "basic::add_two");
    assert_eq!(
        __PROPFUZZ__add_two
            .description()
            .expect("expected description"),
        "Basic test for foo.\n\
        \n\
        This is a simple test which ensures that adding two numbers returns the expected result."
    );

    let config = __PROPFUZZ__add_two.proptest_config();
    assert_eq!(config.cases, 256, "correct case count");
    assert_eq!(config.fork, false, "correct fork setting");
}

#[propfuzz(fork = true)]
fn add_pair((a, b): (u64, u64)) {
    let sum = a.checked_add(b);
    assert_eq!(sum, a.checked_add(b));
}

#[test]
fn propfuzz_add_pair() {
    assert_eq!(__PROPFUZZ__add_pair.name(), "basic::add_pair");
    assert!(
        __PROPFUZZ__add_pair.description().is_none(),
        "no doc comment"
    );

    let config = __PROPFUZZ__add_pair.proptest_config();
    assert_eq!(config.cases, 256, "correct case count");
    assert_eq!(config.fork, true, "correct fork setting");
}

/// Test that reversing a list twice produces the same results.
#[propfuzz(cases = 1024)]
fn reverse(#[propfuzz(strategy = "vec(any::<u32>(), 0..64)")] mut list: Vec<u32>) {
    let list2 = list.clone();
    list.reverse();
    list.reverse();
    prop_assert_eq!(list, list2);
}

#[test]
fn propfuzz_reverse() {
    assert_eq!(__PROPFUZZ__reverse.name(), "basic::reverse");
    assert_eq!(
        __PROPFUZZ__reverse
            .description()
            .expect("expected description"),
        "Test that reversing a list twice produces the same results."
    );

    let config = __PROPFUZZ__reverse.proptest_config();
    assert_eq!(config.cases, 1024, "correct case count");
    assert_eq!(config.fork, false, "correct fork setting");
}

/// This test fails. It is ignored by default and can be run with `cargo test -- --ignored`.
#[propfuzz(fuzz_default = true)]
#[ignore]
fn failing(#[propfuzz(strategy = "vec(any::<u32>(), 0..64)")] mut list: Vec<u32>) {
    let list2 = list.clone();
    // The list is only reversed once.
    list.reverse();
    prop_assert_eq!(list, list2);
}

#[test]
fn propfuzz_failing() {
    assert_eq!(__PROPFUZZ__failing.name(), "basic::failing");
    assert_eq!(
        __PROPFUZZ__failing
            .description()
            .expect("expected description"),
        "This test fails. It is ignored by default and can be run with `cargo test -- --ignored`."
    );

    let mut config = __PROPFUZZ__failing.proptest_config();
    assert_eq!(config.cases, 256, "correct case count");
    assert_eq!(config.fork, false, "correct fork setting");

    // Try running the test and ensure it fails with the correct value. (Determinism is ensured
    // through checking in basic-failing-seed.)
    config.failure_persistence = Some(Box::new(FileFailurePersistence::Direct(
        "tests/basic-failing-seed",
    )));
    let mut test_runner = TestRunner::new(config);
    let err = __PROPFUZZ__failing
        .execute(&mut test_runner)
        .expect_err("test should fail");
    assert!(
        matches!(err, TestError::Fail(_, value) if &value.0 == &[0, 1]),
        "minimal test case"
    );
}

/// Test multiple #[propfuzz] annotations.
#[propfuzz(cases = 1024)]
#[propfuzz(fork = true)]
fn multi(_: Vec<u8>) {}

#[test]
fn propfuzz_multi() {
    assert_eq!(__PROPFUZZ__multi.name(), "basic::multi");
    assert_eq!(
        __PROPFUZZ__multi
            .description()
            .expect("expected description"),
        "Test multiple #[propfuzz] annotations."
    );

    let config = __PROPFUZZ__multi.proptest_config();
    assert_eq!(config.cases, 1024, "correct case count");
    assert_eq!(config.fork, true, "correct fork setting");
}

/// Test all proptest options.
#[propfuzz(cases = 1, max_local_rejects = 2, max_global_rejects = 3)]
#[propfuzz(max_flat_map_regens = 4, fork = true, timeout = 5, max_shrink_time = 6)]
#[propfuzz(max_shrink_iters = 7, verbose = 8)]
#[ignore]
fn all_proptest_options(_: u8) {}

#[test]
fn propfuzz_all_proptest_options() {
    let config = __PROPFUZZ__all_proptest_options.proptest_config();
    assert_eq!(config.cases, 1);
    assert_eq!(config.max_local_rejects, 2);
    assert_eq!(config.max_global_rejects, 3);
    assert_eq!(config.max_flat_map_regens, 4);
    assert_eq!(config.fork, true);
    assert_eq!(config.timeout, 5);
    assert_eq!(config.max_shrink_time, 6);
    assert_eq!(config.max_shrink_iters, 7);
    assert_eq!(config.verbose, 8);
}