chore: import upstream snapshot with attribution

dotnet/tests/Microsoft.Agents.AI.Workflows.UnitTests/MagenticProgressLedgerTests.cs

@@ -0,0 +1,214 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using System;
+using System.Text.Json;
+using FluentAssertions;
+using Microsoft.Agents.AI.Workflows.Specialized.Magentic;
+using Microsoft.Extensions.AI;
+
+namespace Microsoft.Agents.AI.Workflows.UnitTests;
+
+public class MagenticProgressLedgerTests
+{
+    public record KVPair(string key);
+    public record AnswerReasonPair(bool answer, string reason);
+
+    [Theory]
+    [InlineData(false)]
+    [InlineData(true)]
+    public void Test_ExtractJson_SucceedsWhenInBlockQuote(bool isTagged)
+    {
+        // Arrange
+        string json = isTagged
+                    ? "```json\n{\"key\": \"value\"}\n```"
+                    : "```{\"key\": \"value\"}```";
+
+        string embedded = $"Some text before the JSON block.\n{json}\nSome text after the JSON block.";
+        ChatMessage message = new(ChatRole.Assistant, embedded);
+
+        // Act
+        JsonElement element = message.ExtractJson();
+
+        // Assert
+        KVPair? result = element.Deserialize<KVPair>();
+
+        result.Should().NotBeNull();
+        result.key.Should().Be("value");
+    }
+
+    [Fact]
+    public void Test_ExtractJson_SucceedsWhenScanning()
+    {
+        // Arrange
+        ChatMessage message = new(ChatRole.Assistant,
+"""
+    Some text before the JSON embed.
+    {"key": "value"}
+
+    Some text after the JSON embed.        
+""");
+
+        // Act
+        JsonElement element = message.ExtractJson();
+
+        // Assert
+        KVPair? result = element.Deserialize<KVPair>();
+
+        result.Should().NotBeNull();
+        result.key.Should().Be("value");
+    }
+
+    [Fact]
+    public void Test_ExtractJson_FailsWhenUnbalanced()
+    {
+        // Arrange
+        ChatMessage message = new(ChatRole.Assistant,
+"""
+    Some text before the JSON embed.
+    {"key": { "key2": "value" }
+
+    Some text after the JSON embed.
+""");
+
+        // Act
+        Func<JsonElement> action = () => message.ExtractJson();
+
+        // Assert
+        action.Should().Throw();
+    }
+
+    [Fact]
+    public void Test_ExtractJson_FailsWhenNoJson()
+    {
+        // Arrange
+        ChatMessage message = new(ChatRole.Assistant,
+"""
+    Some text, without JSON
+""");
+
+        // Act
+        Func<JsonElement> action = () => message.ExtractJson();
+
+        // Assert
+        action.Should().Throw();
+    }
+
+    [Fact]
+    public void Test_ExtractJson_SuceedsWithQuotesBrackets()
+    {
+        // Arrange
+        ChatMessage message = new(ChatRole.Assistant,
+"""
+    {"reason":"the output contained }", "answer": false}
+""");
+
+        // Act
+        JsonElement element = message.ExtractJson();
+
+        // Assert
+        AnswerReasonPair? result = element.Deserialize<AnswerReasonPair>();
+
+        result.Should().NotBeNull();
+        result.reason.Should().Be("the output contained }");
+        result.answer.Should().BeFalse();
+    }
+
+    public static readonly string TestTeamNames = string.Join(", ", ["CodingAgent", "CodeExecutor", "WebSurferAgent", "FileSurferAgent"]);
+
+    [Fact]
+    public void Test_ProgressLedgerState_IsEmptyWhenStarted()
+    {
+        // Arrange/Act
+        MagenticProgressLedger ledger = new(TestTeamNames, []);
+
+        // Assert
+        ledger.State.Should().BeNull();
+        ledger.IsStarted.Should().BeFalse();
+
+        ledger.TryGetCurrentSlotValue(TestProgressLedgerState.CustomSlot1, out _).Should().BeFalse();
+        ledger.TryGetCurrentSlotValue(TestProgressLedgerState.CustomSlot2, out _).Should().BeFalse();
+    }
+
+    [Theory]
+    [InlineData(0, "RequiredOnly")]
+    [InlineData(1, "IncludeCustom")]
+    public void Test_ProgressLedgerState_IsNotEmptyWhenRestored(int caseIndex, string _)
+    {
+        // Arrange
+        TestProgressLedgerState state = TestProgressLedgerState.Working[caseIndex];
+        JsonElement element = state.ToJson();
+
+        // Act
+        MagenticProgressLedger ledger = new(TestTeamNames, [], element);
+
+        // Assert
+        ledger.State.Should().Be(element);
+        state.Validate(ledger);
+    }
+
+    [Theory]
+    [InlineData(0, "RequiredOnly")]
+    [InlineData(1, "IncludeCustom")]
+    public void Test_ProgressLedgerState_SwitchesToStartedWhenStateUpdates(int caseIndex, string _)
+    {
+        // Arrange
+        MagenticProgressLedger ledger = new(TestTeamNames, []);
+        TestProgressLedgerState targetState = TestProgressLedgerState.Working[caseIndex];
+        JsonElement element = targetState.ToJson();
+        ledger.State.Should().BeNull();
+
+        // Act
+        ledger.TryUpdateState(element).Should().BeTrue();
+
+        // Assert
+        ledger.State.Should().Be(element);
+        targetState.Validate(ledger);
+    }
+
+    [Theory]
+    [InlineData(0, "is_request_satisfied")]
+    [InlineData(1, "is_in_loop")]
+    [InlineData(2, "is_progress_being_made")]
+    [InlineData(3, "instruction_or_question")]
+    [InlineData(4, "next_speaker")]
+    public void Test_ProgressLedgerState_FailsToUpdateWhenRequiredAnswersMissing(int caseIndex, string _)
+    {
+        // Arrange
+        MagenticProgressLedger ledger = new(TestTeamNames, []);
+        TestProgressLedgerState targetState = TestProgressLedgerState.MissingRequired[caseIndex];
+        JsonElement element = targetState.ToJson();
+        ledger.State.Should().BeNull();
+
+        // Act
+        ledger.TryUpdateState(element).Should().BeFalse();
+        ledger.State.Should().BeNull();
+    }
+
+    [Theory]
+    [InlineData(true)]
+    [InlineData(false)]
+    public void Test_ProgressLedgerState_GeneratesCorrectSchema(bool includeCustom)
+    {
+        // Arrange
+        MagenticProgressLedger ledger = new(TestTeamNames, includeCustom
+                                                           ? [TestProgressLedgerState.CustomSlot1, TestProgressLedgerState.CustomSlot2]
+                                                           : []);
+
+        // Act
+        (string questionBlock, string answerSchema) = ledger.FormatQuestions();
+
+        foreach (ProgressLedgerSlot slot in ledger.Slots)
+        {
+            // Best-efforts validation: I do not want to make it super-brittle and check for 1:1: with the template
+            // since that is effectively checking that string formatting works right to some extent.
+            questionBlock.Should().Contain(slot.Question);
+            answerSchema.Should().Contain(slot.Key);
+            answerSchema.Should().Contain(slot.SchemaType);
+
+            if (!string.IsNullOrWhiteSpace(slot.SchemaTypeSuffix))
+            {
+                answerSchema.Should().Contain(slot.SchemaTypeSuffix);
+            }
+        }
+    }
+}