extend the problem details sample with a status code selector and add a functional test

latonz · latonz · commit dca15d760233 · 2024-07-17T21:50:56.000-05:00
diff --git a/src/Middleware/Diagnostics/test/FunctionalTests/ProblemDetailsExceptionHandlerSampleTest.cs b/src/Middleware/Diagnostics/test/FunctionalTests/ProblemDetailsExceptionHandlerSampleTest.cs
@@ -6,6 +6,7 @@
 using Microsoft.AspNetCore.Mvc;
 using System.Net.Http.Json;
 using System.Net.Http.Headers;
+using Microsoft.AspNetCore.Http;
 
 namespace Microsoft.AspNetCore.Diagnostics.FunctionalTests;
 
@@ -34,4 +35,21 @@ public async Task ExceptionHandlerPage_ProducesProblemDetails()
         Assert.NotNull(body);
         Assert.Equal(500, body.Status);
     }
+
+    [Fact]
+    public async Task StatusCodeSelector_ProducesProblemDetailsWith403()
+    {
+        // Arrange
+        var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost/throw/conflict");
+        request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
+
+        // Act
+        var response = await Client.SendAsync(request);
+
+        // Assert
+        var body = await response.Content.ReadFromJsonAsync<ProblemDetails>();
+        Assert.Equal(HttpStatusCode.Conflict, response.StatusCode);
+        Assert.NotNull(body);
+        Assert.Equal(StatusCodes.Status409Conflict, body.Status);
+    }
 }
diff --git a/src/Middleware/Diagnostics/test/UnitTests/ExceptionHandlerTest.cs b/src/Middleware/Diagnostics/test/UnitTests/ExceptionHandlerTest.cs
@@ -692,7 +692,7 @@ public async Task ExceptionHandler_SelectsStatusCode()
     }
 
     [Fact]
-    public async Task ExceptionHandler_SelectsStatusCode404_When404ThrowedAndNotNotAllowed()
+    public async Task StatusCodeSelector_CanSelect404()
     {
         using var host = new HostBuilder()
             .ConfigureWebHost(webHostBuilder =>
diff --git a/src/Middleware/Diagnostics/test/testassets/ExceptionHandlerSample/ConflictException.cs b/src/Middleware/Diagnostics/test/testassets/ExceptionHandlerSample/ConflictException.cs
@@ -0,0 +1,6 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace ExceptionHandlerSample;
+
+public class ConflictException(string message) : Exception(message);
diff --git a/src/Middleware/Diagnostics/test/testassets/ExceptionHandlerSample/StartupWithProblemDetails.cs b/src/Middleware/Diagnostics/test/testassets/ExceptionHandlerSample/StartupWithProblemDetails.cs
@@ -17,12 +17,22 @@ public void ConfigureServices(IServiceCollection services)
     public void Configure(IApplicationBuilder app)
     {
         // Configure the error handler to produces a ProblemDetails.
-        app.UseExceptionHandler();
+        app.UseExceptionHandler(new ExceptionHandlerOptions
+        {
+            StatusCodeSelector = ex => ex is ConflictException
+                ? StatusCodes.Status409Conflict
+                : StatusCodes.Status500InternalServerError,
+        });
 
         // The broken section of our application.
         app.Map("/throw", throwApp =>
         {
-            throwApp.Run(context => { throw new Exception("Application Exception"); });
+            throwApp.Map("/conflict", throwConflictApp =>
+            {
+                throwConflictApp.Run(_ => throw new ConflictException("Conflict Exception"));
+            });
+
+            throwApp.Run(_ => throw new Exception("Application Exception"));
         });
 
         app.UseStaticFiles();
@@ -32,7 +42,8 @@ public void Configure(IApplicationBuilder app)
         {
             context.Response.ContentType = "text/html";
             await context.Response.WriteAsync("<html><body>Welcome to the sample<br><br>\r\n");
-            await context.Response.WriteAsync("Click here to throw an exception: <a href=\"/throw\">throw</a>\r\n");
+            await context.Response.WriteAsync("Click here to throw an exception: <a href=\"/throw\">throw</a><br>\r\n");
+            await context.Response.WriteAsync("Click here to throw a conflict exception: <a href=\"/throw/conflict\">throw conflict</a>\r\n");
             await context.Response.WriteAsync("</body></html>\r\n");
         });
     }

Original file line number	Diff line number	Diff line change
`@@ -692,7 +692,7 @@ public async Task ExceptionHandler_SelectsStatusCode()`
`692`	`692`	`}`
`693`	`693`
`694`	`694`	`[Fact]`
`695`		`- public async Task ExceptionHandler_SelectsStatusCode404_When404ThrowedAndNotNotAllowed()`
	`695`	`+ public async Task StatusCodeSelector_CanSelect404()`
`696`	`696`	`{`
`697`	`697`	`using var host = new HostBuilder()`
`698`	`698`	`.ConfigureWebHost(webHostBuilder =>`