[lldb][test] Add SBExpressionOptions parameter to expect_expr

[Michael137]

Allows API tests to pass SBExpressionOptions when testing a successful expression evaluation with expect_expr. Currently one would have to use SBFrame::EvaluateExpression or pass the option as an argument to the raw command (via expect() or HandleCommand()).

Chose not to do the SetIgnoreBreakpoints/SetAutoApplyFixIts with the assumption that most expression evaluation tests don't actually need to care about these. If the options are passed explicitly, lets use them as-is. Otherwise default to the old options.

First usage of this new parameter would be in #177926

[llvmbot]

@llvm/pr-subscribers-lldb

Author: Michael Buch (Michael137)

Changes

Allows API tests to pass SBExpressionOptions when testing a successful expression evaluation with expect_expr. Currently one would have to use SBFrame::EvaluateExpression or pass the option as an argument to the raw command (via expect() or HandleCommand()).

Chose not to do the SetIgnoreBreakpoints/SetAutoApplyFixIts with the assumption that most expression evaluation tests don't actually need to care about these. If the options are passed explicitly, lets use them as-is. Otherwise default to the old options.

---

Full diff: https://github.com/llvm/llvm-project/pull/177920.diff

1 Files Affected:

• (modified) lldb/packages/Python/lldbsuite/test/lldbtest.py (+9-4)

diff --git a/lldb/packages/Python/lldbsuite/test/lldbtest.py b/lldb/packages/Python/lldbsuite/test/lldbtest.py
index 6bb4516948da5..b77d8e9fae3ab 100644
--- a/lldb/packages/Python/lldbsuite/test/lldbtest.py
+++ b/lldb/packages/Python/lldbsuite/test/lldbtest.py
@@ -2575,6 +2575,7 @@ def expect_expr(
         result_value=None,
         result_type=None,
         result_children=None,
+        options=None,
     ):
         """
         Evaluates the given expression and verifies the result.
@@ -2584,6 +2585,7 @@ def expect_expr(
         :param result_type: The type that the expression result should have. None if the type should not be checked.
         :param result_children: The expected children of the expression result
                                 as a list of ValueChecks. None if the children shouldn't be checked.
+        :param options: Expression evaluation options. None if a default set of options should be used.
         """
         self.assertTrue(
             expr.strip() == expr,
@@ -2593,11 +2595,14 @@ def expect_expr(
         frame = self.frame()
         options = lldb.SBExpressionOptions()
 
-        # Disable fix-its that tests don't pass by accident.
-        options.SetAutoApplyFixIts(False)
+        if not options:
+            options = lldb.SBExpressionOptions()
 
-        # Set the usual default options for normal expressions.
-        options.SetIgnoreBreakpoints(True)
+            # Disable fix-its that tests don't pass by accident.
+            options.SetAutoApplyFixIts(False)
+
+            # Set the usual default options for normal expressions.
+            options.SetIgnoreBreakpoints(True)
 
         if self.frame().IsValid():
             options.SetLanguage(frame.GuessLanguage())

[github-actions]

🐧 Linux x64 Test Results

• 33263 tests passed
• 506 tests skipped

✅ The build succeeded and all tests passed.

[DavidSpickett]

Allows API tests to pass SBExpressionOptions when testing a successful expression evaluation with expect_expr.

Which tests and for what reasons?

Change is fine code wise, but I don't immediately see what I'd do with this.

[Michael137]

Allows API tests to pass SBExpressionOptions when testing a successful expression evaluation with expect_expr.

Which tests and for what reasons?

Change is fine code wise, but I don't immediately see what I'd do with this.

I have an upcoming patch that adds an option to SBExpressionOptions. I would like to use expect_expr in those tests. Not super critical, but it makes the tests slightly nicer to read.

I'll wait on merging this PR once all the follow-up PRs are up, so there's examples of what it looks like