测试使用HttpContext.Current.Request.Files的Web API方法?

时间:2015-07-02 15:42:06

标签: c# unit-testing asp.net-web-api moq httpcontext

我正在尝试为使用HttpContext.Current.Request.Files的Web API方法编写测试,经过详尽的搜索和实验后,我无法弄清楚如何模拟它。正在测试的方法如下所示:

[HttpPost]
public HttpResponseMessage Post()
{
    var requestFiles = HttpContext.Current.Request.Files;
    var file = requestFiles.Get(0);
    //do some other stuff...
}

我意识到有other questions similar to this,但他们没有解决这种特定情况。

如果我试图模拟上下文,我会遇到Http*对象层次结构的问题。假设我设置了各种模拟对象(使用Moq),如下所示:

var mockFiles = new Mock<HttpFileCollectionBase>();
mockFiles.Setup(s => s.Count).Returns(1);
var mockFile = new Mock<HttpPostedFileBase>();
mockFile.Setup(s => s.InputStream).Returns(new MemoryStream());
mockFiles.Setup(s => s.Get(It.IsAny<int>())).Returns(mockFile.Object);
var mockRequest = new Mock<HttpRequestBase>();
mockRequest.Setup(s => s.Files).Returns(mockFiles.Object);
var mockContext = new Mock<HttpContextBase>();
mockContext.Setup(s => s.Request).Returns(mockRequest.Object);

尝试将其分配给当前上下文...

HttpContext.Current = mockContext.Object;

...导致编译器错误/红线,因为它Cannot convert source type 'System.Web.HttpContextBase' to target type 'System.Web.HttpContext'

我还尝试钻进构造的控制器对象附带的各种上下文对象,但找不到a)是控制器方法体中HttpContext.Current调用的返回对象,b)提供访问标准HttpRequest属性,例如Files

var requestMsg = controller.Request;   //returns HttpRequestMessage
var context = controller.ControllerContext;  //returns HttpControllerContext
var requestContext = controller.RequestContext;   //read-only returns HttpRequestContext

同样重要的是要注意我无法更改我正在测试的控制器,因此我无法更改构造函数以允许注入上下文。

有没有办法在Web API中模拟HttpContext.Current.Request.Files进行单元测试?

更新
虽然我不确定这是否会被团队接受,但我正在尝试按照Martin Liversage的建议更改Post方法以使用Request.Content。它目前看起来像这样:

public async Task<HttpResponseMessage> Post()
{
    var uploadFileStream = new MultipartFormDataStreamProvider(@"C:\temp");
    await Request.Content.ReadAsMultipartAsync(uploadFileStream);
    //do the stuff to get the file
    return ActionContext.Request.CreateResponse(HttpStatusCode.OK, "it worked!");
}

我的测试看起来与此相似:

var byteContent = new byte[]{};
var content = new MultipartContent { new ByteArrayContent(byteContent) };
content.Headers.Add("Content-Disposition", "form-data");
var controllerContext = new HttpControllerContext 
{
    Request = new HttpRequestMessage
        {
            Content = new MultipartContent { new ByteArrayContent(byteContent) }
        }
};

现在我在ReadAsMultipartAsync上收到错误:

System.IO.IOException: Error writing MIME multipart body part to output stream. ---> System.InvalidOperationException: The stream provider of type 'MultipartFormDataStreamProvider' threw an exception. ---> System.InvalidOperationException: Did not find required 'Content-Disposition' header field in MIME multipart body part.

3 个答案:

答案 0 :(得分:24)

通过允许您模拟各种上下文对象,构建Web API以支持单元测试。但是,使用HttpContext.Current你正在使用&#34;旧式&#34;使用System.Web类的HttpContext代码,无法对代码进行单元测试。

要允许您的代码可以进行单元测试,您必须停止使用HttpContext.Current。在Sending HTML Form Data in ASP.NET Web API: File Upload and Multipart MIME中,您可以看到如何使用Web API上传文件。具有讽刺意味的是,此代码还使用HttpContext.Current来访问MapPath,但在Web API中,您应该使用也在IIS外部工作的HostingEnvironment.MapPath。嘲笑后者也存在问题但现在我专注于你关于嘲笑请求的问题。

不使用HttpContext.Current允许您通过分配控制器的ControllerContext属性对控制器进行单元测试:

var content = new ByteArrayContent( /* bytes in the file */ );
content.Headers.Add("Content-Disposition", "form-data");
var controllerContext = new HttpControllerContext {
  Request = new HttpRequestMessage {
    Content = new MultipartContent { content }
  }
};
var controller = new MyController();
controller.ControllerContext = controllerContext;

答案 1 :(得分:2)

对于OP的问题,接受的答案是完美的。我想在这里添加我的解决方案,它源自Martin's,因为这是我在简单搜索如何模拟Web API的Request对象时被引导到的页面,因此我可以添加Controller正在查找的头文件。我很难找到简单的答案:

   var controllerContext = new HttpControllerContext();
   controllerContext.Request = new HttpRequestMessage();
   controllerContext.Request.Headers.Add("Accept", "application/xml");

   MyController controller = new MyController(MockRepository);
   controller.ControllerContext = controllerContext;

你在那里;一种非常简单的方法来创建控制器上下文,您可以使用它“模拟”Request对象并为Controller方法提供正确的标头。

答案 2 :(得分:-1)

我只是嘲笑发布的文件。我相信所有文件也可以通过这种方式来模拟。

  

这是在我的控制器中

private HttpPostedFileBase _postedFile;

/// <summary>
/// For mocking HttpPostedFile
/// </summary>
public HttpPostedFileBase PostedFile
{
    get
    {
        if (_postedFile != null) return _postedFile;
        if (HttpContext.Current == null)
        {
            throw new InvalidOperationException("HttpContext not available");
        }
        return new HttpContextWrapper(HttpContext.Current).Request.Files[0];
    }
    set { _postedFile = value; }
}

[HttpPost]
public MyResponse Upload()
{
    if (!ValidateInput(this.PostedFile))
    {
        return new MyResponse
        {
            Status = "Input validation failed"
        };
    }
}

private bool ValidateInput(HttpPostedFileBase file)
{
    if (file.ContentLength == 0)
        return false;

    if (file.ContentType != "test")
        return false;

    if (file.ContentLength > (1024 * 2048))
        return false;

    return true
}
  

这是在我的单元测试用例中

public void Test1()
{
    var controller = new Mock<MyContoller>();
    controller.Setup(x => x.Upload).Returns(new CustomResponse());

    controller.Request = new HttpRequestMessage();
    controller.Request.Content = new StreamContent(GetContent());
    controller.PostedFile = GetPostedFile();

    var result = controller.Upload().Result;
}

private HttpPostedFileBase GetPostedFile()
{
    var postedFile = new Mock<HttpPostedFileBase>();
    using (var stream = new MemoryStream())
    using (var bmp = new Bitmap(1, 1))
    {
        var graphics = Graphics.FromImage(bmp);
        graphics.FillRectangle(Brushes.Black, 0, 0, 1, 1);
        bmp.Save(stream, ImageFormat.Jpeg);
        postedFile.Setup(pf => pf.InputStream).Returns(stream);
        postedFile.Setup(pf => pf.ContentLength).Returns(1024);
        postedFile.Setup(pf => pf.ContentType).Returns("bmp");
    }
    return postedFile.Object;
}
  

虽然,我无法成功模拟HTTPContext。但是我   能够模拟文件上传。