时间相关的单元测试

Question

我需要测试一个函数，它的结果将取决于当前时间（使用 Joda 时间的isBeforeNow()，它发生了）。

public boolean isAvailable() {
    return (this.someDate.isBeforeNow());
}

是否可以使用（例如使用 Mockito）来存根/模拟系统时间，以便我可以可靠地测试该功能？

Answer 1

使您的代码可测试的最佳方法 (IMO) 是将“当前时间是多少”的依赖项提取到它自己的接口中，其中一个实现使用当前系统时间（正常使用），一个实现让您设置时间，根据需要提前等。

我在各种情况下都使用过这种方法，而且效果很好。它很容易设置 - 只需创建一个界面（例如Clock），它有一个方法可以以您想要的任何格式为您提供当前瞬间（例如使用 Joda Time，或者可能是 Date）。

Answer 2

Joda time 支持通过DateTimeUtils 类的setCurrentMillisFixed 和setCurrentMillisOffset 方法设置“假”当前时间。

见https://www.joda.org/joda-time/apidocs/org/joda/time/DateTimeUtils.html

Answer 3

Java 8 引入了抽象类java.time.Clock，它允许您使用替代实现进行测试。这正是乔恩当时在回答中所建议的。

Answer 4

要添加到Jon Skeet's answer，Joda Time 已经包含一个当前时间接口：DateTimeUtils.MillisProvider

例如：

import org.joda.time.DateTime;
import org.joda.time.DateTimeUtils.MillisProvider;

public class Check {
    private final MillisProvider millisProvider;
    private final DateTime someDate;

    public Check(MillisProvider millisProvider, DateTime someDate) {
        this.millisProvider = millisProvider;
        this.someDate = someDate;
    }

    public boolean isAvailable() {
        long now = millisProvider.getMillis();
        return (someDate.isBefore(now));
    }
}

在单元测试中模拟时间（使用Mockito，但您可以实现自己的 MillisProviderMock 类）：

DateTime fakeNow = new DateTime(2016, DateTimeConstants.MARCH, 28, 9, 10);
MillisProvider mockMillisProvider = mock(MillisProvider.class);
when(mockMillisProvider.getMillis()).thenReturn(fakeNow.getMillis());

Check check = new Check(mockMillisProvider, someDate);

在生产中使用当前时间（DateTimeUtils.SYSTEM_MILLIS_PROVIDER 已在 2.9.3 中添加到 Joda Time）：

Check check = new Check(DateTimeUtils.SYSTEM_MILLIS_PROVIDER, someDate);

Answer 5

我使用类似于 Jon 的方法，但不是为当前时间创建专门的接口（例如，Clock），我通常创建一个特殊的测试接口（例如，MockupFactory）。我把测试代码所需的所有方法都放在那里。例如，在我的一个项目中，我有四种方法：

• 返回一个模型数据库客户端；
• 创建一个模型通知对象，通知代码有关数据库中的更改；
• 创建一个模型 java.util.Timer 以在我需要时运行任务；
• 返回当前时间。

被测试的类有一个构造函数，它接受这个接口以及其他参数。没有这个参数的那个只会创建一个“在现实生活中”工作的这个接口的默认实例。接口和构造函数都是包私有的，因此测试 API 不会泄漏到包之外。

如果我需要更多模拟对象，我只需向该接口添加一个方法并在测试和实际实现中实现它。

通过这种方式，我首先设计了适合测试的代码，而不会对代码本身施加太多影响。事实上，这样代码变得更加简洁，因为很多工厂代码都集中在一个地方。例如，如果我需要在实际代码中切换到另一个数据库客户端实现，我只需要修改一行，而不是四处寻找对构造函数的引用。

当然，就像 Jon 的方法一样，它不适用于您无法或不允许修改的第 3 方代码。