c# - 是否可以在包含异步 lambda 的命令中对异常进行单元测试？

Question

考虑以下用于获取和显示项目列表的高度简化的 View 模型:

public class ProjectListViewModel
{
    private readonly IWebService _webService;
    public ICommand RefreshCommand { get; }
    // INotifyPropertyChanged implementation skipped for brevity
    public ObservableCollection<Project> Projects { get; set; }

    public ProjectListViewModel(IWebService serverApi)
    {
        _serverApi = serverApi;
        // ICommand implemented by Xamarin.Forms
        RefreshCommand = new Command(async () => await RefreshAsync());
    }

    private async Task RefreshAsync()
    {
        try
        {
            Projects = await _webService.GetProjectsAsync();
        }
        catch (TaskCanceledException)
        {
            // Empty (task only cancelled when we are navigating away from page)
        }
    }
}

使用 NUnit 和 Moq，我尝试测试当 GetProjectsAsync 抛出 TaskCanceledException 时，ViewModel 会捕获它。我得到的最接近的是:

[Test]
public void When_Refreshing_Catches_TaskCanceledException()
{
    // Arrange
    webService = new Mock<IServerApi>();
    webService.Setup(mock => mock.GetProjectsAsync())
        .ThrowsAsync(new TaskCanceledException());
    vm = new ProjectListViewModel(webService.Object);

    // Act and assert
    Assert.That(() => vm.RefreshCommand.Execute(null), Throws.Nothing);
}

测试通过了，但不幸的是它是错误的——如果我抛出它仍然通过，例如异常而不是 TaskCanceledException。据我所知，原因是异常不会通过命令 lambda 冒泡，async () => await RefreshAsync()，所以 GetProjectsAsync 抛出的异常不会被检测到考试。 (然而，当运行实际应用程序时，如果未捕获到 TaskCanceledException 异常，则会冒泡并使应用程序崩溃。我怀疑这与同步上下文有关，对此我的了解非常有限。)

如果我调试 测试它会起作用 - 如果我模拟它抛出异常，它将在命令/lambda 定义的行上中断，如果我抛出 TaskCanceledException，测试将通过。

请注意，如果我使用 Throws 而不是 ThrowsAsync，结果是相同的。如果相关，我将使用 ReSharper 2016.2 中的测试运行器。

使用 nUnit，是否有可能对执行这样的“异步”命令时抛出的异常进行单元测试？是否有可能不编写自定义命令实现？

Answer 1

你的问题在这里:

new Command(async () => await RefreshAsync())

此 async lambda 被编译器转换为 async void 方法。

在我关于 async best practices 的文章中，我解释为什么不能像这样捕获异常。 async 方法不能直接传播它们的异常(因为它们的堆栈在异常发生时可能已经消失)。 async Task 方法通过将异常放在返回的任务上自然地解决了这个问题。 async void 方法是不自然的，它们无处放置异常，因此它们直接在方法启动时当前的 SynchronizationContext 上引发异常。

在您的应用程序中，这是 UI 上下文，因此就像直接在事件处理程序中抛出一样。在你的单元测试中，没有上下文，所以它被扔到线程池线程上。我认为 NUnit 在这种情况下的行为是捕获异常并将其转储到控制台。

就个人而言，我更喜欢在我的 Mvvm.Async library 中使用我自己的异步兼容 ICommand，例如 AsyncCommand (另请参阅我关于 asynchronous MVVM commands 的文章):

new AsyncCommand(_ => RefreshAsync())

然后可以自然地对其进行单元测试:

await vm.RefreshCommand.ExecuteAsync(null); // does not throw

或者，您可以在单元测试中提供您自己的同步上下文(例如使用 my AsyncContext ):

// Arrange
webService = new Mock<IServerApi>();
webService.Setup(mock => mock.GetProjectsAsync())
    .ThrowsAsync(new TaskCanceledException());
vm = new ProjectListViewModel(webService.Object);

// Act/Assert
AsyncContext.Run(() => vm.RefreshCommand.Execute(null));

在这种情况下，如果有异常，Run 会传播它。