mirror of
https://github.com/jmagar/unraid-mcp.git
synced 2026-03-02 08:14:43 -08:00
Addresses issues found by 4 parallel review agents (code-reviewer,
silent-failure-hunter, type-design-analyzer, pr-test-analyzer).
Source fixes:
- core/utils.py: add public safe_display_url() (moved from tools/health.py)
- core/client.py: rename _redact_sensitive → redact_sensitive (public API)
- core/types.py: add SubscriptionData.__post_init__ for tz-aware datetime
enforcement; remove 6 unused type aliases (SystemHealth, APIResponse, etc.)
- subscriptions/manager.py: add exc_info=True to both except-Exception blocks;
add except ValueError break-on-config-error before retry loop; import
redact_sensitive by new public name
- subscriptions/resources.py: re-raise in autostart_subscriptions() so
ensure_subscriptions_started() doesn't permanently set _subscriptions_started
- subscriptions/diagnostics.py: except ToolError: raise before broad except;
use safe_display_url() instead of raw URL slice
- tools/health.py: move _safe_display_url to core/utils; add exc_info=True;
raise ToolError (not return dict) on ImportError
- tools/info.py: use get_args(INFO_ACTIONS) instead of INFO_ACTIONS.__args__
- tools/{array,docker,keys,notifications,rclone,storage,virtualization}.py:
add Literal-vs-ALL_ACTIONS sync check at import time
Test fixes:
- test_health.py: import safe_display_url from core.utils; update
test_diagnose_import_error_internal to expect ToolError (not error dict)
- test_storage.py: add 3 safe_get tests for zero/False/empty-string values
- test_subscription_manager.py: add TestCapLogContentSingleMassiveLine (2 tests)
- test_client.py: rename _redact_sensitive → redact_sensitive; add tests for
new sensitive keys and is_cacheable explicit-keyword form
182 lines
6.8 KiB
Python
182 lines
6.8 KiB
Python
"""Tests for unraid_rclone 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
|
|
|
|
|
|
@pytest.fixture
|
|
def _mock_graphql() -> Generator[AsyncMock, None, None]:
|
|
with patch("unraid_mcp.tools.rclone.make_graphql_request", new_callable=AsyncMock) as mock:
|
|
yield mock
|
|
|
|
|
|
def _make_tool():
|
|
return make_tool_fn("unraid_mcp.tools.rclone", "register_rclone_tool", "unraid_rclone")
|
|
|
|
|
|
class TestRcloneValidation:
|
|
async def test_delete_requires_confirm(self) -> None:
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="destructive"):
|
|
await tool_fn(action="delete_remote", name="gdrive")
|
|
|
|
async def test_create_requires_fields(self) -> None:
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="requires name"):
|
|
await tool_fn(action="create_remote")
|
|
|
|
async def test_delete_requires_name(self) -> None:
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="name is required"):
|
|
await tool_fn(action="delete_remote", confirm=True)
|
|
|
|
|
|
class TestRcloneActions:
|
|
async def test_list_remotes(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {"rclone": {"remotes": [{"name": "gdrive", "type": "drive"}]}}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="list_remotes")
|
|
assert len(result["remotes"]) == 1
|
|
|
|
async def test_config_form(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {
|
|
"rclone": {"configForm": {"id": "form:1", "dataSchema": {}, "uiSchema": {}}}
|
|
}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="config_form")
|
|
assert result["id"] == "form:1"
|
|
|
|
async def test_config_form_with_provider(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {
|
|
"rclone": {"configForm": {"id": "form:s3", "dataSchema": {}, "uiSchema": {}}}
|
|
}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="config_form", provider_type="s3")
|
|
assert result["id"] == "form:s3"
|
|
call_args = _mock_graphql.call_args
|
|
assert call_args[0][1] == {"formOptions": {"providerType": "s3"}}
|
|
|
|
async def test_create_remote(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {
|
|
"rclone": {"createRCloneRemote": {"name": "newremote", "type": "s3"}}
|
|
}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(
|
|
action="create_remote",
|
|
name="newremote",
|
|
provider_type="s3",
|
|
config_data={"bucket": "mybucket"},
|
|
)
|
|
assert result["success"] is True
|
|
|
|
async def test_create_remote_with_empty_config(self, _mock_graphql: AsyncMock) -> None:
|
|
"""Empty config_data dict should be accepted (not rejected by truthiness)."""
|
|
_mock_graphql.return_value = {
|
|
"rclone": {"createRCloneRemote": {"name": "ftp-remote", "type": "ftp"}}
|
|
}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(
|
|
action="create_remote",
|
|
name="ftp-remote",
|
|
provider_type="ftp",
|
|
config_data={},
|
|
)
|
|
assert result["success"] is True
|
|
|
|
async def test_delete_remote(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {"rclone": {"deleteRCloneRemote": True}}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(action="delete_remote", name="gdrive", confirm=True)
|
|
assert result["success"] is True
|
|
|
|
async def test_delete_remote_failure(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {"rclone": {"deleteRCloneRemote": False}}
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="Failed to delete"):
|
|
await tool_fn(action="delete_remote", name="gdrive", confirm=True)
|
|
|
|
|
|
class TestRcloneConfigDataValidation:
|
|
"""Tests for _validate_config_data security guards."""
|
|
|
|
async def test_path_traversal_in_key_rejected(self, _mock_graphql: AsyncMock) -> None:
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="disallowed characters"):
|
|
await tool_fn(
|
|
action="create_remote",
|
|
name="r",
|
|
provider_type="s3",
|
|
config_data={"../evil": "value"},
|
|
)
|
|
|
|
async def test_shell_metachar_in_key_rejected(self, _mock_graphql: AsyncMock) -> None:
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="disallowed characters"):
|
|
await tool_fn(
|
|
action="create_remote",
|
|
name="r",
|
|
provider_type="s3",
|
|
config_data={"key;rm": "value"},
|
|
)
|
|
|
|
async def test_too_many_keys_rejected(self, _mock_graphql: AsyncMock) -> None:
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="max 50"):
|
|
await tool_fn(
|
|
action="create_remote",
|
|
name="r",
|
|
provider_type="s3",
|
|
config_data={f"key{i}": "v" for i in range(51)},
|
|
)
|
|
|
|
async def test_dict_value_rejected(self, _mock_graphql: AsyncMock) -> None:
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="string, number, or boolean"):
|
|
await tool_fn(
|
|
action="create_remote",
|
|
name="r",
|
|
provider_type="s3",
|
|
config_data={"nested": {"key": "val"}},
|
|
)
|
|
|
|
async def test_value_too_long_rejected(self, _mock_graphql: AsyncMock) -> None:
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="exceeds max length"):
|
|
await tool_fn(
|
|
action="create_remote",
|
|
name="r",
|
|
provider_type="s3",
|
|
config_data={"key": "x" * 4097},
|
|
)
|
|
|
|
async def test_boolean_value_accepted(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {
|
|
"rclone": {"createRCloneRemote": {"name": "r", "type": "s3"}}
|
|
}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(
|
|
action="create_remote",
|
|
name="r",
|
|
provider_type="s3",
|
|
config_data={"use_path_style": True},
|
|
)
|
|
assert result["success"] is True
|
|
|
|
async def test_int_value_accepted(self, _mock_graphql: AsyncMock) -> None:
|
|
_mock_graphql.return_value = {
|
|
"rclone": {"createRCloneRemote": {"name": "r", "type": "sftp"}}
|
|
}
|
|
tool_fn = _make_tool()
|
|
result = await tool_fn(
|
|
action="create_remote",
|
|
name="r",
|
|
provider_type="sftp",
|
|
config_data={"port": 22},
|
|
)
|
|
assert result["success"] is True
|