如何使用 xUnit 测试包含 await 的 async void DelegateCommand 方法？

Question

这是我第一次为异步方法编写单元测试。我正在使用 xUnit。我搜索了 SO，但没有得到有希望的结果。我发现但对我不起作用的最好方法是从THIS 示例中实现IAsyncLifetime。对于如何解决此问题的任何提示，我将不胜感激。

目前我所拥有的。在经过测试的虚拟机中，我有一个命令：

public ICommand TestResultsCommand { get; private set; }

并且该命令在VM构造函数中初始化如下：

TestResultsCommand = new DelegateCommand(OnTestResultExecuteAsync);

命令调用方法：

private async void OnTestResultExecuteAsync(object obj)
        {
            TokenSource = new CancellationTokenSource();
            CancellationToken = TokenSource.Token;

            await TestHistoricalResultsAsync();
        }

TestHistoricalResultsAsync 方法的签名如下：

private async Task TestHistoricalResultsAsync()

现在让我们进入单元测试项目。目前在测试类我有一个方法：

[Fact]//testing async void
        public void OnTestResultExecuteAsync_ShouldCreateCancellationTokenSource_True()
        {
            CancellationTokenSource tokenSource = new CancellationTokenSource();
            CancellationToken cancellationToken = tokenSource.Token;
            _viewModel.TestResultsCommand.Execute(null);
            Assert.Equal(cancellationToken.CanBeCanceled, _viewModel.CancellationToken.CanBeCanceled);
            Assert.Equal(cancellationToken.IsCancellationRequested, _viewModel.CancellationToken.IsCancellationRequested);
        }

测试让我例外：

消息：System.NullReferenceException：对象引用未设置为 一个对象的实例。

异常的堆栈跟踪是：

提前感谢您的时间和建议。

Answer 1

problems of async void methods 之一是它们难以测试。对于您的问题，大多数开发人员会执行以下操作之一：

1. 定义并使用IAsyncCommand 接口。
2. 将他们的逻辑async Task 公开。
3. 使用支持异步命令的框架，例如 MvvmCross。

详情请见我的MSDN magazine article on the subject。

这是第二种方法的示例：

TestResultsCommand = new DelegateCommand(async () => await OnTestResultExecuteAsync());

public async Task OnTestResultExecuteAsync()
{
  TokenSource = new CancellationTokenSource();
  CancellationToken = TokenSource.Token;

  await TestHistoricalResultsAsync();
}

[Fact]
public async Task OnTestResultExecuteAsync_ShouldCreateCancellationTokenSource_True()
{
  CancellationTokenSource tokenSource = new CancellationTokenSource();
  CancellationToken cancellationToken = tokenSource.Token;
  await _viewModel.OnTestResultExecuteAsync();
  Assert.Equal(cancellationToken.CanBeCanceled, _viewModel.CancellationToken.CanBeCanceled);
  Assert.Equal(cancellationToken.IsCancellationRequested, _viewModel.CancellationToken.IsCancellationRequested);
}

如果您不想仅仅为了单元测试而公开async Task 方法，那么您可以使用某种IAsyncCommand；可以是您自己的（如我的文章中所详述）或来自库（例如 MvvmCross）的一个。这是一个使用 MvvmCross 类型的示例：

public IMvxAsyncCommand TestResultsCommand { get; private set; }

TestResultsCommand = new MvxAsyncCommand(OnTestResultExecuteAsync);

private async Task OnTestResultExecuteAsync() // back to private
{
  TokenSource = new CancellationTokenSource();
  CancellationToken = TokenSource.Token;

  await TestHistoricalResultsAsync();
}

[Fact]
public async Task OnTestResultExecuteAsync_ShouldCreateCancellationTokenSource_True()
{
  CancellationTokenSource tokenSource = new CancellationTokenSource();
  CancellationToken cancellationToken = tokenSource.Token;
  await _viewModel.TestResultsCommand.ExecuteAsync();
  Assert.Equal(cancellationToken.CanBeCanceled, _viewModel.CancellationToken.CanBeCanceled);
  Assert.Equal(cancellationToken.IsCancellationRequested, _viewModel.CancellationToken.IsCancellationRequested);
}

如果您更喜欢IMvxAsyncCommand 方法但不想要MvvmCross 依赖，那么define your own IAsyncCommand and AsyncCommand types 并不难。