Mockito：如何模拟 JodaTime 的界面

Question

我使用 JodaTime#DateTime，我需要模拟它的行为。由于不可能直接模拟 JodaTime#DateTime，因此我创建了它的一个接口

Clock.java

public interface Clock {
    DateTime getCurrentDateTimeEST();
    DateTime getFourPM_EST();
    DateTime getSevenPM_EST();
}

JodaTime.java

public class JodaTime implements Clock {

    @Override
    public DateTime getCurrentDateTimeEST() {
        return new DateTime(DateTimeZone.forID("EST"));
    }

    @Override
    public DateTime getFourPM_EST() {
        DateTime current = getCurrentDateTimeEST();
        return new DateTime(current.getYear(), current.getMonthOfYear(), 
                current.getDayOfMonth(), 16, 0, 0, 0, DateTimeZone.forID("EST"));
    }

    @Override
    public DateTime getSevenPM_EST() {
        DateTime current = getCurrentDateTimeEST();
        return new DateTime(current.getYear(), current.getMonthOfYear(), 
                current.getDayOfMonth(), 19, 0, 0, 0, DateTimeZone.forID("EST")); 
    }   
}

这是我要测试的方法

public class PrintProcessor{

  Clock jodaTime;

  public PrintProcessor(){
      jodaTime = new JodaTime();
  }
  ...
  public String getPrintJobName(Shipper shipper){
    String printJobName = null;
    //Get current EST time
    if(jodaTime.getCurrentDateTimeEST().isBefore(jodaTime.getFourPM_EST()) ||
            jodaTime.getCurrentDateTimeEST().isAfter(jodaTime.getSevenPM_EST())){   //Before 4PM EST and after 7PM EST
        switch(shipper){
        case X:
        ...
    }else if(jodaTime.getCurrentDateTimeEST().isBefore(jodaTime.getSevenPM_EST())){ //Between 4PM-7PM EST
        switch(shipper){
        case X:
        ... 
    }
    return printJobName;
  }
}

正如您所看到的 printJobName< /code> 取决于当天相对于时间间隔 [4PM-7PM] EST 的当前时间和发件人名称。由于 Shipper 将通过参数传递，因此我们可以对其进行单元测试，没有问题。但我需要嘲笑时间。所以这是我尝试的

@Test
public void testGetPrintJobNameBeforeFourPM(){
    DateTime current = new DateTime(DateTimeZone.forID("EST"));
    Clock clock = mock(Clock.class);
    //Always return 6pm when I try to ask for the current time
    when(clock.getCurrentDateTimeEST()).thenReturn(new DateTime(current.getYear(), current.getMonthOfYear(), 
            current.getDayOfMonth(), 18, 0, 0, 0, DateTimeZone.forID("EST")));
    //Test for Fedex
    String printJobName = printProcessor.getPrintJobName(Shipper.X);
    assertEquals("XNCRMNCF", printJobName);
}

测试应该失败，因为我在下午 6 点通过，但 XNCRMNCF 是下午 4 点之前的名称。我还需要模拟 printProcessor 吗？如果我所拥有的是错误的。我应该如何修复它？ 我正在努力学习编写高级java代码，请对我的代码进行批评。我真的很想学

Answer 1

这是一个典型的测试案例，显示了设计中的潜在缺陷。您无法模拟 JodaTime，因为您对被测类中的这些类具有硬连线依赖关系。

查看 SOLID 原则，了解为什么这可能是一个问题（特别是在这种情况下依赖倒置原则）。如果您在某处注入了 JodaTime 作为依赖项，那么在单元测试中您将能够用 模拟、存根或间谍（视情况而定）。

但是： JodaTime 是极不可能在生产环境中与其他任何东西一起注入的东西，无论它存在多久。相反，在这种情况下，您可能会更好地使用 组合方法设计模式。在这里，您可以将用于生成 printjobName 的任何计算/算法提取到另一个方法（我看不到您在这里如何执行此操作，因为您的代码片段从未为该变量分配值）。然后，您可以监视（部分模拟）被测试的类，以仅模拟该方法并返回固定值，而不管 JodaTime 提供的实际日期时间如何，例如：

public class PrintProcessor {
    ...
    public String getPrintJobName(Shipper shipper) {
        String printJobName = null;
        String timeHash = this.getTimeHash();
        if (this.isBeforeFourPM()) {
            switch(shipper) {
                printJobName = // Do something with timeHash to generate name
            }
        } else {
            ...
        }
        return printJobName;
    }

    public boolean isBeforeFourPM() {
        return (jodaTime.getCurrentDateTimeEST().isBefore(jodaTime.getFourPM_EST()) ||
            jodaTime.getCurrentDateTimeEST().isAfter(jodaTime.getSevenPM_EST()));
    }

    public String getTimeHash() {
        ... // Do something to hash the time value in to a String
    }
}

现在您可以在测试：

@Test
public void testGetPrintJobNameBeforeFourPM() {
    PrintProcessor concretePrintProcessor = new PrintProcessor();
    PrintProcessor printProcessor = spy(concretePrintProcessor);
    doReturn(true).when(printProcessor).isBeforeFourPM();

    String printJobName = printProcessor.getPrintJobName(Shipper.X);

    assertEquals("XNCRMNCF", printJobName);
}

Answer 2

您永远不会向 PrintProcessor 提供您的模拟。对对象进行模拟与将模拟赋予对象不同。因此，当您调用 PrintProcessor 上的方法时，它是在 JodaTime 的真实实例上进行操作。有几种方法可以为 PrintProcessor 提供模拟：

1. 使用 PowerMockito （确保您使用 PowerMock-mockito jar 而不是 PowerMock-easymock jar）并模拟 JodaTime 构造函数以返回模拟的 Clock 对象 whenNew(JodaTime.class).withNoArguments().thenReturn (mockJodaTime); 这将在使用 JodaTime 的无参数构造函数的地方插入您的模拟。注意：这需要您使用 JodaTime 类的模拟。
2. 为 Clock jodaTime 字段添加一个 setter 方法（如果仅在构造函数中定义，该方法可能应该是 final）。
3. 为您的 Clock 类使用工厂，并在测试期间简单地返回模拟（您可以使用 PowerMockito 来模拟静态方法）。
4. 创建一个带有 Clock 参数的构造函数并传入您的模拟。

Answer 3

我认为你绝对走在正确的道路上。创建用于模拟的时钟接口绝对是一个好主意。

我在您的代码中没有看到一件事：将模拟时钟注入 printProcessor 中。创建模拟后，我认为您需要以下内容：（

printProcessor.setClock(clock)

这在调用 getPrintJobName 之前进行。此设置器应在 PrintProcessor 类中设置 jodaTime 属性）

我习惯了 EasyMock，所以我可能是错的，但我我非常确定您还需要设置 getFourPM_EST 和 getSevenPM_EST 调用的期望。