如何正确地集成测试Web Api控制器与IEnumerable结果?

时间:2015-07-16 10:42:25

标签: c# asp.net asp.net-mvc linq

原始问题有点不正确,因为问题仅在控制器测试How to return correct status code when enumeration of IEnumerable fails. ASP.NET WebApi

期间发生

问题是如何正确测试web api控制器,当IEnumerable在延迟执行期间可能抛出异常时,它返回IEnumerable?

E.g。我有这样的API端点:

public class EntityController : ApiController
{
    ...
    public IHttpActionResult Get()
    {
        return Ok(Session.Query<Entity>());
    }
}

无论在查询执行期间可能抛出异常,相应的测试都将始终通过。

[Test]
public async Task Test()
{
     var entityController = new EntityController(Session)
                {
                    Configuration = new HttpConfiguration(),
                    Request = new HttpRequestMessage()
                };

    var response = await entityController.GetAll().ExecuteAsync(new CancellationTokenSource().Token);

    response.EnsureSuccessStatusCode();
}

但是,如果在控制器内部强制转换ToList,则此测试不会通过。

public class EntityController : ApiController
{
    ...
    public IHttpActionResult Get()
    {
        return Ok(Session.Query<Entity>().ToList());
    }
}

1 个答案:

答案 0 :(得分:7)

在我看来,您希望创建集成测试来测试您的Web api端点。

您当前的测试无法访问媒体类型格式化程序或可能发生问题的Web API管道的其他部分。

我建议在测试项目中使用Microsoft.Owin.Testing nuget包。这将允许您在内存中的Web服务器中设置Web api控制器以进行测试,这将涵盖更多的web api管道。

根据您的代码片段判断,您的web api控制器与System.Web没有任何依赖关系,因此使用OWIN进行测试可能符合您的需求。当然,这将涵盖特定于IIS设置的任何内容或Web api之外的IIS管道中的任何内容。但是,如果您在控制器操作中未使用Linq query,它将捕获ToList()的延迟执行引发的异常。

要使用Owin和Owin测试,您需要按照以下步骤操作:

1。将Microsoft.Owin nuget包添加到包含您要测试的Web api控制器的Web项目中。

2。将Owin Startup类添加到该Web项目:

public class Startup {
    public virtual void Configuration(IAppBuilder builder) {
        // if you want to move all your web api initialization 
        // and configuration to here then you can. 
        // Otherwise just leave this method empty
    }
}

我们将覆盖测试项目中的Configuration方法。

3。将Microsoft.AspNet.WebApi.Owin nuget包添加到测试项目

4。将Microsoft.Owin.Testing nuget包添加到测试项目中。

5。在测试项目中创建一个Test类:

public class TestClass {
    private class TestStartup : Startup {
        public override void Configuration(IAppBuilder app) {
            // do your web api, IoC, etc setup here
            var config = new HttpConfiguration();
            config.MapHttpAttributeRoutes();
            // ...etc
            app.UseWebApi(config);
        }
    }

    [Test]
    public void MyTest() {
        // arrange
        using (var server = TestServer.Create<TestStartup>()) {

            // act
            var response = server.CreateRequest("api/someroute/").GetAsync().Result;

            // verify
            Assert.Equal(HttpStatusCode.InternalServerError, response.StatusCode);
        }
    }
}

确保TestStartup内部类派生自第2步中在您的Web项目中创建的Startup类,这将确保web api将从Web项目中获取您的控制器。还有其他方法,但这很简单,并且如果您使用Owin,则能够重用实际应用程序中的初始化代码。

6。利润