mirror of
https://github.com/jmagar/unraid-mcp.git
synced 2026-03-23 04:29:17 -07:00
dab1cd6995
BREAKING CHANGE: Replaces 15 separate MCP tools (unraid_info, unraid_array, unraid_storage, unraid_docker, unraid_vm, unraid_notifications, unraid_rclone, unraid_users, unraid_keys, unraid_health, unraid_settings, unraid_customization, unraid_plugins, unraid_oidc, unraid_live) with a single `unraid` tool using action (domain) + subaction (operation) routing. New interface: unraid(action="system", subaction="overview") replaces unraid_info(action="overview"). All 15 domains and ~108 subactions preserved. - Add unraid_mcp/tools/unraid.py (1891 lines, all domains consolidated) - Remove 15 individual tool files - Update tools/__init__.py to register single unified tool - Update server.py for new tool registration pattern - Update subscriptions/manager.py and resources.py for new tool names - Update all 25 test files + integration/contract/safety/schema/property tests - Update mcporter smoke-test script for new tool interface - Bump version 0.6.0 → 1.0.0 Co-authored-by: Claude <noreply@anthropic.com>
191 lines
7.2 KiB
Python
191 lines
7.2 KiB
Python
"""Tests for rclone subactions of the consolidated unraid 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.unraid.make_graphql_request", new_callable=AsyncMock) as mock:
|
|
yield mock
|
|
|
|
|
|
def _make_tool():
|
|
return make_tool_fn("unraid_mcp.tools.unraid", "register_unraid_tool", "unraid")
|
|
|
|
|
|
class TestRcloneValidation:
|
|
async def test_delete_requires_confirm(self) -> None:
|
|
tool_fn = _make_tool()
|
|
with pytest.raises(ToolError, match="not confirmed"):
|
|
await tool_fn(action="rclone", subaction="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="rclone", subaction="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="rclone", subaction="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="rclone", subaction="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="rclone", subaction="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="rclone", subaction="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="rclone",
|
|
subaction="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="rclone",
|
|
subaction="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="rclone", subaction="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="rclone", subaction="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="rclone",
|
|
subaction="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="rclone",
|
|
subaction="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="rclone",
|
|
subaction="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="rclone",
|
|
subaction="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="rclone",
|
|
subaction="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="rclone",
|
|
subaction="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="rclone",
|
|
subaction="create_remote",
|
|
name="r",
|
|
provider_type="sftp",
|
|
config_data={"port": 22},
|
|
)
|
|
assert result["success"] is True
|