HowTo: HttpContext, HttpRequest & HttpResponse in MVC Controllern testen & mocken

Eines der top Gründe für ASP.NET MVC ist die gute Testbarkeit. Doch wie testet man eigentlich? Insbesondere wenn man mit HttpContext, HttpRequest und HttpResponse rumbastelt? Hier ein kleiner Leitfaden...

HttpContext

Als kleines Vorwort: HttpContext.Current ist böse. Weil nicht testbar (jedenfalls würde ich das jetzt mal eiskalt behaupten ohne irgendwelches seltsamen Tools zu benutzen). Doch im HttpContext stecken recht viele interessante Dinge. Jegliche Information über den Browser bekommt man über das Request Objekt. Cookies erstellt man, indem man sie in die Response schreibt. Wenn man solche Sachen in seiner Applikationslogik verwendet hat man folgende Möglichkeiten:

• Gar nicht erst sowas testen (ungünstige Idee)
• Einen Binder benutzen und die Werte als Parameter mit reingeben
• Allerdings greift dann spätestens der Binder auf den HttpContext zu...
• Oder wir mocken das ganze.

Szenario

Folgendes Szenario: Ich geh auf die Home/Index Seite und möchte den Browser UserAgent auslesen und gleichzeitig ein Cookie erstellen. Das ganze will ich mit Unit Tests testen.

Als Testframework nutze ich NUnit und als Mocking Framework Moq. Andere Frameworks können das aber auch.

Durch unser Szenario haben wir folgende Fälle:

Wenn die HomeController Index Methode aufgerufen wird...

<ul> <li>dann wird der Useragent ausgelesen</li> <li>dann wird ein Cookie erstellt</li> </ul> <p>
</p> <p>Wer Fragen zum Style von den Unit Tests hat, dem empfehle ich Thomas Bandts TDD Post.</p> <p>Der Testcode</p> <p>Erstmal der gesamte Testcode - unten folgt im Detail die Erklärung:</p> <div style="padding-bottom: 0px; margin: 0px; padding-left: 0px; padding-right: 0px; display: inline; float: none; padding-top: 0px" id="scid:812469c5-0cb0-4c63-8c15-c81123a09de7:4e2ea4d7-dc4d-4fe5-a201-00c52b2bd2f2" class="wlWriterEditableSmartContent"><pre name="code" class="c#"> [TestFixture] public class When_HomeController_Index_is_called { protected HomeController Sut; protected Mock<HttpContextBase> _httpContextBaseMock; protected Mock<HttpRequestBase> _httpRequestBaseMock; protected Mock<HttpResponseBase> _httpRepsonseBaseMock; protected HttpCookieCollection _cookieCollection; protected string _expectedUserAgentInViewBagMessage; protected HttpCookie _expectedCookie;

    protected ViewResult _result;

    [TestFixtureSetUp]
    public void Arrange()
    {
        _expectedUserAgentInViewBagMessage = "HelloTDDInMVC";
        _expectedCookie = new HttpCookie("HelloTDDInCookie");

        // Request expectations
        this._httpRequestBaseMock = new Mock<HttpRequestBase>();
        this._httpRequestBaseMock.Setup(x => x.UserAgent).Returns(this._expectedUserAgentInViewBagMessage);

        // Response expectations
        _cookieCollection = new HttpCookieCollection();
        this._httpRepsonseBaseMock = new Mock<HttpResponseBase>();
        this._httpRepsonseBaseMock.Setup(x => x.Cookies).Returns(_cookieCollection);


        // HttpContext expectations
        this._httpContextBaseMock = new Mock<HttpContextBase>();
        this._httpContextBaseMock.Setup(x => x.Request).Returns(this._httpRequestBaseMock.Object);
        this._httpContextBaseMock.Setup(x => x.Response).Returns(this._httpRepsonseBaseMock.Object);

        // Arrang Sut
        this.Sut = new HomeController();
        this.Sut.ControllerContext = new ControllerContext();
        this.Sut.ControllerContext.HttpContext = this._httpContextBaseMock.Object;
    }

    public void Act()
    {
        this._result = (ViewResult)this.Sut.Index();
    }

    [Test]
    public void Then_the_Request_UserAgent_should_be_read()
    {
        Act();
        Assert.AreEqual(this._expectedUserAgentInViewBagMessage, this._result.ViewBag.Message);
    }

    [Test]
    public void Then_a_Cookie_should_be_added_to_the_Response()
    {
        Act();
        Assert.AreSame(this._expectedCookie.Value, this._cookieCollection[this._expectedCookie.Name].Value);
    }
}</pre></div>

Um nicht auf HttpContext.Current zuzugreifen gibt es im ControllerContext ein Property namens HttpContext. Diesen können wir in einem Unit Test auch selber setzen. Dies wird auf Zeile 38 gemacht. In den Zeilen drüber erstlelle ich mir mein Context/Request/Response Mock und setze zudem noch meinen UserAgentden ich erwarte und mein HttpCookie, welches ich hinterher in der Response haben möchte.

            _expectedUserAgentInViewBagMessage = "HelloTDDInMVC";
            _expectedCookie = new HttpCookie("HelloTDDInCookie");

Da es sich bei Context/Response/Request nur um Mocks handelt muss man diese genau sagen, was passieren soll.

In Zeile 21/22 sage ich, dass es ein HttpRequestBase (HttpRequest ist nicht mockbar, daher wurden die "...Base” Klassen eingeführt) mock gibt, welches beim Zugreifen auf den UserAgent meinen eigenen UserAgent aus Zeile 17 zurückliefert.

            this._httpRequestBaseMock = new Mock<HttpRequestBase>();
            this._httpRequestBaseMock.Setup(x => x.UserAgent).Returns(this._expectedUserAgentInViewBagMessage);

Im Response (Zeile 25-27) sage ich, dass wenn auf Cookies zugegriffen wird, soll die _cookieCollection zurückgegeben werden. Diese ist aber hier leer und enthält in diesem Schritt noch nicht mein erwartetes Cookie von Zeile 18.

            _cookieCollection = new HttpCookieCollection();
            this._httpRepsonseBaseMock = new Mock<HttpResponseBase>();
            this._httpRepsonseBaseMock.Setup(x => x.Cookies).Returns(_cookieCollection);

Nun füge ich dies noch zu dem HttpContext hinzu:

            this._httpContextBaseMock = new Mock<HttpContextBase>();
            this._httpContextBaseMock.Setup(x => x.Request).Returns(this._httpRequestBaseMock.Object);
            this._httpContextBaseMock.Setup(x => x.Response).Returns(this._httpRepsonseBaseMock.Object);

Mein Sut (System Under Test) ist der HomeController.

 this.Sut = new HomeController();
            this.Sut.ControllerContext = new ControllerContext();
            this.Sut.ControllerContext.HttpContext = this._httpContextBaseMock.Object;

Damit habe ich meine Erwartungen/Arranges gemacht.

Nun zu den eigentlichen Tests

public void Act()
        {
            this._result = (ViewResult)this.Sut.Index();
        }

        [Test]
        public void Then_the_Request_UserAgent_should_be_read()
        {
            Act();
            Assert.AreEqual(this._expectedUserAgentInViewBagMessage, this._result.ViewBag.Message);
        }

        [Test]
        public void Then_a_Cookie_should_be_added_to_the_Response()
        {
            Act();
            Assert.AreSame(this._expectedCookie.Value, this._cookieCollection[this._expectedCookie.Name].Value);
        }

Bei "Act” ruf ich die Index Methode auf und speichere das Result dessen in einem Property. In der ersten Testmethode schau ich nun, ob in der ViewBag nun auch der UserAgent gesetzt ist.

In der zweiten Testmethode prüfe ich, ob nun in der _cookieCollection, welche am Anfan leer war, nun auch mein Cookie zu finden ist.

Damit haben wir auch die drei As kennengelernt: Arrange / Act / Assert.

Die Implementierung dessen fand auch ganz nach TDD Art "Red/Green/Refactor” statt und das ist am Ende die fertige Methode:

public ActionResult Index()
        {
            ViewBag.Message = this.ControllerContext.HttpContext.Request.UserAgent;
            HttpCookie cookie = new HttpCookie("HelloTDDInCookie");
            this.Response.Cookies.Add(cookie);
            return View();
        }

Im Browser klappt das natürlich auch:

Prinzipiell ist also das test und mocken mit HttpContext & co. nicht schwer. Es gibt natürlich diverse Feinheiten, aber dies würde ich für einen anderen Post aufbewahren.

[Download Democode]