mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Eduard van Valkenburg
838a7fd61d
* Replace Role and FinishReason classes with NewType + Literal
- Remove EnumLike metaclass from _types.py
- Replace Role class with NewType('Role', str) + RoleLiteral
- Replace FinishReason class with NewType('FinishReason', str) + FinishReasonLiteral
- Update all usages across codebase to use string literals
- Remove .value access patterns (direct string comparison now works)
- Add backward compatibility for legacy dict serialization format
- Update tests to reflect new string-based types
Addresses #3591, #3615
* Simplify ChatResponse and AgentResponse type hints (#3592)
- Remove overloads from ChatResponse.__init__
- Remove text parameter from ChatResponse.__init__
- Remove | dict[str, Any] from finish_reason and usage_details params
- Remove **kwargs from AgentResponse.__init__
- Both now accept ChatMessage | Sequence[ChatMessage] | None for messages
- Update docstrings and examples to reflect changes
- Fix tests that were using removed kwargs
- Fix Role type hint usage in ag-ui utils
* Remove text parameter from ChatResponseUpdate and AgentResponseUpdate (#3597)
- Remove text parameter from ChatResponseUpdate.__init__
- Remove text parameter from AgentResponseUpdate.__init__
- Remove **kwargs from both update classes
- Simplify contents parameter type to Sequence[Content] | None
- Update all usages to use contents=[Content.from_text(...)] pattern
- Fix imports in test files
- Update docstrings and examples
* Rename from_chat_response_updates to from_updates (#3593)
- ChatResponse.from_chat_response_updates → ChatResponse.from_updates
- ChatResponse.from_chat_response_generator → ChatResponse.from_update_generator
- AgentResponse.from_agent_run_response_updates → AgentResponse.from_updates
* Remove try_parse_value method from ChatResponse and AgentResponse (#3595)
- Remove try_parse_value method from ChatResponse
- Remove try_parse_value method from AgentResponse
- Remove try_parse_value calls from from_updates and from_update_generator methods
- Update samples to use try/except with response.value instead
- Update tests to use response.value pattern
- Users should now use response.value with try/except for safe parsing
* Add agent_id to AgentResponse and clarify author_name documentation (#3596)
- Add agent_id parameter to AgentResponse class
- Document that author_name is on ChatMessage objects, not responses
- Update ChatResponse docstring with author_name note
- Update AgentResponse docstring with author_name note
* Simplify ChatMessage.__init__ signature (#3618)
- Make contents a positional argument accepting Sequence[Content | str]
- Auto-convert strings in contents to TextContent
- Remove overloads, keep text kwarg for backward compatibility with serialization
- Update _parse_content_list to handle string items
- Update all usages across codebase to use new format: ChatMessage("role", ["text"])
* Allow Content as input on run and get_response
- Update prepare_messages and normalize_messages to accept Content
- Update type signatures in _agents.py and _clients.py
- Add tests for Content input handling
* Fix ChatMessage usage across packages and samples
Update all remaining ChatMessage(role=..., text=...) to use new
ChatMessage('role', ['text']) signature.
* Fix Role string usage and response format parsing
- Fix redis provider: remove .value access on string literals
- Fix durabletask ensure_response_format: set _response_format before accessing .value
* Fix ollama .value and ai_model_id issues, handle None in content list
- Fix ollama _chat_client: remove .value on string literals
- Fix ollama _chat_client: rename ai_model_id to model_id
- Fix _parse_content_list: skip None values gracefully
* Fix A2AAgent type signature to include Content
* Fix Role/FinishReason NewType dict annotations and improve test coverage to 95%
* Fix mypy errors for Role/FinishReason NewType usage
* Fix Role.TOOL and Role.ASSISTANT usage in _orchestrator_helpers.py
* Fix Role NewType usage in durabletask _models.py
310 lines
11 KiB
Python
310 lines
11 KiB
Python
# Copyright (c) Microsoft. All rights reserved.
|
|
|
|
"""Unit tests for data models (RunRequest)."""
|
|
|
|
import pytest
|
|
from pydantic import BaseModel
|
|
|
|
from agent_framework_durabletask._models import RunRequest
|
|
|
|
|
|
class ModuleStructuredResponse(BaseModel):
|
|
value: int
|
|
|
|
|
|
class TestRunRequest:
|
|
"""Test suite for RunRequest."""
|
|
|
|
def test_init_with_defaults(self) -> None:
|
|
"""Test RunRequest initialization with defaults."""
|
|
request = RunRequest(message="Hello", correlation_id="corr-001")
|
|
|
|
assert request.message == "Hello"
|
|
assert request.correlation_id == "corr-001"
|
|
assert request.role == "user"
|
|
assert request.response_format is None
|
|
assert request.enable_tool_calls is True
|
|
assert request.wait_for_response is True
|
|
|
|
def test_init_with_all_fields(self) -> None:
|
|
"""Test RunRequest initialization with all fields."""
|
|
schema = ModuleStructuredResponse
|
|
request = RunRequest(
|
|
message="Hello",
|
|
correlation_id="corr-002",
|
|
role="system",
|
|
response_format=schema,
|
|
enable_tool_calls=False,
|
|
wait_for_response=False,
|
|
)
|
|
|
|
assert request.message == "Hello"
|
|
assert request.correlation_id == "corr-002"
|
|
assert request.role == "system"
|
|
assert request.response_format is schema
|
|
assert request.enable_tool_calls is False
|
|
assert request.wait_for_response is False
|
|
|
|
def test_init_coerces_string_role(self) -> None:
|
|
"""Ensure string role values are coerced into Role instances."""
|
|
request = RunRequest(message="Hello", correlation_id="corr-003", role="system") # type: ignore[arg-type]
|
|
|
|
assert request.role == "system"
|
|
|
|
def test_to_dict_with_defaults(self) -> None:
|
|
"""Test to_dict with default values."""
|
|
request = RunRequest(message="Test message", correlation_id="corr-004")
|
|
data = request.to_dict()
|
|
|
|
assert data["message"] == "Test message"
|
|
assert data["enable_tool_calls"] is True
|
|
assert data["wait_for_response"] is True
|
|
assert data["role"] == "user"
|
|
assert data["correlationId"] == "corr-004"
|
|
assert "response_format" not in data or data["response_format"] is None
|
|
assert "thread_id" not in data
|
|
|
|
def test_to_dict_with_all_fields(self) -> None:
|
|
"""Test to_dict with all fields."""
|
|
schema = ModuleStructuredResponse
|
|
request = RunRequest(
|
|
message="Hello",
|
|
correlation_id="corr-005",
|
|
role="assistant",
|
|
response_format=schema,
|
|
enable_tool_calls=False,
|
|
wait_for_response=False,
|
|
)
|
|
data = request.to_dict()
|
|
|
|
assert data["message"] == "Hello"
|
|
assert data["correlationId"] == "corr-005"
|
|
assert data["role"] == "assistant"
|
|
assert data["response_format"]["__response_schema_type__"] == "pydantic_model"
|
|
assert data["response_format"]["module"] == schema.__module__
|
|
assert data["response_format"]["qualname"] == schema.__qualname__
|
|
assert data["enable_tool_calls"] is False
|
|
assert data["wait_for_response"] is False
|
|
assert "thread_id" not in data
|
|
|
|
def test_from_dict_with_defaults(self) -> None:
|
|
"""Test from_dict with minimal data."""
|
|
data = {"message": "Hello", "correlationId": "corr-006"}
|
|
request = RunRequest.from_dict(data)
|
|
|
|
assert request.message == "Hello"
|
|
assert request.correlation_id == "corr-006"
|
|
assert request.role == "user"
|
|
assert request.enable_tool_calls is True
|
|
assert request.wait_for_response is True
|
|
|
|
def test_from_dict_ignores_thread_id_field(self) -> None:
|
|
"""Ensure legacy thread_id input does not break RunRequest parsing."""
|
|
request = RunRequest.from_dict({"message": "Hello", "correlationId": "corr-007", "thread_id": "ignored"})
|
|
|
|
assert request.message == "Hello"
|
|
|
|
def test_from_dict_with_all_fields(self) -> None:
|
|
"""Test from_dict with all fields."""
|
|
data = {
|
|
"message": "Test",
|
|
"correlationId": "corr-008",
|
|
"role": "system",
|
|
"response_format": {
|
|
"__response_schema_type__": "pydantic_model",
|
|
"module": ModuleStructuredResponse.__module__,
|
|
"qualname": ModuleStructuredResponse.__qualname__,
|
|
},
|
|
"enable_tool_calls": False,
|
|
}
|
|
request = RunRequest.from_dict(data)
|
|
|
|
assert request.message == "Test"
|
|
assert request.correlation_id == "corr-008"
|
|
assert request.role == "system"
|
|
assert request.response_format is ModuleStructuredResponse
|
|
assert request.enable_tool_calls is False
|
|
|
|
def test_from_dict_unknown_role_preserves_value(self) -> None:
|
|
"""Test from_dict keeps custom roles intact."""
|
|
data = {"message": "Test", "correlationId": "corr-009", "role": "reviewer"}
|
|
request = RunRequest.from_dict(data)
|
|
|
|
assert request.role == "reviewer"
|
|
assert request.role != "user"
|
|
|
|
def test_from_dict_empty_message(self) -> None:
|
|
"""Test from_dict with empty message."""
|
|
request = RunRequest.from_dict({"correlationId": "corr-010"})
|
|
|
|
assert request.message == ""
|
|
assert request.correlation_id == "corr-010"
|
|
assert request.role == "user"
|
|
|
|
def test_from_dict_missing_correlation_id_raises(self) -> None:
|
|
"""Test from_dict raises when correlationId is missing."""
|
|
with pytest.raises(ValueError, match="correlationId is required"):
|
|
RunRequest.from_dict({"message": "Test"})
|
|
|
|
def test_round_trip_dict_conversion(self) -> None:
|
|
"""Test round-trip to_dict and from_dict."""
|
|
original = RunRequest(
|
|
message="Test message",
|
|
correlation_id="corr-011",
|
|
role="system",
|
|
response_format=ModuleStructuredResponse,
|
|
enable_tool_calls=False,
|
|
)
|
|
|
|
data = original.to_dict()
|
|
restored = RunRequest.from_dict(data)
|
|
|
|
assert restored.message == original.message
|
|
assert restored.correlation_id == original.correlation_id
|
|
assert restored.role == original.role
|
|
assert restored.response_format is ModuleStructuredResponse
|
|
assert restored.enable_tool_calls == original.enable_tool_calls
|
|
|
|
def test_round_trip_with_pydantic_response_format(self) -> None:
|
|
"""Ensure Pydantic response formats serialize and deserialize properly."""
|
|
original = RunRequest(
|
|
message="Structured",
|
|
correlation_id="corr-012",
|
|
response_format=ModuleStructuredResponse,
|
|
)
|
|
|
|
data = original.to_dict()
|
|
|
|
assert data["response_format"]["__response_schema_type__"] == "pydantic_model"
|
|
assert data["response_format"]["module"] == ModuleStructuredResponse.__module__
|
|
assert data["response_format"]["qualname"] == ModuleStructuredResponse.__qualname__
|
|
|
|
restored = RunRequest.from_dict(data)
|
|
assert restored.response_format is ModuleStructuredResponse
|
|
|
|
def test_round_trip_with_options(self) -> None:
|
|
"""Ensure options are preserved and response_format is deserialized."""
|
|
original = RunRequest(
|
|
message="Test",
|
|
correlation_id="corr-opts-1",
|
|
response_format=ModuleStructuredResponse,
|
|
enable_tool_calls=False,
|
|
options={
|
|
"response_format": ModuleStructuredResponse,
|
|
"enable_tool_calls": False,
|
|
"custom": "value",
|
|
},
|
|
)
|
|
|
|
data = original.to_dict()
|
|
assert data["options"]["custom"] == "value"
|
|
|
|
restored = RunRequest.from_dict(data)
|
|
assert restored.options is not None
|
|
assert restored.options["custom"] == "value"
|
|
assert restored.options["response_format"] is ModuleStructuredResponse
|
|
|
|
def test_init_with_correlationId(self) -> None:
|
|
"""Test RunRequest initialization with correlationId."""
|
|
request = RunRequest(message="Test message", correlation_id="corr-123")
|
|
|
|
assert request.message == "Test message"
|
|
assert request.correlation_id == "corr-123"
|
|
|
|
def test_to_dict_with_correlationId(self) -> None:
|
|
"""Test to_dict includes correlationId."""
|
|
request = RunRequest(message="Test", correlation_id="corr-456")
|
|
data = request.to_dict()
|
|
|
|
assert data["message"] == "Test"
|
|
assert data["correlationId"] == "corr-456"
|
|
|
|
def test_from_dict_with_correlationId(self) -> None:
|
|
"""Test from_dict with correlationId."""
|
|
data = {"message": "Test", "correlationId": "corr-789"}
|
|
request = RunRequest.from_dict(data)
|
|
|
|
assert request.message == "Test"
|
|
assert request.correlation_id == "corr-789"
|
|
|
|
def test_round_trip_with_correlationId(self) -> None:
|
|
"""Test round-trip to_dict and from_dict with correlationId."""
|
|
original = RunRequest(
|
|
message="Test message",
|
|
role="system",
|
|
correlation_id="corr-124",
|
|
)
|
|
|
|
data = original.to_dict()
|
|
restored = RunRequest.from_dict(data)
|
|
|
|
assert restored.message == original.message
|
|
assert restored.role == original.role
|
|
assert restored.correlation_id == original.correlation_id
|
|
|
|
def test_init_with_orchestration_id(self) -> None:
|
|
"""Test RunRequest initialization with orchestration_id."""
|
|
request = RunRequest(
|
|
message="Test message",
|
|
correlation_id="corr-125",
|
|
orchestration_id="orch-123",
|
|
)
|
|
|
|
assert request.message == "Test message"
|
|
assert request.orchestration_id == "orch-123"
|
|
|
|
def test_to_dict_with_orchestration_id(self) -> None:
|
|
"""Test to_dict includes orchestrationId."""
|
|
request = RunRequest(
|
|
message="Test",
|
|
correlation_id="corr-126",
|
|
orchestration_id="orch-456",
|
|
)
|
|
data = request.to_dict()
|
|
|
|
assert data["message"] == "Test"
|
|
assert data["orchestrationId"] == "orch-456"
|
|
|
|
def test_to_dict_excludes_orchestration_id_when_none(self) -> None:
|
|
"""Test to_dict excludes orchestrationId when not set."""
|
|
request = RunRequest(
|
|
message="Test",
|
|
correlation_id="corr-127",
|
|
)
|
|
data = request.to_dict()
|
|
|
|
assert "orchestrationId" not in data
|
|
|
|
def test_from_dict_with_orchestration_id(self) -> None:
|
|
"""Test from_dict with orchestrationId."""
|
|
data = {
|
|
"message": "Test",
|
|
"correlationId": "corr-128",
|
|
"orchestrationId": "orch-789",
|
|
}
|
|
request = RunRequest.from_dict(data)
|
|
|
|
assert request.message == "Test"
|
|
assert request.orchestration_id == "orch-789"
|
|
|
|
def test_round_trip_with_orchestration_id(self) -> None:
|
|
"""Test round-trip to_dict and from_dict with orchestration_id."""
|
|
original = RunRequest(
|
|
message="Test message",
|
|
role="system",
|
|
correlation_id="corr-129",
|
|
orchestration_id="orch-123",
|
|
)
|
|
|
|
data = original.to_dict()
|
|
restored = RunRequest.from_dict(data)
|
|
|
|
assert restored.message == original.message
|
|
assert restored.role == original.role
|
|
assert restored.correlation_id == original.correlation_id
|
|
assert restored.orchestration_id == original.orchestration_id
|
|
|
|
|
|
if __name__ == "__main__":
|
|
pytest.main([__file__, "-v", "--tb=short"])
|