proptest-macro 0.5.0

Procedural macros for the proptest crate
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

use proc_macro2::TokenStream;
use quote::{quote, ToTokens};
use syn::{parse2, Block, Expr, Ident, Pat, ReturnType, Type, TypeTuple};

use crate::property_test::{options::Options, utils::Argument};

use super::{nth_field_name, struct_name};

/// Generate the new test body by putting the struct and arbitrary impl at the start, then adding
/// the usual glue that `proptest!` adds
pub(super) fn body(
    block: Block,
    args: &[Argument],
    struct_and_impl: TokenStream,
    fn_name: &Ident,
    ret_ty: &ReturnType,
    options: &Options,
) -> Block {
    let struct_name = struct_name(fn_name);

    let errors = &options.errors;

    // convert each arg to `field0: x`
    let struct_fields = args.iter().enumerate().map(|(index, arg)| {
        let pat = arg.pat_ty.pat.as_ref();
        let field_name = nth_field_name(args, index);

        // If the pattern is an ident, we know that the field name is equal to the pattern name.
        // This means we need to avoid generating: `x: x`, which would trigger a lint suggesting
        // shorthand struct initialization.

        match pat {
            // We need to make sure to handle any mutability modifiers here, i.e. if the user wrote
            // `mut x: i32`, we have to generate `mut x`, not `x: mut x`
            //
            // See https://github.com/proptest-rs/proptest/issues/601
            Pat::Ident(i) => match i.mutability {
                Some(mutability) => quote!(#mutability #field_name,),
                None => quote!(#field_name,),
            },
            _ => quote!(#field_name: #pat,),
        }
    });

    // e.g. FooArgs { field0: x, field1: (y, z), }
    let struct_pattern = quote! {
        #struct_name { #(#struct_fields)* }
    };

    let handle_result = handle_result(ret_ty);

    let config = make_config(options.config.as_ref(), fn_name);

    let tokens = quote! ( {

        #(#errors)*

        #struct_and_impl

        #config

        let mut runner = ::proptest::test_runner::TestRunner::new(config);
        
        let result = runner.run(
            &::proptest::strategy::Strategy::prop_map(::proptest::prelude::any::<#struct_name>(), |values| {
                ::proptest::sugar::NamedArguments(stringify!(#struct_name), values)
            }),
            |::proptest::sugar::NamedArguments(_, #struct_pattern)| {
                let result = #block;
                #handle_result
            },
        );

        match result {
            Ok(()) => {}
            Err(e) => panic!("{}", e),
        }
    } );

    // unwrap here is fine because the double braces create a block
    // std::fs::write("/tmp/pt-debug", tokens.to_string());
    parse2(tokens).unwrap()
}

/// rough heuristic for whether we should use result-style syntax - if the function returns either
/// nothing (i.e. `()`) or an empty tuple, it will be non-result handling, otherwise it uses
/// result-style handling
///
/// Note, this won't catch cases like `type Foo = ();`, since type information isn't available yet,
/// it's just looking for the syntax `fn foo() {}` or `fn foo() -> () {}`
fn handle_result(ret_ty: &ReturnType) -> TokenStream {
    let default_body = || quote! { Ok(result) };
    let result_body = || quote! { result };

    match ret_ty {
        ReturnType::Default => default_body(),
        ReturnType::Type(_, ty) => match ty.as_ref() {
            Type::Tuple(TypeTuple { elems, .. }) if elems.is_empty() => {
                default_body()
            }
            _ => result_body(),
        },
    }
}

fn make_config(config: Option<&Expr>, fn_name: &Ident) -> TokenStream {
    let trailing = match config {
        None => quote! { ::proptest::test_runner::Config::default() },
        Some(config) => config.to_token_stream(),
    };

    quote! {
        let config = ::proptest::test_runner::Config {
            test_name: Some(concat!(module_path!(), "::", stringify!(#fn_name))),
            source_file: Some(file!()),
            ..#trailing
        };
    }
}