Add unit tests for API endpoints, AI configuration, and chat service functionality

- Implement ApiEndpointSimpleTests for CRUD operations on conversations.
- Create AIConfigurationTests to validate AI provider and model retrieval.
- Add ChatServiceSimpleTests to ensure proper initialization and message processing.
- Introduce MockChatClient for testing chat client interactions.
- Enhance model validation tests for conversation models.
- Establish integration tests for conversation and message models.
- Update project files to include necessary dependencies and configurations.

Author: codebytes

.editorconfig

@@ -10,6 +10,7 @@
   </Folder>
   <Folder Name="/tests/">
     <Project Path="tests/BuildWithAspire.ApiService.UnitTests/BuildWithAspire.ApiService.UnitTests.csproj" />
+    <Project Path="tests/BuildWithAspire.AppHost.UnitTests/BuildWithAspire.AppHost.UnitTests.csproj" />
     <Project Path="tests/BuildWithAspire.Web.UnitTests/BuildWithAspire.Web.UnitTests.csproj" />
   </Folder>
 </Solution>

BuildWithAspire.slnx

@@ -10,7 +10,7 @@
   <ItemGroup>
     <PackageReference Include="Aspire.Azure.AI.OpenAI" Version="9.3.1-preview.1.25305.6" />
     <PackageReference Include="Aspire.Npgsql.EntityFrameworkCore.PostgreSQL" Version="9.3.1" />
-    <PackageReference Include="CommunityToolkit.Aspire.OllamaSharp" Version="9.5.1-beta.318" />
+    <PackageReference Include="CommunityToolkit.Aspire.OllamaSharp" Version="9.5.1-beta.319" />
     <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.6" />
     <PackageReference Include="Azure.Identity" Version="1.14.1" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="9.0.6">
@@ -23,8 +23,7 @@
     <PackageReference Include="Microsoft.Extensions.AI" Version="9.6.0" />
     <PackageReference Include="Microsoft.Extensions.AI.OpenAI" Version="9.6.0-preview.1.25310.2" />
     <PackageReference Include="Microsoft.AI.Foundry.Local" Version="0.1.0" />
-    <PackageReference Include="OpenAI" Version="2.2.0-beta.4" />    
-    <PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.1" />
+    <PackageReference Include="Scalar.AspNetCore" Version="2.5.6" />
     <PackageReference Include="System.Text.Json" Version="9.0.6" />
     <PackageReference Include="Microsoft.SemanticKernel.Connectors.OpenAI" Version="1.59.0" />
   </ItemGroup>

src/BuildWithAspire.ApiService/BuildWithAspire.ApiService.csproj

@@ -60,4 +60,4 @@ public static string GetModel(IConfiguration configuration, AIProvider? provider
             _ => throw new InvalidOperationException($"No default model available for provider: {provider}")
         };
     }
-}
+}

src/BuildWithAspire.ApiService/Configuration/AIConfiguration.cs

@@ -41,4 +41,4 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
             entity.HasIndex(e => e.ConversationId);
         });
     }
-}
+}

src/BuildWithAspire.ApiService/Data/ChatDbContext.cs

@@ -1,6 +1,6 @@
 using BuildWithAspire.ApiService.Configuration;
-using Microsoft.Extensions.AI;
 using Microsoft.AI.Foundry.Local;
+using Microsoft.Extensions.AI;
 using OpenAI;
 
 namespace BuildWithAspire.ApiService.Extensions;
@@ -108,7 +108,7 @@ private static void AddFoundryLocalAIServices(this IHostApplicationBuilder build
 /// <summary>
 /// Background service that logs AI configuration on startup.
 /// </summary>
-internal class AIConfigurationLogger : BackgroundService
+internal sealed class AIConfigurationLogger : BackgroundService
 {
     private readonly ILogger<AIConfigurationLogger> _logger;
     private readonly AIConfiguration.AISettings _aiSettings;
@@ -125,7 +125,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
             _aiSettings.Provider, _aiSettings.Model, _aiSettings.DeploymentName);
 
         // Complete immediately - this is just for logging
-        await Task.CompletedTask;
+        await Task.CompletedTask.ConfigureAwait(false);
     }
 }
 

src/BuildWithAspire.ApiService/Extensions/AIServiceExtensions.cs

@@ -4,4 +4,4 @@ public class ChatMessageRequest
 {
     public string Role { get; set; } = string.Empty;
     public string Content { get; set; } = string.Empty;
-}
+}

src/BuildWithAspire.ApiService/Models/ChatMessageRequest.cs

@@ -9,4 +9,4 @@ public class Conversation
 
     // Navigation property
     public List<Message> Messages { get; set; } = new();
-}
+}

src/BuildWithAspire.ApiService/Models/Conversation.cs

@@ -13,4 +13,4 @@ public class Message
     // Navigation property
     [JsonIgnore]
     public Conversation Conversation { get; set; } = null!;
-}
+}

src/BuildWithAspire.ApiService/Models/Message.cs

@@ -5,6 +5,7 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.AI;
+using Scalar.AspNetCore;
 using ChatRole = Microsoft.Extensions.AI.ChatRole;
 
 var builder = WebApplication.CreateBuilder(args);
@@ -19,9 +20,18 @@
 
 builder.Services.AddKernel();
 
-// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
+// Learn more about configuring OpenAPI at https://aka.ms/aspnetcore/openapi
 builder.Services.AddEndpointsApiExplorer();
-builder.Services.AddSwaggerGen();
+builder.Services.AddOpenApi(options =>
+{
+    options.AddDocumentTransformer((document, context, cancellationToken) =>
+    {
+        document.Info.Title = "BuildWithAspire API";
+        document.Info.Description = "API for BuildWithAspire application with AI chat capabilities";
+        document.Info.Version = "v1";
+        return Task.CompletedTask;
+    });
+});
 
 builder.Services.AddTransient<ChatService>();
 
@@ -32,8 +42,12 @@
 // Configure the HTTP request pipeline.
 if (app.Environment.IsDevelopment())
 {
-    app.UseSwagger();
-    app.UseSwaggerUI();
+    app.MapOpenApi();
+    app.MapScalarApiReference(options =>
+    {
+        options.WithTitle("BuildWithAspire API");
+        options.WithDefaultHttpClient(ScalarTarget.CSharp, ScalarClient.HttpClient);
+    });
 }
 
 app.UseHttpsRedirection();
@@ -48,7 +62,7 @@
         var startTime = DateTime.UtcNow;
 
         // Ensure database schema exists
-        var wasCreated = await dbContext.Database.EnsureCreatedAsync();
+        var wasCreated = await dbContext.Database.EnsureCreatedAsync().ConfigureAwait(false);
         var duration = DateTime.UtcNow - startTime;
 
         if (wasCreated)
@@ -66,15 +80,14 @@
     app.Logger.LogError(ex, "Database initialization failed. Service will continue without database.");
 }
 
-
 app.MapGet("/weatherforecast", (IChatClient client) =>
 {
     async IAsyncEnumerable<WeatherForecast> GetForecasts()
     {
         for (int index = 1; index <= 5; index++)
         {
             var temperature = Random.Shared.Next(-20, 55);
-            var summary = await GetWeatherSummary(client, temperature);
+            var summary = await GetWeatherSummary(client, temperature).ConfigureAwait(false);
             yield return new WeatherForecast
             (
                 DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
@@ -95,7 +108,7 @@ static async Task<string> GetWeatherSummary(IChatClient client, int temp)
             // User messages represent user input, whether historical or the most recent input
             new(ChatRole.User, $"How would you describe the weather at temp {temp} in celcius? Provide the response in 1 word with no punctuation.")
         };
-        var completion = await client.GetResponseAsync(conversation);
+        var completion = await client.GetResponseAsync(conversation).ConfigureAwait(false);
 
         return $"{completion.Text}";
     }
@@ -118,7 +131,7 @@ static async Task<string> GetWeatherSummary(IChatClient client, int temp)
                 c.UpdatedAt,
                 MessageCount = c.Messages.Count()
             })
-            .ToListAsync();
+            .ToListAsync().ConfigureAwait(false);
 
         return Results.Ok(conversations);
     }
@@ -137,7 +150,7 @@ static async Task<string> GetWeatherSummary(IChatClient client, int temp)
     {
         var conversation = await db.Conversations
             .Include(c => c.Messages.OrderBy(m => m.CreatedAt))
-            .FirstOrDefaultAsync(c => c.Id == id);
+            .FirstOrDefaultAsync(c => c.Id == id).ConfigureAwait(false);
 
         if (conversation == null)
         {
@@ -160,7 +173,9 @@ static async Task<string> GetWeatherSummary(IChatClient client, int temp)
     try
     {
         if (string.IsNullOrWhiteSpace(request.Name))
+        {
             return Results.BadRequest("Conversation name cannot be empty");
+        }
 
         var conversation = new Conversation
         {
@@ -171,7 +186,7 @@ static async Task<string> GetWeatherSummary(IChatClient client, int temp)
         };
 
         db.Conversations.Add(conversation);
-        await db.SaveChangesAsync();
+        await db.SaveChangesAsync().ConfigureAwait(false);
 
         return Results.Created($"/conversations/{conversation.Id}", conversation);
     }
@@ -190,14 +205,18 @@ static async Task<string> GetWeatherSummary(IChatClient client, int temp)
     {
         // Validate input
         if (string.IsNullOrWhiteSpace(request.Message))
+        {
             return Results.BadRequest("Message cannot be empty");
+        }
 
         var conversation = await db.Conversations
             .Include(c => c.Messages)
-            .FirstOrDefaultAsync(c => c.Id == id);
+            .FirstOrDefaultAsync(c => c.Id == id).ConfigureAwait(false);
 
         if (conversation == null)
+        {
             return Results.NotFound("Conversation not found");
+        }
 
         // Add user message
         var userMessage = new Message
@@ -214,7 +233,7 @@ static async Task<string> GetWeatherSummary(IChatClient client, int temp)
         conversation.UpdatedAt = DateTime.UtcNow;
 
         // Save user message first
-        await db.SaveChangesAsync();
+        await db.SaveChangesAsync().ConfigureAwait(false);
 
         // Prepare history for AI - get all messages for this conversation including the new one
         var messages = await db.Messages
@@ -225,13 +244,13 @@ static async Task<string> GetWeatherSummary(IChatClient client, int temp)
                 Role = m.Role,
                 Content = m.Content
             })
-            .ToListAsync();
+            .ToListAsync().ConfigureAwait(false);
 
         // Get AI response with timeout handling
         string aiResponse;
         try
         {
-            aiResponse = await chatService.ProcessMessagesWithHistory(messages);
+            aiResponse = await chatService.ProcessMessagesWithHistory(messages).ConfigureAwait(false);
         }
         catch (Exception ex)
         {
@@ -251,7 +270,7 @@ static async Task<string> GetWeatherSummary(IChatClient client, int temp)
 
         // Add to DbContext directly instead of through navigation property
         db.Messages.Add(assistantMessage);
-        await db.SaveChangesAsync();
+        await db.SaveChangesAsync().ConfigureAwait(false);
 
         return Results.Ok(new { response = aiResponse });
     }
@@ -266,30 +285,35 @@ static async Task<string> GetWeatherSummary(IChatClient client, int temp)
 
 app.MapDelete("/conversations/{id}", async (Guid id, ChatDbContext db) =>
 {
-    var conversation = await db.Conversations.FindAsync(id);
+    var conversation = await db.Conversations.FindAsync(id).ConfigureAwait(false);
     if (conversation == null)
+    {
         return Results.NotFound();
+    }
 
     db.Conversations.Remove(conversation);
-    await db.SaveChangesAsync();
+    await db.SaveChangesAsync().ConfigureAwait(false);
 
     return Results.NoContent();
 })
 .WithName("DeleteConversation")
 .WithOpenApi();
 
 // Keep the original chat endpoint for backward compatibility
-app.MapGet("/chat", async (ChatService chatService, string message) => await chatService.ProcessMessage(message))
+app.MapGet("/chat", async (ChatService chatService, string message) => await chatService.ProcessMessage(message).ConfigureAwait(false))
     .WithName("GetChat")
     .WithOpenApi();
 
 app.Run();
 
-record WeatherForecast(DateOnly Date, int TemperatureC, string? Summary)
+public record WeatherForecast(DateOnly Date, int TemperatureC, string? Summary)
 {
     public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
 }
 
 // Request DTOs
 public record CreateConversationRequest(string Name);
 public record SendMessageRequest(string Message);
+
+// Make Program class accessible for testing
+public partial class Program { }