faux  

一个用于从结构体创建 mocks 的库。

faux 允许您模拟结构体的方法进行测试，而不会使您的代码变得复杂或污染。

有关更多信息，请参阅 API 文档。

入门

faux 充分利用了 unsafe Rust 功能，因此仅建议在测试中使用。为了防止 faux 溢出到您的生产代码中，在您的 Cargo.toml 中将其设置为 dev-dependency

[dev-dependencies]
faux = "^0.1"

faux 提供了两个属性

• #[create]: 将结构体转换为可模拟的等效形式
• #[methods]: 将 impl 块中的方法转换为它们的可模拟等效形式

使用 Rust 的 #[cfg_attr(...)] 将这些属性限制在测试配置中。

#[cfg_attr(test, faux::create)]
pub struct MyStructToMock { /* fields */ }

#[cfg_attr(test, faux::methods)]
impl MyStructToMock { /* methods to mock */ }

示例

mod client {
    // #[faux::create] makes a struct mockable and
    // generates an associated `faux` function
    // e.g., `UserClient::faux()` will create a a mock `UserClient` instance
    #[faux::create]
    pub struct UserClient { /* data of the client */ }

    #[derive(Clone)]
    pub struct User {
        pub name: String
    }

    // #[faux::methods] makes every public method in the `impl` block mockable
    #[faux::methods]
    impl UserClient {
        pub fn fetch(&self, id: usize) -> User {
            // does some network calls that we rather not do in tests
            User { name: "".into() }
        }
    }
}

use crate::client::UserClient;

pub struct Service {
    client: UserClient,
}

#[derive(Debug, PartialEq)]
pub struct UserData {
    pub id: usize,
    pub name: String,
}

impl Service {
    fn user_data(&self) -> UserData {
        let id = 3;
        let user = self.client.fetch(id);
        UserData { id, name: user.name }
    }
}

// A sample #[test] for Service that mocks the client::UserClient
fn main() {
    // create a mock of client::UserClient using `faux`
    let mut client = client::UserClient::faux();

    // mock fetch but only if the argument is 3
    // argument matchers are optional
    faux::when!(client.fetch(3))
        // stub the return value for this mock
        .then_return(client::User { name: "my user name".into() });

    // prepare the subject for your test using the mocked client
    let subject = Service { client };

    // assert that your subject returns the expected data
    let expected = UserData { id: 3, name: String::from("my user name") };
    assert_eq!(subject.user_data(), expected);
}

由于 rustdocs 的限制，上面的示例测试是在 main() 中进行的，而不是一个 #[test] 函数。在实际应用中，伪造属性应该被限制在 #[cfg(test)]。

功能

faux 允许您模拟异步方法、特质方法、泛型结构体方法以及指针自我类型（例如，self: Rc<Self>）的返回值或实现。

• 异步方法
• 特质方法
• 泛型结构体方法
• 具有指针自我类型的（例如，self: Rc<Self>）的方法
• 外部模块中的方法（但不包括外部包）。

faux 还提供了易于使用的参数匹配器。

与 #[derive(...)] 和自动特质交互。

#[faux::create]
struct Foo { /*some items here */ }

#[faux::methods]
#[another_attribute]
impl Foo {
    /* some methods here */
}

async fn run(&self, arg: Arg) -> Out {
    /* stuff inside */
}

fn run<'async>(&'async self, arg: Arg) -> Pin<Box<dyn std::future::Future<Output = Out> + Send + 'async>> {
    /* crazier stuff inside */
}

#[faux::methods]
#[async_trait]
impl MyStruct for MyTrait {
    async fn run(&self, arg: Arg) -> Out {
        /* stuff inside */
    }
}