src/Middleware/Diagnostics/test/UnitTests/StatusCodeMiddlewareTest.cs - main - githubmirror/aspnetcore

src/Middleware/Diagnostics/test/UnitTests/StatusCodeMiddlewareTest.cs
392 строки14 KB
Frederik Rosenberg
Support SkipStatusCodePages when not using WebApplication builder and UseStatusCodePagesWithReExecute (#46109)
19 янв 2023, 01:04
19 янв 2023, 01:041f62c43
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Net;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.TestHost;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

namespace Microsoft.AspNetCore.Diagnostics;

public class StatusCodeMiddlewareTest
{
    [Fact]
    public async Task Redirect_StatusPage()
    {
        var expectedStatusCode = 432;
        var destination = "/location";
        using var host = new HostBuilder()
            .ConfigureWebHost(webHostBuilder =>
            {
                webHostBuilder
                .UseTestServer()
                .Configure(app =>
                {
                    app.UseStatusCodePagesWithRedirects("/errorPage?id={0}");

                    app.Map(destination, (innerAppBuilder) =>
                    {
                        innerAppBuilder.Run((httpContext) =>
                        {
                            httpContext.Response.StatusCode = expectedStatusCode;
                            return Task.FromResult(1);
                        });
                    });

                    app.Map("/errorPage", (innerAppBuilder) =>
                    {
                        innerAppBuilder.Run(async (httpContext) =>
                        {
                            await httpContext.Response.WriteAsync(httpContext.Request.QueryString.Value);
                        });
                    });

                    app.Run((context) =>
                    {
                        throw new InvalidOperationException($"Invalid input provided. {context.Request.Path}");
                    });
                });
            }).Build();

        await host.StartAsync();

        var expectedQueryString = $"?id={expectedStatusCode}";
        var expectedUri = $"/errorPage{expectedQueryString}";
        using var server = host.GetTestServer();
        var client = server.CreateClient();
        var response = await client.GetAsync(destination);
        Assert.Equal(HttpStatusCode.Found, response.StatusCode);
        Assert.Equal(expectedUri, response.Headers.First(s => s.Key == "Location").Value.First());

        response = await client.GetAsync(expectedUri);
        var content = await response.Content.ReadAsStringAsync();
        Assert.Equal(expectedQueryString, content);
        Assert.Equal(expectedQueryString, response.RequestMessage.RequestUri.Query);
    }

    [Fact]
    public async Task Reexecute_CanRetrieveInformationAboutOriginalRequest()
    {
        var expectedStatusCode = 432;
        var destination = "/location";
        using var host = new HostBuilder()
            .ConfigureWebHost(webHostBuilder =>
            {
                webHostBuilder
                .UseTestServer()
                .Configure(app =>
                {
                    app.Use(async (context, next) =>
                    {
                        var beforeNext = context.Request.QueryString;
                        await next(context);
                        var afterNext = context.Request.QueryString;

                        Assert.Equal(beforeNext, afterNext);
                    });
                    app.UseStatusCodePagesWithReExecute(pathFormat: "/errorPage", queryFormat: "?id={0}");

                    app.Map(destination, (innerAppBuilder) =>
                    {
                        innerAppBuilder.Run((httpContext) =>
                        {
                            httpContext.Response.StatusCode = expectedStatusCode;
                            return Task.FromResult(1);
                        });
                    });

                    app.Map("/errorPage", (innerAppBuilder) =>
                    {
                        innerAppBuilder.Run(async (httpContext) =>
                        {
                            var statusCodeReExecuteFeature = httpContext.Features.Get<IStatusCodeReExecuteFeature>();
                            await httpContext.Response.WriteAsync(
                                httpContext.Request.QueryString.Value
                                + ", "
                                + statusCodeReExecuteFeature.OriginalPath
                                + ", "
                                + statusCodeReExecuteFeature.OriginalQueryString);
                        });
                    });

                    app.Run((context) =>
                    {
                        throw new InvalidOperationException("Invalid input provided.");
                    });
                });
            }).Build();

        await host.StartAsync();

        using var server = host.GetTestServer();
        var client = server.CreateClient();
        var response = await client.GetAsync(destination + "?name=James");
        var content = await response.Content.ReadAsStringAsync();
        Assert.Equal($"?id={expectedStatusCode}, /location, ?name=James", content);
    }

    [Fact]
    public async Task Reexecute_ClearsEndpointAndRouteData()
    {
        var expectedStatusCode = 432;
        var destination = "/location";
        using var host = new HostBuilder()
            .ConfigureWebHost(webHostBuilder =>
            {
                webHostBuilder
                .UseTestServer()
                .Configure(app =>
                {
                    app.UseStatusCodePagesWithReExecute(pathFormat: "/errorPage", queryFormat: "?id={0}");

                    app.Use((context, next) =>
                    {
                        Assert.Empty(context.Request.RouteValues);
                        Assert.Null(context.GetEndpoint());
                        return next(context);
                    });

                    app.Map(destination, (innerAppBuilder) =>
                    {
                        innerAppBuilder.Run((httpContext) =>
                        {
                            httpContext.SetEndpoint(new Endpoint((_) => Task.CompletedTask, new EndpointMetadataCollection(), "Test"));
                            httpContext.Request.RouteValues["John"] = "Doe";
                            httpContext.Response.StatusCode = expectedStatusCode;
                            return Task.CompletedTask;
                        });
                    });

                    app.Map("/errorPage", (innerAppBuilder) =>
                    {
                        innerAppBuilder.Run(async (httpContext) =>
                        {
                            var statusCodeReExecuteFeature = httpContext.Features.Get<IStatusCodeReExecuteFeature>();
                            await httpContext.Response.WriteAsync(
                                httpContext.Request.QueryString.Value
                                + ", "
                                + statusCodeReExecuteFeature.OriginalPath
                                + ", "
                                + statusCodeReExecuteFeature.OriginalQueryString);
                        });
                    });

                    app.Run((context) =>
                    {
                        throw new InvalidOperationException("Invalid input provided.");
                    });
                });
            }).Build();

        await host.StartAsync();

        using var server = host.GetTestServer();
        var client = server.CreateClient();
        var response = await client.GetAsync(destination + "?name=James");
        var content = await response.Content.ReadAsStringAsync();
        Assert.Equal($"?id={expectedStatusCode}, /location, ?name=James", content);
    }

    [Fact]
    public async Task Reexecute_CaptureEndpointAndRouteData()
    {
        var expectedStatusCode = 432;
        var destination = "/location";
        var endpoint = new Endpoint((_) => Task.CompletedTask, new EndpointMetadataCollection(), "Test");
        using var host = new HostBuilder()
            .ConfigureWebHost(webHostBuilder =>
            {
                webHostBuilder
                .UseTestServer()
                .Configure(app =>
                {
                    app.UseStatusCodePagesWithReExecute(pathFormat: "/errorPage", queryFormat: "?id={0}");

                    app.Map(destination, (innerAppBuilder) =>
                    {
                        innerAppBuilder.Run((httpContext) =>
                        {
                            httpContext.SetEndpoint(endpoint);
                            httpContext.Request.RouteValues["John"] = "Doe";
                            httpContext.Response.StatusCode = expectedStatusCode;
                            return Task.CompletedTask;
                        });
                    });

                    app.Map("/errorPage", (innerAppBuilder) =>
                    {
                        innerAppBuilder.Run(httpContext =>
                        {
                            var statusCodeReExecuteFeature = httpContext.Features.Get<IStatusCodeReExecuteFeature>();

                            Assert.Equal(endpoint, statusCodeReExecuteFeature.Endpoint);
                            Assert.Equal("Doe", statusCodeReExecuteFeature.RouteValues["John"]);

                            return Task.CompletedTask;
                        });
                    });

                    app.Run((context) =>
                    {
                        throw new InvalidOperationException("Invalid input provided.");
                    });
                });
            }).Build();

        await host.StartAsync();

        using var server = host.GetTestServer();
        var client = server.CreateClient();
        var response = await client.GetAsync(destination + "?name=James");
    }

    [Fact]
    public async Task Reexecute_WorksAfterUseRoutingWithGlobalRouteBuilder()
    {
        var builder = WebApplication.CreateBuilder();
        builder.WebHost.UseTestServer();
        await using var app = builder.Build();

        app.UseRouting();

        app.UseStatusCodePagesWithReExecute(pathFormat: "/errorPage", queryFormat: "?id={0}");

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapGet("/", c =>
            {
                c.Response.StatusCode = 404;
                return Task.CompletedTask;
            });

            endpoints.MapGet("/errorPage", () => "errorPage");
        });

        app.Run((context) =>
        {
            throw new InvalidOperationException("Invalid input provided.");
        });

        await app.StartAsync();

        using var server = app.GetTestServer();
        var client = server.CreateClient();
        var response = await client.GetAsync("/");
        var content = await response.Content.ReadAsStringAsync();
        Assert.Equal("errorPage", content);
    }

    [Fact]
    public async Task SkipStatusCodePages_SupportsEndpoints()
    {
        var builder = WebApplication.CreateBuilder();
        builder.WebHost.UseTestServer();
        await using var app = builder.Build();

        app.UseRouting();

        app.UseStatusCodePages();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapGet("/", [SkipStatusCodePages] (c) =>
            {
                c.Response.StatusCode = 404;
                return Task.CompletedTask;
            });
        });

        app.Run((context) =>
        {
            throw new InvalidOperationException("Invalid input provided.");
        });

        await app.StartAsync();

        using var server = app.GetTestServer();
        var client = server.CreateClient();
        var response = await client.GetAsync("/");
        var content = await response.Content.ReadAsStringAsync();
        Assert.Empty(content);
    }

    [Fact]
    public async Task SkipStatusCodePages_SupportsSkipIfUsedBeforeRouting()
    {
        using var host = new HostBuilder()
            .ConfigureWebHost(builder =>
            {
                builder.UseTestServer()
                .ConfigureServices(services => services.AddRouting())
                .Configure(app =>
                {
                    app.UseStatusCodePagesWithReExecute("/status");
                    app.UseRouting();

                    app.UseEndpoints(endpoints =>
                    {
                        endpoints.MapGet("/skip", [SkipStatusCodePages](c) =>
                        {
                            c.Response.StatusCode = 400;
                            return Task.CompletedTask;
                        });

                        endpoints.MapGet("/status", (HttpResponse response) => $"Status: {response.StatusCode}");
                    });

                    app.Run(_ => throw new InvalidOperationException("Invalid input provided."));
                });
            }).Build();

        await host.StartAsync();

        using var server = host.GetTestServer();
        var client = server.CreateClient();
        var response = await client.GetAsync("/skip");
        var content = await response.Content.ReadAsStringAsync();

        Assert.Empty(content);
    }

    [Fact]
    public async Task SkipStatusCodePages_WorksIfUsedBeforeRouting()
    {
        using var host = new HostBuilder()
            .ConfigureWebHost(builder =>
            {
                builder.UseTestServer()
                .ConfigureServices(services => services.AddRouting())
                .Configure(app =>
                {
                    app.UseStatusCodePagesWithReExecute("/status");
                    app.UseRouting();

                    app.UseEndpoints(endpoints =>
                    {
                        endpoints.MapGet("/", (c) =>
                        {
                            c.Response.StatusCode = 400;
                            return Task.CompletedTask;
                        });

                        endpoints.MapGet("/status", (HttpResponse response) => $"Status: {response.StatusCode}");
                    });

                    app.Run(_ => throw new InvalidOperationException("Invalid input provided."));
                });
            }).Build();

        await host.StartAsync();

        using var server = host.GetTestServer();
        var client = server.CreateClient();
        var response = await client.GetAsync("/");
        var content = await response.Content.ReadAsStringAsync();

        Assert.Equal("Status: 400", content);
    }
}