web-dev-qa-db-ja.com

単体テストで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がnullであるというnull参照例外が発生します。

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

c#web-servicesunit-testinghttpcontext
171
DaveB

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からの予想結果を追加できます。

99
Anthony Shaw

次のような新しい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://stackoverflow/", "");
    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();
277
Milox

Miloxソリューション は受け入れられているものよりも優れていますが、 クエリ文字列でURLを処理するときにこの実装に問題がありました 。

URLが正しく機能するように、またReflectionを回避するために、いくつかの変更を加えました。

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

私は少し前にこれについて何かを心配しています。

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);
}
36
Ro Hit

MVCフレームワークを使用している場合、これは機能するはずです。 Milox's 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();
12
Nimblejoe

試すことができます FakeHttpContext ：

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

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>();
7
KCD

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

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

これを使用できます：

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

決してm笑しないでください。解決策は非常に簡単です。 HttpContextのような美しい作品を偽造するのはなぜですか？

セッションをプッシュダウンします！ （この行はほとんどの人が理解するのに十分ですが、以下で詳細に説明します）

(string)HttpContext.Current.Session["CustomerId"];は、現在のアクセス方法です。これを

_customObject.SessionProperty("CustomerId")

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

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

これはどのように行われますか？さて...依存性注入！

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

実は、「決してモックをしない」と言っても、私たちは結局モックをしました。私たちは次のルール、「それが最も痛くない場所をモック！」に身を任せずにはいられませんでした。巨大なHttpContextをモックするか、小さなセッションをモックします。これらのルールがどこから来たのか聞かないでください。常識を言ってみましょう。ここに、モックではないという興味深い読み物があります 単体テストで殺される可能性があるため

1
Blue Clouds

これを試して：

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

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

1
Isaac Alvarado

上記のオプションよりも少し侵襲性の低いものを探していました。最終的に私は安っぽい解決策を思いつきましたが、それは一部の人々を少し速く動かすかもしれません。

最初に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);
    }
}
1
Chris Hanson

答え@ Ro Hitは多くの助けになりましたが、ユーザーを偽造しなければならなかったため、ユーザーの資格情報が欠落していました認証ユニットのテスト用。したがって、私がそれをどのように解決したかを説明しましょう。

this に従って、メソッドを追加する場合

    // 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には他にも必要な部分があることに気付きました。利用可能なFakeHttpContextがあります。これは ここで説明 で、NuGetを介してインストールできます。

0
Matt

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

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;
  }
0
Ranjan Singh

HttpContextでユーザーを指定するための次の簡単なソリューションを見つけました。 https://forums.asp.net/post/5828182.aspx

0
Lars Ladegaard