在单元测试中设置HttpContext.Current.Session

我有一个web服务，我试图单元测试。在服务中，它从HttpContext中提取几个值，如下所示:

 m_password = (string)HttpContext.Current.Session["CustomerId"];
m_userID = (string)HttpContext.Current.Session["CustomerUrl"];

在单元测试中，我使用一个简单的工作请求创建上下文，如下所示:

SimpleWorkerRequest request = new SimpleWorkerRequest("", "", "", null, new StringWriter());
HttpContext context = new HttpContext(request);
HttpContext.Current = context;

然而，每当我试图设置HttpContext.Current.Session的值时

HttpContext.Current.Session["CustomerId"] = "customer1";
HttpContext.Current.Session["CustomerUrl"] = "customer1Url";

我得到空引用异常，表示HttpContext.Current.Session为空。

是否有方法在单元测试中初始化当前会话?

198081 次浏览
小开
最佳答案

我们必须通过使用HttpContextManager来模拟HttpContext，并从应用程序和单元测试中调用工厂

public class HttpContextManager
{
private static HttpContextBase m_context;
public static HttpContextBase Current
{
get
{
if (m_context != null)
return m_context;


if (HttpContext.Current == null)
throw new InvalidOperationException("HttpContext not available");


return new HttpContextWrapper(HttpContext.Current);
}
}


public static void SetCurrentContext(HttpContextBase context)
{
m_context = context;
}
}

然后，你可以用HttpContextManager.Current替换对HttpContext.Current的任何调用，并可以访问相同的方法。然后当你测试时，你也可以访问HttpContextManager并模拟你的期望

这是一个使用Moq的例子:

private HttpContextBase GetMockedHttpContext()
{
var context = new Mock<HttpContextBase>();
var request = new Mock<HttpRequestBase>();
var response = new Mock<HttpResponseBase>();
var session = new Mock<HttpSessionStateBase>();
var server = new Mock<HttpServerUtilityBase>();
var user = new Mock<IPrincipal>();
var identity = new Mock<IIdentity>();
var urlHelper = new Mock<UrlHelper>();


var routes = new RouteCollection();
MvcApplication.RegisterRoutes(routes);
var requestContext = new Mock<RequestContext>();
requestContext.Setup(x => x.HttpContext).Returns(context.Object);
context.Setup(ctx => ctx.Request).Returns(request.Object);
context.Setup(ctx => ctx.Response).Returns(response.Object);
context.Setup(ctx => ctx.Session).Returns(session.Object);
context.Setup(ctx => ctx.Server).Returns(server.Object);
context.Setup(ctx => ctx.User).Returns(user.Object);
user.Setup(ctx => ctx.Identity).Returns(identity.Object);
identity.Setup(id => id.IsAuthenticated).Returns(true);
identity.Setup(id => id.Name).Returns("test");
request.Setup(req => req.Url).Returns(new Uri("http://www.google.com"));
request.Setup(req => req.RequestContext).Returns(requestContext.Object);
requestContext.Setup(x => x.RouteData).Returns(new RouteData());
request.SetupGet(req => req.Headers).Returns(new NameValueCollection());


return context.Object;
}

然后在单元测试中使用它，我在Test Init方法中调用它

HttpContextManager.SetCurrentContext(GetMockedHttpContext());

然后，您可以在上面的方法中添加来自Session的预期结果，您希望它可以用于您的web服务。

小开

你可以通过创建一个新的HttpContext来“伪造它”，就像这样:

http://www.necronet.org/archive/2010/07/28/unit-testing-code-that-uses-httpcontext-current-session.aspx

我把这段代码放到一个静态helper类中，如下所示:

public static HttpContext FakeHttpContext()
{
var httpRequest = new HttpRequest("", "http://example.com/", "");
var stringWriter = new StringWriter();
var httpResponse = new HttpResponse(stringWriter);
var httpContext = new HttpContext(httpRequest, httpResponse);


var sessionContainer = new HttpSessionStateContainer("id", new SessionStateItemCollection(),
new HttpStaticObjectsCollection(), 10, true,
HttpCookieMode.AutoDetect,
SessionStateMode.InProc, false);


httpContext.Items["AspSession"] = typeof(HttpSessionState).GetConstructor(
BindingFlags.NonPublic | BindingFlags.Instance,
null, CallingConventions.Standard,
new[] { typeof(HttpSessionStateContainer) },
null)
.Invoke(new object[] { sessionContainer });


return httpContext;
}

或者不使用反射来构造新的HttpSessionState实例，你可以将你的HttpSessionStateContainer附加到HttpContext(根据Brent M. Spell的评论):

SessionStateUtility.AddHttpSessionStateToContext(httpContext, sessionContainer);

然后你可以像这样在单元测试中调用它:

HttpContext.Current = MockHelper.FakeHttpContext();
小开

对我有效的答案是@Anthony写的，但你必须添加另一行，这是

    request.SetupGet(req => req.Headers).Returns(new NameValueCollection());

所以你可以用这个:

HttpContextFactory.Current.Request.Headers.Add(key, value);
小开

我之前写过一些关于这方面的东西。

单元测试HttpContext.Current.Session in MVC3 .NET

希望能有所帮助。

[TestInitialize]
public void TestSetup()
{
// We need to setup the Current HTTP Context as follows:
 

// Step 1: Setup the HTTP Request
var httpRequest = new HttpRequest("", "http://localhost/", "");
 

// Step 2: Setup the HTTP Response
var httpResponce = new HttpResponse(new StringWriter());
 

// Step 3: Setup the Http Context
var httpContext = new HttpContext(httpRequest, httpResponce);
var sessionContainer =
new HttpSessionStateContainer("id",
new SessionStateItemCollection(),
new HttpStaticObjectsCollection(),
10,
true,
HttpCookieMode.AutoDetect,
SessionStateMode.InProc,
false);
httpContext.Items["AspSession"] =
typeof(HttpSessionState)
.GetConstructor(
BindingFlags.NonPublic | BindingFlags.Instance,
null,
CallingConventions.Standard,
new[] { typeof(HttpSessionStateContainer) },
null)
.Invoke(new object[] { sessionContainer });
 

// Step 4: Assign the Context
HttpContext.Current = httpContext;
}


[TestMethod]
public void BasicTest_Push_Item_Into_Session()
{
// Arrange
var itemValue = "RandomItemValue";
var itemKey = "RandomItemKey";
             

// Act
HttpContext.Current.Session.Add(itemKey, itemValue);
             

// Assert
Assert.AreEqual(HttpContext.Current.Session[itemKey], itemValue);
}
小开

Milox解决方案比IMHO所接受的要好，但是在使用querystring处理url时，我有一些问题。

我做了一些改变，使它能正常工作与任何url和避免反射。

public static HttpContext FakeHttpContext(string url)
{
var uri = new Uri(url);
var httpRequest = new HttpRequest(string.Empty, uri.ToString(),
uri.Query.TrimStart('?'));
var stringWriter = new StringWriter();
var httpResponse = new HttpResponse(stringWriter);
var httpContext = new HttpContext(httpRequest, httpResponse);


var sessionContainer = new HttpSessionStateContainer("id",
new SessionStateItemCollection(),
new HttpStaticObjectsCollection(),
10, true, HttpCookieMode.AutoDetect,
SessionStateMode.InProc, false);


SessionStateUtility.AddHttpSessionStateToContext(
httpContext, sessionContainer);


return httpContext;
}
小开

如果您正在使用MVC框架，这应该可以工作。我使用Milox的 FakeHttpContext并添加了一些额外的代码行。这个想法来自这个帖子:

http://codepaste.net/p269t8

这似乎在MVC 5中工作。我还没有尝试在早期版本的MVC。

HttpContext.Current = MockHttpContext.FakeHttpContext();


var wrapper = new HttpContextWrapper(HttpContext.Current);


MyController controller = new MyController();
controller.ControllerContext = new ControllerContext(wrapper, new RouteData(), controller);


string result = controller.MyMethod();
小开

你可以尝试FakeHttpContext:

using (new FakeHttpContext())
{
HttpContext.Current.Session["CustomerId"] = "customer1";
}
小开

试试这个:

        // MockHttpSession Setup
var session = new MockHttpSession();


// MockHttpRequest Setup - mock AJAX request
var httpRequest = new Mock<HttpRequestBase>();


// Setup this part of the HTTP request for AJAX calls
httpRequest.Setup(req => req["X-Requested-With"]).Returns("XMLHttpRequest");


// MockHttpContextBase Setup - mock request, cache, and session
var httpContext = new Mock<HttpContextBase>();
httpContext.Setup(ctx => ctx.Request).Returns(httpRequest.Object);
httpContext.Setup(ctx => ctx.Cache).Returns(HttpRuntime.Cache);
httpContext.Setup(ctx => ctx.Session).Returns(session);


// MockHttpContext for cache
var contextRequest = new HttpRequest("", "http://localhost/", "");
var contextResponse = new HttpResponse(new StringWriter());
HttpContext.Current = new HttpContext(contextRequest, contextResponse);


// MockControllerContext Setup
var context = new Mock<ControllerContext>();
context.Setup(ctx => ctx.HttpContext).Returns(httpContext.Object);


//TODO: Create new controller here
//      Set controller's ControllerContext to context.Object

并添加类:

public class MockHttpSession : HttpSessionStateBase
{
Dictionary<string, object> _sessionDictionary = new Dictionary<string, object>();
public override object this[string name]
{
get
{
return _sessionDictionary.ContainsKey(name) ? _sessionDictionary[name] : null;
}
set
{
_sessionDictionary[name] = value;
}
}


public override void Abandon()
{
var keys = new List<string>();


foreach (var kvp in _sessionDictionary)
{
keys.Add(kvp.Key);
}


foreach (var key in keys)
{
_sessionDictionary.Remove(key);
}
}


public override void Clear()
{
var keys = new List<string>();


foreach (var kvp in _sessionDictionary)
{
keys.Add(kvp.Key);
}


foreach(var key in keys)
{
_sessionDictionary.Remove(key);
}
}
}

这将允许您同时测试会话和缓存。

小开

在asp.net Core / MVC 6 rc2中，你可以设置HttpContext

var SomeController controller = new SomeController();


controller.ControllerContext = new ControllerContext();
controller.ControllerContext.HttpContext = new DefaultHttpContext();
controller.HttpContext.Session = new DummySession();

Rc 1为

var SomeController controller = new SomeController();


controller.ActionContext = new ActionContext();
controller.ActionContext.HttpContext = new DefaultHttpContext();
controller.HttpContext.Session = new DummySession();

https://stackoverflow.com/a/34022964/516748 < a href = " https://stackoverflow.com/a/34022964/516748 " > < / >

考虑使用Moq

new Mock<ISession>();
小开

@Ro Hit给出的答案对我帮助很大，但我缺少用户凭据，因为我必须伪造一个用户进行身份验证单元测试。因此，让我描述一下我是如何解决它的。

根据这，如果你添加方法

    // using System.Security.Principal;
GenericPrincipal FakeUser(string userName)
{
var fakeIdentity = new GenericIdentity(userName);
var principal = new GenericPrincipal(fakeIdentity, null);
return principal;
}

然后追加

    HttpContext.Current.User = FakeUser("myDomain\\myUser");

到TestSetup方法的最后一行你就完成了，用户凭证被添加并准备用于身份验证测试。

我还注意到HttpContext中还有其他你可能需要的部分，比如.MapPath()方法。有一个FakeHttpContext可用，它是这里描述，可以通过NuGet安装。

小开

我正在寻找一种比上面提到的选项更少侵入性的东西。最后，我提出了一个俗气的解决方案，但它可能会让一些人行动得更快一些。

首先，我创建了一个TestSession类:

class TestSession : ISession
{


public TestSession()
{
Values = new Dictionary<string, byte[]>();
}


public string Id
{
get
{
return "session_id";
}
}


public bool IsAvailable
{
get
{
return true;
}
}


public IEnumerable<string> Keys
{
get { return Values.Keys; }
}


public Dictionary<string, byte[]> Values { get; set; }


public void Clear()
{
Values.Clear();
}


public Task CommitAsync()
{
throw new NotImplementedException();
}


public Task LoadAsync()
{
throw new NotImplementedException();
}


public void Remove(string key)
{
Values.Remove(key);
}


public void Set(string key, byte[] value)
{
if (Values.ContainsKey(key))
{
Remove(key);
}
Values.Add(key, value);
}


public bool TryGetValue(string key, out byte[] value)
{
if (Values.ContainsKey(key))
{
value = Values[key];
return true;
}
value = new byte[0];
return false;
}
}

然后我在控制器的构造函数中添加了一个可选参数。如果该参数存在，则将其用于会话操作。否则，使用HttpContext。会话:

class MyController
{


private readonly ISession _session;


public MyController(ISession session = null)
{
_session = session;
}




public IActionResult Action1()
{
Session().SetString("Key", "Value");
View();
}


public IActionResult Action2()
{
ViewBag.Key = Session().GetString("Key");
View();
}


private ISession Session()
{
return _session ?? HttpContext.Session;
}
}

现在我可以将TestSession注入到控制器中:

class MyControllerTest
{


private readonly MyController _controller;


public MyControllerTest()
{
var testSession = new TestSession();
var _controller = new MyController(testSession);
}
}
小开

我发现以下简单的解决方案指定一个用户在HttpContext: https://forums.asp.net/post/5828182.aspx

小开

从不嘲弄。从来没有!解决方法非常简单。为什么要伪造像HttpContext这样美丽的创造呢?

下推会话!(这句话对我们大多数人来说已经足够理解了，但下面会详细解释)

(string)HttpContext.Current.Session["CustomerId"];是我们现在访问它的方式。将其更改为

_customObject.SessionProperty("CustomerId")

当从test调用时，_customObject使用替代存储(DB或云键值[http://www.kvstore.io/]])

但是当从实际应用程序调用时，_customObject使用Session。

这是怎么做到的?嗯…依赖注入!

因此test可以设置会话(地下)，然后调用应用程序方法，就好像它对会话一无所知一样。然后测试秘密地检查应用程序代码是否正确地更新了会话。或者应用程序是否基于测试设置的会话值进行操作。

事实上，我们最终还是嘲笑了，尽管我说过:“永远不要嘲笑”。因为我们忍不住溜到下一个规则，“嘲笑最不疼的地方!”模仿巨大的HttpContext或模仿一个小的会话，哪个伤害最小?别问我这些规矩是从哪来的。我们就说常识吧。这里有一个关于不模仿因为单元测试会杀死我们的有趣阅读

小开

试试这个方法。

public static HttpContext getCurrentSession()
{
HttpContext.Current = new HttpContext(new HttpRequest("", ConfigurationManager.AppSettings["UnitTestSessionURL"], ""), new HttpResponse(new System.IO.StringWriter()));
System.Web.SessionState.SessionStateUtility.AddHttpSessionStateToContext(
HttpContext.Current, new HttpSessionStateContainer("", new SessionStateItemCollection(), new HttpStaticObjectsCollection(), 20000, true,
HttpCookieMode.UseCookies, SessionStateMode.InProc, false));
return HttpContext.Current;
}

提交答案