mirror of
https://github.com/jmagar/unraid-mcp.git
synced 2026-03-02 00:04:45 -08:00
refactor: comprehensive code review fixes across 31 files
Addresses all critical, high, medium, and low issues from full codebase review. 494 tests pass, ruff clean, ty type-check clean. Security: - Add tool_error_handler context manager (exceptions.py) — standardised error handling, eliminates 11 bare except-reraise patterns - Remove unused exception subclasses (ConfigurationError, UnraidAPIError, SubscriptionError, ValidationError, IdempotentOperationError) - Harden GraphQL subscription query validator with allow-list and forbidden-keyword regex (diagnostics.py) - Add input validation for rclone create_remote config_data: injection, path-traversal, and key-count limits (rclone.py) - Validate notifications importance enum before GraphQL request (notifications.py) - Sanitise HTTP/network/JSON error messages — no raw exception strings leaked to clients (client.py) - Strip path/creds from displayed API URL via _safe_display_url (health.py) - Enable Ruff S (bandit) rule category in pyproject.toml - Harden container mutations to strict-only matching — no fuzzy/substring for destructive operations (docker.py) Performance: - Token-bucket rate limiter (90 tokens, 9 req/s) with 429 retry backoff (client.py) - Lazy asyncio.Lock init via _get_client_lock() — fixes event-loop module-load crash (client.py) - Double-checked locking in get_http_client() for fast-path (client.py) - Short hex container ID fast-path skips list fetch (docker.py) - Cap resource_data log content to 1 MB / 5,000 lines (manager.py) - Reset reconnect counter after 30 s stable connection (manager.py) - Move tail_lines validation to module level; enforce 10,000 line cap (storage.py, docker.py) - force_terminal=True removed from logging RichHandler (logging.py) Architecture: - Register diagnostic tools in server startup (server.py) - Move ALL_ACTIONS computation to module level in all tools - Consolidate format_kb / format_bytes into shared core/utils.py - Add _safe_get() helper in core/utils.py for nested dict traversal - Extract _analyze_subscription_status() from health.py diagnose handler - Validate required config at startup — fail fast with CRITICAL log (server.py) Code quality: - Remove ~90 lines of dead Rich formatting helpers from logging.py - Remove dead self.websocket attribute from SubscriptionManager - Remove dead setup_uvicorn_logging() wrapper - Move _VALID_IMPORTANCE to module level (N806 fix) - Add slots=True to all three dataclasses (SubscriptionData, SystemHealth, APIResponse) - Fix None rendering as literal "None" string in info.py summaries - Change fuzzy-match log messages from INFO to DEBUG (docker.py) - UTC-aware datetimes throughout (manager.py, diagnostics.py) Infrastructure: - Upgrade base image python:3.11-slim → python:3.12-slim (Dockerfile) - Add non-root appuser (UID/GID 1000) with HEALTHCHECK (Dockerfile) - Add read_only, cap_drop: ALL, tmpfs /tmp to docker-compose.yml - Single-source version via importlib.metadata (pyproject.toml → __init__.py) - Add open_timeout to all websockets.connect() calls Tests: - Update error message matchers to match sanitised messages (test_client.py) - Fix patch targets for UNRAID_API_URL → utils module (test_subscriptions.py) - Fix importance="info" → importance="normal" (test_notifications.py, http_layer) - Fix naive datetime fixtures → UTC-aware (test_subscriptions.py) Co-authored-by: Claude <claude@anthropic.com>
This commit is contained in:
@@ -158,43 +158,43 @@ class TestHttpErrorHandling:
|
||||
@respx.mock
|
||||
async def test_http_401_raises_tool_error(self) -> None:
|
||||
respx.post(API_URL).mock(return_value=httpx.Response(401, text="Unauthorized"))
|
||||
with pytest.raises(ToolError, match="HTTP error 401"):
|
||||
with pytest.raises(ToolError, match="Unraid API returned HTTP 401"):
|
||||
await make_graphql_request("query { online }")
|
||||
|
||||
@respx.mock
|
||||
async def test_http_403_raises_tool_error(self) -> None:
|
||||
respx.post(API_URL).mock(return_value=httpx.Response(403, text="Forbidden"))
|
||||
with pytest.raises(ToolError, match="HTTP error 403"):
|
||||
with pytest.raises(ToolError, match="Unraid API returned HTTP 403"):
|
||||
await make_graphql_request("query { online }")
|
||||
|
||||
@respx.mock
|
||||
async def test_http_500_raises_tool_error(self) -> None:
|
||||
respx.post(API_URL).mock(return_value=httpx.Response(500, text="Internal Server Error"))
|
||||
with pytest.raises(ToolError, match="HTTP error 500"):
|
||||
with pytest.raises(ToolError, match="Unraid API returned HTTP 500"):
|
||||
await make_graphql_request("query { online }")
|
||||
|
||||
@respx.mock
|
||||
async def test_http_503_raises_tool_error(self) -> None:
|
||||
respx.post(API_URL).mock(return_value=httpx.Response(503, text="Service Unavailable"))
|
||||
with pytest.raises(ToolError, match="HTTP error 503"):
|
||||
with pytest.raises(ToolError, match="Unraid API returned HTTP 503"):
|
||||
await make_graphql_request("query { online }")
|
||||
|
||||
@respx.mock
|
||||
async def test_network_connection_error(self) -> None:
|
||||
respx.post(API_URL).mock(side_effect=httpx.ConnectError("Connection refused"))
|
||||
with pytest.raises(ToolError, match="Network connection error"):
|
||||
with pytest.raises(ToolError, match="Network error connecting to Unraid API"):
|
||||
await make_graphql_request("query { online }")
|
||||
|
||||
@respx.mock
|
||||
async def test_network_timeout_error(self) -> None:
|
||||
respx.post(API_URL).mock(side_effect=httpx.ReadTimeout("Read timed out"))
|
||||
with pytest.raises(ToolError, match="Network connection error"):
|
||||
with pytest.raises(ToolError, match="Network error connecting to Unraid API"):
|
||||
await make_graphql_request("query { online }")
|
||||
|
||||
@respx.mock
|
||||
async def test_invalid_json_response(self) -> None:
|
||||
respx.post(API_URL).mock(return_value=httpx.Response(200, text="not json"))
|
||||
with pytest.raises(ToolError, match="Invalid JSON response"):
|
||||
with pytest.raises(ToolError, match="invalid response"):
|
||||
await make_graphql_request("query { online }")
|
||||
|
||||
|
||||
@@ -868,14 +868,14 @@ class TestNotificationsToolRequests:
|
||||
title="Test",
|
||||
subject="Sub",
|
||||
description="Desc",
|
||||
importance="info",
|
||||
importance="normal",
|
||||
)
|
||||
body = _extract_request_body(route.calls.last.request)
|
||||
assert "CreateNotification" in body["query"]
|
||||
inp = body["variables"]["input"]
|
||||
assert inp["title"] == "Test"
|
||||
assert inp["subject"] == "Sub"
|
||||
assert inp["importance"] == "INFO" # uppercased
|
||||
assert inp["importance"] == "NORMAL" # uppercased from "normal"
|
||||
|
||||
@respx.mock
|
||||
async def test_archive_sends_id_variable(self) -> None:
|
||||
@@ -1256,7 +1256,7 @@ class TestCrossCuttingConcerns:
|
||||
tool = make_tool_fn(
|
||||
"unraid_mcp.tools.info", "register_info_tool", "unraid_info"
|
||||
)
|
||||
with pytest.raises(ToolError, match="HTTP error 500"):
|
||||
with pytest.raises(ToolError, match="Unraid API returned HTTP 500"):
|
||||
await tool(action="online")
|
||||
|
||||
@respx.mock
|
||||
@@ -1268,7 +1268,7 @@ class TestCrossCuttingConcerns:
|
||||
tool = make_tool_fn(
|
||||
"unraid_mcp.tools.info", "register_info_tool", "unraid_info"
|
||||
)
|
||||
with pytest.raises(ToolError, match="Network connection error"):
|
||||
with pytest.raises(ToolError, match="Network error connecting to Unraid API"):
|
||||
await tool(action="online")
|
||||
|
||||
@respx.mock
|
||||
|
||||
Reference in New Issue
Block a user