Spaces:
Running
Running
File size: 18,713 Bytes
8c5bdf2 7712403 8c5bdf2 60e47cc 8c5bdf2 60e47cc 8c5bdf2 60e47cc 7712403 8c5bdf2 60e47cc 8c5bdf2 60e47cc 7712403 8c5bdf2 | 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 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 | """Unit tests for schema processing and parameter mapping."""
import pytest
from fastmcp.experimental.utilities.openapi.models import (
HTTPRoute,
ParameterInfo,
RequestBodyInfo,
)
from fastmcp.experimental.utilities.openapi.schemas import (
_combine_schemas,
_combine_schemas_and_map_params,
_replace_ref_with_defs,
)
from fastmcp.utilities.json_schema import compress_schema
class TestSchemaProcessing:
"""Test schema processing utilities."""
@pytest.fixture
def simple_route(self):
"""Create a simple route for testing."""
return HTTPRoute(
path="/users/{id}",
method="GET",
operation_id="get_user",
parameters=[
ParameterInfo(
name="id",
location="path",
required=True,
schema={"type": "integer"},
)
],
)
@pytest.fixture
def collision_route(self):
"""Create a route with parameter name collisions."""
return HTTPRoute(
path="/users/{id}",
method="PUT",
operation_id="update_user",
parameters=[
ParameterInfo(
name="id",
location="path",
required=True,
schema={"type": "integer"},
description="User ID in path",
)
],
request_body=RequestBodyInfo(
required=True,
content_schema={
"application/json": {
"type": "object",
"properties": {
"id": {"type": "integer", "description": "User ID in body"},
"name": {"type": "string"},
"email": {"type": "string"},
},
"required": ["name"],
}
},
),
)
@pytest.fixture
def complex_route(self):
"""Create a complex route with multiple parameter types."""
return HTTPRoute(
path="/items/{id}",
method="PATCH",
operation_id="update_item",
parameters=[
ParameterInfo(
name="id",
location="path",
required=True,
schema={"type": "string"},
),
ParameterInfo(
name="version",
location="query",
required=False,
schema={"type": "integer", "default": 1},
),
ParameterInfo(
name="X-Client-Version",
location="header",
required=False,
schema={"type": "string"},
),
],
request_body=RequestBodyInfo(
required=True,
content_schema={
"application/json": {
"type": "object",
"properties": {
"title": {"type": "string"},
"description": {"type": "string"},
"tags": {
"type": "array",
"items": {"type": "string"},
},
},
"required": ["title"],
}
},
),
)
def test_combine_schemas_simple(self, simple_route):
"""Test combining schemas for a simple route."""
combined_schema = _combine_schemas(simple_route)
assert combined_schema["type"] == "object"
assert "properties" in combined_schema
properties = combined_schema["properties"]
assert "id" in properties
assert properties["id"]["type"] == "integer"
required = combined_schema.get("required", [])
assert "id" in required
def test_combine_schemas_with_collisions(self, collision_route):
"""Test combining schemas with parameter name collisions."""
combined_schema = _combine_schemas(collision_route)
assert combined_schema["type"] == "object"
properties = combined_schema["properties"]
# Should handle collision by suffixing
id_params = [key for key in properties.keys() if "id" in key]
assert len(id_params) >= 2 # Should have both path and body id
# Should have other body parameters
assert "name" in properties
assert "email" in properties
def test_combine_schemas_complex(self, complex_route):
"""Test combining schemas for complex route."""
combined_schema = _combine_schemas(complex_route)
properties = combined_schema["properties"]
# Should have path parameter
assert "id" in properties
# Should have query parameter
assert "version" in properties
assert properties["version"].get("default") == 1
# Should have header parameter
assert "X-Client-Version" in properties
# Should have body parameters
assert "title" in properties
assert "description" in properties
assert "tags" in properties
# Check required fields
required = combined_schema.get("required", [])
assert "id" in required # Path parameters are required
assert "title" in required # Required body parameter
def test_combine_schemas_and_map_params_simple(self, simple_route):
"""Test combining schemas and creating parameter map."""
combined_schema, param_map = _combine_schemas_and_map_params(simple_route)
# Check schema
assert combined_schema["type"] == "object"
assert "id" in combined_schema["properties"]
# Check parameter map
assert len(param_map) == 1
assert "id" in param_map
assert param_map["id"]["location"] == "path"
assert param_map["id"]["openapi_name"] == "id"
def test_combine_schemas_and_map_params_with_collisions(self, collision_route):
"""Test parameter mapping with collisions."""
combined_schema, param_map = _combine_schemas_and_map_params(collision_route)
# Check that we have entries for both conflicting parameters
path_id_key = None
body_id_key = None
for key, mapping in param_map.items():
if mapping["location"] == "path" and mapping["openapi_name"] == "id":
path_id_key = key
elif mapping["location"] == "body" and mapping["openapi_name"] == "id":
body_id_key = key
assert path_id_key is not None
assert body_id_key is not None
assert path_id_key != body_id_key # Should be different keys
# Both should exist in schema
assert path_id_key in combined_schema["properties"]
assert body_id_key in combined_schema["properties"]
# Should also have non-conflicting parameters
assert "name" in param_map
assert "email" in param_map
def test_combine_schemas_and_map_params_complex(self, complex_route):
"""Test parameter mapping for complex route."""
combined_schema, param_map = _combine_schemas_and_map_params(complex_route)
# Should have all parameters mapped
actual_locations = {mapping["location"] for mapping in param_map.values()}
# Should have representatives from each location
assert "path" in actual_locations
assert "body" in actual_locations
# May or may not have query/header depending on whether they're included
# Check specific mappings
id_mapping = param_map["id"]
assert id_mapping["location"] == "path"
assert id_mapping["openapi_name"] == "id"
title_mapping = param_map["title"]
assert title_mapping["location"] == "body"
assert title_mapping["openapi_name"] == "title"
def test_replace_ref_with_defs(self):
"""Test replacing $ref with $defs for JSON Schema compatibility."""
schema_with_ref = {
"type": "object",
"properties": {
"user": {"$ref": "#/components/schemas/User"},
"items": {
"type": "array",
"items": {"$ref": "#/components/schemas/Item"},
},
},
}
# Use our recursive replacement approach
result = _replace_ref_with_defs(schema_with_ref)
assert result["properties"]["user"]["$ref"] == "#/$defs/User"
assert result["properties"]["items"]["items"]["$ref"] == "#/$defs/Item"
def test_replace_ref_with_defs_nested(self):
"""Test replacing $ref in deeply nested structures."""
nested_schema = {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"nested": {"$ref": "#/components/schemas/Nested"},
},
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ref_prop": {"$ref": "#/components/schemas/RefProp"},
},
},
},
},
}
# Use our recursive replacement approach
result = _replace_ref_with_defs(nested_schema)
# Check nested object property
nested_prop = result["properties"]["data"]["properties"]["nested"]
assert nested_prop["$ref"] == "#/$defs/Nested"
# Check array item property
array_item_prop = result["properties"]["items"]["items"]["properties"][
"ref_prop"
]
assert array_item_prop["$ref"] == "#/$defs/RefProp"
def test_parameter_collision_suffixing_logic(self):
"""Test the specific logic for parameter collision suffixing."""
# Create a route that would definitely cause collisions
route = HTTPRoute(
path="/test/{id}",
method="POST",
operation_id="test_collision",
parameters=[
ParameterInfo(
name="id", location="path", required=True, schema={"type": "string"}
),
ParameterInfo(
name="name",
location="query",
required=False,
schema={"type": "string"},
),
ParameterInfo(
name="name",
location="header",
required=False,
schema={"type": "string"},
),
],
request_body=RequestBodyInfo(
required=True,
content_schema={
"application/json": {
"type": "object",
"properties": {
"id": {"type": "integer"},
"name": {"type": "string"},
"description": {"type": "string"},
},
}
},
),
)
combined_schema, param_map = _combine_schemas_and_map_params(route)
# Check that all parameters are included with unique keys
param_keys = list(param_map.keys())
assert len(param_keys) == len(set(param_keys)) # All keys should be unique
# Should have some form of id and name parameters
id_keys = [key for key in param_keys if "id" in key]
name_keys = [key for key in param_keys if "name" in key]
assert len(id_keys) >= 2 # Path id and body id
assert len(name_keys) >= 3 # Query name, header name, and body name
# Check that locations are correctly mapped
path_params = [
key for key, mapping in param_map.items() if mapping["location"] == "path"
]
query_params = [
key for key, mapping in param_map.items() if mapping["location"] == "query"
]
header_params = [
key for key, mapping in param_map.items() if mapping["location"] == "header"
]
body_params = [
key for key, mapping in param_map.items() if mapping["location"] == "body"
]
assert len(path_params) == 1
assert len(query_params) == 1
assert len(header_params) == 1
assert len(body_params) >= 3 # id, name, description from body
class TestEdgeCases:
"""Test edge cases in schema processing."""
def test_empty_route(self):
"""Test schema processing with empty route."""
empty_route = HTTPRoute(
path="/empty",
method="GET",
operation_id="empty_op",
parameters=[],
)
combined_schema = _combine_schemas(empty_route)
assert combined_schema["type"] == "object"
assert combined_schema["properties"] == {}
assert combined_schema.get("required", []) == []
def test_route_without_request_body(self):
"""Test route with only parameters, no request body."""
route = HTTPRoute(
path="/test/{id}",
method="GET",
operation_id="test_get",
parameters=[
ParameterInfo(
name="id", location="path", required=True, schema={"type": "string"}
),
ParameterInfo(
name="filter",
location="query",
required=False,
schema={"type": "string"},
),
],
)
combined_schema, param_map = _combine_schemas_and_map_params(route)
assert "id" in combined_schema["properties"]
assert "filter" in combined_schema["properties"]
assert len(param_map) == 2
def test_route_with_only_request_body(self):
"""Test route with only request body, no parameters."""
route = HTTPRoute(
path="/create",
method="POST",
operation_id="create_item",
parameters=[],
request_body=RequestBodyInfo(
required=True,
content_schema={
"application/json": {
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
},
"required": ["name"],
}
},
),
)
combined_schema, param_map = _combine_schemas_and_map_params(route)
assert "name" in combined_schema["properties"]
assert "description" in combined_schema["properties"]
assert "name" in combined_schema["required"]
assert len(param_map) == 2
def test_parameter_without_schema(self):
"""Test handling parameters without schema."""
# Use minimal schema to avoid validation error
route = HTTPRoute(
path="/test",
method="GET",
operation_id="test_no_schema",
parameters=[
ParameterInfo(
name="param1", location="query", required=False, schema={}
), # Empty schema
],
)
combined_schema, param_map = _combine_schemas_and_map_params(route)
# Should handle gracefully
assert combined_schema["type"] == "object"
assert isinstance(param_map, dict)
def test_request_body_multiple_content_types(self):
"""Test request body with multiple content types."""
route = HTTPRoute(
path="/upload",
method="POST",
operation_id="upload_file",
request_body=RequestBodyInfo(
required=True,
content_schema={
"application/json": {
"type": "object",
"properties": {"metadata": {"type": "string"}},
},
"multipart/form-data": {
"type": "object",
"properties": {"file": {"type": "string", "format": "binary"}},
},
},
),
)
combined_schema, param_map = _combine_schemas_and_map_params(route)
# Should use the first content type found
properties = combined_schema["properties"]
assert (
len(properties) > 0
) # Should have some properties from one of the content types
def test_oneof_reference_preserved(self):
"""Test that schemas referenced in oneOf are preserved."""
schema = {
"type": "object",
"properties": {"data": {"oneOf": [{"$ref": "#/$defs/TestSchema"}]}},
"$defs": {
"TestSchema": {"type": "string"},
"UnusedSchema": {"type": "number"},
},
}
result = compress_schema(schema)
# TestSchema should be preserved (referenced in oneOf)
assert "TestSchema" in result["$defs"]
# UnusedSchema should be removed
assert "UnusedSchema" not in result["$defs"]
def test_anyof_reference_preserved(self):
"""Test that schemas referenced in anyOf are preserved."""
schema = {
"type": "object",
"properties": {"data": {"anyOf": [{"$ref": "#/$defs/TestSchema"}]}},
"$defs": {
"TestSchema": {"type": "string"},
"UnusedSchema": {"type": "number"},
},
}
result = compress_schema(schema)
assert "TestSchema" in result["$defs"]
assert "UnusedSchema" not in result["$defs"]
def test_allof_reference_preserved(self):
"""Test that schemas referenced in allOf are preserved."""
schema = {
"type": "object",
"properties": {"data": {"allOf": [{"$ref": "#/$defs/TestSchema"}]}},
"$defs": {
"TestSchema": {"type": "string"},
"UnusedSchema": {"type": "number"},
},
}
result = compress_schema(schema)
assert "TestSchema" in result["$defs"]
assert "UnusedSchema" not in result["$defs"]
|