Files
agent-framework/dotnet/tests/Microsoft.Agents.AI.UnitTests/Harness/FileAccess/FileAccessProviderTests.cs
T
westey 3f77c555cf .NET: [BREAKING] Align FileAccess tools with Python; add directory discovery and recursive search (#6474)
* Align FileAccess with python and improve functionality

* Addressing PR comments
2026-06-12 14:28:26 +00:00

775 lines
26 KiB
C#

// Copyright (c) Microsoft. All rights reserved.
using System;
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.Harness.FileAccess;
public class FileAccessProviderTests
{
#region Constructor Validation
[Fact]
public void Constructor_NullFileStore_Throws()
{
Assert.Throws<ArgumentNullException>(() => new FileAccessProvider(null!));
}
[Fact]
public void Constructor_WithDefaults_Succeeds()
{
// Act
var provider = new FileAccessProvider(new InMemoryAgentFileStore());
// Assert
Assert.NotNull(provider);
}
#endregion
#region ProvideAIContextAsync Tests
[Fact]
public async Task ProvideAIContextAsync_ReturnsToolsAsync()
{
// Arrange
var tools = await CreateToolsAsync();
// Assert — 6 tools: SaveFile, ReadFile, DeleteFile, ListFiles, ListSubdirectories, SearchFiles
Assert.Equal(6, tools.Count());
}
[Fact]
public async Task ProvideAIContextAsync_ReturnsInstructionsAsync()
{
// Arrange
var provider = new FileAccessProvider(new InMemoryAgentFileStore());
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.Contains("File Access", result.Instructions);
Assert.Contains("file_access_", result.Instructions);
Assert.Contains("persist beyond the current session", result.Instructions);
}
[Fact]
public async Task ProvideAIContextAsync_DoesNotInjectMessagesAsync()
{
// Arrange — FileAccessProvider should never inject messages (unlike FileMemoryProvider).
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("notes.md", "Content");
var provider = new FileAccessProvider(store);
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);
}
[Fact]
public void StateKeys_ReturnsEmpty()
{
// Arrange — FileAccessProvider has no session state.
var provider = new FileAccessProvider(new InMemoryAgentFileStore());
// Act
var keys = provider.StateKeys;
// Assert
Assert.Empty(keys);
}
#endregion
#region SaveFile Tests
[Fact]
public async Task SaveFile_CreatesFileAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
var tools = await CreateToolsAsync(store);
var saveFile = GetTool(tools, "file_access_save_file");
// Act
await InvokeToolAsync(saveFile, new AIFunctionArguments
{
["fileName"] = "notes.md",
["content"] = "Test content",
});
// Assert
var content = await store.ReadFileAsync("notes.md");
Assert.Equal("Test content", content);
}
[Fact]
public async Task SaveFile_DoesNotCreateDescriptionSidecarAsync()
{
// Arrange — FileAccessProvider should never create description sidecar files.
var store = new InMemoryAgentFileStore();
var tools = await CreateToolsAsync(store);
var saveFile = GetTool(tools, "file_access_save_file");
// Act
await InvokeToolAsync(saveFile, new AIFunctionArguments
{
["fileName"] = "research.md",
["content"] = "Long research content...",
});
// Assert — file exists, no description sidecar
Assert.Equal("Long research content...", await store.ReadFileAsync("research.md"));
Assert.Null(await store.ReadFileAsync("research_description.md"));
}
[Fact]
public async Task SaveFile_ExistingFile_WithoutOverwrite_ReturnsErrorAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
var tools = await CreateToolsAsync(store);
var saveFile = GetTool(tools, "file_access_save_file");
await InvokeToolAsync(saveFile, new AIFunctionArguments
{
["fileName"] = "notes.md",
["content"] = "Original",
});
// Act — try to save again without overwrite
var result = await InvokeToolAsync(saveFile, new AIFunctionArguments
{
["fileName"] = "notes.md",
["content"] = "Updated",
});
// Assert — original content preserved, error message returned
Assert.Equal("Original", await store.ReadFileAsync("notes.md"));
var text = Assert.IsType<JsonElement>(result).GetString();
Assert.Contains("already exists", text);
}
[Fact]
public async Task SaveFile_ExistingFile_WithOverwrite_SucceedsAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
var tools = await CreateToolsAsync(store);
var saveFile = GetTool(tools, "file_access_save_file");
await InvokeToolAsync(saveFile, new AIFunctionArguments
{
["fileName"] = "notes.md",
["content"] = "Original",
});
// Act — save again with overwrite=true
await InvokeToolAsync(saveFile, new AIFunctionArguments
{
["fileName"] = "notes.md",
["content"] = "Updated",
["overwrite"] = true,
});
// Assert
Assert.Equal("Updated", await store.ReadFileAsync("notes.md"));
}
[Fact]
public async Task SaveFile_ReturnsConfirmationAsync()
{
// Arrange
var tools = await CreateToolsAsync();
var saveFile = GetTool(tools, "file_access_save_file");
// Act
var result = await InvokeToolAsync(saveFile, new AIFunctionArguments
{
["fileName"] = "test.md",
["content"] = "Content",
});
// Assert
var text = Assert.IsType<JsonElement>(result).GetString();
Assert.Contains("saved", text);
}
#endregion
#region ReadFile Tests
[Fact]
public async Task ReadFile_ExistingFile_ReturnsContentAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("notes.md", "Stored content");
var tools = await CreateToolsAsync(store);
var readFile = GetTool(tools, "file_access_read_file");
// Act
var result = await InvokeToolAsync(readFile, new AIFunctionArguments
{
["fileName"] = "notes.md",
});
// Assert
var text = Assert.IsType<JsonElement>(result).GetString();
Assert.Equal("Stored content", text);
}
[Fact]
public async Task ReadFile_NonExistent_ReturnsNotFoundMessageAsync()
{
// Arrange
var tools = await CreateToolsAsync();
var readFile = GetTool(tools, "file_access_read_file");
// Act
var result = await InvokeToolAsync(readFile, new AIFunctionArguments
{
["fileName"] = "nonexistent.md",
});
// Assert
var text = Assert.IsType<JsonElement>(result).GetString();
Assert.Contains("not found", text);
}
#endregion
#region DeleteFile Tests
[Fact]
public async Task DeleteFile_ExistingFile_DeletesAndReturnsConfirmationAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("notes.md", "Content");
var tools = await CreateToolsAsync(store);
var deleteFile = GetTool(tools, "file_access_delete_file");
// Act
var result = await InvokeToolAsync(deleteFile, new AIFunctionArguments
{
["fileName"] = "notes.md",
});
// Assert
var text = Assert.IsType<JsonElement>(result).GetString();
Assert.Contains("deleted", text);
Assert.False(await store.FileExistsAsync("notes.md"));
}
[Fact]
public async Task DeleteFile_NonExistent_ReturnsNotFoundAsync()
{
// Arrange
var tools = await CreateToolsAsync();
var deleteFile = GetTool(tools, "file_access_delete_file");
// Act
var result = await InvokeToolAsync(deleteFile, new AIFunctionArguments
{
["fileName"] = "missing.md",
});
// Assert
var text = Assert.IsType<JsonElement>(result).GetString();
Assert.Contains("not found", text);
}
#endregion
#region ListFiles Tests
[Fact]
public async Task ListFiles_ReturnsFileNamesAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("notes.md", "Content");
await store.WriteFileAsync("data.txt", "Data");
var tools = await CreateToolsAsync(store);
var listFiles = GetTool(tools, "file_access_list_files");
// Act
var result = await InvokeToolAsync(listFiles, new AIFunctionArguments());
// Assert — returns plain list of file names (no description properties)
var entries = Assert.IsType<JsonElement>(result).EnumerateArray().ToList();
Assert.Equal(2, entries.Count);
Assert.Contains(entries, e => e.GetString() == "data.txt");
Assert.Contains(entries, e => e.GetString() == "notes.md");
}
[Fact]
public async Task ListFiles_DoesNotFilterDescriptionFilesAsync()
{
// Arrange — FileAccessProvider doesn't know about description sidecars, so all files are visible.
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("notes.md", "Content");
await store.WriteFileAsync("notes_description.md", "Description");
var tools = await CreateToolsAsync(store);
var listFiles = GetTool(tools, "file_access_list_files");
// Act
var result = await InvokeToolAsync(listFiles, new AIFunctionArguments());
// Assert — both files should be visible
var entries = Assert.IsType<JsonElement>(result).EnumerateArray().ToList();
Assert.Equal(2, entries.Count);
}
[Fact]
public async Task ListFiles_EmptyStore_ReturnsEmptyListAsync()
{
// Arrange
var tools = await CreateToolsAsync();
var listFiles = GetTool(tools, "file_access_list_files");
// Act
var result = await InvokeToolAsync(listFiles, new AIFunctionArguments());
// Assert
var entries = Assert.IsType<JsonElement>(result).EnumerateArray().ToList();
Assert.Empty(entries);
}
[Fact]
public async Task ListFiles_WithDirectory_ListsSubdirectoryChildrenAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("root.txt", "Root");
await store.WriteFileAsync("reports/2024/q1.md", "Q1");
await store.WriteFileAsync("reports/2024/q2.md", "Q2");
var tools = await CreateToolsAsync(store);
var listFiles = GetTool(tools, "file_access_list_files");
// Act
var result = await InvokeToolAsync(listFiles, new AIFunctionArguments
{
["directory"] = "reports/2024",
});
// Assert — only the direct children of reports/2024 are returned (by their names)
var entries = Assert.IsType<JsonElement>(result).EnumerateArray().ToList();
Assert.Equal(2, entries.Count);
Assert.Contains(entries, e => e.GetString() == "q1.md");
Assert.Contains(entries, e => e.GetString() == "q2.md");
}
#endregion
#region ListSubdirectories Tests
[Fact]
public async Task ListSubdirectories_ReturnsDirectChildDirectoriesAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("root.txt", "Root");
await store.WriteFileAsync("reports/q1.md", "Q1");
await store.WriteFileAsync("reports/2024/q2.md", "Q2");
await store.WriteFileAsync("data/raw.csv", "x");
var tools = await CreateToolsAsync(store);
var listSubdirectories = GetTool(tools, "file_access_list_subdirectories");
// Act — list the root's direct child subdirectories
var result = await InvokeToolAsync(listSubdirectories, new AIFunctionArguments());
// Assert — only direct children (reports, data); not the nested 2024
var entries = Assert.IsType<JsonElement>(result).EnumerateArray().Select(e => e.GetString()).ToList();
Assert.Equal(2, entries.Count);
Assert.Contains("reports", entries);
Assert.Contains("data", entries);
}
[Fact]
public async Task ListSubdirectories_WithDirectory_ListsNestedChildrenAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("reports/q1.md", "Q1");
await store.WriteFileAsync("reports/2024/q2.md", "Q2");
await store.WriteFileAsync("reports/2025/q3.md", "Q3");
var tools = await CreateToolsAsync(store);
var listSubdirectories = GetTool(tools, "file_access_list_subdirectories");
// Act
var result = await InvokeToolAsync(listSubdirectories, new AIFunctionArguments
{
["directory"] = "reports",
});
// Assert — direct child subdirectories of reports
var entries = Assert.IsType<JsonElement>(result).EnumerateArray().Select(e => e.GetString()).ToList();
Assert.Equal(2, entries.Count);
Assert.Contains("2024", entries);
Assert.Contains("2025", entries);
}
[Fact]
public async Task ListSubdirectories_NoSubdirectories_ReturnsEmptyAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("a.txt", "A");
await store.WriteFileAsync("b.txt", "B");
var tools = await CreateToolsAsync(store);
var listSubdirectories = GetTool(tools, "file_access_list_subdirectories");
// Act
var result = await InvokeToolAsync(listSubdirectories, new AIFunctionArguments());
// Assert
var entries = Assert.IsType<JsonElement>(result).EnumerateArray().ToList();
Assert.Empty(entries);
}
#endregion
#region SearchFiles Tests
[Fact]
public async Task SearchFiles_FindsMatchingContentAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("notes.md", "Important research findings about AI");
var tools = await CreateToolsAsync(store);
var searchFiles = GetTool(tools, "file_access_search_files");
// Act
var result = await InvokeToolAsync(searchFiles, new AIFunctionArguments
{
["regexPattern"] = "research findings",
["filePattern"] = "",
});
// Assert
var entries = Assert.IsType<JsonElement>(result).EnumerateArray().ToList();
Assert.Single(entries);
Assert.Equal("notes.md", entries[0].GetProperty("fileName").GetString());
Assert.True(entries[0].TryGetProperty("matchingLines", out var matchingLines));
Assert.True(matchingLines.GetArrayLength() > 0);
}
[Fact]
public async Task SearchFiles_WithFilePattern_FiltersResultsAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("notes.md", "Important data");
await store.WriteFileAsync("data.txt", "Important data");
var tools = await CreateToolsAsync(store);
var searchFiles = GetTool(tools, "file_access_search_files");
// Act
var result = await InvokeToolAsync(searchFiles, new AIFunctionArguments
{
["regexPattern"] = "Important",
["filePattern"] = "*.md",
});
// Assert
var entries = Assert.IsType<JsonElement>(result).EnumerateArray().ToList();
Assert.Single(entries);
Assert.Equal("notes.md", entries[0].GetProperty("fileName").GetString());
}
[Fact]
public async Task SearchFiles_NoMatches_ReturnsEmptyAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("notes.md", "No matching content here");
var tools = await CreateToolsAsync(store);
var searchFiles = GetTool(tools, "file_access_search_files");
// Act
var result = await InvokeToolAsync(searchFiles, new AIFunctionArguments
{
["regexPattern"] = "nonexistent pattern xyz",
});
// Assert
var entries = Assert.IsType<JsonElement>(result).EnumerateArray().ToList();
Assert.Empty(entries);
}
[Fact]
public async Task SearchFiles_SearchesAllDescendantsRecursivelyAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("root.md", "Important data at root");
await store.WriteFileAsync("reports/q1.md", "Important data in reports");
await store.WriteFileAsync("reports/2024/q2.md", "Important data nested deeper");
var tools = await CreateToolsAsync(store);
var searchFiles = GetTool(tools, "file_access_search_files");
// Act — no glob, so all descendants are searched
var result = await InvokeToolAsync(searchFiles, new AIFunctionArguments
{
["regexPattern"] = "Important",
});
// Assert — matches at every depth, returned as store-root-relative paths
var entries = Assert.IsType<JsonElement>(result).EnumerateArray().ToList();
var names = entries.ConvertAll(e => e.GetProperty("fileName").GetString());
Assert.Equal(3, names.Count);
Assert.Contains("root.md", names);
Assert.Contains("reports/q1.md", names);
Assert.Contains("reports/2024/q2.md", names);
}
[Fact]
public async Task SearchFiles_GlobScopesToSubtreeAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("root.md", "Important data at root");
await store.WriteFileAsync("reports/q1.md", "Important data in reports");
await store.WriteFileAsync("reports/2024/q2.md", "Important data nested deeper");
var tools = await CreateToolsAsync(store);
var searchFiles = GetTool(tools, "file_access_search_files");
// Act — restrict to the reports subtree using a recursive glob
var result = await InvokeToolAsync(searchFiles, new AIFunctionArguments
{
["regexPattern"] = "Important",
["filePattern"] = "reports/**",
});
// Assert — only the files under reports/ match
var entries = Assert.IsType<JsonElement>(result).EnumerateArray().ToList();
var names = entries.ConvertAll(e => e.GetProperty("fileName").GetString());
Assert.Equal(2, names.Count);
Assert.Contains("reports/q1.md", names);
Assert.Contains("reports/2024/q2.md", names);
}
[Fact]
public async Task SearchFiles_RecursiveGlobMatchesNestedExtensionAsync()
{
// Arrange
var store = new InMemoryAgentFileStore();
await store.WriteFileAsync("notes.md", "Important data");
await store.WriteFileAsync("data/raw.txt", "Important data");
await store.WriteFileAsync("reports/2024/q1.md", "Important data");
var tools = await CreateToolsAsync(store);
var searchFiles = GetTool(tools, "file_access_search_files");
// Act — match markdown files at any depth
var result = await InvokeToolAsync(searchFiles, new AIFunctionArguments
{
["regexPattern"] = "Important",
["filePattern"] = "**/*.md",
});
// Assert
var entries = Assert.IsType<JsonElement>(result).EnumerateArray().ToList();
var names = entries.ConvertAll(e => e.GetProperty("fileName").GetString());
Assert.Equal(2, names.Count);
Assert.Contains("notes.md", names);
Assert.Contains("reports/2024/q1.md", names);
}
#endregion
#region Path Traversal Protection
[Fact]
public async Task SaveFile_PathTraversal_ThrowsAsync()
{
// Arrange
var tools = await CreateToolsAsync();
var saveFile = GetTool(tools, "file_access_save_file");
// Act & Assert
await Assert.ThrowsAsync<ArgumentException>(async () =>
await InvokeToolAsync(saveFile, new AIFunctionArguments
{
["fileName"] = "../escape.md",
["content"] = "Content",
}));
}
[Fact]
public async Task SaveFile_AbsolutePath_ThrowsAsync()
{
// Arrange
var tools = await CreateToolsAsync();
var saveFile = GetTool(tools, "file_access_save_file");
// Act & Assert
await Assert.ThrowsAsync<ArgumentException>(async () =>
await InvokeToolAsync(saveFile, new AIFunctionArguments
{
["fileName"] = "/etc/passwd",
["content"] = "Content",
}));
}
[Fact]
public async Task SaveFile_DriveRootedPath_ThrowsAsync()
{
// Arrange
var tools = await CreateToolsAsync();
var saveFile = GetTool(tools, "file_access_save_file");
// Act & Assert
await Assert.ThrowsAsync<ArgumentException>(async () =>
await InvokeToolAsync(saveFile, new AIFunctionArguments
{
["fileName"] = "C:\\temp\\file.md",
["content"] = "Content",
}));
}
[Fact]
public async Task SaveFile_DoubleDotsInFileName_AllowedAsync()
{
// Arrange — "notes..md" is not a path traversal attempt.
var store = new InMemoryAgentFileStore();
var tools = await CreateToolsAsync(store);
var saveFile = GetTool(tools, "file_access_save_file");
// Act
await InvokeToolAsync(saveFile, new AIFunctionArguments
{
["fileName"] = "notes..md",
["content"] = "Content",
});
// Assert
Assert.Equal("Content", await store.ReadFileAsync("notes..md"));
}
[Fact]
public async Task ReadFile_PathTraversal_ThrowsAsync()
{
// Arrange
var tools = await CreateToolsAsync();
var readFile = GetTool(tools, "file_access_read_file");
// Act & Assert
await Assert.ThrowsAsync<ArgumentException>(async () =>
await InvokeToolAsync(readFile, new AIFunctionArguments
{
["fileName"] = "../../etc/passwd",
}));
}
[Fact]
public async Task DeleteFile_PathTraversal_ThrowsAsync()
{
// Arrange
var tools = await CreateToolsAsync();
var deleteFile = GetTool(tools, "file_access_delete_file");
// Act & Assert
await Assert.ThrowsAsync<ArgumentException>(async () =>
await InvokeToolAsync(deleteFile, new AIFunctionArguments
{
["fileName"] = "../escape.md",
}));
}
#endregion
#region Options Tests
[Fact]
public async Task Options_CustomInstructions_OverridesDefaultAsync()
{
// Arrange
var options = new FileAccessProviderOptions { Instructions = "Custom file access instructions." };
var provider = new FileAccessProvider(new InMemoryAgentFileStore(), options: 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 file access instructions.", result.Instructions);
}
[Fact]
public async Task Options_Null_UsesDefaultInstructionsAsync()
{
// Arrange
var provider = new FileAccessProvider(new InMemoryAgentFileStore());
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("File Access", result.Instructions);
}
#endregion
#region Helper Methods
private static async Task<IEnumerable<AITool>> CreateToolsAsync(InMemoryAgentFileStore? store = null)
{
var provider = new FileAccessProvider(store ?? new InMemoryAgentFileStore());
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);
return result.Tools!;
}
private static AIFunction GetTool(IEnumerable<AITool> tools, string name)
{
return (AIFunction)tools.First(t => t is AIFunction f && f.Name == name);
}
/// <summary>
/// Invokes a tool. Since <see cref="FileAccessProvider"/> does not use session state,
/// the tools don't need an ambient <see cref="AIAgent.CurrentRunContext"/>.
/// </summary>
private static async Task<object?> InvokeToolAsync(AIFunction tool, AIFunctionArguments arguments)
{
return await tool.InvokeAsync(arguments);
}
#endregion
}