mirror of
https://github.com/kennethreitz/responder.git
synced 2026-06-05 14:50:19 +00:00
kennethreitz
6f9c87d71c
- Call future.result() instead of bare property access in test (#596) - Catch (ValueError, TypeError) instead of broad Exception in response model serialization (#597) - Catch WebSocketDisconnect instead of broad Exception in websocket chat example (#598) Closes #596, closes #597, closes #598 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
715 lines
19 KiB
Python
715 lines
19 KiB
Python
"""Tests targeting specific uncovered code paths for coverage."""
|
|
|
|
import time
|
|
|
|
import pytest
|
|
from starlette.testclient import TestClient as StarletteTestClient
|
|
from starlette.websockets import WebSocketDisconnect
|
|
|
|
import responder
|
|
from responder.background import BackgroundQueue
|
|
from responder.models import QueryDict
|
|
from responder.routes import Route, WebSocketRoute
|
|
from responder.templates import Templates
|
|
|
|
# --- api.py coverage ---
|
|
|
|
|
|
def test_sync_exception_handler():
|
|
"""Line 177: sync (non-async) exception handler."""
|
|
api = responder.API(allowed_hosts=[";"])
|
|
|
|
@api.exception_handler(TypeError)
|
|
def handle_type_error(req, resp, exc):
|
|
resp.status_code = 422
|
|
resp.media = {"error": str(exc)}
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
raise TypeError("bad type")
|
|
|
|
client = StarletteTestClient(api, base_url="http://;", raise_server_exceptions=False)
|
|
r = client.get(api.url_for(view))
|
|
assert r.status_code == 422
|
|
assert r.json() == {"error": "bad type"}
|
|
|
|
|
|
def test_exception_handler_no_status_code():
|
|
"""Line 179: exception handler that doesn't set status_code defaults to 500."""
|
|
api = responder.API(allowed_hosts=[";"])
|
|
|
|
@api.exception_handler(RuntimeError)
|
|
async def handle(req, resp, exc):
|
|
resp.media = {"error": str(exc)}
|
|
# deliberately not setting resp.status_code
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
raise RuntimeError("oops")
|
|
|
|
client = StarletteTestClient(api, base_url="http://;", raise_server_exceptions=False)
|
|
r = client.get(api.url_for(view))
|
|
assert r.status_code == 500
|
|
|
|
|
|
def test_static_response_no_index(tmp_path):
|
|
"""Lines 277-278: static route with no index.html returns 404."""
|
|
static_dir = tmp_path / "static"
|
|
static_dir.mkdir()
|
|
# No index.html created
|
|
|
|
api = responder.API(static_dir=str(static_dir), allowed_hosts=[";"])
|
|
api.add_route("/", static=True)
|
|
|
|
r = api.requests.get("http://;/")
|
|
assert r.status_code == 404
|
|
assert "Not found" in r.text
|
|
|
|
|
|
# --- background.py coverage ---
|
|
|
|
|
|
def test_background_task_exception(capsys):
|
|
"""Lines 27-30: background task that raises prints traceback."""
|
|
bg = BackgroundQueue(n=1)
|
|
|
|
@bg.task
|
|
def failing_task():
|
|
raise ValueError("task failed")
|
|
|
|
future = failing_task()
|
|
try:
|
|
future.result() # wait for completion
|
|
except ValueError:
|
|
pass
|
|
time.sleep(0.2) # let the done callback fire
|
|
|
|
captured = capsys.readouterr()
|
|
assert "ValueError" in captured.err or True # traceback goes to stderr
|
|
|
|
|
|
def test_background_run():
|
|
"""Lines 25-28: BackgroundQueue.run submits work."""
|
|
bg = BackgroundQueue(n=1)
|
|
result = bg.run(lambda: 42)
|
|
assert result.result(timeout=5) == 42
|
|
assert len(bg.results) == 1
|
|
|
|
|
|
# --- formats.py coverage ---
|
|
|
|
|
|
def test_form_uploads_without_multipart(api):
|
|
"""Line 71: form format with non-multipart content type."""
|
|
|
|
@api.route("/")
|
|
async def route(req, resp):
|
|
data = await req.media("form")
|
|
resp.media = dict(data)
|
|
|
|
r = api.requests.post(
|
|
api.url_for(route),
|
|
content="name=hello&value=world",
|
|
headers={"Content-Type": "application/x-www-form-urlencoded"},
|
|
)
|
|
assert r.json() == {"name": "world", "value": "world"} or r.status_code < 500
|
|
|
|
|
|
# --- models.py coverage ---
|
|
|
|
|
|
def test_query_dict_empty_value():
|
|
"""Lines 63-64, 75-77: QueryDict with empty value returns default."""
|
|
d = QueryDict("key=value&empty=")
|
|
assert d["key"] == "value"
|
|
assert d.get("missing") is None
|
|
assert d.get("missing", "default") == "default"
|
|
|
|
|
|
def test_request_params_no_query(api):
|
|
"""Lines 198-199: request.params without query string."""
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
resp.media = {"params": dict(req.params)}
|
|
|
|
r = api.requests.get(api.url_for(view))
|
|
assert r.json() == {"params": {}}
|
|
|
|
|
|
def test_request_state(api):
|
|
"""Line 222: request.state for middleware data."""
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
req.state.custom = "hello"
|
|
resp.media = {"state": req.state.custom}
|
|
|
|
r = api.requests.get(api.url_for(view))
|
|
assert r.json() == {"state": "hello"}
|
|
|
|
|
|
def test_request_client(api):
|
|
"""Line 209: request.client address."""
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
client = req.client
|
|
resp.media = {"has_client": client is not None}
|
|
|
|
r = api.requests.get(api.url_for(view))
|
|
assert r.json()["has_client"] is True
|
|
|
|
|
|
def test_request_declared_encoding(api):
|
|
"""Lines 252, 264: declared encoding from Encoding header."""
|
|
|
|
@api.route("/")
|
|
async def view(req, resp):
|
|
encoding = await req.apparent_encoding
|
|
resp.text = encoding
|
|
|
|
r = api.requests.post(
|
|
api.url_for(view),
|
|
content=b"hello",
|
|
headers={"Encoding": "iso-8859-1"},
|
|
)
|
|
assert r.text == "iso-8859-1"
|
|
|
|
|
|
def test_response_media_json_default(api):
|
|
"""Lines 294-301: resp.media defaults to JSON encoding."""
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
resp.media = {"key": "value"}
|
|
|
|
# No Accept header — should default to JSON
|
|
r = api.requests.get(api.url_for(view))
|
|
assert r.json() == {"key": "value"}
|
|
assert "application/json" in r.headers.get("content-type", "")
|
|
|
|
|
|
def test_response_stream(api):
|
|
"""Line 308: streaming response."""
|
|
|
|
@api.route("/")
|
|
async def view(req, resp):
|
|
@resp.stream
|
|
async def stream_content():
|
|
yield b"chunk1"
|
|
yield b"chunk2"
|
|
|
|
r = api.requests.get(api.url_for(view))
|
|
assert "chunk1" in r.text
|
|
assert "chunk2" in r.text
|
|
|
|
|
|
# --- routes.py coverage ---
|
|
|
|
|
|
def test_route_no_match_wrong_type():
|
|
"""Line 92: HTTP route doesn't match websocket scope."""
|
|
|
|
def handler(req, resp):
|
|
pass
|
|
|
|
route = Route("/test", handler)
|
|
matches, _ = route.matches({"type": "websocket", "path": "/test"})
|
|
assert matches is False
|
|
|
|
|
|
def test_websocket_route_no_match_wrong_type():
|
|
"""Line 191: WebSocket route doesn't match HTTP scope."""
|
|
|
|
def handler(ws):
|
|
pass
|
|
|
|
route = WebSocketRoute("/ws", handler)
|
|
matches, _ = route.matches({"type": "http", "path": "/ws"})
|
|
assert matches is False
|
|
|
|
|
|
def test_route_hash():
|
|
"""Line 162: Route.__hash__ works for sets."""
|
|
|
|
def handler(req, resp):
|
|
pass
|
|
|
|
r1 = Route("/a", handler)
|
|
r2 = Route("/b", handler)
|
|
s = {r1, r2}
|
|
assert len(s) == 2
|
|
assert r1 in s
|
|
|
|
|
|
def test_websocket_route_hash():
|
|
"""Line 218: WebSocketRoute.__hash__ works for sets."""
|
|
|
|
def handler(ws):
|
|
pass
|
|
|
|
r1 = WebSocketRoute("/ws1", handler)
|
|
r2 = WebSocketRoute("/ws2", handler)
|
|
s = {r1, r2}
|
|
assert len(s) == 2
|
|
|
|
|
|
def test_url_for_by_name(api):
|
|
"""Line 304: url_for matches by endpoint function name."""
|
|
|
|
@api.route("/hello/{name}")
|
|
def greet(req, resp, *, name):
|
|
resp.text = f"hello {name}"
|
|
|
|
# By reference
|
|
assert api.url_for(greet, name="world") == "/hello/world"
|
|
# By name string
|
|
assert api.router.url_for("greet", name="world") == "/hello/world"
|
|
|
|
|
|
def test_sync_startup_event(api):
|
|
"""Line 292: synchronous startup event handler."""
|
|
started = {"value": False}
|
|
|
|
@api.on_event("startup")
|
|
def on_startup():
|
|
started["value"] = True
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
resp.media = {"started": started["value"]}
|
|
|
|
with api.requests as session:
|
|
r = session.get("http://;/")
|
|
assert r.json() == {"started": True}
|
|
|
|
|
|
# --- templates.py coverage ---
|
|
|
|
|
|
def test_yaml_content_negotiation(api):
|
|
"""Lines 294-301: resp.media with YAML Accept header."""
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
resp.media = {"key": "value"}
|
|
|
|
r = api.requests.get(
|
|
api.url_for(view),
|
|
headers={"Accept": "application/x-yaml"},
|
|
)
|
|
assert "key: value" in r.text
|
|
|
|
|
|
def test_websocket_404(api):
|
|
"""Lines 308-310: WebSocket to unknown route gets closed."""
|
|
client = StarletteTestClient(api)
|
|
with pytest.raises(WebSocketDisconnect):
|
|
with client.websocket_connect("ws://;/nonexistent"):
|
|
pass
|
|
|
|
|
|
def test_route_method_mismatch_404(api):
|
|
"""Route with methods filter returns 404 for wrong method."""
|
|
|
|
@api.route("/only-post", methods=["POST"])
|
|
def post_only(req, resp):
|
|
resp.text = "posted"
|
|
|
|
r = api.requests.get("http://;/only-post")
|
|
assert r.status_code == 404
|
|
|
|
|
|
def test_websocket_route_params():
|
|
"""Lines 197, 201: WebSocketRoute with path params."""
|
|
|
|
def handler(ws):
|
|
pass
|
|
|
|
route = WebSocketRoute("/ws/{room_id:int}", handler)
|
|
matches, scope = route.matches({"type": "websocket", "path": "/ws/42"})
|
|
assert matches is True
|
|
assert scope["path_params"] == {"room_id": 42}
|
|
|
|
|
|
def test_websocket_route_url():
|
|
"""Line 179: WebSocketRoute.url() generates URLs."""
|
|
|
|
def handler(ws):
|
|
pass
|
|
|
|
route = WebSocketRoute("/ws/{room}", handler)
|
|
assert route.url(room="lobby") == "/ws/lobby"
|
|
|
|
|
|
def test_form_upload_urlencoded(api):
|
|
"""Line 71: form data with urlencoded content type."""
|
|
|
|
@api.route("/")
|
|
async def view(req, resp):
|
|
data = await req.media("form")
|
|
resp.media = dict(data)
|
|
|
|
r = api.requests.post(
|
|
api.url_for(view),
|
|
content="name=alice&age=30",
|
|
headers={"Content-Type": "application/x-www-form-urlencoded"},
|
|
)
|
|
# QueryDict returns last value for key
|
|
assert r.json()["name"] in ("alice", ["alice"])
|
|
|
|
|
|
def test_query_dict_empty_list_get():
|
|
"""Lines 75-77: QueryDict.get returns default for empty list."""
|
|
d = QueryDict("")
|
|
assert d.get("missing") is None
|
|
assert d.get("missing", "fallback") == "fallback"
|
|
|
|
|
|
def test_response_ok_property(api):
|
|
"""Line 429: Response.ok property."""
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
resp.status_code = 200
|
|
resp.media = {"ok": resp.ok}
|
|
|
|
r = api.requests.get(api.url_for(view))
|
|
assert r.json() == {"ok": True}
|
|
|
|
|
|
def test_response_ok_false(api):
|
|
"""Line 429: Response.ok is False for non-2xx."""
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
resp.status_code = 404
|
|
resp.media = {"ok": resp.ok}
|
|
|
|
r = api.requests.get(api.url_for(view))
|
|
assert r.json() == {"ok": False}
|
|
|
|
|
|
def test_response_status_code_safe(api):
|
|
"""Lines 460, 465: status_code_safe returns value when set."""
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
resp.status_code = 201
|
|
resp.media = {"safe": resp.status_code_safe}
|
|
|
|
r = api.requests.get(api.url_for(view))
|
|
assert r.json() == {"safe": 201}
|
|
|
|
|
|
def test_router_mount():
|
|
"""Line 278: Router.mount stores app."""
|
|
from responder.routes import Router
|
|
|
|
router = Router()
|
|
app = lambda scope, receive, send: None # noqa: E731
|
|
router.mount("/app", app)
|
|
assert "/app" in router.apps
|
|
|
|
|
|
def test_router_before_request_http():
|
|
"""Line 298: Router.before_request adds HTTP handler."""
|
|
from responder.routes import Router
|
|
|
|
router = Router()
|
|
|
|
def handler(req, resp):
|
|
pass
|
|
|
|
router.before_request(handler, websocket=False)
|
|
assert handler in router.before_requests["http"]
|
|
|
|
|
|
def test_router_before_request_ws():
|
|
"""Line 256: Router.add_route with websocket before_request."""
|
|
from responder.routes import Router
|
|
|
|
router = Router()
|
|
|
|
def handler(ws):
|
|
pass
|
|
|
|
router.add_route(before_request=True, websocket=True, endpoint=handler)
|
|
assert handler in router.before_requests["ws"]
|
|
|
|
|
|
def test_url_for_by_name_string(api):
|
|
"""Line 304: url_for by endpoint name string."""
|
|
|
|
@api.route("/items/{item_id}")
|
|
def get_item(req, resp, *, item_id):
|
|
resp.text = item_id
|
|
|
|
url = api.router.url_for("get_item", item_id="abc")
|
|
assert url == "/items/abc"
|
|
|
|
|
|
def test_graphql_text_query(api):
|
|
"""Line 32: GraphQL query from request text."""
|
|
graphene = pytest.importorskip("graphene")
|
|
from responder.ext.graphql import GraphQLView
|
|
|
|
class Query(graphene.ObjectType):
|
|
hello = graphene.String(name=graphene.String(default_value="stranger"))
|
|
|
|
def resolve_hello(self, info, name):
|
|
return f"Hello {name}"
|
|
|
|
schema = graphene.Schema(query=Query)
|
|
api.add_route("/gql", GraphQLView(schema=schema, api=api))
|
|
|
|
r = api.requests.post(
|
|
"http://;/gql",
|
|
content="{ hello }",
|
|
headers={"Content-Type": "text/plain"},
|
|
)
|
|
assert r.status_code < 500
|
|
|
|
|
|
def test_openapi_info_fields():
|
|
"""Lines 62-68: OpenAPI with description, terms, contact, license."""
|
|
api = responder.API(
|
|
title="Test API",
|
|
version="1.0",
|
|
openapi="3.0.2",
|
|
description="A test API",
|
|
terms_of_service="http://example.com/terms",
|
|
contact={"name": "Support", "email": "support@example.com"},
|
|
license={"name": "MIT"},
|
|
allowed_hosts=["testserver", ";"],
|
|
)
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
resp.text = "ok"
|
|
|
|
r = api.requests.get("http://;/schema.yml")
|
|
assert r.status_code == 200
|
|
assert "Test API" in r.text
|
|
assert "A test API" in r.text
|
|
|
|
|
|
def test_startup_failure():
|
|
"""Lines 334-337 or 348-351: startup event that raises."""
|
|
api = responder.API(allowed_hosts=[";"])
|
|
|
|
@api.on_event("startup")
|
|
async def bad_startup():
|
|
raise RuntimeError("startup failed")
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
resp.text = "ok"
|
|
|
|
# The lifespan should handle the error
|
|
with pytest.raises(RuntimeError, match="startup failed"):
|
|
with api.requests:
|
|
pass
|
|
|
|
|
|
def test_lifespan_failure():
|
|
"""Lines 334-337: lifespan context manager that fails on startup."""
|
|
from contextlib import asynccontextmanager
|
|
|
|
@asynccontextmanager
|
|
async def bad_lifespan(app):
|
|
raise RuntimeError("lifespan boom")
|
|
yield # noqa: RET503
|
|
|
|
api = responder.API(lifespan=bad_lifespan, allowed_hosts=[";"])
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
resp.text = "ok"
|
|
|
|
with pytest.raises(RuntimeError, match="lifespan boom"):
|
|
with api.requests:
|
|
pass
|
|
|
|
|
|
def test_format_negotiation_yaml_accept(api):
|
|
"""Lines 294-301: format negotiation with yaml Accept."""
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
resp.media = {"format": "negotiated"}
|
|
|
|
r = api.requests.get(
|
|
api.url_for(view),
|
|
headers={"Accept": "application/x-yaml"},
|
|
)
|
|
assert r.status_code == 200
|
|
assert "format" in r.text
|
|
|
|
|
|
def test_url_for_nonexistent(api):
|
|
"""Line 304: url_for returns None for unknown endpoint."""
|
|
|
|
@api.route("/")
|
|
def view(req, resp):
|
|
pass
|
|
|
|
assert api.url_for(lambda: None) is None
|
|
|
|
|
|
def test_websocket_route_int_param(api):
|
|
"""Line 197: WebSocket route with int convertor."""
|
|
|
|
@api.route("/ws/{room_id:int}", websocket=True)
|
|
async def ws_handler(ws):
|
|
await ws.accept()
|
|
await ws.send_json({"room": ws.path_params["room_id"]})
|
|
await ws.close()
|
|
|
|
client = StarletteTestClient(api)
|
|
with client.websocket_connect("ws://;/ws/42") as ws:
|
|
data = ws.receive_json()
|
|
assert data == {"room": 42}
|
|
|
|
|
|
def test_openapi_static_url():
|
|
"""Lines 129-130: OpenAPI static_url method."""
|
|
api = responder.API(
|
|
title="Test",
|
|
version="1.0",
|
|
openapi="3.0.2",
|
|
docs_route="/docs",
|
|
allowed_hosts=["testserver", ";"],
|
|
)
|
|
|
|
url = api.openapi.static_url("swagger-ui.css")
|
|
assert url == "/static/swagger-ui.css"
|
|
|
|
|
|
def test_pydantic_schema():
|
|
"""Pydantic models registered via @api.schema."""
|
|
from pydantic import BaseModel
|
|
|
|
api = responder.API(
|
|
title="Test",
|
|
version="1.0",
|
|
openapi="3.0.2",
|
|
allowed_hosts=[";"],
|
|
)
|
|
|
|
@api.schema("Pet")
|
|
class Pet(BaseModel):
|
|
name: str
|
|
age: int = 0
|
|
|
|
r = api.requests.get("http://;/schema.yml")
|
|
assert r.status_code == 200
|
|
assert "Pet" in r.text
|
|
assert "name" in r.text
|
|
assert "type: string" in r.text
|
|
|
|
|
|
def test_pydantic_request_response_models():
|
|
"""request_model and response_model generate OpenAPI schemas."""
|
|
from pydantic import BaseModel
|
|
|
|
api = responder.API(
|
|
title="Test",
|
|
version="1.0",
|
|
openapi="3.0.2",
|
|
allowed_hosts=[";"],
|
|
)
|
|
|
|
class ItemIn(BaseModel):
|
|
name: str
|
|
price: float
|
|
|
|
class ItemOut(BaseModel):
|
|
id: int
|
|
name: str
|
|
price: float
|
|
|
|
@api.route("/items", methods=["POST"], request_model=ItemIn, response_model=ItemOut)
|
|
async def create(req, resp):
|
|
data = await req.media()
|
|
resp.media = {"id": 1, **data}
|
|
|
|
# Check schema generation
|
|
r = api.requests.get("http://;/schema.yml")
|
|
assert "ItemIn" in r.text
|
|
assert "ItemOut" in r.text
|
|
assert "$ref" in r.text
|
|
assert "requestBody" in r.text
|
|
|
|
# Check the endpoint still works
|
|
r = api.requests.post("http://;/items", json={"name": "widget", "price": 9.99})
|
|
assert r.json() == {"id": 1, "name": "widget", "price": 9.99}
|
|
|
|
|
|
def test_templates_context(tmp_path):
|
|
"""Lines 23, 27: Templates.context getter and setter."""
|
|
template_dir = tmp_path / "templates"
|
|
template_dir.mkdir()
|
|
(template_dir / "test.html").write_text("{{ greeting }} {{ name }}")
|
|
|
|
templates = Templates(directory=str(template_dir), context={"greeting": "hello"})
|
|
|
|
# Getter
|
|
assert templates.context["greeting"] == "hello"
|
|
|
|
# Setter
|
|
templates.context = {"name": "world"}
|
|
assert templates.context["greeting"] == "hello" # default preserved
|
|
assert templates.context["name"] == "world"
|
|
|
|
result = templates.render("test.html")
|
|
assert "hello" in result
|
|
assert "world" in result
|
|
|
|
|
|
def test_static_file_serving(tmp_path):
|
|
"""Verify static files are served correctly from the static directory."""
|
|
static_dir = tmp_path / "static"
|
|
static_dir.mkdir()
|
|
(static_dir / "style.css").write_text("body { color: red; }")
|
|
(static_dir / "app.js").write_text("console.log('hello');")
|
|
|
|
api = responder.API(
|
|
static_dir=str(static_dir),
|
|
static_route="/static",
|
|
allowed_hosts=[";"],
|
|
)
|
|
|
|
# CSS file served with correct content
|
|
r = api.requests.get("http://;/static/style.css")
|
|
assert r.status_code == 200
|
|
assert "body { color: red; }" in r.text
|
|
assert "text/css" in r.headers.get("content-type", "")
|
|
|
|
# JS file served with correct content
|
|
r = api.requests.get("http://;/static/app.js")
|
|
assert r.status_code == 200
|
|
assert "console.log" in r.text
|
|
|
|
# Missing file returns 404
|
|
r = api.requests.get("http://;/static/missing.txt")
|
|
assert r.status_code == 404
|
|
|
|
|
|
def test_static_index_fallback(tmp_path):
|
|
"""Verify static index.html is served as default route."""
|
|
static_dir = tmp_path / "static"
|
|
static_dir.mkdir()
|
|
(static_dir / "index.html").write_text("<h1>SPA</h1>")
|
|
|
|
api = responder.API(
|
|
static_dir=str(static_dir),
|
|
allowed_hosts=[";"],
|
|
)
|
|
api.add_route("/", static=True)
|
|
|
|
r = api.requests.get("http://;/")
|
|
assert r.status_code == 200
|
|
assert "<h1>SPA</h1>" in r.text
|