-
Notifications
You must be signed in to change notification settings - Fork 258
Expand file tree
/
Copy pathtest_mcp_client_factory.py
More file actions
407 lines (343 loc) · 16.3 KB
/
Copy pathtest_mcp_client_factory.py
File metadata and controls
407 lines (343 loc) · 16.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
"""Unit tests for MCP client factory and adapters."""
import json # noqa: F401
import os
import tempfile
import unittest
from pathlib import Path
from unittest.mock import MagicMock, patch # noqa: F401
from apm_cli.adapters.client.codex import CodexClientAdapter
from apm_cli.adapters.client.vscode import VSCodeClientAdapter
from apm_cli.factory import ClientFactory
class TestMCPClientFactory(unittest.TestCase):
"""Test cases for the MCP client factory."""
def test_create_vscode_client(self):
"""Test creating VSCode client adapter."""
client = ClientFactory.create_client("vscode")
self.assertIsInstance(client, VSCodeClientAdapter)
def test_create_codex_client(self):
"""Test creating Codex CLI client adapter."""
client = ClientFactory.create_client("codex")
self.assertIsInstance(client, CodexClientAdapter)
def test_create_client_case_insensitive(self):
"""Test creating clients with different case."""
client1 = ClientFactory.create_client("VSCode")
client3 = ClientFactory.create_client("Codex")
self.assertIsInstance(client1, VSCodeClientAdapter)
self.assertIsInstance(client3, CodexClientAdapter)
def test_create_unsupported_client(self):
"""Test creating unsupported client type raises error."""
with self.assertRaises(ValueError) as context:
ClientFactory.create_client("unsupported")
self.assertIn("Unsupported client type", str(context.exception))
def test_all_supported_client_types(self):
"""Test that all supported client types can be created."""
supported_types = ["vscode", "codex", "cursor"]
for client_type in supported_types:
with self.subTest(client_type=client_type):
client = ClientFactory.create_client(client_type)
self.assertIsNotNone(client)
# Verify basic interface compliance
self.assertTrue(hasattr(client, "get_config_path"))
self.assertTrue(hasattr(client, "update_config"))
self.assertTrue(hasattr(client, "get_current_config"))
self.assertTrue(hasattr(client, "configure_mcp_server"))
class TestCodexClientAdapter(unittest.TestCase):
"""Test cases for Codex CLI client adapter."""
def setUp(self):
"""Set up test fixtures."""
self.temp_dir = tempfile.TemporaryDirectory()
self.config_path = os.path.join(self.temp_dir.name, "config.toml")
# Create basic TOML config
with open(self.config_path, "w") as f:
f.write('model_provider = "github-models"\nmodel = "gpt-4o-mini"\n')
# Create adapter and patch config path
self.adapter = CodexClientAdapter()
self.original_get_config_path = self.adapter.get_config_path
self.adapter.get_config_path = lambda: self.config_path
def tearDown(self):
"""Clean up test fixtures."""
self.adapter.get_config_path = self.original_get_config_path
self.temp_dir.cleanup()
def test_get_config_path_default(self):
"""Test project-scope config path for Codex CLI."""
project_root = Path(self.temp_dir.name) / "workspace"
adapter = CodexClientAdapter(project_root=project_root)
expected_path = str(project_root / ".codex" / "config.toml")
self.assertEqual(adapter.get_config_path(), expected_path)
def test_get_config_path_user_scope(self):
"""Test user-scope config path for Codex CLI."""
adapter = CodexClientAdapter(user_scope=True)
expected_path = str(Path.home() / ".codex" / "config.toml")
self.assertEqual(adapter.get_config_path(), expected_path)
def test_get_current_config_existing(self):
"""Test getting existing TOML config."""
config = self.adapter.get_current_config()
self.assertEqual(config["model_provider"], "github-models")
self.assertEqual(config["model"], "gpt-4o-mini")
def test_get_current_config_invalid_toml_returns_none(self):
"""Invalid existing TOML should not be treated as an empty config."""
Path(self.config_path).write_text('invalid = "unterminated', encoding="utf-8")
with patch("apm_cli.adapters.client.codex._rich_warning") as mock_warn:
config = self.adapter.get_current_config()
self.assertIsNone(config)
mock_warn.assert_called_once()
@patch("apm_cli.registry.client.SimpleRegistryClient.find_server_by_reference")
def test_configure_mcp_server_does_not_overwrite_invalid_toml(self, mock_find_server):
"""Parse failures should skip writes to avoid destroying existing config."""
Path(self.config_path).write_text('invalid = "unterminated', encoding="utf-8")
mock_find_server.return_value = {
"id": "test-id",
"name": "test-server",
"packages": [{"registry_name": "npm", "name": "test-package", "arguments": []}],
"environment_variables": [],
}
original = Path(self.config_path).read_text(encoding="utf-8")
with patch("apm_cli.adapters.client.codex._rich_warning") as mock_warn:
result = self.adapter.configure_mcp_server("test-server", "my_server")
self.assertFalse(result)
self.assertEqual(Path(self.config_path).read_text(encoding="utf-8"), original)
self.assertTrue(mock_warn.called)
@patch("apm_cli.registry.client.SimpleRegistryClient.find_server_by_reference")
def test_configure_mcp_server_basic(self, mock_find_server):
"""Test basic MCP server configuration for Codex."""
# Mock registry response
mock_server_info = {
"id": "test-id",
"name": "test-server",
"package_canonical": "npm",
"packages": [
{
"registry_name": "npm",
"name": "test-package",
"version": "1.0.0",
"arguments": [],
}
],
"environment_variables": [],
}
mock_find_server.return_value = mock_server_info
result = self.adapter.configure_mcp_server("test-server", "my_server")
self.assertTrue(result)
mock_find_server.assert_called_once_with("test-server")
# Verify TOML config was updated
config = self.adapter.get_current_config()
self.assertIn("mcp_servers", config)
self.assertIn("my_server", config["mcp_servers"])
server_config = config["mcp_servers"]["my_server"]
self.assertEqual(server_config["command"], "npx")
@patch("apm_cli.adapters.client.codex._rich_warning")
@patch("apm_cli.registry.client.SimpleRegistryClient.find_server_by_reference")
def test_configure_mcp_server_sse_remote_rejected(self, mock_find_server, mock_warn):
"""SSE remotes are rejected with a warning that points to streamable-http."""
mock_server_info = {
"id": "remote-server-id",
"name": "remote-server",
"remotes": [{"transport_type": "sse", "url": "https://example.com/mcp"}],
"packages": [],
}
mock_find_server.return_value = mock_server_info
result = self.adapter.configure_mcp_server("remote-server")
self.assertFalse(result)
mock_find_server.assert_called_once_with("remote-server")
mock_warn.assert_called_once()
warn_message = mock_warn.call_args[0][0]
self.assertIn("remote-server", warn_message)
self.assertIn("SSE", warn_message)
self.assertIn("streamable-http", warn_message)
# Verify no config was updated
config = self.adapter.get_current_config()
self.assertNotIn("mcp_servers", config)
@patch("apm_cli.registry.client.SimpleRegistryClient.find_server_by_reference")
def test_configure_mcp_server_hybrid_accepted(self, mock_find_server):
"""Test that hybrid servers (both remote and packages) are accepted and configured using packages."""
# Mock registry response for hybrid server
mock_server_info = {
"id": "hybrid-server-id",
"name": "hybrid-server",
"remotes": [{"transport_type": "sse", "url": "https://example.com/mcp"}],
"packages": [
{ # Has both remote and packages - use packages for Codex
"registry_name": "npm",
"name": "hybrid-package",
"version": "1.0.0",
"arguments": [],
}
],
"environment_variables": [],
}
mock_find_server.return_value = mock_server_info
result = self.adapter.configure_mcp_server("hybrid-server", "hybrid")
# Should succeed because it has packages
self.assertTrue(result)
mock_find_server.assert_called_once_with("hybrid-server")
# Verify TOML config was updated using package info
config = self.adapter.get_current_config()
self.assertIn("mcp_servers", config)
self.assertIn("hybrid", config["mcp_servers"])
server_config = config["mcp_servers"]["hybrid"]
self.assertEqual(server_config["command"], "npx")
@patch("apm_cli.registry.client.SimpleRegistryClient.find_server_by_reference")
def test_configure_mcp_server_name_extraction(self, mock_find_server):
"""Test server name extraction from URL for Codex."""
# Mock registry response
mock_server_info = {
"id": "test-id",
"name": "test-server",
"packages": [{"registry_name": "npm", "name": "test-package", "arguments": []}],
"environment_variables": [],
}
mock_find_server.return_value = mock_server_info
# Test with org/repo format
result = self.adapter.configure_mcp_server("microsoft/azure-devops-mcp")
self.assertTrue(result)
# Verify config uses extracted name
config = self.adapter.get_current_config()
self.assertIn("mcp_servers", config)
self.assertIn("azure-devops-mcp", config["mcp_servers"]) # Should extract name after slash
self.assertNotIn(
"microsoft/azure-devops-mcp", config["mcp_servers"]
) # Should NOT use full path
def test_self_defined_stdio_normalizes_project_placeholders(self):
"""Project-local Codex configs normalize VS Code placeholders to '.'."""
adapter = CodexClientAdapter(project_root=Path(self.temp_dir.name))
server_info = {
"id": "stdio-id",
"name": "local-filesystem",
"_raw_stdio": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-filesystem",
"${workspaceFolder}",
"${projectRoot}",
],
"env": {},
},
}
config = adapter._format_server_config(server_info)
self.assertEqual(
config["args"],
["-y", "@modelcontextprotocol/server-filesystem", ".", "."],
)
def test_format_server_config_streamable_http_writes_url_and_id(self):
"""Streamable-HTTP remote produces url + id (no http_headers when none)."""
server_info = {
"name": "figma",
"id": "ab12cd34-0000-0000-0000-000000000000",
"remotes": [
{
"url": "https://mcp.figma.com/mcp",
"transport_type": "streamable-http",
}
],
}
config = self.adapter._format_server_config(server_info)
self.assertEqual(config["url"], "https://mcp.figma.com/mcp")
self.assertEqual(config["id"], "ab12cd34-0000-0000-0000-000000000000")
self.assertNotIn("http_headers", config)
def test_format_server_config_streamable_http_writes_headers(self):
"""Registry-supplied headers land under ``http_headers``."""
server_info = {
"name": "figma",
"remotes": [
{
"url": "https://mcp.figma.com/mcp",
"transport_type": "streamable-http",
"headers": [
{"name": "Authorization", "value": "Bearer ghp_xxx"},
{"name": "X-Figma-Region", "value": "us-east-1"},
],
}
],
}
config = self.adapter._format_server_config(server_info)
self.assertEqual(
config["http_headers"],
{
"Authorization": "Bearer ghp_xxx",
"X-Figma-Region": "us-east-1",
},
)
def test_format_server_config_streamable_http_self_defined(self):
"""Self-defined streamable-http info produces a remote config."""
server_info = {
"name": "my-remote",
"remotes": [
{
"transport_type": "streamable-http",
"url": "https://example.com/mcp",
"headers": [{"name": "Authorization", "value": "Bearer xyz"}],
}
],
}
config = self.adapter._format_server_config(server_info)
self.assertEqual(config["url"], "https://example.com/mcp")
self.assertEqual(config["http_headers"], {"Authorization": "Bearer xyz"})
@patch("apm_cli.adapters.client.codex._rich_warning")
def test_format_server_config_streamable_http_rejects_non_https(self, mock_warn):
"""Non-HTTPS remote URLs are rejected to prevent cleartext header leakage."""
server_info = {
"name": "evil-remote",
"id": "evil-id",
"remotes": [
{
"url": "http://mcp.example.com/mcp",
"transport_type": "streamable-http",
"headers": [{"name": "Authorization", "value": "Bearer secret"}],
}
],
}
result = self.adapter._format_server_config(server_info)
self.assertIsNone(result)
mock_warn.assert_called_once()
warn_message = mock_warn.call_args[0][0]
self.assertIn("evil-remote", warn_message)
self.assertIn("https://", warn_message)
@patch("apm_cli.adapters.client.codex._rich_warning")
@patch("apm_cli.registry.client.SimpleRegistryClient.find_server_by_reference")
def test_configure_mcp_server_http_remote_rejected(self, mock_find_server, mock_warn):
"""End-to-end: an http:// remote URL never lands in the Codex config."""
mock_find_server.return_value = {
"name": "evil-remote",
"id": "evil-id",
"remotes": [
{
"url": "http://mcp.example.com/mcp",
"transport_type": "streamable-http",
"headers": [{"name": "Authorization", "value": "Bearer secret"}],
}
],
"packages": [],
}
result = self.adapter.configure_mcp_server("evil-remote")
self.assertFalse(result)
mock_warn.assert_called_once()
warn_message = mock_warn.call_args[0][0]
self.assertIn("evil-remote", warn_message)
self.assertIn("https://", warn_message)
# Verify no config was written
config = self.adapter.get_current_config()
self.assertNotIn("mcp_servers", config)
@patch("apm_cli.registry.client.SimpleRegistryClient.find_server_by_reference")
def test_configure_mcp_server_streamable_http_writes_toml_entry(self, mock_find_server):
"""End-to-end install of a streamable-HTTP server writes a parseable TOML entry."""
mock_find_server.return_value = {
"name": "figma",
"id": "ab12cd34-0000-0000-0000-000000000000",
"remotes": [
{
"url": "https://mcp.figma.com/mcp",
"transport_type": "streamable-http",
"headers": [{"name": "Authorization", "value": "Bearer ghp_xxx"}],
}
],
}
result = self.adapter.configure_mcp_server("figma/figma")
self.assertTrue(result)
config = self.adapter.get_current_config()
figma = config["mcp_servers"]["figma"]
self.assertEqual(figma["url"], "https://mcp.figma.com/mcp")
self.assertEqual(figma["id"], "ab12cd34-0000-0000-0000-000000000000")
self.assertEqual(figma["http_headers"], {"Authorization": "Bearer ghp_xxx"})
if __name__ == "__main__":
unittest.main()