simulacrum_mock 0.1.0

Core functionality for 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

pub mod result;
pub mod stock;

pub use self::result::*;

/// A `Constraint` is a type that can be added to an `Expectation`.
///
/// All `Constraint`s added to an `Expectation` must all pass in order for the
/// `Expectation` to pass.
pub trait Constraint<I> {
    /// This constraint has been called with the given parameters. Update the
    ///
    /// Constraint state so that when `verify()` is called, it will return the
    /// correct result.
    #[allow(unused_variables)]
    fn handle_call(&mut self, params: &I) { }

    /// At the end of the test, see if the Constraint passed or failed.
    fn verify(&self) -> ConstraintResult;
}

// lol, it would be handy to have simulacrum here
pub struct ConstraintMock {
    handle_call_expected: bool,
    handle_call_called: bool
}

impl ConstraintMock {
    pub fn new() -> Self {
        Self {
            handle_call_expected: false,
            handle_call_called: false
        }
    }

    pub fn expect_handle_call(&mut self) {
        self.handle_call_expected = true
    }
}

impl<I> Constraint<I> for ConstraintMock {
    fn handle_call(&mut self, _params: &I) {
        self.handle_call_called = true
    }

    fn verify(&self) -> ConstraintResult {
        Ok(())
    }
}

impl Drop for ConstraintMock {
    /// All expectations will be verified when the mock object is dropped.
    fn drop(&mut self) {
        if self.handle_call_expected && !self.handle_call_called {
            panic!("handle_call was not called");
        }
    }
}