yapp 0.5.0

Yet Another Password Prompt
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

/// An example of how to mock the `PasswordReader` trait in user code.
///
/// This example demonstrates how to use the `mockall` library to create a mock implementation of
/// the `PasswordReader` trait. The mock implementation can be used to test the `_your_func`
/// function without requiring a real `PasswordReader` implementation.
///
/// The `_your_func` function takes a `PasswordReader` implementation and reads a password from it.
/// The function then returns a string that includes the password, but in real code the password
/// would probably be used for some other purpose.
///
/// The `tests` module includes a test that replaces the `PasswordReader` implementation with a
/// mock implementation. The test uses the `mockall` library to create a mock implementation of
/// the `PasswordReader` trait. The test then uses the mock implementation to test the `_your_func`
/// function.
use std::io;
use yapp::PasswordReader;

fn _your_func(yapp: &mut impl PasswordReader) -> io::Result<String> {
    let password = yapp.read_password()?;
    Ok(format!("Sending \"{password}\" to ether"))
}

fn _your_func_dyn(yapp: &mut dyn PasswordReader) -> io::Result<String> {
    let password = yapp.read_password()?;
    Ok(format!("Sending \"{password}\" to ether"))
}

#[cfg(test)]
mod tests {
    use super::*;
    use mockall::mock;
    use std::io;
    use yapp::PasswordReader;

    mock! {
        Yacc {}
        impl PasswordReader for Yacc {
            fn read_password(&mut self) -> io::Result<String>;
            fn read_password_with_prompt(&mut self, prompt: &str) -> io::Result<String>;
        }
    }

    #[test]
    fn replace_yacc_with_mock() {
        let mut yacc_mock = MockYacc::new();
        yacc_mock
            .expect_read_password()
            .return_once(|| Ok(String::from("P455w0rd!")));

        let result = _your_func(&mut yacc_mock);

        assert!(result.is_ok());
        assert_eq!("Sending \"P455w0rd!\" to ether", result.unwrap())
    }

    #[test]
    fn replace_yacc_with_dyn_mock() {
        let mut yacc_mock = MockYacc::new();
        yacc_mock
            .expect_read_password()
            .return_once(|| Ok(String::from("P455w0rd!")));

        let result = _your_func_dyn(&mut yacc_mock);

        assert!(result.is_ok());
        assert_eq!("Sending \"P455w0rd!\" to ether", result.unwrap())
    }
}