mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
.NET: Promote FoundryChatClient to public, add file/vector-store helpers and ToPromptAgentAsync converter (#5940)
* Consolidate Foundry chat client decorators into FoundryChatClient
- Replace AzureAIProjectChatClient and AzureAIProjectResponsesChatClient with a single internal sealed FoundryChatClient that covers three modes (pure responses, server-side agent reference, hosted agent endpoint).
- Rename AzureAIProjectChatClientExtensions to AIProjectClientExtensions to reflect that it extends AIProjectClient.
- All four AsAIAgent extension overloads and both FoundryAgent constructors now construct FoundryChatClient internally so the microsoft.foundry telemetry tag is uniform across paths.
- Introduce AgentFrameworkUserAgentPolicy that stamps agent-framework-dotnet/{version} on outbound requests, mirroring the Python agent-framework-python/{version} contract.
- Delete the Foundry-local MeaiUserAgentPolicy duplicate; rely on MEAI 10.5.1 to stamp MEAI/{version} automatically.
- HostedAgentUserAgentPolicy keeps the combined foundry-hosting/agent-framework-dotnet/{version} segment (Python parity) and upgrades the bare segment in place to avoid duplication.
- Tests reorganized: FoundryChatClientTests, AIProjectClientExtensionsTests, AgentFrameworkUserAgentPolicyTests, MeaiAutoUserAgentVerificationTests, plus in-place upgrade unit tests in HostedOutboundUserAgentTests.
* Promote FoundryChatClient to public; add file/vector-store helpers and ToPromptAgentAsync converter
- Promote FoundryChatClient from internal sealed to public sealed for Python parity, so .NET developers can hold and pass a FoundryChatClient directly the way Python developers do.
- Mode 3 (hosted agent endpoint) now materializes an AIProjectClient from the parsed project root, making GetService<AIProjectClient>() non-null across all three construction modes. This eliminates the per-mode asymmetry that previously hid project-level helpers from agents constructed via an agent endpoint URL.
- Add four new instance methods on FoundryChatClient mirroring Python's spec: UploadFileAsync, DeleteFileAsync, CreateVectorStoreAsync (bundles upload + create + wait), DeleteVectorStoreAsync. Single overload each, path-only inputs to start; additional overloads can be added later without breaking callers. All are Experimental, consistent with the rest of the Foundry package.
- Add ToPromptAgentAsync extension methods on ChatClientAgent and FoundryAgent for the agent-to-prompt-agent converter described in the Foundry spec. Mode 1 (responses API) synthesizes a DeclarativeAgentDefinition from the agent's ChatOptions; mode 2 (server-side agent reference, version, or record) returns the cached or freshly fetched Definition; mode 3 throws InvalidOperationException because no local definition exists to convert.
- Strict AITool to ResponseTool mapping for mode 1: AIFunction becomes CreateFunctionTool with the function's JSON schema; AITool instances that wrap a ResponseTool unwrap via GetService(typeof(ResponseTool)); anything else throws InvalidOperationException naming the offending tool type. Matches the Python spec's unsupported-tools-raise-ValueError contract.
- New unit tests: FoundryChatClientVectorStoreTests (22 tests covering all four helpers across the three FoundryChatClient construction modes plus validation and cancellation), FoundryPromptAgentConverterTests (16 tests covering both extension entry points across mode 1 synthesis, mode 2 cached and fetched paths, all failure modes, and a Python-parity guard asserting both extensions produce equivalent definitions for equivalent inputs), plus four new tests in FoundryChatClientTests for the mode 3 AIProjectClient materialization.
* Stop building duplicate ProjectOpenAIClient in FoundryAgent agent-endpoint ctor
After Plan #2's mode-3 AIProjectClient materialization, the inner FoundryChatClient already exposes a project-level AIProjectClient (via GetService) that internally provides the project-level ProjectOpenAIClient via GetProjectOpenAIClient(). FoundryAgent's agent-endpoint constructor was still independently constructing a second project-level ProjectOpenAIClient via the now-redundant CreateProjectLevelOpenAIClientFromAgentEndpoint helper — two handles to the same logical resource.
Refactor: the agent-endpoint constructor now reads the inner FoundryChatClient's materialized AIProjectClient via base.GetService(typeof(AIProjectClient)) and derives the project-level ProjectOpenAIClient from it. The dead helper on both FoundryAgent (private static wrapper) and FoundryChatClient (the actual implementation) is removed. The user-supplied per-agent ClientPipelineOptions primitives (Transport, RetryPolicy, NetworkTimeout, UserAgentApplicationId) are propagated into the materialized AIProjectClientOptions so test-injected transports and explicit retry / timeout / user-agent settings reach the project-level pipeline — preserving the behavior the dead helper used to provide.
Updated AgentEndpointConstructor_GetServiceAIProjectClient_ReturnsNull to its now-correct counterpart AgentEndpointConstructor_GetServiceAIProjectClient_ReturnsNonNull, since after Plan #2 the agent-endpoint ctor surfaces a non-null AIProjectClient (per user direction in Plan #2 Q2).
* Strip duplicated AIProjectClient/ProjectOpenAIClient state from FoundryAgent
Both _aiProjectClient and _projectOpenAIClient fields on FoundryAgent were redundant:
- _aiProjectClient: FoundryAgent's GetService<AIProjectClient> override returned this field, but DelegatingAIAgent.GetService → ChatClientAgent.GetService → FoundryChatClient.GetService<AIProjectClient> already returns the same instance through the delegating chain. Field + override are pure duplication.
- _projectOpenAIClient: only used by FoundryAgent's own GetService<ProjectOpenAIClient> override and by CreateConversationSessionAsync. Per user direction, ProjectOpenAIClient is no longer exposed via GetService on either FoundryChatClient or FoundryAgent — callers retrieve it from the AIProjectClient themselves (aiProjectClient.GetProjectOpenAIClient()) the same way the framework does internally. This eliminates the mode-3 asymmetry where the chat client's stored ProjectOpenAIClient was per-agent (URL /agents/{name}/endpoint/protocols/openai) while the agent's was project-level.
Refactor:
- Delete both fields on FoundryAgent and the GetService override.
- Delete the ProjectOpenAIClient branch from FoundryChatClient.GetService.
- CreateConversationSessionAsync now resolves AIProjectClient at call time via this.GetService<AIProjectClient>() and derives the conversations client from it.
- Update FoundryChatClient tests that asserted on GetService<ProjectOpenAIClient> to assert Null (deliberate removal).
- Update FoundryAgent tests AgentEndpointConstructor_GetServiceProjectOpenAIClient_ReturnsNonNull and ProjectEndpointConstructor_GetServiceProjectOpenAIClient_ReturnsNonNull to ...ReturnsNull, and rewrite AgentEndpointConstructor_PropagatesUserAgentApplicationId_ToProjectLevelClient to look up AIProjectClient instead.
No production code (only tests) referenced GetService<ProjectOpenAIClient>, so this is a safe surface reduction. Net: 30 insertions, 61 deletions; FoundryAgent shrinks to a pure delegator with only the two convenience methods (CreateSessionAsync, CreateConversationSessionAsync) on top of the delegating chain.
* Rename FoundryChatClient.HostedAgentName to AgentName and populate it for mode 2
The previous name implied a mode 3 only property tied to the hosted-agent endpoint URL. Today only hosted endpoints surface this name, but conceptually an agent name exists for every server-side agent the client talks to. Renaming to AgentName makes the property general-purpose and ready for future modes where the same chat client may target other server-side agent shapes that are not necessarily 'hosted'.
Mode 2 (server-side agent reference) now mirrors AgentReference.Name into AgentName so callers have a uniform handle regardless of construction mode:
* Mode 1 (pure responses): AgentName is null. There is no agent.
* Mode 2 (AgentReference): AgentName == AgentReference.Name.
* Mode 3 (agent endpoint URL): AgentName is parsed from the URL segment as before.
Converter discriminator update: FoundryPromptAgentConverter previously used 'HostedAgentName is not null' to detect mode 3 and reject it. Now that mode 2 also populates AgentName, the mode 3 guard moves to the end of the resolution chain and uses the unambiguous 'AgentName is set AND no AgentReference exists' test. The user-visible error message and behavior are preserved.
Dead-state cleanup spotted during format verify:
* IDE0052 surfaced that FoundryChatClient._projectOpenAIClient is never read since the prior refactor stopped exposing ProjectOpenAIClient via GetService and rewired CreateConversationSessionAsync to resolve the AIProjectClient through the delegating chain. The field is deleted and its three ctor assignments removed.
* HostedAgentEndpointInner.PerAgentClient only existed to plumb the per-agent ProjectOpenAIClient into that now-deleted field, so the property and its ctor parameter are removed. The local 'perAgentClient' variable inside BuildHostedAgentEndpointInner is still needed to derive the inner IChatClient, but no longer escapes the helper.
Tests:
* Mode1_PureResponses_ReturnsNullForAgentSpecificServices now also asserts AgentName is null.
* New Mode2_AgentReference_PopulatesAgentNameFromAgentReference asserts the mode 2 mirror.
* Mode3_HostedAgentEndpoint_ParsesAgentNameFromUrl renamed assertion target HostedAgentName to AgentName.
Verification: 335/335 net10.0, 273/273 net472 Foundry unit; 229/229 Foundry.Hosting unit; format-verify (WSL2 + Docker mcr.microsoft.com/dotnet/sdk:10.0) clean on Microsoft.Agents.AI.Foundry.
* Adopt canonical mode names: Responses Agent, Prompt Agent, Agent Endpoint
Three FoundryChatClient construction modes now have one canonical noun used everywhere.
* Responses Agent (Mode 1): inline ChatClientAgent, project-level Responses API, no server-side def.
* Prompt Agent (Mode 2): server-side ProjectsAgentDefinition invoked by AgentReference.
* Agent Endpoint (Mode 3): per-agent URL /agents/{name}/endpoint/protocols/openai. Hosted-or-not.
'Hosted' stays the kind of agent (Microsoft.Agents.AI.Foundry.Hosting). Not synonym of Mode 3.
Rings:
1. XML docs + error messages use canonical names. en-GB to en-US: centralises, synthesise.
2. HostedAgentEndpointInner -> AgentEndpointInner, BuildHostedAgentEndpointInner -> BuildAgentEndpointInner.
3. Tests: Mode1_PureResponses_* -> Mode1_ResponsesAgent_*, Mode2_AgentReference_* -> Mode2_PromptAgent_*, Mode3_HostedAgentEndpoint_* -> Mode3_AgentEndpoint_*.
Pure rename. No behavior change. 335/335 net10 + 273/273 net472 unit, format clean.
* Address PR #5940 design feedback (Q-A through Q-F)
Q-A: poll vector store til status leaves InProgress before return. Exp backoff 250ms-2s. Honor cancel.
Q-B: try/catch upload loop. Mid-fail = best-effort DeleteFileAsync on already-uploaded ids. Swallow cleanup errors.
Q-C: pinned AgentReference.Version uses GetAgentVersionAsync. Empty/whitespace/'latest' = GetLatest path.
Q-D: HostedAgentUserAgentPolicy detects existing combined 'foundry-hosting/...' segment. No double prefix.
Q-E: mode-3 vector-store test uses fake transport. No DNS to example.com.
Q-F: no shim. Class always [Experimental] (since 8015e00f5, before dotnet-1.0.0). No compat contract. Callers rename to AIProjectClientExtensions.
Rebase onto origin/main reconciliation: aad20c2b3 added public AsAIAgent(this AIProjectClient, Uri agentEndpoint, ...) extension that calls an internal FoundryAgent(AIProjectClient, Uri, ...) ctor. Reintroduced that ctor + a new FoundryChatClient(AIProjectClient, Uri, ProjectOpenAIClientOptions?) overload that reuses the supplied AIProjectClient's pipeline (via GetProjectResponsesClientForAgentEndpoint) instead of stamping a fresh credential.
Verified: 346/346 net10 + 284/284 net472 Foundry unit, 230/230 Foundry.Hosting unit, format clean.
* Add FoundryAgent helper extensions: UploadFile/DeleteFile/CreateVectorStore/DeleteVectorStore
4 thin forwarders on FoundryAgent that route to the inner FoundryChatClient's helpers via agent.GetService<FoundryChatClient>().X(). Live in existing FoundryAgentExtensions.cs alongside ToPromptAgentAsync.
Throws InvalidOperationException when agent does not expose a FoundryChatClient via GetService (same pattern as ToPromptAgentAsync).
Unit tests: FoundryAgentExtensionsTests covers all 4 forwarders + null-agent ArgumentNullException for each. 8 new tests, 354/354 net10 + 292/292 net472.
Integration tests: parallel FoundryAgentExtensionsTests under Foundry.IntegrationTests mirrors the existing CreateAgent_CreatesAgentWithVectorStoresAsync shape (upload -> create vector store -> FileSearch tool answers question -> cleanup), but routes every helper call through the new FoundryAgent extensions. 4 new IT tests, all verified pass live against the real Foundry project (12-30s each). Skipped by default like the existing vector-store IT.
* Address Sergey's PR review comments
#1 (FoundryAgent.cs:139): drop unused aiProjectClient param from internal FoundryAgent(AIProjectClient, ChatClientAgent) ctor. Was discarded after null-check. Inner FoundryChatClient already surfaces AIProjectClient via GetService. 3 call sites in AIProjectClientExtensions updated.
#2 (FoundryChatClient.cs:376): add pollingTimeout param to CreateVectorStoreAsync. Defaults to 5 min, configurable, Timeout.InfiniteTimeSpan disables. Throws TimeoutException with vector store id and elapsed seconds when bound exceeded. CancellationToken still wins. New unit test PollingTimeout_ThrowsTimeoutExceptionAsync. FoundryAgentExtensions forwarder updated to plumb the new param.
Verified: 355/355 net10 + 293/293 net472 Foundry unit, 230/230 Foundry.Hosting unit, format clean.
This commit is contained in:
Roger Barreto
@@ -0,0 +1,229 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Threading.Tasks;
|
||||
using AgentConformance.IntegrationTests.Support;
|
||||
using Azure.AI.Projects;
|
||||
using Azure.AI.Projects.Agents;
|
||||
using Microsoft.Agents.AI;
|
||||
using Microsoft.Agents.AI.Foundry;
|
||||
using OpenAI.Files;
|
||||
using OpenAI.Responses;
|
||||
using OpenAI.VectorStores;
|
||||
using Shared.IntegrationTests;
|
||||
|
||||
namespace Foundry.IntegrationTests;
|
||||
|
||||
/// <summary>
|
||||
/// Integration tests for the file and vector-store forwarder extensions on
|
||||
/// <see cref="FoundryAgent"/> declared in <see cref="FoundryAgentExtensions"/>. End-to-end
|
||||
/// counterparts of the unit tests in
|
||||
/// <c>FoundryAgentExtensionsTests</c> that exercise the live Foundry project pipeline.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Mirrors <see cref="FoundryVersionedAgentCreateTests.CreateAgent_CreatesAgentWithVectorStoresAsync(string)"/>
|
||||
/// in shape (file upload → vector store creation → FileSearchTool answer → cleanup), but routes
|
||||
/// every helper call through the new <see cref="FoundryAgent"/> extensions instead of the raw
|
||||
/// <c>projectOpenAIClient.GetProjectFilesClient()</c> / <c>GetProjectVectorStoresClient()</c>
|
||||
/// path. Skipped by default for the same reasons as the existing vector-store IT (cost and
|
||||
/// runtime); flip Skip to run manually after seeding the right Foundry project.
|
||||
/// </remarks>
|
||||
public class FoundryAgentExtensionsTests
|
||||
{
|
||||
private readonly AIProjectClient _client = new(
|
||||
new Uri(TestConfiguration.GetRequiredValue(TestSettings.AzureAIProjectEndpoint)),
|
||||
TestAzureCliCredentials.CreateAzureCliCredential());
|
||||
|
||||
[Fact(Skip = "For manual testing only")]
|
||||
public async Task UploadFileAsync_ViaAgentExtension_UploadsToProjectAsync()
|
||||
{
|
||||
// Arrange — non-versioned Responses Agent (Mode 1) so we do not have to provision a server-side agent.
|
||||
var agent = this._client.AsAIAgent(
|
||||
model: TestConfiguration.GetRequiredValue(TestSettings.AzureAIModelDeploymentName),
|
||||
instructions: "Be helpful.");
|
||||
var foundryAgent = this.WrapAsFoundryAgent(agent);
|
||||
|
||||
var filePath = Path.GetTempFileName() + ".txt";
|
||||
File.WriteAllText(filePath, "agent-extensions integration test payload");
|
||||
|
||||
OpenAIFile? uploaded = null;
|
||||
try
|
||||
{
|
||||
// Act.
|
||||
uploaded = await foundryAgent.UploadFileAsync(filePath, FileUploadPurpose.Assistants);
|
||||
|
||||
// Assert.
|
||||
Assert.NotNull(uploaded);
|
||||
Assert.False(string.IsNullOrEmpty(uploaded.Id));
|
||||
Assert.Equal(Path.GetFileName(filePath), uploaded.Filename);
|
||||
}
|
||||
finally
|
||||
{
|
||||
if (uploaded is not null)
|
||||
{
|
||||
await foundryAgent.DeleteFileAsync(uploaded.Id);
|
||||
}
|
||||
|
||||
File.Delete(filePath);
|
||||
}
|
||||
}
|
||||
|
||||
[Fact(Skip = "For manual testing only")]
|
||||
public async Task DeleteFileAsync_ViaAgentExtension_RemovesUploadedFileAsync()
|
||||
{
|
||||
var agent = this._client.AsAIAgent(
|
||||
model: TestConfiguration.GetRequiredValue(TestSettings.AzureAIModelDeploymentName),
|
||||
instructions: "Be helpful.");
|
||||
var foundryAgent = this.WrapAsFoundryAgent(agent);
|
||||
|
||||
var filePath = Path.GetTempFileName() + ".txt";
|
||||
File.WriteAllText(filePath, "delete-me payload");
|
||||
|
||||
try
|
||||
{
|
||||
var uploaded = await foundryAgent.UploadFileAsync(filePath, FileUploadPurpose.Assistants);
|
||||
|
||||
// Act.
|
||||
var result = await foundryAgent.DeleteFileAsync(uploaded.Id);
|
||||
|
||||
// Assert.
|
||||
Assert.NotNull(result);
|
||||
Assert.Equal(uploaded.Id, result.FileId);
|
||||
Assert.True(result.Deleted);
|
||||
}
|
||||
finally
|
||||
{
|
||||
File.Delete(filePath);
|
||||
}
|
||||
}
|
||||
|
||||
[Fact(Skip = "For manual testing only")]
|
||||
public async Task CreateVectorStoreAsync_ViaAgentExtension_BuildsStoreAndAnswersFileSearchQuestionAsync()
|
||||
{
|
||||
// Mirrors CreateAgent_CreatesAgentWithVectorStoresAsync but the upload-then-create-store
|
||||
// sequence routes through the FoundryAgent.CreateVectorStoreAsync extension (single call
|
||||
// that uploads, creates the store, and polls until ready). The resulting vector store id
|
||||
// is then wired to a versioned agent's FileSearch tool and queried for a known value.
|
||||
string AgentName = FoundryVersionedAgentFixture.GenerateUniqueAgentName("VectorStoreExtAgent");
|
||||
const string AgentInstructions = """
|
||||
You are a helpful agent that can help fetch data from files you know about.
|
||||
Use the File Search Tool to look up codes for words.
|
||||
Do not answer a question unless you can find the answer using the File Search Tool.
|
||||
""";
|
||||
|
||||
// Non-versioned helper agent that owns the upload pipeline.
|
||||
var helperAgent = this._client.AsAIAgent(
|
||||
model: TestConfiguration.GetRequiredValue(TestSettings.AzureAIModelDeploymentName),
|
||||
instructions: "Be helpful.");
|
||||
var helperFoundryAgent = this.WrapAsFoundryAgent(helperAgent);
|
||||
|
||||
var searchFilePath = Path.GetTempFileName() + "wordcodelookup.txt";
|
||||
File.WriteAllText(searchFilePath, "The word 'apple' uses the code 442345, while the word 'banana' uses the code 673457.");
|
||||
|
||||
VectorStore? vectorStore = null;
|
||||
FoundryAgent? versionedAgent = null;
|
||||
try
|
||||
{
|
||||
// Act — single agent-level helper call uploads, creates, and waits until ready.
|
||||
vectorStore = await helperFoundryAgent.CreateVectorStoreAsync(
|
||||
"WordCodeLookup_ExtensionVectorStore",
|
||||
new[] { searchFilePath });
|
||||
|
||||
Assert.NotNull(vectorStore);
|
||||
Assert.False(string.IsNullOrEmpty(vectorStore.Id));
|
||||
Assert.NotEqual(VectorStoreStatus.InProgress, vectorStore.Status);
|
||||
|
||||
// Wire the store id into a versioned agent's FileSearch tool to prove it is actually usable.
|
||||
var definition = new DeclarativeAgentDefinition(TestConfiguration.GetRequiredValue(TestSettings.AzureAIModelDeploymentName))
|
||||
{
|
||||
Instructions = AgentInstructions,
|
||||
Tools = { ResponseTool.CreateFileSearchTool(vectorStoreIds: [vectorStore.Id]) },
|
||||
};
|
||||
|
||||
var agentVersion = await this._client.AgentAdministrationClient.CreateAgentVersionAsync(
|
||||
AgentName,
|
||||
new ProjectsAgentVersionCreationOptions(definition));
|
||||
|
||||
versionedAgent = this._client.AsAIAgent(agentVersion);
|
||||
|
||||
// Assert.
|
||||
var result = await versionedAgent.RunAsync("Can you give me the documented code for 'banana'?");
|
||||
Assert.Contains("673457", result.ToString());
|
||||
}
|
||||
finally
|
||||
{
|
||||
if (versionedAgent is not null)
|
||||
{
|
||||
await this._client.AgentAdministrationClient.DeleteAgentAsync(versionedAgent.Name);
|
||||
}
|
||||
|
||||
// Cleanup the vector store via the new extension too.
|
||||
if (vectorStore is not null)
|
||||
{
|
||||
await helperFoundryAgent.DeleteVectorStoreAsync(vectorStore.Id);
|
||||
}
|
||||
|
||||
File.Delete(searchFilePath);
|
||||
}
|
||||
}
|
||||
|
||||
[Fact(Skip = "For manual testing only")]
|
||||
public async Task DeleteVectorStoreAsync_ViaAgentExtension_RemovesStoreAsync()
|
||||
{
|
||||
var agent = this._client.AsAIAgent(
|
||||
model: TestConfiguration.GetRequiredValue(TestSettings.AzureAIModelDeploymentName),
|
||||
instructions: "Be helpful.");
|
||||
var foundryAgent = this.WrapAsFoundryAgent(agent);
|
||||
|
||||
var filePath = Path.GetTempFileName() + ".txt";
|
||||
File.WriteAllText(filePath, "delete-store payload");
|
||||
|
||||
VectorStore? vectorStore = null;
|
||||
try
|
||||
{
|
||||
vectorStore = await foundryAgent.CreateVectorStoreAsync(
|
||||
"DeleteVectorStore_ExtensionTest",
|
||||
new[] { filePath });
|
||||
|
||||
// Act.
|
||||
var result = await foundryAgent.DeleteVectorStoreAsync(vectorStore.Id);
|
||||
|
||||
// Assert.
|
||||
Assert.NotNull(result);
|
||||
Assert.Equal(vectorStore.Id, result.VectorStoreId);
|
||||
Assert.True(result.Deleted);
|
||||
vectorStore = null;
|
||||
}
|
||||
finally
|
||||
{
|
||||
if (vectorStore is not null)
|
||||
{
|
||||
await foundryAgent.DeleteVectorStoreAsync(vectorStore.Id);
|
||||
}
|
||||
|
||||
File.Delete(filePath);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Resolves the underlying <see cref="FoundryAgent"/> from an <see cref="AIAgent"/> handle
|
||||
/// returned by <c>AIProjectClient.AsAIAgent(model, instructions)</c>. The Mode 1 overload
|
||||
/// returns a <see cref="ChatClientAgent"/>; the extension forwarders we test live on
|
||||
/// <see cref="FoundryAgent"/>, so callers wanting them through this entry point need to
|
||||
/// reach for the FoundryAgent constructor instead. This helper makes the test setup
|
||||
/// consistent across the four IT scenarios.
|
||||
/// </summary>
|
||||
private FoundryAgent WrapAsFoundryAgent(AIAgent agent)
|
||||
{
|
||||
// The Mode 1 AsAIAgent overload returns ChatClientAgent rather than FoundryAgent; use
|
||||
// the FoundryAgent projectEndpoint+model+instructions ctor to get the same underlying
|
||||
// FoundryChatClient surfaced through a FoundryAgent typed handle.
|
||||
_ = agent;
|
||||
return new FoundryAgent(
|
||||
projectEndpoint: new Uri(TestConfiguration.GetRequiredValue(TestSettings.AzureAIProjectEndpoint)),
|
||||
credential: TestAzureCliCredentials.CreateAzureCliCredential(),
|
||||
model: TestConfiguration.GetRequiredValue(TestSettings.AzureAIModelDeploymentName),
|
||||
instructions: "Be helpful.");
|
||||
}
|
||||
}
|
||||
+2
-2
@@ -11,7 +11,7 @@ namespace Foundry.IntegrationTests;
|
||||
public class FoundryVersionedAgentStructuredOutputRunTests() : StructuredOutputRunTests<FoundryVersionedAgentStructuredOutputFixture<CityInfo>>(() => new FoundryVersionedAgentStructuredOutputFixture<CityInfo>())
|
||||
{
|
||||
private const string NotSupported = "Versioned Foundry agents do not support specifying structured output type at invocation time.";
|
||||
private const string ResponseFormatNotSupported = "AzureAIProjectChatClient clears ResponseFormat for versioned agents; structured output must be defined in the server-side agent definition.";
|
||||
private const string ResponseFormatNotSupported = "FoundryChatClient clears ResponseFormat for versioned agents; structured output must be defined in the server-side agent definition.";
|
||||
|
||||
/// <summary>
|
||||
/// Verifies that response format provided at agent initialization is used when invoking RunAsync.
|
||||
@@ -41,7 +41,7 @@ public class FoundryVersionedAgentStructuredOutputRunTests() : StructuredOutputR
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Versioned Foundry agents do not support specifying the structured output type at invocation time yet.
|
||||
/// The type T provided to RunAsync<T> is ignored by AzureAIProjectChatClient and is only used
|
||||
/// The type T provided to RunAsync<T> is ignored by FoundryChatClient and is only used
|
||||
/// for deserializing the agent response by AgentResponse<T>.Result.
|
||||
/// </remarks>
|
||||
[RetryFact(Constants.RetryCount, Constants.RetryDelay, Skip = ResponseFormatNotSupported)]
|
||||
|
||||
+191
-4
@@ -64,15 +64,29 @@ public sealed class HostedOutboundUserAgentTests : IAsyncDisposable
|
||||
var inboundBody = await inboundResponse.Content.ReadAsStringAsync();
|
||||
|
||||
// Assert: at least one OUTBOUND request reached the fake transport, AND it carries the
|
||||
// foundry-hosting/agent-framework-dotnet/{version} supplement on its User-Agent.
|
||||
// (We don't care about the inbound response shape — only that the agent's call to MEAI
|
||||
// triggered an outbound request whose UA reaches the sandbox boundary correctly.)
|
||||
// combined hosted segment foundry-hosting/agent-framework-dotnet/{version} on its
|
||||
// User-Agent. This matches Python's contract
|
||||
// (foundry-hosting/agent-framework-python/{version}, see
|
||||
// python/packages/core/agent_framework/_telemetry.py): a single combined segment when
|
||||
// hosted, never two separate ones. The bare agent-framework-dotnet/{version} segment
|
||||
// (from AgentFrameworkUserAgentPolicy in FoundryChatClient) must be upgraded in place
|
||||
// by HostedAgentUserAgentPolicy — never appear duplicated.
|
||||
Assert.True(this._outboundHandler!.Requests.Count > 0,
|
||||
$"Expected at least one outbound request. Inbound status: {(int)inboundResponse.StatusCode}, body: {inboundBody}");
|
||||
var outbound = this._outboundHandler.Requests[0];
|
||||
Assert.StartsWith(TestEndpoint, outbound.Uri);
|
||||
Assert.Contains("MEAI/", outbound.UserAgent);
|
||||
Assert.Contains("foundry-hosting/agent-framework-dotnet", outbound.UserAgent);
|
||||
Assert.Contains("foundry-hosting/agent-framework-dotnet/", outbound.UserAgent);
|
||||
|
||||
// The bare agent-framework-dotnet/{v} segment must NOT appear separately when the
|
||||
// combined form is present — Python emits a single combined value when the hosted
|
||||
// prefix is registered, and .NET preserves that contract via the in-place upgrade in
|
||||
// HostedAgentUserAgentPolicy.
|
||||
var combinedIdx = outbound.UserAgent!.IndexOf("foundry-hosting/agent-framework-dotnet/", StringComparison.Ordinal);
|
||||
var beforeCombined = outbound.UserAgent.Substring(0, combinedIdx);
|
||||
var afterCombined = outbound.UserAgent.Substring(combinedIdx + "foundry-hosting/agent-framework-dotnet/".Length);
|
||||
Assert.DoesNotContain("agent-framework-dotnet/", beforeCombined);
|
||||
Assert.DoesNotContain("agent-framework-dotnet/", afterCombined);
|
||||
}
|
||||
|
||||
private async Task StartHostedServerAsync()
|
||||
@@ -197,6 +211,179 @@ public sealed class HostedOutboundUserAgentTests : IAsyncDisposable
|
||||
return array?.Length ?? -1;
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// Direct unit tests for HostedAgentUserAgentPolicy's in-place upgrade behavior.
|
||||
// These run the policy on a synthetic ClientPipeline (no hosting infrastructure)
|
||||
// so the upgrade logic itself can be asserted in isolation.
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
[Fact]
|
||||
public async Task HostedAgentUserAgentPolicy_UpgradesBareAgentFrameworkSegment_InPlaceAsync()
|
||||
{
|
||||
// Arrange: an upstream per-call policy stamps the bare agent-framework-dotnet/{version}
|
||||
// segment (matching what AgentFrameworkUserAgentPolicy would write in non-hosted code).
|
||||
// Then HostedAgentUserAgentPolicy runs and must REPLACE that segment with the combined
|
||||
// foundry-hosting/agent-framework-dotnet/{version} form, not append a duplicate.
|
||||
using var handler = new InspectingHandler();
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
var pipeline = ClientPipeline.Create(
|
||||
new ClientPipelineOptions { Transport = new HttpClientPipelineTransport(httpClient) },
|
||||
perCallPolicies: [new SetUserAgentPolicy("agent-framework-dotnet/9.9.9"), HostedAgentUserAgentPolicy.Instance],
|
||||
perTryPolicies: default,
|
||||
beforeTransportPolicies: default);
|
||||
|
||||
// Act
|
||||
var message = pipeline.CreateMessage();
|
||||
message.Request.Method = "POST";
|
||||
message.Request.Uri = new Uri("https://example.test/anything");
|
||||
await pipeline.SendAsync(message);
|
||||
|
||||
// Assert: combined form is present; bare form is gone (no duplicate agent-framework segment).
|
||||
Assert.NotNull(handler.LastUserAgent);
|
||||
Assert.Contains("foundry-hosting/agent-framework-dotnet/", handler.LastUserAgent);
|
||||
var ua = handler.LastUserAgent!;
|
||||
var firstAgentFramework = ua.IndexOf("agent-framework-dotnet/", StringComparison.Ordinal);
|
||||
Assert.True(firstAgentFramework >= 0, "Expected agent-framework-dotnet segment.");
|
||||
var secondAgentFramework = ua.IndexOf("agent-framework-dotnet/", firstAgentFramework + 1, StringComparison.Ordinal);
|
||||
Assert.Equal(-1, secondAgentFramework);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task HostedAgentUserAgentPolicy_AppendsCombined_WhenNoBareSegmentPresentAsync()
|
||||
{
|
||||
// Arrange: nothing upstream stamps the bare segment. Hosted policy should append the
|
||||
// full combined segment to whatever User-Agent is on the wire.
|
||||
using var handler = new InspectingHandler();
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
var pipeline = ClientPipeline.Create(
|
||||
new ClientPipelineOptions { Transport = new HttpClientPipelineTransport(httpClient) },
|
||||
perCallPolicies: [HostedAgentUserAgentPolicy.Instance],
|
||||
perTryPolicies: default,
|
||||
beforeTransportPolicies: default);
|
||||
|
||||
// Act
|
||||
var message = pipeline.CreateMessage();
|
||||
message.Request.Method = "POST";
|
||||
message.Request.Uri = new Uri("https://example.test/anything");
|
||||
await pipeline.SendAsync(message);
|
||||
|
||||
// Assert
|
||||
Assert.NotNull(handler.LastUserAgent);
|
||||
Assert.Contains("foundry-hosting/agent-framework-dotnet/", handler.LastUserAgent);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task HostedAgentUserAgentPolicy_IsIdempotent_WhenCombinedSegmentAlreadyPresentAsync()
|
||||
{
|
||||
// Arrange: upstream pre-populates the combined segment (simulating a retry or duplicate
|
||||
// registration). Hosted policy must not re-append.
|
||||
using var handler = new InspectingHandler();
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
var pipeline = ClientPipeline.Create(
|
||||
new ClientPipelineOptions { Transport = new HttpClientPipelineTransport(httpClient) },
|
||||
perCallPolicies: [new SetUserAgentPolicy("foundry-hosting/agent-framework-dotnet/9.9.9"), HostedAgentUserAgentPolicy.Instance],
|
||||
perTryPolicies: default,
|
||||
beforeTransportPolicies: default);
|
||||
|
||||
// Act
|
||||
var message = pipeline.CreateMessage();
|
||||
message.Request.Method = "POST";
|
||||
message.Request.Uri = new Uri("https://example.test/anything");
|
||||
await pipeline.SendAsync(message);
|
||||
|
||||
// Assert: exactly one occurrence of "foundry-hosting/agent-framework-dotnet/" segment.
|
||||
Assert.NotNull(handler.LastUserAgent);
|
||||
var first = handler.LastUserAgent!.IndexOf("foundry-hosting/agent-framework-dotnet/", StringComparison.Ordinal);
|
||||
Assert.True(first >= 0);
|
||||
var second = handler.LastUserAgent.IndexOf("foundry-hosting/agent-framework-dotnet/", first + 1, StringComparison.Ordinal);
|
||||
Assert.Equal(-1, second);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task HostedAgentUserAgentPolicy_ReplacesDifferentVersionCombinedSegment_InPlaceAsync()
|
||||
{
|
||||
// Q-D regression: when the User-Agent already carries the COMBINED hosted form with a
|
||||
// different version (e.g. an older registration or caller-supplied baseline), the policy
|
||||
// must replace the entire combined span — not just the bare suffix — so we never emit
|
||||
// the malformed `foundry-hosting/foundry-hosting/agent-framework-dotnet/...` shape.
|
||||
using var handler = new InspectingHandler();
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
var pipeline = ClientPipeline.Create(
|
||||
new ClientPipelineOptions { Transport = new HttpClientPipelineTransport(httpClient) },
|
||||
perCallPolicies: [new SetUserAgentPolicy("foundry-hosting/agent-framework-dotnet/0.0.1 MEAI/10.5.1"), HostedAgentUserAgentPolicy.Instance],
|
||||
perTryPolicies: default,
|
||||
beforeTransportPolicies: default);
|
||||
|
||||
// Act
|
||||
var message = pipeline.CreateMessage();
|
||||
message.Request.Method = "POST";
|
||||
message.Request.Uri = new Uri("https://example.test/anything");
|
||||
await pipeline.SendAsync(message);
|
||||
|
||||
// Assert: no doubled foundry-hosting/ prefix.
|
||||
Assert.NotNull(handler.LastUserAgent);
|
||||
Assert.DoesNotContain("foundry-hosting/foundry-hosting/", handler.LastUserAgent, StringComparison.Ordinal);
|
||||
|
||||
// The combined segment must appear exactly once, and the trailing MEAI segment must be
|
||||
// preserved in place (i.e. the policy only rewrote the combined span, not anything after it).
|
||||
var firstCombined = handler.LastUserAgent!.IndexOf("foundry-hosting/agent-framework-dotnet/", StringComparison.Ordinal);
|
||||
Assert.True(firstCombined >= 0);
|
||||
var secondCombined = handler.LastUserAgent.IndexOf("foundry-hosting/agent-framework-dotnet/", firstCombined + 1, StringComparison.Ordinal);
|
||||
Assert.Equal(-1, secondCombined);
|
||||
Assert.Contains(" MEAI/10.5.1", handler.LastUserAgent, StringComparison.Ordinal);
|
||||
|
||||
// And the version that survives must be the runtime supplement value's version, not 0.0.1.
|
||||
Assert.DoesNotContain("foundry-hosting/agent-framework-dotnet/0.0.1", handler.LastUserAgent, StringComparison.Ordinal);
|
||||
}
|
||||
|
||||
private sealed class InspectingHandler : HttpClientHandler
|
||||
{
|
||||
public string? LastUserAgent { get; private set; }
|
||||
|
||||
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
|
||||
{
|
||||
this.LastUserAgent = request.Headers.TryGetValues("User-Agent", out var values)
|
||||
? string.Join(",", values)
|
||||
: null;
|
||||
|
||||
return Task.FromResult(new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent("{}", Encoding.UTF8, "application/json"),
|
||||
RequestMessage = request,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
private sealed class SetUserAgentPolicy : PipelinePolicy
|
||||
{
|
||||
private readonly string _value;
|
||||
public SetUserAgentPolicy(string value) => this._value = value;
|
||||
|
||||
public override void Process(PipelineMessage message, IReadOnlyList<PipelinePolicy> pipeline, int currentIndex)
|
||||
{
|
||||
message.Request.Headers.Set("User-Agent", this._value);
|
||||
ProcessNext(message, pipeline, currentIndex);
|
||||
}
|
||||
|
||||
public override ValueTask ProcessAsync(PipelineMessage message, IReadOnlyList<PipelinePolicy> pipeline, int currentIndex)
|
||||
{
|
||||
message.Request.Headers.Set("User-Agent", this._value);
|
||||
return ProcessNextAsync(message, pipeline, currentIndex);
|
||||
}
|
||||
}
|
||||
|
||||
private sealed class NoopHandler : HttpMessageHandler
|
||||
{
|
||||
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
|
||||
|
||||
+111
-4
@@ -23,9 +23,9 @@ namespace Microsoft.Agents.AI.Foundry.UnitTests;
|
||||
|
||||
#pragma warning disable CS0618
|
||||
/// <summary>
|
||||
/// Unit tests for the <see cref="AzureAIProjectChatClientExtensions"/> class.
|
||||
/// Unit tests for the <see cref="AIProjectClientExtensions"/> class.
|
||||
/// </summary>
|
||||
public sealed class AzureAIProjectChatClientExtensionsTests
|
||||
public sealed class AIProjectClientExtensionsTests
|
||||
{
|
||||
#region AsAIAgent(AIProjectClient, model, instructions) Tests
|
||||
|
||||
@@ -71,7 +71,11 @@ public sealed class AzureAIProjectChatClientExtensionsTests
|
||||
Assert.Equal("test-agent", agent.Name);
|
||||
Assert.Equal("A test agent", agent.Description);
|
||||
Assert.NotNull(agent.GetService<IChatClient>());
|
||||
Assert.Null(agent.GetService<AIProjectClient>());
|
||||
// After the FoundryChatClient consolidation the inner chat-client now exposes the
|
||||
// AIProjectClient via GetService — Foundry callers can walk to the project client from
|
||||
// the agent without holding their own reference. (Previously this path returned null
|
||||
// because AsAIAgent(model, instructions) skipped the decorator entirely.)
|
||||
Assert.NotNull(agent.GetService<AIProjectClient>());
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -123,7 +127,10 @@ public sealed class AzureAIProjectChatClientExtensionsTests
|
||||
Assert.NotNull(agent);
|
||||
Assert.Equal("options-agent", agent.Name);
|
||||
Assert.Equal("Agent from options", agent.Description);
|
||||
Assert.Null(agent.GetService<AIProjectClient>());
|
||||
// After the FoundryChatClient consolidation the inner chat-client now exposes the
|
||||
// AIProjectClient via GetService — see twin assertion in
|
||||
// AsAIAgent_Rapi_WithModelAndInstructions_CreatesChatClientAgent for the rationale.
|
||||
Assert.NotNull(agent.GetService<AIProjectClient>());
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -185,6 +192,106 @@ public sealed class AzureAIProjectChatClientExtensionsTests
|
||||
Assert.True(userAgentFound, "MEAI user-agent header was not found in any request");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Verify that the non-versioned AsAIAgent overload now wraps with FoundryChatClient
|
||||
/// (regression-prevention for the previously-untagged extension path).
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public void AsAIAgent_Rapi_WithModelAndInstructions_ExposesFoundryChatClientAndProviderName()
|
||||
{
|
||||
// Arrange
|
||||
AIProjectClient client = this.CreateTestAgentClient();
|
||||
|
||||
// Act
|
||||
ChatClientAgent agent = client.AsAIAgent("gpt-4o-mini", "You are helpful.");
|
||||
|
||||
// Assert: FoundryChatClient is internal-sealed and reachable via GetService<IChatClient>().
|
||||
var chatClient = agent.GetService<IChatClient>();
|
||||
Assert.NotNull(chatClient);
|
||||
|
||||
// Provider tag is "microsoft.foundry" (previously this path had no Foundry tag at all).
|
||||
var metadata = chatClient!.GetService<ChatClientMetadata>();
|
||||
Assert.NotNull(metadata);
|
||||
Assert.Equal("microsoft.foundry", metadata!.ProviderName);
|
||||
Assert.Equal("gpt-4o-mini", metadata.DefaultModelId);
|
||||
|
||||
// Reaching the FoundryChatClient by type (via InternalsVisibleTo).
|
||||
Assert.NotNull(agent.GetService<FoundryChatClient>());
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Verify that the options-based non-versioned AsAIAgent overload now wraps with FoundryChatClient.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public void AsAIAgent_Rapi_WithOptions_ExposesFoundryChatClientAndProviderName()
|
||||
{
|
||||
// Arrange
|
||||
AIProjectClient client = this.CreateTestAgentClient();
|
||||
ChatClientAgentOptions options = new()
|
||||
{
|
||||
Name = "options-agent",
|
||||
ChatOptions = new ChatOptions { ModelId = "gpt-4o-mini", Instructions = "x" },
|
||||
};
|
||||
|
||||
// Act
|
||||
ChatClientAgent agent = client.AsAIAgent(options);
|
||||
|
||||
// Assert
|
||||
var chatClient = agent.GetService<IChatClient>();
|
||||
Assert.NotNull(chatClient);
|
||||
var metadata = chatClient!.GetService<ChatClientMetadata>();
|
||||
Assert.NotNull(metadata);
|
||||
Assert.Equal("microsoft.foundry", metadata!.ProviderName);
|
||||
Assert.NotNull(agent.GetService<FoundryChatClient>());
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Verify that the non-versioned AsAIAgent overload stamps the
|
||||
/// agent-framework-dotnet/{version} segment on outbound requests via the new
|
||||
/// AgentFrameworkUserAgentPolicy registered by FoundryChatClient.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task AsAIAgent_Rapi_WithModelAndInstructions_StampsAgentFrameworkUserAgentSegmentAsync()
|
||||
{
|
||||
bool afSeen = false;
|
||||
using HttpHandlerAssert httpHandler = new(request =>
|
||||
{
|
||||
if (request.Headers.TryGetValues("User-Agent", out IEnumerable<string>? values))
|
||||
{
|
||||
foreach (string value in values)
|
||||
{
|
||||
if (value.Contains("agent-framework-dotnet/"))
|
||||
{
|
||||
afSeen = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent(TestDataUtil.GetOpenAIDefaultResponseJson(), Encoding.UTF8, "application/json")
|
||||
};
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using HttpClient httpClient = new(httpHandler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
AIProjectClient aiProjectClient = new(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new() { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
ChatClientAgent agent = aiProjectClient.AsAIAgent("gpt-4o-mini", "You are helpful.");
|
||||
|
||||
// Act
|
||||
AgentSession session = await agent.CreateSessionAsync();
|
||||
await agent.RunAsync("Hello", session);
|
||||
|
||||
// Assert
|
||||
Assert.True(afSeen, "Expected agent-framework-dotnet/{version} segment on outbound requests from AsAIAgent(model, instructions).");
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region AsAIAgent(AIProjectClient, ProjectsAgentRecord) Tests
|
||||
+199
@@ -0,0 +1,199 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
using System;
|
||||
using System.ClientModel.Primitives;
|
||||
using System.Collections.Generic;
|
||||
using System.Net;
|
||||
using System.Net.Http;
|
||||
using System.Reflection;
|
||||
using System.Text;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
|
||||
namespace Microsoft.Agents.AI.Foundry.UnitTests;
|
||||
|
||||
/// <summary>
|
||||
/// Verifies the framework-wide <see cref="AgentFrameworkUserAgentPolicy"/>. The policy stamps
|
||||
/// <c>agent-framework-dotnet/{version}</c> onto the outgoing <c>User-Agent</c> header of every
|
||||
/// request made through a Foundry chat client and is registered automatically by
|
||||
/// <c>FoundryChatClient</c> via the MEAI <c>OpenAIRequestPolicies</c> hook.
|
||||
/// </summary>
|
||||
public sealed class AgentFrameworkUserAgentPolicyTests
|
||||
{
|
||||
[Fact]
|
||||
public async Task AgentFrameworkUserAgentPolicy_AddsAgentFrameworkSegment_ToOutgoingRequestAsync()
|
||||
{
|
||||
// Arrange
|
||||
using var handler = new RecordingHandler();
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var pipeline = ClientPipeline.Create(
|
||||
new ClientPipelineOptions { Transport = new HttpClientPipelineTransport(httpClient) },
|
||||
perCallPolicies: [AgentFrameworkUserAgentPolicy.Instance],
|
||||
perTryPolicies: default,
|
||||
beforeTransportPolicies: default);
|
||||
|
||||
// Act
|
||||
var message = pipeline.CreateMessage();
|
||||
message.Request.Method = "POST";
|
||||
message.Request.Uri = new Uri("https://example.test/anything");
|
||||
await pipeline.SendAsync(message);
|
||||
|
||||
// Assert
|
||||
Assert.Equal(1, handler.Count);
|
||||
Assert.NotNull(handler.LastUserAgent);
|
||||
Assert.Contains("agent-framework-dotnet/", handler.LastUserAgent);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task AgentFrameworkUserAgentPolicy_DoesNotStampMeaiSegmentAsync()
|
||||
{
|
||||
// Arrange: the AF policy must only contribute the agent-framework-dotnet segment.
|
||||
// The MEAI/{version} segment is contributed by the MEAI-shipped policy at a different
|
||||
// layer; this policy must not duplicate or replace it.
|
||||
using var handler = new RecordingHandler();
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var pipeline = ClientPipeline.Create(
|
||||
new ClientPipelineOptions { Transport = new HttpClientPipelineTransport(httpClient) },
|
||||
perCallPolicies: [AgentFrameworkUserAgentPolicy.Instance],
|
||||
perTryPolicies: default,
|
||||
beforeTransportPolicies: default);
|
||||
|
||||
// Act
|
||||
var message = pipeline.CreateMessage();
|
||||
message.Request.Method = "POST";
|
||||
message.Request.Uri = new Uri("https://example.test/anything");
|
||||
await pipeline.SendAsync(message);
|
||||
|
||||
// Assert
|
||||
Assert.NotNull(handler.LastUserAgent);
|
||||
Assert.DoesNotContain("MEAI/", handler.LastUserAgent);
|
||||
Assert.DoesNotContain("foundry-hosting/", handler.LastUserAgent);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task AgentFrameworkUserAgentPolicy_PreservesExistingUserAgent_WhenAppendingAsync()
|
||||
{
|
||||
// Arrange: a per-call policy upstream that pre-populates the User-Agent header. The AF
|
||||
// policy must read the existing value and append (not overwrite) the agent-framework
|
||||
// segment so both stay reachable on the wire. (The exact separator the HTTP transport
|
||||
// emits between multi-value User-Agent entries is comma per RFC 7230; this test does
|
||||
// not assert on the separator character because that is a transport detail.)
|
||||
using var handler = new RecordingHandler();
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var pipeline = ClientPipeline.Create(
|
||||
new ClientPipelineOptions { Transport = new HttpClientPipelineTransport(httpClient) },
|
||||
perCallPolicies: [new SeedUserAgentPolicy("existing-app/1.0"), AgentFrameworkUserAgentPolicy.Instance],
|
||||
perTryPolicies: default,
|
||||
beforeTransportPolicies: default);
|
||||
|
||||
// Act
|
||||
var message = pipeline.CreateMessage();
|
||||
message.Request.Method = "POST";
|
||||
message.Request.Uri = new Uri("https://example.test/anything");
|
||||
await pipeline.SendAsync(message);
|
||||
|
||||
// Assert: both segments survive to the wire.
|
||||
Assert.NotNull(handler.LastUserAgent);
|
||||
Assert.Contains("existing-app/1.0", handler.LastUserAgent);
|
||||
Assert.Contains("agent-framework-dotnet/", handler.LastUserAgent);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task AgentFrameworkUserAgentPolicy_IsIdempotent_DoesNotDoubleStampAsync()
|
||||
{
|
||||
// Arrange: register the same policy twice on the same pipeline. The second application
|
||||
// must detect the segment is already present and not append it again. Guards against
|
||||
// double-stamping on retries or duplicate registration.
|
||||
using var handler = new RecordingHandler();
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var pipeline = ClientPipeline.Create(
|
||||
new ClientPipelineOptions { Transport = new HttpClientPipelineTransport(httpClient) },
|
||||
perCallPolicies: [AgentFrameworkUserAgentPolicy.Instance, AgentFrameworkUserAgentPolicy.Instance],
|
||||
perTryPolicies: default,
|
||||
beforeTransportPolicies: default);
|
||||
|
||||
// Act
|
||||
var message = pipeline.CreateMessage();
|
||||
message.Request.Method = "POST";
|
||||
message.Request.Uri = new Uri("https://example.test/anything");
|
||||
await pipeline.SendAsync(message);
|
||||
|
||||
// Assert: exactly one occurrence of "agent-framework-dotnet/".
|
||||
Assert.NotNull(handler.LastUserAgent);
|
||||
var ua = handler.LastUserAgent!;
|
||||
var first = ua.IndexOf("agent-framework-dotnet/", StringComparison.Ordinal);
|
||||
Assert.True(first >= 0, "Expected at least one agent-framework-dotnet segment.");
|
||||
var second = ua.IndexOf("agent-framework-dotnet/", first + 1, StringComparison.Ordinal);
|
||||
Assert.Equal(-1, second);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AgentFrameworkUserAgentPolicy_ExposesSingletonInstance()
|
||||
{
|
||||
// Two reads of the static property must return the same instance. The policy is stateless
|
||||
// and shared; allocating a fresh instance per registration site would bloat memory and
|
||||
// defeat the dedup logic in OpenAIRequestPoliciesReflection.AddPolicyIfMissing.
|
||||
var first = AgentFrameworkUserAgentPolicy.Instance;
|
||||
var second = AgentFrameworkUserAgentPolicy.Instance;
|
||||
Assert.Same(first, second);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AgentFrameworkUserAgentPolicy_ValueIncludesAFFoundryAssemblyVersion_ReflectionGuard()
|
||||
{
|
||||
// The policy emits "agent-framework-dotnet/{Microsoft.Agents.AI.Foundry assembly InformationalVersion}".
|
||||
// If the assembly metadata stops being readable, the policy falls back to "agent-framework-dotnet"
|
||||
// without a version, which is a measurable telemetry regression.
|
||||
var attr = typeof(AgentFrameworkUserAgentPolicy).Assembly
|
||||
.GetCustomAttribute<AssemblyInformationalVersionAttribute>();
|
||||
Assert.NotNull(attr);
|
||||
Assert.False(string.IsNullOrEmpty(attr!.InformationalVersion));
|
||||
}
|
||||
|
||||
private sealed class RecordingHandler : HttpClientHandler
|
||||
{
|
||||
public int Count { get; private set; }
|
||||
public string? LastUserAgent { get; private set; }
|
||||
|
||||
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
|
||||
{
|
||||
this.Count++;
|
||||
this.LastUserAgent = request.Headers.TryGetValues("User-Agent", out var values)
|
||||
? string.Join(",", values)
|
||||
: null;
|
||||
|
||||
var resp = new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent("{}", Encoding.UTF8, "application/json"),
|
||||
RequestMessage = request,
|
||||
};
|
||||
return Task.FromResult(resp);
|
||||
}
|
||||
}
|
||||
|
||||
private sealed class SeedUserAgentPolicy : PipelinePolicy
|
||||
{
|
||||
private readonly string _value;
|
||||
public SeedUserAgentPolicy(string value) => this._value = value;
|
||||
|
||||
public override void Process(PipelineMessage message, IReadOnlyList<PipelinePolicy> pipeline, int currentIndex)
|
||||
{
|
||||
message.Request.Headers.Set("User-Agent", this._value);
|
||||
ProcessNext(message, pipeline, currentIndex);
|
||||
}
|
||||
|
||||
public override ValueTask ProcessAsync(PipelineMessage message, IReadOnlyList<PipelinePolicy> pipeline, int currentIndex)
|
||||
{
|
||||
message.Request.Headers.Set("User-Agent", this._value);
|
||||
return ProcessNextAsync(message, pipeline, currentIndex);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,209 +0,0 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
using System;
|
||||
using System.ClientModel.Primitives;
|
||||
using System.Net;
|
||||
using System.Net.Http;
|
||||
using System.Text;
|
||||
using System.Threading.Tasks;
|
||||
using Azure.AI.Extensions.OpenAI;
|
||||
using Azure.AI.Projects;
|
||||
|
||||
namespace Microsoft.Agents.AI.Foundry.UnitTests;
|
||||
|
||||
#pragma warning disable CS0618
|
||||
public class AzureAIProjectChatClientTests
|
||||
{
|
||||
/// <summary>
|
||||
/// Verify that after the first RunAsync, the session's ConversationId is set from the
|
||||
/// response, and subsequent requests include that conversation ID automatically.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task ChatClient_UsesDefaultConversationIdAsync()
|
||||
{
|
||||
// Arrange
|
||||
var responsesRequestCount = 0;
|
||||
using var httpHandler = new HttpHandlerAssert(async (request) =>
|
||||
{
|
||||
if (request.Method == HttpMethod.Post && request.RequestUri!.PathAndQuery.Contains("/responses"))
|
||||
{
|
||||
responsesRequestCount++;
|
||||
|
||||
// Assert: On the second Responses API call, verify the conversation ID
|
||||
// from the first response is automatically included in the request body.
|
||||
if (responsesRequestCount == 2 && request.Content is not null)
|
||||
{
|
||||
var requestBody = await request.Content.ReadAsStringAsync().ConfigureAwait(false);
|
||||
Assert.Contains("resp_0888a", requestBody);
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetOpenAIDefaultResponseJson(), Encoding.UTF8, "application/json") };
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetAgentResponseJson(), Encoding.UTF8, "application/json") };
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(httpHandler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
AIProjectClient projectClient = new(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions() { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
var agent = projectClient.AsAIAgent(new AgentReference("agent-name"));
|
||||
|
||||
// Act
|
||||
var session = await agent.CreateSessionAsync();
|
||||
await agent.RunAsync("Hello", session);
|
||||
await agent.RunAsync("Follow up", session);
|
||||
|
||||
// Assert
|
||||
Assert.Equal(2, responsesRequestCount);
|
||||
var chatClientSession = Assert.IsType<ChatClientAgentSession>(session);
|
||||
Assert.Equal("resp_0888a46cbf2b1ff3006914596e05d08195a77c3f5187b769a7", chatClientSession.ConversationId);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Verify that when the chat client doesn't have a default "conv_" conversation id, the chat client still uses the conversation ID in HTTP requests.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task ChatClient_UsesPerRequestConversationId_WhenNoDefaultConversationIdIsProvidedAsync()
|
||||
{
|
||||
// Arrange
|
||||
var requestTriggered = false;
|
||||
using var httpHandler = new HttpHandlerAssert(async (request) =>
|
||||
{
|
||||
if (request.Method == HttpMethod.Post && request.RequestUri!.PathAndQuery.Contains("/responses"))
|
||||
{
|
||||
requestTriggered = true;
|
||||
|
||||
// Assert
|
||||
if (request.Content is not null)
|
||||
{
|
||||
var requestBody = await request.Content.ReadAsStringAsync().ConfigureAwait(false);
|
||||
Assert.Contains("conv_12345", requestBody);
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetOpenAIDefaultResponseJson(), Encoding.UTF8, "application/json") };
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetAgentResponseJson(), Encoding.UTF8, "application/json") };
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(httpHandler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
AIProjectClient projectClient = new(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions() { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
var agent = projectClient.AsAIAgent(new AgentReference("agent-name"));
|
||||
|
||||
// Act
|
||||
var session = await agent.CreateSessionAsync();
|
||||
await agent.RunAsync("Hello", session, options: new ChatClientAgentRunOptions() { ChatOptions = new() { ConversationId = "conv_12345" } });
|
||||
|
||||
Assert.True(requestTriggered);
|
||||
var chatClientSession = Assert.IsType<ChatClientAgentSession>(session);
|
||||
Assert.Equal("conv_12345", chatClientSession.ConversationId);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Verify that even when the chat client has a default conversation id, the chat client will prioritize the per-request conversation id provided in HTTP requests.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task ChatClient_UsesPerRequestConversationId_EvenWhenDefaultConversationIdIsProvidedAsync()
|
||||
{
|
||||
// Arrange
|
||||
var requestTriggered = false;
|
||||
using var httpHandler = new HttpHandlerAssert(async (request) =>
|
||||
{
|
||||
if (request.Method == HttpMethod.Post && request.RequestUri!.PathAndQuery.Contains("/responses"))
|
||||
{
|
||||
requestTriggered = true;
|
||||
|
||||
// Assert
|
||||
if (request.Content is not null)
|
||||
{
|
||||
var requestBody = await request.Content.ReadAsStringAsync().ConfigureAwait(false);
|
||||
Assert.Contains("conv_12345", requestBody);
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetOpenAIDefaultResponseJson(), Encoding.UTF8, "application/json") };
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetAgentResponseJson(), Encoding.UTF8, "application/json") };
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(httpHandler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
AIProjectClient projectClient = new(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions() { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
var agent = projectClient.AsAIAgent(new AgentReference("agent-name"));
|
||||
|
||||
// Act
|
||||
var session = await agent.CreateSessionAsync();
|
||||
await agent.RunAsync("Hello", session, options: new ChatClientAgentRunOptions() { ChatOptions = new() { ConversationId = "conv_12345" } });
|
||||
|
||||
Assert.True(requestTriggered);
|
||||
var chatClientSession = Assert.IsType<ChatClientAgentSession>(session);
|
||||
Assert.Equal("conv_12345", chatClientSession.ConversationId);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Verify that when the chat client is provided without a "conv_" prefixed conversation ID, the chat client uses the previous conversation ID in HTTP requests.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task ChatClient_UsesPreviousResponseId_WhenConversationIsNotPrefixedAsConvAsync()
|
||||
{
|
||||
// Arrange
|
||||
var requestTriggered = false;
|
||||
using var httpHandler = new HttpHandlerAssert(async (request) =>
|
||||
{
|
||||
if (request.Method == HttpMethod.Post && request.RequestUri!.PathAndQuery.Contains("/responses"))
|
||||
{
|
||||
requestTriggered = true;
|
||||
|
||||
// Assert
|
||||
if (request.Content is not null)
|
||||
{
|
||||
var requestBody = await request.Content.ReadAsStringAsync().ConfigureAwait(false);
|
||||
Assert.Contains("resp_0888a", requestBody);
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetOpenAIDefaultResponseJson(), Encoding.UTF8, "application/json") };
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetAgentResponseJson(), Encoding.UTF8, "application/json") };
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(httpHandler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
AIProjectClient projectClient = new(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions() { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
var agent = projectClient.AsAIAgent(new AgentReference("agent-name"));
|
||||
|
||||
// Act
|
||||
var session = await agent.CreateSessionAsync();
|
||||
await agent.RunAsync("Hello", session, options: new ChatClientAgentRunOptions() { ChatOptions = new() { ConversationId = "resp_0888a" } });
|
||||
|
||||
Assert.True(requestTriggered);
|
||||
var chatClientSession = Assert.IsType<ChatClientAgentSession>(session);
|
||||
Assert.Equal("resp_0888a46cbf2b1ff3006914596e05d08195a77c3f5187b769a7", chatClientSession.ConversationId);
|
||||
}
|
||||
}
|
||||
#pragma warning restore CS0618
|
||||
@@ -0,0 +1,200 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
using System;
|
||||
using System.ClientModel.Primitives;
|
||||
using System.Net;
|
||||
using System.Net.Http;
|
||||
using System.Text;
|
||||
using System.Threading.Tasks;
|
||||
using Azure.AI.Projects;
|
||||
using OpenAI.Files;
|
||||
|
||||
#pragma warning disable OPENAI001, CS0618
|
||||
|
||||
namespace Microsoft.Agents.AI.Foundry.UnitTests;
|
||||
|
||||
/// <summary>
|
||||
/// Unit tests for the file and vector-store forwarder extensions on <see cref="FoundryAgent"/>
|
||||
/// declared in <see cref="FoundryAgentExtensions"/>. The forwarders are thin shims over the
|
||||
/// inner <see cref="FoundryChatClient"/>, so coverage focuses on (a) request shape (the agent
|
||||
/// path reaches the same wire as a direct chat-client call), (b) null/missing-FoundryChatClient
|
||||
/// handling, and (c) returns the same payload the chat client would.
|
||||
/// </summary>
|
||||
public sealed class FoundryAgentExtensionsTests
|
||||
{
|
||||
private static readonly Uri s_testProjectEndpoint = new("https://test.openai.azure.com/");
|
||||
|
||||
[Fact]
|
||||
public async Task UploadFileAsync_Forwards_ToInnerFoundryChatClient_Async()
|
||||
{
|
||||
// Arrange — agent built via the Responses Agent (Mode 1) projectEndpoint+model+instructions
|
||||
// ctor wires a FoundryChatClient inside that the extension can resolve via GetService.
|
||||
var sawPostToFiles = false;
|
||||
using var handler = new HttpHandlerAssert(req =>
|
||||
{
|
||||
if (req.Method == HttpMethod.Post && req.RequestUri!.AbsolutePath.Contains("/files", StringComparison.Ordinal))
|
||||
{
|
||||
sawPostToFiles = true;
|
||||
return new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent(FakeFileJson("file_via_agent"), Encoding.UTF8, "application/json"),
|
||||
};
|
||||
}
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent("{}", Encoding.UTF8, "application/json") };
|
||||
});
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
var agent = new FoundryAgent(
|
||||
projectEndpoint: s_testProjectEndpoint,
|
||||
credential: new FakeAuthenticationTokenProvider(),
|
||||
model: "gpt-4o-mini",
|
||||
instructions: "Be helpful.",
|
||||
clientOptions: new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
var path = System.IO.Path.Combine(System.IO.Path.GetTempPath(), $"fae-{Guid.NewGuid():N}.txt");
|
||||
System.IO.File.WriteAllText(path, "hello");
|
||||
|
||||
try
|
||||
{
|
||||
// Act — call the forwarder on the agent.
|
||||
var result = await agent.UploadFileAsync(path, FileUploadPurpose.Assistants);
|
||||
|
||||
// Assert
|
||||
Assert.True(sawPostToFiles, "POST to /files must reach the wire through the agent forwarder.");
|
||||
Assert.Equal("file_via_agent", result.Id);
|
||||
}
|
||||
finally
|
||||
{
|
||||
System.IO.File.Delete(path);
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task DeleteFileAsync_Forwards_ToInnerFoundryChatClient_Async()
|
||||
{
|
||||
var sawDelete = false;
|
||||
using var handler = new HttpHandlerAssert(req =>
|
||||
{
|
||||
if (req.Method == HttpMethod.Delete && req.RequestUri!.AbsolutePath.Contains("/files/", StringComparison.Ordinal))
|
||||
{
|
||||
sawDelete = true;
|
||||
return new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent("{\"id\":\"file_abc\",\"object\":\"file\",\"deleted\":true}", Encoding.UTF8, "application/json"),
|
||||
};
|
||||
}
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent("{}", Encoding.UTF8, "application/json") };
|
||||
});
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
var agent = new FoundryAgent(
|
||||
projectEndpoint: s_testProjectEndpoint,
|
||||
credential: new FakeAuthenticationTokenProvider(),
|
||||
model: "gpt-4o-mini",
|
||||
instructions: "Be helpful.",
|
||||
clientOptions: new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
var result = await agent.DeleteFileAsync("file_abc");
|
||||
|
||||
Assert.True(sawDelete);
|
||||
Assert.NotNull(result);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CreateVectorStoreAsync_Forwards_ToInnerFoundryChatClient_Async()
|
||||
{
|
||||
var sawVectorStorePost = false;
|
||||
using var handler = new HttpHandlerAssert(req =>
|
||||
{
|
||||
if (req.Method == HttpMethod.Post && req.RequestUri!.AbsolutePath.Contains("/vector_stores", StringComparison.Ordinal))
|
||||
{
|
||||
sawVectorStorePost = true;
|
||||
return new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent(FakeVectorStoreJson("vs_via_agent", "kb"), Encoding.UTF8, "application/json"),
|
||||
};
|
||||
}
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent("{}", Encoding.UTF8, "application/json") };
|
||||
});
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
var agent = new FoundryAgent(
|
||||
projectEndpoint: s_testProjectEndpoint,
|
||||
credential: new FakeAuthenticationTokenProvider(),
|
||||
model: "gpt-4o-mini",
|
||||
instructions: "Be helpful.",
|
||||
clientOptions: new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
var store = await agent.CreateVectorStoreAsync("kb", Array.Empty<string>());
|
||||
|
||||
Assert.True(sawVectorStorePost);
|
||||
Assert.Equal("vs_via_agent", store.Id);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task DeleteVectorStoreAsync_Forwards_ToInnerFoundryChatClient_Async()
|
||||
{
|
||||
var sawDelete = false;
|
||||
using var handler = new HttpHandlerAssert(req =>
|
||||
{
|
||||
if (req.Method == HttpMethod.Delete && req.RequestUri!.AbsolutePath.Contains("/vector_stores/", StringComparison.Ordinal))
|
||||
{
|
||||
sawDelete = true;
|
||||
return new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent("{\"id\":\"vs_abc\",\"object\":\"vector_store.deleted\",\"deleted\":true}", Encoding.UTF8, "application/json"),
|
||||
};
|
||||
}
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent("{}", Encoding.UTF8, "application/json") };
|
||||
});
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
var agent = new FoundryAgent(
|
||||
projectEndpoint: s_testProjectEndpoint,
|
||||
credential: new FakeAuthenticationTokenProvider(),
|
||||
model: "gpt-4o-mini",
|
||||
instructions: "Be helpful.",
|
||||
clientOptions: new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
await agent.DeleteVectorStoreAsync("vs_abc");
|
||||
|
||||
Assert.True(sawDelete);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task UploadFileAsync_NullAgent_ThrowsArgumentNullExceptionAsync()
|
||||
=> await Assert.ThrowsAsync<ArgumentNullException>(() =>
|
||||
FoundryAgentExtensions.UploadFileAsync(null!, "x", FileUploadPurpose.Assistants));
|
||||
|
||||
[Fact]
|
||||
public async Task DeleteFileAsync_NullAgent_ThrowsArgumentNullExceptionAsync()
|
||||
=> await Assert.ThrowsAsync<ArgumentNullException>(() =>
|
||||
FoundryAgentExtensions.DeleteFileAsync(null!, "file_abc"));
|
||||
|
||||
[Fact]
|
||||
public async Task CreateVectorStoreAsync_NullAgent_ThrowsArgumentNullExceptionAsync()
|
||||
=> await Assert.ThrowsAsync<ArgumentNullException>(() =>
|
||||
FoundryAgentExtensions.CreateVectorStoreAsync(null!, "kb", Array.Empty<string>()));
|
||||
|
||||
[Fact]
|
||||
public async Task DeleteVectorStoreAsync_NullAgent_ThrowsArgumentNullExceptionAsync()
|
||||
=> await Assert.ThrowsAsync<ArgumentNullException>(() =>
|
||||
FoundryAgentExtensions.DeleteVectorStoreAsync(null!, "vs_abc"));
|
||||
|
||||
// ----- Helpers -----
|
||||
|
||||
private static string FakeFileJson(string id)
|
||||
=> $"{{\"id\":\"{id}\",\"object\":\"file\",\"bytes\":11,\"created_at\":1700000000,\"filename\":\"x.txt\",\"purpose\":\"assistants\",\"status\":\"processed\"}}";
|
||||
|
||||
private static string FakeVectorStoreJson(string id, string name)
|
||||
=> $"{{\"id\":\"{id}\",\"object\":\"vector_store\",\"created_at\":1700000000,\"name\":\"{name}\",\"usage_bytes\":0,\"file_counts\":{{\"in_progress\":0,\"completed\":0,\"failed\":0,\"cancelled\":0,\"total\":0}},\"status\":\"completed\",\"last_active_at\":1700000000}}";
|
||||
}
|
||||
#pragma warning restore CS0618
|
||||
@@ -2,7 +2,6 @@
|
||||
|
||||
using System;
|
||||
using System.ClientModel.Primitives;
|
||||
using System.Collections.Generic;
|
||||
using System.Net;
|
||||
using System.Net.Http;
|
||||
using System.Text;
|
||||
@@ -352,18 +351,24 @@ public class FoundryAgentTests
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Constructor_UserAgentHeaderAddedToRequestsAsync()
|
||||
public async Task Constructor_AgentFrameworkUserAgentHeaderAddedToRequestsAsync()
|
||||
{
|
||||
bool userAgentFound = false;
|
||||
// After the FoundryChatClient consolidation, every outbound request from a
|
||||
// FoundryAgent-built chat client carries the new agent-framework-dotnet/{version}
|
||||
// segment (stamped by AgentFrameworkUserAgentPolicy registered via the MEAI
|
||||
// OpenAIRequestPolicies hook). The local MEAI/{version} stamp was removed because
|
||||
// MEAI 10.5.1 stamps that itself; this test only verifies the framework-wide segment
|
||||
// that the Foundry package now guarantees.
|
||||
bool agentFrameworkUserAgentFound = false;
|
||||
using HttpHandlerAssert httpHandler = new(request =>
|
||||
{
|
||||
if (request.Headers.TryGetValues("User-Agent", out IEnumerable<string>? values))
|
||||
if (request.Headers.TryGetValues("User-Agent", out System.Collections.Generic.IEnumerable<string>? values))
|
||||
{
|
||||
foreach (string value in values)
|
||||
{
|
||||
if (value.StartsWith("MEAI/", StringComparison.OrdinalIgnoreCase))
|
||||
if (value.Contains("agent-framework-dotnet/"))
|
||||
{
|
||||
userAgentFound = true;
|
||||
agentFrameworkUserAgentFound = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -396,7 +401,7 @@ public class FoundryAgentTests
|
||||
AgentSession session = await agent.CreateSessionAsync();
|
||||
await agent.RunAsync("Hello", session);
|
||||
|
||||
Assert.True(userAgentFound, "Expected MEAI user-agent header to be present in requests.");
|
||||
Assert.True(agentFrameworkUserAgentFound, "Expected agent-framework-dotnet user-agent segment to be present on outbound requests.");
|
||||
}
|
||||
|
||||
#endregion
|
||||
@@ -434,6 +439,9 @@ public class FoundryAgentTests
|
||||
[Fact]
|
||||
public void AgentEndpointConstructor_GetServiceProjectOpenAIClient_ReturnsNull()
|
||||
{
|
||||
// Behavior change: FoundryAgent no longer caches a ProjectOpenAIClient. Callers
|
||||
// retrieve it from the AIProjectClient themselves
|
||||
// (agent.GetService<AIProjectClient>()!.GetProjectOpenAIClient()).
|
||||
FoundryAgent agent = new(s_testAgentEndpoint, new FakeAuthenticationTokenProvider());
|
||||
|
||||
Assert.Null(agent.GetService<ProjectOpenAIClient>());
|
||||
@@ -442,6 +450,10 @@ public class FoundryAgentTests
|
||||
[Fact]
|
||||
public void AgentEndpointConstructor_GetServiceAIProjectClient_ReturnsNonNull()
|
||||
{
|
||||
// Behavior change: after Plan #2's Agent Endpoint mode (Mode 3) AIProjectClient materialization, the
|
||||
// agent-endpoint constructor now derives a project-level AIProjectClient from the
|
||||
// parsed project root URL and surfaces it via GetService. Previously this returned
|
||||
// null because no AIProjectClient was constructed for hosted-agent-endpoint agents.
|
||||
FoundryAgent agent = new(s_testAgentEndpoint, new FakeAuthenticationTokenProvider());
|
||||
|
||||
Assert.NotNull(agent.GetService<AIProjectClient>());
|
||||
@@ -450,6 +462,7 @@ public class FoundryAgentTests
|
||||
[Fact]
|
||||
public void ProjectEndpointConstructor_GetServiceProjectOpenAIClient_ReturnsNull()
|
||||
{
|
||||
// See AgentEndpointConstructor_GetServiceProjectOpenAIClient_ReturnsNull for rationale.
|
||||
FoundryAgent agent = new(
|
||||
s_testEndpoint,
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
@@ -611,6 +624,57 @@ public class FoundryAgentTests
|
||||
Assert.True(meaiSeen, "Expected MEAI/x.y.z to appear in the User-Agent header on the agent-endpoint pipeline.");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AgentEndpointConstructor_ExposesFoundryProviderName_OnChatClientMetadata()
|
||||
{
|
||||
// Behavior change: after the FoundryChatClient consolidation, the agent-endpoint path
|
||||
// now wraps with FoundryChatClient in the Agent Endpoint mode (Mode 3) and stamps the microsoft.foundry provider
|
||||
// name. Previously this path used a bare AsIChatClient() with no Foundry-specific
|
||||
// decorator, so the provider name defaulted to whatever MEAI surfaces. This guards the
|
||||
// new behavior.
|
||||
FoundryAgent agent = new(s_testAgentEndpoint, new FakeAuthenticationTokenProvider());
|
||||
|
||||
var metadata = agent.GetService<ChatClientMetadata>();
|
||||
Assert.NotNull(metadata);
|
||||
Assert.Equal("microsoft.foundry", metadata!.ProviderName);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task AgentEndpointConstructor_StampsAgentFrameworkUserAgentSegmentAsync()
|
||||
{
|
||||
// Behavior change: after the FoundryChatClient consolidation, every outbound request
|
||||
// from the agent-endpoint constructor carries the agent-framework-dotnet/{version}
|
||||
// segment via AgentFrameworkUserAgentPolicy. Previously this path had no
|
||||
// agent-framework branding at all.
|
||||
bool afSeen = false;
|
||||
using HttpHandlerAssert handler = new(req =>
|
||||
{
|
||||
if (req.Headers.TryGetValues("User-Agent", out var values))
|
||||
{
|
||||
foreach (string v in values)
|
||||
{
|
||||
if (v.Contains("agent-framework-dotnet/"))
|
||||
{
|
||||
afSeen = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
return new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent(TestDataUtil.GetOpenAIDefaultResponseJson(), Encoding.UTF8, "application/json"),
|
||||
};
|
||||
});
|
||||
#pragma warning disable CA5399
|
||||
using HttpClient http = new(handler);
|
||||
#pragma warning restore CA5399
|
||||
ProjectOpenAIClientOptions opts = new() { Transport = new HttpClientPipelineTransport(http) };
|
||||
|
||||
FoundryAgent agent = new(s_testAgentEndpoint, new FakeAuthenticationTokenProvider(), clientOptions: opts);
|
||||
await agent.RunAsync("Hello");
|
||||
|
||||
Assert.True(afSeen, "Expected agent-framework-dotnet/{version} segment on the agent-endpoint outbound User-Agent.");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task AgentEndpointConstructor_PassesThroughCallerPolicyOnPerAgentPipelineAsync()
|
||||
{
|
||||
@@ -666,82 +730,22 @@ public class FoundryAgentTests
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AgentEndpointConstructor_PreservesUserAgentApplicationId()
|
||||
public void AgentEndpointConstructor_PropagatesUserAgentApplicationId_ToProjectLevelClient()
|
||||
{
|
||||
// The MEAI policy adds its own User-Agent header so we cannot reliably observe the OpenAI SDK's
|
||||
// application-id stamp in the outbound request. Verify the value is propagated onto the
|
||||
// caller's options bag and that the materialized AIProjectClient is reachable so
|
||||
// downstream conversation/file/vector-store operations can pick the application id up.
|
||||
ProjectOpenAIClientOptions opts = new() { UserAgentApplicationId = "my-app-id" };
|
||||
|
||||
FoundryAgent agent = new(s_testAgentEndpoint, new FakeAuthenticationTokenProvider(), clientOptions: opts);
|
||||
|
||||
AIProjectClient? aiProjectClient = agent.GetService<AIProjectClient>();
|
||||
Assert.NotNull(aiProjectClient);
|
||||
// Caller's UserAgentApplicationId is preserved on the per-agent options bag verbatim.
|
||||
Assert.NotNull(agent);
|
||||
Assert.Equal("my-app-id", opts.UserAgentApplicationId);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void CreateProjectClientOptions_NullCallerOptions_ReturnsNull()
|
||||
{
|
||||
Assert.Null(FoundryAgent.CreateProjectClientOptions(null));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void CreateProjectClientOptions_CarriesPipelineSettingsAndUserAgent()
|
||||
{
|
||||
// Arrange
|
||||
var transport = new FakePipelineTransport();
|
||||
var retryPolicy = new FakeRetryPolicy();
|
||||
var messageLoggingPolicy = new FakeMessageLoggingPolicy();
|
||||
var clientLoggingOptions = new ClientLoggingOptions { EnableLogging = false };
|
||||
var networkTimeout = TimeSpan.FromSeconds(42);
|
||||
|
||||
ProjectOpenAIClientOptions callerOptions = new()
|
||||
{
|
||||
UserAgentApplicationId = "my-app-id",
|
||||
Transport = transport,
|
||||
RetryPolicy = retryPolicy,
|
||||
MessageLoggingPolicy = messageLoggingPolicy,
|
||||
ClientLoggingOptions = clientLoggingOptions,
|
||||
NetworkTimeout = networkTimeout,
|
||||
};
|
||||
|
||||
// Act
|
||||
AIProjectClientOptions? projectOptions = FoundryAgent.CreateProjectClientOptions(callerOptions);
|
||||
|
||||
// Assert: every settable pipeline behavior the caller configured is forwarded
|
||||
// onto the project-level options bag, not silently dropped.
|
||||
Assert.NotNull(projectOptions);
|
||||
Assert.Equal("my-app-id", projectOptions!.UserAgentApplicationId);
|
||||
Assert.Same(transport, projectOptions.Transport);
|
||||
Assert.Same(retryPolicy, projectOptions.RetryPolicy);
|
||||
Assert.Same(messageLoggingPolicy, projectOptions.MessageLoggingPolicy);
|
||||
Assert.Same(clientLoggingOptions, projectOptions.ClientLoggingOptions);
|
||||
Assert.Equal(networkTimeout, projectOptions.NetworkTimeout);
|
||||
}
|
||||
|
||||
private sealed class FakeRetryPolicy : PipelinePolicy
|
||||
{
|
||||
public override void Process(PipelineMessage message, IReadOnlyList<PipelinePolicy> pipeline, int currentIndex)
|
||||
=> ProcessNext(message, pipeline, currentIndex);
|
||||
|
||||
public override ValueTask ProcessAsync(PipelineMessage message, IReadOnlyList<PipelinePolicy> pipeline, int currentIndex)
|
||||
=> ProcessNextAsync(message, pipeline, currentIndex);
|
||||
}
|
||||
|
||||
private sealed class FakeMessageLoggingPolicy : PipelinePolicy
|
||||
{
|
||||
public override void Process(PipelineMessage message, IReadOnlyList<PipelinePolicy> pipeline, int currentIndex)
|
||||
=> ProcessNext(message, pipeline, currentIndex);
|
||||
|
||||
public override ValueTask ProcessAsync(PipelineMessage message, IReadOnlyList<PipelinePolicy> pipeline, int currentIndex)
|
||||
=> ProcessNextAsync(message, pipeline, currentIndex);
|
||||
}
|
||||
|
||||
private sealed class FakePipelineTransport : PipelineTransport
|
||||
{
|
||||
protected override PipelineMessage CreateMessageCore() => throw new NotSupportedException();
|
||||
protected override void ProcessCore(PipelineMessage message) => throw new NotSupportedException();
|
||||
protected override ValueTask ProcessCoreAsync(PipelineMessage message) => throw new NotSupportedException();
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region ParseAgentEndpoint tests
|
||||
@@ -824,13 +828,13 @@ public class FoundryAgentTests
|
||||
private readonly string _value;
|
||||
public HeaderStampPolicy(string name, string value) { this._name = name; this._value = value; }
|
||||
|
||||
public override void Process(PipelineMessage message, IReadOnlyList<PipelinePolicy> pipeline, int currentIndex)
|
||||
public override void Process(PipelineMessage message, System.Collections.Generic.IReadOnlyList<PipelinePolicy> pipeline, int currentIndex)
|
||||
{
|
||||
message.Request.Headers.Set(this._name, this._value);
|
||||
ProcessNext(message, pipeline, currentIndex);
|
||||
}
|
||||
|
||||
public override ValueTask ProcessAsync(PipelineMessage message, IReadOnlyList<PipelinePolicy> pipeline, int currentIndex)
|
||||
public override ValueTask ProcessAsync(PipelineMessage message, System.Collections.Generic.IReadOnlyList<PipelinePolicy> pipeline, int currentIndex)
|
||||
{
|
||||
message.Request.Headers.Set(this._name, this._value);
|
||||
return ProcessNextAsync(message, pipeline, currentIndex);
|
||||
|
||||
@@ -0,0 +1,616 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
using System;
|
||||
using System.ClientModel.Primitives;
|
||||
using System.Net;
|
||||
using System.Net.Http;
|
||||
using System.Reflection;
|
||||
using System.Text;
|
||||
using System.Threading.Tasks;
|
||||
using Azure.AI.Extensions.OpenAI;
|
||||
using Azure.AI.Projects;
|
||||
using Azure.AI.Projects.Agents;
|
||||
using Microsoft.Extensions.AI;
|
||||
|
||||
#pragma warning disable OPENAI001, CS0618
|
||||
|
||||
namespace Microsoft.Agents.AI.Foundry.UnitTests;
|
||||
|
||||
/// <summary>
|
||||
/// Unit tests for the internal <see cref="FoundryChatClient"/>. Covers the three construction
|
||||
/// modes (Responses Agent, Prompt Agent, Agent Endpoint), the GetService
|
||||
/// returns per mode, the metadata-tagging contract, the agent-framework user-agent registration,
|
||||
/// the Agent Endpoint mode (Mode 3) URL parsing happy and error paths, and end-to-end behavior through the public
|
||||
/// <c>AsAIAgent(AgentReference)</c> extension that constructs a FoundryChatClient internally.
|
||||
/// </summary>
|
||||
public sealed class FoundryChatClientTests
|
||||
{
|
||||
#region the Responses Agent mode (Mode 1): Responses Agent (AIProjectClient + modelId)
|
||||
|
||||
[Fact]
|
||||
public void Mode1_ResponsesAgent_StampsFoundryProviderName()
|
||||
{
|
||||
// Arrange
|
||||
var projectClient = CreateProjectClient();
|
||||
|
||||
// Act
|
||||
var chatClient = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
|
||||
// Assert
|
||||
var metadata = chatClient.GetService<ChatClientMetadata>();
|
||||
Assert.NotNull(metadata);
|
||||
Assert.Equal("microsoft.foundry", metadata!.ProviderName);
|
||||
Assert.Equal("gpt-4o-mini", metadata.DefaultModelId);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode1_ResponsesAgent_ExposesAIProjectClient_ViaGetService()
|
||||
{
|
||||
// Arrange
|
||||
var projectClient = CreateProjectClient();
|
||||
|
||||
// Act
|
||||
var chatClient = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
|
||||
// Assert
|
||||
Assert.Same(projectClient, chatClient.GetService<AIProjectClient>());
|
||||
// ProjectOpenAIClient is intentionally NOT exposed via GetService — callers retrieve
|
||||
// it from the AIProjectClient themselves (aiProjectClient.GetProjectOpenAIClient()).
|
||||
Assert.Null(chatClient.GetService<ProjectOpenAIClient>());
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode1_ResponsesAgent_ReturnsNullForAgentSpecificServices()
|
||||
{
|
||||
// Arrange
|
||||
var projectClient = CreateProjectClient();
|
||||
|
||||
// Act
|
||||
var chatClient = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
|
||||
// Assert
|
||||
Assert.Null(chatClient.GetService<AgentReference>());
|
||||
Assert.Null(chatClient.GetService<ProjectsAgentVersion>());
|
||||
Assert.Null(chatClient.GetService<ProjectsAgentRecord>());
|
||||
// No agent name exists in the Responses Agent mode (Mode 1) — only the Prompt Agent mode (Mode 2) (from AgentReference.Name) and the Agent Endpoint mode (Mode 3)
|
||||
// (parsed from URL) populate FoundryChatClient.AgentName.
|
||||
Assert.Null(chatClient.AgentName);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode1_ResponsesAgent_ThrowsOnNullProjectClient()
|
||||
=> Assert.Throws<ArgumentNullException>(() => new FoundryChatClient(aiProjectClient: null!, "gpt-4o-mini"));
|
||||
|
||||
[Fact]
|
||||
public void Mode1_ResponsesAgent_ThrowsOnEmptyModelId()
|
||||
=> Assert.Throws<ArgumentException>(() => new FoundryChatClient(CreateProjectClient(), modelId: ""));
|
||||
|
||||
#endregion
|
||||
|
||||
#region the Prompt Agent mode (Mode 2): Prompt Agent (direct unit tests)
|
||||
|
||||
[Fact]
|
||||
public void Mode2_PromptAgent_StampsFoundryProviderNameAndDefaultModelId()
|
||||
{
|
||||
// Arrange
|
||||
var projectClient = CreateProjectClient();
|
||||
var agentRef = new AgentReference("agent-name", "1");
|
||||
|
||||
// Act
|
||||
var chatClient = new FoundryChatClient(projectClient, agentRef, defaultModelId: "gpt-4o", baseChatOptions: null);
|
||||
|
||||
// Assert
|
||||
var metadata = chatClient.GetService<ChatClientMetadata>();
|
||||
Assert.NotNull(metadata);
|
||||
Assert.Equal("microsoft.foundry", metadata!.ProviderName);
|
||||
Assert.Equal("gpt-4o", metadata.DefaultModelId);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode2_PromptAgent_ExposesAgentReference_ViaGetService()
|
||||
{
|
||||
// Arrange
|
||||
var projectClient = CreateProjectClient();
|
||||
var agentRef = new AgentReference("agent-name", "1");
|
||||
|
||||
// Act
|
||||
var chatClient = new FoundryChatClient(projectClient, agentRef, defaultModelId: null, baseChatOptions: null);
|
||||
|
||||
// Assert
|
||||
Assert.Same(agentRef, chatClient.GetService<AgentReference>());
|
||||
Assert.Same(projectClient, chatClient.GetService<AIProjectClient>());
|
||||
// ProjectOpenAIClient is intentionally NOT exposed via GetService — see comment in
|
||||
// Mode1_ResponsesAgent_ExposesAIProjectClient_ViaGetService.
|
||||
Assert.Null(chatClient.GetService<ProjectOpenAIClient>());
|
||||
// Version/Record were not provided via this ctor.
|
||||
Assert.Null(chatClient.GetService<ProjectsAgentVersion>());
|
||||
Assert.Null(chatClient.GetService<ProjectsAgentRecord>());
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode2_PromptAgent_PopulatesAgentNameFromAgentReference()
|
||||
{
|
||||
// Arrange
|
||||
var projectClient = CreateProjectClient();
|
||||
var agentRef = new AgentReference("my-server-side-agent", "1");
|
||||
|
||||
// Act
|
||||
var chatClient = new FoundryChatClient(projectClient, agentRef, defaultModelId: null, baseChatOptions: null);
|
||||
|
||||
// Assert: AgentName is general-purpose across the Prompt Agent (Mode 2) and Agent Endpoint (Mode 3) modes. In the Prompt Agent mode (Mode 2) it mirrors
|
||||
// AgentReference.Name so callers have a uniform handle regardless of construction mode.
|
||||
Assert.Equal("my-server-side-agent", chatClient.AgentName);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode2_PromptAgent_AllowsNullDefaultModelIdAndBaseChatOptions()
|
||||
{
|
||||
// Arrange
|
||||
var projectClient = CreateProjectClient();
|
||||
var agentRef = new AgentReference("agent-name", "1");
|
||||
|
||||
// Act + Assert: must not throw; defaultModelId and baseChatOptions are optional.
|
||||
var chatClient = new FoundryChatClient(projectClient, agentRef, defaultModelId: null, baseChatOptions: null);
|
||||
Assert.NotNull(chatClient);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode2_PromptAgent_ThrowsOnNullAgentReference()
|
||||
=> Assert.Throws<ArgumentNullException>(() =>
|
||||
new FoundryChatClient(CreateProjectClient(), agentReference: null!, defaultModelId: null, baseChatOptions: null));
|
||||
|
||||
#endregion
|
||||
|
||||
#region the Prompt Agent mode (Mode 2): Prompt Agent end-to-end round-trip via AsAIAgent(AgentReference) extension
|
||||
|
||||
// The end-to-end tests below exercise the same FoundryChatClient mode-2 behaviors above,
|
||||
// but through the public AsAIAgent(AgentReference) extension that constructs a FoundryChatClient
|
||||
// internally. They focus on the conversation-id handling that only manifests through the
|
||||
// ChatClientAgentSession surface, which requires a fully assembled agent rather than a bare
|
||||
// chat client.
|
||||
|
||||
/// <summary>
|
||||
/// Verify that after the first RunAsync, the session's ConversationId is set from the
|
||||
/// response, and subsequent requests include that conversation ID automatically.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task EndToEnd_AgentReference_UsesDefaultConversationIdAsync()
|
||||
{
|
||||
// Arrange
|
||||
var responsesRequestCount = 0;
|
||||
using var httpHandler = new HttpHandlerAssert(async (request) =>
|
||||
{
|
||||
if (request.Method == HttpMethod.Post && request.RequestUri!.PathAndQuery.Contains("/responses"))
|
||||
{
|
||||
responsesRequestCount++;
|
||||
|
||||
// Assert: On the second Responses API call, verify the conversation ID
|
||||
// from the first response is automatically included in the request body.
|
||||
if (responsesRequestCount == 2 && request.Content is not null)
|
||||
{
|
||||
var requestBody = await request.Content.ReadAsStringAsync().ConfigureAwait(false);
|
||||
Assert.Contains("resp_0888a", requestBody);
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetOpenAIDefaultResponseJson(), Encoding.UTF8, "application/json") };
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetAgentResponseJson(), Encoding.UTF8, "application/json") };
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(httpHandler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
AIProjectClient projectClient = new(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions() { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
var agent = projectClient.AsAIAgent(new AgentReference("agent-name"));
|
||||
|
||||
// Act
|
||||
var session = await agent.CreateSessionAsync();
|
||||
await agent.RunAsync("Hello", session);
|
||||
await agent.RunAsync("Follow up", session);
|
||||
|
||||
// Assert
|
||||
Assert.Equal(2, responsesRequestCount);
|
||||
var chatClientSession = Assert.IsType<ChatClientAgentSession>(session);
|
||||
Assert.Equal("resp_0888a46cbf2b1ff3006914596e05d08195a77c3f5187b769a7", chatClientSession.ConversationId);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Verify that when the chat client doesn't have a default "conv_" conversation id, the chat client still uses the conversation ID in HTTP requests.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task EndToEnd_AgentReference_UsesPerRequestConversationId_WhenNoDefaultConversationIdIsProvidedAsync()
|
||||
{
|
||||
// Arrange
|
||||
var requestTriggered = false;
|
||||
using var httpHandler = new HttpHandlerAssert(async (request) =>
|
||||
{
|
||||
if (request.Method == HttpMethod.Post && request.RequestUri!.PathAndQuery.Contains("/responses"))
|
||||
{
|
||||
requestTriggered = true;
|
||||
|
||||
// Assert
|
||||
if (request.Content is not null)
|
||||
{
|
||||
var requestBody = await request.Content.ReadAsStringAsync().ConfigureAwait(false);
|
||||
Assert.Contains("conv_12345", requestBody);
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetOpenAIDefaultResponseJson(), Encoding.UTF8, "application/json") };
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetAgentResponseJson(), Encoding.UTF8, "application/json") };
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(httpHandler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
AIProjectClient projectClient = new(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions() { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
var agent = projectClient.AsAIAgent(new AgentReference("agent-name"));
|
||||
|
||||
// Act
|
||||
var session = await agent.CreateSessionAsync();
|
||||
await agent.RunAsync("Hello", session, options: new ChatClientAgentRunOptions() { ChatOptions = new() { ConversationId = "conv_12345" } });
|
||||
|
||||
Assert.True(requestTriggered);
|
||||
var chatClientSession = Assert.IsType<ChatClientAgentSession>(session);
|
||||
Assert.Equal("conv_12345", chatClientSession.ConversationId);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Verify that even when the chat client has a default conversation id, the chat client will prioritize the per-request conversation id provided in HTTP requests.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task EndToEnd_AgentReference_UsesPerRequestConversationId_EvenWhenDefaultConversationIdIsProvidedAsync()
|
||||
{
|
||||
// Arrange
|
||||
var requestTriggered = false;
|
||||
using var httpHandler = new HttpHandlerAssert(async (request) =>
|
||||
{
|
||||
if (request.Method == HttpMethod.Post && request.RequestUri!.PathAndQuery.Contains("/responses"))
|
||||
{
|
||||
requestTriggered = true;
|
||||
|
||||
// Assert
|
||||
if (request.Content is not null)
|
||||
{
|
||||
var requestBody = await request.Content.ReadAsStringAsync().ConfigureAwait(false);
|
||||
Assert.Contains("conv_12345", requestBody);
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetOpenAIDefaultResponseJson(), Encoding.UTF8, "application/json") };
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetAgentResponseJson(), Encoding.UTF8, "application/json") };
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(httpHandler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
AIProjectClient projectClient = new(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions() { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
var agent = projectClient.AsAIAgent(new AgentReference("agent-name"));
|
||||
|
||||
// Act
|
||||
var session = await agent.CreateSessionAsync();
|
||||
await agent.RunAsync("Hello", session, options: new ChatClientAgentRunOptions() { ChatOptions = new() { ConversationId = "conv_12345" } });
|
||||
|
||||
Assert.True(requestTriggered);
|
||||
var chatClientSession = Assert.IsType<ChatClientAgentSession>(session);
|
||||
Assert.Equal("conv_12345", chatClientSession.ConversationId);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Verify that when the chat client is provided without a "conv_" prefixed conversation ID, the chat client uses the previous conversation ID in HTTP requests.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task EndToEnd_AgentReference_UsesPreviousResponseId_WhenConversationIsNotPrefixedAsConvAsync()
|
||||
{
|
||||
// Arrange
|
||||
var requestTriggered = false;
|
||||
using var httpHandler = new HttpHandlerAssert(async (request) =>
|
||||
{
|
||||
if (request.Method == HttpMethod.Post && request.RequestUri!.PathAndQuery.Contains("/responses"))
|
||||
{
|
||||
requestTriggered = true;
|
||||
|
||||
// Assert
|
||||
if (request.Content is not null)
|
||||
{
|
||||
var requestBody = await request.Content.ReadAsStringAsync().ConfigureAwait(false);
|
||||
Assert.Contains("resp_0888a", requestBody);
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetOpenAIDefaultResponseJson(), Encoding.UTF8, "application/json") };
|
||||
}
|
||||
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(TestDataUtil.GetAgentResponseJson(), Encoding.UTF8, "application/json") };
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(httpHandler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
AIProjectClient projectClient = new(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions() { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
var agent = projectClient.AsAIAgent(new AgentReference("agent-name"));
|
||||
|
||||
// Act
|
||||
var session = await agent.CreateSessionAsync();
|
||||
await agent.RunAsync("Hello", session, options: new ChatClientAgentRunOptions() { ChatOptions = new() { ConversationId = "resp_0888a" } });
|
||||
|
||||
Assert.True(requestTriggered);
|
||||
var chatClientSession = Assert.IsType<ChatClientAgentSession>(session);
|
||||
Assert.Equal("resp_0888a46cbf2b1ff3006914596e05d08195a77c3f5187b769a7", chatClientSession.ConversationId);
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region the Agent Endpoint mode (Mode 3): Agent Endpoint
|
||||
|
||||
[Fact]
|
||||
public void Mode3_AgentEndpoint_ParsesAgentNameFromUrl()
|
||||
{
|
||||
// Arrange + Act
|
||||
var chatClient = new FoundryChatClient(
|
||||
agentEndpoint: new Uri("https://example.com/api/projects/myproj/agents/myagent/endpoint/protocols/openai"),
|
||||
credential: new FakeAuthenticationTokenProvider(),
|
||||
clientOptions: null);
|
||||
|
||||
// Assert
|
||||
Assert.Equal("myagent", chatClient.AgentName);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode3_AgentEndpoint_StampsFoundryProviderName()
|
||||
{
|
||||
// Act
|
||||
var chatClient = new FoundryChatClient(
|
||||
agentEndpoint: new Uri("https://example.com/api/projects/myproj/agents/myagent/endpoint/protocols/openai"),
|
||||
credential: new FakeAuthenticationTokenProvider(),
|
||||
clientOptions: null);
|
||||
|
||||
// Assert
|
||||
var metadata = chatClient.GetService<ChatClientMetadata>();
|
||||
Assert.NotNull(metadata);
|
||||
Assert.Equal("microsoft.foundry", metadata!.ProviderName);
|
||||
// No model id is knowable from the URL alone.
|
||||
Assert.Null(metadata.DefaultModelId);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode3_AgentEndpoint_ExposesProjectOpenAIClientAndAIProjectClient()
|
||||
{
|
||||
// Act
|
||||
var chatClient = new FoundryChatClient(
|
||||
agentEndpoint: new Uri("https://example.com/api/projects/myproj/agents/myagent/endpoint/protocols/openai"),
|
||||
credential: new FakeAuthenticationTokenProvider(),
|
||||
clientOptions: null);
|
||||
|
||||
// Assert
|
||||
// ProjectOpenAIClient is intentionally NOT exposed via GetService — callers retrieve
|
||||
// it from the AIProjectClient themselves (aiProjectClient.GetProjectOpenAIClient()).
|
||||
Assert.Null(chatClient.GetService<ProjectOpenAIClient>());
|
||||
// After the materialization change, the Agent Endpoint mode (Mode 3) also exposes a working AIProjectClient
|
||||
// built from the parsed project root. This makes the helper surface symmetric across
|
||||
// all three construction modes.
|
||||
Assert.NotNull(chatClient.GetService<AIProjectClient>());
|
||||
Assert.Null(chatClient.GetService<AgentReference>());
|
||||
Assert.Null(chatClient.GetService<ProjectsAgentVersion>());
|
||||
Assert.Null(chatClient.GetService<ProjectsAgentRecord>());
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode3_AgentEndpoint_MaterializedAIProjectClient_TargetsParsedProjectRoot()
|
||||
{
|
||||
// The Agent Endpoint mode (Mode 3) ctor must derive the project root from the agent endpoint URL and
|
||||
// construct the AIProjectClient against that root, NOT the agent endpoint itself.
|
||||
var agentEndpoint = new Uri("https://example.com/api/projects/myproj/agents/myagent/endpoint/protocols/openai");
|
||||
var chatClient = new FoundryChatClient(
|
||||
agentEndpoint: agentEndpoint,
|
||||
credential: new FakeAuthenticationTokenProvider(),
|
||||
clientOptions: null);
|
||||
|
||||
var aiProjectClient = chatClient.GetService<AIProjectClient>();
|
||||
Assert.NotNull(aiProjectClient);
|
||||
// AIProjectClient does not expose its endpoint publicly, so we rely on reflection on
|
||||
// the well-known private field. If the SDK field shape changes this guard fails loudly.
|
||||
var field = typeof(AIProjectClient).GetField("_endpoint", BindingFlags.Instance | BindingFlags.NonPublic);
|
||||
Assert.NotNull(field);
|
||||
var actualEndpoint = (Uri)field!.GetValue(aiProjectClient!)!;
|
||||
Assert.Equal("https://example.com/api/projects/myproj", actualEndpoint.AbsoluteUri.TrimEnd('/'));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode3_AgentEndpoint_MaterializedAIProjectClient_IsReusedAcrossGetServiceCalls()
|
||||
{
|
||||
// Repeated GetService<AIProjectClient>() calls must return the same instance — the
|
||||
// materialized client is cached in the existing _aiProjectClient field, not built on
|
||||
// demand each call.
|
||||
var chatClient = new FoundryChatClient(
|
||||
agentEndpoint: new Uri("https://example.com/api/projects/myproj/agents/myagent/endpoint/protocols/openai"),
|
||||
credential: new FakeAuthenticationTokenProvider(),
|
||||
clientOptions: null);
|
||||
|
||||
var first = chatClient.GetService<AIProjectClient>();
|
||||
var second = chatClient.GetService<AIProjectClient>();
|
||||
Assert.NotNull(first);
|
||||
Assert.Same(first, second);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode1_ResponsesAgent_AIProjectClient_IsTheSuppliedInstance()
|
||||
{
|
||||
// Regression check: the Responses Agent mode (Mode 1) must continue to expose the AIProjectClient the caller
|
||||
// supplied via the constructor, NOT a freshly-materialized one.
|
||||
var supplied = CreateProjectClient();
|
||||
var chatClient = new FoundryChatClient(supplied, "gpt-4o-mini");
|
||||
Assert.Same(supplied, chatClient.GetService<AIProjectClient>());
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode2_PromptAgent_AIProjectClient_IsTheSuppliedInstance()
|
||||
{
|
||||
// Regression check: the Prompt Agent mode (Mode 2) must continue to expose the AIProjectClient the caller
|
||||
// supplied via the constructor.
|
||||
var supplied = CreateProjectClient();
|
||||
var agentRef = new AgentReference("agent-name", "1");
|
||||
var chatClient = new FoundryChatClient(supplied, agentRef, defaultModelId: null, baseChatOptions: null);
|
||||
Assert.Same(supplied, chatClient.GetService<AIProjectClient>());
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Mode3_AgentEndpoint_ThrowsOnNullEndpoint()
|
||||
=> Assert.Throws<ArgumentNullException>(() =>
|
||||
new FoundryChatClient(agentEndpoint: null!, credential: new FakeAuthenticationTokenProvider(), clientOptions: null));
|
||||
|
||||
[Fact]
|
||||
public void Mode3_AgentEndpoint_ThrowsOnNullCredential()
|
||||
=> Assert.Throws<ArgumentNullException>(() =>
|
||||
new FoundryChatClient(
|
||||
agentEndpoint: new Uri("https://example.com/api/projects/myproj/agents/myagent/endpoint/protocols/openai"),
|
||||
credential: null!,
|
||||
clientOptions: null));
|
||||
|
||||
#endregion
|
||||
|
||||
#region ParseAgentEndpoint URL parsing
|
||||
|
||||
[Fact]
|
||||
public void ParseAgentEndpoint_HappyPath_ReturnsAgentNameAndProjectRoot()
|
||||
{
|
||||
// Act
|
||||
var (agentName, projectRoot) = FoundryChatClient.ParseAgentEndpoint(
|
||||
new Uri("https://example.com/api/projects/myproj/agents/myagent/endpoint/protocols/openai"));
|
||||
|
||||
// Assert
|
||||
Assert.Equal("myagent", agentName);
|
||||
Assert.Equal("https://example.com/api/projects/myproj", projectRoot.AbsoluteUri.TrimEnd('/'));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ParseAgentEndpoint_TolerantOfTrailingSlash()
|
||||
{
|
||||
// Act
|
||||
var (agentName, _) = FoundryChatClient.ParseAgentEndpoint(
|
||||
new Uri("https://example.com/api/projects/myproj/agents/myagent/endpoint/protocols/openai/"));
|
||||
|
||||
// Assert
|
||||
Assert.Equal("myagent", agentName);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ParseAgentEndpoint_TolerantOfCaseDifferencesOnAgentsSegment()
|
||||
{
|
||||
// Act
|
||||
var (agentName, _) = FoundryChatClient.ParseAgentEndpoint(
|
||||
new Uri("https://example.com/api/projects/myproj/AGENTS/myagent/endpoint/protocols/openai"));
|
||||
|
||||
// Assert
|
||||
Assert.Equal("myagent", agentName);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ParseAgentEndpoint_StripsQueryAndFragment()
|
||||
{
|
||||
// Act
|
||||
var (_, projectRoot) = FoundryChatClient.ParseAgentEndpoint(
|
||||
new Uri("https://example.com/api/projects/myproj/agents/myagent/endpoint/protocols/openai?api-version=v1#frag"));
|
||||
|
||||
// Assert
|
||||
Assert.Equal(string.Empty, projectRoot.Query);
|
||||
Assert.Equal(string.Empty, projectRoot.Fragment);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ParseAgentEndpoint_ThrowsOnMissingAgentsSegment()
|
||||
=> Assert.Throws<ArgumentException>(() =>
|
||||
FoundryChatClient.ParseAgentEndpoint(new Uri("https://example.com/api/projects/myproj/anyseg/myagent/endpoint/protocols/openai")));
|
||||
|
||||
[Fact]
|
||||
public void ParseAgentEndpoint_ThrowsOnWrongSuffix()
|
||||
=> Assert.Throws<ArgumentException>(() =>
|
||||
FoundryChatClient.ParseAgentEndpoint(new Uri("https://example.com/api/projects/myproj/agents/myagent/wrong/suffix")));
|
||||
|
||||
[Fact]
|
||||
public void ParseAgentEndpoint_ThrowsOnNullUri()
|
||||
=> Assert.Throws<ArgumentNullException>(() => FoundryChatClient.ParseAgentEndpoint(null!));
|
||||
|
||||
#endregion
|
||||
|
||||
#region AgentFrameworkUserAgentPolicy registration + dedup
|
||||
|
||||
[Fact]
|
||||
public void Register_AgentFrameworkUserAgentPolicy_OnUnderlyingOpenAIRequestPolicies()
|
||||
{
|
||||
// Arrange + Act: constructing a FoundryChatClient should register the
|
||||
// AgentFrameworkUserAgentPolicy on the inner chat client's OpenAIRequestPolicies.
|
||||
var chatClient = new FoundryChatClient(CreateProjectClient(), "gpt-4o-mini");
|
||||
|
||||
// Assert: the inner chat client (MEAI's OpenAIResponsesChatClient) exposes
|
||||
// OpenAIRequestPolicies via GetService, and our policy is present in its entries.
|
||||
var policies = chatClient.GetService<OpenAIRequestPolicies>();
|
||||
Assert.NotNull(policies);
|
||||
Assert.Equal(1, EntriesCount(policies!));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Register_AgentFrameworkUserAgentPolicy_IsDedupedAcrossMultipleClients_OnSharedInner()
|
||||
{
|
||||
// Arrange: construct via the ProjectsAgentVersion mode-2 variant, which chains via
|
||||
// :this(...) into the AgentReference ctor. If the policy registration code were
|
||||
// inadvertently called twice along the chain, we would see 2 entries.
|
||||
var projectClient = CreateProjectClient();
|
||||
var agentVersion = ModelReaderWriter.Read<ProjectsAgentVersion>(
|
||||
BinaryData.FromString(TestDataUtil.GetAgentVersionResponseJson()))!;
|
||||
|
||||
// Act
|
||||
var chatClient = new FoundryChatClient(projectClient, agentVersion, baseChatOptions: null);
|
||||
|
||||
// Assert: even though the version variant funnels through the AgentReference ctor
|
||||
// via :this(...), the policy is registered exactly once on the inner pipeline.
|
||||
var policies = chatClient.GetService<OpenAIRequestPolicies>();
|
||||
Assert.NotNull(policies);
|
||||
Assert.Equal(1, EntriesCount(policies!));
|
||||
Assert.Same(agentVersion, chatClient.GetService<ProjectsAgentVersion>());
|
||||
Assert.NotNull(chatClient.GetService<AgentReference>());
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Helpers
|
||||
|
||||
private static AIProjectClient CreateProjectClient()
|
||||
=> new(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(new HttpClient()) });
|
||||
|
||||
private static int EntriesCount(OpenAIRequestPolicies policies)
|
||||
{
|
||||
var field = typeof(OpenAIRequestPolicies).GetField("_entries", BindingFlags.Instance | BindingFlags.NonPublic);
|
||||
Assert.NotNull(field);
|
||||
var arr = (Array)field!.GetValue(policies)!;
|
||||
return arr.Length;
|
||||
}
|
||||
|
||||
#endregion
|
||||
}
|
||||
#pragma warning restore CS0618
|
||||
+660
@@ -0,0 +1,660 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
using System;
|
||||
using System.ClientModel.Primitives;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Net;
|
||||
using System.Net.Http;
|
||||
using System.Text;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Azure.AI.Extensions.OpenAI;
|
||||
using Azure.AI.Projects;
|
||||
using OpenAI.Files;
|
||||
|
||||
#pragma warning disable OPENAI001, CS0618
|
||||
|
||||
namespace Microsoft.Agents.AI.Foundry.UnitTests;
|
||||
|
||||
/// <summary>
|
||||
/// Unit tests for the file and vector-store helper methods on <see cref="FoundryChatClient"/>.
|
||||
/// Covers all four methods across the three FoundryChatClient construction modes plus argument
|
||||
/// validation, cancellation, and request-body shape on the wire.
|
||||
/// </summary>
|
||||
public sealed class FoundryChatClientVectorStoreTests
|
||||
{
|
||||
// ----- Construction helpers shared by every test in this file -----
|
||||
|
||||
private static (FoundryChatClient ChatClient, RequestRecorder Recorder) CreateMode1(string modelId = "gpt-4o-mini", string? responseBody = null)
|
||||
{
|
||||
var recorder = new RequestRecorder(responseBody);
|
||||
#pragma warning disable CA5399
|
||||
var httpClient = new HttpClient(recorder);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
return (new FoundryChatClient(projectClient, modelId), recorder);
|
||||
}
|
||||
|
||||
private static (FoundryChatClient ChatClient, RequestRecorder Recorder) CreateMode2(string? responseBody = null)
|
||||
{
|
||||
var recorder = new RequestRecorder(responseBody);
|
||||
#pragma warning disable CA5399
|
||||
var httpClient = new HttpClient(recorder);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
var agentRef = new AgentReference("agent-name", "1");
|
||||
return (new FoundryChatClient(projectClient, agentRef, defaultModelId: "gpt-4o", baseChatOptions: null), recorder);
|
||||
}
|
||||
|
||||
private static string MakeTempFile(string contents = "hello world")
|
||||
{
|
||||
var path = Path.Combine(Path.GetTempPath(), $"fcc-test-{Guid.NewGuid():N}.txt");
|
||||
File.WriteAllText(path, contents);
|
||||
return path;
|
||||
}
|
||||
|
||||
// ----- UploadFileAsync -----
|
||||
|
||||
[Fact]
|
||||
public async Task UploadFileAsync_Mode1_UploadsViaProjectOpenAIClientAsync()
|
||||
{
|
||||
var (chatClient, recorder) = CreateMode1(responseBody: FakeFileJson("file_abc"));
|
||||
var path = MakeTempFile();
|
||||
try
|
||||
{
|
||||
var result = await chatClient.UploadFileAsync(path, FileUploadPurpose.Assistants);
|
||||
|
||||
Assert.Equal("file_abc", result.Id);
|
||||
Assert.NotEmpty(recorder.Requests);
|
||||
Assert.EndsWith("/files", recorder.Requests[0].PathAndQuery.TrimEnd('/').Split('?')[0]);
|
||||
}
|
||||
finally { File.Delete(path); }
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task UploadFileAsync_Mode2_UploadsViaProjectOpenAIClientAsync()
|
||||
{
|
||||
var (chatClient, recorder) = CreateMode2(responseBody: FakeFileJson("file_xyz"));
|
||||
var path = MakeTempFile();
|
||||
try
|
||||
{
|
||||
var result = await chatClient.UploadFileAsync(path, FileUploadPurpose.Assistants);
|
||||
Assert.Equal("file_xyz", result.Id);
|
||||
Assert.Contains(recorder.Requests, r => r.PathAndQuery.Contains("/files"));
|
||||
}
|
||||
finally { File.Delete(path); }
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task UploadFileAsync_Mode3_UploadsViaMaterializedProjectClientAsync()
|
||||
{
|
||||
// Q-E: Mode 3 (Agent Endpoint) now honors caller-supplied transports via
|
||||
// ProjectOpenAIClientOptions.Transport, so we can use a fake transport here instead of
|
||||
// depending on DNS/network availability against example.com.
|
||||
var sawUpload = false;
|
||||
using var handler = new HttpHandlerAssert(req =>
|
||||
{
|
||||
if (req.Method == HttpMethod.Post && req.RequestUri!.AbsolutePath.Contains("/files", StringComparison.Ordinal))
|
||||
{
|
||||
sawUpload = true;
|
||||
return MakeJsonResponse(FakeFileJson("file_mode3"));
|
||||
}
|
||||
return MakeJsonResponse("{}");
|
||||
});
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var chatClient = new FoundryChatClient(
|
||||
agentEndpoint: new Uri("https://example.com/api/projects/myproj/agents/myagent/endpoint/protocols/openai"),
|
||||
credential: new FakeAuthenticationTokenProvider(),
|
||||
clientOptions: new ProjectOpenAIClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
|
||||
var path = MakeTempFile();
|
||||
try
|
||||
{
|
||||
var result = await chatClient.UploadFileAsync(path, FileUploadPurpose.Assistants, CancellationToken.None);
|
||||
Assert.True(sawUpload);
|
||||
Assert.Equal("file_mode3", result.Id);
|
||||
}
|
||||
finally { File.Delete(path); }
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task UploadFileAsync_NullFilePath_ThrowsArgumentNullExceptionAsync()
|
||||
{
|
||||
var (chatClient, _) = CreateMode1();
|
||||
await Assert.ThrowsAsync<ArgumentNullException>(() =>
|
||||
chatClient.UploadFileAsync(null!, FileUploadPurpose.Assistants));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task UploadFileAsync_FileNotFound_ThrowsFileNotFoundExceptionAsync()
|
||||
{
|
||||
var (chatClient, _) = CreateMode1();
|
||||
var missing = Path.Combine(Path.GetTempPath(), $"does-not-exist-{Guid.NewGuid():N}.txt");
|
||||
await Assert.ThrowsAsync<FileNotFoundException>(() =>
|
||||
chatClient.UploadFileAsync(missing, FileUploadPurpose.Assistants));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task UploadFileAsync_HonorsCancellationAsync()
|
||||
{
|
||||
// Cancellation propagation through the OpenAI SDK pipeline surfaces different exception
|
||||
// types depending on the framework target (OperationCanceledException on net10.0,
|
||||
// ObjectDisposedException at the transport layer on net472). Asserting on the exact
|
||||
// exception class is brittle; assert only that the call throws when the token is
|
||||
// pre-cancelled.
|
||||
var (chatClient, _) = CreateMode1(responseBody: FakeFileJson("file_abc"));
|
||||
var path = MakeTempFile();
|
||||
try
|
||||
{
|
||||
using var cts = new CancellationTokenSource();
|
||||
cts.Cancel();
|
||||
await Assert.ThrowsAnyAsync<Exception>(() =>
|
||||
chatClient.UploadFileAsync(path, FileUploadPurpose.Assistants, cts.Token));
|
||||
}
|
||||
finally { File.Delete(path); }
|
||||
}
|
||||
|
||||
// ----- DeleteFileAsync -----
|
||||
|
||||
[Fact]
|
||||
public async Task DeleteFileAsync_Mode1_CallsDeleteOnFileClientAsync()
|
||||
{
|
||||
var (chatClient, recorder) = CreateMode1(responseBody: FakeFileDeletedJson("file_abc"));
|
||||
await chatClient.DeleteFileAsync("file_abc");
|
||||
Assert.Contains(recorder.Requests, r => r.Method == "DELETE" && r.PathAndQuery.Contains("/files/file_abc"));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task DeleteFileAsync_Mode2_CallsDeleteOnFileClientAsync()
|
||||
{
|
||||
var (chatClient, recorder) = CreateMode2(responseBody: FakeFileDeletedJson("file_xyz"));
|
||||
await chatClient.DeleteFileAsync("file_xyz");
|
||||
Assert.Contains(recorder.Requests, r => r.Method == "DELETE" && r.PathAndQuery.Contains("/files/file_xyz"));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task DeleteFileAsync_NullId_ThrowsArgumentExceptionAsync()
|
||||
{
|
||||
var (chatClient, _) = CreateMode1();
|
||||
await Assert.ThrowsAnyAsync<ArgumentException>(() => chatClient.DeleteFileAsync(null!));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task DeleteFileAsync_EmptyId_ThrowsArgumentExceptionAsync()
|
||||
{
|
||||
var (chatClient, _) = CreateMode1();
|
||||
await Assert.ThrowsAnyAsync<ArgumentException>(() => chatClient.DeleteFileAsync(""));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task DeleteFileAsync_HonorsCancellationAsync()
|
||||
{
|
||||
// Verify the cancellation token reaches the HTTP pipeline by having the handler
|
||||
// throw OperationCanceledException when the token is cancelled before the request.
|
||||
// This is more robust than asserting on the exact exception the SDK surfaces, which
|
||||
// depends on internal pipeline plumbing.
|
||||
var observedToken = CancellationToken.None;
|
||||
using var handler = new HttpHandlerAssert(async req =>
|
||||
{
|
||||
// We don't have direct access to the SDK's CancellationToken here; instead, sleep
|
||||
// briefly to give the caller's pre-cancellation a chance to be picked up by the
|
||||
// transport. If cancellation reached the pipeline, the await on this handler call
|
||||
// would surface OperationCanceledException; if not, the response is returned.
|
||||
await Task.Delay(50).ConfigureAwait(false);
|
||||
return new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent(FakeFileDeletedJson("file_abc"), Encoding.UTF8, "application/json"),
|
||||
};
|
||||
});
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
var chatClient = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
|
||||
using var cts = new CancellationTokenSource();
|
||||
cts.Cancel();
|
||||
// Any throw is acceptable evidence that cancellation was honored. The SDK's exact
|
||||
// exception surface for pre-cancelled tokens is an implementation detail of
|
||||
// System.ClientModel's pipeline and may differ between versions.
|
||||
await Assert.ThrowsAnyAsync<Exception>(() => chatClient.DeleteFileAsync("file_abc", cts.Token));
|
||||
}
|
||||
|
||||
// ----- CreateVectorStoreAsync -----
|
||||
|
||||
[Fact]
|
||||
public async Task CreateVectorStoreAsync_UploadsThenCreates_WithFileIds_ReturnsVectorStoreAsync()
|
||||
{
|
||||
// Each file POST returns a distinct file id; the recorder dispatches on URL to differentiate.
|
||||
var fileCount = 0;
|
||||
using var handler = new HttpHandlerAssert(async req =>
|
||||
{
|
||||
var body = req.Content is null ? "" : await req.Content.ReadAsStringAsync().ConfigureAwait(false);
|
||||
if (req.RequestUri!.AbsolutePath.Contains("/files") && req.Method == HttpMethod.Post)
|
||||
{
|
||||
fileCount++;
|
||||
return MakeJsonResponse(FakeFileJson($"file_{fileCount}"));
|
||||
}
|
||||
if (req.RequestUri.AbsolutePath.Contains("/vector_stores") && req.Method == HttpMethod.Post)
|
||||
{
|
||||
Assert.Contains("file_1", body);
|
||||
Assert.Contains("file_2", body);
|
||||
Assert.Contains("knowledge-base", body);
|
||||
return MakeJsonResponse(FakeVectorStoreJson("vs_abc", name: "knowledge-base"));
|
||||
}
|
||||
return MakeJsonResponse("{}");
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
var chatClient = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
|
||||
var pathA = MakeTempFile("alpha");
|
||||
var pathB = MakeTempFile("beta");
|
||||
try
|
||||
{
|
||||
var store = await chatClient.CreateVectorStoreAsync("knowledge-base", new[] { pathA, pathB });
|
||||
Assert.Equal("vs_abc", store.Id);
|
||||
Assert.Equal(2, fileCount);
|
||||
}
|
||||
finally { File.Delete(pathA); File.Delete(pathB); }
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CreateVectorStoreAsync_WithExpiresAfter_SerializesLastActiveAtAnchorAsync()
|
||||
{
|
||||
string? vectorStoreBody = null;
|
||||
using var handler = new HttpHandlerAssert(async req =>
|
||||
{
|
||||
if (req.RequestUri!.AbsolutePath.Contains("/vector_stores") && req.Method == HttpMethod.Post)
|
||||
{
|
||||
vectorStoreBody = req.Content is null ? "" : await req.Content.ReadAsStringAsync().ConfigureAwait(false);
|
||||
return MakeJsonResponse(FakeVectorStoreJson("vs_abc", name: "x"));
|
||||
}
|
||||
return MakeJsonResponse("{}");
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
var chatClient = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
|
||||
await chatClient.CreateVectorStoreAsync("x", Array.Empty<string>(), expiresAfter: TimeSpan.FromDays(7));
|
||||
|
||||
Assert.NotNull(vectorStoreBody);
|
||||
Assert.Contains("\"expires_after\"", vectorStoreBody);
|
||||
Assert.Contains("\"last_active_at\"", vectorStoreBody);
|
||||
Assert.Contains("\"days\":7", vectorStoreBody);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CreateVectorStoreAsync_WithNullExpiresAfter_OmitsExpirationPolicyAsync()
|
||||
{
|
||||
string? vectorStoreBody = null;
|
||||
using var handler = new HttpHandlerAssert(async req =>
|
||||
{
|
||||
if (req.RequestUri!.AbsolutePath.Contains("/vector_stores") && req.Method == HttpMethod.Post)
|
||||
{
|
||||
vectorStoreBody = req.Content is null ? "" : await req.Content.ReadAsStringAsync().ConfigureAwait(false);
|
||||
return MakeJsonResponse(FakeVectorStoreJson("vs_abc", name: "x"));
|
||||
}
|
||||
return MakeJsonResponse("{}");
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
var chatClient = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
|
||||
await chatClient.CreateVectorStoreAsync("x", Array.Empty<string>(), expiresAfter: null);
|
||||
|
||||
Assert.NotNull(vectorStoreBody);
|
||||
Assert.DoesNotContain("\"expires_after\"", vectorStoreBody);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CreateVectorStoreAsync_EmptyFilesList_CreatesEmptyStoreAsync()
|
||||
{
|
||||
var (chatClient, _) = CreateMode1(responseBody: FakeVectorStoreJson("vs_empty", name: "x"));
|
||||
var store = await chatClient.CreateVectorStoreAsync("x", Array.Empty<string>());
|
||||
Assert.Equal("vs_empty", store.Id);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CreateVectorStoreAsync_NullName_ThrowsArgumentExceptionAsync()
|
||||
{
|
||||
var (chatClient, _) = CreateMode1();
|
||||
await Assert.ThrowsAnyAsync<ArgumentException>(() =>
|
||||
chatClient.CreateVectorStoreAsync(null!, Array.Empty<string>()));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CreateVectorStoreAsync_NullFilePaths_ThrowsArgumentNullExceptionAsync()
|
||||
{
|
||||
var (chatClient, _) = CreateMode1();
|
||||
await Assert.ThrowsAsync<ArgumentNullException>(() =>
|
||||
chatClient.CreateVectorStoreAsync("x", filePaths: null!));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CreateVectorStoreAsync_HonorsCancellationAsync()
|
||||
{
|
||||
// Same rationale as UploadFileAsync_HonorsCancellationAsync — assert only that any
|
||||
// exception is thrown on a pre-cancelled token.
|
||||
var (chatClient, _) = CreateMode1(responseBody: FakeVectorStoreJson("vs_x", "x"));
|
||||
using var cts = new CancellationTokenSource();
|
||||
cts.Cancel();
|
||||
await Assert.ThrowsAnyAsync<Exception>(() =>
|
||||
chatClient.CreateVectorStoreAsync("x", Array.Empty<string>(), expiresAfter: null, cancellationToken: cts.Token));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CreateVectorStoreAsync_PollsUntilStoreLeavesInProgress_Async()
|
||||
{
|
||||
// Q-A regression: when the create response returns status=in_progress, the helper must
|
||||
// poll GET /vector_stores/{id} until status changes before returning. Otherwise the
|
||||
// caller receives a half-built store.
|
||||
var pollCount = 0;
|
||||
using var handler = new HttpHandlerAssert(req =>
|
||||
{
|
||||
if (req.RequestUri!.AbsolutePath.Contains("/vector_stores") && req.Method == HttpMethod.Post)
|
||||
{
|
||||
// First response: status=in_progress.
|
||||
return Task.FromResult(MakeJsonResponse(FakeVectorStoreJsonWithStatus("vs_abc", name: "x", status: "in_progress")));
|
||||
}
|
||||
if (req.RequestUri.AbsolutePath.Contains("/vector_stores/vs_abc") && req.Method == HttpMethod.Get)
|
||||
{
|
||||
pollCount++;
|
||||
// Stay in_progress for two polls, then complete on the third.
|
||||
var status = pollCount < 3 ? "in_progress" : "completed";
|
||||
return Task.FromResult(MakeJsonResponse(FakeVectorStoreJsonWithStatus("vs_abc", name: "x", status: status)));
|
||||
}
|
||||
return Task.FromResult(MakeJsonResponse("{}"));
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
var chatClient = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
|
||||
var store = await chatClient.CreateVectorStoreAsync("x", Array.Empty<string>());
|
||||
|
||||
Assert.NotEqual(OpenAI.VectorStores.VectorStoreStatus.InProgress, store.Status);
|
||||
Assert.True(pollCount >= 3, $"Expected at least 3 GET polls before status leaves in_progress; saw {pollCount}.");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CreateVectorStoreAsync_PollingTimeout_ThrowsTimeoutExceptionAsync()
|
||||
{
|
||||
// Sergey #2: caller-supplied (or default) polling timeout must surface as TimeoutException
|
||||
// when the vector store never leaves InProgress. Mock keeps the store stuck and we pass
|
||||
// a tiny timeout; cancellation token stays unused so the only path that ends the loop
|
||||
// is the timeout check.
|
||||
using var handler = new HttpHandlerAssert(req =>
|
||||
{
|
||||
if (req.RequestUri!.AbsolutePath.Contains("/vector_stores", StringComparison.Ordinal))
|
||||
{
|
||||
return Task.FromResult(MakeJsonResponse(FakeVectorStoreJsonWithStatus("vs_stuck", name: "x", status: "in_progress")));
|
||||
}
|
||||
return Task.FromResult(MakeJsonResponse("{}"));
|
||||
});
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
var chatClient = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
|
||||
var ex = await Assert.ThrowsAsync<TimeoutException>(() =>
|
||||
chatClient.CreateVectorStoreAsync("x", Array.Empty<string>(), expiresAfter: null, pollingTimeout: TimeSpan.FromMilliseconds(500)));
|
||||
Assert.Contains("vs_stuck", ex.Message, StringComparison.Ordinal);
|
||||
Assert.Contains("in-progress", ex.Message, StringComparison.Ordinal);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CreateVectorStoreAsync_MidUploadFailure_DeletesAlreadyUploadedFilesAsync()
|
||||
{
|
||||
// Q-B regression: when the upload loop throws partway through (e.g. file 3 of 5 is
|
||||
// missing or the network fails), the helper must DELETE the already-uploaded files so
|
||||
// they do not accumulate as orphaned resources. The exception must still propagate.
|
||||
var uploadCount = 0;
|
||||
var deleted = new List<string>();
|
||||
using var handler = new HttpHandlerAssert(req =>
|
||||
{
|
||||
// DELETE first so we don't match the upload-collection /files path against this.
|
||||
if (req.Method == HttpMethod.Delete)
|
||||
{
|
||||
var segments = req.RequestUri!.AbsolutePath.Split('/');
|
||||
var fileId = segments[segments.Length - 1];
|
||||
deleted.Add(fileId);
|
||||
return MakeJsonResponse(FakeFileDeletedJson(fileId));
|
||||
}
|
||||
if (req.Method == HttpMethod.Post && req.RequestUri!.AbsolutePath.Contains("/files", StringComparison.Ordinal))
|
||||
{
|
||||
uploadCount++;
|
||||
if (uploadCount == 3)
|
||||
{
|
||||
// 400 is non-retriable; the SDK retry policy ignores it. 5xx would trigger
|
||||
// retries and confuse the assertion on upload count.
|
||||
return new HttpResponseMessage(HttpStatusCode.BadRequest)
|
||||
{
|
||||
Content = new StringContent("{\"error\":{\"code\":\"BadRequest\",\"message\":\"upload-failed-on-3\"}}", Encoding.UTF8, "application/json"),
|
||||
};
|
||||
}
|
||||
return MakeJsonResponse(FakeFileJson($"file_{uploadCount}"));
|
||||
}
|
||||
return MakeJsonResponse("{}");
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
var chatClient = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
|
||||
var paths = new[] { MakeTempFile("a"), MakeTempFile("b"), MakeTempFile("c"), MakeTempFile("d"), MakeTempFile("e") };
|
||||
try
|
||||
{
|
||||
await Assert.ThrowsAnyAsync<Exception>(() => chatClient.CreateVectorStoreAsync("knowledge-base", paths));
|
||||
|
||||
// Three upload attempts: two succeeded, the third threw.
|
||||
Assert.Equal(3, uploadCount);
|
||||
// The two successful uploads must have been deleted as part of best-effort cleanup.
|
||||
Assert.Equal(2, deleted.Count);
|
||||
Assert.Contains("file_1", deleted);
|
||||
Assert.Contains("file_2", deleted);
|
||||
}
|
||||
finally
|
||||
{
|
||||
foreach (var p in paths)
|
||||
{
|
||||
File.Delete(p);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CreateVectorStoreAsync_MidUploadFailure_CleanupSwallowsDeleteErrorsAsync()
|
||||
{
|
||||
// Q-B follow-on: if a cleanup DELETE itself fails, the helper must still propagate the
|
||||
// original upload exception — not the cleanup exception. The caller cares about the
|
||||
// upload failure; cleanup is best-effort.
|
||||
var uploadCount = 0;
|
||||
using var handler = new HttpHandlerAssert(req =>
|
||||
{
|
||||
if (req.Method == HttpMethod.Delete)
|
||||
{
|
||||
return new HttpResponseMessage(HttpStatusCode.BadRequest)
|
||||
{
|
||||
Content = new StringContent("{\"error\":{\"code\":\"DeleteFailed\",\"message\":\"cleanup-failed\"}}", Encoding.UTF8, "application/json"),
|
||||
};
|
||||
}
|
||||
if (req.Method == HttpMethod.Post && req.RequestUri!.AbsolutePath.Contains("/files", StringComparison.Ordinal))
|
||||
{
|
||||
uploadCount++;
|
||||
if (uploadCount == 2)
|
||||
{
|
||||
return new HttpResponseMessage(HttpStatusCode.BadRequest)
|
||||
{
|
||||
Content = new StringContent("{\"error\":{\"code\":\"BadRequest\",\"message\":\"upload-failed\"}}", Encoding.UTF8, "application/json"),
|
||||
};
|
||||
}
|
||||
return MakeJsonResponse(FakeFileJson($"file_{uploadCount}"));
|
||||
}
|
||||
return MakeJsonResponse("{}");
|
||||
});
|
||||
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
var chatClient = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
|
||||
var paths = new[] { MakeTempFile("a"), MakeTempFile("b") };
|
||||
try
|
||||
{
|
||||
var ex = await Assert.ThrowsAnyAsync<Exception>(() => chatClient.CreateVectorStoreAsync("kb", paths));
|
||||
|
||||
// The original upload-failure message must surface, not the cleanup-failure message.
|
||||
Assert.DoesNotContain("cleanup-failed", ex.Message ?? "", StringComparison.Ordinal);
|
||||
}
|
||||
finally
|
||||
{
|
||||
foreach (var p in paths)
|
||||
{
|
||||
File.Delete(p);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ----- DeleteVectorStoreAsync -----
|
||||
|
||||
[Fact]
|
||||
public async Task DeleteVectorStoreAsync_Mode1_CallsDeleteAsync()
|
||||
{
|
||||
var (chatClient, recorder) = CreateMode1(responseBody: FakeVectorStoreDeletedJson("vs_abc"));
|
||||
await chatClient.DeleteVectorStoreAsync("vs_abc");
|
||||
Assert.Contains(recorder.Requests, r => r.Method == "DELETE" && r.PathAndQuery.Contains("/vector_stores/vs_abc"));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task DeleteVectorStoreAsync_Mode2_CallsDeleteAsync()
|
||||
{
|
||||
var (chatClient, recorder) = CreateMode2(responseBody: FakeVectorStoreDeletedJson("vs_xyz"));
|
||||
await chatClient.DeleteVectorStoreAsync("vs_xyz");
|
||||
Assert.Contains(recorder.Requests, r => r.Method == "DELETE" && r.PathAndQuery.Contains("/vector_stores/vs_xyz"));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task DeleteVectorStoreAsync_NullId_ThrowsArgumentExceptionAsync()
|
||||
{
|
||||
var (chatClient, _) = CreateMode1();
|
||||
await Assert.ThrowsAnyAsync<ArgumentException>(() => chatClient.DeleteVectorStoreAsync(null!));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task DeleteVectorStoreAsync_HonorsCancellationAsync()
|
||||
{
|
||||
// Same approach as DeleteFileAsync_HonorsCancellationAsync — assert that the call
|
||||
// throws when the token is pre-cancelled, without asserting on the exact exception
|
||||
// surfaced by the SDK pipeline.
|
||||
var (chatClient, _) = CreateMode1(responseBody: FakeVectorStoreDeletedJson("vs_abc"));
|
||||
using var cts = new CancellationTokenSource();
|
||||
cts.Cancel();
|
||||
await Assert.ThrowsAnyAsync<Exception>(() => chatClient.DeleteVectorStoreAsync("vs_abc", cts.Token));
|
||||
}
|
||||
|
||||
// ----- Fixtures and helpers -----
|
||||
|
||||
private static HttpResponseMessage MakeJsonResponse(string json)
|
||||
=> new(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent(json, Encoding.UTF8, "application/json"),
|
||||
};
|
||||
|
||||
private static string FakeFileJson(string id)
|
||||
=> $"{{\"id\":\"{id}\",\"object\":\"file\",\"bytes\":11,\"created_at\":1700000000,\"filename\":\"x.txt\",\"purpose\":\"assistants\",\"status\":\"processed\"}}";
|
||||
|
||||
private static string FakeFileDeletedJson(string id)
|
||||
=> $"{{\"id\":\"{id}\",\"object\":\"file\",\"deleted\":true}}";
|
||||
|
||||
private static string FakeVectorStoreJson(string id, string name)
|
||||
=> FakeVectorStoreJsonWithStatus(id, name, status: "completed");
|
||||
|
||||
private static string FakeVectorStoreJsonWithStatus(string id, string name, string status)
|
||||
=> $"{{\"id\":\"{id}\",\"object\":\"vector_store\",\"created_at\":1700000000,\"name\":\"{name}\",\"usage_bytes\":0,\"file_counts\":{{\"in_progress\":0,\"completed\":0,\"failed\":0,\"cancelled\":0,\"total\":0}},\"status\":\"{status}\",\"last_active_at\":1700000000}}";
|
||||
|
||||
private static string FakeVectorStoreDeletedJson(string id)
|
||||
=> $"{{\"id\":\"{id}\",\"object\":\"vector_store.deleted\",\"deleted\":true}}";
|
||||
|
||||
private sealed class RequestRecorder : HttpClientHandler
|
||||
{
|
||||
private readonly string _responseBody;
|
||||
public List<RecordedRequest> Requests { get; } = [];
|
||||
|
||||
public RequestRecorder(string? responseBody)
|
||||
{
|
||||
this._responseBody = responseBody ?? "{}";
|
||||
}
|
||||
|
||||
protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
|
||||
{
|
||||
this.Requests.Add(new RecordedRequest
|
||||
{
|
||||
Method = request.Method.Method,
|
||||
PathAndQuery = request.RequestUri?.PathAndQuery ?? "",
|
||||
#if NET
|
||||
Body = request.Content is null ? "" : await request.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false),
|
||||
#else
|
||||
Body = request.Content is null ? "" : await request.Content.ReadAsStringAsync().ConfigureAwait(false),
|
||||
#endif
|
||||
});
|
||||
return MakeJsonResponse(this._responseBody);
|
||||
}
|
||||
}
|
||||
|
||||
private sealed class RecordedRequest
|
||||
{
|
||||
public string Method { get; set; } = "";
|
||||
public string PathAndQuery { get; set; } = "";
|
||||
public string Body { get; set; } = "";
|
||||
}
|
||||
}
|
||||
#pragma warning restore CS0618
|
||||
+433
@@ -0,0 +1,433 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
using System;
|
||||
using System.ClientModel.Primitives;
|
||||
using System.Net;
|
||||
using System.Net.Http;
|
||||
using System.Text;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Azure.AI.Extensions.OpenAI;
|
||||
using Azure.AI.Projects;
|
||||
using Azure.AI.Projects.Agents;
|
||||
using Microsoft.Extensions.AI;
|
||||
using OpenAI.Responses;
|
||||
|
||||
#pragma warning disable OPENAI001, CS0618
|
||||
|
||||
namespace Microsoft.Agents.AI.Foundry.UnitTests;
|
||||
|
||||
/// <summary>
|
||||
/// Unit tests for the public <c>ToPromptAgentAsync</c> extension methods on
|
||||
/// <see cref="ChatClientAgent"/> and <see cref="FoundryAgent"/>. Both entry points dispatch
|
||||
/// to the same internal converter, so each behavior is asserted through both surfaces.
|
||||
/// </summary>
|
||||
public sealed class FoundryPromptAgentConverterTests
|
||||
{
|
||||
// ----- Failure modes (assert through ChatClientAgent and FoundryAgent extensions) -----
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_ChatClientAgent_NonFoundryChatClient_ThrowsInvalidOperationExceptionAsync()
|
||||
{
|
||||
var agent = new ChatClientAgent(new NoOpChatClient());
|
||||
var ex = await Assert.ThrowsAsync<InvalidOperationException>(() => agent.ToPromptAgentAsync());
|
||||
Assert.Contains("FoundryChatClient", ex.Message);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_FoundryAgent_FoundryChatClientInMode3_ThrowsInvalidOperationExceptionAsync()
|
||||
{
|
||||
var foundryAgent = new FoundryAgent(
|
||||
agentEndpoint: new Uri("https://example.com/api/projects/myproj/agents/myagent/endpoint/protocols/openai"),
|
||||
credential: new FakeAuthenticationTokenProvider());
|
||||
var ex = await Assert.ThrowsAsync<InvalidOperationException>(() => foundryAgent.ToPromptAgentAsync());
|
||||
Assert.Contains("Agent Endpoint mode (Mode 3)", ex.Message);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_ChatClientAgent_Mode1_MissingModelId_ThrowsInvalidOperationExceptionAsync()
|
||||
{
|
||||
var projectClient = CreateProjectClient();
|
||||
// Construct a FoundryChatClient via the Responses Agent mode (Mode 1) then wrap in a ChatClientAgent whose
|
||||
// ChatOptions has no ModelId — synthesis must throw.
|
||||
var fcc = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
var agent = new ChatClientAgent(fcc, new ChatClientAgentOptions { ChatOptions = new ChatOptions() });
|
||||
var ex = await Assert.ThrowsAsync<InvalidOperationException>(() => agent.ToPromptAgentAsync());
|
||||
Assert.Contains("model id", ex.Message, StringComparison.OrdinalIgnoreCase);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_ChatClientAgent_Mode1_UnsupportedAITool_ThrowsInvalidOperationExceptionNamingTypeAsync()
|
||||
{
|
||||
var projectClient = CreateProjectClient();
|
||||
var fcc = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
var agent = new ChatClientAgent(fcc, new ChatClientAgentOptions
|
||||
{
|
||||
ChatOptions = new ChatOptions
|
||||
{
|
||||
ModelId = "gpt-4o-mini",
|
||||
Tools = new System.Collections.Generic.List<AITool> { new UnsupportedTool() },
|
||||
},
|
||||
});
|
||||
var ex = await Assert.ThrowsAsync<InvalidOperationException>(() => agent.ToPromptAgentAsync());
|
||||
Assert.Contains(nameof(UnsupportedTool), ex.Message);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_FoundryAgent_HonorsCancellationAsync()
|
||||
{
|
||||
// Cancellation should bubble up from the AgentReference fetch path. Construct a
|
||||
// FoundryAgent via AsAIAgent(AgentReference) and pass a pre-cancelled token.
|
||||
var (foundryAgent, _) = CreateMode2_PromptAgentOnly("agent-name");
|
||||
using var cts = new CancellationTokenSource();
|
||||
cts.Cancel();
|
||||
await Assert.ThrowsAnyAsync<Exception>(() => foundryAgent.ToPromptAgentAsync(cts.Token));
|
||||
}
|
||||
|
||||
// ----- the Responses Agent mode (Mode 1) (RAPI) synthesis paths -----
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_ChatClientAgent_Mode1_RoundTripsModelInstructionsTemperatureTopPAsync()
|
||||
{
|
||||
var projectClient = CreateProjectClient();
|
||||
var fcc = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
var agent = new ChatClientAgent(fcc, new ChatClientAgentOptions
|
||||
{
|
||||
ChatOptions = new ChatOptions
|
||||
{
|
||||
ModelId = "gpt-4o-mini",
|
||||
Instructions = "Be helpful.",
|
||||
Temperature = 0.5f,
|
||||
TopP = 0.9f,
|
||||
},
|
||||
});
|
||||
|
||||
var def = await agent.ToPromptAgentAsync();
|
||||
var declarative = Assert.IsType<DeclarativeAgentDefinition>(def);
|
||||
Assert.Equal("gpt-4o-mini", declarative.Model);
|
||||
Assert.Equal("Be helpful.", declarative.Instructions);
|
||||
Assert.Equal(0.5f, declarative.Temperature);
|
||||
Assert.Equal(0.9f, declarative.TopP);
|
||||
Assert.Empty(declarative.Tools);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_ChatClientAgent_Mode1_NoTools_ReturnsDefinitionWithEmptyToolsAsync()
|
||||
{
|
||||
var projectClient = CreateProjectClient();
|
||||
var fcc = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
var agent = new ChatClientAgent(fcc, new ChatClientAgentOptions
|
||||
{
|
||||
ChatOptions = new ChatOptions { ModelId = "gpt-4o-mini" },
|
||||
});
|
||||
var def = await agent.ToPromptAgentAsync();
|
||||
var declarative = Assert.IsType<DeclarativeAgentDefinition>(def);
|
||||
Assert.Empty(declarative.Tools);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_ChatClientAgent_Mode1_AIFunctionTool_ConvertsToFunctionToolAsync()
|
||||
{
|
||||
var projectClient = CreateProjectClient();
|
||||
var fcc = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
var function = AIFunctionFactory.Create(() => "ok", "my_function", "A documented function.");
|
||||
var agent = new ChatClientAgent(fcc, new ChatClientAgentOptions
|
||||
{
|
||||
ChatOptions = new ChatOptions
|
||||
{
|
||||
ModelId = "gpt-4o-mini",
|
||||
Tools = new System.Collections.Generic.List<AITool> { function },
|
||||
},
|
||||
});
|
||||
|
||||
var def = await agent.ToPromptAgentAsync();
|
||||
var declarative = Assert.IsType<DeclarativeAgentDefinition>(def);
|
||||
var fnTool = Assert.Single(declarative.Tools);
|
||||
var ft = Assert.IsType<FunctionTool>(fnTool);
|
||||
Assert.Equal("my_function", ft.FunctionName);
|
||||
Assert.Equal("A documented function.", ft.FunctionDescription);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_ChatClientAgent_Mode1_FoundryAITool_UnwrapsUnderlyingResponseToolAsync()
|
||||
{
|
||||
var projectClient = CreateProjectClient();
|
||||
var fcc = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
var agent = new ChatClientAgent(fcc, new ChatClientAgentOptions
|
||||
{
|
||||
ChatOptions = new ChatOptions
|
||||
{
|
||||
ModelId = "gpt-4o-mini",
|
||||
Tools = new System.Collections.Generic.List<AITool> { FoundryAITool.CreateWebSearchTool() },
|
||||
},
|
||||
});
|
||||
|
||||
var def = await agent.ToPromptAgentAsync();
|
||||
var declarative = Assert.IsType<DeclarativeAgentDefinition>(def);
|
||||
var tool = Assert.Single(declarative.Tools);
|
||||
// The unwrapped instance must be the concrete WebSearchTool from the OpenAI SDK.
|
||||
Assert.IsType<WebSearchTool>(tool);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_ChatClientAgent_Mode1_MultipleToolsMixed_ConvertsAllInOrderAsync()
|
||||
{
|
||||
var projectClient = CreateProjectClient();
|
||||
var fcc = new FoundryChatClient(projectClient, "gpt-4o-mini");
|
||||
var function = AIFunctionFactory.Create(() => "ok", "fn", "");
|
||||
var agent = new ChatClientAgent(fcc, new ChatClientAgentOptions
|
||||
{
|
||||
ChatOptions = new ChatOptions
|
||||
{
|
||||
ModelId = "gpt-4o-mini",
|
||||
Tools = new System.Collections.Generic.List<AITool> { function, FoundryAITool.CreateWebSearchTool() },
|
||||
},
|
||||
});
|
||||
|
||||
var def = await agent.ToPromptAgentAsync();
|
||||
var declarative = Assert.IsType<DeclarativeAgentDefinition>(def);
|
||||
Assert.Equal(2, declarative.Tools.Count);
|
||||
Assert.IsType<FunctionTool>(declarative.Tools[0]);
|
||||
Assert.IsType<WebSearchTool>(declarative.Tools[1]);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_FoundryAgent_Mode1_ResultIsDeclarativeAgentDefinitionAsync()
|
||||
{
|
||||
// FoundryAgent constructed via the projectEndpoint+model+instructions ctor (Responses Agent mode, the Responses Agent mode (Mode 1)).
|
||||
var foundryAgent = new FoundryAgent(
|
||||
projectEndpoint: new Uri("https://test.openai.azure.com/"),
|
||||
credential: new FakeAuthenticationTokenProvider(),
|
||||
model: "gpt-4o-mini",
|
||||
instructions: "You are helpful.");
|
||||
|
||||
var def = await foundryAgent.ToPromptAgentAsync();
|
||||
var declarative = Assert.IsType<DeclarativeAgentDefinition>(def);
|
||||
Assert.Equal("gpt-4o-mini", declarative.Model);
|
||||
Assert.Equal("You are helpful.", declarative.Instructions);
|
||||
}
|
||||
|
||||
// ----- the Prompt Agent mode (Mode 2) paths -----
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_FoundryAgent_Mode2_AgentVersion_ReturnsCachedDefinitionAsync()
|
||||
{
|
||||
// Construct via ProjectsAgentVersion → the Definition reference must come back unchanged.
|
||||
var version = ModelReaderWriter.Read<ProjectsAgentVersion>(BinaryData.FromString(TestDataUtil.GetAgentVersionResponseJson()))!;
|
||||
var projectClient = CreateProjectClient();
|
||||
var foundryAgent = projectClient.AsAIAgent(version);
|
||||
|
||||
var def = await foundryAgent.ToPromptAgentAsync();
|
||||
Assert.Same(version.Definition, def);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_FoundryAgent_Mode2_AgentRecord_ReturnsLatestVersionDefinitionAsync()
|
||||
{
|
||||
var record = ModelReaderWriter.Read<ProjectsAgentRecord>(BinaryData.FromString(TestDataUtil.GetAgentResponseJson()))!;
|
||||
var projectClient = CreateProjectClient();
|
||||
var foundryAgent = projectClient.AsAIAgent(record);
|
||||
|
||||
var def = await foundryAgent.ToPromptAgentAsync();
|
||||
Assert.Same(record.GetLatestVersion().Definition, def);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_FoundryAgent_Mode2_PromptAgentOnly_FetchesLatestVersionAsync()
|
||||
{
|
||||
// The handler returns a known agent JSON. The converter must hit GET /agents/{name}
|
||||
// and return that record's latest version definition.
|
||||
var fetched = false;
|
||||
using var handler = new HttpHandlerAssert(req =>
|
||||
{
|
||||
if (req.Method == HttpMethod.Get && req.RequestUri!.AbsolutePath.Contains("/agents/agent-name"))
|
||||
{
|
||||
fetched = true;
|
||||
return new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent(TestDataUtil.GetAgentResponseJson(agentName: "agent-name"), Encoding.UTF8, "application/json"),
|
||||
};
|
||||
}
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent("{}", Encoding.UTF8, "application/json") };
|
||||
});
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
var foundryAgent = projectClient.AsAIAgent(new AgentReference("agent-name"));
|
||||
|
||||
var def = await foundryAgent.ToPromptAgentAsync();
|
||||
Assert.True(fetched);
|
||||
Assert.NotNull(def);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_FoundryAgent_Mode2_PromptAgentOnly_PinnedVersion_FetchesPinnedVersionAsync()
|
||||
{
|
||||
// Q-C regression: when AgentReference.Version is set, the converter must call
|
||||
// GET /agents/{name}/versions/{version} and return that pinned version's definition,
|
||||
// NOT GET /agents/{name} -> GetLatestVersion() which would silently substitute the
|
||||
// server's latest. We probe both paths from the same handler and assert exactly one was hit.
|
||||
var fetchedLatest = false;
|
||||
var fetchedPinned = false;
|
||||
using var handler = new HttpHandlerAssert(req =>
|
||||
{
|
||||
// Pinned-version path: …/agents/{name}/versions/{version}
|
||||
if (req.Method == HttpMethod.Get && req.RequestUri!.AbsolutePath.Contains("/agents/agent-name/versions/2", StringComparison.Ordinal))
|
||||
{
|
||||
fetchedPinned = true;
|
||||
var pinnedDef = new DeclarativeAgentDefinition("gpt-pinned") { Instructions = "Pinned-version instructions." };
|
||||
return new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent(TestDataUtil.GetAgentVersionResponseJson(agentName: "agent-name", agentDefinition: pinnedDef), Encoding.UTF8, "application/json"),
|
||||
};
|
||||
}
|
||||
// Latest-version path: …/agents/{name}
|
||||
if (req.Method == HttpMethod.Get && req.RequestUri!.AbsolutePath.EndsWith("/agents/agent-name", StringComparison.Ordinal))
|
||||
{
|
||||
fetchedLatest = true;
|
||||
var latestDef = new DeclarativeAgentDefinition("gpt-latest") { Instructions = "Latest-version instructions." };
|
||||
return new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent(TestDataUtil.GetAgentResponseJson(agentName: "agent-name", agentDefinition: latestDef), Encoding.UTF8, "application/json"),
|
||||
};
|
||||
}
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent("{}", Encoding.UTF8, "application/json") };
|
||||
});
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
var foundryAgent = projectClient.AsAIAgent(new AgentReference("agent-name", "2"));
|
||||
|
||||
var def = await foundryAgent.ToPromptAgentAsync();
|
||||
|
||||
Assert.True(fetchedPinned, "Pinned-version endpoint (.../agents/agent-name/versions/2) must be called when AgentReference.Version is set.");
|
||||
Assert.False(fetchedLatest, "Latest-version endpoint (.../agents/agent-name) must NOT be called when AgentReference.Version is set.");
|
||||
var declarative = Assert.IsType<DeclarativeAgentDefinition>(def);
|
||||
Assert.Equal("gpt-pinned", declarative.Model);
|
||||
Assert.Equal("Pinned-version instructions.", declarative.Instructions);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_FoundryAgent_Mode2_PromptAgentOnly_UnpinnedVersionKeyword_FetchesLatestAsync()
|
||||
{
|
||||
// Q-C boundary: AgentReference.Version == "latest" must fall back to the GET /agents/{name}
|
||||
// path (the latest-version path), NOT GET /agents/{name}/versions/latest.
|
||||
var fetchedLatest = false;
|
||||
using var handler = new HttpHandlerAssert(req =>
|
||||
{
|
||||
if (req.Method == HttpMethod.Get && req.RequestUri!.AbsolutePath.EndsWith("/agents/agent-name", StringComparison.Ordinal))
|
||||
{
|
||||
fetchedLatest = true;
|
||||
return new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent(TestDataUtil.GetAgentResponseJson(agentName: "agent-name"), Encoding.UTF8, "application/json"),
|
||||
};
|
||||
}
|
||||
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent("{}", Encoding.UTF8, "application/json") };
|
||||
});
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
var foundryAgent = projectClient.AsAIAgent(new AgentReference("agent-name", "latest"));
|
||||
|
||||
var def = await foundryAgent.ToPromptAgentAsync();
|
||||
|
||||
Assert.True(fetchedLatest);
|
||||
Assert.NotNull(def);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ToPromptAgentAsync_FoundryAgent_Mode2_PromptAgentOnly_ServerReturnsError_PropagatesExceptionAsync()
|
||||
{
|
||||
using var handler = new HttpHandlerAssert(req =>
|
||||
new HttpResponseMessage(HttpStatusCode.NotFound) { Content = new StringContent("{\"error\":{\"code\":\"NotFound\"}}", Encoding.UTF8, "application/json") });
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var projectClient = new AIProjectClient(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(httpClient) });
|
||||
var foundryAgent = projectClient.AsAIAgent(new AgentReference("missing-agent"));
|
||||
|
||||
await Assert.ThrowsAnyAsync<Exception>(() => foundryAgent.ToPromptAgentAsync());
|
||||
}
|
||||
|
||||
// ----- Python-parity guard: both extensions produce equivalent definitions -----
|
||||
|
||||
[Fact]
|
||||
public async Task BothExtensions_ProduceEquivalentDefinitions_ForEquivalentInputsAsync()
|
||||
{
|
||||
// Build two agents that are semantically equivalent: one as a plain ChatClientAgent
|
||||
// via AsAIAgent(model, instructions), and one as a FoundryAgent via the projectEndpoint
|
||||
// ctor. Both flow through the same converter; assert key fields match.
|
||||
var projectClient = CreateProjectClient();
|
||||
ChatClientAgent ccaAgent = projectClient.AsAIAgent("gpt-4o-mini", "Be helpful.");
|
||||
var foundryAgent = new FoundryAgent(
|
||||
projectEndpoint: new Uri("https://test.openai.azure.com/"),
|
||||
credential: new FakeAuthenticationTokenProvider(),
|
||||
model: "gpt-4o-mini",
|
||||
instructions: "Be helpful.");
|
||||
|
||||
var ccaDef = await ccaAgent.ToPromptAgentAsync();
|
||||
var faDef = await foundryAgent.ToPromptAgentAsync();
|
||||
|
||||
var a = Assert.IsType<DeclarativeAgentDefinition>(ccaDef);
|
||||
var b = Assert.IsType<DeclarativeAgentDefinition>(faDef);
|
||||
Assert.Equal(a.Model, b.Model);
|
||||
Assert.Equal(a.Instructions, b.Instructions);
|
||||
Assert.Equal(a.Tools.Count, b.Tools.Count);
|
||||
}
|
||||
|
||||
// ----- Helpers -----
|
||||
|
||||
private static AIProjectClient CreateProjectClient()
|
||||
=> new(
|
||||
new Uri("https://test.openai.azure.com/"),
|
||||
new FakeAuthenticationTokenProvider(),
|
||||
new AIProjectClientOptions { Transport = new HttpClientPipelineTransport(new HttpClient()) });
|
||||
|
||||
private static (FoundryAgent FoundryAgent, AIProjectClient ProjectClient) CreateMode2_PromptAgentOnly(string agentName)
|
||||
{
|
||||
var projectClient = CreateProjectClient();
|
||||
var foundryAgent = projectClient.AsAIAgent(new AgentReference(agentName));
|
||||
return (foundryAgent, projectClient);
|
||||
}
|
||||
|
||||
private sealed class NoOpChatClient : IChatClient
|
||||
{
|
||||
public Task<ChatResponse> GetResponseAsync(System.Collections.Generic.IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default)
|
||||
=> Task.FromResult(new ChatResponse());
|
||||
|
||||
public System.Collections.Generic.IAsyncEnumerable<ChatResponseUpdate> GetStreamingResponseAsync(System.Collections.Generic.IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default)
|
||||
=> EmptyAsyncEnumerableAsync();
|
||||
|
||||
private static async System.Collections.Generic.IAsyncEnumerable<ChatResponseUpdate> EmptyAsyncEnumerableAsync()
|
||||
{
|
||||
await Task.CompletedTask.ConfigureAwait(false);
|
||||
yield break;
|
||||
}
|
||||
|
||||
public object? GetService(Type serviceType, object? serviceKey = null) => null;
|
||||
|
||||
public void Dispose() { }
|
||||
}
|
||||
|
||||
private sealed class UnsupportedTool : AITool
|
||||
{
|
||||
public override string Name => "unsupported";
|
||||
}
|
||||
}
|
||||
#pragma warning restore CS0618
|
||||
+90
@@ -0,0 +1,90 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
using System;
|
||||
using System.ClientModel;
|
||||
using System.ClientModel.Primitives;
|
||||
using System.Net;
|
||||
using System.Net.Http;
|
||||
using System.Text;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.Extensions.AI;
|
||||
using OpenAI;
|
||||
using OpenAI.Responses;
|
||||
|
||||
#pragma warning disable OPENAI001
|
||||
|
||||
namespace Microsoft.Agents.AI.Foundry.UnitTests;
|
||||
|
||||
/// <summary>
|
||||
/// One-shot verification (kept in tree to detect regressions) that MEAI 10.5.1 stamps its own
|
||||
/// <c>MEAI/{version}</c> User-Agent segment automatically when an <see cref="ResponsesClient"/>
|
||||
/// is wrapped via <c>AsIChatClient()</c>. If this test starts failing, the FoundryChatClient
|
||||
/// implementation must re-register the MEAI policy explicitly via OpenAIRequestPolicies because
|
||||
/// the local Foundry copy was deleted under the assumption that MEAI provides it built-in.
|
||||
/// </summary>
|
||||
public sealed class MeaiAutoUserAgentVerificationTests
|
||||
{
|
||||
[Fact]
|
||||
public async Task MeaiOpenAIResponsesClient_StampsMeaiSegmentAutomatically_WithoutLocalPolicyAsync()
|
||||
{
|
||||
// Arrange: bare OpenAI ResponseClient over a fake HTTP transport, wrapped via MEAI's
|
||||
// AsIChatClient() with no custom OpenAIRequestPolicies registration. If MEAI auto-stamps
|
||||
// its own MEAI/{version} segment, it will appear here.
|
||||
using var handler = new RecordingHandler();
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
|
||||
var options = new OpenAIClientOptions
|
||||
{
|
||||
Transport = new HttpClientPipelineTransport(httpClient),
|
||||
Endpoint = new Uri("https://example.test/v1"),
|
||||
};
|
||||
|
||||
var responseClient = new ResponsesClient(new ApiKeyCredential("test-key"), options);
|
||||
var chatClient = responseClient.AsIChatClient("gpt-4o-mini");
|
||||
|
||||
// Act: send a request through MEAI's chat client. The fake transport will throw on
|
||||
// response parsing, but we only care about the outbound headers, which are captured
|
||||
// before the response is parsed.
|
||||
try
|
||||
{
|
||||
await chatClient.GetResponseAsync("hi", cancellationToken: CancellationToken.None);
|
||||
}
|
||||
catch
|
||||
{
|
||||
// Expected: the fake response body is not parseable as a Responses API payload.
|
||||
}
|
||||
|
||||
// Assert: at least one outbound request reached the transport, and its User-Agent
|
||||
// contains either "MEAI/" (auto-stamped by MEAI) or no MEAI segment (verification
|
||||
// signal — see test summary).
|
||||
Assert.True(handler.Count > 0, "Expected at least one outbound request from MEAI wrapper.");
|
||||
Assert.NotNull(handler.LastUserAgent);
|
||||
// INTENT: assert that MEAI auto-stamps. If the assertion fails, see the FoundryChatClient
|
||||
// implementation note about needing to register the MEAI policy explicitly.
|
||||
Assert.Contains("MEAI/", handler.LastUserAgent);
|
||||
}
|
||||
|
||||
private sealed class RecordingHandler : HttpClientHandler
|
||||
{
|
||||
public int Count { get; private set; }
|
||||
public string? LastUserAgent { get; private set; }
|
||||
|
||||
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
|
||||
{
|
||||
this.Count++;
|
||||
this.LastUserAgent = request.Headers.TryGetValues("User-Agent", out var values)
|
||||
? string.Join(",", values)
|
||||
: null;
|
||||
|
||||
var resp = new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent("{}", Encoding.UTF8, "application/json"),
|
||||
RequestMessage = request,
|
||||
};
|
||||
return Task.FromResult(resp);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,115 +0,0 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
using System.ClientModel.Primitives;
|
||||
using System.Net;
|
||||
using System.Net.Http;
|
||||
using System.Reflection;
|
||||
using System.Text;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
|
||||
namespace Microsoft.Agents.AI.Foundry.UnitTests;
|
||||
|
||||
/// <summary>
|
||||
/// Verifies the per-call <c>MeaiUserAgentPolicy</c> exposed via
|
||||
/// <see cref="RequestOptionsExtensions.UserAgentPolicy"/>. The policy is reachable through the
|
||||
/// public <see cref="FoundryAgent"/> constructors (which add it to the internally-built
|
||||
/// <see cref="Azure.AI.Projects.AIProjectClient"/>'s pipeline), so its behavior is part of the
|
||||
/// public API surface.
|
||||
/// </summary>
|
||||
public sealed class RequestOptionsExtensionsTests
|
||||
{
|
||||
[Fact]
|
||||
public async Task MeaiUserAgentPolicy_AddsMeaiSegment_ToOutgoingRequestAsync()
|
||||
{
|
||||
// Arrange
|
||||
using var handler = new RecordingHandler();
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var pipeline = ClientPipeline.Create(
|
||||
new ClientPipelineOptions { Transport = new HttpClientPipelineTransport(httpClient) },
|
||||
perCallPolicies: [RequestOptionsExtensions.UserAgentPolicy],
|
||||
perTryPolicies: default,
|
||||
beforeTransportPolicies: default);
|
||||
|
||||
// Act
|
||||
var message = pipeline.CreateMessage();
|
||||
message.Request.Method = "POST";
|
||||
message.Request.Uri = new System.Uri("https://example.test/anything");
|
||||
await pipeline.SendAsync(message);
|
||||
|
||||
// Assert
|
||||
Assert.Equal(1, handler.Count);
|
||||
Assert.NotNull(handler.LastUserAgent);
|
||||
Assert.Contains("MEAI/", handler.LastUserAgent);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task MeaiUserAgentPolicy_DoesNotAddFoundryHostingSegmentAsync()
|
||||
{
|
||||
// Arrange
|
||||
using var handler = new RecordingHandler();
|
||||
#pragma warning disable CA5399
|
||||
using var httpClient = new HttpClient(handler);
|
||||
#pragma warning restore CA5399
|
||||
var pipeline = ClientPipeline.Create(
|
||||
new ClientPipelineOptions { Transport = new HttpClientPipelineTransport(httpClient) },
|
||||
perCallPolicies: [RequestOptionsExtensions.UserAgentPolicy],
|
||||
perTryPolicies: default,
|
||||
beforeTransportPolicies: default);
|
||||
|
||||
// Act
|
||||
var message = pipeline.CreateMessage();
|
||||
message.Request.Method = "POST";
|
||||
message.Request.Uri = new System.Uri("https://example.test/anything");
|
||||
await pipeline.SendAsync(message);
|
||||
|
||||
// Assert: the policy is MEAI-only; the foundry-hosting supplement is added elsewhere
|
||||
// (by the polyfill UserAgentResponsesClient → HostedAgentUserAgentPolicy).
|
||||
Assert.NotNull(handler.LastUserAgent);
|
||||
Assert.DoesNotContain("foundry-hosting/agent-framework-dotnet", handler.LastUserAgent);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void UserAgentPolicy_ExposesSingletonInstance()
|
||||
{
|
||||
// Two reads of the static property must return the same instance — the policy is stateless and shared.
|
||||
var first = RequestOptionsExtensions.UserAgentPolicy;
|
||||
var second = RequestOptionsExtensions.UserAgentPolicy;
|
||||
Assert.Same(first, second);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void MeaiUserAgentPolicy_ValueIncludesAFFoundryAssemblyVersion_ReflectionGuard()
|
||||
{
|
||||
// The policy emits "MEAI/{Microsoft.Agents.AI.Foundry assembly InformationalVersion}".
|
||||
// If the assembly metadata stops being readable, the policy falls back to "MEAI" without a version,
|
||||
// which is a measurable telemetry regression.
|
||||
var attr = typeof(RequestOptionsExtensions).Assembly
|
||||
.GetCustomAttribute<AssemblyInformationalVersionAttribute>();
|
||||
Assert.NotNull(attr);
|
||||
Assert.False(string.IsNullOrEmpty(attr!.InformationalVersion));
|
||||
}
|
||||
|
||||
private sealed class RecordingHandler : HttpClientHandler
|
||||
{
|
||||
public int Count { get; private set; }
|
||||
public string? LastUserAgent { get; private set; }
|
||||
|
||||
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
|
||||
{
|
||||
this.Count++;
|
||||
this.LastUserAgent = request.Headers.TryGetValues("User-Agent", out var values)
|
||||
? string.Join(",", values)
|
||||
: null;
|
||||
|
||||
var resp = new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent("{}", Encoding.UTF8, "application/json"),
|
||||
RequestMessage = request,
|
||||
};
|
||||
return Task.FromResult(resp);
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user