Skip to content

[lldb-dap] Adding exception handling for dap server disconnect and terminations in lldbdap_testcase.py #155335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

[lldb-dap] Adding exception handling for dap server disconnect and terminations in lldbdap_testcase.py #155335

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
443c2b4
Improving lldbdap server error diagnosability and adding exception ha…
Aug 26, 2025
1c68d3f
spliting into 2 PRs and consolidating exeptions
Aug 26, 2025
6a2c9a7
Using addTearDownHook and formatting
Aug 26, 2025
8795455
Merge branch 'main' into lldbdap
piyushjaiswal98 Aug 27, 2025
4765008
Merge branch 'main' into lldbdap
piyushjaiswal98 Aug 27, 2025
ca1e606
Merge branch 'main' into lldbdap
piyushjaiswal98 Aug 27, 2025
dbb55a9
Merge branch 'main' into lldbdap
piyushjaiswal98 Aug 27, 2025
de5efe2
Merge branch 'main' into lldbdap
piyushjaiswal98 Aug 27, 2025
e36edb7
Reverting to original format
Aug 28, 2025
0cedbbf
Merge branch 'main' into lldbdap
piyushjaiswal98 Aug 28, 2025
68eddcb
Format document
Aug 28, 2025
3f0102d
Merge branch 'main' into lldbdap
piyushjaiswal98 Aug 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 17 additions & 14 deletions lldb/packages/Python/lldbsuite/test/tools/lldb-dap/lldbdap_testcase.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,20 @@ def disassemble(self, threadId=None, frameIndex=None):

return disassembled_instructions, disassembled_instructions[memoryReference]

def dapCleanup(self, disconnectAutomatically):
if disconnectAutomatically:
try:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is swallowing any exceptions that can occur in either request_disconnect or terminate, which is different behavior than the version originally approved by @walter-erquinigo and @ashgti.

@piyushjaiswal98 says that the teardown hooks are actually processed in LIFO order instead of FIFO order as expected which is why he changed it to catching them. Is there a better way to handle the exceptions here?

Can we use try-finally instead?

def dapCleanup(self, disconnectAutomatically):
    try:
        if disconnectAutomatically:
            self.dap_server.request_disconnect(terminateDebuggee=True)
    finally:
        self.dap_server.terminate()

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's a good idea

self.dap_server.request_disconnect(terminateDebuggee=True)
except Exception as e:
# DAP server might not be responsive, skip disconnect and terminate directly
print(
f"Warning: disconnect failed ({e}), skipping and terminating directly"
)
try:
self.dap_server.terminate()
except Exception as e:
print(f"Warning: terminate failed ({e}), DAP server may have already died")

def _build_error_message(self, base_message, response):
"""Build a detailed error message from a DAP response.
Extracts error information from various possible locations in the response structure.
Expand Down Expand Up @@ -483,13 +497,8 @@ def attach(

# Make sure we disconnect and terminate the DAP debug adapter even
# if we throw an exception during the test case.
def cleanup():
if disconnectAutomatically:
self.dap_server.request_disconnect(terminateDebuggee=True)
self.dap_server.terminate()
self.addTearDownHook(lambda: self.dapCleanup(disconnectAutomatically))

# Execute the cleanup function during test case tear down.
self.addTearDownHook(cleanup)
# Initialize and launch the program
self.dap_server.request_initialize(sourceInitFile)
response = self.dap_server.request_attach(**kwargs)
Expand All @@ -511,14 +520,8 @@ def launch(
"""Sending launch request to dap"""

# Make sure we disconnect and terminate the DAP debug adapter,
# if we throw an exception during the test case
def cleanup():
if disconnectAutomatically:
self.dap_server.request_disconnect(terminateDebuggee=True)
self.dap_server.terminate()

# Execute the cleanup function during test case tear down.
self.addTearDownHook(cleanup)
# if we throw an exception during the test case.
self.addTearDownHook(lambda: self.dapCleanup(disconnectAutomatically))

# Initialize and launch the program
self.dap_server.request_initialize(sourceInitFile)
Expand Down
Loading