|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | +"""Unit tests for Federation Forwarding Service. |
| 3 | +
|
| 4 | +Copyright 2025 |
| 5 | +SPDX-License-Identifier: Apache-2.0 |
| 6 | +Authors: Mihai Criveti |
| 7 | +
|
| 8 | +Comprehensive unit tests for the forwarding service module. |
| 9 | +""" |
| 10 | + |
| 11 | +import asyncio |
| 12 | +from datetime import datetime |
| 13 | + |
| 14 | +import pytest |
| 15 | + |
| 16 | +from mcpgateway.federation.forward import ForwardingError, ForwardingService, ToolResult |
| 17 | +from mcpgateway.types import TextContent |
| 18 | + |
| 19 | +# --------------------------------------------------------------------------- |
| 20 | +# Tiny dummy ORM objects + fake Session |
| 21 | +# --------------------------------------------------------------------------- |
| 22 | + |
| 23 | + |
| 24 | +class DummyGateway: |
| 25 | + def __init__(self, id_, name, url, is_active=True): |
| 26 | + self.id = id_ |
| 27 | + self.name = name |
| 28 | + self.url = url |
| 29 | + self.is_active = is_active |
| 30 | + self.last_seen: datetime | None = None |
| 31 | + |
| 32 | + |
| 33 | +class DummyTool: |
| 34 | + def __init__(self, id_, name, gateway_id=None, is_active=True): |
| 35 | + self.id = id_ |
| 36 | + self.name = name |
| 37 | + self.gateway_id = gateway_id |
| 38 | + self.is_active = is_active |
| 39 | + |
| 40 | + |
| 41 | +class _FakeResult: |
| 42 | + def __init__(self, scalar=None, scalar_list=None): |
| 43 | + self._scalar = scalar |
| 44 | + self._scalar_list = scalar_list or [] |
| 45 | + |
| 46 | + def scalar_one_or_none(self): |
| 47 | + return self._scalar |
| 48 | + |
| 49 | + class _Proxy: |
| 50 | + def __init__(self, items): |
| 51 | + self._items = items |
| 52 | + |
| 53 | + def all(self): |
| 54 | + return self._items |
| 55 | + |
| 56 | + def scalars(self): |
| 57 | + return self._Proxy(self._scalar_list) |
| 58 | + |
| 59 | + |
| 60 | +class FakeSession: |
| 61 | + def __init__(self, gateways=None, tools=None): |
| 62 | + self._gateways = gateways or [] |
| 63 | + self._tools = tools or [] |
| 64 | + |
| 65 | + def get(self, _model, pk): |
| 66 | + for gw in self._gateways: |
| 67 | + if gw.id == pk: |
| 68 | + return gw |
| 69 | + return None |
| 70 | + |
| 71 | + def execute(self, query): # pragma: no cover |
| 72 | + txt = str(query).lower() |
| 73 | + if "tool" in txt: |
| 74 | + return _FakeResult(scalar=self._tools[0] if self._tools else None) |
| 75 | + return _FakeResult(scalar_list=self._gateways) |
| 76 | + |
| 77 | + |
| 78 | +# --------------------------------------------------------------------------- |
| 79 | +# ForwardingService fixture with network stubbed out |
| 80 | +# --------------------------------------------------------------------------- |
| 81 | + |
| 82 | + |
| 83 | +@pytest.fixture |
| 84 | +async def fwd_service(monkeypatch): |
| 85 | + svc = ForwardingService() |
| 86 | + |
| 87 | + class _FakeResp: |
| 88 | + def __init__(self, payload): |
| 89 | + self._payload = payload |
| 90 | + |
| 91 | + def raise_for_status(self): |
| 92 | + pass |
| 93 | + |
| 94 | + def json(self): |
| 95 | + return self._payload |
| 96 | + |
| 97 | + async def fake_post(url, json=None, headers=None): # noqa: D401 |
| 98 | + return _FakeResp({"result": {"method": json["method"]}}) |
| 99 | + |
| 100 | + monkeypatch.setattr(svc._http_client, "post", fake_post) |
| 101 | + |
| 102 | + from mcpgateway.config import settings |
| 103 | + |
| 104 | + monkeypatch.setattr(settings, "max_tool_retries", 1, raising=False) |
| 105 | + yield svc |
| 106 | + await svc.stop() |
| 107 | + |
| 108 | + |
| 109 | +# --------------------------------------------------------------------------- |
| 110 | +# Tests |
| 111 | +# --------------------------------------------------------------------------- |
| 112 | + |
| 113 | + |
| 114 | +@pytest.mark.anyio |
| 115 | +async def test_forward_to_gateway_success(fwd_service): |
| 116 | + gw = DummyGateway(1, "Alpha", "http://alpha") |
| 117 | + db = FakeSession(gateways=[gw]) |
| 118 | + |
| 119 | + result = await fwd_service._forward_to_gateway(db, 1, "ping", {"x": 1}) |
| 120 | + assert result == {"method": "ping"} |
| 121 | + assert isinstance(gw.last_seen, datetime) |
| 122 | + |
| 123 | + |
| 124 | +@pytest.mark.anyio |
| 125 | +async def test_forward_tool_request_parses_result(monkeypatch, fwd_service): |
| 126 | + # Fake gateway call to produce valid ContentType payload |
| 127 | + async def fake_forward(db, gid, method, params): # noqa: D401 |
| 128 | + assert method == "tools/invoke" |
| 129 | + payload = { |
| 130 | + "content": [TextContent(type="text", text="OK").model_dump()], |
| 131 | + "is_error": False, |
| 132 | + } |
| 133 | + return payload |
| 134 | + |
| 135 | + monkeypatch.setattr(fwd_service, "_forward_to_gateway", fake_forward) # type: ignore[arg-type] |
| 136 | + |
| 137 | + tool = DummyTool(1, "echo", gateway_id=42) |
| 138 | + db = FakeSession(gateways=[DummyGateway(42, "EchoGW", "http://echo")], tools=[tool]) |
| 139 | + |
| 140 | + result: ToolResult = await fwd_service.forward_tool_request(db, "echo", {"msg": "hi"}) |
| 141 | + assert result.is_error is False |
| 142 | + assert isinstance(result.content[0], TextContent) and result.content[0].text == "OK" |
| 143 | + |
| 144 | + |
| 145 | +@pytest.mark.anyio |
| 146 | +async def test_rate_limit(monkeypatch): |
| 147 | + from mcpgateway.config import settings |
| 148 | + |
| 149 | + monkeypatch.setattr(settings, "tool_rate_limit", 2, raising=False) |
| 150 | + |
| 151 | + svc = ForwardingService() |
| 152 | + url = "http://beta" |
| 153 | + assert svc._check_rate_limit(url) |
| 154 | + assert svc._check_rate_limit(url) |
| 155 | + assert svc._check_rate_limit(url) is False # third call exceeds limit |
| 156 | + |
| 157 | + |
| 158 | +@pytest.mark.anyio |
| 159 | +async def test_forward_to_all_partial_success(monkeypatch, fwd_service): |
| 160 | + gw_ok = DummyGateway(1, "GoodGW", "http://good") |
| 161 | + gw_bad = DummyGateway(2, "BadGW", "http://bad") |
| 162 | + |
| 163 | + async def fake_forward(db, gid, method, params): # noqa: D401 |
| 164 | + if gid == 1: |
| 165 | + return "ok!" |
| 166 | + raise ForwardingError("boom") |
| 167 | + |
| 168 | + monkeypatch.setattr(fwd_service, "_forward_to_gateway", fake_forward) # type: ignore[arg-type] |
| 169 | + |
| 170 | + db = FakeSession(gateways=[gw_ok, gw_bad]) |
| 171 | + results = await fwd_service._forward_to_all(db, "stats/get") |
| 172 | + assert results == ["ok!"] |
0 commit comments