forked from anthropics/claude-agent-sdk-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_streaming_client.py
More file actions
1314 lines (1110 loc) · 54.2 KB
/
Copy pathtest_streaming_client.py
File metadata and controls
1314 lines (1110 loc) · 54.2 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
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Tests for ClaudeSDKClient streaming functionality and query() with async iterables."""
import asyncio
import json
import sys
import tempfile
from pathlib import Path
from unittest.mock import AsyncMock, Mock, patch
import anyio
import pytest
from claude_agent_sdk import (
AssistantMessage,
ClaudeAgentOptions,
ClaudeSDKClient,
CLIConnectionError,
ResultMessage,
TextBlock,
UserMessage,
query,
)
from claude_agent_sdk._internal.transport.subprocess_cli import SubprocessCLITransport
def create_mock_transport(with_init_response=True):
"""Create a properly configured mock transport.
Args:
with_init_response: If True, automatically respond to initialization request
"""
mock_transport = AsyncMock()
mock_transport.connect = AsyncMock()
mock_transport.close = AsyncMock()
mock_transport.end_input = AsyncMock()
mock_transport.write = AsyncMock()
mock_transport.is_ready = Mock(return_value=True)
# Track written messages to simulate control protocol responses
written_messages = []
async def mock_write(data):
written_messages.append(data)
mock_transport.write.side_effect = mock_write
# Default read_messages to handle control protocol
async def control_protocol_generator():
# Wait for initialization request if needed
if with_init_response:
# Wait a bit for the write to happen
await asyncio.sleep(0.01)
# Check if initialization was requested
for msg_str in written_messages:
try:
msg = json.loads(msg_str.strip())
if (
msg.get("type") == "control_request"
and msg.get("request", {}).get("subtype") == "initialize"
):
# Send initialization response
yield {
"type": "control_response",
"response": {
"request_id": msg.get("request_id"),
"subtype": "success",
"commands": [],
"output_style": "default",
},
}
break
except (json.JSONDecodeError, KeyError, AttributeError):
pass
# Keep checking for other control requests (like interrupt)
last_check = len(written_messages)
timeout_counter = 0
while timeout_counter < 100: # Avoid infinite loop
await asyncio.sleep(0.01)
timeout_counter += 1
# Check for new messages
for msg_str in written_messages[last_check:]:
try:
msg = json.loads(msg_str.strip())
if msg.get("type") == "control_request":
subtype = msg.get("request", {}).get("subtype")
if subtype == "interrupt":
# Send interrupt response
yield {
"type": "control_response",
"response": {
"request_id": msg.get("request_id"),
"subtype": "success",
},
}
return # End after interrupt
except (json.JSONDecodeError, KeyError, AttributeError):
pass
last_check = len(written_messages)
# Then end the stream
return
mock_transport.read_messages = control_protocol_generator
return mock_transport
def _create_mock_transport_with_control_responses():
"""Create a mock transport that responds with success to all control requests.
Useful for testing client methods that send control requests (e.g.
reconnect_mcp_server, toggle_mcp_server) without needing to special-case
each subtype in the mock.
"""
mock_transport = AsyncMock()
mock_transport.connect = AsyncMock()
mock_transport.close = AsyncMock()
mock_transport.end_input = AsyncMock()
mock_transport.is_ready = Mock(return_value=True)
written_messages: list[str] = []
async def mock_write(data):
written_messages.append(data)
mock_transport.write = AsyncMock(side_effect=mock_write)
async def control_protocol_generator():
# Poll for control requests and respond with success to each one.
last_check = 0
timeout_counter = 0
while timeout_counter < 200: # Avoid infinite loop
await asyncio.sleep(0.01)
timeout_counter += 1
for msg_str in written_messages[last_check:]:
try:
msg = json.loads(msg_str.strip())
if msg.get("type") == "control_request":
yield {
"type": "control_response",
"response": {
"request_id": msg.get("request_id"),
"subtype": "success",
"response": {},
},
}
except (json.JSONDecodeError, KeyError, AttributeError):
pass
last_check = len(written_messages)
mock_transport.read_messages = control_protocol_generator
return mock_transport
class TestClaudeSDKClientStreaming:
"""Test ClaudeSDKClient streaming functionality."""
def test_auto_connect_with_context_manager(self):
"""Test automatic connection when using context manager."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = create_mock_transport()
mock_transport_class.return_value = mock_transport
async with ClaudeSDKClient() as client:
# Verify connect was called
mock_transport.connect.assert_called_once()
assert client._transport is mock_transport
# Verify disconnect was called on exit
mock_transport.close.assert_called_once()
anyio.run(_test)
def test_manual_connect_disconnect(self):
"""Test manual connect and disconnect."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = create_mock_transport()
mock_transport_class.return_value = mock_transport
client = ClaudeSDKClient()
await client.connect()
# Verify connect was called
mock_transport.connect.assert_called_once()
assert client._transport is mock_transport
await client.disconnect()
# Verify disconnect was called
mock_transport.close.assert_called_once()
assert client._transport is None
anyio.run(_test)
def test_connect_with_string_prompt(self):
"""Test connecting with a string prompt writes it as a user message."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = create_mock_transport()
mock_transport_class.return_value = mock_transport
client = ClaudeSDKClient()
await client.connect("Hello Claude")
# Verify the string prompt was written as a user message to stdin.
# Previously the string was stored but never sent, causing
# receive_messages() to hang indefinitely (#766).
user_messages = [
json.loads(call.args[0].strip())
for call in mock_transport.write.call_args_list
if '"type": "user"' in call.args[0]
]
assert len(user_messages) == 1
assert user_messages[0]["message"]["content"] == "Hello Claude"
assert user_messages[0]["session_id"] == "default"
anyio.run(_test)
def test_connect_with_async_iterable(self):
"""Test connecting with an async iterable."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = create_mock_transport()
mock_transport_class.return_value = mock_transport
async def message_stream():
yield {"type": "user", "message": {"role": "user", "content": "Hi"}}
yield {
"type": "user",
"message": {"role": "user", "content": "Bye"},
}
client = ClaudeSDKClient()
stream = message_stream()
await client.connect(stream)
# Verify transport was created with async iterable
call_kwargs = mock_transport_class.call_args.kwargs
# Should be the same async iterator
assert call_kwargs["prompt"] is stream
anyio.run(_test)
def test_query(self):
"""Test sending a query."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = create_mock_transport()
mock_transport_class.return_value = mock_transport
async with ClaudeSDKClient() as client:
await client.query("Test message")
# Verify write was called with correct format
# Should have at least 2 writes: init request and user message
assert mock_transport.write.call_count >= 2
# Find the user message in the write calls
user_msg_found = False
for call in mock_transport.write.call_args_list:
data = call[0][0]
try:
msg = json.loads(data.strip())
if msg.get("type") == "user":
assert msg["message"]["content"] == "Test message"
assert msg["session_id"] == "default"
user_msg_found = True
break
except (json.JSONDecodeError, KeyError, AttributeError):
pass
assert user_msg_found, "User message not found in write calls"
anyio.run(_test)
def test_send_message_with_session_id(self):
"""Test sending a message with custom session ID."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = create_mock_transport()
mock_transport_class.return_value = mock_transport
async with ClaudeSDKClient() as client:
await client.query("Test", session_id="custom-session")
# Find the user message with custom session ID
session_found = False
for call in mock_transport.write.call_args_list:
data = call[0][0]
try:
msg = json.loads(data.strip())
if msg.get("type") == "user":
assert msg["session_id"] == "custom-session"
session_found = True
break
except (json.JSONDecodeError, KeyError, AttributeError):
pass
assert session_found, "User message with custom session not found"
anyio.run(_test)
def test_send_message_not_connected(self):
"""Test sending message when not connected raises error."""
async def _test():
client = ClaudeSDKClient()
with pytest.raises(CLIConnectionError, match="Not connected"):
await client.query("Test")
anyio.run(_test)
def test_receive_messages(self):
"""Test receiving messages."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = create_mock_transport()
mock_transport_class.return_value = mock_transport
# Mock the message stream with control protocol support
async def mock_receive():
# First handle initialization
await asyncio.sleep(0.01)
written = mock_transport.write.call_args_list
for call in written:
data = call[0][0]
try:
msg = json.loads(data.strip())
if (
msg.get("type") == "control_request"
and msg.get("request", {}).get("subtype")
== "initialize"
):
yield {
"type": "control_response",
"response": {
"request_id": msg.get("request_id"),
"subtype": "success",
"commands": [],
"output_style": "default",
},
}
break
except (json.JSONDecodeError, KeyError, AttributeError):
pass
# Then yield the actual messages
yield {
"type": "assistant",
"message": {
"role": "assistant",
"content": [{"type": "text", "text": "Hello!"}],
"model": "claude-opus-4-1-20250805",
},
}
yield {
"type": "user",
"message": {"role": "user", "content": "Hi there"},
}
mock_transport.read_messages = mock_receive
async with ClaudeSDKClient() as client:
messages = []
async for msg in client.receive_messages():
messages.append(msg)
if len(messages) == 2:
break
assert len(messages) == 2
assert isinstance(messages[0], AssistantMessage)
assert isinstance(messages[0].content[0], TextBlock)
assert messages[0].content[0].text == "Hello!"
assert isinstance(messages[1], UserMessage)
assert messages[1].content == "Hi there"
anyio.run(_test)
def test_receive_response(self):
"""Test receive_response stops at ResultMessage."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = create_mock_transport()
mock_transport_class.return_value = mock_transport
# Mock the message stream with control protocol support
async def mock_receive():
# First handle initialization
await asyncio.sleep(0.01)
written = mock_transport.write.call_args_list
for call in written:
data = call[0][0]
try:
msg = json.loads(data.strip())
if (
msg.get("type") == "control_request"
and msg.get("request", {}).get("subtype")
== "initialize"
):
yield {
"type": "control_response",
"response": {
"request_id": msg.get("request_id"),
"subtype": "success",
"commands": [],
"output_style": "default",
},
}
break
except (json.JSONDecodeError, KeyError, AttributeError):
pass
# Then yield the actual messages
yield {
"type": "assistant",
"message": {
"role": "assistant",
"content": [{"type": "text", "text": "Answer"}],
"model": "claude-opus-4-1-20250805",
},
}
yield {
"type": "result",
"subtype": "success",
"duration_ms": 1000,
"duration_api_ms": 800,
"is_error": False,
"num_turns": 1,
"session_id": "test",
"total_cost_usd": 0.001,
}
# This should not be yielded
yield {
"type": "assistant",
"message": {
"role": "assistant",
"content": [
{"type": "text", "text": "Should not see this"}
],
},
"model": "claude-opus-4-1-20250805",
}
mock_transport.read_messages = mock_receive
async with ClaudeSDKClient() as client:
messages = []
async for msg in client.receive_response():
messages.append(msg)
# Should only get 2 messages (assistant + result)
assert len(messages) == 2
assert isinstance(messages[0], AssistantMessage)
assert isinstance(messages[1], ResultMessage)
anyio.run(_test)
def test_interrupt(self):
"""Test interrupt functionality."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = create_mock_transport()
mock_transport_class.return_value = mock_transport
async with ClaudeSDKClient() as client:
# Interrupt is now handled via control protocol
await client.interrupt()
# Check that a control request was sent via write
write_calls = mock_transport.write.call_args_list
interrupt_found = False
for call in write_calls:
data = call[0][0]
try:
msg = json.loads(data.strip())
if (
msg.get("type") == "control_request"
and msg.get("request", {}).get("subtype") == "interrupt"
):
interrupt_found = True
break
except (json.JSONDecodeError, KeyError, AttributeError):
pass
assert interrupt_found, "Interrupt control request not found"
anyio.run(_test)
def test_interrupt_not_connected(self):
"""Test interrupt when not connected raises error."""
async def _test():
client = ClaudeSDKClient()
with pytest.raises(CLIConnectionError, match="Not connected"):
await client.interrupt()
anyio.run(_test)
def test_reconnect_mcp_server(self):
"""Test reconnect_mcp_server sends correct control request."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = _create_mock_transport_with_control_responses()
mock_transport_class.return_value = mock_transport
async with ClaudeSDKClient() as client:
await client.reconnect_mcp_server("my-server")
# Check that a control request was sent via write
write_calls = mock_transport.write.call_args_list
request_found = False
for call in write_calls:
data = call[0][0]
try:
msg = json.loads(data.strip())
req = msg.get("request", {})
if (
msg.get("type") == "control_request"
and req.get("subtype") == "mcp_reconnect"
):
# Verify wire format uses camelCase serverName
assert req.get("serverName") == "my-server"
request_found = True
break
except (json.JSONDecodeError, KeyError, AttributeError):
pass
assert request_found, "mcp_reconnect control request not found"
anyio.run(_test)
def test_reconnect_mcp_server_not_connected(self):
"""Test reconnect_mcp_server when not connected raises error."""
async def _test():
client = ClaudeSDKClient()
with pytest.raises(CLIConnectionError, match="Not connected"):
await client.reconnect_mcp_server("my-server")
anyio.run(_test)
def test_toggle_mcp_server(self):
"""Test toggle_mcp_server sends correct control request."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = _create_mock_transport_with_control_responses()
mock_transport_class.return_value = mock_transport
async with ClaudeSDKClient() as client:
await client.toggle_mcp_server("my-server", False)
# Check that a control request was sent via write
write_calls = mock_transport.write.call_args_list
request_found = False
for call in write_calls:
data = call[0][0]
try:
msg = json.loads(data.strip())
req = msg.get("request", {})
if (
msg.get("type") == "control_request"
and req.get("subtype") == "mcp_toggle"
):
# Verify wire format uses camelCase serverName
assert req.get("serverName") == "my-server"
assert req.get("enabled") is False
request_found = True
break
except (json.JSONDecodeError, KeyError, AttributeError):
pass
assert request_found, "mcp_toggle control request not found"
anyio.run(_test)
def test_toggle_mcp_server_enabled_true(self):
"""Test toggle_mcp_server with enabled=True."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = _create_mock_transport_with_control_responses()
mock_transport_class.return_value = mock_transport
async with ClaudeSDKClient() as client:
await client.toggle_mcp_server("other-server", True)
write_calls = mock_transport.write.call_args_list
request_found = False
for call in write_calls:
data = call[0][0]
try:
msg = json.loads(data.strip())
req = msg.get("request", {})
if (
msg.get("type") == "control_request"
and req.get("subtype") == "mcp_toggle"
):
assert req.get("serverName") == "other-server"
assert req.get("enabled") is True
request_found = True
break
except (json.JSONDecodeError, KeyError, AttributeError):
pass
assert request_found, "mcp_toggle control request not found"
anyio.run(_test)
def test_toggle_mcp_server_not_connected(self):
"""Test toggle_mcp_server when not connected raises error."""
async def _test():
client = ClaudeSDKClient()
with pytest.raises(CLIConnectionError, match="Not connected"):
await client.toggle_mcp_server("my-server", True)
anyio.run(_test)
def test_stop_task(self):
"""Test stop_task sends correct control request with task_id."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = _create_mock_transport_with_control_responses()
mock_transport_class.return_value = mock_transport
async with ClaudeSDKClient() as client:
await client.stop_task("task-abc123")
# Check that a control request was sent via write
write_calls = mock_transport.write.call_args_list
request_found = False
for call in write_calls:
data = call[0][0]
try:
msg = json.loads(data.strip())
req = msg.get("request", {})
if (
msg.get("type") == "control_request"
and req.get("subtype") == "stop_task"
):
assert req.get("task_id") == "task-abc123"
request_found = True
break
except (json.JSONDecodeError, KeyError, AttributeError):
pass
assert request_found, (
"stop_task control request with task_id not found"
)
anyio.run(_test)
def test_stop_task_not_connected(self):
"""Test stop_task when not connected raises error."""
async def _test():
client = ClaudeSDKClient()
with pytest.raises(CLIConnectionError, match="Not connected"):
await client.stop_task("task-abc123")
anyio.run(_test)
def test_get_mcp_status(self):
"""Test get_mcp_status returns McpStatusResponse shape."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = AsyncMock()
mock_transport.connect = AsyncMock()
mock_transport.close = AsyncMock()
mock_transport.end_input = AsyncMock()
mock_transport.is_ready = Mock(return_value=True)
mock_transport_class.return_value = mock_transport
written_messages: list[str] = []
async def mock_write(data):
written_messages.append(data)
mock_transport.write = AsyncMock(side_effect=mock_write)
# Simulated mcp_status response matching McpServerStatus shape
mcp_status_response = {
"mcpServers": [
{
"name": "my-http-server",
"status": "connected",
"serverInfo": {
"name": "my-http-server",
"version": "1.0.0",
},
"config": {
"type": "http",
"url": "https://example.com/mcp",
},
"scope": "project",
"tools": [
{
"name": "greet",
"description": "Greet a user",
"annotations": {"readOnly": True},
},
{"name": "reset"},
],
},
{
"name": "failed-server",
"status": "failed",
"error": "Connection refused",
},
{
"name": "proxy-server",
"status": "needs-auth",
"config": {
"type": "claudeai-proxy",
"url": "https://claude.ai/proxy",
"id": "proxy-123",
},
},
]
}
async def control_protocol_generator():
last_check = 0
timeout_counter = 0
while timeout_counter < 200:
await asyncio.sleep(0.01)
timeout_counter += 1
for msg_str in written_messages[last_check:]:
try:
msg = json.loads(msg_str.strip())
if msg.get("type") == "control_request":
subtype = msg.get("request", {}).get("subtype")
if subtype == "initialize":
yield {
"type": "control_response",
"response": {
"request_id": msg.get("request_id"),
"subtype": "success",
"response": {},
},
}
elif subtype == "mcp_status":
yield {
"type": "control_response",
"response": {
"request_id": msg.get("request_id"),
"subtype": "success",
"response": mcp_status_response,
},
}
except (json.JSONDecodeError, KeyError, AttributeError):
pass
last_check = len(written_messages)
mock_transport.read_messages = control_protocol_generator
async with ClaudeSDKClient() as client:
status = await client.get_mcp_status()
# Verify response conforms to McpStatusResponse shape
assert "mcpServers" in status
servers = status["mcpServers"]
assert len(servers) == 3
# Connected server with full info
connected = servers[0]
assert connected["name"] == "my-http-server"
assert connected["status"] == "connected"
assert connected["serverInfo"]["version"] == "1.0.0"
assert connected["config"]["type"] == "http"
assert connected["config"]["url"] == "https://example.com/mcp"
assert connected["scope"] == "project"
assert len(connected["tools"]) == 2
assert connected["tools"][0]["name"] == "greet"
assert connected["tools"][0]["annotations"]["readOnly"] is True
# Tool without optional fields
assert connected["tools"][1]["name"] == "reset"
assert "description" not in connected["tools"][1]
# Failed server with error
failed = servers[1]
assert failed["name"] == "failed-server"
assert failed["status"] == "failed"
assert failed["error"] == "Connection refused"
# Server with claudeai-proxy config
proxy = servers[2]
assert proxy["name"] == "proxy-server"
assert proxy["status"] == "needs-auth"
assert proxy["config"]["type"] == "claudeai-proxy"
assert proxy["config"]["id"] == "proxy-123"
anyio.run(_test)
def test_get_mcp_status_not_connected(self):
"""Test get_mcp_status when not connected raises error."""
async def _test():
client = ClaudeSDKClient()
with pytest.raises(CLIConnectionError, match="Not connected"):
await client.get_mcp_status()
anyio.run(_test)
def test_get_context_usage(self):
"""Test get_context_usage returns ContextUsageResponse shape."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = AsyncMock()
mock_transport.connect = AsyncMock()
mock_transport.close = AsyncMock()
mock_transport.end_input = AsyncMock()
mock_transport.is_ready = Mock(return_value=True)
mock_transport_class.return_value = mock_transport
written_messages: list[str] = []
async def mock_write(data):
written_messages.append(data)
mock_transport.write = AsyncMock(side_effect=mock_write)
context_usage_response = {
"categories": [
{"name": "System prompt", "tokens": 3200, "color": "#abc"},
{"name": "Messages", "tokens": 61400, "color": "#def"},
],
"totalTokens": 98200,
"maxTokens": 155000,
"rawMaxTokens": 200000,
"percentage": 49.1,
"model": "claude-sonnet-4-5",
"isAutoCompactEnabled": True,
"memoryFiles": [
{"path": "CLAUDE.md", "type": "project", "tokens": 512}
],
"mcpTools": [
{
"name": "search",
"serverName": "ref",
"tokens": 164,
"isLoaded": True,
}
],
"agents": [{"agentType": "coder", "source": "sdk", "tokens": 299}],
"gridRows": [],
"apiUsage": None,
}
async def control_protocol_generator():
last_check = 0
timeout_counter = 0
while timeout_counter < 200:
await asyncio.sleep(0.01)
timeout_counter += 1
for msg_str in written_messages[last_check:]:
try:
msg = json.loads(msg_str.strip())
if msg.get("type") == "control_request":
subtype = msg.get("request", {}).get("subtype")
if subtype == "initialize":
yield {
"type": "control_response",
"response": {
"request_id": msg.get("request_id"),
"subtype": "success",
"response": {},
},
}
elif subtype == "get_context_usage":
yield {
"type": "control_response",
"response": {
"request_id": msg.get("request_id"),
"subtype": "success",
"response": context_usage_response,
},
}
except (json.JSONDecodeError, KeyError, AttributeError):
pass
last_check = len(written_messages)
mock_transport.read_messages = control_protocol_generator
async with ClaudeSDKClient() as client:
usage = await client.get_context_usage()
assert usage["totalTokens"] == 98200
assert usage["maxTokens"] == 155000
assert usage["percentage"] == 49.1
assert usage["model"] == "claude-sonnet-4-5"
assert usage["isAutoCompactEnabled"] is True
assert len(usage["categories"]) == 2
assert usage["categories"][0]["name"] == "System prompt"
assert usage["categories"][0]["tokens"] == 3200
assert usage["mcpTools"][0]["serverName"] == "ref"
assert usage["agents"][0]["tokens"] == 299
anyio.run(_test)
def test_get_context_usage_not_connected(self):
"""Test get_context_usage when not connected raises error."""
async def _test():
client = ClaudeSDKClient()
with pytest.raises(CLIConnectionError, match="Not connected"):
await client.get_context_usage()
anyio.run(_test)
def test_client_with_options(self):
"""Test client initialization with options."""
async def _test():
options = ClaudeAgentOptions(
cwd="/custom/path",
allowed_tools=["Read", "Write"],
system_prompt="Be helpful",
)
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = create_mock_transport()
mock_transport_class.return_value = mock_transport
client = ClaudeSDKClient(options=options)
await client.connect()
# Verify options were passed to transport
call_kwargs = mock_transport_class.call_args.kwargs
assert call_kwargs["options"] is options
anyio.run(_test)
def test_concurrent_send_receive(self):
"""Test concurrent sending and receiving messages."""
async def _test():
with patch(
"claude_agent_sdk._internal.transport.subprocess_cli.SubprocessCLITransport"
) as mock_transport_class:
mock_transport = create_mock_transport()
mock_transport_class.return_value = mock_transport
# Mock receive to wait then yield messages with control protocol support
async def mock_receive():
# First handle initialization
await asyncio.sleep(0.01)
written = mock_transport.write.call_args_list
for call in written:
if call:
data = call[0][0]
try:
msg = json.loads(data.strip())
if (
msg.get("type") == "control_request"
and msg.get("request", {}).get("subtype")
== "initialize"
):
yield {
"type": "control_response",