等待异步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。对于后台工作人员，这项功能正常运行，因为我可以等待后台工作人员完成。

但是似乎没有办法等待异步无效方法...

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

Answer 1

我想出了一种单元测试的方法：

[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 2

async void方法本质上是一种“触发并忘记”方法。无法恢复完成事件（没有外部事件等）。

如果需要对其进行单元测试，我建议将其改为async Task方法。然后可以对结果调用Wait（），该结果将在方法完成时通知您。

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

Answer 3

您应该避免async void。仅对事件处理程序使用async voidDelegateCommand是（逻辑上）一个事件处理程序，因此您可以这样做：

// 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();
}

我的建议答案在上面。但如果您确实想测试异步void方法，可以使用我的AsyncEx库：

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

但是此解决方案会在视图模型的生存期内更改视图模型的同步上下文。