simulacrum_macros 0.2.1

Macros to simplify creating mock objects with Simulacrum.
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

// This is the highest-level macro in Simulacrum.
//
// It creates a Mock struct and impls a Trait - all you have to do is copy over
// the trait interface and annotate it.
//
// Note that if you want additional control, like not mocking certain parameters,
// you should use the mid-level macros shown in the `mid_level.rs` example. For
// even more control, you can use the `simulacrum` crate directly.

extern crate simulacrum_macros;

use simulacrum_macros::*;

trait CoolTrait {
    // Shared self
    fn foo(&self);

    // Mutable self
    fn bar(&mut self);

    // One parameter and returning a value
    fn goop(&mut self, flag: bool) -> u32;

    // Multiple parameters
    fn zing(&self, first: i32, second: bool);

    // Static reference
    fn boop(&self, name: &'static str);

    // Shared reference
    fn store(&self, val: &i64);

    // Mutable reference
    fn toggle(&self, bit: &mut bool);

    // Unsafe
    unsafe fn ohno(&self);
}

create_mock! {
    impl CoolTrait for CoolTraitMock (self) {
        expect_foo("foo"):
        fn foo(&self);

        expect_bar("bar"):
        fn bar(&mut self);

        expect_goop("goop"):
        fn goop(&mut self, flag: bool) -> u32;

        expect_zing("zing"):
        fn zing(&self, first: i32, second: bool);

        // &'static params are a special case - other lifetimes can't be mocked.
        expect_boop("boop"):
        fn boop(&self, name: &'static str);

        // & params are mocked as *const and &mut are mocked as *mut.
        expect_store("store"):
        fn store(&self, val: &i64);

        expect_toggle("toggle"): 
        fn toggle(&self, bit: &mut bool);

        expect_ohno("ohno"):
        unsafe fn ohno(&self);
    }
}

fn main() {
    // Set up expectations
    let mut m = CoolTraitMock::new();
    m.expect_bar().called_never();
    m.expect_foo().called_once();
    m.then().expect_goop().called_once().with(true).returning(|_| 5);
    m.then().expect_zing().called_once().with(params!(13, false));
    m.expect_boop().called_times(2);
    m.expect_store().called_once().with(deref(777));
    m.expect_toggle().called_once().with(deref(true))
                                   .modifying(|&mut arg| { unsafe { *arg = false } });
    m.expect_ohno().called_once();

    // Execute test code
    m.foo();
    assert_eq!(m.goop(true), 5);
    m.zing(13, false);
    m.boop("hey");
    m.boop("yo");
    m.store(&777);
    let mut b = true;
    m.toggle(&mut b);
    assert_eq!(b, false);
    unsafe {
        m.ohno();
    }

    // When the Expectations struct is dropped, each of its expectations will be evaluated
}