Files
agent-framework/dotnet/tests/Microsoft.Agents.AI.Workflows.UnitTests/HandoffWorkflowBuilderTests.cs
T
Jacob Alber 6f31e32df6 feat: tag-aware defaults and designation API on orchestration builders
Aligns the .NET orchestration builders with Python's output / intermediate-output
distinction. Each builder either applies a Python-aligned default designation set or
replays the user's explicit `WithOutputFrom` / `WithIntermediateOutputFrom` calls,
never both.

Static `AgentWorkflowBuilder.BuildSequential` / `BuildConcurrent` apply defaults
unconditionally (no user-facing fluent surface to take control through):

- Sequential: terminal `end` + every agent designated intermediate.
- Concurrent: terminal `end` + every agent and per-agent accumulator designated
  intermediate.

The three fluent instance builders memoize agent-typed designation calls in a
`Dictionary<AIAgent, HashSet<OutputTag>>` (empty set = terminal-only, non-empty =
intermediate tag(s)) so repeated calls dedupe naturally. They replay the entries
at `Build()` time, suppressing defaults when any call has been made:

- `HandoffWorkflowBuilder` / `HandoffWorkflowBuilderCore<TBuilder>` (also picked up
  by the obsolete `HandoffsWorkflowBuilder` via inheritance).
  Default: terminal `HandoffEnd` + every handoff agent intermediate.
  (Bug fix: legacy code relied on `WithOutputFrom(end)` to bind `HandoffEnd`. The
  new explicit-designation path bypasses that, so `Build()` now calls
  `BindExecutor(end)` unconditionally to keep validation happy.)
- `GroupChatWorkflowBuilder` — default: terminal host + every participant intermediate.
- `MagenticWorkflowBuilder` — default: terminal orchestrator + every team member
  intermediate.

Designating a non-participant agent throws `InvalidOperationException`.

The bare `WorkflowBuilder` default is unchanged — only the orchestration-style
builders gain implicit defaults, matching the plan's non-goal.

Tests
-----
- `AgentWorkflowBuilder.SequentialTests` / `.ConcurrentTests`: one default-spec
  assertion each.
- `GroupChatWorkflowBuilderTests`: defaults-match-spec, explicit-replaces-defaults,
  non-participant throws.
- `HandoffWorkflowBuilderTests` (new file): same three.
- `MagenticWorkflowBuilderTests` (new file): same three.

593/593 unit tests pass on net10.0 (582 baseline + 11 new).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-05-28 16:44:08 -04:00

78 lines
3.3 KiB
C#

// Copyright (c) Microsoft. All rights reserved.
using System;
using System.Collections.Generic;
using System.Linq;
using FluentAssertions;
namespace Microsoft.Agents.AI.Workflows.UnitTests;
/// <summary>
/// Tests focused on <see cref="HandoffWorkflowBuilder"/>'s output-designation surface —
/// the Python-aligned defaults applied at <see cref="HandoffWorkflowBuilderCore{TBuilder}.Build"/>
/// when the user has not made explicit designations, and the memoized
/// <c>WithOutputFrom</c> / <c>WithIntermediateOutputFrom</c> replay otherwise.
/// </summary>
#pragma warning disable MAAIW001 // Experimental: HandoffWorkflowBuilder
public class HandoffWorkflowBuilderTests
{
[Fact]
public void Test_HandoffWorkflowBuilder_DefaultDesignationsMatchSpec()
{
AgentWorkflowBuilderTests.DoubleEchoAgent coordinator = new("coordinator");
AgentWorkflowBuilderTests.DoubleEchoAgent specialist = new("specialist");
Workflow workflow = AgentWorkflowBuilder
.CreateHandoffBuilderWith(coordinator)
.WithHandoff(coordinator, specialist)
.Build();
Dictionary<string, HashSet<OutputTag>> designations = workflow.OutputExecutors;
designations.Where(kvp => kvp.Value.Count == 0)
.Should().ContainSingle("the handoff end executor is the sole terminal output by default");
designations.Where(kvp => kvp.Value.Contains(OutputTag.Intermediate))
.Should().HaveCount(2, "both the coordinator and the specialist are designated intermediate by default");
}
[Fact]
public void Test_HandoffWorkflowBuilder_ExplicitDesignationsReplaceDefaults()
{
AgentWorkflowBuilderTests.DoubleEchoAgent coordinator = new("coordinator");
AgentWorkflowBuilderTests.DoubleEchoAgent specialist = new("specialist");
Workflow workflow = AgentWorkflowBuilder
.CreateHandoffBuilderWith(coordinator)
.WithHandoff(coordinator, specialist)
.WithOutputFrom(coordinator)
.WithIntermediateOutputFrom([specialist])
.Build();
Dictionary<string, HashSet<OutputTag>> designations = workflow.OutputExecutors;
designations.Should().HaveCount(2,
"only the user-specified designations land on the inner builder; the handoff-end default is suppressed");
designations.Values.Where(tags => tags.Count == 0)
.Should().ContainSingle("coordinator is the only terminal designation");
designations.Values.Where(tags => tags.Contains(OutputTag.Intermediate))
.Should().ContainSingle("specialist is the only intermediate designation");
}
[Fact]
public void Test_HandoffWorkflowBuilder_DesignationForNonParticipantThrows()
{
AgentWorkflowBuilderTests.DoubleEchoAgent coordinator = new("coordinator");
AgentWorkflowBuilderTests.DoubleEchoAgent specialist = new("specialist");
AgentWorkflowBuilderTests.DoubleEchoAgent stranger = new("stranger");
HandoffWorkflowBuilder builder = AgentWorkflowBuilder
.CreateHandoffBuilderWith(coordinator)
.WithHandoff(coordinator, specialist)
.WithIntermediateOutputFrom([stranger]);
Action build = () => builder.Build();
build.Should().Throw<InvalidOperationException>().WithMessage("*stranger*");
}
}
#pragma warning restore MAAIW001