mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2026-04-02 16:22:20 -07:00
feat(api): MCP, OpenAPI & Dynamic Introspection
New Features: - API endpoints now support comprehensive input validation with detailed error responses via Pydantic models. - OpenAPI specification endpoint (/openapi.json) and interactive Swagger UI documentation (/docs) now available for API discovery. - Enhanced MCP session lifecycle management with create, retrieve, and delete operations. - Network diagnostic tools: traceroute, nslookup, NMAP scanning, and network topology viewing exposed via API. - Device search, filtering by status (including 'offline'), and bulk operations (copy, delete, update). - Wake-on-LAN functionality for remote device management. - Added dynamic tool disablement and status reporting. Bug Fixes: - Fixed get_tools_status in registry to correctly return boolean values instead of None for enabled tools. - Improved error handling for invalid API inputs with standardized validation responses. - Fixed OPTIONS request handling for cross-origin requests. Refactoring: - Significant refactoring of api_server_start.py to use decorator-based validation (@validate_request).
This commit is contained in:
147
test/test_mcp_disablement.py
Normal file
147
test/test_mcp_disablement.py
Normal file
@@ -0,0 +1,147 @@
|
||||
import pytest
|
||||
from unittest.mock import patch
|
||||
from flask import Flask
|
||||
from server.api_server.openapi import spec_generator, registry
|
||||
from server.api_server import mcp_endpoint
|
||||
|
||||
|
||||
# Helper to reset state between tests
|
||||
@pytest.fixture(autouse=True)
|
||||
def reset_registry():
|
||||
registry.clear_registry()
|
||||
registry._disabled_tools.clear()
|
||||
yield
|
||||
registry.clear_registry()
|
||||
registry._disabled_tools.clear()
|
||||
|
||||
|
||||
def test_disable_tool_management():
|
||||
"""Test enabling and disabling tools."""
|
||||
# Register a dummy tool
|
||||
registry.register_tool(
|
||||
path="/test",
|
||||
method="GET",
|
||||
operation_id="test_tool",
|
||||
summary="Test Tool",
|
||||
description="A test tool"
|
||||
)
|
||||
|
||||
# Initially enabled
|
||||
assert not registry.is_tool_disabled("test_tool")
|
||||
assert "test_tool" not in registry.get_disabled_tools()
|
||||
|
||||
# Disable it
|
||||
assert registry.set_tool_disabled("test_tool", True)
|
||||
assert registry.is_tool_disabled("test_tool")
|
||||
assert "test_tool" in registry.get_disabled_tools()
|
||||
|
||||
# Enable it
|
||||
assert registry.set_tool_disabled("test_tool", False)
|
||||
assert not registry.is_tool_disabled("test_tool")
|
||||
assert "test_tool" not in registry.get_disabled_tools()
|
||||
|
||||
# Try to disable non-existent tool
|
||||
assert not registry.set_tool_disabled("non_existent", True)
|
||||
|
||||
|
||||
def test_get_tools_status():
|
||||
"""Test getting the status of all tools."""
|
||||
registry.register_tool(
|
||||
path="/tool1",
|
||||
method="GET",
|
||||
operation_id="tool1",
|
||||
summary="Tool 1",
|
||||
description="First tool"
|
||||
)
|
||||
registry.register_tool(
|
||||
path="/tool2",
|
||||
method="GET",
|
||||
operation_id="tool2",
|
||||
summary="Tool 2",
|
||||
description="Second tool"
|
||||
)
|
||||
|
||||
registry.set_tool_disabled("tool1", True)
|
||||
|
||||
status = registry.get_tools_status()
|
||||
|
||||
assert len(status) == 2
|
||||
|
||||
t1 = next(t for t in status if t["operation_id"] == "tool1")
|
||||
t2 = next(t for t in status if t["operation_id"] == "tool2")
|
||||
|
||||
assert t1["disabled"] is True
|
||||
assert t1["summary"] == "Tool 1"
|
||||
|
||||
assert t2["disabled"] is False
|
||||
assert t2["summary"] == "Tool 2"
|
||||
|
||||
|
||||
def test_openapi_spec_injection():
|
||||
"""Test that x-mcp-disabled is injected into OpenAPI spec."""
|
||||
registry.register_tool(
|
||||
path="/test",
|
||||
method="GET",
|
||||
operation_id="test_tool",
|
||||
summary="Test Tool",
|
||||
description="A test tool"
|
||||
)
|
||||
|
||||
# Disable it
|
||||
registry.set_tool_disabled("test_tool", True)
|
||||
|
||||
spec = spec_generator.generate_openapi_spec()
|
||||
path_entry = spec["paths"]["/test"]
|
||||
method_key = next(iter(path_entry))
|
||||
operation = path_entry[method_key]
|
||||
|
||||
assert "x-mcp-disabled" in operation
|
||||
assert operation["x-mcp-disabled"] is True
|
||||
|
||||
# Re-enable
|
||||
registry.set_tool_disabled("test_tool", False)
|
||||
spec = spec_generator.generate_openapi_spec()
|
||||
path_entry = spec["paths"]["/test"]
|
||||
method_key = next(iter(path_entry))
|
||||
operation = path_entry[method_key]
|
||||
|
||||
assert "x-mcp-disabled" not in operation
|
||||
|
||||
|
||||
@patch("server.api_server.mcp_endpoint.get_setting_value")
|
||||
@patch("requests.get")
|
||||
def test_execute_disabled_tool(mock_get, mock_setting):
|
||||
"""Test that executing a disabled tool returns an error."""
|
||||
mock_setting.return_value = 8000
|
||||
|
||||
# Create a dummy app for context
|
||||
app = Flask(__name__)
|
||||
|
||||
# Register tool
|
||||
registry.register_tool(
|
||||
path="/test",
|
||||
method="GET",
|
||||
operation_id="test_tool",
|
||||
summary="Test Tool",
|
||||
description="A test tool"
|
||||
)
|
||||
|
||||
route = mcp_endpoint.find_route_for_tool("test_tool")
|
||||
|
||||
with app.test_request_context():
|
||||
# 1. Test enabled (mock request)
|
||||
mock_get.return_value.json.return_value = {"success": True}
|
||||
mock_get.return_value.status_code = 200
|
||||
|
||||
result = mcp_endpoint._execute_tool(route, {})
|
||||
assert not result["isError"]
|
||||
|
||||
# 2. Disable tool
|
||||
registry.set_tool_disabled("test_tool", True)
|
||||
|
||||
result = mcp_endpoint._execute_tool(route, {})
|
||||
assert result["isError"]
|
||||
assert "is disabled" in result["content"][0]["text"]
|
||||
|
||||
# Ensure no HTTP request was made for the second call
|
||||
assert mock_get.call_count == 1
|
||||
Reference in New Issue
Block a user