嘲笑 Task.Delay

Mocking Task.Delay

我有一个包含以下行的方法: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();

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

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

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

public class AsyncDelayer : IAsyncDelayer
{
    public Task Delay(TimeSpan timeSpan)
    {
        return Task.Delay(timeSpan);
    }
}

现在,您的 class 看起来像这样:

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;
    }
}

这是Dependency Injection. Basically, we extracted the logic of asynchronously waiting to a different class and created an interface for it to enable polymorphism的基本应用。

在生产中,您可以这样组合对象:

var myClass = new ClassUnderTest(new AsyncDelayer());

现在,在您的测试中,您可以创建一个 returns 立即像这样的假延迟器:

[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;
    }
}

在测试中,需要部分mock class。然后模拟 Delay() 到 return Task.CompletedTask 所以它什么都不做。您还可以验证是否使用值 2.

调用了模拟方法