faux −

一个从结构体创建模拟的库。

faux 允许你在测试时模拟结构体的方法，而不使你的代码变得复杂或混乱。

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

入门

faux 充分利用了不安全的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 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>）
• 外部模块中的方法（但不是外部包）。

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

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

faux 模拟将自动实现 Send 和 Sync，如果真实实例也实现了它们。使用 #[derive(...)] 为 Clone、Debug 和 Default 也会按预期工作。其他可派生的特质不受支持，因为它们关于数据（例如，Eq 或 Hash），而 faux 是关于模拟行为而不是数据。不支持从非标准库中派生特质。解决这个问题的一个方法是手动编写该特质的 impl。如果您相信有可派生的特质 faux 应该支持，请提交一个说明您用例的问题。

Clone是一个有点特殊的情况，因为它不复制存根而是与克隆实例共享它们。如果这不是克隆模拟所期望的行为，则可以手动实现Clone并执行正常的方法存根（faux::when!(my_struct.clone()).then_return(/* something */)）。请注意，对于耗尽存根的情况（例如，faux::when!(my_struct.foo()).once()），如果任一实例调用存根，那么由于它们是共享的，这将计为耗尽存根。

#[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 */
    }
}