Add DB availability check to the health API endpoint

src/Notifications.API/Database/Repository.cs

@@ -6,19 +6,23 @@ namespace Notifications.Database;
 internal static class Repository
 {
     // Read
+    public static async Task<IResult> DbAvailable(AppDbContext db) =>
+        await db.Database.CanConnectAsync()
+            ? TypedResults.Ok("OK")
+            : TypedResults.InternalServerError("Database not available.");
 
-    public static Task<List<Notification>> GetCurrentNotificationsAsync(AppDbContext db) =>
-        db.Notifications
+    public static async Task<List<Notification>> GetCurrentNotificationsAsync(AppDbContext db) =>
+        await db.Notifications
             .Where(n => n.Active && n.DisplayStart < DateTime.Now && DateTime.Now < n.DisplayEnd)
             .OrderBy(n => n.DisplayStart).ThenBy(n => n.DisplayEnd).ToListAsync();
 
-    public static Task<List<Notification>> GetFutureNotificationsAsync(AppDbContext db) =>
-        db.Notifications
+    public static async Task<List<Notification>> GetFutureNotificationsAsync(AppDbContext db) =>
+        await db.Notifications
             .Where(n => n.Active && DateTime.Now < n.DisplayStart)
             .OrderBy(n => n.DisplayStart).ThenBy(n => n.DisplayEnd).ToListAsync();
 
-    public static Task<List<Notification>> GetAllNotifications(AppDbContext db) =>
-        db.Notifications
+    public static async Task<List<Notification>> GetAllNotifications(AppDbContext db) =>
+        await db.Notifications
             .OrderBy(n => n.DisplayStart).ThenBy(n => n.DisplayEnd).ToListAsync();
 
     // Write

src/Notifications.API/Platform/Endpoints.cs

@@ -7,7 +7,8 @@ internal static class Endpoints
     public static void MapEndpoints(this IEndpointRouteBuilder app)
     {
         // Status endpoints
-        app.MapGet("/health", () => Results.Ok("OK"));
+        app.MapGet("/", () => Results.Ok());
+        app.MapGet("/health", Repository.DbAvailable);
         app.MapGet("/version", () => Results.Ok(new { AppSettings.Version }));
 
         // Public endpoints

src/Notifications.API/Program.cs

@@ -19,6 +19,6 @@
 var app = builder.Build();
 app.UseRaygun();
 app.MapEndpoints();
-await app.BuildDatabaseAsync();
 
+await app.BuildDatabaseAsync();
 await app.RunAsync();

src/Notifications.API/REST-Samples/successes.http

@@ -5,6 +5,10 @@
 @ApiKey = client-api-key-1
 @ApiKey2 = client-api-key-2
 
+### Connect to API
+GET {{HostAddress}}
+Accept: application/json
+
 ### Check health.
 GET {{HostAddress}}/health
 Accept: application/json

tests/Notifications.API.Tests/AddNotificationTests.cs

@@ -22,10 +22,10 @@ public async Task Setup()
     }
 
     [TearDown]
-    public void TearDown()
+    public async Task TearDown()
     {
-        _dbContext.Database.EnsureDeleted();
-        _dbContext.Dispose();
+        await _dbContext.Database.EnsureDeletedAsync();
+        await _dbContext.DisposeAsync();
     }
 
     [Test]

tests/Notifications.API.Tests/DeactivateNotificationTests.cs

@@ -23,10 +23,10 @@ public async Task Setup()
     }
 
     [TearDown]
-    public void TearDown()
+    public async Task TearDown()
     {
-        _dbContext.Database.EnsureDeleted();
-        _dbContext.Dispose();
+        await _dbContext.Database.EnsureDeletedAsync();
+        await _dbContext.DisposeAsync();
     }
 
     [Test]

tests/Notifications.API.Tests/GetNotificationsTests.cs

@@ -21,10 +21,10 @@ public async Task Setup()
     }
 
     [TearDown]
-    public void TearDown()
+    public async Task TearDown()
     {
-        _dbContext.Database.EnsureDeleted();
-        _dbContext.Dispose();
+        await _dbContext.Database.EnsureDeletedAsync();
+        await _dbContext.DisposeAsync();
     }
 
     [Test]

tests/Notifications.API.Tests/HealthCheckTests.cs

@@ -0,0 +1,39 @@
+using Microsoft.AspNetCore.Http.HttpResults;
+using Microsoft.EntityFrameworkCore;
+using Notifications.Database;
+
+namespace Notifications.API.Tests;
+
+[TestFixture]
+public class HealthCheckTests
+{
+    private AppDbContext _dbContext;
+
+    [SetUp]
+    public async Task Setup()
+    {
+        var options = new DbContextOptionsBuilder<AppDbContext>()
+            .UseInMemoryDatabase(databaseName: "RepositoryTest")
+            .Options;
+
+        _dbContext = new AppDbContext(options);
+        await _dbContext.Database.EnsureCreatedAsync();
+    }
+
+    [TearDown]
+    public async Task TearDown()
+    {
+        await _dbContext.Database.EnsureDeletedAsync();
+        await _dbContext.DisposeAsync();
+    }
+
+    [Test]
+    public async Task DbAvailable_IfAvailable()
+    {
+        // Act
+        var results = await Repository.DbAvailable(_dbContext);
+
+        // Assert
+        results.Should().BeOfType<Ok<string>>();
+    }
+}