有没有办法对异步方法进行单元测试？

Question

我在 .NET 平台上使用 Xunit 和 NMock。 我正在测试一个表示模型，其中方法是异步的。 该方法创建一个异步任务并执行它，以便该方法立即返回，并且我需要检查的状态尚未准备好。

我可以在完成时设置一个标志而不修改 SUT，但这意味着我必须在 while 循环中继续检查该标志，例如，可能会超时。

我有什么选择？

Answer 1

只是认为您可能需要对此进行更新，因为#1 答案实际上是推荐一种较旧的模式来解决此问题。

在 .net 4.5 + xUnit 1.9 或更高版本中，您可以简单地返回一个任务，并可以选择使用测试中的 async 关键字让 xunit 等待测试异步完成。

请参阅有关 xUnit.net 1.9 的文章

[Fact]
public async Task MyAsyncUnitTest()
{    
  // ... setup code here ...     
  var result = await CallMyAsyncApi(...);     
  // ... assertions here ...
}

Answer 2

您的对象是否具有异步方法完成的任何类型的信号，例如事件？ 如果是这种情况，您可以使用以下方法：

[Test]
public void CanTestAsync()
{
    MyObject instance = new MyObject()
    AutoResetEvent waitHandle = new AutoResetEvent(false); 
    // create and attach event handler for the "Finished" event
    EventHandler eventHandler = delegate(object sender, EventArgs e) 
    {
        waitHandle.Set();  // signal that the finished event was raised
    } 
    instance.AsyncMethodFinished += eventHandler;

    // call the async method
    instance.CallAsyncMethod();

    // Wait until the event handler is invoked
    if (!waitHandle.WaitOne(5000, false))  
    {  
        Assert.Fail("Test timed out.");  
    }  
    instance.AsyncMethodFinished -= eventHandler;    
    Assert.AreEqual("expected", instance.ValueToCheck);
}

Answer 3

我的首选方法是模拟并注入实际的线程机制，以便在测试时它不是异步的。 有时这是不可能的（如果方法的线程是框架的一部分，或者不在您的控制之下）。

如果您无法控制线程创建，则等待线程以某种方式完成，无论是 while 循环还是只是定时等待线程应该花费的时间，如果状态不存在，则测试失败无论如何花了太长时间。

Answer 4

查看我关于 Silverlight 应用程序单元测试的文章

http://www.codeproject.com/KB /silverlight/Ag3DemoLOB.aspx

有一个对异步调用 WCF 服务的方法进行单元测试的示例...

Answer 5

使用 NSubtitute 和 XUnit 进行异步测试实际上非常简单：

 public interface IA
{
    Task<int> DoSomething();
}

调用者：

 public class IAmUnderTest
{
    public async Task<int> GetInt(IA a)
    {
        return await a.DoSomething();
    }
}

因为异步方法仅返回任务，所以使用 NSubstitute 模拟 DoSomething() 所需要做的就是使用 Task.FromResult()。 然后调用代码返回一个任务，它仍然可以等待并返回整数结果。

因此，使用 NSubstitute 模拟它看起来像这样：

  public class ATest
{
    [Fact]
    public void DoesSomething()
    {
        var dependency = Substitute.For<IA>();
        dependency.DoSomething().Returns(Task.FromResult(1));

        var target = new IAmUnderTest();
        var id = target.GetInt(dependency).Result;

        id.Should().Be(1);
    }
}

通过使测试异步添加一点额外的内容：

  public class ATest
{
    [Fact]
    public async Task DoesSomethingAsync()
    {
        var dependency = Substitute.For<IA>();
        dependency.DoSomething().Returns(Task.FromResult(1));

        var target = new IAmUnderTest();
        var id = await target.GetInt(dependency);

        id.Should().Be(1);
    }
}

在测试异步方法时，后者比前者更受青睐。

归功于：https://www.garethrepton.com/Unit-Testing-async-methods/#:~:text=因为%20Async%20methods%20just%20return%20tasks%2C%20all%20you，所以%20mocking%20it%20用%20NSubstitute%20looks%20like%20this%3A