在ASP.NET WebApi 2中测试OWIN中间件:如何设置cookie?

时间:2018-11-01 10:39:34

标签: c# unit-testing cookies owin

我正在尝试在ASP.NET WebApi 2应用程序中测试OWIN中间件组件。中间件应该查看传入请求的cookie,在将请求交给下一个组件之前对其进行一些修改,并有可能在退出过程中设置cookie。

让我感到困扰的是OwinRequest.Cookies属性的类型为RequestCookieCollection,它似乎不允许修改,并且该属性本身是只读的,这意味着我不能使用RequestCookieCollection(IDictionary<string,string>)构造函数可以使用其中的cookie初始化集合,并根据请求进行设置。

我想做这样的事情:

var context = new OwinContext();
// option 1:
context.Request.Cookies.Append("cookie-name", "cookie-value");
// option 2:
var cookies = new RequestCookieCollection(new Dictionary<string, string>{ { "cookie-name", "cookie-value" } });
context.Request.Cookies = cookies;

await myMiddleware.Invoke(context);

// Assert stuff about context.Response

但是由于上述原因,该方法不起作用。

我本来希望不必完全模拟IOwinContext,因为使用功能良好的RequestResponse对象进行设置非常方便(我需要,尤其是东西,请查看我的实现中的Request.User.Identity.IsAuthenticated

1 个答案:

答案 0 :(得分:1)

使用以下内容作为示例中间件进行单元测试

using RequestDelegate = Func<IOwinContext, Task>;

class MyMiddleware {
    private readonly RequestDelegate next;

    public MyMiddleware(RequestDelegate next) {
        this.next = next;
    }

    public async Task Invoke(IOwinContext context) {
        //The middleware is supposed to look at the cookies of the incoming request, 
        var request = context.Request;
        var authenticated = request.User.Identity.IsAuthenticated;

        var cookies = request.Cookies;
        if (cookies["cookie-name"] != null) {
            // 1. check for existence of a cookie on the incoming request. 
            //if the cookie exists, use its value to set a header, 
            //so that the pipline after this component thinks the header was always present.
            request.Headers.Append("header-name", "header-value");
        }

        //2. call the next component.
        await next.Invoke(context);

        //3. on the way out, check for some conditions, and possibly set a cookie value.
        if (authenticated) {
            context.Response.Cookies.Append("cookie-name", "cookie-value");
        }
    }
}

并使用提供的有关所需行为的详细信息,

要用完整的OwinContext所需的所有管道对控制器进行单元测试是很困难的。

您已经说明了访问某些成员时的许多限制。

但是,Owin提供了许多抽象方法,可以对孤立的单元测试进行模拟/插入/伪造所需的行为。

以下示例基于上面提供的主题,并使用Moq模拟框架以及具体的实现为主题中间件正确设置和执行隔离的单元测试。

[TestClass]
public class OwinMiddlewareCookiesTest {
    [Test]
    public async Task MyMiddleware_Should_Set_RequestHeader_And_ResponseHeader() {
        //Arrange
        var cookieStore = new Dictionary<string, string> { { "cookie-name", "cookie-value" } };
        var cookies = new RequestCookieCollection(cookieStore);

        var request = Mock.Of<IOwinRequest>();
        var requestMock = Mock.Get(request);
        requestMock.Setup(_ => _.Cookies).Returns(cookies);
        requestMock.Setup(_ => _.User.Identity.IsAuthenticated).Returns(true);
        requestMock.Setup(_ => _.Headers.Append(It.IsAny<string>(), It.IsAny<string>()));

        var response = new OwinResponse();

        var context = Mock.Of<OwinContext>();
        var contextMock = Mock.Get(context);
        contextMock.CallBase = true;
        contextMock.Setup(_ => _.Request).Returns(request);
        contextMock.Setup(_ => _.Response).Returns(response);

        RequestDelegate next = _ => Task.FromResult((object)null);

        var myMiddleware = new MyMiddleware(next);

        //Act
        await myMiddleware.Invoke(context);

        //Assert
        requestMock.Verify(_ => _.Headers.Append("header-name", "header-value"));
        response.Headers.ContainsKey("Set-Cookie");
    }
}

只需要模拟必要的依赖关系,测试就可以完成并验证预期的行为。

并且由于无法实现请求实现的Cookies属性,因此必须使用抽象。但是,这为模拟所需行为提供了更大的灵活性。