wehub/agentscope-ai--agentscope
1
0
Fork 0
Code Issues Pull Requests Actions Deployments Models Agent Notes Packages Projects Releases Wiki Activity
Files
main
agentscope-ai--agentscope/tests/formatter_openai_chat_test.py
T
wehub-resource-sync c3bf08ac8d
K8s Workspace Integration Tests / k8s-workspace-tests (push) Has been cancelled
Details
Pre-commit / run (ubuntu-latest) (push) Has been cancelled
Details
Python Unittest Coverage / test (macos-15, 3.11) (push) Has been cancelled
Details
Python Unittest Coverage / test (ubuntu-latest, 3.11) (push) Has been cancelled
Details
Python Unittest Coverage / test (windows-latest, 3.11) (push) Has been cancelled
Details
Web UI / check (push) Has been cancelled
Details
chore: import upstream snapshot with attribution
2026-07-13 12:39:27 +08:00

773 lines
26 KiB
Python
Raw Permalink Blame History

# -*- coding: utf-8 -*-
"""Comprehensive formatter unit tests for OpenAIChatFormatter and
OpenAIMultiAgentFormatter, following the reference test style with exact
ground-truth comparisons.
"""
from unittest import IsolatedAsyncioTestCase
from unittest.mock import patch
from agentscope.formatter import (
OpenAIChatFormatter,
OpenAIMultiAgentFormatter,
)
from agentscope.message import (
UserMsg,
AssistantMsg,
SystemMsg,
TextBlock,
DataBlock,
ToolCallBlock,
ToolResultBlock,
ToolResultState,
Base64Source,
URLSource,
ThinkingBlock,
HintBlock,
)
_FIXED_ID = "TESTID1234567"
class TestOpenAIFormatter(IsolatedAsyncioTestCase):
"""Comprehensive tests for OpenAI Chat and MultiAgent formatters."""
async def asyncSetUp(self) -> None:
"""Set up shared message fixtures and expected ground-truth dicts."""
_img_src = URLSource(
url="https://example.com/image.png",
media_type="image/png",
)
self.image_url = str(_img_src.url)
self.image_b64 = "ZmFrZSBpbWFnZSBkYXRh"
self.image_data_uri = f"data:image/png;base64,{self.image_b64}"
# ---------------------------------------------------------------
# Message fixtures
# (No audio in conversation: OpenAI URL audio requires a download)
# ---------------------------------------------------------------
self.msgs_system = [
SystemMsg(
name="system",
content="You're a helpful assistant.",
),
]
self.msgs_conversation = [
UserMsg(
name="user",
content=[
TextBlock(text="What is the capital of France?"),
DataBlock(
source=URLSource(
url=self.image_url,
media_type="image/png",
),
),
],
),
AssistantMsg(
name="assistant",
content="The capital of France is Paris.",
),
UserMsg(
name="user",
content="What is the capital of Germany?",
),
AssistantMsg(
name="assistant",
content="The capital of Germany is Berlin.",
),
UserMsg(
name="user",
content="What is the capital of Japan?",
),
]
self.msgs_tools = [
AssistantMsg(
name="assistant",
content=[
ToolCallBlock(
id="call_1",
name="get_capital",
input='{"country": "Japan"}',
),
ToolResultBlock(
id="call_1",
name="get_capital",
output=[
TextBlock(text="The capital of Japan is Tokyo."),
],
state=ToolResultState.SUCCESS,
),
TextBlock(text="The capital of Japan is Tokyo."),
],
),
]
# ---------------------------------------------------------------
# Ground truth: OpenAIChatFormatter
# - Content is a list of {"type": ..., ...} dicts.
# - Tool-result content is a plain string.
# - Messages have a "name" field.
# ---------------------------------------------------------------
self.gt_chat = [
{
"role": "system",
"name": "system",
"content": [
{"type": "text", "text": "You're a helpful assistant."},
],
},
{
"role": "user",
"name": "user",
"content": [
{"type": "text", "text": "What is the capital of France?"},
{
"type": "image_url",
"image_url": {"url": self.image_url},
},
],
},
{
"role": "assistant",
"name": "assistant",
"content": [
{
"type": "text",
"text": "The capital of France is Paris.",
},
],
},
{
"role": "user",
"name": "user",
"content": [
{
"type": "text",
"text": "What is the capital of Germany?",
},
],
},
{
"role": "assistant",
"name": "assistant",
"content": [
{
"type": "text",
"text": "The capital of Germany is Berlin.",
},
],
},
{
"role": "user",
"name": "user",
"content": [
{"type": "text", "text": "What is the capital of Japan?"},
],
},
{
"role": "assistant",
"name": "assistant",
"content": None,
"tool_calls": [
{
"id": "call_1",
"type": "function",
"function": {
"name": "get_capital",
"arguments": '{"country": "Japan"}',
},
},
],
},
{
"role": "tool",
"tool_call_id": "call_1",
"content": "The capital of Japan is Tokyo.",
"name": "get_capital",
},
{
"role": "assistant",
"name": "assistant",
"content": [
{
"type": "text",
"text": "The capital of Japan is Tokyo.",
},
],
},
]
# ---------------------------------------------------------------
# Ground truth: OpenAIMultiAgentFormatter
# - System content is a plain string.
# - All conversation text is collapsed into a single text block,
# with media blocks appended after.
# - No "name" field on the user wrapper message.
# ---------------------------------------------------------------
_hist_prompt = OpenAIMultiAgentFormatter().conversation_history_prompt
_conv_text = (
"user: What is the capital of France?\n"
"assistant: The capital of France is Paris.\n"
"user: What is the capital of Germany?\n"
"assistant: The capital of Germany is Berlin.\n"
"user: What is the capital of Japan?"
)
self._gt_trailing_asst = {
"role": "assistant",
"name": "assistant",
"content": [
{
"type": "text",
"text": "The capital of Japan is Tokyo.",
},
],
}
self._gt_tool_call = {
"role": "assistant",
"name": "assistant",
"content": None,
"tool_calls": [
{
"id": "call_1",
"type": "function",
"function": {
"name": "get_capital",
"arguments": '{"country": "Japan"}',
},
},
],
}
self._gt_tool_result = {
"role": "tool",
"tool_call_id": "call_1",
"content": "The capital of Japan is Tokyo.",
"name": "get_capital",
}
self.gt_multiagent = [
{
"role": "system",
"content": "You're a helpful assistant.",
},
{
"role": "user",
"content": [
{
"type": "text",
"text": (
_hist_prompt
+ "<history>\n"
+ _conv_text
+ "\n</history>"
),
},
{
"type": "image_url",
"image_url": {"url": self.image_url},
},
],
},
self._gt_tool_call,
self._gt_tool_result,
self._gt_trailing_asst,
]
# -------------------------------------------------------------------
# OpenAIChatFormatter tests
# -------------------------------------------------------------------
async def test_chat_formatter(self) -> None:
"""Chat formatter produces exact output for various subsets."""
fmt = OpenAIChatFormatter()
# Full history
res = await fmt.format(
[*self.msgs_system, *self.msgs_conversation, *self.msgs_tools],
)
self.assertListEqual(self.gt_chat, res)
# Without system
res = await fmt.format([*self.msgs_conversation, *self.msgs_tools])
self.assertListEqual(self.gt_chat[1:], res)
# Without conversation
n_tools_gt = len(self.gt_chat) - 1 - len(self.msgs_conversation)
res = await fmt.format([*self.msgs_system, *self.msgs_tools])
self.assertListEqual(
[self.gt_chat[0]] + self.gt_chat[-n_tools_gt:],
res,
)
# Without tools
res = await fmt.format([*self.msgs_system, *self.msgs_conversation])
self.assertListEqual(self.gt_chat[:-n_tools_gt], res)
# Empty
res = await fmt.format([])
self.assertListEqual([], res)
async def test_chat_formatter_base64_image(self) -> None:
"""Base64-encoded image is inlined as a data URI."""
fmt = OpenAIChatFormatter()
msgs = [
UserMsg(
name="user",
content=[
TextBlock(text="What's in this image?"),
DataBlock(
source=Base64Source(
data=self.image_b64,
media_type="image/png",
),
),
],
),
]
res = await fmt.format(msgs)
self.assertListEqual(
[
{
"role": "user",
"name": "user",
"content": [
{"type": "text", "text": "What's in this image?"},
{
"type": "image_url",
"image_url": {"url": self.image_data_uri},
},
],
},
],
res,
)
async def test_chat_formatter_thinking_dropped(self) -> None:
"""ThinkingBlock is silently dropped by OpenAI formatter."""
fmt = OpenAIChatFormatter()
msgs = [
AssistantMsg(
name="assistant",
content=[
ThinkingBlock(thinking="inner thoughts"),
TextBlock(text="reply"),
],
),
]
res = await fmt.format(msgs)
self.assertListEqual(
[
{
"role": "assistant",
"name": "assistant",
"content": [{"type": "text", "text": "reply"}],
},
],
res,
)
@patch(
"agentscope.formatter._formatter_base.shortuuid.uuid",
return_value=_FIXED_ID,
)
async def test_chat_formatter_url_image_in_tool_result(
self,
_mock_uuid: object,
) -> None:
"""URL images in tool results are promoted to a follow-up user
message."""
fmt = OpenAIChatFormatter()
msgs = [
AssistantMsg(
name="assistant",
content=[
ToolCallBlock(
id="call_img",
name="get_map",
input='{"city": "Tokyo"}',
),
ToolResultBlock(
id="call_img",
name="get_map",
output=[
TextBlock(text="Here is the map."),
DataBlock(
source=URLSource(
url=self.image_url,
media_type="image/png",
),
),
],
state=ToolResultState.SUCCESS,
),
TextBlock(text="Here is the map of Tokyo."),
],
),
]
res = await fmt.format(msgs)
expected_tool_content = (
"Here is the map.\n"
f"<system-reminder>A(n) image file is returned "
f"and will be presented to you with the identifier "
f"[{_FIXED_ID}].</system-reminder>"
)
self.assertListEqual(
[
{
"role": "assistant",
"name": "assistant",
"content": None,
"tool_calls": [
{
"id": "call_img",
"type": "function",
"function": {
"name": "get_map",
"arguments": '{"city": "Tokyo"}',
},
},
],
},
{
"role": "tool",
"tool_call_id": "call_img",
"content": expected_tool_content,
"name": "get_map",
},
{
"role": "user",
"name": "system-reminder",
"content": [
{
"type": "text",
"text": (
"<system-reminder>The multimodal data "
"and their identifiers are listed as "
"follows:"
),
},
{
"type": "text",
"text": f"- {_FIXED_ID} (image file): ",
},
{
"type": "image_url",
"image_url": {"url": self.image_url},
},
{
"type": "text",
"text": "</system-reminder>",
},
],
},
{
"role": "assistant",
"name": "assistant",
"content": [
{
"type": "text",
"text": "Here is the map of Tokyo.",
},
],
},
],
res,
)
# -------------------------------------------------------------------
# OpenAIMultiAgentFormatter tests
# -------------------------------------------------------------------
async def test_multiagent_formatter(self) -> None:
"""MultiAgent formatter produces exact output for various subsets."""
fmt = OpenAIMultiAgentFormatter()
# Full history
res = await fmt.format(
[*self.msgs_system, *self.msgs_conversation, *self.msgs_tools],
)
self.assertListEqual(self.gt_multiagent, res)
# Without system
res = await fmt.format([*self.msgs_conversation, *self.msgs_tools])
self.assertListEqual(self.gt_multiagent[1:], res)
# Without tools
res = await fmt.format([*self.msgs_system, *self.msgs_conversation])
self.assertListEqual(self.gt_multiagent[:2], res)
# System only
res = await fmt.format(self.msgs_system)
self.assertListEqual([self.gt_multiagent[0]], res)
# Conversation only
res = await fmt.format(self.msgs_conversation)
self.assertListEqual([self.gt_multiagent[1]], res)
# Tools only
res = await fmt.format(self.msgs_tools)
self.assertListEqual(
[
self._gt_tool_call,
self._gt_tool_result,
self._gt_trailing_asst,
],
res,
)
# System + tools (no conversation)
res = await fmt.format([*self.msgs_system, *self.msgs_tools])
self.assertListEqual(
[
self.gt_multiagent[0],
self._gt_tool_call,
self._gt_tool_result,
self._gt_trailing_asst,
],
res,
)
# Empty
res = await fmt.format([])
self.assertListEqual([], res)
async def test_chat_formatter_complex_multi_step(self) -> None:
"""Complex multi-step sequence with interleaved thinking, text,
tool calls, and tool results."""
fmt = OpenAIChatFormatter()
msgs = [
AssistantMsg(
name="assistant",
content=[
ThinkingBlock(thinking="thinking_1"),
TextBlock(text="text_1"),
ToolCallBlock(
id="call_1",
name="func_1",
input='{"arg": "value1"}',
),
ToolCallBlock(
id="call_2",
name="func_2",
input='{"arg": "value2"}',
),
ToolResultBlock(
id="call_1",
name="func_1",
output=[TextBlock(text="result_1")],
state=ToolResultState.SUCCESS,
),
ToolResultBlock(
id="call_2",
name="func_2",
output=[TextBlock(text="result_2")],
state=ToolResultState.SUCCESS,
),
ThinkingBlock(thinking="thinking_2"),
TextBlock(text="text_2"),
ToolCallBlock(
id="call_3",
name="func_3",
input='{"arg": "value3"}',
),
ToolResultBlock(
id="call_3",
name="func_3",
output=[TextBlock(text="result_3")],
state=ToolResultState.SUCCESS,
),
ToolCallBlock(
id="call_4",
name="func_4",
input='{"arg": "value4"}',
),
ToolResultBlock(
id="call_4",
name="func_4",
output=[TextBlock(text="result_4")],
state=ToolResultState.SUCCESS,
),
ThinkingBlock(thinking="thinking_3"),
TextBlock(text="text_3"),
],
),
]
res = await fmt.format(msgs)
self.assertListEqual(
[
{
"role": "assistant",
"name": "assistant",
"content": [{"type": "text", "text": "text_1"}],
"tool_calls": [
{
"id": "call_1",
"type": "function",
"function": {
"name": "func_1",
"arguments": '{"arg": "value1"}',
},
},
{
"id": "call_2",
"type": "function",
"function": {
"name": "func_2",
"arguments": '{"arg": "value2"}',
},
},
],
},
{
"role": "tool",
"tool_call_id": "call_1",
"content": "result_1",
"name": "func_1",
},
{
"role": "tool",
"tool_call_id": "call_2",
"content": "result_2",
"name": "func_2",
},
{
"role": "assistant",
"name": "assistant",
"content": [{"type": "text", "text": "text_2"}],
"tool_calls": [
{
"id": "call_3",
"type": "function",
"function": {
"name": "func_3",
"arguments": '{"arg": "value3"}',
},
},
],
},
{
"role": "tool",
"tool_call_id": "call_3",
"content": "result_3",
"name": "func_3",
},
{
"role": "assistant",
"name": "assistant",
"content": None,
"tool_calls": [
{
"id": "call_4",
"type": "function",
"function": {
"name": "func_4",
"arguments": '{"arg": "value4"}',
},
},
],
},
{
"role": "tool",
"tool_call_id": "call_4",
"content": "result_4",
"name": "func_4",
},
{
"role": "assistant",
"name": "assistant",
"content": [{"type": "text", "text": "text_3"}],
},
],
res,
)
async def test_chat_formatter_hint_block(self) -> None:
"""HintBlock flushes preceding content and becomes a user message."""
fmt = OpenAIChatFormatter()
msgs = [
AssistantMsg(
name="assistant",
content=[
TextBlock(text="Let me think about that."),
HintBlock(hint="Remember to be concise."),
TextBlock(text="Here is my answer."),
],
),
]
res = await fmt.format(msgs)
self.assertListEqual(
[
{
"role": "assistant",
"name": "assistant",
"content": [
{"type": "text", "text": "Let me think about that."},
],
},
{
"role": "user",
"content": [
{"type": "text", "text": "Remember to be concise."},
],
},
{
"role": "assistant",
"name": "assistant",
"content": [
{"type": "text", "text": "Here is my answer."},
],
},
],
res,
)
async def test_chat_formatter_hint_block_multimodal(self) -> None:
"""Multimodal HintBlock becomes a single user message with text +
image."""
fmt = OpenAIChatFormatter()
msgs = [
AssistantMsg(
name="assistant",
content=[
HintBlock(
hint=[
TextBlock(text="Inspect this screenshot:"),
DataBlock(
source=Base64Source(
data=self.image_b64,
media_type="image/png",
),
),
],
),
],
),
]
res = await fmt.format(msgs)
self.assertListEqual(
[
{
"role": "user",
"content": [
{
"type": "text",
"text": "Inspect this screenshot:",
},
{
"type": "image_url",
"image_url": {"url": self.image_data_uri},
},
],
},
],
res,
)
Reference in New Issue View Git Blame Copy Permalink