UnitTest 一种与时间相关的方法

Question

您将如何测试与时间相关的方法？

一个简单的例子可以是：

public static int GetAge(DateTime birthdate)
{
    // ...
}

[TestMethod]
public void GetAgeTest()
{
    // This is only ok for year 2013 !
    Assert.AreEqual(GetAge(new DateTime(2000, 1, 1)), 13);
}

问题在于它仅适用于当前年份（在本例中为 2013 年）。新的一年一开始，我就得重写所有依赖时间的测试......

对这种方法进行单元测试的最佳方法是什么？

Answer 1

您可以覆盖 GetAge 方法查找今天日期的机制。

如果您将 DateTime 包装在另一个类中，则可以将实际调用替换为在单元测试时返回已知值的假调用。

您可以使用依赖注入在生产的真实实现和测试的假实现之间切换。

Answer 2

另外，不要忘记“预期”参数是AreEquals 中的第一个参数。

[TestMethod]
public void GetAgeTest()
{
    int age = 13;
    Assert.AreEqual(age, GetAge(DateTime.Now.AddYears(age * -1));
}

最好将测试拆分为 Arrange - Act - Assert 组，如下所示：

[TestMethod]
public void GetAgeTest()
{
    // Arrange
    int age = 13;

    // Act
    int result = GetAge(DateTime.Now.AddYears(age * -1);

    // Assert
    Assert.AreEqual(age, result);
}

Answer 3

两个主要选项：

1. 创建一个隔离时间相关功能的服务，并将其接口注入到需要它的类中。然后你可以模拟这个接口来获得你需要的测试行为。

2. 使用像Moles 这样的迂回测试框架（也有其他一些），可以重新路由像DateTime.Now 这样的静态方法调用。

Answer 4

这样的事情就可以解决问题

var birthDate = new DateTime(DateTime.Now.Year - 13, 1, 1)
int age = GetAge(birthDate);
Assert.AreEqual(age, 13);

Answer 5

另一个解决方案是使用 Microsoft Shimes and Fakes。 看http://msdn.microsoft.com/en-us/library/hh549175.aspx

using (ShimsContext.Create())
{
    // Shim DateTime.Now to return a fixed date:
    System.Fakes.ShimDateTime.NowGet = () =>
    { 
        return new DateTime(fixedYear, 1, 1); 
    };
}

Answer 6

在这种特定情况下可能不是最佳选择，但您也可以将函数的接口扩展为还需要传递 DateTime now。

public static int GetAge(DateTime birthdate, DateTime now)
{
    // ...
}

[TestMethod]
public void GetAgeTest()
{
    Assert.AreEqual(GetAge(new DateTime(2000, 1, 1), new DateTime(2013, 1, 1)), 13);
}

您基本上是将获取当前日期的责任委托给调用者（不过也将单元测试问题推到了那里）。

一个很好的副作用是您在此函数的范围内确实获得了一个明确定义的“现在”。在刻度级别上，调用 DateTime.Now 的那一刻会有所作为。您可以在抽象层面上将函数描述为“给定这个生日和这个当前日期，年龄是”。

同样，这可能不是在所有情况下都最好的方法，但我认为在某些情况下值得考虑。

Answer 7

另一个解决方案是使用 VirtualTime。 ，它简化了单元测试依赖于时间的应用程序，请在此处查看如何使用和示例Unit Testing: DateTime.Now

Answer 8

您可以将时间视为依赖项并将其注入您的方法中。我建议使用NodaTime 中的IClock 接口。然后在您的单元测试中，您可以使用来自NodaTime.Testing 的FakeClock 类。

你修改过的方法。

public static int GetAge(IClock clock, DateTime birthdate)
{
    now = clock.GetCurrentInstant().ToDateTimeUtc();
    // use now and birthdate to calculate age
}

然后你可以这样写你的单元测试。

[TestMethod]
public void GetAgeTest()
{
    var clock = new FakeClock(Instant.FromUtc(2013, 1, 1, 0, 0, 0)); // Create a fake clock that always return 2013/01/01 0:00:00
    var birthDate = new DateTime(2000, 1, 1, 0, 0, 0, DateTimeKind.Utc);
    Assert.AreEqual(GetAge(clock, birthdate), 13); Always return 13
}

如果您决定将GetAge 移动到它自己的类中。

public class AClass
{
    private readonly IClock _clock;

    public AClass(IClock clock) => _clock = clock;

    public int GetAge(DateTime birthdate)
    {
        now = _clock.GetCurrentInstant().ToDateTimeUtc();
        // use now and birthdate to calculate age
    }
}

FakeClock 是一个非常强大的测试工具。你可以从我的博文here了解更多。