如何避免用于单元测试目的的HttpContext.Server.MapPath

本文关键字：HttpContext MapPath Server 何避免 用于 单元测试 | 更新日期: 2023-09-27 17:57:40

我在ASP.net MVC 5应用程序中工作。我想对我的控制器动作进行单元测试，它看起来像这个

public ActionResult Search()
{
  var vm = SetupSearchViewModel();
  return View(vm);
}

所有的艰苦工作都是由SetupSearchViewModel()方法完成的，它本身就是一个协调器，调用许多不同的其他方法，其中之一就是这个

private string ExtractJsonFile(string filename)
{
  var filePath = HttpContext.Server.MapPath(filename);
  var json = System.IO.File.ReadAllText(filePath);
  return json;
}

我计划对这个特定的操作进行许多单元测试，但我从一个非常简单的单元测试开始，它检查是否返回了正确类型的ActionResult

[Test]
public void Search_Get_ReturnsViewResult()
{
  // arrange
  var performanceController = PerformanceControllerInstance;
  // act
  var result = performanceController.Search();
  //assert
  Assert.IsNotNull(result as ViewResult);
}

由于ExtractJsonFile方法，测试失败。它使用HttpContext，这就是null。我正在使用Rhino Mocks来模拟各种类。

单元测试的最佳方式是什么？Darin在这个线程中建议，如果我们想对代码进行单元测试，我们可以避免HttpContext.Current。

顺便说一句，我试着嘲笑HttpContext，并使其不为null，但Server就是null，我想我也可以继续嘲笑它（我还不知道怎么做），但没有更好的方法吗？如果需要的话，我可以进行重大的重构。

如何避免用于单元测试目的的HttpContext.Server.MapPath

HttpContext.Server.MapPath将需要一个在单元测试期间不存在的底层虚拟目录提供程序。抽象服务背后的路径映射，您可以对其进行模拟以使代码可测试。

public interface IPathProvider {
    string MapPath(string path);
}

在具体服务的实现中，您可以调用映射路径并检索文件。

public class ServerPathProvider: IPathProvider {
    public string MapPath(string path) {
        return HttpContext.Current.Server.MapPath(path);
    }
}

你可以将抽象注入你的控制器，或者在需要和使用的地方

public MyController : Controller {
    public MyController(IPathProvider pathProvider) {
        this.pathProvider = pathProvider;
    }
    //...other code removed for brevity
    private string ExtractJsonFile(string filename) {
      var filePath = pathProvider.MapPath(filename);
      var json = System.IO.File.ReadAllText(filePath);
      return json;
    }
}

使用您选择的模拟框架，您可以模拟提供商

[Test]
public void Search_Get_ReturnsViewResult() {
  // arrange
  IPathProvider mockedPathProvider = //...insert your mock/fake/stub here
  var performanceController = PerformanceControllerInstance(mockedPathProvider);
  // act
  var result = performanceController.Search();
  //assert
  Assert.IsNotNull(result as ViewResult);
}

并且不耦合到HttpContext

您甚至可以更进一步，将整个ExtractJsonFile(string filename)重构为自己的服务，以避免与磁盘绑定。

public interface IJsonProvider {
    string ExtractJsonFile(string filename);
}

该服务现在足够灵活，可以在需要时从web服务等其他来源获取文件。

相关文章：