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
309 lines
14 KiB
Python
309 lines
14 KiB
Python
# Copyright (c) Microsoft. All rights reserved.
|
|
|
|
from typing import Any
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
import pytest
|
|
from agent_framework import AgentResponse, AgentResponseUpdate, AgentThread, ChatMessage, Content
|
|
from agent_framework.exceptions import ServiceException, ServiceInitializationError
|
|
from microsoft_agents.copilotstudio.client import CopilotClient
|
|
|
|
from agent_framework_copilotstudio import CopilotStudioAgent
|
|
|
|
|
|
def create_async_generator(items: list[Any]) -> Any:
|
|
"""Helper to create async generator mock."""
|
|
|
|
async def async_gen() -> Any:
|
|
for item in items:
|
|
yield item
|
|
|
|
return async_gen()
|
|
|
|
|
|
class TestCopilotStudioAgent:
|
|
"""Test cases for CopilotStudioAgent."""
|
|
|
|
@pytest.fixture
|
|
def mock_activity(self) -> MagicMock:
|
|
activity = MagicMock()
|
|
activity.text = "Test response"
|
|
activity.type = "message"
|
|
activity.id = "test-id"
|
|
activity.from_property.name = "Test Bot"
|
|
return activity
|
|
|
|
@pytest.fixture
|
|
def mock_copilot_client(self) -> MagicMock:
|
|
return MagicMock(spec=CopilotClient)
|
|
|
|
@patch("agent_framework_copilotstudio._acquire_token.acquire_token")
|
|
@patch("agent_framework_copilotstudio._agent.CopilotStudioSettings")
|
|
def test_init_missing_environment_id(self, mock_settings: MagicMock, mock_acquire_token: MagicMock) -> None:
|
|
mock_acquire_token.return_value = "fake-token"
|
|
mock_settings.return_value.environmentid = None
|
|
mock_settings.return_value.schemaname = "test-bot"
|
|
mock_settings.return_value.tenantid = "test-tenant"
|
|
mock_settings.return_value.agentappid = "test-client"
|
|
|
|
with pytest.raises(ServiceInitializationError, match="environment ID is required"):
|
|
CopilotStudioAgent()
|
|
|
|
@patch("agent_framework_copilotstudio._acquire_token.acquire_token")
|
|
@patch("agent_framework_copilotstudio._agent.CopilotStudioSettings")
|
|
def test_init_missing_bot_id(self, mock_settings: MagicMock, mock_acquire_token: MagicMock) -> None:
|
|
mock_acquire_token.return_value = "fake-token"
|
|
mock_settings.return_value.environmentid = "test-env"
|
|
mock_settings.return_value.schemaname = None
|
|
mock_settings.return_value.tenantid = "test-tenant"
|
|
mock_settings.return_value.agentappid = "test-client"
|
|
|
|
with pytest.raises(ServiceInitializationError, match="agent identifier"):
|
|
CopilotStudioAgent()
|
|
|
|
@patch("agent_framework_copilotstudio._acquire_token.acquire_token")
|
|
@patch("agent_framework_copilotstudio._agent.CopilotStudioSettings")
|
|
def test_init_missing_tenant_id(self, mock_settings: MagicMock, mock_acquire_token: MagicMock) -> None:
|
|
mock_acquire_token.return_value = "fake-token"
|
|
mock_settings.return_value.environmentid = "test-env"
|
|
mock_settings.return_value.schemaname = "test-bot"
|
|
mock_settings.return_value.tenantid = None
|
|
mock_settings.return_value.agentappid = "test-client"
|
|
|
|
with pytest.raises(ServiceInitializationError, match="tenant ID is required"):
|
|
CopilotStudioAgent()
|
|
|
|
@patch("agent_framework_copilotstudio._acquire_token.acquire_token")
|
|
@patch("agent_framework_copilotstudio._agent.CopilotStudioSettings")
|
|
def test_init_missing_client_id(self, mock_settings: MagicMock, mock_acquire_token: MagicMock) -> None:
|
|
mock_acquire_token.return_value = "fake-token"
|
|
mock_settings.return_value.environmentid = "test-env"
|
|
mock_settings.return_value.schemaname = "test-bot"
|
|
mock_settings.return_value.tenantid = "test-tenant"
|
|
mock_settings.return_value.agentappid = None
|
|
|
|
with pytest.raises(ServiceInitializationError, match="client ID is required"):
|
|
CopilotStudioAgent()
|
|
|
|
def test_init_with_client(self, mock_copilot_client: MagicMock) -> None:
|
|
agent = CopilotStudioAgent(client=mock_copilot_client)
|
|
assert agent.client == mock_copilot_client
|
|
assert agent.id is not None
|
|
|
|
@patch("agent_framework_copilotstudio._acquire_token.acquire_token")
|
|
def test_init_empty_environment_id(self, mock_acquire_token: MagicMock) -> None:
|
|
mock_acquire_token.return_value = "fake-token"
|
|
with patch("agent_framework_copilotstudio._agent.CopilotStudioSettings") as mock_settings:
|
|
mock_settings.return_value.environmentid = ""
|
|
mock_settings.return_value.schemaname = "test-bot"
|
|
mock_settings.return_value.tenantid = "test-tenant"
|
|
mock_settings.return_value.agentappid = "test-client"
|
|
|
|
with pytest.raises(ServiceInitializationError, match="environment ID is required"):
|
|
CopilotStudioAgent()
|
|
|
|
@patch("agent_framework_copilotstudio._acquire_token.acquire_token")
|
|
def test_init_empty_schema_name(self, mock_acquire_token: MagicMock) -> None:
|
|
mock_acquire_token.return_value = "fake-token"
|
|
with patch("agent_framework_copilotstudio._agent.CopilotStudioSettings") as mock_settings:
|
|
mock_settings.return_value.environmentid = "test-env"
|
|
mock_settings.return_value.schemaname = ""
|
|
mock_settings.return_value.tenantid = "test-tenant"
|
|
mock_settings.return_value.agentappid = "test-client"
|
|
|
|
with pytest.raises(ServiceInitializationError, match="agent identifier"):
|
|
CopilotStudioAgent()
|
|
|
|
async def test_run_with_string_message(self, mock_copilot_client: MagicMock, mock_activity: MagicMock) -> None:
|
|
"""Test run method with string message."""
|
|
agent = CopilotStudioAgent(client=mock_copilot_client)
|
|
|
|
conversation_activity = MagicMock()
|
|
conversation_activity.conversation.id = "test-conversation-id"
|
|
|
|
mock_copilot_client.start_conversation.return_value = create_async_generator([conversation_activity])
|
|
mock_copilot_client.ask_question.return_value = create_async_generator([mock_activity])
|
|
|
|
response = await agent.run("test message")
|
|
|
|
assert isinstance(response, AgentResponse)
|
|
assert len(response.messages) == 1
|
|
content = response.messages[0].contents[0]
|
|
assert content.type == "text"
|
|
assert content.text == "Test response"
|
|
assert response.messages[0].role == "assistant"
|
|
|
|
async def test_run_with_chat_message(self, mock_copilot_client: MagicMock, mock_activity: MagicMock) -> None:
|
|
"""Test run method with ChatMessage."""
|
|
agent = CopilotStudioAgent(client=mock_copilot_client)
|
|
|
|
conversation_activity = MagicMock()
|
|
conversation_activity.conversation.id = "test-conversation-id"
|
|
|
|
mock_copilot_client.start_conversation.return_value = create_async_generator([conversation_activity])
|
|
mock_copilot_client.ask_question.return_value = create_async_generator([mock_activity])
|
|
|
|
chat_message = ChatMessage("user", [Content.from_text("test message")])
|
|
response = await agent.run(chat_message)
|
|
|
|
assert isinstance(response, AgentResponse)
|
|
assert len(response.messages) == 1
|
|
content = response.messages[0].contents[0]
|
|
assert content.type == "text"
|
|
assert content.text == "Test response"
|
|
assert response.messages[0].role == "assistant"
|
|
|
|
async def test_run_with_thread(self, mock_copilot_client: MagicMock, mock_activity: MagicMock) -> None:
|
|
"""Test run method with existing thread."""
|
|
agent = CopilotStudioAgent(client=mock_copilot_client)
|
|
thread = AgentThread()
|
|
|
|
conversation_activity = MagicMock()
|
|
conversation_activity.conversation.id = "test-conversation-id"
|
|
|
|
mock_copilot_client.start_conversation.return_value = create_async_generator([conversation_activity])
|
|
mock_copilot_client.ask_question.return_value = create_async_generator([mock_activity])
|
|
|
|
response = await agent.run("test message", thread=thread)
|
|
|
|
assert isinstance(response, AgentResponse)
|
|
assert len(response.messages) == 1
|
|
assert thread.service_thread_id == "test-conversation-id"
|
|
|
|
async def test_run_start_conversation_failure(self, mock_copilot_client: MagicMock) -> None:
|
|
"""Test run method when conversation start fails."""
|
|
agent = CopilotStudioAgent(client=mock_copilot_client)
|
|
|
|
mock_copilot_client.start_conversation.return_value = create_async_generator([])
|
|
|
|
with pytest.raises(ServiceException, match="Failed to start a new conversation"):
|
|
await agent.run("test message")
|
|
|
|
async def test_run_stream_with_string_message(self, mock_copilot_client: MagicMock) -> None:
|
|
"""Test run_stream method with string message."""
|
|
agent = CopilotStudioAgent(client=mock_copilot_client)
|
|
|
|
conversation_activity = MagicMock()
|
|
conversation_activity.conversation.id = "test-conversation-id"
|
|
|
|
typing_activity = MagicMock()
|
|
typing_activity.text = "Streaming response"
|
|
typing_activity.type = "typing"
|
|
typing_activity.id = "test-typing-id"
|
|
typing_activity.from_property.name = "Test Bot"
|
|
|
|
mock_copilot_client.start_conversation.return_value = create_async_generator([conversation_activity])
|
|
mock_copilot_client.ask_question.return_value = create_async_generator([typing_activity])
|
|
|
|
response_count = 0
|
|
async for response in agent.run_stream("test message"):
|
|
assert isinstance(response, AgentResponseUpdate)
|
|
content = response.contents[0]
|
|
assert content.type == "text"
|
|
assert content.text == "Streaming response"
|
|
response_count += 1
|
|
|
|
assert response_count == 1
|
|
|
|
async def test_run_stream_with_thread(self, mock_copilot_client: MagicMock) -> None:
|
|
"""Test run_stream method with existing thread."""
|
|
agent = CopilotStudioAgent(client=mock_copilot_client)
|
|
thread = AgentThread()
|
|
|
|
conversation_activity = MagicMock()
|
|
conversation_activity.conversation.id = "test-conversation-id"
|
|
|
|
typing_activity = MagicMock()
|
|
typing_activity.text = "Streaming response"
|
|
typing_activity.type = "typing"
|
|
typing_activity.id = "test-typing-id"
|
|
typing_activity.from_property.name = "Test Bot"
|
|
|
|
mock_copilot_client.start_conversation.return_value = create_async_generator([conversation_activity])
|
|
mock_copilot_client.ask_question.return_value = create_async_generator([typing_activity])
|
|
|
|
response_count = 0
|
|
async for response in agent.run_stream("test message", thread=thread):
|
|
assert isinstance(response, AgentResponseUpdate)
|
|
content = response.contents[0]
|
|
assert content.type == "text"
|
|
assert content.text == "Streaming response"
|
|
response_count += 1
|
|
|
|
assert response_count == 1
|
|
assert thread.service_thread_id == "test-conversation-id"
|
|
|
|
async def test_run_stream_no_typing_activity(self, mock_copilot_client: MagicMock) -> None:
|
|
"""Test run_stream method with non-typing activity."""
|
|
agent = CopilotStudioAgent(client=mock_copilot_client)
|
|
|
|
conversation_activity = MagicMock()
|
|
conversation_activity.conversation.id = "test-conversation-id"
|
|
|
|
message_activity = MagicMock()
|
|
message_activity.text = "Message response"
|
|
message_activity.type = "message"
|
|
message_activity.id = "test-message-id"
|
|
|
|
mock_copilot_client.start_conversation.return_value = create_async_generator([conversation_activity])
|
|
mock_copilot_client.ask_question.return_value = create_async_generator([message_activity])
|
|
|
|
response_count = 0
|
|
async for _response in agent.run_stream("test message"):
|
|
response_count += 1
|
|
|
|
assert response_count == 0
|
|
|
|
async def test_run_multiple_activities(self, mock_copilot_client: MagicMock) -> None:
|
|
"""Test run method with multiple message activities."""
|
|
agent = CopilotStudioAgent(client=mock_copilot_client)
|
|
|
|
conversation_activity = MagicMock()
|
|
conversation_activity.conversation.id = "test-conversation-id"
|
|
|
|
activity1 = MagicMock()
|
|
activity1.text = "First response"
|
|
activity1.type = "message"
|
|
activity1.id = "test-id-1"
|
|
activity1.from_property.name = "Test Bot"
|
|
|
|
activity2 = MagicMock()
|
|
activity2.text = "Second response"
|
|
activity2.type = "message"
|
|
activity2.id = "test-id-2"
|
|
activity2.from_property.name = "Test Bot"
|
|
|
|
mock_copilot_client.start_conversation.return_value = create_async_generator([conversation_activity])
|
|
mock_copilot_client.ask_question.return_value = create_async_generator([activity1, activity2])
|
|
|
|
response = await agent.run("test message")
|
|
|
|
assert isinstance(response, AgentResponse)
|
|
assert len(response.messages) == 2
|
|
|
|
async def test_run_list_of_messages(self, mock_copilot_client: MagicMock, mock_activity: MagicMock) -> None:
|
|
"""Test run method with list of messages."""
|
|
agent = CopilotStudioAgent(client=mock_copilot_client)
|
|
|
|
conversation_activity = MagicMock()
|
|
conversation_activity.conversation.id = "test-conversation-id"
|
|
|
|
mock_copilot_client.start_conversation.return_value = create_async_generator([conversation_activity])
|
|
mock_copilot_client.ask_question.return_value = create_async_generator([mock_activity])
|
|
|
|
messages = ["Hello", "How are you?"]
|
|
response = await agent.run(messages)
|
|
|
|
assert isinstance(response, AgentResponse)
|
|
assert len(response.messages) == 1
|
|
|
|
async def test_run_stream_start_conversation_failure(self, mock_copilot_client: MagicMock) -> None:
|
|
"""Test run_stream method when conversation start fails."""
|
|
agent = CopilotStudioAgent(client=mock_copilot_client)
|
|
|
|
mock_copilot_client.start_conversation.return_value = create_async_generator([])
|
|
|
|
with pytest.raises(ServiceException, match="Failed to start a new conversation"):
|
|
async for _ in agent.run_stream("test message"):
|
|
pass
|