521 lines
22 KiB
C#
521 lines
22 KiB
C#
// Copyright (c) .NET Foundation. All rights reserved.
|
|
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Diagnostics;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Net;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using Microsoft.AspNetCore.Builder;
|
|
using Microsoft.AspNetCore.Hosting;
|
|
using Microsoft.AspNetCore.Http;
|
|
using Microsoft.AspNetCore.TestHost;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using Xunit;
|
|
|
|
namespace Microsoft.AspNetCore.Diagnostics
|
|
{
|
|
public class ExceptionHandlerTest
|
|
{
|
|
[Theory]
|
|
[InlineData(HttpStatusCode.NotFound)]
|
|
[InlineData(HttpStatusCode.BadRequest)]
|
|
[InlineData(HttpStatusCode.InternalServerError)]
|
|
public async Task OnlyHandles_UnhandledExceptions(HttpStatusCode expectedStatusCode)
|
|
{
|
|
var builder = new WebHostBuilder()
|
|
.Configure(app =>
|
|
{
|
|
app.UseExceptionHandler("/handle-errors");
|
|
|
|
app.Map("/handle-errors", (innerAppBuilder) =>
|
|
{
|
|
innerAppBuilder.Run(async (httpContext) =>
|
|
{
|
|
await httpContext.Response.WriteAsync("Handled error in a custom way.");
|
|
});
|
|
});
|
|
|
|
app.Run((RequestDelegate)(async (context) =>
|
|
{
|
|
context.Response.StatusCode = (int)expectedStatusCode;
|
|
context.Response.ContentType = "text/plain; charset=utf-8";
|
|
await context.Response.WriteAsync("An error occurred while adding a product");
|
|
}));
|
|
});
|
|
|
|
using (var server = new TestServer(builder))
|
|
{
|
|
var client = server.CreateClient();
|
|
var response = await client.GetAsync(string.Empty);
|
|
Assert.Equal(expectedStatusCode, response.StatusCode);
|
|
Assert.Equal("An error occurred while adding a product", await response.Content.ReadAsStringAsync());
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public async Task DoesNotHandle_UnhandledExceptions_WhenResponseAlreadyStarted()
|
|
{
|
|
var builder = new WebHostBuilder()
|
|
.Configure(app =>
|
|
{
|
|
app.Use(async (httpContext, next) =>
|
|
{
|
|
Exception exception = null;
|
|
try
|
|
{
|
|
await next();
|
|
}
|
|
catch (InvalidOperationException ex)
|
|
{
|
|
exception = ex;
|
|
}
|
|
|
|
Assert.NotNull(exception);
|
|
Assert.Equal("Something bad happened", exception.Message);
|
|
});
|
|
|
|
app.UseExceptionHandler("/handle-errors");
|
|
|
|
app.Map("/handle-errors", (innerAppBuilder) =>
|
|
{
|
|
innerAppBuilder.Run(async (httpContext) =>
|
|
{
|
|
await httpContext.Response.WriteAsync("Handled error in a custom way.");
|
|
});
|
|
});
|
|
|
|
app.Run(async (httpContext) =>
|
|
{
|
|
await httpContext.Response.WriteAsync("Hello");
|
|
throw new InvalidOperationException("Something bad happened");
|
|
});
|
|
});
|
|
|
|
using (var server = new TestServer(builder))
|
|
{
|
|
var client = server.CreateClient();
|
|
var response = await client.GetAsync(string.Empty);
|
|
response.EnsureSuccessStatusCode();
|
|
Assert.Equal("Hello", await response.Content.ReadAsStringAsync());
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ClearsResponseBuffer_BeforeRequestIsReexecuted()
|
|
{
|
|
var expectedResponseBody = "New response body";
|
|
var builder = new WebHostBuilder()
|
|
.Configure(app =>
|
|
{
|
|
// add response buffering
|
|
app.Use(async (httpContext, next) =>
|
|
{
|
|
var response = httpContext.Response;
|
|
var originalResponseBody = response.Body;
|
|
var bufferingStream = new MemoryStream();
|
|
response.Body = bufferingStream;
|
|
|
|
try
|
|
{
|
|
await next();
|
|
|
|
response.Body = originalResponseBody;
|
|
bufferingStream.Seek(0, SeekOrigin.Begin);
|
|
await bufferingStream.CopyToAsync(response.Body);
|
|
}
|
|
finally
|
|
{
|
|
response.Body = originalResponseBody;
|
|
}
|
|
});
|
|
|
|
app.UseExceptionHandler("/handle-errors");
|
|
|
|
app.Map("/handle-errors", (innerAppBuilder) =>
|
|
{
|
|
innerAppBuilder.Run(async (httpContext) =>
|
|
{
|
|
Assert.True(httpContext.Response.Body.CanSeek);
|
|
Assert.Equal(0, httpContext.Response.Body.Position);
|
|
|
|
await httpContext.Response.WriteAsync(expectedResponseBody);
|
|
});
|
|
});
|
|
|
|
app.Run(async (context) =>
|
|
{
|
|
// Write some content into the response before throwing exception
|
|
await context.Response.WriteAsync(new string('a', 100));
|
|
|
|
throw new InvalidOperationException("Invalid input provided.");
|
|
});
|
|
});
|
|
|
|
using (var server = new TestServer(builder))
|
|
{
|
|
var client = server.CreateClient();
|
|
var response = await client.GetAsync(string.Empty);
|
|
Assert.Equal(HttpStatusCode.InternalServerError, response.StatusCode);
|
|
Assert.Equal(expectedResponseBody, await response.Content.ReadAsStringAsync());
|
|
IEnumerable<string> values;
|
|
Assert.True(response.Headers.TryGetValues("Cache-Control", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal("no-cache", values.First());
|
|
Assert.True(response.Headers.TryGetValues("Pragma", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal("no-cache", values.First());
|
|
Assert.True(response.Content.Headers.TryGetValues("Expires", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal("-1", values.First());
|
|
Assert.False(response.Headers.TryGetValues("ETag", out values));
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public async Task Redirect_StatusPage()
|
|
{
|
|
var expectedStatusCode = 432;
|
|
var destination = "/location";
|
|
var builder = new WebHostBuilder()
|
|
.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}");
|
|
});
|
|
});
|
|
var expectedQueryString = $"?id={expectedStatusCode}";
|
|
var expectedUri = $"/errorPage{expectedQueryString}";
|
|
using (var server = new TestServer(builder))
|
|
{
|
|
|
|
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";
|
|
var builder = new WebHostBuilder()
|
|
.Configure(app =>
|
|
{
|
|
app.Use(async (context, next) =>
|
|
{
|
|
var beforeNext = context.Request.QueryString;
|
|
await next();
|
|
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.");
|
|
});
|
|
});
|
|
|
|
using (var server = new TestServer(builder))
|
|
{
|
|
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 ClearsCacheHeaders_SetByReexecutionPathHandlers()
|
|
{
|
|
var expiresTime = DateTime.UtcNow.AddDays(5).ToString("R");
|
|
var expectedResponseBody = "Handled error in a custom way.";
|
|
var builder = new WebHostBuilder()
|
|
.Configure(app =>
|
|
{
|
|
app.UseExceptionHandler("/handle-errors");
|
|
|
|
app.Map("/handle-errors", (innerAppBuilder) =>
|
|
{
|
|
innerAppBuilder.Run(async (httpContext) =>
|
|
{
|
|
httpContext.Response.Headers.Add("Cache-Control", new[] { "max-age=600" });
|
|
httpContext.Response.Headers.Add("Pragma", new[] { "max-age=600" });
|
|
httpContext.Response.Headers.Add(
|
|
"Expires", new[] { expiresTime });
|
|
httpContext.Response.Headers.Add("ETag", new[] { "12345" });
|
|
|
|
await httpContext.Response.WriteAsync(expectedResponseBody);
|
|
});
|
|
});
|
|
|
|
app.Run((context) =>
|
|
{
|
|
throw new InvalidOperationException("Invalid input provided.");
|
|
});
|
|
});
|
|
|
|
using (var server = new TestServer(builder))
|
|
{
|
|
var client = server.CreateClient();
|
|
var response = await client.GetAsync(string.Empty);
|
|
Assert.Equal(HttpStatusCode.InternalServerError, response.StatusCode);
|
|
Assert.Equal(expectedResponseBody, await response.Content.ReadAsStringAsync());
|
|
IEnumerable<string> values;
|
|
Assert.True(response.Headers.TryGetValues("Cache-Control", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal("no-cache", values.First());
|
|
Assert.True(response.Headers.TryGetValues("Pragma", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal("no-cache", values.First());
|
|
Assert.True(response.Content.Headers.TryGetValues("Expires", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal("-1", values.First());
|
|
Assert.False(response.Headers.TryGetValues("ETag", out values));
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public async Task DoesNotModifyCacheHeaders_WhenNoExceptionIsThrown()
|
|
{
|
|
var expiresTime = DateTime.UtcNow.AddDays(10).ToString("R");
|
|
var expectedResponseBody = "Hello world!";
|
|
var builder = new WebHostBuilder()
|
|
.Configure(app =>
|
|
{
|
|
app.UseExceptionHandler("/handle-errors");
|
|
|
|
app.Map("/handle-errors", (innerAppBuilder) =>
|
|
{
|
|
innerAppBuilder.Run(async (httpContext) =>
|
|
{
|
|
await httpContext.Response.WriteAsync("Handled error in a custom way.");
|
|
});
|
|
});
|
|
|
|
app.Run(async (httpContext) =>
|
|
{
|
|
httpContext.Response.Headers.Add("Cache-Control", new[] { "max-age=3600" });
|
|
httpContext.Response.Headers.Add("Pragma", new[] { "max-age=3600" });
|
|
httpContext.Response.Headers.Add("Expires", new[] { expiresTime });
|
|
httpContext.Response.Headers.Add("ETag", new[] { "abcdef" });
|
|
|
|
await httpContext.Response.WriteAsync(expectedResponseBody);
|
|
});
|
|
});
|
|
|
|
using (var server = new TestServer(builder))
|
|
{
|
|
var client = server.CreateClient();
|
|
var response = await client.GetAsync(string.Empty);
|
|
response.EnsureSuccessStatusCode();
|
|
Assert.Equal(expectedResponseBody, await response.Content.ReadAsStringAsync());
|
|
IEnumerable<string> values;
|
|
Assert.True(response.Headers.TryGetValues("Cache-Control", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal("max-age=3600", values.First());
|
|
Assert.True(response.Headers.TryGetValues("Pragma", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal("max-age=3600", values.First());
|
|
Assert.True(response.Content.Headers.TryGetValues("Expires", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal(expiresTime, values.First());
|
|
Assert.True(response.Headers.TryGetValues("ETag", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal("abcdef", values.First());
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public async Task DoesNotClearCacheHeaders_WhenResponseHasAlreadyStarted()
|
|
{
|
|
var expiresTime = DateTime.UtcNow.AddDays(10).ToString("R");
|
|
var builder = new WebHostBuilder()
|
|
.Configure(app =>
|
|
{
|
|
app.Use(async (httpContext, next) =>
|
|
{
|
|
Exception exception = null;
|
|
try
|
|
{
|
|
await next();
|
|
}
|
|
catch (InvalidOperationException ex)
|
|
{
|
|
exception = ex;
|
|
}
|
|
|
|
Assert.NotNull(exception);
|
|
Assert.Equal("Something bad happened", exception.Message);
|
|
});
|
|
|
|
app.UseExceptionHandler("/handle-errors");
|
|
|
|
app.Map("/handle-errors", (innerAppBuilder) =>
|
|
{
|
|
innerAppBuilder.Run(async (httpContext) =>
|
|
{
|
|
await httpContext.Response.WriteAsync("Handled error in a custom way.");
|
|
});
|
|
});
|
|
|
|
app.Run(async (httpContext) =>
|
|
{
|
|
httpContext.Response.Headers.Add("Cache-Control", new[] { "max-age=3600" });
|
|
httpContext.Response.Headers.Add("Pragma", new[] { "max-age=3600" });
|
|
httpContext.Response.Headers.Add("Expires", new[] { expiresTime });
|
|
httpContext.Response.Headers.Add("ETag", new[] { "abcdef" });
|
|
|
|
await httpContext.Response.WriteAsync("Hello");
|
|
|
|
throw new InvalidOperationException("Something bad happened");
|
|
});
|
|
});
|
|
|
|
using (var server = new TestServer(builder))
|
|
{
|
|
var client = server.CreateClient();
|
|
var response = await client.GetAsync(string.Empty);
|
|
response.EnsureSuccessStatusCode();
|
|
Assert.Equal("Hello", await response.Content.ReadAsStringAsync());
|
|
IEnumerable<string> values;
|
|
Assert.True(response.Headers.TryGetValues("Cache-Control", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal("max-age=3600", values.First());
|
|
Assert.True(response.Headers.TryGetValues("Pragma", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal("max-age=3600", values.First());
|
|
Assert.True(response.Content.Headers.TryGetValues("Expires", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal(expiresTime, values.First());
|
|
Assert.True(response.Headers.TryGetValues("ETag", out values));
|
|
Assert.Single(values);
|
|
Assert.Equal("abcdef", values.First());
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public async Task HandledErrorsWriteToDiagnosticWhenUsingExceptionHandler()
|
|
{
|
|
// Arrange
|
|
DiagnosticListener diagnosticListener = null;
|
|
|
|
var builder = new WebHostBuilder()
|
|
.Configure(app =>
|
|
{
|
|
diagnosticListener = app.ApplicationServices.GetRequiredService<DiagnosticListener>();
|
|
|
|
app.UseExceptionHandler("/handle-errors");
|
|
app.Map("/handle-errors", (innerAppBuilder) =>
|
|
{
|
|
innerAppBuilder.Run(async (httpContext) =>
|
|
{
|
|
await httpContext.Response.WriteAsync("Handled error in a custom way.");
|
|
});
|
|
});
|
|
app.Run(context =>
|
|
{
|
|
throw new Exception("Test exception");
|
|
});
|
|
});
|
|
var server = new TestServer(builder);
|
|
|
|
var listener = new TestDiagnosticListener();
|
|
diagnosticListener.SubscribeWithAdapter(listener);
|
|
|
|
// Act
|
|
await server.CreateClient().GetAsync(string.Empty);
|
|
|
|
// This ensures that all diagnostics are completely written to the diagnostic listener
|
|
Thread.Sleep(1000);
|
|
|
|
// Assert
|
|
Assert.NotNull(listener.EndRequest?.HttpContext);
|
|
Assert.Null(listener.HostingUnhandledException?.HttpContext);
|
|
Assert.Null(listener.HostingUnhandledException?.Exception);
|
|
Assert.Null(listener.DiagnosticUnhandledException?.HttpContext);
|
|
Assert.Null(listener.DiagnosticUnhandledException?.Exception);
|
|
Assert.NotNull(listener.DiagnosticHandledException?.HttpContext);
|
|
Assert.NotNull(listener.DiagnosticHandledException?.Exception);
|
|
}
|
|
|
|
[Fact]
|
|
public void UsingExceptionHandler_ThrowsAnException_WhenExceptionHandlingPathNotSet()
|
|
{
|
|
// Arrange
|
|
DiagnosticListener diagnosticListener = null;
|
|
|
|
var builder = new WebHostBuilder()
|
|
.Configure(app =>
|
|
{
|
|
diagnosticListener = app.ApplicationServices.GetRequiredService<DiagnosticListener>();
|
|
app.UseExceptionHandler();
|
|
});
|
|
|
|
// Act
|
|
var exception = Assert.Throws<InvalidOperationException>(() => new TestServer(builder));
|
|
|
|
// Assert
|
|
Assert.Equal($"An error occurred when configuring the exception handler middleware. " +
|
|
$"Either the 'ExceptionHandlingPath' or the 'ExceptionHandler' option must be set in 'UseExceptionHandler()'.",
|
|
exception.Message);
|
|
}
|
|
}
|
|
}
|