単体テストで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";

nullであるというnull参照例外が発生しHttpContext.Current.Sessionます。

単体テスト内で現在のセッションを初期化する方法はありますか？

をHttpContext使用してHttpContextManager、アプリケーション内からファクトリーを呼び出し、単体テストをモックする必要がありました。

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;
    }
}

あなたは、その後に任意の呼び出しを置き換えるだろうHttpContext.CurrentとHttpContextManager.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());

次に、上記のメソッドで、Webサービスで利用できると予想されるSessionからの予想される結果を追加できます。

あなたはHttpContextこのような新しいものを作成することによって「それを偽造」することができます：

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

私はそのコードを取得して、静的ヘルパークラスに次のように配置しました。

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（ブレントM.スペルさんのコメントによります）：

SessionStateUtility.AddHttpSessionStateToContext(httpContext, sessionContainer);

そして、あなたはあなたのようなユニットテストでそれを呼び出すことができます：

HttpContext.Current = MockHelper.FakeHttpContext();

Miloxソリューションは、受け入れられているIMHOよりも優れていますが、クエリ文字列で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;
}

しばらく前にこれについて何か悩みました。

MVC3 .NETでのHttpContext.Current.Sessionの単体テスト

それが役に立てば幸い。

[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);
}

MVCフレームワークを使用している場合、これは機能するはずです。Miloxを使用しました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";       
}

私と一緒に働いた答えは@Anthonyが書いたものですが、次の行を追加する必要があります

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

これを使用できます：

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

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

使用を検討してください Moq

new Mock<ISession>();

これを試して：

        // 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);
        }
    }
}

これにより、セッションとキャッシュの両方でテストできます。

上記のオプションよりも少し侵襲性の低いものを探していました。結局私は安っぽい解決策を思いついたが、一部の人々は少し速く動くかもしれない。

まず、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.Sessionを使用します。

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ですか？

セッションを押し下げてください！（この行でほとんどの人が理解できますが、以下で詳しく説明します）

(string)HttpContext.Current.Session["CustomerId"];私たちが現在それにアクセスする方法です。これを

_customObject.SessionProperty("CustomerId")

テストから呼び出されると、_customObjectは代替ストアを使用します（DBまたはクラウドキー値[ http://www.kvstore.io/]）

ただし、実際のアプリケーションから呼び出された場合は、を_customObject使用しSessionます。

これどうやって？まあ...依存性注入！

そのため、テストはセッション（地下）を設定し、セッションについて何も知らないようにアプリケーションメソッドを呼び出すことができます。次に、アプリケーションコードがセッションを正しく更新したかどうかを密かにテストします。または、アプリケーションがテストによって設定されたセッション値に基づいて動作する場合。

実際、私は「決してモックしない」と言っていても、私たちはあざけることになりました。私たちが仕方がなかったので、次のルール、「それが最も痛くないところを模擬してください！」に進んでください。巨大なHttpContextものをあざけるか、小さなセッションをあざけるか、どれが一番痛いですか？これらのルールがどこから来たのか私に尋ねないでください。常識だけを言いましょう。ユニットテストは私たちを殺すことができるので、モックしないことについての興味深い読みです

@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メソッドの最後の行に、ユーザー資格情報が追加され、認証テストに使用できるようになります。

また、.MapPath()メソッドなど、HttpContextに必要な他の部分があることにも気付きました。ここで説明し、NuGetを介してインストールできるFakeHttpContextが利用可能です。

HttpContextでユーザーを指定するための次の簡単な解決策を見つけました：https : //forums.asp.net/post/5828182.aspx

この方法を試してください。

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;
  }