// Copyright (c) Microsoft. All rights reserved. using System; using System.Collections.Generic; using System.Runtime.CompilerServices; using System.Threading; using System.Threading.Tasks; using Microsoft.Extensions.AI; using OpenAI.Chat; using ChatMessage = Microsoft.Extensions.AI.ChatMessage; using OpenAIChatClient = OpenAI.Chat.ChatClient; namespace Microsoft.Agents.AI.OpenAI.UnitTests.Extensions; /// /// Unit tests for the class. /// public sealed class OpenAIChatClientExtensionsTests { /// /// Test custom chat client that can be used to verify clientFactory functionality. /// private sealed class TestChatClient : IChatClient { private readonly IChatClient _innerClient; public TestChatClient(IChatClient innerClient) { this._innerClient = innerClient; } public Task GetResponseAsync(IEnumerable messages, ChatOptions? options = null, CancellationToken cancellationToken = default) => this._innerClient.GetResponseAsync(messages, options, cancellationToken); public async IAsyncEnumerable GetStreamingResponseAsync( IEnumerable messages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) { await foreach (var update in this._innerClient.GetStreamingResponseAsync(messages, options, cancellationToken)) { yield return update; } } public object? GetService(Type serviceType, object? serviceKey = null) { // Return this instance when requested if (serviceType == typeof(TestChatClient)) { return this; } return this._innerClient.GetService(serviceType, serviceKey); } public void Dispose() => this._innerClient.Dispose(); } /// /// Creates a test ChatClient implementation for testing. /// private sealed class TestOpenAIChatClient : OpenAIChatClient { public TestOpenAIChatClient() { } } /// /// Verify that CreateAIAgent with clientFactory parameter correctly applies the factory. /// [Fact] public void CreateAIAgent_WithClientFactory_AppliesFactoryCorrectly() { // Arrange var chatClient = new TestOpenAIChatClient(); var testChatClient = new TestChatClient(chatClient.AsIChatClient()); // Act var agent = chatClient.AsAIAgent( instructions: "Test instructions", name: "Test Agent", description: "Test description", clientFactory: (innerClient) => testChatClient); // Assert Assert.NotNull(agent); Assert.Equal("Test Agent", agent.Name); Assert.Equal("Test description", agent.Description); // Verify that the custom chat client can be retrieved from the agent's service collection var retrievedTestClient = agent.GetService(); Assert.NotNull(retrievedTestClient); Assert.Same(testChatClient, retrievedTestClient); } /// /// Verify that CreateAIAgent with clientFactory using AsBuilder pattern works correctly. /// [Fact] public void CreateAIAgent_WithClientFactoryUsingAsBuilder_AppliesFactoryCorrectly() { // Arrange var chatClient = new TestOpenAIChatClient(); TestChatClient? testChatClient = null; // Act var agent = chatClient.AsAIAgent( instructions: "Test instructions", clientFactory: (innerClient) => innerClient.AsBuilder().Use((innerClient) => testChatClient = new TestChatClient(innerClient)).Build()); // Assert Assert.NotNull(agent); // Verify that the custom chat client can be retrieved from the agent's service collection var retrievedTestClient = agent.GetService(); Assert.NotNull(retrievedTestClient); Assert.Same(testChatClient, retrievedTestClient); } /// /// Verify that CreateAIAgent with options and clientFactory parameter correctly applies the factory. /// [Fact] public void CreateAIAgent_WithOptionsAndClientFactory_AppliesFactoryCorrectly() { // Arrange var chatClient = new TestOpenAIChatClient(); var testChatClient = new TestChatClient(chatClient.AsIChatClient()); var options = new ChatClientAgentOptions { Name = "Test Agent", Description = "Test description", ChatOptions = new() { Instructions = "Test instructions" } }; // Act var agent = chatClient.AsAIAgent( options, clientFactory: (innerClient) => testChatClient); // Assert Assert.NotNull(agent); Assert.Equal("Test Agent", agent.Name); Assert.Equal("Test description", agent.Description); // Verify that the custom chat client can be retrieved from the agent's service collection var retrievedTestClient = agent.GetService(); Assert.NotNull(retrievedTestClient); Assert.Same(testChatClient, retrievedTestClient); } /// /// Verify that CreateAIAgent without clientFactory works normally. /// [Fact] public void CreateAIAgent_WithoutClientFactory_WorksNormally() { // Arrange var chatClient = new TestOpenAIChatClient(); // Act var agent = chatClient.AsAIAgent( instructions: "Test instructions", name: "Test Agent"); // Assert Assert.NotNull(agent); Assert.Equal("Test Agent", agent.Name); // Verify that no TestChatClient is available since no factory was provided var retrievedTestClient = agent.GetService(); Assert.Null(retrievedTestClient); } /// /// Verify that CreateAIAgent with null clientFactory works normally. /// [Fact] public void CreateAIAgent_WithNullClientFactory_WorksNormally() { // Arrange var chatClient = new TestOpenAIChatClient(); // Act var agent = chatClient.AsAIAgent( instructions: "Test instructions", name: "Test Agent", clientFactory: null); // Assert Assert.NotNull(agent); Assert.Equal("Test Agent", agent.Name); // Verify that no TestChatClient is available since no factory was provided var retrievedTestClient = agent.GetService(); Assert.Null(retrievedTestClient); } /// /// Verify that CreateAIAgent throws ArgumentNullException when client is null. /// [Fact] public void CreateAIAgent_WithNullClient_ThrowsArgumentNullException() { // Act & Assert var exception = Assert.Throws(() => ((OpenAIChatClient)null!).AsAIAgent()); Assert.Equal("client", exception.ParamName); } /// /// Verify that CreateAIAgent with options throws ArgumentNullException when options is null. /// [Fact] public void CreateAIAgent_WithNullOptions_ThrowsArgumentNullException() { // Arrange var chatClient = new TestOpenAIChatClient(); // Act & Assert var exception = Assert.Throws(() => chatClient.AsAIAgent((ChatClientAgentOptions)null!)); Assert.Equal("options", exception.ParamName); } }