Files
agent-framework/dotnet/tests/Microsoft.Agents.AI.OpenAI.UnitTests/Extensions/OpenAIAssistantClientExtensionsTests.cs
Copilot 958e6d27ce .NET: Improve unit test coverage for Microsoft.Agents.AI.OpenAI (#3349)
* Initial plan

* Add unit tests for Microsoft.Agents.AI.OpenAI to improve code coverage

Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com>

* Address code review feedback: remove unused using directives

Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com>

* Fix format issues: file encoding and remove unused using directives

Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com>

* Fix redundant cast error by using named parameter

Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com>

* Remove excessive inline comments per PR review feedback

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com>
2026-01-22 16:48:52 +00:00

1014 lines
36 KiB
C#

// Copyright (c) Microsoft. All rights reserved.
#pragma warning disable CS0618 // Type or member is obsolete - This is intentional as we are testing deprecated methods
using System;
using System.ClientModel;
using System.ClientModel.Primitives;
using System.IO;
using System.Reflection;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.AI;
using OpenAI.Assistants;
namespace Microsoft.Agents.AI.OpenAI.UnitTests.Extensions;
/// <summary>
/// Unit tests for the <see cref="OpenAIAssistantClientExtensions"/> class.
/// </summary>
public sealed class OpenAIAssistantClientExtensionsTests
{
/// <summary>
/// Verify that CreateAIAgent with clientFactory parameter correctly applies the factory.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithClientFactory_AppliesFactoryCorrectlyAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
var testChatClient = new TestChatClient(assistantClient.AsIChatClient("test-model"));
const string ModelId = "test-model";
// Act
var agent = await assistantClient.CreateAIAgentAsync(
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<TestChatClient>();
Assert.NotNull(retrievedTestClient);
Assert.Same(testChatClient, retrievedTestClient);
}
/// <summary>
/// Verify that CreateAIAgent with clientFactory using AsBuilder pattern works correctly.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithClientFactoryUsingAsBuilder_AppliesFactoryCorrectlyAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
TestChatClient? testChatClient = null;
const string ModelId = "test-model";
// Act
var agent = await assistantClient.CreateAIAgentAsync(
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<TestChatClient>();
Assert.NotNull(retrievedTestClient);
Assert.Same(testChatClient, retrievedTestClient);
}
/// <summary>
/// Verify that CreateAIAgent with options and clientFactory parameter correctly applies the factory.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithOptionsAndClientFactory_AppliesFactoryCorrectlyAsync()
{
// 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",
ChatOptions = new() { Instructions = "Test instructions" }
};
// Act
var agent = await assistantClient.CreateAIAgentAsync(
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<TestChatClient>();
Assert.NotNull(retrievedTestClient);
Assert.Same(testChatClient, retrievedTestClient);
}
/// <summary>
/// Verify that CreateAIAgent without clientFactory works normally.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithoutClientFactory_WorksNormallyAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
const string ModelId = "test-model";
// Act
var agent = await assistantClient.CreateAIAgentAsync(
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<TestChatClient>();
Assert.Null(retrievedTestClient);
}
/// <summary>
/// Verify that CreateAIAgent with null clientFactory works normally.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithNullClientFactory_WorksNormallyAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
const string ModelId = "test-model";
// Act
var agent = await assistantClient.CreateAIAgentAsync(
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<TestChatClient>();
Assert.Null(retrievedTestClient);
}
/// <summary>
/// Verify that CreateAIAgent throws ArgumentNullException when client is null.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithNullClient_ThrowsArgumentNullExceptionAsync()
{
// Act & Assert
var exception = await Assert.ThrowsAsync<ArgumentNullException>(() =>
((AssistantClient)null!).CreateAIAgentAsync("test-model"));
Assert.Equal("client", exception.ParamName);
}
/// <summary>
/// Verify that CreateAIAgent throws ArgumentNullException when model is null.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithNullModel_ThrowsArgumentNullExceptionAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
// Act & Assert
var exception = await Assert.ThrowsAsync<ArgumentNullException>(() =>
assistantClient.CreateAIAgentAsync(null!));
Assert.Equal("model", exception.ParamName);
}
/// <summary>
/// Verify that CreateAIAgent with options throws ArgumentNullException when options is null.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithNullOptions_ThrowsArgumentNullExceptionAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
// Act & Assert
var exception = await Assert.ThrowsAsync<ArgumentNullException>(() =>
assistantClient.CreateAIAgentAsync("test-model", (ChatClientAgentOptions)null!));
Assert.Equal("options", exception.ParamName);
}
/// <summary>
/// Verify that AsAIAgent with ClientResult and options works correctly.
/// </summary>
[Fact]
public void AsAIAgent_WithClientResultAndOptions_WorksCorrectly()
{
// Arrange
var assistantClient = new TestAssistantClient();
var assistant = ModelReaderWriter.Read<Assistant>(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",
ChatOptions = new() { Instructions = "Override Instructions" }
};
// Act
var agent = assistantClient.AsAIAgent(clientResult, options);
// Assert
Assert.NotNull(agent);
Assert.Equal("Override Name", agent.Name);
Assert.Equal("Override Description", agent.Description);
Assert.Equal("Override Instructions", agent.Instructions);
}
/// <summary>
/// Verify that AsAIAgent with Assistant and options works correctly.
/// </summary>
[Fact]
public void AsAIAgent_WithAssistantAndOptions_WorksCorrectly()
{
// Arrange
var assistantClient = new TestAssistantClient();
var assistant = ModelReaderWriter.Read<Assistant>(BinaryData.FromString("""{"id": "asst_abc123", "name": "Original Name", "description": "Original Description", "instructions": "Original Instructions"}"""))!;
var options = new ChatClientAgentOptions
{
Name = "Override Name",
Description = "Override Description",
ChatOptions = new() { Instructions = "Override Instructions" }
};
// Act
var agent = assistantClient.AsAIAgent(assistant, options);
// Assert
Assert.NotNull(agent);
Assert.Equal("Override Name", agent.Name);
Assert.Equal("Override Description", agent.Description);
Assert.Equal("Override Instructions", agent.Instructions);
}
/// <summary>
/// Verify that AsAIAgent with Assistant and options falls back to assistant metadata when options are null.
/// </summary>
[Fact]
public void AsAIAgent_WithAssistantAndOptionsWithNullFields_FallsBackToAssistantMetadata()
{
// Arrange
var assistantClient = new TestAssistantClient();
var assistant = ModelReaderWriter.Read<Assistant>(BinaryData.FromString("""{"id": "asst_abc123", "name": "Original Name", "description": "Original Description", "instructions": "Original Instructions"}"""))!;
var options = new ChatClientAgentOptions(); // Empty options
// Act
var agent = assistantClient.AsAIAgent(assistant, options);
// Assert
Assert.NotNull(agent);
Assert.Equal("Original Name", agent.Name);
Assert.Equal("Original Description", agent.Description);
Assert.Equal("Original Instructions", agent.Instructions);
}
/// <summary>
/// Verify that GetAIAgentAsync with agentId and options works correctly.
/// </summary>
[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",
ChatOptions = new() { 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);
}
/// <summary>
/// Verify that AsAIAgent with clientFactory parameter correctly applies the factory.
/// </summary>
[Fact]
public void AsAIAgent_WithClientFactory_AppliesFactoryCorrectly()
{
// Arrange
var assistantClient = new TestAssistantClient();
var assistant = ModelReaderWriter.Read<Assistant>(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.AsAIAgent(
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<TestChatClient>();
Assert.NotNull(retrievedTestClient);
Assert.Same(testChatClient, retrievedTestClient);
}
/// <summary>
/// Verify that AsAIAgent throws ArgumentNullException when assistantClientResult is null.
/// </summary>
[Fact]
public void AsAIAgent_WithNullClientResult_ThrowsArgumentNullException()
{
// Arrange
var assistantClient = new TestAssistantClient();
var options = new ChatClientAgentOptions();
// Act & Assert
var exception = Assert.Throws<ArgumentNullException>(() =>
assistantClient.AsAIAgent(null!, options));
Assert.Equal("assistantClientResult", exception.ParamName);
}
/// <summary>
/// Verify that AsAIAgent throws ArgumentNullException when assistant is null.
/// </summary>
[Fact]
public void AsAIAgent_WithNullAssistant_ThrowsArgumentNullException()
{
// Arrange
var assistantClient = new TestAssistantClient();
var options = new ChatClientAgentOptions();
// Act & Assert
var exception = Assert.Throws<ArgumentNullException>(() =>
assistantClient.AsAIAgent((Assistant)null!, options));
Assert.Equal("assistantMetadata", exception.ParamName);
}
/// <summary>
/// Verify that AsAIAgent throws ArgumentNullException when options is null.
/// </summary>
[Fact]
public void AsAIAgent_WithNullOptions_ThrowsArgumentNullException()
{
// Arrange
var assistantClient = new TestAssistantClient();
var assistant = ModelReaderWriter.Read<Assistant>(BinaryData.FromString("""{"id": "asst_abc123"}"""))!;
// Act & Assert
var exception = Assert.Throws<ArgumentNullException>(() =>
assistantClient.AsAIAgent(assistant, (ChatClientAgentOptions)null!));
Assert.Equal("options", exception.ParamName);
}
/// <summary>
/// Verify that GetAIAgentAsync throws ArgumentException when agentId is empty.
/// </summary>
[Fact]
public async Task GetAIAgentAsync_WithEmptyAgentId_ThrowsArgumentExceptionAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
var options = new ChatClientAgentOptions();
// Act & Assert
var exception = await Assert.ThrowsAsync<ArgumentException>(() =>
assistantClient.GetAIAgentAsync(string.Empty, options));
Assert.Equal("agentId", exception.ParamName);
}
/// <summary>
/// Verify that CreateAIAgent with services parameter correctly passes it through to the ChatClientAgent.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithServices_PassesServicesToAgentAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
var serviceProvider = new TestServiceProvider();
const string ModelId = "test-model";
// Act
var agent = await assistantClient.CreateAIAgentAsync(
ModelId,
instructions: "Test instructions",
name: "Test Agent",
services: serviceProvider);
// Assert
Assert.NotNull(agent);
// Verify the IServiceProvider was passed through to the FunctionInvokingChatClient
var chatClient = agent.GetService<IChatClient>();
Assert.NotNull(chatClient);
var functionInvokingClient = chatClient.GetService<FunctionInvokingChatClient>();
Assert.NotNull(functionInvokingClient);
Assert.Same(serviceProvider, GetFunctionInvocationServices(functionInvokingClient));
}
/// <summary>
/// Verify that CreateAIAgent with options and services parameter correctly passes it through to the ChatClientAgent.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithOptionsAndServices_PassesServicesToAgentAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
var serviceProvider = new TestServiceProvider();
const string ModelId = "test-model";
var options = new ChatClientAgentOptions
{
Name = "Test Agent",
ChatOptions = new() { Instructions = "Test instructions" }
};
// Act
var agent = await assistantClient.CreateAIAgentAsync(ModelId, options, services: serviceProvider);
// Assert
Assert.NotNull(agent);
Assert.Equal("Test Agent", agent.Name);
// Verify the IServiceProvider was passed through to the FunctionInvokingChatClient
var chatClient = agent.GetService<IChatClient>();
Assert.NotNull(chatClient);
var functionInvokingClient = chatClient.GetService<FunctionInvokingChatClient>();
Assert.NotNull(functionInvokingClient);
Assert.Same(serviceProvider, GetFunctionInvocationServices(functionInvokingClient));
}
/// <summary>
/// Verify that AsAIAgent with services parameter correctly passes it through to the ChatClientAgent.
/// </summary>
[Fact]
public void AsAIAgent_WithServices_PassesServicesToAgent()
{
// Arrange
var assistantClient = new TestAssistantClient();
var serviceProvider = new TestServiceProvider();
var assistant = ModelReaderWriter.Read<Assistant>(BinaryData.FromString("""{"id": "asst_abc123", "name": "Test Agent"}"""))!;
// Act
var agent = assistantClient.AsAIAgent(assistant, services: serviceProvider);
// Assert
Assert.NotNull(agent);
// Verify the IServiceProvider was passed through to the FunctionInvokingChatClient
var chatClient = agent.GetService<IChatClient>();
Assert.NotNull(chatClient);
var functionInvokingClient = chatClient.GetService<FunctionInvokingChatClient>();
Assert.NotNull(functionInvokingClient);
Assert.Same(serviceProvider, GetFunctionInvocationServices(functionInvokingClient));
}
/// <summary>
/// Verify that GetAIAgentAsync with services parameter correctly passes it through to the ChatClientAgent.
/// </summary>
[Fact]
public async Task GetAIAgentAsync_WithServices_PassesServicesToAgentAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
var serviceProvider = new TestServiceProvider();
// Act
var agent = await assistantClient.GetAIAgentAsync("asst_abc123", services: serviceProvider);
// Assert
Assert.NotNull(agent);
// Verify the IServiceProvider was passed through to the FunctionInvokingChatClient
var chatClient = agent.GetService<IChatClient>();
Assert.NotNull(chatClient);
var functionInvokingClient = chatClient.GetService<FunctionInvokingChatClient>();
Assert.NotNull(functionInvokingClient);
Assert.Same(serviceProvider, GetFunctionInvocationServices(functionInvokingClient));
}
/// <summary>
/// Verify that CreateAIAgent with both clientFactory and services works correctly.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithClientFactoryAndServices_AppliesBothCorrectlyAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
var serviceProvider = new TestServiceProvider();
var testChatClient = new TestChatClient(assistantClient.AsIChatClient("test-model"));
const string ModelId = "test-model";
// Act
var agent = await assistantClient.CreateAIAgentAsync(
ModelId,
instructions: "Test instructions",
name: "Test Agent",
clientFactory: (innerClient) => testChatClient,
services: serviceProvider);
// Assert
Assert.NotNull(agent);
// Verify the custom chat client was applied
var retrievedTestClient = agent.GetService<TestChatClient>();
Assert.NotNull(retrievedTestClient);
Assert.Same(testChatClient, retrievedTestClient);
// Verify the IServiceProvider was passed through
var chatClient = agent.GetService<IChatClient>();
Assert.NotNull(chatClient);
var functionInvokingClient = chatClient.GetService<FunctionInvokingChatClient>();
Assert.NotNull(functionInvokingClient);
Assert.Same(serviceProvider, GetFunctionInvocationServices(functionInvokingClient));
}
/// <summary>
/// Uses reflection to access the FunctionInvocationServices property which is not public.
/// </summary>
private static IServiceProvider? GetFunctionInvocationServices(FunctionInvokingChatClient client)
{
var property = typeof(FunctionInvokingChatClient).GetProperty(
"FunctionInvocationServices",
BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic);
return property?.GetValue(client) as IServiceProvider;
}
/// <summary>
/// Verify that CreateAIAgentAsync with HostedCodeInterpreterTool properly adds CodeInterpreter tool definition.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithHostedCodeInterpreterTool_CreatesAgentWithToolAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
const string ModelId = "test-model";
var options = new ChatClientAgentOptions
{
Name = "Test Agent",
ChatOptions = new ChatOptions
{
Instructions = "Test instructions",
Tools = [new HostedCodeInterpreterTool()]
}
};
// Act
var agent = await assistantClient.CreateAIAgentAsync(ModelId, options);
// Assert
Assert.NotNull(agent);
Assert.Equal("Test Agent", agent.Name);
}
/// <summary>
/// Verify that CreateAIAgentAsync with HostedCodeInterpreterTool with HostedFileContent input properly creates agent.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithHostedCodeInterpreterToolAndHostedFileContent_CreatesAgentWithToolResourcesAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
const string ModelId = "test-model";
var codeInterpreterTool = new HostedCodeInterpreterTool
{
Inputs = [new HostedFileContent("test-file-id")]
};
var options = new ChatClientAgentOptions
{
Name = "Test Agent",
ChatOptions = new ChatOptions
{
Instructions = "Test instructions",
Tools = [codeInterpreterTool]
}
};
// Act
var agent = await assistantClient.CreateAIAgentAsync(ModelId, options);
// Assert
Assert.NotNull(agent);
Assert.Equal("Test Agent", agent.Name);
}
/// <summary>
/// Verify that CreateAIAgentAsync with HostedFileSearchTool properly adds FileSearch tool definition.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithHostedFileSearchTool_CreatesAgentWithToolAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
const string ModelId = "test-model";
var options = new ChatClientAgentOptions
{
Name = "Test Agent",
ChatOptions = new ChatOptions
{
Instructions = "Test instructions",
Tools = [new HostedFileSearchTool()]
}
};
// Act
var agent = await assistantClient.CreateAIAgentAsync(ModelId, options);
// Assert
Assert.NotNull(agent);
Assert.Equal("Test Agent", agent.Name);
}
/// <summary>
/// Verify that CreateAIAgentAsync with HostedFileSearchTool with HostedVectorStoreContent input properly creates agent.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithHostedFileSearchToolAndHostedVectorStoreContent_CreatesAgentWithToolResourcesAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
const string ModelId = "test-model";
var fileSearchTool = new HostedFileSearchTool
{
MaximumResultCount = 10,
Inputs = [new HostedVectorStoreContent("test-vector-store-id")]
};
var options = new ChatClientAgentOptions
{
Name = "Test Agent",
ChatOptions = new ChatOptions
{
Instructions = "Test instructions",
Tools = [fileSearchTool]
}
};
// Act
var agent = await assistantClient.CreateAIAgentAsync(ModelId, options);
// Assert
Assert.NotNull(agent);
Assert.Equal("Test Agent", agent.Name);
}
/// <summary>
/// Verify that CreateAIAgentAsync with multiple tools including functions properly creates agent.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithMixedTools_CreatesAgentWithAllToolsAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
const string ModelId = "test-model";
var testFunction = AIFunctionFactory.Create(() => "test", "TestFunction", "A test function");
var options = new ChatClientAgentOptions
{
Name = "Test Agent",
ChatOptions = new ChatOptions
{
Instructions = "Test instructions",
Tools = [new HostedCodeInterpreterTool(), new HostedFileSearchTool(), testFunction]
}
};
// Act
var agent = await assistantClient.CreateAIAgentAsync(ModelId, options);
// Assert
Assert.NotNull(agent);
Assert.Equal("Test Agent", agent.Name);
}
/// <summary>
/// Verify that CreateAIAgentAsync with function tools properly categorizes them as other tools.
/// </summary>
[Fact]
public async Task CreateAIAgentAsync_WithFunctionTools_CategorizesAsOtherToolsAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
const string ModelId = "test-model";
var testFunction = AIFunctionFactory.Create(() => "test", "TestFunction", "A test function");
var options = new ChatClientAgentOptions
{
Name = "Test Agent",
ChatOptions = new ChatOptions
{
Instructions = "Test instructions",
Tools = [testFunction]
}
};
// Act
var agent = await assistantClient.CreateAIAgentAsync(ModelId, options);
// Assert
Assert.NotNull(agent);
Assert.Equal("Test Agent", agent.Name);
}
/// <summary>
/// Verify that AsAIAgent with legacy overload works correctly when assistant instructions are set.
/// </summary>
[Fact]
public void AsAIAgent_LegacyOverload_WithAssistantInstructions_SetsInstructions()
{
// Arrange
var assistantClient = new TestAssistantClient();
var assistant = ModelReaderWriter.Read<Assistant>(BinaryData.FromString("""{"id": "asst_abc123", "name": "Test Agent", "instructions": "Original Instructions"}"""))!;
// Act
var agent = assistantClient.AsAIAgent(assistant);
// Assert
Assert.NotNull(agent);
Assert.Equal("Test Agent", agent.Name);
Assert.Equal("Original Instructions", agent.Instructions);
}
/// <summary>
/// Verify that AsAIAgent with legacy overload works correctly when chatOptions with instructions is provided.
/// </summary>
[Fact]
public void AsAIAgent_LegacyOverload_WithChatOptionsInstructions_UsesChatOptionsInstructions()
{
// Arrange
var assistantClient = new TestAssistantClient();
var assistant = ModelReaderWriter.Read<Assistant>(BinaryData.FromString("""{"id": "asst_abc123", "name": "Test Agent", "instructions": "Original Instructions"}"""))!;
var chatOptions = new ChatOptions { Instructions = "Override Instructions" };
// Act
var agent = assistantClient.AsAIAgent(assistant, chatOptions);
// Assert
Assert.NotNull(agent);
Assert.Equal("Test Agent", agent.Name);
Assert.Equal("Override Instructions", agent.Instructions);
}
/// <summary>
/// Verify that AsAIAgent with legacy overload and ClientResult works correctly.
/// </summary>
[Fact]
public void AsAIAgent_LegacyOverload_WithClientResult_WorksCorrectly()
{
// Arrange
var assistantClient = new TestAssistantClient();
var assistant = ModelReaderWriter.Read<Assistant>(BinaryData.FromString("""{"id": "asst_abc123", "name": "Test Agent", "instructions": "Original Instructions"}"""))!;
var clientResult = ClientResult.FromValue(assistant, new FakePipelineResponse());
// Act
var agent = assistantClient.AsAIAgent(clientResult);
// Assert
Assert.NotNull(agent);
Assert.Equal("Test Agent", agent.Name);
}
/// <summary>
/// Verify that AsAIAgent with legacy overload throws ArgumentNullException when assistant client is null.
/// </summary>
[Fact]
public void AsAIAgent_LegacyOverload_WithNullAssistantClient_ThrowsArgumentNullException()
{
// Arrange
AssistantClient? assistantClient = null;
var assistant = ModelReaderWriter.Read<Assistant>(BinaryData.FromString("""{"id": "asst_abc123"}"""))!;
// Act & Assert
var exception = Assert.Throws<ArgumentNullException>(() =>
assistantClient!.AsAIAgent(assistant));
Assert.Equal("assistantClient", exception.ParamName);
}
/// <summary>
/// Verify that AsAIAgent with legacy overload throws ArgumentNullException when assistantMetadata is null.
/// </summary>
[Fact]
public void AsAIAgent_LegacyOverload_WithNullAssistantMetadata_ThrowsArgumentNullException()
{
// Arrange
var assistantClient = new TestAssistantClient();
// Act & Assert
var exception = Assert.Throws<ArgumentNullException>(() =>
assistantClient.AsAIAgent((Assistant)null!));
Assert.Equal("assistantMetadata", exception.ParamName);
}
/// <summary>
/// Verify that AsAIAgent with legacy overload throws ArgumentNullException when clientResult is null.
/// </summary>
[Fact]
public void AsAIAgent_LegacyOverload_WithNullClientResult_ThrowsArgumentNullException()
{
// Arrange
var assistantClient = new TestAssistantClient();
// Act & Assert
var exception = Assert.Throws<ArgumentNullException>(() =>
assistantClient.AsAIAgent(null!, chatOptions: null));
Assert.Equal("assistantClientResult", exception.ParamName);
}
/// <summary>
/// Verify that GetAIAgentAsync with legacy overload works correctly.
/// </summary>
[Fact]
public async Task GetAIAgentAsync_LegacyOverload_WorksCorrectlyAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
const string AgentId = "asst_abc123";
// Act
var agent = await assistantClient.GetAIAgentAsync(AgentId);
// Assert
Assert.NotNull(agent);
Assert.Equal("Original Name", agent.Name);
}
/// <summary>
/// Verify that GetAIAgentAsync with legacy overload throws ArgumentNullException when assistantClient is null.
/// </summary>
[Fact]
public async Task GetAIAgentAsync_LegacyOverload_WithNullAssistantClient_ThrowsArgumentNullExceptionAsync()
{
// Arrange
AssistantClient? assistantClient = null;
// Act & Assert
var exception = await Assert.ThrowsAsync<ArgumentNullException>(() =>
assistantClient!.GetAIAgentAsync("asst_abc123"));
Assert.Equal("assistantClient", exception.ParamName);
}
/// <summary>
/// Verify that GetAIAgentAsync with legacy overload throws ArgumentException when agentId is empty.
/// </summary>
[Fact]
public async Task GetAIAgentAsync_LegacyOverload_WithEmptyAgentId_ThrowsArgumentExceptionAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
// Act & Assert
var exception = await Assert.ThrowsAsync<ArgumentException>(() =>
assistantClient.GetAIAgentAsync(string.Empty));
Assert.Equal("agentId", exception.ParamName);
}
/// <summary>
/// Verify that GetAIAgentAsync with options throws ArgumentNullException when assistantClient is null.
/// </summary>
[Fact]
public async Task GetAIAgentAsync_WithOptions_WithNullAssistantClient_ThrowsArgumentNullExceptionAsync()
{
// Arrange
AssistantClient? assistantClient = null;
var options = new ChatClientAgentOptions();
// Act & Assert
var exception = await Assert.ThrowsAsync<ArgumentNullException>(() =>
assistantClient!.GetAIAgentAsync("asst_abc123", options));
Assert.Equal("assistantClient", exception.ParamName);
}
/// <summary>
/// Verify that GetAIAgentAsync with options throws ArgumentNullException when options is null.
/// </summary>
[Fact]
public async Task GetAIAgentAsync_WithOptions_WithNullOptions_ThrowsArgumentNullExceptionAsync()
{
// Arrange
var assistantClient = new TestAssistantClient();
// Act & Assert
var exception = await Assert.ThrowsAsync<ArgumentNullException>(() =>
assistantClient.GetAIAgentAsync("asst_abc123", (ChatClientAgentOptions)null!));
Assert.Equal("options", exception.ParamName);
}
/// <summary>
/// Verify that AsAIAgent with options throws ArgumentNullException when assistantClient is null.
/// </summary>
[Fact]
public void AsAIAgent_WithOptions_WithNullAssistantClient_ThrowsArgumentNullException()
{
// Arrange
AssistantClient? assistantClient = null;
var assistant = ModelReaderWriter.Read<Assistant>(BinaryData.FromString("""{"id": "asst_abc123"}"""))!;
var options = new ChatClientAgentOptions();
// Act & Assert
var exception = Assert.Throws<ArgumentNullException>(() =>
assistantClient!.AsAIAgent(assistant, options));
Assert.Equal("assistantClient", exception.ParamName);
}
/// <summary>
/// Creates a test AssistantClient implementation for testing.
/// </summary>
private sealed class TestAssistantClient : AssistantClient
{
public TestAssistantClient()
{
}
public override Task<ClientResult<Assistant>> CreateAssistantAsync(string model, AssistantCreationOptions? options = null, CancellationToken cancellationToken = default)
{
return Task.FromResult<ClientResult<Assistant>>(ClientResult.FromValue(ModelReaderWriter.Read<Assistant>(BinaryData.FromString("""{"id": "asst_abc123"}""")), new FakePipelineResponse())!);
}
public override async Task<ClientResult<Assistant>> GetAssistantAsync(string assistantId, CancellationToken cancellationToken = default)
{
await Task.Delay(1, cancellationToken); // Simulate async operation
return ClientResult.FromValue(ModelReaderWriter.Read<Assistant>(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 TestServiceProvider : IServiceProvider
{
public object? GetService(Type serviceType) => null;
}
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<BinaryData> BufferContentAsync(CancellationToken cancellationToken = default)
{
throw new NotImplementedException();
}
public override void Dispose()
{
throw new NotImplementedException();
}
}
}