Spaces:
Running
Running
File size: 24,313 Bytes
48f7143 2e6dbad 48f7143 a84c433 582f82a 0a0f1ed 48f7143 0a0f1ed bf2f475 ef81ec0 bf2f475 ef81ec0 bf2f475 ef81ec0 bf2f475 48f7143 3de056b 0a0f1ed ceea07c ef81ec0 acef890 0a0f1ed b770cbf 506c09a b770cbf 0a0f1ed 2e6dbad 0a0f1ed b770cbf 0a0f1ed 15f96d2 b770cbf 15f96d2 b770cbf ce692fd 37d552f a84c433 1175ac0 a84c433 1534a61 a84c433 1534a61 a84c433 1534a61 a84c433 1534a61 a84c433 1534a61 a84c433 1534a61 a84c433 1534a61 6fe9090 1534a61 a84c433 4dee55e a84c433 1534a61 6fe9090 1534a61 4dee55e | 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 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 | import json
from urllib.parse import quote
import pytest
from pydantic import BaseModel
from fastmcp import Context
from fastmcp.resources import ResourceTemplate
from fastmcp.resources.resource import FunctionResource
from fastmcp.resources.template import match_uri_template
class TestResourceTemplate:
"""Test ResourceTemplate functionality."""
def test_template_creation(self):
"""Test creating a template from a function."""
def my_func(key: str, value: int) -> dict:
return {"key": key, "value": value}
template = ResourceTemplate.from_function(
fn=my_func,
uri_template="test://{key}/{value}",
name="test",
)
assert template.uri_template == "test://{key}/{value}"
assert template.name == "test"
assert template.mime_type == "text/plain" # default
test_input = {"key": "test", "value": 42}
assert template.fn(**test_input) == my_func(**test_input)
def test_template_matches(self):
"""Test matching URIs against a template."""
def my_func(key: str, value: int) -> dict:
return {"key": key, "value": value}
template = ResourceTemplate.from_function(
fn=my_func,
uri_template="test://{key}/{value}",
name="test",
)
# Valid match
params = template.matches("test://foo/123")
assert params == {"key": "foo", "value": "123"}
# No match
assert template.matches("test://foo") is None
assert template.matches("other://foo/123") is None
def test_template_matches_with_prefix(self):
"""Test matching URIs against a template with a prefix."""
def my_func(key: str, value: int) -> dict:
return {"key": key, "value": value}
template = ResourceTemplate.from_function(
fn=my_func,
uri_template="app+test://{key}/{value}",
name="test",
)
# Valid match
params = template.matches("app+test://foo/123")
assert params == {"key": "foo", "value": "123"}
# No match
assert template.matches("test://foo/123") is None
assert template.matches("test://foo") is None
assert template.matches("other://foo/123") is None
def test_template_uri_validation(self):
"""Test validation rule: URI template must have at least one parameter."""
def my_func() -> dict:
return {"data": "value"}
with pytest.raises(
ValueError, match="URI template must contain at least one parameter"
):
ResourceTemplate.from_function(
fn=my_func,
uri_template="test://no-params",
name="test",
)
def test_template_uri_params_subset_of_function_params(self):
"""Test validation rule: URI parameters must be a subset of function parameters."""
def my_func(key: str, value: int) -> dict:
return {"key": key, "value": value}
# This should work - URI params are a subset of function params
template = ResourceTemplate.from_function(
fn=my_func,
uri_template="test://{key}/{value}",
name="test",
)
assert template.uri_template == "test://{key}/{value}"
# This should fail - 'unknown' is not a function parameter
with pytest.raises(
ValueError,
match="Required function arguments .* must be a subset of the URI parameters",
):
ResourceTemplate.from_function(
fn=my_func,
uri_template="test://{key}/{unknown}",
name="test",
)
def test_required_params_subset_of_uri_params(self):
"""Test validation rule: Required function parameters must be in URI parameters."""
# Function with required parameters
def func_with_required(
required_param: str, optional_param: str = "default"
) -> dict:
return {"required": required_param, "optional": optional_param}
# This should work - required param is in URI
template = ResourceTemplate.from_function(
fn=func_with_required,
uri_template="test://{required_param}",
name="test",
)
assert template.uri_template == "test://{required_param}"
# This should fail - required param is not in URI
with pytest.raises(
ValueError,
match="Required function arguments .* must be a subset of the URI parameters",
):
ResourceTemplate.from_function(
fn=func_with_required,
uri_template="test://{optional_param}",
name="test",
)
def test_multiple_required_params(self):
"""Test validation with multiple required parameters."""
def multi_required(param1: str, param2: int, optional: str = "default") -> dict:
return {"p1": param1, "p2": param2, "opt": optional}
# This works - all required params in URI
template = ResourceTemplate.from_function(
fn=multi_required,
uri_template="test://{param1}/{param2}",
name="test",
)
assert template.uri_template == "test://{param1}/{param2}"
# This fails - missing one required param
with pytest.raises(
ValueError,
match="Required function arguments .* must be a subset of the URI parameters",
):
ResourceTemplate.from_function(
fn=multi_required,
uri_template="test://{param1}",
name="test",
)
async def test_create_resource(self):
"""Test creating a resource from a template."""
def my_func(key: str, value: int) -> dict:
return {"key": key, "value": value}
template = ResourceTemplate.from_function(
fn=my_func,
uri_template="test://{key}/{value}",
name="test",
)
resource = await template.create_resource(
"test://foo/123",
{"key": "foo", "value": 123},
)
assert isinstance(resource, FunctionResource)
content = await resource.read()
assert isinstance(content, str)
data = json.loads(content)
assert data == {"key": "foo", "value": 123}
async def test_async_text_resource(self):
"""Test creating a text resource from async function."""
async def greet(name: str) -> str:
return f"Hello, {name}!"
template = ResourceTemplate.from_function(
fn=greet,
uri_template="greet://{name}",
name="greeter",
)
resource = await template.create_resource(
"greet://world",
{"name": "world"},
)
assert isinstance(resource, FunctionResource)
content = await resource.read()
assert content == "Hello, world!"
async def test_async_binary_resource(self):
"""Test creating a binary resource from async function."""
async def get_bytes(value: str) -> bytes:
return value.encode()
template = ResourceTemplate.from_function(
fn=get_bytes,
uri_template="bytes://{value}",
name="bytes",
)
resource = await template.create_resource(
"bytes://test",
{"value": "test"},
)
assert isinstance(resource, FunctionResource)
content = await resource.read()
assert content == b"test"
async def test_basemodel_conversion(self):
"""Test handling of BaseModel types."""
class MyModel(BaseModel):
key: str
value: int
def get_data(key: str, value: int) -> MyModel:
return MyModel(key=key, value=value)
template = ResourceTemplate.from_function(
fn=get_data,
uri_template="test://{key}/{value}",
name="test",
)
resource = await template.create_resource(
"test://foo/123",
{"key": "foo", "value": 123},
)
assert isinstance(resource, FunctionResource)
content = await resource.read()
assert isinstance(content, str)
data = json.loads(content)
assert data == {"key": "foo", "value": 123}
async def test_custom_type_conversion(self):
"""Test handling of custom types."""
class CustomData:
def __init__(self, value: str):
self.value = value
def __str__(self) -> str:
return self.value
def get_data(value: str) -> CustomData:
return CustomData(value)
template = ResourceTemplate.from_function(
fn=get_data,
uri_template="test://{value}",
name="test",
)
resource = await template.create_resource(
"test://hello",
{"value": "hello"},
)
assert isinstance(resource, FunctionResource)
content = await resource.read()
assert content == '"hello"'
async def test_wildcard_param_can_create_resource(self):
"""Test that wildcard parameters are valid."""
def identity(path: str) -> str:
return path
template = ResourceTemplate.from_function(
fn=identity,
uri_template="test://{path*}.py",
name="test",
)
assert await template.create_resource(
"test://path/to/test.py",
{"path": "path/to/test.py"},
)
async def test_wildcard_param_matches(self):
def identify(path: str) -> str:
return path
template = ResourceTemplate.from_function(
fn=identify,
uri_template="test://src/{path*}.py",
name="test",
)
# Valid match
params = template.matches("test://src/path/to/test.py")
assert params == {"path": "path/to/test"}
async def test_multiple_wildcard_params(self):
"""Test that multiple wildcard parameters are valid."""
def identity(path: str, path2: str) -> str:
return f"{path}/{path2}"
template = ResourceTemplate.from_function(
fn=identity,
uri_template="test://{path*}/xyz/{path2*}",
name="test",
)
params = template.matches("test://path/to/xyz/abc")
assert params == {"path": "path/to", "path2": "abc"}
async def test_wildcard_param_with_regular_param(self):
"""Test that a wildcard parameter can be used with a regular parameter."""
def identity(prefix: str, path: str) -> str:
return f"{prefix}/{path}"
template = ResourceTemplate.from_function(
fn=identity,
uri_template="test://{prefix}/{path*}",
name="test",
)
params = template.matches("test://src/path/to/test.py")
assert params == {"prefix": "src", "path": "path/to/test.py"}
async def test_function_with_varargs_not_allowed(self):
def func(x: int, *args: int) -> int:
return x + sum(args)
with pytest.raises(
ValueError,
match=r"Functions with \*args are not supported as resource templates",
):
ResourceTemplate.from_function(
fn=func,
uri_template="test://{x}/{args*}",
name="test",
)
async def test_function_with_varkwargs_ok(self):
def func(x: int, **kwargs: int) -> int:
return x + sum(kwargs.values())
template = ResourceTemplate.from_function(
fn=func,
uri_template="test://{x}/{y}/{z}",
name="test",
)
assert template.uri_template == "test://{x}/{y}/{z}"
async def test_callable_object_as_template(self):
"""Test that a callable object can be used as a template."""
class MyTemplate:
"""This is my template"""
def __call__(self, x: str) -> str:
"""ignore this"""
return f"X was {x}"
template = ResourceTemplate.from_function(
fn=MyTemplate(),
uri_template="test://{x}",
name="test",
)
resource = await template.create_resource(
"test://foo",
{"x": "foo"},
)
assert isinstance(resource, FunctionResource)
content = await resource.read()
assert content == "X was foo"
class TestMatchUriTemplate:
"""Test match_uri_template function."""
@pytest.mark.parametrize(
"uri, expected_params",
[
("test://a/b", None),
("test://a/b/c", None),
("test://a/x/b", {"x": "x"}),
("test://a/x/y/b", None),
("test://a/1-2/b", {"x": "1-2"}),
],
)
def test_match_uri_template_single_param(
self, uri: str, expected_params: dict[str, str]
):
"""Test that match_uri_template uses the slash delimiter."""
uri_template = "test://a/{x}/b"
result = match_uri_template(uri=uri, uri_template=uri_template)
assert result == expected_params
@pytest.mark.parametrize(
"uri, expected_params",
[
("test://foo/123", {"x": "foo", "y": "123"}),
("test://bar/456", {"x": "bar", "y": "456"}),
("test://foo/bar", {"x": "foo", "y": "bar"}),
("test://foo/bar/baz", None),
("test://foo/email@domain.com", {"x": "foo", "y": "email@domain.com"}),
("test://two words/foo", {"x": "two words", "y": "foo"}),
("test://two.words/foo+bar", {"x": "two.words", "y": "foo+bar"}),
(
f"test://escaped{quote('/', safe='')}word/bar",
{"x": "escaped/word", "y": "bar"},
),
(
f"test://escaped{quote('{', safe='')}x{quote('}', safe='')}word/bar",
{"x": "escaped{x}word", "y": "bar"},
),
("prefix+test://foo/123", None),
("test://foo", None),
("other://foo/123", None),
("t.est://foo/bar", None),
],
)
def test_match_uri_template_simple_params(
self, uri: str, expected_params: dict[str, str] | None
):
"""Test matching URIs against a template with simple parameters."""
uri_template = "test://{x}/{y}"
result = match_uri_template(uri=uri, uri_template=uri_template)
assert result == expected_params
@pytest.mark.parametrize(
"uri, expected_params",
[
("test://a/b/foo/c/d/123", {"x": "foo", "y": "123"}),
("test://a/b/bar/c/d/456", {"x": "bar", "y": "456"}),
("prefix+test://a/b/foo/c/d/123", None),
("test://a/b/foo", None),
("other://a/b/foo/c/d/123", None),
],
)
def test_match_uri_template_params_and_literal_segments(
self, uri: str, expected_params: dict[str, str] | None
):
"""Test matching URIs against a template with parameters and literal segments."""
uri_template = "test://a/b/{x}/c/d/{y}"
result = match_uri_template(uri=uri, uri_template=uri_template)
assert result == expected_params
@pytest.mark.parametrize(
"uri, expected_params",
[
("prefix+test://foo/test/123", {"x": "foo", "y": "123"}),
("prefix+test://bar/test/456", {"x": "bar", "y": "456"}),
("test://foo/test/123", None),
("other.prefix+test://foo/test/123", None),
("other+prefix+test://foo/test/123", None),
],
)
def test_match_uri_template_with_prefix(
self, uri: str, expected_params: dict[str, str] | None
):
"""Test matching URIs against a template with a prefix."""
uri_template = "prefix+test://{x}/test/{y}"
result = match_uri_template(uri=uri, uri_template=uri_template)
assert result == expected_params
def test_match_uri_template_quoted_params(self):
uri_template = "user://{name}/{email}"
quoted_name = quote("John Doe", safe="")
quoted_email = quote("john@example.com", safe="")
uri = f"user://{quoted_name}/{quoted_email}"
result = match_uri_template(uri=uri, uri_template=uri_template)
assert result == {"name": "John Doe", "email": "john@example.com"}
@pytest.mark.parametrize(
"uri, expected_params",
[
("test://a/b", None),
("test://a/b/c", None),
("test://a/x/b", {"x": "x"}),
("test://a/x/y/b", {"x": "x/y"}),
("bad-prefix://a/x/y/b", None),
("test://a/x/y/z", None),
],
)
def test_match_uri_template_wildcard_param(
self, uri: str, expected_params: dict[str, str]
):
"""Test that match_uri_template uses the slash delimiter."""
uri_template = "test://a/{x*}/b"
result = match_uri_template(uri=uri, uri_template=uri_template)
assert result == expected_params
@pytest.mark.parametrize(
"uri, expected_params",
[
("test://a/x/y/b/c/d", {"x": "x/y", "y": "c/d"}),
("bad-prefix://a/x/y/b/c/d", None),
("test://a/x/y/c/d", None),
("test://a/x/b/y", {"x": "x", "y": "y"}),
],
)
def test_match_uri_template_multiple_wildcard_params(
self, uri: str, expected_params: dict[str, str]
):
"""Test that match_uri_template uses the slash delimiter."""
uri_template = "test://a/{x*}/b/{y*}"
result = match_uri_template(uri=uri, uri_template=uri_template)
assert result == expected_params
def test_match_uri_template_wildcard_and_literal_param(self):
"""Test that match_uri_template uses the slash delimiter."""
uri = "test://a/x/y/b"
uri_template = "test://a/{x*}/{y}"
result = match_uri_template(uri=uri, uri_template=uri_template)
assert result == {"x": "x/y", "y": "b"}
def test_match_consecutive_params(self):
"""Test that consecutive parameters without a / are not matched."""
uri = "test://a/x/y"
uri_template = "test://a/{x}{y}"
result = match_uri_template(uri=uri, uri_template=uri_template)
assert result is None
@pytest.mark.parametrize(
"uri, expected_params",
[
("file://abc/xyz.py", {"path": "xyz"}),
("file://abc/x/y/z.py", {"path": "x/y/z"}),
("file://abc/x/y/z/.py", {"path": "x/y/z/"}),
("file://abc/x/y/z.md", None),
("file://x/y/z.txt", None),
],
)
def test_match_uri_template_with_non_slash_suffix(
self, uri: str, expected_params: dict[str, str]
):
uri_template = "file://abc/{path*}.py"
result = match_uri_template(uri=uri, uri_template=uri_template)
assert result == expected_params
@pytest.mark.parametrize(
"uri, expected_params",
[
("resource://test_foo", {"x": "foo"}),
("resource://test_bar", {"x": "bar"}),
("resource://test_hello", {"x": "hello"}),
("resource://test_with_underscores", {"x": "with_underscores"}),
("resource://test_", None), # Empty parameter not matched
("resource://test", None), # Missing parameter delimiter
("resource://other_foo", None), # Wrong prefix
("other://test_foo", None), # Wrong scheme
],
)
def test_match_uri_template_embedded_param(
self, uri: str, expected_params: dict[str, str] | None
):
"""Test matching URIs where parameter is embedded within a word segment."""
uri_template = "resource://test_{x}"
result = match_uri_template(uri=uri, uri_template=uri_template)
assert result == expected_params
@pytest.mark.parametrize(
"uri, expected_params",
[
("resource://prefix_foo_suffix", {"x": "foo"}),
("resource://prefix_bar_suffix", {"x": "bar"}),
("resource://prefix_hello_world_suffix", {"x": "hello_world"}),
("resource://prefix__suffix", None), # Empty parameter not matched
("resource://prefix_suffix", None), # Missing parameter delimiter
("resource://other_foo_suffix", None), # Wrong prefix
("resource://prefix_foo_other", None), # Wrong suffix
],
)
def test_match_uri_template_embedded_param_with_prefix_and_suffix(
self, uri: str, expected_params: dict[str, str] | None
):
"""Test matching URIs where parameter has both prefix and suffix."""
uri_template = "resource://prefix_{x}_suffix"
result = match_uri_template(uri=uri, uri_template=uri_template)
assert result == expected_params
class TestContextHandling:
"""Test context handling in resource templates."""
def test_context_parameter_detection(self):
"""Test that context parameters are properly detected in
ResourceTemplate.from_function()."""
def template_with_context(x: int, ctx: Context) -> str:
return str(x)
ResourceTemplate.from_function(
fn=template_with_context,
uri_template="test://{x}",
name="test",
)
def template_without_context(x: int) -> str:
return str(x)
ResourceTemplate.from_function(
fn=template_without_context,
uri_template="test://{x}",
name="test",
)
def test_parameterized_context_parameter_detection(self):
"""Test that parameterized context parameters are properly detected in
ResourceTemplate.from_function()."""
def template_with_context(x: int, ctx: Context) -> str:
return str(x)
ResourceTemplate.from_function(
fn=template_with_context,
uri_template="test://{x}",
name="test",
)
def test_parameterized_union_context_parameter_detection(self):
"""Test that context parameters in a union are properly detected in
ResourceTemplate.from_function()."""
def template_with_context(x: int, ctx: Context | None) -> str:
return str(x)
ResourceTemplate.from_function(
fn=template_with_context,
uri_template="test://{x}",
name="test",
)
async def test_context_injection(self):
"""Test that context is properly injected during resource creation."""
def resource_with_context(x: int, ctx: Context) -> str:
assert isinstance(ctx, Context)
return str(x)
template = ResourceTemplate.from_function(
fn=resource_with_context,
uri_template="test://{x}",
name="test",
)
from fastmcp import FastMCP
mcp = FastMCP()
context = Context(fastmcp=mcp)
async with context:
resource = await template.create_resource(
"test://42",
{"x": 42},
)
assert isinstance(resource, FunctionResource)
content = await resource.read()
assert content == "42"
async def test_context_optional(self):
"""Test that context is optional when creating resources."""
def resource_with_context(x: int, ctx: Context | None = None) -> str:
return str(x)
template = ResourceTemplate.from_function(
fn=resource_with_context,
uri_template="test://{x}",
name="test",
)
# Even for optional context, we need to provide a context
from fastmcp import FastMCP
mcp = FastMCP()
context = Context(fastmcp=mcp)
async with context:
resource = await template.create_resource(
"test://42",
{"x": 42},
)
assert isinstance(resource, FunctionResource)
content = await resource.read()
assert content == "42"
|