Spaces:
Running
Running
File size: 11,112 Bytes
c21d179 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 | """Integration test for OpenAPI deepObject style parameter handling.
This test verifies that the deepObject style and explode properties are correctly
parsed from OpenAPI specifications and properly applied during HTTP request serialization.
"""
from unittest.mock import AsyncMock, MagicMock
import httpx
from fastmcp.server.openapi import OpenAPITool
from fastmcp.utilities.openapi import parse_openapi_to_http_routes
class TestDeepObjectStyle:
"""Test the complete pipeline from OpenAPI spec to HTTP request parameters for deepObject style."""
def test_deepobject_style_parsing_from_openapi_spec(self):
"""Test that deepObject style is correctly parsed from OpenAPI specification."""
# Real OpenAPI spec with style: deepObject and explode: true
openapi_spec = {
"openapi": "3.1.0",
"info": {"title": "Test API", "version": "1.0.0"},
"paths": {
"/api/surveys": {
"get": {
"operationId": "getSurveys",
"parameters": [
{
"name": "target",
"in": "query",
"required": False,
"style": "deepObject",
"explode": True,
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Valid ID for an object",
},
"type": {
"type": "string",
"enum": ["location", "organisation"],
"description": "The type of object for given id",
},
},
"required": ["type", "id"],
},
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {"schema": {"type": "integer"}}
},
}
},
}
}
},
}
# Parse the spec
routes = parse_openapi_to_http_routes(openapi_spec)
route = routes[0]
parameter = route.parameters[0]
# Verify style and explode properties were captured correctly
assert parameter.name == "target"
assert parameter.location == "query"
assert parameter.style == "deepObject", (
f"Expected style='deepObject', got {parameter.style}"
)
assert parameter.explode is True, (
f"Expected explode=True, got {parameter.explode}"
)
async def test_deepobject_style_request_serialization(self):
"""Test that deepObject style results in bracketed query parameters in HTTP requests.
This is the critical integration test that reproduces the GitHub issue.
"""
# OpenAPI spec matching the GitHub issue example
openapi_spec = {
"openapi": "3.1.0",
"info": {"title": "Test API", "version": "1.0.0"},
"paths": {
"/api/surveys": {
"get": {
"operationId": "getSurveys",
"parameters": [
{
"name": "target",
"in": "query",
"required": False,
"style": "deepObject",
"explode": True,
"schema": {
"type": "object",
"properties": {
"id": {"type": "string"},
"type": {"type": "string"},
},
"required": ["type", "id"],
},
}
],
"responses": {"200": {"description": "Success"}},
}
}
},
}
# Parse and create tool
routes = parse_openapi_to_http_routes(openapi_spec)
route = routes[0]
# Mock HTTP client
mock_client = AsyncMock(spec=httpx.AsyncClient)
mock_response = MagicMock()
mock_response.status_code = 200
mock_response.json.return_value = {}
mock_response.raise_for_status.return_value = None
mock_client.request.return_value = mock_response
# Create tool
tool = OpenAPITool(
client=mock_client,
route=route,
name="getSurveys",
description="Get surveys",
parameters={},
)
# Execute tool with object parameter (as it would come from user input)
await tool.run(
{"target": {"id": "57dc372a81b610496e8b465e", "type": "organisation"}}
)
# Verify the HTTP request was made with deepObject-style parameters
mock_client.request.assert_called_once()
call_kwargs = mock_client.request.call_args.kwargs
# Check that params contains bracketed parameters, not JSON string
params = call_kwargs.get("params", {})
# Should have target[id] and target[type] parameters
assert "target[id]" in params, "target[id] parameter should be present"
assert "target[type]" in params, "target[type] parameter should be present"
# Values should be correctly set
assert params["target[id]"] == "57dc372a81b610496e8b465e", (
f"Expected target[id]=57dc372a81b610496e8b465e, got {params.get('target[id]')}"
)
assert params["target[type]"] == "organisation", (
f"Expected target[type]=organisation, got {params.get('target[type]')}"
)
# Should NOT have the original parameter name as JSON
assert "target" not in params, (
"Original 'target' parameter should not be present when using deepObject style"
)
async def test_deepobject_style_with_explode_false(self):
"""Test that deepObject style with explode=false falls back to JSON serialization."""
openapi_spec = {
"openapi": "3.1.0",
"info": {"title": "Test API", "version": "1.0.0"},
"paths": {
"/api/surveys": {
"get": {
"operationId": "getSurveys",
"parameters": [
{
"name": "target",
"in": "query",
"style": "deepObject",
"explode": False, # Non-standard combination
"schema": {
"type": "object",
"properties": {
"id": {"type": "string"},
"type": {"type": "string"},
},
},
}
],
"responses": {"200": {"description": "Success"}},
}
}
},
}
routes = parse_openapi_to_http_routes(openapi_spec)
route = routes[0]
mock_client = AsyncMock(spec=httpx.AsyncClient)
mock_response = MagicMock()
mock_response.status_code = 200
mock_response.json.return_value = {}
mock_response.raise_for_status.return_value = None
mock_client.request.return_value = mock_response
tool = OpenAPITool(
client=mock_client,
route=route,
name="getSurveys",
description="Get surveys",
parameters={},
)
await tool.run({"target": {"id": "123", "type": "test"}})
mock_client.request.assert_called_once()
call_kwargs = mock_client.request.call_args.kwargs
params = call_kwargs.get("params", {})
# Should fall back to JSON serialization
assert "target" in params, "target parameter should be present"
assert params["target"] == '{"id": "123", "type": "test"}', (
f"Expected JSON string fallback, got {params.get('target')}"
)
async def test_non_object_with_deepobject_style(self):
"""Test that non-object parameters with deepObject style are handled gracefully."""
openapi_spec = {
"openapi": "3.1.0",
"info": {"title": "Test API", "version": "1.0.0"},
"paths": {
"/api/test": {
"get": {
"operationId": "testEndpoint",
"parameters": [
{
"name": "param",
"in": "query",
"style": "deepObject",
"explode": True,
"schema": {"type": "string"}, # Not an object
}
],
"responses": {"200": {"description": "Success"}},
}
}
},
}
routes = parse_openapi_to_http_routes(openapi_spec)
route = routes[0]
mock_client = AsyncMock(spec=httpx.AsyncClient)
mock_response = MagicMock()
mock_response.status_code = 200
mock_response.json.return_value = {}
mock_response.raise_for_status.return_value = None
mock_client.request.return_value = mock_response
tool = OpenAPITool(
client=mock_client,
route=route,
name="testEndpoint",
description="Test endpoint",
parameters={},
)
# Pass a string value instead of an object
await tool.run({"param": "test_value"})
mock_client.request.assert_called_once()
call_kwargs = mock_client.request.call_args.kwargs
params = call_kwargs.get("params", {})
# Should use the parameter as-is since it's not an object
assert "param" in params, "param parameter should be present"
assert params["param"] == "test_value", (
f"Expected 'test_value', got {params.get('param')}"
)
|