是否可以在包装异步lambda的命令中单元测试异常？

Question

考虑以下高度简化的viewmodel来获取和显示项目列表:

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抛出a时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);
}

测试通过,但不幸的是它有问题 - 如果我抛出例如Exception而不是TaskCanceledException它仍然会通过.据我所知,原因是异常不会超过命令lambda async () => await RefreshAsync(),因此测试不会检测到GetProjectsAsync抛出的异常.(但是当运行实际应用程序时,如果没有捕获,TaskCanceledException将冒泡并崩溃应用程序.我怀疑这与同步上下文有关,我对其理解非常有限.)

如果我调试测试它是有效的 - 如果我将它模拟为抛出异常,它将在命令/ lambda定义中断行,如果我抛出TaskCanceledException,测试将通过.

请注意,如果我使用Throws而不是ThrowsAsync,结果是相同的.如果它是相关的,我在ReSharper 2016.2中使用测试运行器.

使用nUnit,是否可以对执行这样的"async"命令时抛出的异常进行单元测试？是否可以不编写自定义Command实现？

Answer 1

你的问题在这里:

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

此asynclambda async void由编译器转换为方法.

在我关于async最佳实践的文章中,我解释了为什么不能像这样捕获异常.async方法不能直接传播它们的异常(因为它们的堆栈可能在异常发生时消失).async Task方法通过在返回的任务上放置异常来自然地解决这个问题.async void方法是不自然的,并且它们无处放置异常,因此它们直接在SynchronizationContext方法开始时的当前值上提升它.

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

就个人而言,我更喜欢使用我自己的异步兼容,ICommand例如AsyncCommand在我的Mvvm.Async库中(另见我的关于异步MVVM命令的文章):

new AsyncCommand(_ => RefreshAsync())

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

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

或者,您可以在单元测试中提供自己的同步上下文(例如,使用我的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传播它.