Mocking Task.Delay

本文关键字：Delay Task Mocking | 更新日期: 2023-09-27 18:17:26

我有以下一行的方法:await Task.Delay(waitTime).ConfigureAwait(false);

我有一个很好的策略来避免在单元测试时实际等待几秒钟，而是验证我们试图等待特定的秒数。

例如，是否有一种方法可以在我的方法中注入一个额外的参数，就像在这个(人为的)示例中，我注入一个虚构的ITaskWaiter接口的模拟对象:

// Arrange
var mockWait = new Mock<ITaskWaiter>(MockBehavior.Strict);
mockWait.Setup(w => w.Delay(It.Is<TimeSpan>(t => t.TotalSeconds == 2)));
// Act
myObject.MyMethod(mockWait.Object);
// Assert
mockWait.Verify();

Mocking Task.Delay

你可以这样定义一个"delayer"接口:

public interface IAsyncDelayer
{
    Task Delay(TimeSpan timeSpan);
}

然后您可以为生产代码提供以下实现:

public class AsyncDelayer : IAsyncDelayer
{
    public Task Delay(TimeSpan timeSpan)
    {
        return Task.Delay(timeSpan);
    }
}
现在，你的类看起来像这样: 
public class ClassUnderTest
{
    private readonly IAsyncDelayer asyncDelayer;
    public ClassUnderTest(IAsyncDelayer asyncDelayer)
    {
        this.asyncDelayer = asyncDelayer;
    }
    public async Task<int> MethodUnderTest()
    {
        await asyncDelayer.Delay(TimeSpan.FromSeconds(2));
        return 5;
    }
}

这是依赖注入的基本应用。基本上，我们提取了异步等待另一个类的逻辑，并为它创建了一个接口来启用多态性。

在生产环境中，您可以这样组合对象:

var myClass = new ClassUnderTest(new AsyncDelayer());
现在，在您的测试中，您可以创建一个假延迟层，它立即返回如下: 
[TestMethod]
public async Task TestMethod1()
{
    var mockWait = new Mock<IAsyncDelayer>();
    mockWait.Setup(m => m.Delay(It.IsAny<TimeSpan>())).Returns(Task.FromResult(0));
    var sut = new ClassUnderTest(mockWait.Object);
    var result = await sut.MethodUnderTest();
    Assert.AreEqual(5, result);
}

接受的答案是正确的方法。

替代1

如果你想"隐藏"来自客户端代码的依赖项(在不同的程序集中)，但允许测试使用它:

public class ClassUnderTest
{
    private readonly IAsyncDelayer asyncDelayer;
    public ClassUnderTest() : this(new AsyncDelayer()) { }   // used by client code
    internal ClassUnderTest(IAsyncDelayer asyncDelayer)      // used by tests
    {
        this.asyncDelayer = asyncDelayer;
    }
    public async Task<int> MethodUnderTest()
    {
        await asyncDelayer.Delay(TimeSpan.FromSeconds(2));
        return 5;
    }
}
替代2

如果您不想引入可模拟依赖(无论出于何种原因)，那么将延迟提取到virtual方法并模拟:

public class ClassUnderTest
{
    internal virtual Task Delay(TimeSpan delay) => Task.Delay(delay);
    public async Task<int> MethodUnderTest()
    {
        await Delay(TimeSpan.FromSeconds(2));
        return 5;
    }
}

在测试中，需要部分模拟类。然后模拟Delay()以返回Task.CompletedTask，因此它什么都不做。您还可以验证是否使用值2调用了模拟方法。

相关文章：