Spaces:
Running
Running
File size: 11,883 Bytes
4a8c120 | 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 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 | """Integration test for OpenAPI explode property handling.
This test verifies that the explode property is 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 TestExplodeIntegration:
"""Test the complete pipeline from OpenAPI spec to HTTP request parameters."""
def test_explode_false_parsing_from_openapi_spec(self):
"""Test that explode=false is correctly parsed from OpenAPI specification."""
# Real OpenAPI spec with explode: false
openapi_spec = {
"openapi": "3.1.0",
"info": {"title": "Test API", "version": "1.0.0"},
"paths": {
"/search": {
"get": {
"operationId": "search_items",
"parameters": [
{
"name": "tags",
"in": "query",
"required": False,
"style": "form",
"explode": False, # This should be respected
"schema": {
"type": "array",
"items": {"type": "string"},
},
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {"schema": {"type": "object"}}
},
}
},
}
}
},
}
# Parse the spec
routes = parse_openapi_to_http_routes(openapi_spec)
route = routes[0]
parameter = route.parameters[0]
# Verify explode property was captured correctly
assert parameter.name == "tags"
assert parameter.location == "query"
assert parameter.explode is False, (
f"Expected explode=False, got {parameter.explode}"
)
def test_explode_true_parsing_from_openapi_spec(self):
"""Test that explode=true is correctly parsed from OpenAPI specification."""
openapi_spec = {
"openapi": "3.1.0",
"info": {"title": "Test API", "version": "1.0.0"},
"paths": {
"/search": {
"get": {
"operationId": "search_items",
"parameters": [
{
"name": "tags",
"in": "query",
"explode": True, # Explicitly set to true
"schema": {
"type": "array",
"items": {"type": "string"},
},
}
],
"responses": {"200": {"description": "Success"}},
}
}
},
}
routes = parse_openapi_to_http_routes(openapi_spec)
parameter = routes[0].parameters[0]
assert parameter.explode is True, (
f"Expected explode=True, got {parameter.explode}"
)
def test_explode_default_parsing_from_openapi_spec(self):
"""Test that missing explode defaults to None during parsing."""
openapi_spec = {
"openapi": "3.1.0",
"info": {"title": "Test API", "version": "1.0.0"},
"paths": {
"/search": {
"get": {
"operationId": "search_items",
"parameters": [
{
"name": "tags",
"in": "query",
"schema": {
"type": "array",
"items": {"type": "string"},
},
# No explode property specified
}
],
"responses": {"200": {"description": "Success"}},
}
}
},
}
routes = parse_openapi_to_http_routes(openapi_spec)
parameter = routes[0].parameters[0]
assert parameter.explode is None, (
f"Expected explode=None, got {parameter.explode}"
)
async def test_explode_false_request_serialization(self):
"""Test that explode=false results in comma-separated query parameters in HTTP requests.
This is the critical integration test that would have failed before the fix.
"""
# OpenAPI spec with explode: false
openapi_spec = {
"openapi": "3.1.0",
"info": {"title": "Test API", "version": "1.0.0"},
"paths": {
"/search": {
"get": {
"operationId": "search_items",
"parameters": [
{
"name": "tags",
"in": "query",
"explode": False,
"schema": {
"type": "array",
"items": {"type": "string"},
},
}
],
"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="search_items",
description="Search items",
parameters={},
)
# Execute tool with array parameter
await tool.run({"tags": ["red", "blue", "green"]})
# Verify the HTTP request was made with comma-separated parameters
mock_client.request.assert_called_once()
call_kwargs = mock_client.request.call_args.kwargs
# Check that params contains comma-separated values, not an array
params = call_kwargs.get("params", {})
assert "tags" in params, "tags parameter should be present"
tags_value = params["tags"]
assert isinstance(tags_value, str), (
f"Expected string for explode=false, got {type(tags_value)}"
)
assert tags_value == "red,blue,green", (
f"Expected 'red,blue,green', got '{tags_value}'"
)
async def test_explode_true_request_serialization(self):
"""Test that explode=true results in separate query parameters in HTTP requests."""
openapi_spec = {
"openapi": "3.1.0",
"info": {"title": "Test API", "version": "1.0.0"},
"paths": {
"/search": {
"get": {
"operationId": "search_items",
"parameters": [
{
"name": "tags",
"in": "query",
"explode": True,
"schema": {
"type": "array",
"items": {"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="search_items",
description="Search items",
parameters={},
)
await tool.run({"tags": ["red", "blue", "green"]})
mock_client.request.assert_called_once()
call_kwargs = mock_client.request.call_args.kwargs
params = call_kwargs.get("params", {})
assert "tags" in params, "tags parameter should be present"
tags_value = params["tags"]
assert isinstance(tags_value, list), (
f"Expected list for explode=true, got {type(tags_value)}"
)
assert tags_value == ["red", "blue", "green"], (
f"Expected ['red', 'blue', 'green'], got {tags_value}"
)
async def test_explode_default_request_serialization(self):
"""Test that default behavior (no explode) uses explode=true for query parameters."""
openapi_spec = {
"openapi": "3.1.0",
"info": {"title": "Test API", "version": "1.0.0"},
"paths": {
"/search": {
"get": {
"operationId": "search_items",
"parameters": [
{
"name": "tags",
"in": "query",
"schema": {
"type": "array",
"items": {"type": "string"},
},
# No explode specified - should default to true for query params
}
],
"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="search_items",
description="Search items",
parameters={},
)
await tool.run({"tags": ["red", "blue", "green"]})
mock_client.request.assert_called_once()
call_kwargs = mock_client.request.call_args.kwargs
params = call_kwargs.get("params", {})
tags_value = params["tags"]
# Default behavior should be explode=true (separate parameters)
assert isinstance(tags_value, list), (
f"Expected list for default behavior, got {type(tags_value)}"
)
assert tags_value == ["red", "blue", "green"], (
f"Expected ['red', 'blue', 'green'], got {tags_value}"
)
|