web-dev-qa-db-ja.com

ASP.NET Web APIルーティングを単体テストするにはどうすればよいですか？

Web APIに対して行われたリクエストが、予期される引数を使用して予期されるAPIコントローラーアクションにルーティングされることを確認するために、いくつかの単体テストを作成しようとしています。

HttpServerクラスを使用してテストを作成しようとしましたが、サーバーから500応答が返され、問題をデバッグするための情報がありません。

ASP.NET Web APIサイトのルーティングの単体テストを作成する方法はありますか？

理想的には、HttpClientを使用してリクエストを作成し、サーバーにリクエストを処理させて、予想されるルーティングプロセスを通過させたいと思います。

c#unit-testingasp.net-web-api
31
Paul Turner

私はルートのテストとあなたが求めていることのほとんどを行うことについてブログ投稿を書きました：

http://www.strathweb.com/2012/08/testing-routes-in-asp-net-web-api/

それが役に立てば幸い。

追加の利点は、リフレクションを使用してアクションメソッドを提供することです。そのため、文字列でルートを使用する代わりに、厳密に型指定された方法でルートを追加します。このアプローチでは、アクション名が変更されてもテストがコンパイルされないため、簡単にエラーを見つけることができます。

25
Filip W

ASP.NET Web APIアプリケーションのルートをテストする最良の方法は、エンドポイントの統合テストです。

ASP.NET Web APIアプリケーションの簡単な統合テストサンプルを次に示します。これは主にルートをテストするわけではありませんが、目に見えないようにテストします。また、ここではXUnit、Autofac、Moqを使用しています。

[Fact, NullCurrentPrincipal]
public async Task 
    Returns_200_And_Role_With_Key() {

    // Arrange
    Guid key1 = Guid.NewGuid(),
         key2 = Guid.NewGuid(),
         key3 = Guid.NewGuid(),
         key4 = Guid.NewGuid();

    var mockMemSrv = ServicesMockHelper
        .GetInitialMembershipService();

    mockMemSrv.Setup(ms => ms.GetRole(
            It.Is<Guid>(k =>
                k == key1 || k == key2 || 
                k == key3 || k == key4
            )
        )
    ).Returns<Guid>(key => new Role { 
        Key = key, Name = "FooBar"
    });

    var config = IntegrationTestHelper
        .GetInitialIntegrationTestConfig(GetInitialServices(mockMemSrv.Object));

    using (var httpServer = new HttpServer(config))
    using (var client = httpServer.ToHttpClient()) {

        var request = HttpRequestMessageHelper
            .ConstructRequest(
                httpMethod: HttpMethod.Get,
                uri: string.Format(
                    "https://localhost/{0}/{1}", 
                    "api/roles", 
                    key2.ToString()),
                mediaType: "application/json",
                username: Constants.ValidAdminUserName,
                password: Constants.ValidAdminPassword);

        // Act
        var response = await client.SendAsync(request);
        var role = await response.Content.ReadAsAsync<RoleDto>();

        // Assert
        Assert.Equal(key2, role.Key);
        Assert.Equal("FooBar", role.Name);
    }
}

このテストに使用する外部ヘルパーがいくつかあります。それらの1つはNullCurrentPrincipalAttributeです。テストはWindows Identityの下で実行されるため、Thread.CurrentPrincipalはこのIDで設定されます。したがって、アプリケーションで何らかの承認を使用している場合は、最初にこれを取り除くのが最善です。

public class NullCurrentPrincipalAttribute : BeforeAfterTestAttribute {

    public override void Before(MethodInfo methodUnderTest) {

        Thread.CurrentPrincipal = null;
    }
}

次に、モックMembershipServiceを作成します。これはアプリケーション固有の設定です。したがって、これは独自の実装に合わせて変更されます。

GetInitialServicesはAutofacコンテナーを作成します。

private static IContainer GetInitialServices(
    IMembershipService memSrv) {

    var builder = IntegrationTestHelper
        .GetEmptyContainerBuilder();

    builder.Register(c => memSrv)
        .As<IMembershipService>()
        .InstancePerApiRequest();

    return builder.Build();
}

GetInitialIntegrationTestConfigメソッドは、私の設定を初期化するだけです。

internal static class IntegrationTestHelper {

    internal static HttpConfiguration GetInitialIntegrationTestConfig() {

        var config = new HttpConfiguration();
        RouteConfig.RegisterRoutes(config.Routes);
        WebAPIConfig.Configure(config);

        return config;
    }

    internal static HttpConfiguration GetInitialIntegrationTestConfig(IContainer container) {

        var config = GetInitialIntegrationTestConfig();
        AutofacWebAPI.Initialize(config, container);

        return config;
    }
}

RouteConfig.RegisterRoutesメソッドは基本的にルートを登録します。また、HttpClient上にHttpServerを作成するための小さな拡張メソッドもあります。

internal static class HttpServerExtensions {

    internal static HttpClient ToHttpClient(
        this HttpServer httpServer) {

        return new HttpClient(httpServer);
    }
}

最後に、HttpRequestMessageHelperという静的クラスがあり、新しいHttpRequestMessageインスタンスを構築するための一連の静的メソッドがあります。

internal static class HttpRequestMessageHelper {

    internal static HttpRequestMessage ConstructRequest(
        HttpMethod httpMethod, string uri) {

        return new HttpRequestMessage(httpMethod, uri);
    }

    internal static HttpRequestMessage ConstructRequest(
        HttpMethod httpMethod, string uri, string mediaType) {

        return ConstructRequest(
            httpMethod, 
            uri, 
            new MediaTypeWithQualityHeaderValue(mediaType));
    }

    internal static HttpRequestMessage ConstructRequest(
        HttpMethod httpMethod, string uri,
        IEnumerable<string> mediaTypes) {

        return ConstructRequest(
            httpMethod,
            uri,
            mediaTypes.ToMediaTypeWithQualityHeaderValues());
    }

    internal static HttpRequestMessage ConstructRequest(
        HttpMethod httpMethod, string uri, string mediaType, 
        string username, string password) {

        return ConstructRequest(
            httpMethod, uri, new[] { mediaType }, username, password);
    }

    internal static HttpRequestMessage ConstructRequest(
        HttpMethod httpMethod, string uri, 
        IEnumerable<string> mediaTypes,
        string username, string password) {

        var request = ConstructRequest(httpMethod, uri, mediaTypes);
        request.Headers.Authorization = new AuthenticationHeaderValue(
            "Basic",
            EncodeToBase64(
                string.Format("{0}:{1}", username, password)));

        return request;
    }

    // Private helpers
    private static HttpRequestMessage ConstructRequest(
        HttpMethod httpMethod, string uri,
        MediaTypeWithQualityHeaderValue mediaType) {

        return ConstructRequest(
            httpMethod, 
            uri, 
            new[] { mediaType });
    }

    private static HttpRequestMessage ConstructRequest(
        HttpMethod httpMethod, string uri,
        IEnumerable<MediaTypeWithQualityHeaderValue> mediaTypes) {

        var request = ConstructRequest(httpMethod, uri);
        request.Headers.Accept.AddTo(mediaTypes);

        return request;
    }

    private static string EncodeToBase64(string value) {

        byte[] toEncodeAsBytes = Encoding.UTF8.GetBytes(value);
        return Convert.ToBase64String(toEncodeAsBytes);
    }
}

アプリケーションで基本認証を使用しています。したがって、このクラスには、Authenticationヘッダーを使用してHttpRequestMessegeを構築するいくつかのメソッドがあります。

最後に、ActおよびAssertを実行して、事柄を確認します私は欲しい。これはやり過ぎのサンプルかもしれませんが、これはあなたに素晴らしいアイデアを与えると思います。

これが HttpServerとの統合テスト に関する素晴らしいブログ投稿です。また、これは ASP.NET Web APIでのルートのテスト に関する別の素晴らしい投稿です。

9
tugberk

hiルートをテストする場合、主な目的はこのテストでGetRouteData（）をテストすることです。ルートシステムがリクエストを正しく認識し、正しいルートが選択されていることを確認します。

[Theory]
[InlineData("http://localhost:5240/foo/route", "GET", false, null, null)]
[InlineData("http://localhost:5240/api/Cars/", "GET", true, "Cars", null)]
[InlineData("http://localhost:5240/api/Cars/123", "GET", true, "Cars", "123")]
public void DefaultRoute_Returns_Correct_RouteData(
     string url, string method, bool shouldfound, string controller, string id)
{
    //Arrange
    var config = new HttpConfiguration();

    WebApiConfig.Register(config);

    var actionSelector = config.Services.GetActionSelector();
    var controllerSelector = config.Services.GetHttpControllerSelector();

    var request = new HttpRequestMessage(new HttpMethod(method), url);
    config.EnsureInitialized();
    //Act
    var routeData = config.Routes.GetRouteData(request);
    //Assert
    // assert
    Assert.Equal(shouldfound, routeData != null);
    if (shouldfound)
    {
        Assert.Equal(controller, routeData.Values["controller"]);
        Assert.Equal(id == null ? (object)RouteParameter.Optional : (object)id, routeData.
        Values["id"]);
    }
}

これは重要ですが、十分ではありません。正しいルートが選択され、正しいルートデータが抽出されていることを確認しても、正しいコントローラーとアクションが選択されているとは限りません。これは、デフォルトを書き直さない場合に便利な方法ですIHttpActionSelectorおよびIHttpControllerSelector独自のサービス。

 [Theory]
        [InlineData("http://localhost:12345/api/Cars/123", "GET", typeof(CarsController), "GetCars")]
        [InlineData("http://localhost:12345/api/Cars", "GET", typeof(CarsController), "GetCars")]
        public void Ensure_Correct_Controller_and_Action_Selected(string url,string method,
                                                    Type controllerType,string actionName) {
            //Arrange
            var config = new HttpConfiguration();
            WebApiConfig.Register(config);

            var controllerSelector = config.Services.GetHttpControllerSelector();
            var actionSelector = config.Services.GetActionSelector();

            var request = new HttpRequestMessage(new HttpMethod(method),url);

            config.EnsureInitialized();

            var routeData = config.Routes.GetRouteData(request);
            request.Properties[HttpPropertyKeys.HttpRouteDataKey] = routeData;
            request.Properties[HttpPropertyKeys.HttpConfigurationKey] = config;
            //Act
            var ctrlDescriptor = controllerSelector.SelectController(request);
            var ctrlContext = new HttpControllerContext(config, routeData, request)
            {
                ControllerDescriptor = ctrlDescriptor
            };
            var actionDescriptor = actionSelector.SelectAction(ctrlContext);
            //Assert
            Assert.NotNull(ctrlDescriptor);
            Assert.Equal(controllerType, ctrlDescriptor.ControllerType);
            Assert.Equal(actionName, actionDescriptor.ActionName);
        }
    }
2
Alejandro Serret