Skip to content

Fix HttpTool serialization in StaticStreamWorkbench (Issue #7172) #7189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aabhathanki wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix HttpTool serialization in StaticStreamWorkbench (Issue #7172) #7189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion python/packages/autogen-ext/src/autogen_ext/tools/http/_http_tool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class HttpToolConfig(BaseModel):
"""
The HTTP method to use, will default to POST if not provided.
"""
headers: Optional[dict[str, Any]]
headers: Optional[dict[str, Any]] = None
"""
A dictionary of headers to send with the request.
"""
Expand Down
91 changes: 91 additions & 0 deletions python/packages/autogen-ext/tests/tools/test_http_tool_serialization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
"""Tests for HttpTool serialization and deserialization (Issue #7172)"""

import pytest
from autogen_core.tools import StaticStreamWorkbench
from autogen_ext.tools.http import HttpTool


@pytest.mark.asyncio
async def test_httptool_config_serialization():
"""Test HttpTool can be serialized and deserialized directly"""
tool = HttpTool(
name="test_tool",
description="test description",
scheme="https",
host="httpbin.org",
port=443,
path="/get",
method="GET",
json_schema={"type": "object", "properties": {}},
headers={"Authorization": "Bearer test", "Custom-Header": "value"},
)

# Serialize
config = tool._to_config()

# Deserialize
restored_tool = HttpTool._from_config(config)

# Verify all fields are preserved
assert restored_tool.name == tool.name
assert restored_tool.server_params.headers == tool.server_params.headers
assert restored_tool.server_params.host == tool.server_params.host
assert restored_tool.server_params.port == tool.server_params.port


@pytest.mark.asyncio
async def test_httptool_serialization_without_headers():
"""Test HttpTool serialization works when headers is None"""
tool = HttpTool(
name="test_tool_no_headers",
description="test without headers",
scheme="https",
host="httpbin.org",
port=443,
path="/get",
method="GET",
json_schema={"type": "object", "properties": {}},
# headers not provided (defaults to None)
)

# Serialize and deserialize
config = tool._to_config()
restored_tool = HttpTool._from_config(config)

# Verify headers is None
assert restored_tool.server_params.headers is None


@pytest.mark.asyncio
async def test_static_workbench_httptool_serialization():
"""Test StaticStreamWorkbench can save/load with HttpTool (Issue #7172)"""
tool = HttpTool(
name="base64_decode",
description="base64 decode a value",
scheme="https",
host="httpbin.org",
port=443,
path="/base64/{value}",
method="GET",
json_schema={
"type": "object",
"properties": {
"value": {"type": "string", "description": "The base64 value to decode"},
},
"required": ["value"],
},
)

# Create workbench
workbench = StaticStreamWorkbench(tools=[tool])

# Serialize config
config = workbench._to_config()

# This should not raise validation error (was failing before fix)
new_workbench = StaticStreamWorkbench._from_config(config)

# Verify workbench works
tools = await new_workbench.list_tools()
assert len(tools) == 1
assert tools[0]["name"] == "base64_decode"