Add API key configuration, fix chat context persistence, and isolate sessions by IP

.github/workflows/sonarcloud.yml

@@ -50,7 +50,7 @@ jobs:
             /k:"rrusson_DarkClippy" \
             /o:"rrusson" \
             /d:sonar.host.url="https://sonarcloud.io" \
-            /d:sonar.token="${{ SONAR_TOKEN }}" \
+            /d:sonar.token="${SONAR_TOKEN}" \
             /d:sonar.cs.opencover.reportsPaths="**/TestResults/**/coverage.opencover.xml"
 
       - name: Restore

ClippyWeb.Tests/ChatClientFactoryTests.cs

@@ -0,0 +1,80 @@
+using Microsoft.Extensions.Caching.Memory;
+
+using SemanticKernelHelper;
+
+using SharedInterfaces;
+
+namespace ClippyWeb.Tests
+{
+	[TestClass]
+	public class ChatClientFactoryTests
+	{
+		private const string TestApiUrl = "http://localhost:11434/v1";
+		private const string TestModel = "test-model";
+		private const string TestApiKey = "test-api-key";
+		private IMemoryCache _cache = null!;
+
+		[TestInitialize]
+		public void TestInitialize()
+		{
+			_cache = new MemoryCache(new MemoryCacheOptions());
+		}
+
+		[TestCleanup]
+		public void TestCleanup()
+		{
+			_cache?.Dispose();
+		}
+
+		[TestMethod]
+		public void IfSessionKeyIsProvidedThenClientIsReturned()
+		{
+			var factory = new ChatClientFactory(TestApiUrl, TestModel, TestApiKey, _cache);
+
+			var client = factory.GetOrCreateClient("test-session");
+
+			Assert.IsNotNull(client);
+		}
+
+		[TestMethod]
+		public void IfSameSessionKeyIsUsedThenSameClientIsReturned()
+		{
+			var factory = new ChatClientFactory(TestApiUrl, TestModel, TestApiKey, _cache);
+
+			var client1 = factory.GetOrCreateClient("test-session");
+			var client2 = factory.GetOrCreateClient("test-session");
+
+			Assert.AreSame(client1, client2);
+		}
+
+		[TestMethod]
+		public void IfDifferentSessionKeysAreUsedThenDifferentClientsAreReturned()
+		{
+			var factory = new ChatClientFactory(TestApiUrl, TestModel, TestApiKey, _cache);
+
+			var client1 = factory.GetOrCreateClient("session-1");
+			var client2 = factory.GetOrCreateClient("session-2");
+
+			Assert.AreNotSame(client1, client2);
+		}
+
+		[TestMethod]
+		public void IfMultipleSessionsAreConcurrentThenFactoryIsThreadSafe()
+		{
+			var factory = new ChatClientFactory(TestApiUrl, TestModel, TestApiKey, _cache);
+			var clients = new List<IChatClient>();
+			var lockObj = new object();
+
+			Parallel.For(0, 10, i =>
+			{
+				var client = factory.GetOrCreateClient($"session-{i % 3}");
+				lock (lockObj)
+				{
+					clients.Add(client);
+				}
+			});
+
+			Assert.AreEqual(10, clients.Count);
+		}
+	}
+}

ClippyWeb.Tests/ClippyWeb.Tests.csproj

@@ -21,12 +21,8 @@
 
 	<ItemGroup>
 		<ProjectReference Include="..\ClippyWeb\ClippyWeb.csproj" />
+		<ProjectReference Include="..\SemanticKernelHelper\SemanticKernelHelper.csproj" />
 		<ProjectReference Include="..\SharedInterfaces\SharedInterfaces.csproj" />
 	</ItemGroup>
 
-	<ItemGroup>
-		<Folder Include="Util\" />
-		<Folder Include="Pages\" />
-	</ItemGroup>
-
 </Project>

ClippyWeb.Tests/Controllers/ChatControllerTests.cs

@@ -1,11 +1,13 @@
+using System.Net;
+using System.Net.Sockets;
+
+using ClippyWeb.Controllers;
+
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Caching.Memory;
 using Microsoft.Extensions.Configuration;
-using System.Net;
-using System.Net.Sockets;
 
-using ClippyWeb.Controllers;
 using SharedInterfaces;
 
 namespace ClippyWeb.Tests.Controllers
@@ -17,6 +19,7 @@ namespace ClippyWeb.Tests.Controllers
 	public class ChatControllerTests
 	{
 		private Mock<IChatClient> _mockChatClient = null!;
+		private Mock<IChatClientFactory> _mockChatClientFactory = null!;
 		private IMemoryCache _memoryCache = null!;
 		private Mock<IConfiguration> _mockConfiguration = null!;
 		private ChatController _sut = null!;
@@ -25,10 +28,12 @@ public class ChatControllerTests
 		public void TestInitialize()
 		{
 			_mockChatClient = new Mock<IChatClient>();
+			_mockChatClientFactory = new Mock<IChatClientFactory>();
+			_mockChatClientFactory.Setup(f => f.GetOrCreateClient(It.IsAny<string>())).Returns(_mockChatClient.Object);
 			_memoryCache = new MemoryCache(new MemoryCacheOptions());
 			_mockConfiguration = new Mock<IConfiguration>();
 
-			_sut = new ChatController(_mockChatClient.Object, _memoryCache, _mockConfiguration.Object);
+			_sut = new ChatController(_mockChatClientFactory.Object, _memoryCache, _mockConfiguration.Object);
 			SetupHttpContext();
 		}
 

ClippyWeb.Tests/GlobalUsings.cs

@@ -1,2 +1,3 @@
 global using Microsoft.VisualStudio.TestTools.UnitTesting;
+
 global using Moq;

ClippyWeb.Tests/Pages/ErrorModelTests.cs

@@ -1,12 +1,11 @@
-using Microsoft.AspNetCore.Http;
-using Microsoft.AspNetCore.Mvc;
-using Microsoft.AspNetCore.Mvc.RazorPages;
-using Microsoft.Extensions.Configuration;
-
 using System.Diagnostics;
 
 using ClippyWeb.Pages;
 
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc.RazorPages;
+using Microsoft.Extensions.Configuration;
+
 namespace ClippyWeb.Tests.Pages
 {
 	/// <summary>

ClippyWeb.Tests/SemanticKernelClientTests.cs

@@ -0,0 +1,94 @@
+using SemanticKernelHelper;
+
+namespace ClippyWeb.Tests
+{
+	[TestClass]
+	public class SemanticKernelClientTests
+	{
+		private const string TestApiUrl = "http://localhost:11434/v1";
+		private const string TestModel = "test-model";
+		private const string TestApiKey = "test-api-key";
+
+		[TestMethod]
+		public void IfApiKeyIsProvidedThenClientIsCreated()
+		{
+			var client = new SemanticKernelClient(TestApiUrl, TestModel, TestApiKey);
+
+			Assert.IsNotNull(client);
+		}
+
+		[TestMethod]
+		public void IfApiKeyIsNullThenClientIsCreatedWithEmptyKey()
+		{
+			var client = new SemanticKernelClient(TestApiUrl, TestModel, null);
+
+			Assert.IsNotNull(client);
+		}
+
+		[TestMethod]
+		public void IfApiKeyIsNotProvidedThenClientIsCreatedWithEmptyKey()
+		{
+			var client = new SemanticKernelClient(TestApiUrl, TestModel);
+
+			Assert.IsNotNull(client);
+		}
+
+		[TestMethod]
+		public async Task IfEmptyMessageThenReturnsDefaultResponse()
+		{
+			var client = new SemanticKernelClient(TestApiUrl, TestModel, TestApiKey);
+
+			var response = await client.GetChatResponseAsync("");
+
+			Assert.AreEqual("You say something?", response);
+		}
+
+		[TestMethod]
+		public async Task IfWhitespaceMessageThenReturnsDefaultResponse()
+		{
+			var client = new SemanticKernelClient(TestApiUrl, TestModel, TestApiKey);
+
+			var response = await client.GetChatResponseAsync("   ");
+
+			Assert.AreEqual("You say something?", response);
+		}
+
+		[TestMethod]
+		public async Task IfNullMessageThenReturnsDefaultResponse()
+		{
+			var client = new SemanticKernelClient(TestApiUrl, TestModel, TestApiKey);
+
+			var response = await client.GetChatResponseAsync(null!);
+
+			Assert.AreEqual("You say something?", response);
+		}
+
+		[TestMethod]
+		[ExpectedException(typeof(ArgumentNullException))]
+		public void IfApiUrlIsNullThenThrowsArgumentNullException()
+		{
+			_ = new SemanticKernelClient(null!, TestModel, TestApiKey);
+		}
+
+		[TestMethod]
+		[ExpectedException(typeof(ArgumentNullException))]
+		public void IfModelIsNullThenThrowsArgumentNullException()
+		{
+			_ = new SemanticKernelClient(TestApiUrl, null!, TestApiKey);
+		}
+
+		[TestMethod]
+		[ExpectedException(typeof(UriFormatException))]
+		public void IfApiUrlIsInvalidThenThrowsUriFormatException()
+		{
+			_ = new SemanticKernelClient("not-a-valid-url", TestModel, TestApiKey);
+		}
+
+		[TestMethod]
+		[ExpectedException(typeof(UriFormatException))]
+		public void IfApiUrlIsNotHttpOrHttpsThenThrowsUriFormatException()
+		{
+			_ = new SemanticKernelClient("ftp://localhost:11434", TestModel, TestApiKey);
+		}
+	}
+}

ClippyWeb.Tests/Util/ConnectionValidatorTests.cs

@@ -1,6 +1,3 @@
-using System.Net;
-using System.Net.Sockets;
-
 using ClippyWeb.Util;
 
 using Microsoft.Extensions.Configuration;

ClippyWeb.Tests/Util/TcpClientFactoryTests.cs

@@ -0,0 +1,23 @@
+namespace ClippyWeb.Util.UnitTests
+{
+	/// <summary>
+	/// Unit tests for the <see cref="ClippyWeb.Util.TcpClientFactory"/> class.
+	/// </summary>
+	[TestClass]
+	public class TcpClientFactoryTests
+	{
+		/// <summary>
+		/// Tests that the Dispose method calls Dispose(bool) with true parameter.
+		/// </summary>
+		[TestMethod]
+		public void CreateWorks()
+		{
+			// Act
+			var result = new TcpClientFactory().Create();
+
+			// Assert
+			Assert.IsNotNull(result);
+			Assert.IsInstanceOfType(result, typeof(TcpClientWrapper));
+		}
+	}
+}