Files
agent-framework/python/packages/declarative/tests/test_workflow_state.py
T
Evan Mattson 9c094573e8 Python: Add declarative workflow runtime (#2815)
* Further support for declarative python workflows

* Add tests. Clean up for typing and formatting

* Improvements and cleanup

* Typing cleanup. Improve docstrings

* Proper code in docstrings

* Fix malformed code-block directive in docstring

* Remove dead links

* PR feedback

* Address PR feedback

* Address PR feedback

* Remove sl

* Update devui frontend

* More cleanup

* Fix uv lock

* Skip Py 3.14 tests as powerfx doesn't support it

* Fix mypy error

* Fix for tool calls

* Removed stale docstring

* Fix lint

* Standardize on .NET namespaces. Revert DevUI changes (bring in later)

* Implement remaining items for Python declarative support to match dotnet
2026-01-13 07:11:21 +00:00

226 lines
8.0 KiB
Python

# Copyright (c) Microsoft. All rights reserved.
"""Unit tests for WorkflowState class."""
import pytest
from agent_framework_declarative._workflows._state import WorkflowState
class TestWorkflowStateInitialization:
"""Tests for WorkflowState initialization."""
def test_empty_initialization(self):
"""Test creating a WorkflowState with no inputs."""
state = WorkflowState()
assert state.inputs == {}
assert state.outputs == {}
assert state.local == {}
assert state.agent == {}
def test_initialization_with_inputs(self):
"""Test creating a WorkflowState with inputs."""
state = WorkflowState(inputs={"query": "Hello", "count": 5})
assert state.inputs == {"query": "Hello", "count": 5}
assert state.outputs == {}
def test_inputs_are_immutable(self):
"""Test that inputs cannot be modified through set()."""
state = WorkflowState(inputs={"query": "Hello"})
with pytest.raises(ValueError, match="Cannot modify Workflow.Inputs"):
state.set("Workflow.Inputs.query", "Modified")
class TestWorkflowStateGetSet:
"""Tests for get and set operations."""
def test_set_and_get_turn_variable(self):
"""Test setting and getting a turn variable."""
state = WorkflowState()
state.set("Local.counter", 10)
assert state.get("Local.counter") == 10
def test_set_and_get_nested_turn_variable(self):
"""Test setting and getting a nested turn variable."""
state = WorkflowState()
state.set("Local.data.nested.value", "test")
assert state.get("Local.data.nested.value") == "test"
def test_set_and_get_workflow_output(self):
"""Test setting and getting workflow output."""
state = WorkflowState()
state.set("Workflow.Outputs.result", "success")
assert state.get("Workflow.Outputs.result") == "success"
assert state.outputs["result"] == "success"
def test_get_with_default(self):
"""Test get with default value."""
state = WorkflowState()
assert state.get("Local.nonexistent") is None
assert state.get("Local.nonexistent", "default") == "default"
def test_get_workflow_inputs(self):
"""Test getting workflow inputs."""
state = WorkflowState(inputs={"query": "test"})
assert state.get("Workflow.Inputs.query") == "test"
def test_set_custom_namespace(self):
"""Test setting a custom namespace variable."""
state = WorkflowState()
state.set("custom.myvar", "value")
assert state.get("custom.myvar") == "value"
class TestWorkflowStateAppend:
"""Tests for append operation."""
def test_append_to_nonexistent_list(self):
"""Test appending to a path that doesn't exist yet."""
state = WorkflowState()
state.append("Local.results", "item1")
assert state.get("Local.results") == ["item1"]
def test_append_to_existing_list(self):
"""Test appending to an existing list."""
state = WorkflowState()
state.set("Local.results", ["item1"])
state.append("Local.results", "item2")
assert state.get("Local.results") == ["item1", "item2"]
def test_append_to_non_list_raises(self):
"""Test that appending to a non-list raises ValueError."""
state = WorkflowState()
state.set("Local.value", "not a list")
with pytest.raises(ValueError, match="Cannot append to non-list"):
state.append("Local.value", "item")
class TestWorkflowStateAgentResult:
"""Tests for agent result management."""
def test_set_agent_result(self):
"""Test setting agent result."""
state = WorkflowState()
state.set_agent_result(
text="Agent response",
messages=[{"role": "assistant", "content": "Hello"}],
tool_calls=[{"name": "tool1"}],
)
assert state.agent["text"] == "Agent response"
assert len(state.agent["messages"]) == 1
assert len(state.agent["toolCalls"]) == 1
def test_get_agent_result_via_path(self):
"""Test getting agent result via path."""
state = WorkflowState()
state.set_agent_result(text="Response")
assert state.get("Agent.text") == "Response"
def test_reset_agent(self):
"""Test resetting agent result."""
state = WorkflowState()
state.set_agent_result(text="Response")
state.reset_agent()
assert state.agent == {}
class TestWorkflowStateConversation:
"""Tests for conversation management."""
def test_add_conversation_message(self):
"""Test adding a conversation message."""
state = WorkflowState()
message = {"role": "user", "content": "Hello"}
state.add_conversation_message(message)
assert len(state.conversation["messages"]) == 1
assert state.conversation["messages"][0] == message
def test_get_conversation_history(self):
"""Test getting conversation history."""
state = WorkflowState()
state.add_conversation_message({"role": "user", "content": "Hi"})
state.add_conversation_message({"role": "assistant", "content": "Hello"})
assert len(state.get("Conversation.history")) == 2
class TestWorkflowStatePowerFx:
"""Tests for PowerFx expression evaluation."""
def test_eval_non_expression(self):
"""Test that non-expressions are returned as-is."""
state = WorkflowState()
assert state.eval("plain text") == "plain text"
def test_eval_if_expression_with_literal(self):
"""Test eval_if_expression with a literal value."""
state = WorkflowState()
assert state.eval_if_expression(42) == 42
assert state.eval_if_expression(["a", "b"]) == ["a", "b"]
def test_eval_if_expression_with_non_expression_string(self):
"""Test eval_if_expression with a non-expression string."""
state = WorkflowState()
assert state.eval_if_expression("plain text") == "plain text"
def test_to_powerfx_symbols(self):
"""Test converting state to PowerFx symbols."""
state = WorkflowState(inputs={"query": "test"})
state.set("Local.counter", 5)
state.set("Workflow.Outputs.result", "done")
symbols = state.to_powerfx_symbols()
assert symbols["Workflow"]["Inputs"]["query"] == "test"
assert symbols["Workflow"]["Outputs"]["result"] == "done"
assert symbols["Local"]["counter"] == 5
class TestWorkflowStateClone:
"""Tests for state cloning."""
def test_clone_creates_copy(self):
"""Test that clone creates a copy of the state."""
state = WorkflowState(inputs={"query": "test"})
state.set("Local.counter", 5)
cloned = state.clone()
assert cloned.get("Workflow.Inputs.query") == "test"
assert cloned.get("Local.counter") == 5
def test_clone_is_independent(self):
"""Test that modifications to clone don't affect original."""
state = WorkflowState()
state.set("Local.value", "original")
cloned = state.clone()
cloned.set("Local.value", "modified")
assert state.get("Local.value") == "original"
assert cloned.get("Local.value") == "modified"
class TestWorkflowStateResetTurn:
"""Tests for turn reset."""
def test_reset_local_clears_turn_variables(self):
"""Test that reset_local clears turn variables."""
state = WorkflowState()
state.set("Local.var1", "value1")
state.set("Local.var2", "value2")
state.reset_local()
assert state.get("Local.var1") is None
assert state.get("Local.var2") is None
assert state.local == {}
def test_reset_local_preserves_other_state(self):
"""Test that reset_local preserves other state."""
state = WorkflowState(inputs={"query": "test"})
state.set("Workflow.Outputs.result", "done")
state.set("Local.temp", "will be cleared")
state.reset_local()
assert state.get("Workflow.Inputs.query") == "test"
assert state.get("Workflow.Outputs.result") == "done"