Spaces:
Running
Running
File size: 30,069 Bytes
c151bc3 a4d699c c151bc3 5057c7c df0a1cf 5057c7c | 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 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 | import json
import httpx
import pytest
from pydantic.networks import AnyUrl
from fastmcp import FastMCP
from fastmcp.client import Client
from fastmcp.server.openapi import FastMCPOpenAPI
from fastmcp.utilities.openapi import parse_openapi_to_http_routes
from .conftest import GET_ROUTE_MAPS
class TestOpenAPI30Compatibility:
"""Tests for compatibility with OpenAPI 3.0 specifications."""
@pytest.fixture
def openapi_30_spec(self) -> dict:
"""Fixture that returns a simple OpenAPI 3.0 specification."""
return {
"openapi": "3.0.0",
"info": {"title": "Product API (3.0)", "version": "1.0.0"},
"paths": {
"/products": {
"get": {
"operationId": "listProducts",
"summary": "List all products",
"responses": {"200": {"description": "A list of products"}},
},
"post": {
"operationId": "createProduct",
"summary": "Create a new product",
"requestBody": {
"required": True,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {"type": "string"},
"price": {"type": "number"},
},
"required": ["name", "price"],
}
}
},
},
"responses": {"201": {"description": "Product created"}},
},
},
"/products/{product_id}": {
"get": {
"operationId": "getProduct",
"summary": "Get product by ID",
"parameters": [
{
"name": "product_id",
"in": "path",
"required": True,
"schema": {"type": "string"},
}
],
"responses": {"200": {"description": "A product"}},
}
},
},
}
@pytest.fixture
async def mock_30_client(self) -> httpx.AsyncClient:
"""Mock client that returns predefined responses for the 3.0 API."""
async def _responder(request):
if request.url.path == "/products" and request.method == "GET":
return httpx.Response(
200,
json=[
{"id": "p1", "name": "Product 1", "price": 19.99},
{"id": "p2", "name": "Product 2", "price": 29.99},
],
)
elif request.url.path == "/products" and request.method == "POST":
data = json.loads(request.content)
return httpx.Response(
201, json={"id": "p3", "name": data["name"], "price": data["price"]}
)
elif request.url.path.startswith("/products/") and request.method == "GET":
product_id = request.url.path.split("/")[-1]
products = {
"p1": {"id": "p1", "name": "Product 1", "price": 19.99},
"p2": {"id": "p2", "name": "Product 2", "price": 29.99},
}
if product_id in products:
return httpx.Response(200, json=products[product_id])
return httpx.Response(404, json={"error": "Product not found"})
return httpx.Response(404)
transport = httpx.MockTransport(_responder)
return httpx.AsyncClient(transport=transport, base_url="http://test")
@pytest.fixture
async def openapi_30_server_with_all_types(
self, openapi_30_spec, mock_30_client
) -> FastMCPOpenAPI:
"""Create a FastMCPOpenAPI server from the OpenAPI 3.0 spec."""
return FastMCPOpenAPI(
openapi_spec=openapi_30_spec,
client=mock_30_client,
name="Product API 3.0",
route_maps=GET_ROUTE_MAPS,
)
async def test_server_creation(self, openapi_30_server_with_all_types):
"""Test that a server can be created from an OpenAPI 3.0 spec."""
assert isinstance(openapi_30_server_with_all_types, FastMCP)
assert openapi_30_server_with_all_types.name == "Product API 3.0"
async def test_resource_discovery(self, openapi_30_server_with_all_types):
"""Test that resources are correctly discovered from an OpenAPI 3.0 spec."""
async with Client(openapi_30_server_with_all_types) as client:
resources = await client.list_resources()
assert len(resources) == 1
assert resources[0].uri == AnyUrl("resource://listProducts")
async def test_resource_template_discovery(self, openapi_30_server_with_all_types):
"""Test that resource templates are correctly discovered from an OpenAPI 3.0 spec."""
async with Client(openapi_30_server_with_all_types) as client:
templates = await client.list_resource_templates()
assert len(templates) == 1
assert templates[0].name == "getProduct"
assert templates[0].uriTemplate == r"resource://getProduct/{product_id}"
async def test_tool_discovery(self, openapi_30_server_with_all_types):
"""Test that tools are correctly discovered from an OpenAPI 3.0 spec."""
async with Client(openapi_30_server_with_all_types) as client:
tools = await client.list_tools()
assert len(tools) == 1
assert tools[0].name == "createProduct"
assert "name" in tools[0].inputSchema["properties"]
assert "price" in tools[0].inputSchema["properties"]
async def test_resource_access(self, openapi_30_server_with_all_types):
"""Test reading a resource from an OpenAPI 3.0 server."""
async with Client(openapi_30_server_with_all_types) as client:
resource_response = await client.read_resource("resource://listProducts")
response_text = resource_response[0].text # type: ignore[attr-defined]
content = json.loads(response_text)
assert len(content) == 2
assert content[0]["name"] == "Product 1"
assert content[1]["name"] == "Product 2"
async def test_resource_template_access(self, openapi_30_server_with_all_types):
"""Test reading a resource from template from an OpenAPI 3.0 server."""
async with Client(openapi_30_server_with_all_types) as client:
resource_response = await client.read_resource("resource://getProduct/p1")
response_text = resource_response[0].text # type: ignore[attr-defined]
content = json.loads(response_text)
assert content["id"] == "p1"
assert content["name"] == "Product 1"
assert content["price"] == 19.99
async def test_tool_execution(self, openapi_30_server_with_all_types):
"""Test executing a tool from an OpenAPI 3.0 server."""
async with Client(openapi_30_server_with_all_types) as client:
result = await client.call_tool(
"createProduct", {"name": "New Product", "price": 39.99}
)
# Result should be a text content
assert len(result.content) == 1
product = json.loads(result.content[0].text) # type: ignore[attr-defined]
assert product["id"] == "p3"
assert product["name"] == "New Product"
assert product["price"] == 39.99
assert result.structured_content is not None
assert result.structured_content["id"] == "p3"
assert result.structured_content["name"] == "New Product"
assert result.structured_content["price"] == 39.99
assert result.data is not None
assert result.data["id"] == "p3"
assert result.data["name"] == "New Product"
assert result.data["price"] == 39.99
class TestOpenAPI31Compatibility:
"""Tests for compatibility with OpenAPI 3.1 specifications."""
@pytest.fixture
def openapi_31_spec(self) -> dict:
"""Fixture that returns a simple OpenAPI 3.1 specification."""
return {
"openapi": "3.1.0",
"info": {"title": "Order API (3.1)", "version": "1.0.0"},
"paths": {
"/orders": {
"get": {
"operationId": "listOrders",
"summary": "List all orders",
"responses": {"200": {"description": "A list of orders"}},
},
"post": {
"operationId": "createOrder",
"summary": "Place a new order",
"requestBody": {
"required": True,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"customer": {"type": "string"},
"items": {
"type": "array",
"items": {"type": "string"},
},
},
"required": ["customer", "items"],
}
}
},
},
"responses": {"201": {"description": "Order created"}},
},
},
"/orders/{order_id}": {
"get": {
"operationId": "getOrder",
"summary": "Get order by ID",
"parameters": [
{
"name": "order_id",
"in": "path",
"required": True,
"schema": {"type": "string"},
}
],
"responses": {"200": {"description": "An order"}},
}
},
},
}
@pytest.fixture
async def mock_31_client(self) -> httpx.AsyncClient:
"""Mock client that returns predefined responses for the 3.1 API."""
async def _responder(request):
if request.url.path == "/orders" and request.method == "GET":
return httpx.Response(
200,
json=[
{"id": "o1", "customer": "Alice", "items": ["item1", "item2"]},
{"id": "o2", "customer": "Bob", "items": ["item3"]},
],
)
elif request.url.path == "/orders" and request.method == "POST":
data = json.loads(request.content)
return httpx.Response(
201,
json={
"id": "o3",
"customer": data["customer"],
"items": data["items"],
},
)
elif request.url.path.startswith("/orders/") and request.method == "GET":
order_id = request.url.path.split("/")[-1]
orders = {
"o1": {
"id": "o1",
"customer": "Alice",
"items": ["item1", "item2"],
},
"o2": {"id": "o2", "customer": "Bob", "items": ["item3"]},
}
if order_id in orders:
return httpx.Response(200, json=orders[order_id])
return httpx.Response(404, json={"error": "Order not found"})
return httpx.Response(404)
transport = httpx.MockTransport(_responder)
return httpx.AsyncClient(transport=transport, base_url="http://test")
@pytest.fixture
async def openapi_31_server_with_all_types(
self, openapi_31_spec, mock_31_client
) -> FastMCPOpenAPI:
"""Create a FastMCPOpenAPI server from the OpenAPI 3.1 spec."""
return FastMCPOpenAPI(
openapi_spec=openapi_31_spec,
client=mock_31_client,
name="Order API 3.1",
route_maps=GET_ROUTE_MAPS,
)
async def test_server_creation(self, openapi_31_server_with_all_types):
"""Test that a server can be created from an OpenAPI 3.1 spec."""
assert isinstance(openapi_31_server_with_all_types, FastMCP)
assert openapi_31_server_with_all_types.name == "Order API 3.1"
async def test_resource_discovery(self, openapi_31_server_with_all_types):
"""Test that resources are correctly discovered from an OpenAPI 3.1 spec."""
async with Client(openapi_31_server_with_all_types) as client:
resources = await client.list_resources()
assert len(resources) == 1
assert resources[0].uri == AnyUrl("resource://listOrders")
async def test_resource_template_discovery(self, openapi_31_server_with_all_types):
"""Test that resource templates are correctly discovered from an OpenAPI 3.1 spec."""
async with Client(openapi_31_server_with_all_types) as client:
templates = await client.list_resource_templates()
assert len(templates) == 1
assert templates[0].name == "getOrder"
assert templates[0].uriTemplate == r"resource://getOrder/{order_id}"
async def test_tool_discovery(self, openapi_31_server_with_all_types):
"""Test that tools are correctly discovered from an OpenAPI 3.1 spec."""
async with Client(openapi_31_server_with_all_types) as client:
tools = await client.list_tools()
assert len(tools) == 1
assert tools[0].name == "createOrder"
assert "customer" in tools[0].inputSchema["properties"]
assert "items" in tools[0].inputSchema["properties"]
async def test_resource_access(self, openapi_31_server_with_all_types):
"""Test reading a resource from an OpenAPI 3.1 server."""
async with Client(openapi_31_server_with_all_types) as client:
resource_response = await client.read_resource("resource://listOrders")
response_text = resource_response[0].text # type: ignore[attr-defined]
content = json.loads(response_text)
assert len(content) == 2
assert content[0]["customer"] == "Alice"
assert content[1]["customer"] == "Bob"
async def test_resource_template_access(self, openapi_31_server_with_all_types):
"""Test reading a resource from template from an OpenAPI 3.1 server."""
async with Client(openapi_31_server_with_all_types) as client:
resource_response = await client.read_resource("resource://getOrder/o1")
response_text = resource_response[0].text # type: ignore[attr-defined]
content = json.loads(response_text)
assert content["id"] == "o1"
assert content["customer"] == "Alice"
assert content["items"] == ["item1", "item2"]
async def test_tool_execution(self, openapi_31_server_with_all_types):
"""Test executing a tool from an OpenAPI 3.1 server."""
async with Client(openapi_31_server_with_all_types) as client:
result = await client.call_tool(
"createOrder", {"customer": "Charlie", "items": ["item4", "item5"]}
)
# Result should be a text content
assert len(result.content) == 1
order = json.loads(result.content[0].text) # type: ignore[attr-defined]
assert order["id"] == "o3"
assert order["customer"] == "Charlie"
assert order["items"] == ["item4", "item5"]
assert result.structured_content is not None
assert result.structured_content["id"] == "o3"
assert result.structured_content["customer"] == "Charlie"
assert result.structured_content["items"] == ["item4", "item5"]
assert result.data is not None
assert result.data["id"] == "o3"
assert result.data["customer"] == "Charlie"
assert result.data["items"] == ["item4", "item5"]
class TestOpenAPIVersionDifferences:
"""Test specific differences between OpenAPI 3.0 and 3.1 that can cause compatibility issues."""
def test_openapi_30_exclusive_maximum_boolean_format(self):
"""Test OpenAPI 3.0 format with boolean exclusiveMaximum (reproduces GitHub issue #1021)."""
spec_with_exclusive_max = {
"openapi": "3.0.0",
"info": {"title": "Loan API", "version": "1.0.0"},
"paths": {
"/loans": {
"post": {
"operationId": "createLoan",
"summary": "Create a loan",
"requestBody": {
"required": True,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoanDetails"
}
}
},
},
"responses": {"201": {"description": "Loan created"}},
}
}
},
"components": {
"schemas": {
"LoanDetails": {
"type": "object",
"properties": {
"amount": {"type": "number", "minimum": 0},
"interest_rate": {
"type": "number",
"minimum": 0,
"maximum": 100,
"exclusiveMaximum": True, # OpenAPI 3.0 boolean format
},
},
"required": ["amount", "interest_rate"],
}
}
},
}
# This should not raise a ValidationError
routes = parse_openapi_to_http_routes(spec_with_exclusive_max)
assert len(routes) == 1
assert routes[0].operation_id == "createLoan"
def test_openapi_31_exclusive_maximum_numeric_format(self):
"""Test OpenAPI 3.1 format with numeric exclusiveMaximum."""
spec_with_exclusive_max = {
"openapi": "3.1.0",
"info": {"title": "Loan API", "version": "1.0.0"},
"paths": {
"/loans": {
"post": {
"operationId": "createLoan",
"summary": "Create a loan",
"requestBody": {
"required": True,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoanDetails"
}
}
},
},
"responses": {"201": {"description": "Loan created"}},
}
}
},
"components": {
"schemas": {
"LoanDetails": {
"type": "object",
"properties": {
"amount": {"type": "number", "minimum": 0},
"interest_rate": {
"type": "number",
"minimum": 0,
"exclusiveMaximum": 100, # OpenAPI 3.1 numeric format
},
},
"required": ["amount", "interest_rate"],
}
}
},
}
# This should not raise a ValidationError
routes = parse_openapi_to_http_routes(spec_with_exclusive_max)
assert len(routes) == 1
assert routes[0].operation_id == "createLoan"
def test_openapi_30_nullable_format(self):
"""Test OpenAPI 3.0 nullable format."""
spec_with_nullable = {
"openapi": "3.0.0",
"info": {"title": "User API", "version": "1.0.0"},
"paths": {
"/users": {
"post": {
"operationId": "createUser",
"summary": "Create a user",
"requestBody": {
"required": True,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {"type": "string"},
"email": {
"type": "string",
"nullable": True, # OpenAPI 3.0 nullable format
},
},
"required": ["name"],
}
}
},
},
"responses": {"201": {"description": "User created"}},
}
}
},
}
# This should not raise a ValidationError
routes = parse_openapi_to_http_routes(spec_with_nullable)
assert len(routes) == 1
assert routes[0].operation_id == "createUser"
def test_openapi_31_type_array_format(self):
"""Test OpenAPI 3.1 type array format for nullable values."""
spec_with_type_array = {
"openapi": "3.1.0",
"info": {"title": "User API", "version": "1.0.0"},
"paths": {
"/users": {
"post": {
"operationId": "createUser",
"summary": "Create a user",
"requestBody": {
"required": True,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {"type": "string"},
"email": {
"type": [
"string",
"null",
], # OpenAPI 3.1 type array format
},
},
"required": ["name"],
}
}
},
},
"responses": {"201": {"description": "User created"}},
}
}
},
}
# This should not raise a ValidationError
routes = parse_openapi_to_http_routes(spec_with_type_array)
assert len(routes) == 1
assert routes[0].operation_id == "createUser"
def test_openapi_30_with_defs_and_exclusive_maximum(self):
"""Test OpenAPI 3.0 with $defs and exclusiveMaximum (complex case from GitHub issue #1021)."""
spec_with_defs = {
"openapi": "3.0.0",
"info": {"title": "Complex Loan API", "version": "1.0.0"},
"paths": {
"/loans": {
"post": {
"operationId": "createComplexLoan",
"summary": "Create a complex loan",
"requestBody": {
"required": True,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"loanDetails": {
"$ref": "#/components/schemas/LoanDetails"
}
},
"required": ["loanDetails"],
"$defs": {
"LoanDetails": {
"type": "object",
"properties": {
"interest_rate": {
"type": "number",
"minimum": 0,
"maximum": 100,
"exclusiveMaximum": True, # This should trigger the issue
},
},
"required": ["interest_rate"],
}
},
}
}
},
},
"responses": {"201": {"description": "Complex loan created"}},
}
}
},
"components": {
"schemas": {
"LoanDetails": {
"type": "object",
"properties": {
"interest_rate": {
"type": "number",
"minimum": 0,
"maximum": 100,
"exclusiveMaximum": True,
},
},
"required": ["interest_rate"],
}
}
},
}
# This should not raise a ValidationError (GitHub issue #1021 should be fixed)
routes = parse_openapi_to_http_routes(spec_with_defs)
assert len(routes) == 1
assert routes[0].operation_id == "createComplexLoan"
def test_openapi_30_edge_case_with_multiple_exclusive_constraints(self):
"""Test edge case with multiple exclusive constraints that might trigger validation issues."""
spec_edge_case = {
"openapi": "3.0.0",
"info": {"title": "Edge Case API", "version": "1.0.0"},
"paths": {
"/validate": {
"post": {
"operationId": "validateData",
"summary": "Validate data with edge case constraints",
"requestBody": {
"required": True,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"minimum": 0,
"maximum": 100,
"exclusiveMaximum": True,
"exclusiveMinimum": True, # Both exclusive constraints
},
"rating": {
"type": "integer",
"minimum": 1,
"maximum": 10,
"exclusiveMaximum": True,
},
},
"required": ["percentage", "rating"],
}
}
},
},
"responses": {"200": {"description": "Data validated"}},
}
}
},
}
# This might trigger validation issues with multiple exclusive constraints
routes = parse_openapi_to_http_routes(spec_edge_case)
assert len(routes) == 1
assert routes[0].operation_id == "validateData"
|