等待 Async Void 方法调用以进行单元测试

Question

我有一个看起来像这样的方法：

private async void DoStuff(long idToLookUp)
{
    IOrder order = await orderService.LookUpIdAsync(idToLookUp);   

    // Close the search
    IsSearchShowing = false;
}    

//Other stuff in case you want to see it
public DelegateCommand<long> DoLookupCommand{ get; set; }
ViewModel()
{
     DoLookupCommand= new DelegateCommand<long>(DoStuff);
}    

我正在尝试像这样对其进行单元测试：

[TestMethod]
public void TestDoStuff()
{
    //+ Arrange
    myViewModel.IsSearchShowing = true;

    // container is my Unity container and it setup in the init method.
    container.Resolve<IOrderService>().Returns(orderService);
    orderService = Substitute.For<IOrderService>();
    orderService.LookUpIdAsync(Arg.Any<long>())
                .Returns(new Task<IOrder>(() => null));

    //+ Act
    myViewModel.DoLookupCommand.Execute(0);

    //+ Assert
    myViewModel.IsSearchShowing.Should().BeFalse();
}

在我完成模拟 LookUpIdAsync 之前调用了我的断言。在我的正常代码中，这正是我想要的。但是对于我的单元测试，我不希望这样。

我正在从使用 BackgroundWorker 转换为 Async/Await。使用后台工作人员，这可以正常工作，因为我可以等待 BackgroundWorker 完成。

但似乎没有办法等待 async void 方法...

如何对这个方法进行单元测试？

Answer 1

你应该避免async void。仅将 async void 用于事件处理程序。 DelegateCommand （逻辑上）是一个事件处理程序，所以你可以这样做：

// Use [InternalsVisibleTo] to share internal methods with the unit test project.
internal async Task DoLookupCommandImpl(long idToLookUp)
{
  IOrder order = await orderService.LookUpIdAsync(idToLookUp);   

  // Close the search
  IsSearchShowing = false;
}

private async void DoStuff(long idToLookUp)
{
  await DoLookupCommandImpl(idToLookup);
}

并对其进行单元测试：

[TestMethod]
public async Task TestDoStuff()
{
  //+ Arrange
  myViewModel.IsSearchShowing = true;

  // container is my Unity container and it setup in the init method.
  container.Resolve<IOrderService>().Returns(orderService);
  orderService = Substitute.For<IOrderService>();
  orderService.LookUpIdAsync(Arg.Any<long>())
              .Returns(new Task<IOrder>(() => null));

  //+ Act
  await myViewModel.DoLookupCommandImpl(0);

  //+ Assert
  myViewModel.IsSearchShowing.Should().BeFalse();
}

---

我推荐的答案在上面。但是如果你真的想测试一个async void 方法，你可以用我的AsyncEx library 来做：

[TestMethod]
public void TestDoStuff()
{
  AsyncContext.Run(() =>
  {
    //+ Arrange
    myViewModel.IsSearchShowing = true;

    // container is my Unity container and it setup in the init method.
    container.Resolve<IOrderService>().Returns(orderService);
    orderService = Substitute.For<IOrderService>();
    orderService.LookUpIdAsync(Arg.Any<long>())
                .Returns(new Task<IOrder>(() => null));

    //+ Act
    myViewModel.DoLookupCommand.Execute(0);
  });

  //+ Assert
  myViewModel.IsSearchShowing.Should().BeFalse();
}

但此解决方案会在其生命周期内更改您的视图模型的 SynchronizationContext。

Answer 2

async void 方法本质上是一种“一劳永逸”的方法。没有办法取回完成事件（没有外部事件等）。

如果您需要对此进行单元测试，我建议您改为使用async Task 方法。然后您可以在结果上调用Wait()，它会在方法完成时通知您。

但是，这种编写的测试方法仍然不起作用，因为您实际上并没有直接测试DoStuff，而是测试包装它的DelegateCommand。您需要直接测试此方法。

Answer 3

我想出了一种方法来进行单元测试：

[TestMethod]
public void TestDoStuff()
{
    //+ Arrange
    myViewModel.IsSearchShowing = true;

    // container is my Unity container and it setup in the init method.
    container.Resolve<IOrderService>().Returns(orderService);
    orderService = Substitute.For<IOrderService>();

    var lookupTask = Task<IOrder>.Factory.StartNew(() =>
                                  {
                                      return new Order();
                                  });

    orderService.LookUpIdAsync(Arg.Any<long>()).Returns(lookupTask);

    //+ Act
    myViewModel.DoLookupCommand.Execute(0);
    lookupTask.Wait();

    //+ Assert
    myViewModel.IsSearchShowing.Should().BeFalse();
}

这里的关键是，因为我是单元测试，所以我可以在我想让我的异步调用（在我的异步 void 内）返回的任务中替换。然后，我只需确保任务已完成，然后再继续。

Answer 4

我知道的唯一方法是将您的 async void 方法转换为 async Task 方法

Answer 5

您可以使用 AutoResetEvent 来暂停测试方法，直到异步调用完成：

[TestMethod()]
public void Async_Test()
{
    TypeToTest target = new TypeToTest();
    AutoResetEvent AsyncCallComplete = new AutoResetEvent(false);
    SuccessResponse SuccessResult = null;
    Exception FailureResult = null;

    target.AsyncMethodToTest(
        (SuccessResponse response) =>
        {
            SuccessResult = response;
            AsyncCallComplete.Set();
        },
        (Exception ex) =>
        {
            FailureResult = ex;
            AsyncCallComplete.Set();
        }
    );

    // Wait until either async results signal completion.
    AsyncCallComplete.WaitOne();
    Assert.AreEqual(null, FailureResult);
}

Answer 6

提供的答案测试命令而不是异步方法。如上所述，您还需要另一个测试来测试该异步方法。

花了一些时间处理类似问题后，我发现只需同步调用即可在单元测试中测试异步方法很容易：

    protected static void CallSync(Action target)
    {
        var task = new Task(target);
        task.RunSynchronously();
    }

及用法：

CallSync(() => myClass.MyAsyncMethod());

测试在这一行等待并在结果准备好后继续，因此我们可以在之后立即断言。

Answer 7

改变你的方法来返回一个Task，你可以使用Task.Result

bool res = configuration.InitializeAsync(appConfig).Result;
Assert.IsTrue(res);

Answer 8

我遇到了类似的问题。就我而言，解决方案是在 .Returns(...) 的起订量设置中使用 Task.FromResult，如下所示：

orderService.LookUpIdAsync(Arg.Any<long>())
    .Returns(Task.FromResult(null));

另外，Moq 也有一个ReturnsAysnc(...) 方法。