mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
7cea5e162a
* Require TODO finish reason and rename SubAgents to BackgroundAgents * Address PR comments
805 lines
30 KiB
C#
805 lines
30 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using System.Text.Json;
|
|
using System.Threading.Tasks;
|
|
using Microsoft.Extensions.AI;
|
|
using Moq;
|
|
|
|
namespace Microsoft.Agents.AI.UnitTests;
|
|
|
|
/// <summary>
|
|
/// Unit tests for the <see cref="TodoProvider"/> class.
|
|
/// </summary>
|
|
public class TodoProviderTests
|
|
{
|
|
#region ProvideAIContextAsync Tests
|
|
|
|
/// <summary>
|
|
/// Verify that the provider returns tools and instructions.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task ProvideAIContextAsync_ReturnsToolsAndInstructionsAsync()
|
|
{
|
|
// Arrange
|
|
var provider = new TodoProvider();
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
|
|
// Act
|
|
AIContext result = await provider.InvokingAsync(context);
|
|
|
|
// Assert
|
|
Assert.NotNull(result.Instructions);
|
|
Assert.NotNull(result.Tools);
|
|
Assert.Equal(5, result.Tools!.Count());
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region AddTodos Tests
|
|
|
|
/// <summary>
|
|
/// Verify that AddTodos creates a new todo item when given a single item.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task AddTodos_CreatesSingleItemAsync()
|
|
{
|
|
// Arrange
|
|
var (tools, state) = await CreateToolsWithStateAsync();
|
|
AIFunction addTodos = GetTool(tools, "TodoList_Add");
|
|
|
|
// Act
|
|
await addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput> { new() { Title = "Test todo", Description = "A test description" } },
|
|
});
|
|
|
|
// Assert
|
|
Assert.Single(state.Items);
|
|
Assert.Equal("Test todo", state.Items[0].Title);
|
|
Assert.Equal("A test description", state.Items[0].Description);
|
|
Assert.False(state.Items[0].IsComplete);
|
|
Assert.Equal(1, state.Items[0].Id);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that AddTodos creates multiple items with incrementing IDs.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task AddTodos_CreatesMultipleItemsWithIncrementingIdsAsync()
|
|
{
|
|
// Arrange
|
|
var (tools, state) = await CreateToolsWithStateAsync();
|
|
AIFunction addTodos = GetTool(tools, "TodoList_Add");
|
|
|
|
// Act
|
|
await addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput>
|
|
{
|
|
new() { Title = "First", Description = null },
|
|
new() { Title = "Second", Description = null },
|
|
new() { Title = "Third", Description = "With description" },
|
|
},
|
|
});
|
|
|
|
// Assert
|
|
Assert.Equal(3, state.Items.Count);
|
|
Assert.Equal(1, state.Items[0].Id);
|
|
Assert.Equal("First", state.Items[0].Title);
|
|
Assert.Equal(2, state.Items[1].Id);
|
|
Assert.Equal("Second", state.Items[1].Title);
|
|
Assert.Equal(3, state.Items[2].Id);
|
|
Assert.Equal("Third", state.Items[2].Title);
|
|
Assert.Equal("With description", state.Items[2].Description);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region CompleteTodos Tests
|
|
|
|
/// <summary>
|
|
/// Verify that CompleteTodos marks an item as complete.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task CompleteTodos_MarksItemCompleteAsync()
|
|
{
|
|
// Arrange
|
|
var (tools, state) = await CreateToolsWithStateAsync();
|
|
AIFunction addTodos = GetTool(tools, "TodoList_Add");
|
|
AIFunction completeTodos = GetTool(tools, "TodoList_Complete");
|
|
await addTodos.InvokeAsync(new AIFunctionArguments() { ["todos"] = new List<TodoItemInput> { new() { Title = "Test", Description = null } } });
|
|
|
|
// Act
|
|
object? result = await completeTodos.InvokeAsync(new AIFunctionArguments() { ["items"] = new List<TodoCompleteInput> { new() { Id = 1, Reason = "Done" } } });
|
|
|
|
// Assert
|
|
Assert.True(state.Items[0].IsComplete);
|
|
Assert.Equal(1, GetIntResult(result));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that CompleteTodos marks multiple items as complete.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task CompleteTodos_MarksMultipleItemsCompleteAsync()
|
|
{
|
|
// Arrange
|
|
var (tools, state) = await CreateToolsWithStateAsync();
|
|
AIFunction addTodos = GetTool(tools, "TodoList_Add");
|
|
AIFunction completeTodos = GetTool(tools, "TodoList_Complete");
|
|
await addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput> { new() { Title = "First" }, new() { Title = "Second" }, new() { Title = "Third" } },
|
|
});
|
|
|
|
// Act
|
|
object? result = await completeTodos.InvokeAsync(new AIFunctionArguments() { ["items"] = new List<TodoCompleteInput> { new() { Id = 1, Reason = "Done" }, new() { Id = 3, Reason = "Done" } } });
|
|
|
|
// Assert
|
|
Assert.True(state.Items[0].IsComplete);
|
|
Assert.False(state.Items[1].IsComplete);
|
|
Assert.True(state.Items[2].IsComplete);
|
|
Assert.Equal(2, GetIntResult(result));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that CompleteTodos returns zero for non-existent IDs.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task CompleteTodos_ReturnsZeroForMissingIdsAsync()
|
|
{
|
|
// Arrange
|
|
var (tools, _) = await CreateToolsWithStateAsync();
|
|
AIFunction completeTodos = GetTool(tools, "TodoList_Complete");
|
|
|
|
// Act
|
|
object? result = await completeTodos.InvokeAsync(new AIFunctionArguments() { ["items"] = new List<TodoCompleteInput> { new() { Id = 999, Reason = "Done" } } });
|
|
|
|
// Assert
|
|
Assert.Equal(0, GetIntResult(result));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that CompleteTodos accepts an optional reason parameter.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task CompleteTodos_AcceptsReasonParameterAsync()
|
|
{
|
|
// Arrange
|
|
var (tools, state) = await CreateToolsWithStateAsync();
|
|
AIFunction addTodos = GetTool(tools, "TodoList_Add");
|
|
AIFunction completeTodos = GetTool(tools, "TodoList_Complete");
|
|
await addTodos.InvokeAsync(new AIFunctionArguments() { ["todos"] = new List<TodoItemInput> { new() { Title = "Research topic" } } });
|
|
|
|
// Act
|
|
object? result = await completeTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["items"] = new List<TodoCompleteInput> { new() { Id = 1, Reason = "Found the answer in the documentation." } },
|
|
});
|
|
|
|
// Assert
|
|
Assert.True(state.Items[0].IsComplete);
|
|
Assert.Equal(1, GetIntResult(result));
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region RemoveTodos Tests
|
|
|
|
/// <summary>
|
|
/// Verify that RemoveTodos removes an item.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task RemoveTodos_RemovesItemAsync()
|
|
{
|
|
// Arrange
|
|
var (tools, state) = await CreateToolsWithStateAsync();
|
|
AIFunction addTodos = GetTool(tools, "TodoList_Add");
|
|
AIFunction removeTodos = GetTool(tools, "TodoList_Remove");
|
|
await addTodos.InvokeAsync(new AIFunctionArguments() { ["todos"] = new List<TodoItemInput> { new() { Title = "Test", Description = null } } });
|
|
|
|
// Act
|
|
object? result = await removeTodos.InvokeAsync(new AIFunctionArguments() { ["ids"] = new List<int> { 1 } });
|
|
|
|
// Assert
|
|
Assert.Empty(state.Items);
|
|
Assert.Equal(1, GetIntResult(result));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that RemoveTodos removes multiple items.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task RemoveTodos_RemovesMultipleItemsAsync()
|
|
{
|
|
// Arrange
|
|
var (tools, state) = await CreateToolsWithStateAsync();
|
|
AIFunction addTodos = GetTool(tools, "TodoList_Add");
|
|
AIFunction removeTodos = GetTool(tools, "TodoList_Remove");
|
|
await addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput> { new() { Title = "First" }, new() { Title = "Second" }, new() { Title = "Third" } },
|
|
});
|
|
|
|
// Act
|
|
object? result = await removeTodos.InvokeAsync(new AIFunctionArguments() { ["ids"] = new List<int> { 1, 3 } });
|
|
|
|
// Assert
|
|
Assert.Single(state.Items);
|
|
Assert.Equal("Second", state.Items[0].Title);
|
|
Assert.Equal(2, GetIntResult(result));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that RemoveTodos returns zero for non-existent IDs.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task RemoveTodos_ReturnsZeroForMissingIdsAsync()
|
|
{
|
|
// Arrange
|
|
var (tools, _) = await CreateToolsWithStateAsync();
|
|
AIFunction removeTodos = GetTool(tools, "TodoList_Remove");
|
|
|
|
// Act
|
|
object? result = await removeTodos.InvokeAsync(new AIFunctionArguments() { ["ids"] = new List<int> { 999 } });
|
|
|
|
// Assert
|
|
Assert.Equal(0, GetIntResult(result));
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region GetRemainingTodos Tests
|
|
|
|
/// <summary>
|
|
/// Verify that GetRemainingTodos returns only incomplete items.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task GetRemainingTodos_ReturnsOnlyIncompleteAsync()
|
|
{
|
|
// Arrange
|
|
var (tools, _) = await CreateToolsWithStateAsync();
|
|
AIFunction addTodos = GetTool(tools, "TodoList_Add");
|
|
AIFunction completeTodos = GetTool(tools, "TodoList_Complete");
|
|
AIFunction getRemainingTodos = GetTool(tools, "TodoList_GetRemaining");
|
|
await addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput> { new() { Title = "Done", Description = null }, new() { Title = "Pending", Description = null } },
|
|
});
|
|
await completeTodos.InvokeAsync(new AIFunctionArguments() { ["items"] = new List<TodoCompleteInput> { new() { Id = 1, Reason = "Done" } } });
|
|
|
|
// Act
|
|
object? result = await getRemainingTodos.InvokeAsync(new AIFunctionArguments());
|
|
|
|
// Assert
|
|
var remaining = GetArrayResult(result);
|
|
Assert.Single(remaining);
|
|
Assert.Equal("Pending", remaining[0].GetProperty("title").GetString());
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region GetAllTodos Tests
|
|
|
|
/// <summary>
|
|
/// Verify that GetAllTodos returns all items.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task GetAllTodos_ReturnsAllItemsAsync()
|
|
{
|
|
// Arrange
|
|
var (tools, _) = await CreateToolsWithStateAsync();
|
|
AIFunction addTodos = GetTool(tools, "TodoList_Add");
|
|
AIFunction completeTodos = GetTool(tools, "TodoList_Complete");
|
|
AIFunction getAllTodos = GetTool(tools, "TodoList_GetAll");
|
|
await addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput> { new() { Title = "Done", Description = null }, new() { Title = "Pending", Description = null } },
|
|
});
|
|
await completeTodos.InvokeAsync(new AIFunctionArguments() { ["items"] = new List<TodoCompleteInput> { new() { Id = 1, Reason = "Done" } } });
|
|
|
|
// Act
|
|
object? result = await getAllTodos.InvokeAsync(new AIFunctionArguments());
|
|
|
|
// Assert
|
|
var all = GetArrayResult(result);
|
|
Assert.Equal(2, all.Count);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region State Persistence Tests
|
|
|
|
/// <summary>
|
|
/// Verify that state persists in the session StateBag.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task State_PersistsInSessionStateBagAsync()
|
|
{
|
|
// Arrange
|
|
var provider = new TodoProvider();
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
|
|
// Act — first invocation adds a todo
|
|
AIContext result1 = await provider.InvokingAsync(context);
|
|
AIFunction addTodos = (AIFunction)result1.Tools!.First(t => t is AIFunction f && f.Name == "TodoList_Add");
|
|
await addTodos.InvokeAsync(new AIFunctionArguments() { ["todos"] = new List<TodoItemInput> { new() { Title = "Persisted", Description = null } } });
|
|
|
|
// Second invocation should see the same state
|
|
AIContext result2 = await provider.InvokingAsync(context);
|
|
AIFunction getAllTodos = (AIFunction)result2.Tools!.First(t => t is AIFunction f && f.Name == "TodoList_GetAll");
|
|
object? allResult = await getAllTodos.InvokeAsync(new AIFunctionArguments());
|
|
|
|
// Assert
|
|
var all = GetArrayResult(allResult);
|
|
Assert.Single(all);
|
|
Assert.Equal("Persisted", all[0].GetProperty("title").GetString());
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Public Helper Method Tests
|
|
|
|
/// <summary>
|
|
/// Verify that GetAllTodosAsync returns all items after adding via tools.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task PublicGetAllTodos_ReturnsAllItemsAsync()
|
|
{
|
|
// Arrange
|
|
var provider = new TodoProvider();
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
AIContext result = await provider.InvokingAsync(context);
|
|
AIFunction addTodos = GetTool(result.Tools!, "TodoList_Add");
|
|
await addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput> { new() { Title = "First", Description = null }, new() { Title = "Second", Description = null } },
|
|
});
|
|
|
|
// Act
|
|
var todos = await provider.GetAllTodosAsync(session);
|
|
|
|
// Assert
|
|
Assert.Equal(2, todos.Count);
|
|
Assert.Equal("First", todos[0].Title);
|
|
Assert.Equal("Second", todos[1].Title);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that GetRemainingTodosAsync returns only incomplete items.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task PublicGetRemainingTodos_ReturnsOnlyIncompleteAsync()
|
|
{
|
|
// Arrange
|
|
var provider = new TodoProvider();
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
AIContext result = await provider.InvokingAsync(context);
|
|
AIFunction addTodos = GetTool(result.Tools!, "TodoList_Add");
|
|
AIFunction completeTodos = GetTool(result.Tools!, "TodoList_Complete");
|
|
await addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput> { new() { Title = "Done", Description = null }, new() { Title = "Pending", Description = null } },
|
|
});
|
|
await completeTodos.InvokeAsync(new AIFunctionArguments() { ["items"] = new List<TodoCompleteInput> { new() { Id = 1, Reason = "Done" } } });
|
|
|
|
// Act
|
|
var remaining = await provider.GetRemainingTodosAsync(session);
|
|
|
|
// Assert
|
|
Assert.Single(remaining);
|
|
Assert.Equal("Pending", remaining[0].Title);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that GetAllTodosAsync returns empty list for a new session.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task PublicGetAllTodos_ReturnsEmptyForNewSessionAsync()
|
|
{
|
|
// Arrange
|
|
var provider = new TodoProvider();
|
|
var session = new ChatClientAgentSession();
|
|
|
|
// Act
|
|
var todos = await provider.GetAllTodosAsync(session);
|
|
|
|
// Assert
|
|
Assert.Empty(todos);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Helper Methods
|
|
|
|
private static async Task<(IEnumerable<AITool> Tools, TodoState State)> CreateToolsWithStateAsync()
|
|
{
|
|
var provider = new TodoProvider();
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
|
|
AIContext result = await provider.InvokingAsync(context);
|
|
|
|
// Retrieve the state from the session to verify mutations
|
|
session.StateBag.TryGetValue<TodoState>("TodoProvider", out var state, AgentJsonUtilities.DefaultOptions);
|
|
|
|
return (result.Tools!, state!);
|
|
}
|
|
|
|
private static AIFunction GetTool(IEnumerable<AITool> tools, string name)
|
|
{
|
|
return (AIFunction)tools.First(t => t is AIFunction f && f.Name == name);
|
|
}
|
|
|
|
private static int GetIntResult(object? result)
|
|
{
|
|
var element = Assert.IsType<JsonElement>(result);
|
|
return element.GetInt32();
|
|
}
|
|
|
|
private static List<JsonElement> GetArrayResult(object? result)
|
|
{
|
|
var element = Assert.IsType<JsonElement>(result);
|
|
return element.EnumerateArray().ToList();
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Options Tests
|
|
|
|
/// <summary>
|
|
/// Verify that custom instructions override the default.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task Options_CustomInstructions_OverridesDefaultAsync()
|
|
{
|
|
// Arrange
|
|
var options = new TodoProviderOptions { Instructions = "Custom todo instructions." };
|
|
var provider = new TodoProvider(options);
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
|
|
// Act
|
|
AIContext result = await provider.InvokingAsync(context);
|
|
|
|
// Assert
|
|
Assert.Equal("Custom todo instructions.", result.Instructions);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that null options uses default instructions.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task Options_Null_UsesDefaultInstructionsAsync()
|
|
{
|
|
// Arrange
|
|
var provider = new TodoProvider();
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
|
|
// Act
|
|
AIContext result = await provider.InvokingAsync(context);
|
|
|
|
// Assert
|
|
Assert.Contains("todo list", result.Instructions);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Message Injection Tests
|
|
|
|
/// <summary>
|
|
/// Verify that ProvideAIContextAsync injects a "none yet" message when the list is empty.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task ProvideAIContextAsync_InjectsEmptyTodoMessageAsync()
|
|
{
|
|
// Arrange
|
|
var provider = new TodoProvider();
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
|
|
// Act
|
|
AIContext result = await provider.InvokingAsync(context);
|
|
|
|
// Assert
|
|
Assert.NotNull(result.Messages);
|
|
var messages = result.Messages!.ToList();
|
|
Assert.Single(messages);
|
|
Assert.Contains("none yet", messages[0].Text);
|
|
Assert.Contains("### Current todo list", messages[0].Text);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that ProvideAIContextAsync injects a message listing existing todos with status.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task ProvideAIContextAsync_InjectsTodoListMessageAsync()
|
|
{
|
|
// Arrange
|
|
var provider = new TodoProvider();
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
|
|
// First invocation — add some todos (one with a description to cover that branch)
|
|
AIContext result1 = await provider.InvokingAsync(context);
|
|
AIFunction addTodos = (AIFunction)result1.Tools!.First(t => t is AIFunction f && f.Name == "TodoList_Add");
|
|
AIFunction completeTodos = (AIFunction)result1.Tools!.First(t => t is AIFunction f && f.Name == "TodoList_Complete");
|
|
await addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput>
|
|
{
|
|
new() { Title = "First" },
|
|
new() { Title = "Second", Description = "Has details" },
|
|
},
|
|
});
|
|
await completeTodos.InvokeAsync(new AIFunctionArguments() { ["items"] = new List<TodoCompleteInput> { new() { Id = 1, Reason = "Done" } } });
|
|
|
|
// Act — second invocation should see the updated list in messages
|
|
AIContext result2 = await provider.InvokingAsync(context);
|
|
|
|
// Assert
|
|
Assert.NotNull(result2.Messages);
|
|
var messages = result2.Messages!.ToList();
|
|
Assert.Single(messages);
|
|
string text = messages[0].Text!;
|
|
Assert.Contains("### Current todo list", text);
|
|
Assert.Contains("[done] First", text);
|
|
Assert.Contains("[open] Second", text);
|
|
Assert.Contains(": Has details", text);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that when SuppressTodoListMessage is true, no message is injected.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task ProvideAIContextAsync_SuppressTodoListMessage_NoMessageInjectedAsync()
|
|
{
|
|
// Arrange
|
|
var provider = new TodoProvider(new TodoProviderOptions { SuppressTodoListMessage = true });
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
|
|
// Act
|
|
AIContext result = await provider.InvokingAsync(context);
|
|
|
|
// Assert
|
|
Assert.Null(result.Messages);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that a custom TodoListMessageBuilder is used when provided.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task ProvideAIContextAsync_CustomTodoListMessageBuilder_UsesCustomFormatterAsync()
|
|
{
|
|
// Arrange
|
|
var provider = new TodoProvider(new TodoProviderOptions
|
|
{
|
|
TodoListMessageBuilder = items => $"Custom: {items.Count} items",
|
|
});
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
|
|
// First invocation — add a todo
|
|
AIContext result1 = await provider.InvokingAsync(context);
|
|
AIFunction addTodos = (AIFunction)result1.Tools!.First(t => t is AIFunction f && f.Name == "TodoList_Add");
|
|
await addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput> { new() { Title = "Task A" } },
|
|
});
|
|
|
|
// Act — second invocation should use the custom builder
|
|
AIContext result2 = await provider.InvokingAsync(context);
|
|
|
|
// Assert
|
|
Assert.NotNull(result2.Messages);
|
|
var messages = result2.Messages!.ToList();
|
|
Assert.Single(messages);
|
|
Assert.Equal("Custom: 1 items", messages[0].Text);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that SuppressTodoListMessage takes precedence over a set TodoListMessageBuilder.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task ProvideAIContextAsync_SuppressWinsOverBuilder_NoMessageInjectedAsync()
|
|
{
|
|
// Arrange
|
|
var provider = new TodoProvider(new TodoProviderOptions
|
|
{
|
|
SuppressTodoListMessage = true,
|
|
TodoListMessageBuilder = items => "Should not appear",
|
|
});
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
|
|
// Act
|
|
AIContext result = await provider.InvokingAsync(context);
|
|
|
|
// Assert
|
|
Assert.Null(result.Messages);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that the list passed to TodoListMessageBuilder is a snapshot and mutating it does not affect state.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task ProvideAIContextAsync_BuilderReceivesSnapshot_MutationDoesNotAffectStateAsync()
|
|
{
|
|
// Arrange
|
|
IReadOnlyList<TodoItem>? capturedList = null;
|
|
var provider = new TodoProvider(new TodoProviderOptions
|
|
{
|
|
TodoListMessageBuilder = items =>
|
|
{
|
|
capturedList = items;
|
|
return "snapshot test";
|
|
},
|
|
});
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
|
|
// Add a todo
|
|
AIContext result1 = await provider.InvokingAsync(context);
|
|
AIFunction addTodos = (AIFunction)result1.Tools!.First(t => t is AIFunction f && f.Name == "TodoList_Add");
|
|
await addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput> { new() { Title = "Original" } },
|
|
});
|
|
|
|
// Act — invoke again to trigger builder with 1 item
|
|
await provider.InvokingAsync(context);
|
|
|
|
// Mutate the captured snapshot
|
|
Assert.NotNull(capturedList);
|
|
var mutableList = (List<TodoItem>)capturedList!;
|
|
mutableList.Clear();
|
|
|
|
// Assert — provider state is unaffected
|
|
var allTodos = await provider.GetAllTodosAsync(session);
|
|
Assert.Single(allTodos);
|
|
Assert.Equal("Original", allTodos[0].Title);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Concurrency Tests
|
|
|
|
/// <summary>
|
|
/// Verify that concurrent add operations do not produce duplicate IDs.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task ConcurrentAdds_ProduceUniqueIdsAsync()
|
|
{
|
|
// Arrange
|
|
var provider = new TodoProvider();
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
AIContext result = await provider.InvokingAsync(context);
|
|
AIFunction addTodos = GetTool(result.Tools!, "TodoList_Add");
|
|
AIFunction getAllTodos = GetTool(result.Tools!, "TodoList_GetAll");
|
|
|
|
// Act — launch multiple concurrent adds
|
|
var tasks = Enumerable.Range(0, 10).Select(i =>
|
|
addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput> { new() { Title = $"Item {i}" } },
|
|
}).AsTask());
|
|
await Task.WhenAll(tasks);
|
|
|
|
// Assert — all IDs are unique and sequential
|
|
object? allResult = await getAllTodos.InvokeAsync(new AIFunctionArguments());
|
|
var all = GetArrayResult(allResult);
|
|
Assert.Equal(10, all.Count);
|
|
#pragma warning disable RCS1077 // Optimize LINQ method call — .Order() not available on net472
|
|
var ids = all.Select(e => e.GetProperty("id").GetInt32()).OrderBy(x => x).ToList();
|
|
#pragma warning restore RCS1077
|
|
Assert.Equal(Enumerable.Range(1, 10).ToList(), ids);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verify that concurrent add and complete operations serialize correctly.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task ConcurrentAddAndComplete_SerializesCorrectlyAsync()
|
|
{
|
|
// Arrange
|
|
var provider = new TodoProvider();
|
|
var agent = new Mock<AIAgent>().Object;
|
|
var session = new ChatClientAgentSession();
|
|
#pragma warning disable MAAI001
|
|
var context = new AIContextProvider.InvokingContext(agent, session, new AIContext());
|
|
#pragma warning restore MAAI001
|
|
AIContext result = await provider.InvokingAsync(context);
|
|
AIFunction addTodos = GetTool(result.Tools!, "TodoList_Add");
|
|
AIFunction completeTodos = GetTool(result.Tools!, "TodoList_Complete");
|
|
AIFunction getAllTodos = GetTool(result.Tools!, "TodoList_GetAll");
|
|
|
|
// Add initial items
|
|
await addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput>
|
|
{
|
|
new() { Title = "Existing 1" },
|
|
new() { Title = "Existing 2" },
|
|
new() { Title = "Existing 3" },
|
|
},
|
|
});
|
|
|
|
// Act — concurrent adds and completions
|
|
await Task.WhenAll(
|
|
addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput> { new() { Title = "New A" }, new() { Title = "New B" } },
|
|
}).AsTask(),
|
|
addTodos.InvokeAsync(new AIFunctionArguments()
|
|
{
|
|
["todos"] = new List<TodoItemInput> { new() { Title = "New C" } },
|
|
}).AsTask(),
|
|
completeTodos.InvokeAsync(new AIFunctionArguments() { ["items"] = new List<TodoCompleteInput> { new() { Id = 1, Reason = "Done" }, new() { Id = 2, Reason = "Done" }, new() { Id = 3, Reason = "Done" } } }).AsTask());
|
|
|
|
// Assert
|
|
object? allResult = await getAllTodos.InvokeAsync(new AIFunctionArguments());
|
|
var all = GetArrayResult(allResult);
|
|
Assert.Equal(6, all.Count);
|
|
#pragma warning disable RCS1077 // Optimize LINQ method call — .Order() not available on net472
|
|
var ids = all.Select(e => e.GetProperty("id").GetInt32()).OrderBy(x => x).ToList();
|
|
#pragma warning restore RCS1077
|
|
Assert.Equal(ids.Count, ids.Distinct().Count()); // no duplicates
|
|
Assert.Equal(Enumerable.Range(1, 6).ToList(), ids);
|
|
var completedIds = all.Where(e => e.GetProperty("isComplete").GetBoolean()).Select(e => e.GetProperty("id").GetInt32()).ToHashSet();
|
|
Assert.Subset(new HashSet<int> { 1, 2, 3 }, completedIds);
|
|
}
|
|
|
|
#endregion
|
|
}
|