|
| 1 | + |
| 2 | +import pytest |
| 3 | +from dap.client import DAPClient, ClientState |
| 4 | +from dap.events import InitializedEvent, StoppedEvent, TerminatedEvent |
| 5 | +from dap.protocol import Response |
| 6 | +import json |
| 7 | + |
| 8 | +def _make_response_bytes(seq, request_seq, command, success=True, body=None): |
| 9 | + content = { |
| 10 | + "type": "response", |
| 11 | + "seq": seq, |
| 12 | + "request_seq": request_seq, |
| 13 | + "command": command, |
| 14 | + "success": success, |
| 15 | + } |
| 16 | + if body: |
| 17 | + content["body"] = body |
| 18 | + |
| 19 | + encoded = json.dumps(content).encode("utf-8") |
| 20 | + header = f"Content-Length: {len(encoded)}\r\n\r\n".encode("utf-8") |
| 21 | + return header + encoded |
| 22 | + |
| 23 | +def _make_event_bytes(seq, event_name, body=None): |
| 24 | + content = { |
| 25 | + "type": "event", |
| 26 | + "seq": seq, |
| 27 | + "event": event_name, |
| 28 | + } |
| 29 | + if body: |
| 30 | + content["body"] = body |
| 31 | + |
| 32 | + encoded = json.dumps(content).encode("utf-8") |
| 33 | + header = f"Content-Length: {len(encoded)}\r\n\r\n".encode("utf-8") |
| 34 | + return header + encoded |
| 35 | + |
| 36 | +def test_full_lifecycle(): |
| 37 | + """Test a full debug session lifecycle.""" |
| 38 | + client = DAPClient(clientID="test", clientName="Test") |
| 39 | + |
| 40 | + # 1. Initialize |
| 41 | + init_req_bytes = client.send() |
| 42 | + # Expect seq 0 |
| 43 | + |
| 44 | + # Adapter responds to initialize (seq=0) |
| 45 | + response_bytes = _make_response_bytes(seq=1, request_seq=0, command="initialize", body={"supportsConfigurationDoneRequest": True}) |
| 46 | + events = list(client.recv(response_bytes)) |
| 47 | + |
| 48 | + assert len(events) == 1 |
| 49 | + assert isinstance(events[0], InitializedEvent) |
| 50 | + |
| 51 | + # 2. Launch |
| 52 | + client.launch(program="main.py") |
| 53 | + client.send() # flush |
| 54 | + # Expect seq 1 |
| 55 | + |
| 56 | + # Adapter responds to launch (seq=1) |
| 57 | + response_bytes = _make_response_bytes(seq=2, request_seq=1, command="launch") |
| 58 | + events = list(client.recv(response_bytes)) |
| 59 | + |
| 60 | + print(f"Launch response event: {events[0]}") |
| 61 | + assert events[0].event == "response" |
| 62 | + assert events[0].body["command"] == "launch" |
| 63 | + |
| 64 | + # 3. Configuration Done |
| 65 | + client.configuration_done() |
| 66 | + client.send() # flush |
| 67 | + # Expect seq 2 |
| 68 | + |
| 69 | + response_bytes = _make_response_bytes(seq=3, request_seq=2, command="configurationDone") |
| 70 | + list(client.recv(response_bytes)) |
| 71 | + |
| 72 | + # 4. Breakpoint Hit |
| 73 | + stop_event_bytes = _make_event_bytes(seq=4, event_name="stopped", body={"reason": "breakpoint", "threadId": 1}) |
| 74 | + events = list(client.recv(stop_event_bytes)) |
| 75 | + assert events[0].event == "stopped" |
| 76 | + |
| 77 | + # 5. Continue |
| 78 | + client.continue_execution(threadId=1) |
| 79 | + client.send() |
| 80 | + # Expect seq 3 |
| 81 | + |
| 82 | + response_bytes = _make_response_bytes(seq=5, request_seq=3, command="continue") |
| 83 | + list(client.recv(response_bytes)) |
| 84 | + |
| 85 | + # 6. Disconnect |
| 86 | + client.disconnect() |
| 87 | + client.send() |
| 88 | + # Expect seq 4 |
| 89 | + |
| 90 | + print(f"Unanswered requests before disconnect response: {client._unanswered_requests}") |
| 91 | + |
| 92 | + response_bytes = _make_response_bytes(seq=6, request_seq=4, command="disconnect") |
| 93 | + events = list(client.recv(response_bytes)) |
| 94 | + |
| 95 | + print(f"Disconnect events: {events}") |
| 96 | + |
| 97 | + assert len(events) == 1 |
| 98 | + assert isinstance(events[0], TerminatedEvent) or events[0].event == "terminated" |
| 99 | + |
| 100 | +def test_unsolicited_events(): |
| 101 | + """Test parsing events that come without a request.""" |
| 102 | + client = DAPClient() |
| 103 | + client.send() |
| 104 | + |
| 105 | + out_evt_bytes = _make_event_bytes(seq=1, event_name="output", body={"category": "stdout", "output": "Hello World\n"}) |
| 106 | + events = list(client.recv(out_evt_bytes)) |
| 107 | + |
| 108 | + assert len(events) == 1 |
| 109 | + assert events[0].event == "output" |
| 110 | + assert events[0].body["output"] == "Hello World\n" |
| 111 | + |
| 112 | +def test_request_methods(): |
| 113 | + """Test helper methods for sending requests.""" |
| 114 | + client = DAPClient() |
| 115 | + client.send() |
| 116 | + client._state = ClientState.NORMAL |
| 117 | + |
| 118 | + client.next(threadId=1) |
| 119 | + req = client.send() |
| 120 | + assert b'"command": "next"' in req |
| 121 | + assert b'"threadId": 1' in req |
0 commit comments