unit-testing - 如何将特征对象的 stub 注入(inject) Rust 中的类型并保留对它的引用？

Question

我正在尝试用 Rust 开发某种时间跟踪 CLI 工具。我尝试用单元测试覆盖大部分代码，但在如何使用具有 Rusts 所有权限制的 stub 对象方面遇到了困难。

我有一个 Tracker 类型，它具有开始/停止跟踪时间的功能。这些函数查询当前系统时间。

为了使这个设计可测试，我引入了特性 TimeService 来提供当前时间戳。我有返回当前系统时间的“真实”实现 SystemTimeService 和用于可以从外部设置时间的测试的假实现 FakeTimeService。

这是当前的实现:

pub struct Tracker {
    // ...
    time_service: Box<TimeService>,
}

trait TimeService {
    fn time(&self) -> u64;
}

这是我要实现的测试:

#[test]
fn tracker_end_when_called_tracks_total_time() {
    let (tracker, time_service) = init_tracker();

    time_service.set_seconds(0);
    tracker.start("feature1");
    time_service.set_seconds(10);
    tracker.end();

    assert_eq!(tracker.total_time, 10);
}

fn init_tracker() -> (Tracker, &FakeTimeService) {
    let time_service = Box::new(FakeTimeService::new());
    let tracker = Tracker::with_time_service(time_service);

    // does not compile, as time service's ownership has been
    // moved to the tracker.
    (tracker, &*time_service)
}

问题是我不知道如何从单元测试内部访问虚假时间服务，因为它的所有权已被跟踪器获取。

我可以想象多种解决方案:

1. 在跟踪器中使用 Rc 而不是 Box 来共享时间服务的所有权
2. 使 Tracker 通用并为使用的 TimeTracker 实现添加类型参数
3. 为 init_tracker 函数添加生命周期

我不喜欢使用解决方案 1，因为这不会表达服务是跟踪器一部分的想法(似乎违反了封装)。

解决方案 2 可能是可行的，但在那种情况下，我需要公开 TimeService 特征和使用的实现，我也想避免这样做。

因此，在不更改设计的情况下，最有希望的解决方案似乎是生命周期。是否可以通过 init_tracker 函数可以返回跟踪器和虚假时间服务的方式为变量添加生命周期？

还有其他解决方案/最佳实践吗？

Answer 1

您可以使 FakeTimeService 类型可克隆，使其状态在多个克隆实例之间共享:

use std::rc::Rc;

#[derive(Clone)]
struct FakeTimeService {
    state: Rc<FakeTimeServiceState>,
}

impl TimeService for FakeTimeService { ... }

impl FakeTimeService {
    fn state(&self) -> &FakeTimeServiceState {
        *self.state
    }
}

fn init_tracker() -> (Tracker, FakeTimeService) {
    let time_service = FakeTimeService::new();
    let tracker = Tracker::with_time_service(Box::new(time_service.clone()));
    (tracker, time_service)
}

现在您将能够独立修改假时间服务状态，同时保持 Tracker 的接口(interface)和实现与以前相同。

您很可能希望在 FakeTimeService 中有一些可变状态，以便设置您的测试先决条件。因此，您可能需要为 FakeTimeService 状态使用某种内部可变性:

use std::rc::Rc;
use std::cell::{RefCell, RefMut};

#[derive(Clone)]
struct FakeTimeService {
    state: Rc<RefCell<FakeTimeServiceState>>,
}

impl FakeTimeService {
    fn state_mut(&self) -> RefMut<FakeTimeServiceState> {
        self.state.borrow_mut()
    }
}

struct FakeTimeServiceState {
    init_value: i32,
}

impl FakeTimeServiceState {
    fn set_initial_value(&mut self, x: i32) {
        self.init_value = x;
    }
}

let (tracker, time_service) = init_tracker();
time_service.state_mut().set_initial_value(123);