// Copyright (c) Microsoft. All rights reserved. using System; using System.ClientModel; using System.ClientModel.Primitives; using System.IO; using System.Threading; using System.Threading.Tasks; using Microsoft.Extensions.AI; using OpenAI; using OpenAI.Assistants; namespace Microsoft.Agents.AI.OpenAI.UnitTests.Extensions; /// /// Unit tests for the class. /// public sealed class OpenAIAssistantClientExtensionsTests { /// /// Verify that CreateAIAgent with clientFactory parameter correctly applies the factory. /// [Fact] public void CreateAIAgent_WithClientFactory_AppliesFactoryCorrectly() { // Arrange var assistantClient = new TestAssistantClient(); var testChatClient = new TestChatClient(assistantClient.AsIChatClient("test-model")); const string ModelId = "test-model"; // Act var agent = assistantClient.CreateAIAgent( ModelId, 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 assistantClient = new TestAssistantClient(); TestChatClient? testChatClient = null; const string ModelId = "test-model"; // Act var agent = assistantClient.CreateAIAgent( ModelId, 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 assistantClient = new TestAssistantClient(); var testChatClient = new TestChatClient(assistantClient.AsIChatClient("test-model")); const string ModelId = "test-model"; var options = new ChatClientAgentOptions { Name = "Test Agent", Description = "Test description", Instructions = "Test instructions" }; // Act var agent = assistantClient.CreateAIAgent( ModelId, 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 assistantClient = new TestAssistantClient(); const string ModelId = "test-model"; // Act var agent = assistantClient.CreateAIAgent( ModelId, 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 assistantClient = new TestAssistantClient(); const string ModelId = "test-model"; // Act var agent = assistantClient.CreateAIAgent( ModelId, 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(() => ((AssistantClient)null!).CreateAIAgent("test-model")); Assert.Equal("client", exception.ParamName); } /// /// Verify that CreateAIAgent throws ArgumentNullException when model is null. /// [Fact] public void CreateAIAgent_WithNullModel_ThrowsArgumentNullException() { // Arrange var assistantClient = new TestAssistantClient(); // Act & Assert var exception = Assert.Throws(() => assistantClient.CreateAIAgent(null!)); Assert.Equal("model", exception.ParamName); } /// /// Verify that CreateAIAgent with options throws ArgumentNullException when options is null. /// [Fact] public void CreateAIAgent_WithNullOptions_ThrowsArgumentNullException() { // Arrange var assistantClient = new TestAssistantClient(); // Act & Assert var exception = Assert.Throws(() => assistantClient.CreateAIAgent("test-model", (ChatClientAgentOptions)null!)); Assert.Equal("options", exception.ParamName); } /// /// Verify that GetAIAgent with ClientResult and options works correctly. /// [Fact] public void GetAIAgent_WithClientResultAndOptions_WorksCorrectly() { // Arrange var assistantClient = new TestAssistantClient(); var assistant = ModelReaderWriter.Read(BinaryData.FromString("""{"id": "asst_abc123", "name": "Original Name", "description": "Original Description", "instructions": "Original Instructions"}"""))!; var clientResult = ClientResult.FromValue(assistant, new FakePipelineResponse()); var options = new ChatClientAgentOptions { Name = "Override Name", Description = "Override Description", Instructions = "Override Instructions" }; // Act var agent = assistantClient.GetAIAgent(clientResult, options); // Assert Assert.NotNull(agent); Assert.Equal("Override Name", agent.Name); Assert.Equal("Override Description", agent.Description); Assert.Equal("Override Instructions", agent.Instructions); } /// /// Verify that GetAIAgent with Assistant and options works correctly. /// [Fact] public void GetAIAgent_WithAssistantAndOptions_WorksCorrectly() { // Arrange var assistantClient = new TestAssistantClient(); var assistant = ModelReaderWriter.Read(BinaryData.FromString("""{"id": "asst_abc123", "name": "Original Name", "description": "Original Description", "instructions": "Original Instructions"}"""))!; var options = new ChatClientAgentOptions { Name = "Override Name", Description = "Override Description", Instructions = "Override Instructions" }; // Act var agent = assistantClient.GetAIAgent(assistant, options); // Assert Assert.NotNull(agent); Assert.Equal("Override Name", agent.Name); Assert.Equal("Override Description", agent.Description); Assert.Equal("Override Instructions", agent.Instructions); } /// /// Verify that GetAIAgent with Assistant and options falls back to assistant metadata when options are null. /// [Fact] public void GetAIAgent_WithAssistantAndOptionsWithNullFields_FallsBackToAssistantMetadata() { // Arrange var assistantClient = new TestAssistantClient(); var assistant = ModelReaderWriter.Read(BinaryData.FromString("""{"id": "asst_abc123", "name": "Original Name", "description": "Original Description", "instructions": "Original Instructions"}"""))!; var options = new ChatClientAgentOptions(); // Empty options // Act var agent = assistantClient.GetAIAgent(assistant, options); // Assert Assert.NotNull(agent); Assert.Equal("Original Name", agent.Name); Assert.Equal("Original Description", agent.Description); Assert.Equal("Original Instructions", agent.Instructions); } /// /// Verify that GetAIAgent with agentId and options works correctly. /// [Fact] public void GetAIAgent_WithAgentIdAndOptions_WorksCorrectly() { // Arrange var assistantClient = new TestAssistantClient(); const string AgentId = "asst_abc123"; var options = new ChatClientAgentOptions { Name = "Override Name", Description = "Override Description", Instructions = "Override Instructions" }; // Act var agent = assistantClient.GetAIAgent(AgentId, options); // Assert Assert.NotNull(agent); Assert.Equal("Override Name", agent.Name); Assert.Equal("Override Description", agent.Description); Assert.Equal("Override Instructions", agent.Instructions); } /// /// Verify that GetAIAgentAsync with agentId and options works correctly. /// [Fact] public async Task GetAIAgentAsync_WithAgentIdAndOptions_WorksCorrectlyAsync() { // Arrange var assistantClient = new TestAssistantClient(); const string AgentId = "asst_abc123"; var options = new ChatClientAgentOptions { Name = "Override Name", Description = "Override Description", Instructions = "Override Instructions" }; // Act var agent = await assistantClient.GetAIAgentAsync(AgentId, options); // Assert Assert.NotNull(agent); Assert.Equal("Override Name", agent.Name); Assert.Equal("Override Description", agent.Description); Assert.Equal("Override Instructions", agent.Instructions); } /// /// Verify that GetAIAgent with clientFactory parameter correctly applies the factory. /// [Fact] public void GetAIAgent_WithClientFactory_AppliesFactoryCorrectly() { // Arrange var assistantClient = new TestAssistantClient(); var assistant = ModelReaderWriter.Read(BinaryData.FromString("""{"id": "asst_abc123", "name": "Test Agent"}"""))!; var testChatClient = new TestChatClient(assistantClient.AsIChatClient("asst_abc123")); var options = new ChatClientAgentOptions { Name = "Test Agent" }; // Act var agent = assistantClient.GetAIAgent( assistant, options, clientFactory: (innerClient) => testChatClient); // Assert Assert.NotNull(agent); Assert.Equal("Test Agent", agent.Name); // 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 GetAIAgent throws ArgumentNullException when assistantClientResult is null. /// [Fact] public void GetAIAgent_WithNullClientResult_ThrowsArgumentNullException() { // Arrange var assistantClient = new TestAssistantClient(); var options = new ChatClientAgentOptions(); // Act & Assert var exception = Assert.Throws(() => assistantClient.GetAIAgent((ClientResult)null!, options)); Assert.Equal("assistantClientResult", exception.ParamName); } /// /// Verify that GetAIAgent throws ArgumentNullException when assistant is null. /// [Fact] public void GetAIAgent_WithNullAssistant_ThrowsArgumentNullException() { // Arrange var assistantClient = new TestAssistantClient(); var options = new ChatClientAgentOptions(); // Act & Assert var exception = Assert.Throws(() => assistantClient.GetAIAgent((Assistant)null!, options)); Assert.Equal("assistantMetadata", exception.ParamName); } /// /// Verify that GetAIAgent throws ArgumentNullException when options is null. /// [Fact] public void GetAIAgent_WithNullOptions_ThrowsArgumentNullException() { // Arrange var assistantClient = new TestAssistantClient(); var assistant = ModelReaderWriter.Read(BinaryData.FromString("""{"id": "asst_abc123"}"""))!; // Act & Assert var exception = Assert.Throws(() => assistantClient.GetAIAgent(assistant, (ChatClientAgentOptions)null!)); Assert.Equal("options", exception.ParamName); } /// /// Verify that GetAIAgent throws ArgumentException when agentId is empty. /// [Fact] public void GetAIAgent_WithEmptyAgentId_ThrowsArgumentException() { // Arrange var assistantClient = new TestAssistantClient(); var options = new ChatClientAgentOptions(); // Act & Assert var exception = Assert.Throws(() => assistantClient.GetAIAgent(string.Empty, options)); Assert.Equal("agentId", exception.ParamName); } /// /// Verify that GetAIAgentAsync throws ArgumentException when agentId is empty. /// [Fact] public async Task GetAIAgentAsync_WithEmptyAgentId_ThrowsArgumentExceptionAsync() { // Arrange var assistantClient = new TestAssistantClient(); var options = new ChatClientAgentOptions(); // Act & Assert var exception = await Assert.ThrowsAsync(() => assistantClient.GetAIAgentAsync(string.Empty, options)); Assert.Equal("agentId", exception.ParamName); } /// /// Creates a test AssistantClient implementation for testing. /// private sealed class TestAssistantClient : AssistantClient { public TestAssistantClient() { } public override ClientResult CreateAssistant(string model, AssistantCreationOptions? options = null, CancellationToken cancellationToken = default) { return ClientResult.FromValue(ModelReaderWriter.Read(BinaryData.FromString("""{"id": "asst_abc123"}""")), new FakePipelineResponse())!; } public override ClientResult GetAssistant(string assistantId, CancellationToken cancellationToken = default) { return ClientResult.FromValue(ModelReaderWriter.Read(BinaryData.FromString("""{"id": "asst_abc123", "name": "Original Name", "description": "Original Description", "instructions": "Original Instructions"}""")), new FakePipelineResponse())!; } public override async Task> GetAssistantAsync(string assistantId, CancellationToken cancellationToken = default) { await Task.Delay(1, cancellationToken); // Simulate async operation return ClientResult.FromValue(ModelReaderWriter.Read(BinaryData.FromString("""{"id": "asst_abc123", "name": "Original Name", "description": "Original Description", "instructions": "Original Instructions"}""")), new FakePipelineResponse())!; } } private sealed class TestChatClient : DelegatingChatClient { public TestChatClient(IChatClient innerClient) : base(innerClient) { } } private sealed class FakePipelineResponse : PipelineResponse { public override int Status => throw new NotImplementedException(); public override string ReasonPhrase => throw new NotImplementedException(); public override Stream? ContentStream { get => throw new NotImplementedException(); set => throw new NotImplementedException(); } public override BinaryData Content => throw new NotImplementedException(); protected override PipelineResponseHeaders HeadersCore => throw new NotImplementedException(); public override BinaryData BufferContent(CancellationToken cancellationToken = default) { throw new NotImplementedException(); } public override ValueTask BufferContentAsync(CancellationToken cancellationToken = default) { throw new NotImplementedException(); } public override void Dispose() { throw new NotImplementedException(); } } }