为什么在使用 MSpec/Moq 测试此异步方法时会收到 NullReferenceException？答案

【问题标题】：Why do I get a NullReferenceException when testing this async method with MSpec/Moq?为什么在使用 MSpec/Moq 测试此异步方法时会收到 NullReferenceException？
【发布时间】：2013-07-06 13:09:38
【问题描述】：

我想测试是否从异步方法返回了正确的类型。此方法使用依赖类中的另一个异步方法。依赖类实现了这个接口：

Task<string> DownloadStringAsync(string url);

我要测试的方法是这样的：

public async Task<T> GetData<T>(string url) where T : class , new()
{
    var jsonData = await _webClientWrapper.DownloadStringAsync(url);

    if (string.IsNullOrEmpty(jsonData))
        return new T();

    try
    {
        return await JsonConvert.DeserializeObjectAsync<T>(jsonData);
    }
    catch (JsonException inner)
    {
        throw new JsonConvertException("Error converting Json string", inner) { JsonString = jsonData };
    }
}

使用 xUnit 和 Moq 测试成功：

public class Testes
{
    private const string ValidJson = "{'Nome':'Rogerio','Idade':'51'}";
    protected static JsonWebServiceClassProvider JsonWebServiceClassProvider;
    private static Mock<IWebClientWrapper> _webClientWrapperMoq;
    private static FakeClassFromJson _resultClass;

    [Fact]
    public async static void When_calling_GetData_it_should_return_a_class_of_same_type()
    {
        _webClientWrapperMoq = new Mock<IWebClientWrapper>();
        _webClientWrapperMoq
            .Setup(w => w.DownloadStringAsync(Moq.It.IsAny<string>()))
            .Returns(Task.FromResult(ValidJson));

        JsonWebServiceClassProvider = new JsonWebServiceClassProvider(_webClientWrapperMoq.Object);

        _resultClass = await JsonWebServiceClassProvider
            .GetData<FakeClassFromJson>(Moq.It.IsAny<string>());

        Assert.IsType<FakeClassFromJson>(_resultClass);
    }
}

使用 MSpec 和 Moq 进行测试：

[Subject("JsonWebServiceClassProvider")]
public class When_calling_GetData_with_a_valid_Json_Service_Url
{
    private const string ValidJson = "{'Nome':'Rogerio','Idade':'51'}";
    protected static JsonWebServiceClassProvider JsonWebServiceClassProvider;
    protected static Mock<IWebClientWrapper> WebClientWrapperMoq;
    protected static FakeClassFromJson ResultClass;

    Establish context = () =>
    {
        WebClientWrapperMoq = new Mock<IWebClientWrapper>();
        WebClientWrapperMoq
            .Setup(w => w.DownloadStringAsync(Moq.It.IsAny<string>()))
            .Returns(Task.FromResult(ValidJson));

        JsonWebServiceClassProvider = new JsonWebServiceClassProvider(WebClientWrapperMoq.Object);
    };

    Because of = () => ResultClass = JsonWebServiceClassProvider
        .GetData<FakeClassFromJson>(Moq.It.IsAny<string>())
        .Await();

    It should_return_a_class_of_same_type = () => ResultClass.ShouldBeOfType<FakeClassFromJson>();
}

这些Because 语句也会失败

Because of = () => JsonWebServiceClassProvider
    .GetData<FakeClassFromJson>(Moq.It.IsAny<string>())
    .ContinueWith(task => ResultClass = task.Result)
    .Wait();

Because of = () => ResultClass = JsonWebServiceClassProvider
    .GetData<FakeClassFromJson>(Moq.It.IsAny<string>())
    .Result;

这会失败并在行中显示NullReferenceException

public async Task<T> GetData<T>(string url) where T : class , new()
{
    string jsonData = await _webClientWrapper.DownloadStringAsync(url);
    // ...
}

已解决

在等待响应时，做了一些重构，瞧！我用Establish 语句创建了一个基类，并在那里启动了模拟对象：

public class JsonWebServiceClassProviderSpecs
{
    protected static JsonWebServiceClassProvider JsonWebServiceClassProvider;
    protected static Mock<IWebClientWrapper> WebClientWrapperMoq; 

    Establish context = () =>
    {
        WebClientWrapperMoq = new Mock<IWebClientWrapper>();
        JsonWebServiceClassProvider = new JsonWebServiceClassProvider(WebClientWrapperMoq.Object);
    };
}

我更新了测试类：

[Subject("JsonWebServiceClassProvider")]
public class When_ask_data_with_a_valid_Json_Service_Url : JsonWebServiceClassProviderSpecs
{
    private const string ValidJson = "{'Nome':'Rogerio','Idade':'51'}";
    protected static FakeClassFromJson ResultClass;

    Establish context = () =>
    {
        WebClientWrapperMoq
            .Setup(w => w.DownloadStringAsync(Moq.It.IsAny<string>()))
            .Returns(Task.FromResult(ValidJson));
    };

    Because of = () => ResultClass = JsonWebServiceClassProvider
        .GetData<FakeClassFromJson>(Moq.It.IsAny<string>())
        .Await();

    It should_return_a_class_of_same_type = () => ResultClass.ShouldBeOfType<FakeClassFromJson>();
}

【问题讨论】：

请发布您的“已解决”更新作为答案，以便我们可以单独对您的解决方案进行投票/评论！
如果您是 TekPub 订阅者，Jon Skeet 关于异步 C# 系列的最后一集对单元测试异步代码有一些很好的建议。
在阅读了@Alexander Groß 的回复后，我返回了我的原始代码并且它有效。这里的问题是我的代码一直是正确的。但最初和一段时间它因 NullReferenceException 而失败。我一直不明白为什么。

标签： c# moq async-await mspec

【解决方案1】：

这是您的规范的精简版本，可以正常工作。没有NullReferenceException 可以看到。注意：

It 不检查AwaitResult 的类型，而是获取包装后的Task.Result
我没有在Because 中传递Moq.It<string>.Any...，这太吵了。如果该参数被忽略，请使用传达该事实的值。

（只是一些文本，使得下面的代码块格式正确。）

using System.Diagnostics;
using System.Threading.Tasks;

using Machine.Specifications;

using Moq;

using YourApp;

using It = Machine.Specifications.It;

namespace YourApp
{
  class Foo
  {
  }

  public interface IWebClientWrapper
  {
    Task<string> DownloadStringAsync(string url);
  }

  public class JsonWebServiceClassProvider
  {
    readonly IWebClientWrapper _webClientWrapper;

    public JsonWebServiceClassProvider(IWebClientWrapper webClientWrapper)
    {
      _webClientWrapper = webClientWrapper;
    }

    public async Task<T> GetData<T>(string url) where T : class, new()
    {
      string jsonData = await _webClientWrapper.DownloadStringAsync(url);
      Debug.Assert(jsonData != null);
      return new T();
    }
  }
}

namespace Specs
{
  public class When_calling_GetData_with_a_valid_Json_Service_Url
  {
    const string ValidJson = "{'Nome':'Rogerio','Idade':'51'}";
    static JsonWebServiceClassProvider JsonWebServiceClassProvider;
    static Mock<IWebClientWrapper> Wrapper;
    static AwaitResult<Foo> Result;

    Establish context = () =>
    {
      Wrapper = new Mock<IWebClientWrapper>();
      Wrapper.Setup(w => w.DownloadStringAsync(Moq.It.IsAny<string>()))
             .Returns(Task.FromResult(ValidJson));

      JsonWebServiceClassProvider = new JsonWebServiceClassProvider(Wrapper.Object);
    };

    Because of = () => Result = JsonWebServiceClassProvider.GetData<Foo>("ignored").Await();

    It should_return_a_class_of_same_type = () => Result.AsTask.Result.ShouldBeOfType<Foo>();
  }
}

【讨论】：

看了你的代码后，我让自己觉得发生了一些奇怪的事情。 Result.AsTask.Result 与 Task.Result 相同。所以，我的初始测试代码必须运行。我再次测试并工作。遇到这个问题已经快两天了，现在可以了！也许在我重构时解决了我的项目的问题？谢谢
我也有这个问题 - 过了这么多月，不知道你的代码对我有什么帮助 - 但我重新调整了这张图片，嘿presto

【解决方案2】：

我在 IoC 中使用这种方法：

1) 创建任务运行器接口和实现

public interface ITaskRunner
{
    Task<TNewResult> Execute<TResult, TNewResult>(Func<TResult> action, Func<Task<TResult>, TNewResult> continueWith);
}

public class TaskRunner : ITaskRunner
{
    public Task<TNewResult> Execute<TResult, TNewResult>(Func<TResult> action, Func<Task<TResult>, TNewResult> continueWith)
    {
        return Task.Factory.StartNew(action).ContinueWith(continueWith);
    }
}

及用法：

public Task<JsonResult> CheckForOnline(Int64? adId)
    {
        ITaskRunner taskRunner = IoCFactory.Instance.TryResolve<ITaskRunner>();
        return taskRunner.Execute(() => CheckForOnlineFunc(adId),
            r => Json(r.Result, JsonRequestBehavior.AllowGet));
    }

2) 创建在同步模式下运行 func 的 Fake 实现（无异步调用）

internal class FakeTaskRunner : ITaskRunner
{
    public Task<TNewResult> Execute<TResult, TNewResult>(Func<TResult> action, Func<Task<TResult>, TNewResult> continueWith)
    {
        Task<TResult> task = new Task<TResult>(action);
        try
        {
            task.RunSynchronously();
            if (task.Exception != null)
                throw task.Exception;
            return task.ContinueWith(continueWith);
        }
        catch (Exception ex)
        {
            throw ((AggregateException)ex).InnerExceptions[0];
        }
    }
}

因此，相同的代码将在实时版本中运行异步，在测试中运行异步。只需确保将 IoC 配置为在 live 中使用普通 TaskRunner，在测试中使用 FakeTaskRunner。

【讨论】：