|
1 | 1 | # -*- coding: utf-8 -*-
|
2 |
| -""" |
| 2 | +"""Unit tests for **mcpgateway.transports.streamablehttp_transport** |
3 | 3 |
|
4 | 4 | Copyright 2025
|
5 | 5 | SPDX-License-Identifier: Apache-2.0
|
6 | 6 | Authors: Mihai Criveti
|
7 | 7 |
|
| 8 | +Focus areas |
| 9 | +----------- |
| 10 | +* **InMemoryEventStore** - storing, replaying, and eviction when the per‑stream |
| 11 | + max size is reached. |
| 12 | +* **streamable_http_auth** - behaviour on happy path (valid Bearer token) and |
| 13 | + when verification fails (returns 401 and False). |
| 14 | +
|
| 15 | +No external MCP server is started; we test the isolated utility pieces that |
| 16 | +have no heavy dependencies. |
8 | 17 | """
|
| 18 | + |
| 19 | +from __future__ import annotations |
| 20 | + |
| 21 | +import asyncio |
| 22 | +from types import SimpleNamespace |
| 23 | +from typing import List |
| 24 | + |
| 25 | +import pytest |
| 26 | +from starlette.types import Scope |
| 27 | + |
| 28 | +# --------------------------------------------------------------------------- |
| 29 | +# Import module under test - we only need the specific classes / functions |
| 30 | +# --------------------------------------------------------------------------- |
| 31 | +from mcpgateway.transports import streamablehttp_transport as tr # noqa: E402 |
| 32 | + |
| 33 | +InMemoryEventStore = tr.InMemoryEventStore # alias |
| 34 | +streamable_http_auth = tr.streamable_http_auth |
| 35 | + |
| 36 | +# --------------------------------------------------------------------------- |
| 37 | +# InMemoryEventStore tests |
| 38 | +# --------------------------------------------------------------------------- |
| 39 | + |
| 40 | + |
| 41 | +@pytest.mark.asyncio |
| 42 | +async def test_event_store_store_and_replay(): |
| 43 | + store = InMemoryEventStore(max_events_per_stream=10) |
| 44 | + stream_id = "abc" |
| 45 | + |
| 46 | + # store two events |
| 47 | + eid1 = await store.store_event(stream_id, {"id": 1}) |
| 48 | + eid2 = await store.store_event(stream_id, {"id": 2}) |
| 49 | + |
| 50 | + sent: List[tr.EventMessage] = [] |
| 51 | + |
| 52 | + async def collector(msg): |
| 53 | + sent.append(msg) |
| 54 | + |
| 55 | + returned_stream = await store.replay_events_after(eid1, collector) |
| 56 | + |
| 57 | + assert returned_stream == stream_id |
| 58 | + # Only the *second* event is replayed |
| 59 | + assert len(sent) == 1 and sent[0].message["id"] == 2 |
| 60 | + assert sent[0].event_id == eid2 |
| 61 | + |
| 62 | + |
| 63 | +@pytest.mark.asyncio |
| 64 | +async def test_event_store_eviction(): |
| 65 | + """Oldest event should be evicted once per‑stream limit is exceeded.""" |
| 66 | + store = InMemoryEventStore(max_events_per_stream=1) |
| 67 | + stream_id = "s" |
| 68 | + |
| 69 | + eid_old = await store.store_event(stream_id, {"x": "old"}) |
| 70 | + # Second insert causes eviction of the first (deque maxlen = 1) |
| 71 | + await store.store_event(stream_id, {"x": "new"}) |
| 72 | + |
| 73 | + # The evicted event ID should no longer be replayable |
| 74 | + sent: List[tr.EventMessage] = [] |
| 75 | + |
| 76 | + async def collector(_): |
| 77 | + sent.append(_) |
| 78 | + |
| 79 | + result = await store.replay_events_after(eid_old, collector) |
| 80 | + |
| 81 | + assert result is None # event no longer known |
| 82 | + assert sent == [] # callback not invoked |
| 83 | + |
| 84 | + |
| 85 | +# --------------------------------------------------------------------------- |
| 86 | +# streamable_http_auth tests |
| 87 | +# --------------------------------------------------------------------------- |
| 88 | + |
| 89 | + |
| 90 | +def _make_scope(path: str, headers: list[tuple[bytes, bytes]] | None = None) -> Scope: # helper |
| 91 | + return { |
| 92 | + "type": "http", |
| 93 | + "path": path, |
| 94 | + "headers": headers or [], |
| 95 | + } |
| 96 | + |
| 97 | + |
| 98 | +@pytest.mark.asyncio |
| 99 | +async def test_auth_all_ok(monkeypatch): |
| 100 | + """Valid Bearer token passes; function returns True and does *not* send.""" |
| 101 | + |
| 102 | + async def fake_verify(token): # noqa: D401 - stub |
| 103 | + assert token == "good-token" |
| 104 | + return {"ok": True} |
| 105 | + |
| 106 | + monkeypatch.setattr(tr, "verify_credentials", fake_verify) |
| 107 | + |
| 108 | + messages = [] |
| 109 | + |
| 110 | + async def send(msg): # collect ASGI messages for later inspection |
| 111 | + messages.append(msg) |
| 112 | + |
| 113 | + scope = _make_scope( |
| 114 | + "/servers/1/mcp", |
| 115 | + headers=[(b"authorization", b"Bearer good-token")], |
| 116 | + ) |
| 117 | + |
| 118 | + assert await streamable_http_auth(scope, None, send) is True |
| 119 | + assert messages == [] # nothing sent - auth succeeded |
| 120 | + |
| 121 | + |
| 122 | +@pytest.mark.asyncio |
| 123 | +async def test_auth_failure(monkeypatch): |
| 124 | + """When verify_credentials raises, auth func responds 401 and returns False.""" |
| 125 | + |
| 126 | + async def fake_verify(_): # noqa: D401 - stub that always fails |
| 127 | + raise ValueError("bad token") |
| 128 | + |
| 129 | + monkeypatch.setattr(tr, "verify_credentials", fake_verify) |
| 130 | + |
| 131 | + sent = [] |
| 132 | + |
| 133 | + async def send(msg): |
| 134 | + sent.append(msg) |
| 135 | + |
| 136 | + scope = _make_scope( |
| 137 | + "/servers/1/mcp", |
| 138 | + headers=[(b"authorization", b"Bearer bad")], |
| 139 | + ) |
| 140 | + |
| 141 | + result = await streamable_http_auth(scope, None, send) |
| 142 | + |
| 143 | + # First ASGI message should be http.response.start with 401 |
| 144 | + assert result is False |
| 145 | + assert sent and sent[0]["type"] == "http.response.start" |
| 146 | + assert sent[0]["status"] == tr.HTTP_401_UNAUTHORIZED |
| 147 | + |
| 148 | + |
| 149 | +# --------------------------------------------------------------------------- |
| 150 | +# SamplingHandler tests |
| 151 | +# --------------------------------------------------------------------------- |
| 152 | + |
| 153 | +import types as _t # local alias for creating simple stubs |
| 154 | + |
| 155 | +from mcpgateway.handlers import sampling as sp # noqa: E402 |
| 156 | + |
| 157 | +SamplingHandler = sp.SamplingHandler |
| 158 | +SamplingError = sp.SamplingError |
| 159 | + |
| 160 | + |
| 161 | +@pytest.fixture() |
| 162 | +def handler(): |
| 163 | + return SamplingHandler() |
| 164 | + |
| 165 | + |
| 166 | +# --------------------------------------------------------------------------- |
| 167 | +# _select_model |
| 168 | +# --------------------------------------------------------------------------- |
| 169 | + |
| 170 | + |
| 171 | +@pytest.mark.asyncio |
| 172 | +async def test_select_model_by_hint(handler): |
| 173 | + """Model hint should override scoring logic.""" |
| 174 | + |
| 175 | + prefs = _t.SimpleNamespace( |
| 176 | + hints=[_t.SimpleNamespace(name="sonnet")], |
| 177 | + cost_priority=0, |
| 178 | + speed_priority=0, |
| 179 | + intelligence_priority=0, |
| 180 | + ) |
| 181 | + |
| 182 | + assert handler._select_model(prefs) == "claude-3-sonnet" # pylint: disable=protected-access |
| 183 | + |
| 184 | + |
| 185 | +# --------------------------------------------------------------------------- |
| 186 | +# _validate_message |
| 187 | +# --------------------------------------------------------------------------- |
| 188 | + |
| 189 | + |
| 190 | +def test_validate_message(handler): |
| 191 | + valid_text = {"role": "user", "content": {"type": "text", "text": "hi"}} |
| 192 | + valid_image = { |
| 193 | + "role": "assistant", |
| 194 | + "content": {"type": "image", "data": "xxx", "mime_type": "image/png"}, |
| 195 | + } |
| 196 | + invalid = {"role": "user", "content": {"type": "text"}} # missing text value |
| 197 | + |
| 198 | + assert handler._validate_message(valid_text) # pylint: disable=protected-access |
| 199 | + assert handler._validate_message(valid_image) # pylint: disable=protected-access |
| 200 | + assert not handler._validate_message(invalid) # pylint: disable=protected-access |
| 201 | + |
| 202 | + |
| 203 | +# --------------------------------------------------------------------------- |
| 204 | +# create_message success + error paths |
| 205 | +# --------------------------------------------------------------------------- |
| 206 | + |
| 207 | + |
| 208 | +@pytest.mark.asyncio |
| 209 | +async def test_create_message_success(monkeypatch, handler): |
| 210 | + # Patch ModelPreferences.parse_obj to return neutral prefs (no hints) |
| 211 | + neutral_prefs = _t.SimpleNamespace(hints=[], cost_priority=0.33, speed_priority=0.33, intelligence_priority=0.34) |
| 212 | + monkeypatch.setattr(sp.ModelPreferences, "parse_obj", lambda _x: neutral_prefs) |
| 213 | + |
| 214 | + request = { |
| 215 | + "messages": [ |
| 216 | + {"role": "user", "content": {"type": "text", "text": "Hello"}}, |
| 217 | + ], |
| 218 | + "maxTokens": 5, |
| 219 | + "modelPreferences": {}, |
| 220 | + } |
| 221 | + |
| 222 | + result = await handler.create_message(db=None, request=request) |
| 223 | + |
| 224 | + assert result.role == sp.Role.ASSISTANT |
| 225 | + assert result.content.text.startswith("You said: Hello") |
| 226 | + |
| 227 | + |
| 228 | +@pytest.mark.asyncio |
| 229 | +async def test_create_message_no_messages(monkeypatch, handler): |
| 230 | + monkeypatch.setattr(sp.ModelPreferences, "parse_obj", lambda _x: _t.SimpleNamespace(hints=[], cost_priority=0, speed_priority=0, intelligence_priority=0)) |
| 231 | + |
| 232 | + request = {"messages": [], "maxTokens": 5, "modelPreferences": {}} |
| 233 | + |
| 234 | + with pytest.raises(SamplingError): |
| 235 | + await handler.create_message(db=None, request=request) |
0 commit comments