Unit test Custom Route in Web API

Question

I've spent already half day on this without any success. How do you unit test routes in Web API?

I mean given the following URI:

~/Test/Get/2

I want to unit test that the above url is captured by the Test controller and Get action accepting an int parameter.

Might be useful? http://stackoverflow.com/questions/10446174/httpclient-with-asp-net-webapi-in-unit-testing-scenario — Jason Evans, Jul 08 '12 at 19:53
and this: http://www.peterprovost.org/blog/2012/06/16/unit-testing-asp-dot-net-web-api/ — Jason Evans, Jul 08 '12 at 19:54
You can try to use the NuGet package MvcRouteUnitTester (works pretty easy) http://nuget.org/packages/MvcRouteUnitTester — Styxxy, Jul 08 '12 at 21:09

score 4 · Answer 1 · answered Nov 10 '15 at 13:35

For testing the routes, I have created a library to help you with the assertions - MyWebApi: https://github.com/ivaylokenov/MyWebApi

Basically, you can do the following:

MyWebApi
    .Routes()
    .ShouldMap(“api/WebApiController/SomeAction/5”)
    .WithJsonContent(@”{“”SomeInt””: 1, “”SomeString””: “”Test””}”)
    .And()
    .WithHttpMethod(HttpMethod.Post)
    .To(c => c.SomeAction(5, new RequestModel
    {
        SomeInt = 1,
        SomeString = “Test”
    }));

If you want to implement it yourself, you can see the code here and copy it: https://github.com/ivaylokenov/MyWebApi/blob/master/src/MyWebApi/Utilities/RouteResolvers/InternalRouteResolver.cs

score 1 · Answer 2 · edited May 23 '17 at 12:16

1

I described a ready-to-use example of how to test Web API routes in the related question: Testing route configuration in ASP.NET WebApi

edited May 23 '17 at 12:16

Community

1
1

answered Jan 17 '13 at 01:07

whyleee

4,019
1
31
33

score 0 · Answer 3 · edited Aug 09 '12 at 02:09

This is what i did, please let me know what you think

[Test]
public void Should_be_able_to_route_to_gettables_action_in_databaseschemaexplorercontroller()
{
    const string url = "~/DatabaseSchemaExplorer/Tables/DatabaseType/Provider/DataSource/DatabaseName";

    _httpContextMock.Expect(c => c.Request.AppRelativeCurrentExecutionFilePath).Return(url);

    var routeData = _routes.GetRouteData(_httpContextMock);

    Assert.IsNotNull(routeData, "Should have found the route");
    Assert.AreEqual("DatabaseSchemaExplorer", routeData.Values["Controller"]);
    Assert.AreEqual("Tables", routeData.Values["action"]);
    Assert.AreEqual("DatabaseType", routeData.Values["databaseType"]);
    Assert.AreEqual("Provider", routeData.Values["provider"]);
    Assert.AreEqual("DataSource", routeData.Values["dataSource"]);
    Assert.AreEqual("DatabaseName", routeData.Values["databaseName"]);
}

Could you please post your mock code for `_httpContexMock` and `_routes`? I've been working on the same issue and asked this question: http://stackoverflow.com/q/11851558/61654. — ahsteele, Aug 09 '12 at 02:05

Unit test Custom Route in Web API

3 Answers3