Add Health Check (#167)

* Avoid using custom middleware for auth

* Add health check

* Remove unecessary test

* Wait for health endpoint before running Docker tests

* Use standard test key in HTTP file

* Use AddAuthorizationBuilder to register authorization services and construct policies

Author: elzik

src/Elzik.Breef.Api/Auth/AuthExtensions.cs

@@ -1,4 +1,5 @@
 using AspNetCore.Authentication.ApiKey;
+using Microsoft.AspNetCore.Authorization;
 
 namespace Elzik.Breef.Api.Auth;
 
@@ -12,22 +13,19 @@ public static void AddAuth(this IServiceCollection services)
                 options.KeyName = "BREEF-API-KEY";
                 options.Realm = "BreefAPI";
             });
-        services.AddAuthorization();
+
+        var authBuilder = services.AddAuthorizationBuilder();
+        authBuilder.AddPolicy("RequireAuthenticated", p => p.RequireAuthenticatedUser());
+
+        services.Configure<AuthorizationOptions>(options =>
+        {
+            options.FallbackPolicy = options.GetPolicy("RequireAuthenticated");
+        });
     }
 
     public static void UseAuth(this WebApplication app)
     {
         app.UseAuthentication();
         app.UseAuthorization();
-        app.Use(async (context, next) =>
-        {
-            if (context.User.Identity != null && !context.User.Identity.IsAuthenticated)
-            {
-                context.Response.StatusCode = 401;
-                await context.Response.WriteAsync("Unauthorised");
-                return;
-            }
-            await next();
-        });
     }
 }

src/Elzik.Breef.Api/Elzik.Breef.Api.http

@@ -1,8 +1,15 @@
 @Elzik.Breef.Api_HostAddress = http://localhost:5079
 
+### Breefs
+
 Post {{Elzik.Breef.Api_HostAddress}}/breefs
 Content-Type: application/json
 BREEF-API-KEY: test-key
 {
-  "url":"https://www.reddit.com/r/dotnet/comments/1o0j6or/im_giving_up_on_copilot_i_spend_more_time/"
+ "url":"https://www.reddit.com/r/selfhosted/comments/1og7kjd/a_note_to_myself_from_the_future_document/"
 }
+
+### Health
+
+Get {{Elzik.Breef.Api_HostAddress}}/health
+Content-Type: application/json

src/Elzik.Breef.Api/Program.cs

@@ -135,6 +135,9 @@ public static async Task Main(string[] args)
         app.UseCors();
         app.UseAuth();
 
+        app.MapGet("/health", () => Results.Ok(new { status = "Healthy" }))
+           .AllowAnonymous();
+
         app.AddBreefEndpoints();
 
         await app.RunAsync();

tests/Elzik.Breef.Api.Tests.Functional/BreefTestsBase.cs

@@ -73,9 +73,13 @@ public async Task Unauthorised()
 
             // Assert
             response.StatusCode.ShouldBe(HttpStatusCode.Unauthorized);
+            response.Headers.WwwAuthenticate.ShouldNotBeEmpty();
+            var challenge = response.Headers.WwwAuthenticate.First();
+            challenge.Scheme.ShouldBe("ApiKey");
+            challenge.Parameter.ShouldNotBeNullOrEmpty();
+            challenge.Parameter.ShouldContain("BREEF-API-KEY");
             var responseString = await response.Content.ReadAsStringAsync();
-            responseString.ShouldNotBeNullOrEmpty();
-            responseString.ShouldContain("Unauthorised");
+            responseString.ShouldBeEmpty();
         }
     }
 }

tests/Elzik.Breef.Api.Tests.Functional/BreefTestsDocker.cs

@@ -80,7 +80,10 @@ public BreefTestsDocker(ITestOutputHelper testOutputHelper)
                 .WithEnvironment("breef_Wallabag__Password", breefWallabagPassword)
                 .WithEnvironment("breef_Wallabag__ClientId", breefWallabagClientId)
                 .WithEnvironment("breef_Wallabag__ClientSecret", breefWallabagClientSecret)
-                .WithWaitStrategy(Wait.ForUnixContainer().UntilInternalTcpPortIsAvailable(8080))
+                .WithWaitStrategy(Wait.ForUnixContainer().UntilHttpRequestIsSucceeded(request => request
+                    .ForPort(8080)
+                    .ForPath("/health")
+                    .ForStatusCode(System.Net.HttpStatusCode.OK)))
                 .WithOutputConsumer(outputConsumer)
                 .Build();
         }

tests/Elzik.Breef.Api.Tests.Functional/HealthEndpointTests.cs

@@ -0,0 +1,35 @@
+using Shouldly;
+using System.Net;
+using System.Net.Http.Json;
+using Xunit;
+
+namespace Elzik.Breef.Api.Tests.Functional
+{
+ public class HealthEndpointTests : IClassFixture<Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory<Elzik.Breef.Api.Program>>
+ {
+ private readonly HttpClient _client;
+
+ public HealthEndpointTests(Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory<Elzik.Breef.Api.Program> factory)
+ {
+ _client = factory.CreateClient();
+ }
+
+ [Fact]
+ public async Task Health_Called_ReturnsOK()
+ {
+ // Act
+ var response = await _client.GetAsync("/health");
+
+ // Assert
+ response.StatusCode.ShouldBe(HttpStatusCode.OK);
+ var body = await response.Content.ReadFromJsonAsync<HealthResponse>();
+ body.ShouldNotBeNull();
+ body!.Status.ShouldBe("Healthy");
+ }
+
+ private class HealthResponse
+ {
+ public string Status { get; set; } = string.Empty;
+ }
+ }
+}