{{ message }}
Repository navigation
Expand file tree
/
Copy pathtest_client.py
More file actions
761 lines (636 loc) · 26.9 KB
/
Copy pathtest_client.py
File metadata and controls
761 lines (636 loc) · 26.9 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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
"""
CopilotClient Unit Tests
This file is for unit tests. Where relevant, prefer to add e2e tests in e2e/*.py instead.
"""
from unittest.mock import AsyncMock, patch
import pytest
from copilot import CopilotClient, define_tool
from copilot.client import (
ExternalServerConfig,
ModelCapabilities,
ModelInfo,
ModelLimits,
ModelSupports,
SubprocessConfig,
)
from copilot.session import PermissionHandler, PermissionRequestResult
from e2e.testharness import CLI_PATH
class TestPermissionHandlerRequired:
@pytest.mark.asyncio
async def test_create_session_raises_without_permission_handler(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
with pytest.raises(TypeError, match="on_permission_request"):
await client.create_session() # type: ignore[call-arg]
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_create_session_raises_with_none_permission_handler(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
with pytest.raises(ValueError, match="on_permission_request handler is required"):
await client.create_session(on_permission_request=None) # type: ignore[arg-type]
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_v2_permission_adapter_rejects_no_result(self):
client = CopilotClient(SubprocessConfig(CLI_PATH))
await client.start()
try:
session = await client.create_session(
on_permission_request=lambda request, invocation: PermissionRequestResult(
kind="no-result"
)
)
with pytest.raises(ValueError, match="protocol v2 server"):
await client._handle_permission_request_v2(
{
"sessionId": session.session_id,
"permissionRequest": {"kind": "write"},
}
)
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_resume_session_raises_without_permission_handler(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
session = await client.create_session(
on_permission_request=PermissionHandler.approve_all
)
with pytest.raises(ValueError, match="on_permission_request.*is required"):
await client.resume_session(session.session_id, on_permission_request=None)
finally:
await client.force_stop()
class TestURLParsing:
def test_parse_port_only_url(self):
client = CopilotClient(ExternalServerConfig(url="8080"))
assert client._actual_port == 8080
assert client._actual_host == "localhost"
assert client._is_external_server
def test_parse_host_port_url(self):
client = CopilotClient(ExternalServerConfig(url="127.0.0.1:9000"))
assert client._actual_port == 9000
assert client._actual_host == "127.0.0.1"
assert client._is_external_server
def test_parse_http_url(self):
client = CopilotClient(ExternalServerConfig(url="http://localhost:7000"))
assert client._actual_port == 7000
assert client._actual_host == "localhost"
assert client._is_external_server
def test_parse_https_url(self):
client = CopilotClient(ExternalServerConfig(url="https://example.com:443"))
assert client._actual_port == 443
assert client._actual_host == "example.com"
assert client._is_external_server
def test_invalid_url_format(self):
with pytest.raises(ValueError, match="Invalid cli_url format"):
CopilotClient(ExternalServerConfig(url="invalid-url"))
def test_invalid_port_too_high(self):
with pytest.raises(ValueError, match="Invalid port in cli_url"):
CopilotClient(ExternalServerConfig(url="localhost:99999"))
def test_invalid_port_zero(self):
with pytest.raises(ValueError, match="Invalid port in cli_url"):
CopilotClient(ExternalServerConfig(url="localhost:0"))
def test_invalid_port_negative(self):
with pytest.raises(ValueError, match="Invalid port in cli_url"):
CopilotClient(ExternalServerConfig(url="localhost:-1"))
def test_is_external_server_true(self):
client = CopilotClient(ExternalServerConfig(url="localhost:8080"))
assert client._is_external_server
class TestSessionFsConfig:
def test_missing_initial_cwd(self):
with pytest.raises(ValueError, match="session_fs.initial_cwd is required"):
CopilotClient(
SubprocessConfig(
cli_path=CLI_PATH,
log_level="error",
session_fs={
"initial_cwd": "",
"session_state_path": "/session-state",
"conventions": "posix",
},
)
)
def test_missing_session_state_path(self):
with pytest.raises(ValueError, match="session_fs.session_state_path is required"):
CopilotClient(
SubprocessConfig(
cli_path=CLI_PATH,
log_level="error",
session_fs={
"initial_cwd": "/",
"session_state_path": "",
"conventions": "posix",
},
)
)
class TestAuthOptions:
def test_accepts_github_token(self):
client = CopilotClient(
SubprocessConfig(
cli_path=CLI_PATH,
github_token="gho_test_token",
log_level="error",
)
)
assert isinstance(client._config, SubprocessConfig)
assert client._config.github_token == "gho_test_token"
def test_default_use_logged_in_user_true_without_token(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, log_level="error"))
assert isinstance(client._config, SubprocessConfig)
assert client._config.use_logged_in_user is True
def test_default_use_logged_in_user_false_with_token(self):
client = CopilotClient(
SubprocessConfig(
cli_path=CLI_PATH,
github_token="gho_test_token",
log_level="error",
)
)
assert isinstance(client._config, SubprocessConfig)
assert client._config.use_logged_in_user is False
def test_explicit_use_logged_in_user_true_with_token(self):
client = CopilotClient(
SubprocessConfig(
cli_path=CLI_PATH,
github_token="gho_test_token",
use_logged_in_user=True,
log_level="error",
)
)
assert isinstance(client._config, SubprocessConfig)
assert client._config.use_logged_in_user is True
def test_explicit_use_logged_in_user_false_without_token(self):
client = CopilotClient(
SubprocessConfig(
cli_path=CLI_PATH,
use_logged_in_user=False,
log_level="error",
)
)
assert isinstance(client._config, SubprocessConfig)
assert client._config.use_logged_in_user is False
class TestOverridesBuiltInTool:
@pytest.mark.asyncio
async def test_overrides_built_in_tool_sent_in_tool_definition(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
captured = {}
original_request = client._client.request
async def mock_request(method, params):
captured[method] = params
return await original_request(method, params)
client._client.request = mock_request
@define_tool(description="Custom grep", overrides_built_in_tool=True)
def grep(params) -> str:
return "ok"
await client.create_session(
on_permission_request=PermissionHandler.approve_all, tools=[grep]
)
tool_defs = captured["session.create"]["tools"]
assert len(tool_defs) == 1
assert tool_defs[0]["name"] == "grep"
assert tool_defs[0]["overridesBuiltInTool"] is True
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_resume_session_sends_overrides_built_in_tool(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
session = await client.create_session(
on_permission_request=PermissionHandler.approve_all
)
captured = {}
async def mock_request(method, params):
captured[method] = params
# Return a fake response instead of calling the real CLI,
# which would fail without auth credentials.
return {"sessionId": params["sessionId"]}
client._client.request = mock_request
@define_tool(description="Custom grep", overrides_built_in_tool=True)
def grep(params) -> str:
return "ok"
await client.resume_session(
session.session_id,
on_permission_request=PermissionHandler.approve_all,
tools=[grep],
)
tool_defs = captured["session.resume"]["tools"]
assert len(tool_defs) == 1
assert tool_defs[0]["overridesBuiltInTool"] is True
finally:
await client.force_stop()
class TestOnListModels:
@pytest.mark.asyncio
async def test_list_models_with_custom_handler(self):
"""Test that on_list_models handler is called instead of RPC"""
custom_models = [
ModelInfo(
id="my-custom-model",
name="My Custom Model",
capabilities=ModelCapabilities(
supports=ModelSupports(vision=False, reasoning_effort=False),
limits=ModelLimits(max_context_window_tokens=128000),
),
)
]
handler_calls = []
def handler():
handler_calls.append(1)
return custom_models
client = CopilotClient(
SubprocessConfig(cli_path=CLI_PATH),
on_list_models=handler,
)
await client.start()
try:
models = await client.list_models()
assert len(handler_calls) == 1
assert models == custom_models
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_list_models_handler_caches_results(self):
"""Test that on_list_models results are cached"""
custom_models = [
ModelInfo(
id="cached-model",
name="Cached Model",
capabilities=ModelCapabilities(
supports=ModelSupports(vision=False, reasoning_effort=False),
limits=ModelLimits(max_context_window_tokens=128000),
),
)
]
handler_calls = []
def handler():
handler_calls.append(1)
return custom_models
client = CopilotClient(
SubprocessConfig(cli_path=CLI_PATH),
on_list_models=handler,
)
await client.start()
try:
await client.list_models()
await client.list_models()
assert len(handler_calls) == 1 # Only called once due to caching
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_list_models_async_handler(self):
"""Test that async on_list_models handler works"""
custom_models = [
ModelInfo(
id="async-model",
name="Async Model",
capabilities=ModelCapabilities(
supports=ModelSupports(vision=False, reasoning_effort=False),
limits=ModelLimits(max_context_window_tokens=128000),
),
)
]
async def handler():
return custom_models
client = CopilotClient(
SubprocessConfig(cli_path=CLI_PATH),
on_list_models=handler,
)
await client.start()
try:
models = await client.list_models()
assert models == custom_models
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_list_models_handler_without_start(self):
"""Test that on_list_models works without starting the CLI connection"""
custom_models = [
ModelInfo(
id="no-start-model",
name="No Start Model",
capabilities=ModelCapabilities(
supports=ModelSupports(vision=False, reasoning_effort=False),
limits=ModelLimits(max_context_window_tokens=128000),
),
)
]
handler_calls = []
def handler():
handler_calls.append(1)
return custom_models
client = CopilotClient(
SubprocessConfig(cli_path=CLI_PATH),
on_list_models=handler,
)
models = await client.list_models()
assert len(handler_calls) == 1
assert models == custom_models
class TestSessionConfigForwarding:
@pytest.mark.asyncio
async def test_create_session_forwards_client_name(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
captured = {}
original_request = client._client.request
async def mock_request(method, params):
captured[method] = params
return await original_request(method, params)
client._client.request = mock_request
await client.create_session(
on_permission_request=PermissionHandler.approve_all, client_name="my-app"
)
assert captured["session.create"]["clientName"] == "my-app"
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_resume_session_forwards_client_name(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
session = await client.create_session(
on_permission_request=PermissionHandler.approve_all
)
captured = {}
original_request = client._client.request
async def mock_request(method, params):
captured[method] = params
if method == "session.resume":
# Return a fake response to avoid needing real auth
return {"sessionId": session.session_id}
return await original_request(method, params)
client._client.request = mock_request
await client.resume_session(
session.session_id,
on_permission_request=PermissionHandler.approve_all,
client_name="my-app",
)
assert captured["session.resume"]["clientName"] == "my-app"
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_create_session_forwards_provider_headers(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
captured = {}
original_request = client._client.request
async def mock_request(method, params):
captured[method] = params
if method == "session.create":
return {"sessionId": params["sessionId"]}
return await original_request(method, params)
client._client.request = mock_request
await client.create_session(
on_permission_request=PermissionHandler.approve_all,
provider={
"base_url": "https://example.com/provider",
"headers": {"Authorization": "Bearer provider-token"},
},
)
provider = captured["session.create"]["provider"]
assert provider["baseUrl"] == "https://example.com/provider"
assert provider["headers"] == {"Authorization": "Bearer provider-token"}
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_resume_session_forwards_provider_headers(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
session = await client.create_session(
on_permission_request=PermissionHandler.approve_all
)
captured = {}
original_request = client._client.request
async def mock_request(method, params):
captured[method] = params
if method == "session.resume":
return {"sessionId": session.session_id}
return await original_request(method, params)
client._client.request = mock_request
await client.resume_session(
session.session_id,
on_permission_request=PermissionHandler.approve_all,
provider={
"base_url": "https://example.com/provider",
"headers": {"Authorization": "Bearer resume-token"},
},
)
provider = captured["session.resume"]["provider"]
assert provider["baseUrl"] == "https://example.com/provider"
assert provider["headers"] == {"Authorization": "Bearer resume-token"}
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_session_send_forwards_request_headers(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
session = await client.create_session(
on_permission_request=PermissionHandler.approve_all
)
captured = {}
original_request = client._client.request
async def mock_request(method, params):
captured[method] = params
if method == "session.send":
return {"messageId": "msg-1"}
return await original_request(method, params)
client._client.request = mock_request
await session.send(
"hello",
request_headers={"Authorization": "Bearer turn-token"},
)
assert captured["session.send"]["prompt"] == "hello"
assert captured["session.send"]["requestHeaders"] == {
"Authorization": "Bearer turn-token"
}
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_create_session_forwards_agent(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
captured = {}
original_request = client._client.request
async def mock_request(method, params):
captured[method] = params
return await original_request(method, params)
client._client.request = mock_request
await client.create_session(
on_permission_request=PermissionHandler.approve_all,
agent="test-agent",
custom_agents=[{"name": "test-agent", "prompt": "You are a test agent."}],
)
assert captured["session.create"]["agent"] == "test-agent"
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_resume_session_forwards_agent(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
session = await client.create_session(
on_permission_request=PermissionHandler.approve_all
)
captured = {}
original_request = client._client.request
async def mock_request(method, params):
captured[method] = params
if method == "session.resume":
return {"sessionId": session.session_id}
return await original_request(method, params)
client._client.request = mock_request
await client.resume_session(
session.session_id,
on_permission_request=PermissionHandler.approve_all,
agent="test-agent",
custom_agents=[{"name": "test-agent", "prompt": "You are a test agent."}],
)
assert captured["session.resume"]["agent"] == "test-agent"
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_create_session_defaults_include_sub_agent_streaming_events_to_true(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
captured = {}
original_request = client._client.request
async def mock_request(method, params):
captured[method] = params
return await original_request(method, params)
client._client.request = mock_request
await client.create_session(
on_permission_request=PermissionHandler.approve_all,
)
assert captured["session.create"]["includeSubAgentStreamingEvents"] is True
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_create_session_preserves_explicit_false_include_sub_agent_streaming_events(
self,
):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
captured = {}
original_request = client._client.request
async def mock_request(method, params):
captured[method] = params
return await original_request(method, params)
client._client.request = mock_request
await client.create_session(
on_permission_request=PermissionHandler.approve_all,
include_sub_agent_streaming_events=False,
)
assert captured["session.create"]["includeSubAgentStreamingEvents"] is False
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_resume_session_defaults_include_sub_agent_streaming_events_to_true(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
session = await client.create_session(
on_permission_request=PermissionHandler.approve_all
)
captured = {}
original_request = client._client.request
async def mock_request(method, params):
captured[method] = params
if method == "session.resume":
return {"sessionId": session.session_id}
return await original_request(method, params)
client._client.request = mock_request
await client.resume_session(
session.session_id,
on_permission_request=PermissionHandler.approve_all,
)
assert captured["session.resume"]["includeSubAgentStreamingEvents"] is True
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_resume_session_preserves_explicit_false_include_sub_agent_streaming_events(
self,
):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
session = await client.create_session(
on_permission_request=PermissionHandler.approve_all
)
captured = {}
original_request = client._client.request
async def mock_request(method, params):
captured[method] = params
if method == "session.resume":
return {"sessionId": session.session_id}
return await original_request(method, params)
client._client.request = mock_request
await client.resume_session(
session.session_id,
on_permission_request=PermissionHandler.approve_all,
include_sub_agent_streaming_events=False,
)
assert captured["session.resume"]["includeSubAgentStreamingEvents"] is False
finally:
await client.force_stop()
@pytest.mark.asyncio
async def test_set_model_sends_correct_rpc(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
await client.start()
try:
session = await client.create_session(
on_permission_request=PermissionHandler.approve_all
)
captured = {}
original_request = client._client.request
async def mock_request(method, params):
captured[method] = params
if method == "session.model.switchTo":
return {}
return await original_request(method, params)
client._client.request = mock_request
await session.set_model("gpt-4.1")
assert captured["session.model.switchTo"]["sessionId"] == session.session_id
assert captured["session.model.switchTo"]["modelId"] == "gpt-4.1"
finally:
await client.force_stop()
class TestCopilotClientContextManager:
@pytest.mark.asyncio
async def test_aenter_calls_start_and_returns_self(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
with patch.object(client, "start", new_callable=AsyncMock) as mock_start:
result = await client.__aenter__()
mock_start.assert_awaited_once()
assert result is client
@pytest.mark.asyncio
async def test_aexit_calls_stop(self):
client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))
with patch.object(client, "stop", new_callable=AsyncMock) as mock_stop:
await client.__aexit__(None, None, None)
mock_stop.assert_awaited_once()
class TestCopilotSessionContextManager:
@pytest.mark.asyncio
async def test_aenter_returns_self(self):
from copilot.session import CopilotSession
session = CopilotSession.__new__(CopilotSession)
result = await session.__aenter__()
assert result is session
@pytest.mark.asyncio
async def test_aexit_calls_disconnect(self):
from copilot.session import CopilotSession
session = CopilotSession.__new__(CopilotSession)
with patch.object(session, "disconnect", new_callable=AsyncMock) as mock_disconnect:
await session.__aexit__(None, None, None)
mock_disconnect.assert_awaited_once()
You can’t perform that action at this time.