如何对这个（正确）抛出异常的异步方法进行单元测试？

Question

我在一个界面中有以下方法..

Task<SearchResult<T>> SearchAsync(TU searchOptions);

效果很好。

现在我正在尝试进行单元测试以测试何时出现问题 - 并且代码会引发异常。

在这种情况下，我设置了我的方法来抛出一个HttpRequestException。我的单元测试没有说我抛出了那个异常..

var result = Should.Throw<HttpRequestException>
    (async () => await service.SearchAsync(searchOptions));

单元测试的错误信息是

应该.ChuckedAWobbly
var 结果 = 应该
扔
System.Net.Http.HttpRequestException
但没有

所以assertion framework 是在说：你已经预料到了一个异常，但没有抛出任何异常。

当我单步执行代码时，会 100% 抛出异常。

谁能看看我的单元测试代码做错了什么？

Answer 1

今天应该包含Should.ThrowAsync<T>。

你可以这样使用它：

await Should.ThrowAsync<HttpRequestException>(() => service.SearchAsync(searchOptions));

Answer 2

问题是传递的 lambda 返回一个任务。抛出的异常只能由Should.Throw 观察到，如果它等待此任务完成，显然它不会。作为一种变通方法，您可以在 SearchAsync 自己返回的任务上 .Wait。

mstest（内置的 Visual Studio 测试框架）自 Visual Studio 2012 起支持异步测试。您基本上可以通过将“void”替换为“async Task”来更改测试方法声明。

[TestMethod]
[ExpectedException(typeof(System.Net.Http.HttpRequestException))]
public async Task SomeTest()
{
   await service.SearchAsync(searchOptions);
}

您可能正在使用不同的单元测试框架，但不清楚是哪一个。请查阅其文档以查看它是否支持异步测试。

NUnit 2.6.3 似乎也支持异步测试。

edit：所以您使用的是 xUnit。这个特殊问题是fixed for xUnit 2.0。不过，它目前仍处于 alpha 阶段。

Answer 3

问题是您的断言框架不理解异步方法。我建议您向他们提出问题。

同时，您可以使用source for Should.Throw 编写自己的MyShould.ThrowAsync：

public static async Task<TException> ThrowAsync<TException>(Func<Task> actual)
    where TException : Exception
{
  try
  {
    await actual();
  }
  catch (TException e)
  {
    return e;
  }
  catch (Exception e)
  {
    throw new ChuckedAWobbly(new ShouldlyMessage(typeof(TException), e.GetType()).ToString());
  }

  throw new ChuckedAWobbly(new ShouldlyMessage(typeof(TException)).ToString());
}

并像这样使用它：

var result = await MyShould.ThrowAsync<HttpRequestException>
    (async () => await service.SearchAsync(searchOptions));

或稍微简单和等效的：

var result = await MyShould.ThrowAsync<HttpRequestException>
    (() => service.SearchAsync(searchOptions));

Answer 4

像这样测试它：

var result = Should.Throw<HttpRequestException>
    (() => service.SearchAsync(searchOptions).Result);

或者：

var result = Should.Throw<HttpRequestException>
    (() => service.SearchAsync(searchOptions).Wait());

否则，您的 Should.Throw 在 async lambda 完成之前返回。

Answer 5

对异步代码/功能进行单元测试非常困难。我自己正在进行单元测试异步并遇到与您相同的问题。

我发现以下两个资源非常有用：

• Best practices in async programming - 它深入探讨了异步的主题以及测试它的问题。
• Unit testing async the wrong way 和 Unit testing async the right way - 深入研究主题，展示您将遇到的问题以及如何设置测试。

Answer 6

异常是在与运行单元测试的线程不同的线程上引发的。单元测试框架只能在自己的线程上预测异常。

我建议您在服务的同步版本上测试异常。