c# - 使用 HttpClient 对发出 Http 请求的 Controller 进行单元测试

Question

我需要为此 Controller 编写单元测试(最重要的是，我被要求获得代码覆盖率)。

public class MyController : Controller
{
    public async Task<ActionResult> Index()
    {
        ViewBag.Title = "Home Page";
        var httpClient = new HttpClient();
        var json = await httpClient.GetStringAsync(ConfigurationManager.AppSettings["MyCustomAPI"]);
        var tasks = JsonConvert.DeserializeObject<List<MyObject>>(json);
        return View(tasks);
    }
}

两天来我一直在阅读有关此的想法，但我无法全神贯注。

我一直在考虑像这样注入(inject) HttpClient:

    private readonly HttpClient _httpClient;

    public TasksController(HttpClient httpClient)
    {
        _httpClient = httpClient;
    }

但是在 Controller 构造函数中传递 HttpClient 可能不是一个好主意。

然后我一直在关注this使用 FakeItEasy 的指南，但我无法根据我的要求调整此解决方案。

我应该如何进行测试？

Answer 1

将您的 http 工作提取到一个接口(interface)中，并将该接口(interface)的实现注入(inject)到您的 Controller 中。

public interface INetworkService {
  Task<List<MyObject>> GetThingsAsync(string api);
}

public class HttpNetworkService : INetworkService {
  private readonly HttpClient Client;
  public HttpNetworkService(HttpClient client) {
    Client = client;
  }

  public Task<List<MyObject>> GetThingsAsync(string api) {
    var json = await Client.GetStringAsync(api);
    return JsonConvert.DeserializeObject<List<MyObject>>(json);
  }
}

public class TestNetworkService : INetworkService {
  public Task<List<MyObject>> GetThingsAsync(string api) {
    return Task.FromResult(new List<MyObject> { /*build out your mock result here*/ });
  }
}

public class MyController : Controller {
  private readonly INetworkService NetworkService;
  public MyController(INetworkService svc) {
    NetworkService = svc;
  }

  public async Task<ActionResult> Index() {
    ViewBag.Title = "Home Page";
    var tasks = await NetworkService.GetThingsAsync(ConfigurationManager.AppSettings["MyCustomAPI"]);
    return View(tasks);
  }
}

现在，当您进行测试时，您可以加入 INetworkService 的测试版本，该版本实际上不执行任何网络 IO。此外，如评论中所述，您应该共享一个 HttpClient 而不是一直创建新的，该客户端可以注入(inject)到真正的 INetworkedService 实现中。