Spaces:
Running
Running
File size: 9,648 Bytes
53a91d7 dd2c763 53a91d7 dd2c763 | 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 | """Tests for OpenAPI output schema extraction functionality."""
from fastmcp.utilities.openapi import (
ResponseInfo,
_adjust_union_types,
extract_output_schema_from_responses,
)
class TestExtractOutputSchema:
"""Test the extract_output_schema_from_responses function."""
def test_extract_object_schema(self):
"""Test extracting object output schema (no wrapping needed)."""
responses = {
"200": ResponseInfo(
description="Success",
content_schema={
"application/json": {
"type": "object",
"properties": {
"id": {"type": "integer"},
"name": {"type": "string"},
},
"required": ["id", "name"],
}
},
)
}
result = extract_output_schema_from_responses(responses)
assert result == {
"type": "object",
"properties": {"id": {"type": "integer"}, "name": {"type": "string"}},
"required": ["id", "name"],
}
assert result is not None and "x-fastmcp-wrap-result" not in result
def test_extract_array_schema_with_wrapping(self):
"""Test extracting array output schema (should be wrapped)."""
responses = {
"200": ResponseInfo(
description="Success",
content_schema={
"application/json": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {"type": "integer"},
"name": {"type": "string"},
},
},
}
},
)
}
result = extract_output_schema_from_responses(responses)
assert result == {
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {"type": "integer"},
"name": {"type": "string"},
},
},
}
},
"required": ["result"],
"x-fastmcp-wrap-result": True,
}
def test_extract_primitive_schema_with_wrapping(self):
"""Test extracting primitive output schema (should be wrapped)."""
responses = {
"201": ResponseInfo(
description="Created",
content_schema={
"application/json": {
"type": "string",
"description": "ID of created resource",
}
},
)
}
result = extract_output_schema_from_responses(responses)
assert result == {
"type": "object",
"properties": {
"result": {"type": "string", "description": "ID of created resource"}
},
"required": ["result"],
"x-fastmcp-wrap-result": True,
}
def test_priority_of_success_codes(self):
"""Test that 200 takes priority over other success codes."""
responses = {
"201": ResponseInfo(
description="Created",
content_schema={"application/json": {"type": "string"}},
),
"200": ResponseInfo(
description="Success",
content_schema={
"application/json": {
"type": "object",
"properties": {"id": {"type": "integer"}},
}
},
),
}
result = extract_output_schema_from_responses(responses)
# Should use the 200 response (object), not 201 (string)
assert result is not None and result["type"] == "object"
assert result is not None and "x-fastmcp-wrap-result" not in result
def test_prefer_json_content_type(self):
"""Test that application/json is preferred over other content types."""
responses = {
"200": ResponseInfo(
description="Success",
content_schema={
"text/plain": {"type": "string"},
"application/json": {
"type": "object",
"properties": {"id": {"type": "integer"}},
},
},
)
}
result = extract_output_schema_from_responses(responses)
# Should use the application/json schema (object), not text/plain (string)
assert result is not None and result["type"] == "object"
assert result is not None and "x-fastmcp-wrap-result" not in result
def test_no_responses(self):
"""Test that None is returned when no responses are provided."""
result = extract_output_schema_from_responses({})
assert result is None
def test_no_success_responses(self):
"""Test that None is returned when no success responses are found."""
responses = {
"400": ResponseInfo(
description="Bad Request",
content_schema={
"application/json": {
"type": "object",
"properties": {"error": {"type": "string"}},
}
},
)
}
result = extract_output_schema_from_responses(responses)
assert result is None
def test_no_content_schema(self):
"""Test that None is returned when response has no content schema."""
responses = {"204": ResponseInfo(description="No Content")}
result = extract_output_schema_from_responses(responses)
assert result is None
def test_schema_definitions_included(self):
"""Test that schema definitions are properly included in output schema."""
responses = {
"200": ResponseInfo(
description="Success",
content_schema={
"application/json": {
"type": "object",
"properties": {"user": {"$ref": "#/$defs/User"}},
}
},
)
}
schema_definitions = {
"User": {
"type": "object",
"properties": {"id": {"type": "integer"}, "name": {"type": "string"}},
"required": ["id", "name"],
}
}
result = extract_output_schema_from_responses(responses, schema_definitions)
assert result is not None
assert "$defs" in result
assert "User" in result["$defs"]
assert result["$defs"]["User"] == schema_definitions["User"]
def test_wrapped_schema_with_definitions(self):
"""Test that wrapped schemas properly include schema definitions."""
responses = {
"200": ResponseInfo(
description="Success",
content_schema={
"application/json": {
"type": "array",
"items": {"$ref": "#/$defs/User"},
}
},
)
}
schema_definitions = {
"User": {
"type": "object",
"properties": {"id": {"type": "integer"}, "name": {"type": "string"}},
"required": ["id", "name"],
}
}
result = extract_output_schema_from_responses(responses, schema_definitions)
assert result is not None
assert result["x-fastmcp-wrap-result"] is True
assert "$defs" in result
assert "User" in result["$defs"]
assert result["properties"]["result"]["type"] == "array"
assert result["properties"]["result"]["items"]["$ref"] == "#/$defs/User"
def test_adjust_union_types():
"""Test that oneOf is replaced with anyOf in schemas."""
schema = {"oneOf": [{"type": "string"}, {"type": "number"}]}
result = _adjust_union_types(schema)
assert isinstance(result, dict)
assert "anyOf" in result
assert "oneOf" not in result
assert len(result["anyOf"]) == 2
assert result["anyOf"][0] == {"type": "string"}
assert result["anyOf"][1] == {"type": "number"}
def test_extract_output_schema_converts_oneOf_to_anyOf():
"""Test that extracted schema converts oneOf to anyOf."""
responses = {
"200": ResponseInfo(
description="Success",
content_schema={
"application/json": {
"type": "object",
"properties": {
"result": {
"oneOf": [
{"$ref": "#/$defs/TypeA"},
{"$ref": "#/$defs/TypeB"},
]
}
},
}
},
)
}
schema_definitions = {"TypeA": {"type": "string"}, "TypeB": {"type": "number"}}
result = extract_output_schema_from_responses(responses, schema_definitions)
assert result is not None
assert "oneOf" not in str(result) # Ensure no oneOf remains
assert "anyOf" in str(result) # Ensure anyOf is present
|