|
| 1 | +"""Test backward compatibility for tool invocation after PR #746.""" |
| 2 | + |
| 3 | +from unittest.mock import AsyncMock, MagicMock, patch |
| 4 | + |
| 5 | +import pytest |
| 6 | +from fastapi.testclient import TestClient |
| 7 | +from sqlalchemy.orm import Session |
| 8 | + |
| 9 | +from mcpgateway.main import app |
| 10 | + |
| 11 | + |
| 12 | +@pytest.fixture |
| 13 | +def client(): |
| 14 | + """Create a test client.""" |
| 15 | + return TestClient(app) |
| 16 | + |
| 17 | + |
| 18 | +@pytest.fixture |
| 19 | +def mock_db(): |
| 20 | + """Create a mock database session.""" |
| 21 | + return MagicMock(spec=Session) |
| 22 | + |
| 23 | + |
| 24 | +class TestRPCBackwardCompatibility: |
| 25 | + """Test backward compatibility for RPC tool invocation.""" |
| 26 | + |
| 27 | + def test_old_format_tool_invocation_with_backward_compatibility(self, client, mock_db): |
| 28 | + """Test that old format (direct tool name as method) still works with backward compatibility.""" |
| 29 | + with patch("mcpgateway.config.settings.auth_required", False): |
| 30 | + with patch("mcpgateway.main.get_db", return_value=mock_db): |
| 31 | + with patch("mcpgateway.main.tool_service.invoke_tool", new_callable=AsyncMock) as mock_invoke: |
| 32 | + mock_invoke.return_value = {"result": "success", "data": "test data from old format"} |
| 33 | + |
| 34 | + # Old format: tool name directly as method |
| 35 | + request_body = {"jsonrpc": "2.0", "method": "my_custom_tool", "params": {"query": "test query", "limit": 10}, "id": 123} |
| 36 | + |
| 37 | + response = client.post("/rpc", json=request_body) |
| 38 | + |
| 39 | + assert response.status_code == 200 |
| 40 | + result = response.json() |
| 41 | + assert result["jsonrpc"] == "2.0" |
| 42 | + assert "result" in result |
| 43 | + assert result["result"]["result"] == "success" |
| 44 | + assert result["result"]["data"] == "test data from old format" |
| 45 | + assert result["id"] == 123 |
| 46 | + |
| 47 | + # Verify the tool was invoked with correct parameters |
| 48 | + mock_invoke.assert_called_once() |
| 49 | + call_args = mock_invoke.call_args |
| 50 | + assert call_args.kwargs["name"] == "my_custom_tool" |
| 51 | + assert call_args.kwargs["arguments"] == {"query": "test query", "limit": 10} |
| 52 | + |
| 53 | + def test_new_format_tool_invocation_still_works(self, client, mock_db): |
| 54 | + """Test that new format (tools/call method) continues to work.""" |
| 55 | + with patch("mcpgateway.config.settings.auth_required", False): |
| 56 | + with patch("mcpgateway.main.get_db", return_value=mock_db): |
| 57 | + with patch("mcpgateway.main.tool_service.invoke_tool", new_callable=AsyncMock) as mock_invoke: |
| 58 | + mock_invoke.return_value = {"result": "success", "data": "test data from new format"} |
| 59 | + |
| 60 | + # New format: tools/call method |
| 61 | + request_body = {"jsonrpc": "2.0", "method": "tools/call", "params": {"name": "my_custom_tool", "arguments": {"query": "test query", "limit": 10}}, "id": 456} |
| 62 | + |
| 63 | + response = client.post("/rpc", json=request_body) |
| 64 | + |
| 65 | + assert response.status_code == 200 |
| 66 | + result = response.json() |
| 67 | + assert result["jsonrpc"] == "2.0" |
| 68 | + assert "result" in result |
| 69 | + assert result["result"]["result"] == "success" |
| 70 | + assert result["result"]["data"] == "test data from new format" |
| 71 | + assert result["id"] == 456 |
| 72 | + |
| 73 | + # Verify the tool was invoked with correct parameters |
| 74 | + mock_invoke.assert_called_once() |
| 75 | + call_args = mock_invoke.call_args |
| 76 | + assert call_args.kwargs["name"] == "my_custom_tool" |
| 77 | + assert call_args.kwargs["arguments"] == {"query": "test query", "limit": 10} |
| 78 | + |
| 79 | + def test_both_formats_invoke_same_tool(self, client, mock_db): |
| 80 | + """Test that both old and new formats can invoke the same tool successfully.""" |
| 81 | + with patch("mcpgateway.config.settings.auth_required", False): |
| 82 | + with patch("mcpgateway.main.get_db", return_value=mock_db): |
| 83 | + with patch("mcpgateway.main.tool_service.invoke_tool", new_callable=AsyncMock) as mock_invoke: |
| 84 | + mock_invoke.return_value = {"result": "success"} |
| 85 | + |
| 86 | + # Test old format |
| 87 | + old_format_request = {"jsonrpc": "2.0", "method": "search_tool", "params": {"query": "old format"}, "id": 1} |
| 88 | + |
| 89 | + response_old = client.post("/rpc", json=old_format_request) |
| 90 | + assert response_old.status_code == 200 |
| 91 | + |
| 92 | + # Reset mock |
| 93 | + mock_invoke.reset_mock() |
| 94 | + |
| 95 | + # Test new format |
| 96 | + new_format_request = {"jsonrpc": "2.0", "method": "tools/call", "params": {"name": "search_tool", "arguments": {"query": "new format"}}, "id": 2} |
| 97 | + |
| 98 | + response_new = client.post("/rpc", json=new_format_request) |
| 99 | + assert response_new.status_code == 200 |
| 100 | + |
| 101 | + # Both should have invoked the tool |
| 102 | + assert mock_invoke.call_count == 1 |
| 103 | + call_args = mock_invoke.call_args |
| 104 | + assert call_args.kwargs["name"] == "search_tool" |
| 105 | + assert call_args.kwargs["arguments"]["query"] == "new format" |
| 106 | + |
| 107 | + def test_invalid_method_still_returns_error(self, client, mock_db): |
| 108 | + """Test that truly invalid methods still return an error.""" |
| 109 | + with patch("mcpgateway.config.settings.auth_required", False): |
| 110 | + with patch("mcpgateway.main.get_db", return_value=mock_db): |
| 111 | + with patch("mcpgateway.main.tool_service.invoke_tool", new_callable=AsyncMock) as mock_invoke: |
| 112 | + # Simulate tool not found |
| 113 | + mock_invoke.side_effect = ValueError("Tool not found") |
| 114 | + |
| 115 | + with patch("mcpgateway.main.gateway_service.forward_request", new_callable=AsyncMock) as mock_forward: |
| 116 | + # Simulate gateway forward also failing |
| 117 | + mock_forward.side_effect = ValueError("Not a gateway method") |
| 118 | + |
| 119 | + request_body = {"jsonrpc": "2.0", "method": "completely_invalid_method", "params": {}, "id": 999} |
| 120 | + |
| 121 | + response = client.post("/rpc", json=request_body) |
| 122 | + |
| 123 | + assert response.status_code == 200 |
| 124 | + result = response.json() |
| 125 | + assert result["jsonrpc"] == "2.0" |
| 126 | + assert "error" in result |
| 127 | + assert result["error"]["code"] == -32000 |
| 128 | + assert result["error"]["message"] == "Invalid method" |
| 129 | + assert result["id"] == 999 |
0 commit comments