forked from HomeLab/unraid-mcp
f76e676fd4
Critical bug fixes from PR review agents: - client.py: eager asyncio.Lock init, Final[frozenset] for _SENSITIVE_KEYS, explicit 429 ToolError after retries exhausted, removed lazy _get_client_lock() and _RateLimiter._get_lock() patterns - exceptions.py: use builtin TimeoutError (UP041), explicit handler before broad except so asyncio timeouts get descriptive messages - docker.py: add update_all to DESTRUCTIVE_ACTIONS (was missing), remove dead _MUTATION_ACTIONS constant - manager.py: _cap_log_content returns new dict (immutable), lock write to resource_data, clean dead task from active_subscriptions after loop exits - diagnostics.py: fix inaccurate comment about semicolon injection guard - health.py: narrow except ValueError in _safe_display_url, fix TODO comment New test coverage (98 tests added, 529 → 598 passing): - test_subscription_validation.py: 27 tests for _validate_subscription_query (security-critical allow-list, forbidden keyword guards, word-boundary test) - test_subscription_manager.py: 12 tests for _cap_log_content (immutability, truncation, nesting, passthrough) - test_client.py: +57 tests — _RateLimiter (token math, refill, sleep-on-empty), _QueryCache (TTL, invalidation, is_cacheable), 429 retry loop (1/2/3 failures) - test_health.py: +10 tests for _safe_display_url (credential strip, port, path/query removal, malformed IPv6 → <unparseable>) - test_notifications.py: +7 importance enum and field length validation tests - test_rclone.py: +7 _validate_config_data security guard tests - test_storage.py: +15 (tail_lines bounds, format_kb, safe_get) - test_docker.py: update_all now requires confirm=True + new guard test - test_destructive_guards.py: update audit to include update_all Co-authored-by: Claude <noreply@anthropic.com>
324 lines
13 KiB
Python
324 lines
13 KiB
Python
"""Tests for unraid_docker tool."""
|
|
|
|
from collections.abc import Generator
|
|
from unittest.mock import AsyncMock, patch
|
|
|
|
import pytest
|
|
from conftest import make_tool_fn
|
|
|
|
from unraid_mcp.core.exceptions import ToolError
|
|
from unraid_mcp.tools.docker import find_container_by_identifier, get_available_container_names
|
|
|
|
|
|
# --- Unit tests for helpers ---
|
|
|
|
|
|
class TestFindContainerByIdentifier:
|
|
def test_by_exact_id(self) -> None:
|
|
containers = [{"id": "abc123", "names": ["plex"]}]
|
|
assert find_container_by_identifier("abc123", containers) == containers[0]
|
|
|
|
def test_by_exact_name(self) -> None:
|
|
containers = [{"id": "abc123", "names": ["plex"]}]
|
|
assert find_container_by_identifier("plex", containers) == containers[0]
|
|
|
|
def test_fuzzy_match(self) -> None:
|
|
containers = [{"id": "abc123", "names": ["plex-media-server"]}]
|
|
result = find_container_by_identifier("plex", containers)
|
|
assert result == containers[0]
|
|
|
|
def test_not_found(self) -> None:
|
|
containers = [{"id": "abc123", "names": ["plex"]}]
|
|
assert find_container_by_identifier("sonarr", containers) is None
|
|
|
|
def test_empty_list(self) -> None:
|
|
assert find_container_by_identifier("plex", []) is None
|
|
|
|
|
|
class TestGetAvailableContainerNames:
|
|
def test_extracts_names(self) -> None:
|
|
containers = [
|
|
{"names": ["plex"]},
|
|
{"names": ["sonarr", "sonarr-v3"]},
|
|
]
|
|
names = get_available_container_names(containers)
|
|
assert "plex" in names
|
|
assert "sonarr" in names
|
|
assert "sonarr-v3" in names
|
|
|
|
def test_empty(self) -> None:
|
|
assert get_available_container_names([]) == []
|
|
|
|
|
|
# --- Integration tests ---
|
|
|
|
|
|
@pytest.fixture
|
|
def _mock_graphql() -> Generator[AsyncMock, None, None]:
|
|
with patch("unraid_mcp.tools.docker.make_graphql_request", new_callable=AsyncMock) as mock:
|
|
yield mock
|
|
|
|
|
|
def _make_tool():
|
|
return make_tool_fn("unraid_mcp.tools.docker", "register_docker_tool", "unraid_docker")
|
|
|
|
|
|
class TestDockerValidation:
|
|
async def test_remove_requires_confirm(self, _mock_graphql: AsyncMock) -> None:
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="destructive"):
|
|
await tool_fn(action="remove", container_id="abc123")
|
|
|
|
@pytest.mark.parametrize("action", ["start", "stop", "details", "logs", "pause", "unpause"])
|
|
async def test_container_actions_require_id(self, _mock_graphql: AsyncMock, action: str) -> None:
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="container_id"):
|
|
await tool_fn(action=action)
|
|
|
|
async def test_network_details_requires_id(self, _mock_graphql: AsyncMock) -> None:
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="network_id"):
|
|
await tool_fn(action="network_details")
|
|
|
|
|
|
class TestDockerActions:
|
|
async def test_list(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {
|
|
"docker": {"containers": [{"id": "c1", "names": ["plex"], "state": "running"}]}
|
|
}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="list")
|
|
assert len(result["containers"]) == 1
|
|
|
|
async def test_start_container(self, _mock_graphql: AsyncMock) -> None:
|
|
# First call resolves ID, second performs start
|
|
cid = "a" * 64 + ":local"
|
|
_mock_graphql.side_effect = [
|
|
{
|
|
"docker": {
|
|
"containers": [
|
|
{"id": cid, "names": ["plex"]}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"docker": {
|
|
"start": {
|
|
"id": cid,
|
|
"state": "running",
|
|
}
|
|
}
|
|
},
|
|
]
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="start", container_id="plex")
|
|
assert result["success"] is True
|
|
|
|
async def test_networks(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {"dockerNetworks": [{"id": "net:1", "name": "bridge"}]}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="networks")
|
|
assert len(result["networks"]) == 1
|
|
|
|
async def test_port_conflicts(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {"docker": {"portConflicts": []}}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="port_conflicts")
|
|
assert result["port_conflicts"] == []
|
|
|
|
async def test_check_updates(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {
|
|
"docker": {
|
|
"containerUpdateStatuses": [{"id": "c1", "name": "plex", "updateAvailable": True}]
|
|
}
|
|
}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="check_updates")
|
|
assert len(result["update_statuses"]) == 1
|
|
|
|
async def test_idempotent_start(self, _mock_graphql: AsyncMock) -> None:
|
|
# Resolve + idempotent success
|
|
_mock_graphql.side_effect = [
|
|
{"docker": {"containers": [{"id": "a" * 64 + ":local", "names": ["plex"]}]}},
|
|
{"idempotent_success": True, "docker": {}},
|
|
]
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="start", container_id="plex")
|
|
assert result["idempotent"] is True
|
|
|
|
async def test_restart(self, _mock_graphql: AsyncMock) -> None:
|
|
cid = "a" * 64 + ":local"
|
|
_mock_graphql.side_effect = [
|
|
{"docker": {"containers": [{"id": cid, "names": ["plex"]}]}},
|
|
{"docker": {"stop": {"id": cid, "state": "exited"}}},
|
|
{"docker": {"start": {"id": cid, "state": "running"}}},
|
|
]
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="restart", container_id="plex")
|
|
assert result["success"] is True
|
|
assert result["action"] == "restart"
|
|
|
|
async def test_restart_idempotent_stop(self, _mock_graphql: AsyncMock) -> None:
|
|
cid = "a" * 64 + ":local"
|
|
_mock_graphql.side_effect = [
|
|
{"docker": {"containers": [{"id": cid, "names": ["plex"]}]}},
|
|
{"idempotent_success": True},
|
|
{"docker": {"start": {"id": cid, "state": "running"}}},
|
|
]
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="restart", container_id="plex")
|
|
assert result["success"] is True
|
|
assert "note" in result
|
|
|
|
async def test_update_all(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {
|
|
"docker": {"updateAllContainers": [{"id": "c1", "state": "running"}]}
|
|
}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="update_all", confirm=True)
|
|
assert result["success"] is True
|
|
assert len(result["containers"]) == 1
|
|
|
|
async def test_remove_with_confirm(self, _mock_graphql: AsyncMock) -> None:
|
|
cid = "a" * 64 + ":local"
|
|
_mock_graphql.side_effect = [
|
|
{"docker": {"containers": [{"id": cid, "names": ["old-app"]}]}},
|
|
{"docker": {"removeContainer": True}},
|
|
]
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="remove", container_id="old-app", confirm=True)
|
|
assert result["success"] is True
|
|
|
|
async def test_details_found(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {
|
|
"docker": {
|
|
"containers": [
|
|
{"id": "c1", "names": ["plex"], "state": "running", "image": "plexinc/pms"}
|
|
]
|
|
}
|
|
}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="details", container_id="plex")
|
|
assert result["names"] == ["plex"]
|
|
|
|
async def test_logs(self, _mock_graphql: AsyncMock) -> None:
|
|
cid = "a" * 64 + ":local"
|
|
_mock_graphql.side_effect = [
|
|
{"docker": {"containers": [{"id": cid, "names": ["plex"]}]}},
|
|
{"docker": {"logs": "2026-02-08 log line here"}},
|
|
]
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="logs", container_id="plex")
|
|
assert "log line" in result["logs"]
|
|
|
|
async def test_pause_container(self, _mock_graphql: AsyncMock) -> None:
|
|
cid = "a" * 64 + ":local"
|
|
_mock_graphql.side_effect = [
|
|
{"docker": {"containers": [{"id": cid, "names": ["plex"]}]}},
|
|
{"docker": {"pause": {"id": cid, "state": "paused"}}},
|
|
]
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="pause", container_id="plex")
|
|
assert result["success"] is True
|
|
|
|
async def test_generic_exception_wraps_in_tool_error(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.side_effect = RuntimeError("unexpected failure")
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="unexpected failure"):
|
|
await tool_fn(action="list")
|
|
|
|
|
|
class TestDockerMutationFailures:
|
|
"""Tests for mutation responses that indicate failure or unexpected shapes."""
|
|
|
|
async def test_remove_mutation_returns_null(self, _mock_graphql: AsyncMock) -> None:
|
|
"""removeContainer returning null instead of True."""
|
|
cid = "a" * 64 + ":local"
|
|
_mock_graphql.side_effect = [
|
|
{"docker": {"containers": [{"id": cid, "names": ["old-app"]}]}},
|
|
{"docker": {"removeContainer": None}},
|
|
]
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="remove", container_id="old-app", confirm=True)
|
|
assert result["success"] is True
|
|
assert result["container"] is None
|
|
|
|
async def test_start_mutation_empty_docker_response(self, _mock_graphql: AsyncMock) -> None:
|
|
"""docker field returning empty object (missing the action sub-field)."""
|
|
cid = "a" * 64 + ":local"
|
|
_mock_graphql.side_effect = [
|
|
{"docker": {"containers": [{"id": cid, "names": ["plex"]}]}},
|
|
{"docker": {}},
|
|
]
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="start", container_id="plex")
|
|
assert result["success"] is True
|
|
assert result["container"] is None
|
|
|
|
async def test_stop_mutation_returns_false_state(self, _mock_graphql: AsyncMock) -> None:
|
|
"""Stop mutation returning a container with unexpected state."""
|
|
cid = "a" * 64 + ":local"
|
|
_mock_graphql.side_effect = [
|
|
{"docker": {"containers": [{"id": cid, "names": ["plex"]}]}},
|
|
{"docker": {"stop": {"id": cid, "state": "running"}}},
|
|
]
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="stop", container_id="plex")
|
|
assert result["success"] is True
|
|
assert result["container"]["state"] == "running"
|
|
|
|
async def test_update_all_returns_empty_list(self, _mock_graphql: AsyncMock) -> None:
|
|
"""update_all with no containers to update."""
|
|
_mock_graphql.return_value = {"docker": {"updateAllContainers": []}}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="update_all", confirm=True)
|
|
assert result["success"] is True
|
|
assert result["containers"] == []
|
|
|
|
async def test_update_all_requires_confirm(self, _mock_graphql: AsyncMock) -> None:
|
|
"""update_all is destructive and requires confirm=True."""
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="destructive"):
|
|
await tool_fn(action="update_all")
|
|
|
|
async def test_mutation_timeout(self, _mock_graphql: AsyncMock) -> None:
|
|
"""Mid-operation timeout during a docker mutation."""
|
|
|
|
cid = "a" * 64 + ":local"
|
|
_mock_graphql.side_effect = [
|
|
{"docker": {"containers": [{"id": cid, "names": ["plex"]}]}},
|
|
TimeoutError("operation timed out"),
|
|
]
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="timed out"):
|
|
await tool_fn(action="start", container_id="plex")
|
|
|
|
|
|
class TestDockerNetworkErrors:
|
|
"""Tests for network-level failures in docker operations."""
|
|
|
|
async def test_list_connection_refused(self, _mock_graphql: AsyncMock) -> None:
|
|
"""Connection refused when listing containers should be wrapped in ToolError."""
|
|
_mock_graphql.side_effect = ToolError(
|
|
"Network connection error: [Errno 111] Connection refused"
|
|
)
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="Connection refused"):
|
|
await tool_fn(action="list")
|
|
|
|
async def test_list_http_401_unauthorized(self, _mock_graphql: AsyncMock) -> None:
|
|
"""HTTP 401 should propagate as ToolError."""
|
|
_mock_graphql.side_effect = ToolError("HTTP error 401: Unauthorized")
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="401"):
|
|
await tool_fn(action="list")
|
|
|
|
async def test_json_decode_error_on_list(self, _mock_graphql: AsyncMock) -> None:
|
|
"""Invalid JSON response should be wrapped in ToolError."""
|
|
_mock_graphql.side_effect = ToolError(
|
|
"Invalid JSON response from Unraid API: Expecting value: line 1 column 1"
|
|
)
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="Invalid JSON"):
|
|
await tool_fn(action="list")
|