[Lldb-commits] [lldb] [lldb] Improve completion tests (PR #65973)
David Spickett via lldb-commits
lldb-commits at lists.llvm.org
Mon Sep 11 10:24:53 PDT 2023
https://github.com/DavidSpickett updated https://github.com/llvm/llvm-project/pull/65973:
>From ea172bdf8b1d66087076b7ed842021749a49b9fb Mon Sep 17 00:00:00 2001
From: David Spickett <david.spickett at linaro.org>
Date: Mon, 11 Sep 2023 09:09:31 +0000
Subject: [PATCH 1/3] [lldb] Improve completion tests
* Assert no completions for tests that should not find completions.
* Remove regex mode from complete_from_to, which was unused.
This exposed bugs in 2 of the tests, target stop-hook and
process unload. These were fixed in previous commits but
couldn't be tested properly until this patch.
---
.../Python/lldbsuite/test/lldbtest.py | 30 +++---
.../completion/TestExprCompletion.py | 92 +++++++++----------
.../completion/TestCompletion.py | 14 +--
3 files changed, 62 insertions(+), 74 deletions(-)
diff --git a/lldb/packages/Python/lldbsuite/test/lldbtest.py b/lldb/packages/Python/lldbsuite/test/lldbtest.py
index 49355d61911837f..4f8bdcd7263dc35 100644
--- a/lldb/packages/Python/lldbsuite/test/lldbtest.py
+++ b/lldb/packages/Python/lldbsuite/test/lldbtest.py
@@ -2223,10 +2223,7 @@ def check_completion_with_desc(
)
self.assertFalse(got_failure, error_msg)
- def complete_exactly(self, str_input, patterns):
- self.complete_from_to(str_input, patterns, True)
-
- def complete_from_to(self, str_input, patterns, turn_off_re_match=False):
+ def complete_from_to(self, str_input, patterns):
"""Test that the completion mechanism completes str_input to patterns,
where patterns could be a pattern-string or a list of pattern-strings"""
# Patterns should not be None in order to proceed.
@@ -2254,21 +2251,18 @@ def complete_from_to(self, str_input, patterns, turn_off_re_match=False):
for idx in range(1, num_matches + 1):
compare_string += match_strings.GetStringAtIndex(idx) + "\n"
+ # If the singular pattern is the same as the input, assume that we
+ # shouldn't have any completions.
+ if len(patterns) == 1 and str_input == patterns[0] and num_matches:
+ self.fail("Expected no completions but got:\n" + compare_string)
+
for p in patterns:
- if turn_off_re_match:
- self.expect(
- compare_string,
- msg=COMPLETION_MSG(str_input, p, match_strings),
- exe=False,
- substrs=[p],
- )
- else:
- self.expect(
- compare_string,
- msg=COMPLETION_MSG(str_input, p, match_strings),
- exe=False,
- patterns=[p],
- )
+ self.expect(
+ compare_string,
+ msg=COMPLETION_MSG(str_input, p, match_strings),
+ exe=False,
+ substrs=[p],
+ )
def completions_match(self, command, completions):
"""Checks that the completions for the given command are equal to the
diff --git a/lldb/test/API/commands/expression/completion/TestExprCompletion.py b/lldb/test/API/commands/expression/completion/TestExprCompletion.py
index 3c354a3bce1a9b5..ada818989c789a1 100644
--- a/lldb/test/API/commands/expression/completion/TestExprCompletion.py
+++ b/lldb/test/API/commands/expression/completion/TestExprCompletion.py
@@ -29,34 +29,34 @@ def test_expr_completion(self):
)
# Completing member functions
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr.FooNoArgs", "expr some_expr.FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr.FooWithArgs", "expr some_expr.FooWithArgsBar("
)
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr.FooWithMultipleArgs",
"expr some_expr.FooWithMultipleArgsBar(",
)
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr.FooUnderscore", "expr some_expr.FooUnderscoreBar_()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr.FooNumbers", "expr some_expr.FooNumbersBar1()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr.StaticMemberMethod",
"expr some_expr.StaticMemberMethodBar()",
)
# Completing static functions
- self.complete_exactly(
+ self.complete_from_to(
"expr Expr::StaticMemberMethod", "expr Expr::StaticMemberMethodBar()"
)
# Completing member variables
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr.MemberVariab", "expr some_expr.MemberVariableBar"
)
@@ -94,43 +94,43 @@ def test_expr_completion(self):
self.completions_contain("expr 1+", ["1+some_expr", "1+static_cast"])
# Test with spaces
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr .FooNoArgs", "expr some_expr .FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr .FooNoArgs", "expr some_expr .FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr .FooNoArgs", "expr some_expr .FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr. FooNoArgs", "expr some_expr. FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr . FooNoArgs", "expr some_expr . FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr Expr :: StaticMemberMethod", "expr Expr :: StaticMemberMethodBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr Expr ::StaticMemberMethod", "expr Expr ::StaticMemberMethodBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr Expr:: StaticMemberMethod", "expr Expr:: StaticMemberMethodBar()"
)
# Test that string literals don't break our parsing logic.
- self.complete_exactly(
+ self.complete_from_to(
'expr const char *cstr = "some_e"; char c = *cst',
'expr const char *cstr = "some_e"; char c = *cstr',
)
- self.complete_exactly(
+ self.complete_from_to(
'expr const char *cstr = "some_e" ; char c = *cst',
'expr const char *cstr = "some_e" ; char c = *cstr',
)
# Requesting completions inside an incomplete string doesn't provide any
# completions.
- self.complete_exactly(
+ self.complete_from_to(
'expr const char *cstr = "some_e', 'expr const char *cstr = "some_e'
)
@@ -139,110 +139,110 @@ def test_expr_completion(self):
self.assume_no_completions("expr -i0 -- some_expr.", 11)
# Test with expr arguments
- self.complete_exactly(
+ self.complete_from_to(
"expr -i0 -- some_expr .FooNoArgs", "expr -i0 -- some_expr .FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr -i0 -- some_expr .FooNoArgs",
"expr -i0 -- some_expr .FooNoArgsBar()",
)
# Addrof and deref
- self.complete_exactly(
+ self.complete_from_to(
"expr (*(&some_expr)).FooNoArgs", "expr (*(&some_expr)).FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr (*(&some_expr)) .FooNoArgs", "expr (*(&some_expr)) .FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr (* (&some_expr)) .FooNoArgs", "expr (* (&some_expr)) .FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr (* (& some_expr)) .FooNoArgs",
"expr (* (& some_expr)) .FooNoArgsBar()",
)
# Addrof and deref (part 2)
- self.complete_exactly(
+ self.complete_from_to(
"expr (&some_expr)->FooNoArgs", "expr (&some_expr)->FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr (&some_expr) ->FooNoArgs", "expr (&some_expr) ->FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr (&some_expr) -> FooNoArgs", "expr (&some_expr) -> FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr (&some_expr)-> FooNoArgs", "expr (&some_expr)-> FooNoArgsBar()"
)
# Builtin arg
- self.complete_exactly("expr static_ca", "expr static_cast")
+ self.complete_from_to("expr static_ca", "expr static_cast")
# From other files
- self.complete_exactly(
+ self.complete_from_to(
"expr fwd_decl_ptr->Hidden", "expr fwd_decl_ptr->HiddenMember"
)
# Types
- self.complete_exactly("expr LongClassNa", "expr LongClassName")
- self.complete_exactly(
+ self.complete_from_to("expr LongClassNa", "expr LongClassName")
+ self.complete_from_to(
"expr LongNamespaceName::NestedCla", "expr LongNamespaceName::NestedClass"
)
# Namespaces
- self.complete_exactly("expr LongNamespaceNa", "expr LongNamespaceName::")
+ self.complete_from_to("expr LongNamespaceNa", "expr LongNamespaceName::")
# Multiple arguments
- self.complete_exactly(
+ self.complete_from_to(
"expr &some_expr + &some_e", "expr &some_expr + &some_expr"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr SomeLongVarNameWithCapitals + SomeLongVarName",
"expr SomeLongVarNameWithCapitals + SomeLongVarNameWithCapitals",
)
- self.complete_exactly(
+ self.complete_from_to(
"expr SomeIntVar + SomeIntV", "expr SomeIntVar + SomeIntVar"
)
# Multiple statements
- self.complete_exactly(
+ self.complete_from_to(
"expr long LocalVariable = 0; LocalVaria",
"expr long LocalVariable = 0; LocalVariable",
)
# Custom Decls
- self.complete_exactly(
+ self.complete_from_to(
"expr auto l = [](int LeftHandSide, int bx){ return LeftHandS",
"expr auto l = [](int LeftHandSide, int bx){ return LeftHandSide",
)
- self.complete_exactly(
+ self.complete_from_to(
"expr struct LocalStruct { long MemberName; } ; LocalStruct S; S.Mem",
"expr struct LocalStruct { long MemberName; } ; LocalStruct S; S.MemberName",
)
# Completing function call arguments
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr.FooWithArgsBar(some_exp",
"expr some_expr.FooWithArgsBar(some_expr",
)
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr.FooWithArgsBar(SomeIntV",
"expr some_expr.FooWithArgsBar(SomeIntVar",
)
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr.FooWithMultipleArgsBar(SomeIntVar, SomeIntVa",
"expr some_expr.FooWithMultipleArgsBar(SomeIntVar, SomeIntVar",
)
# Function return values
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr.Self().FooNoArgs", "expr some_expr.Self().FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr.Self() .FooNoArgs", "expr some_expr.Self() .FooNoArgsBar()"
)
- self.complete_exactly(
+ self.complete_from_to(
"expr some_expr.Self(). FooNoArgs", "expr some_expr.Self(). FooNoArgsBar()"
)
diff --git a/lldb/test/API/functionalities/completion/TestCompletion.py b/lldb/test/API/functionalities/completion/TestCompletion.py
index cc2a20dcd0dca76..8898bf2e2b5da9e 100644
--- a/lldb/test/API/functionalities/completion/TestCompletion.py
+++ b/lldb/test/API/functionalities/completion/TestCompletion.py
@@ -237,16 +237,13 @@ def test_log_dir(self):
src_dir = os.path.dirname(os.path.realpath(__file__))
self.complete_from_to(
"log enable lldb expr -f " + src_dir,
- [src_dir + os.sep],
- turn_off_re_match=True,
- )
+ [src_dir + os.sep])
# <rdar://problem/11052829>
def test_infinite_loop_while_completing(self):
"""Test that 'process print hello\' completes to itself and does not infinite loop."""
self.complete_from_to(
- "process print hello\\", "process print hello\\", turn_off_re_match=True
- )
+ "process print hello\\", "process print hello\\")
def test_watchpoint_co(self):
"""Test that 'watchpoint co' completes to 'watchpoint command '."""
@@ -727,9 +724,7 @@ def test_symbol_name(self):
self.dbg.CreateTarget(self.getBuildArtifact("a.out"))
self.complete_from_to(
"breakpoint set -n Fo",
- "breakpoint set -n Foo::Bar(int,\\ int)",
- turn_off_re_match=True,
- )
+ "breakpoint set -n Foo::Bar(int,\\ int)")
# No completion for Qu because the candidate is
# (anonymous namespace)::Quux().
self.complete_from_to("breakpoint set -n Qu", "")
@@ -822,8 +817,7 @@ def test_common_completion_target_stophook_ids(self):
for subcommand in subcommands:
self.complete_from_to(
"target stop-hook " + subcommand + " 1 ",
- "target stop-hook " + subcommand + " 1 ",
- )
+ "target stop-hook " + subcommand + " 1 ")
def test_common_completion_type_language(self):
self.complete_from_to("type category -l ", ["c"])
>From 15228bc0a2311df5b422b0878fd7da23ad480d6e Mon Sep 17 00:00:00 2001
From: David Spickett <david.spickett at linaro.org>
Date: Mon, 11 Sep 2023 16:17:03 +0000
Subject: [PATCH 2/3] Format with black
---
.../functionalities/completion/TestCompletion.py | 14 ++++++--------
1 file changed, 6 insertions(+), 8 deletions(-)
diff --git a/lldb/test/API/functionalities/completion/TestCompletion.py b/lldb/test/API/functionalities/completion/TestCompletion.py
index 8898bf2e2b5da9e..e01bc0ce03f5c95 100644
--- a/lldb/test/API/functionalities/completion/TestCompletion.py
+++ b/lldb/test/API/functionalities/completion/TestCompletion.py
@@ -235,15 +235,12 @@ def test_log_file(self):
def test_log_dir(self):
# Complete our source directory.
src_dir = os.path.dirname(os.path.realpath(__file__))
- self.complete_from_to(
- "log enable lldb expr -f " + src_dir,
- [src_dir + os.sep])
+ self.complete_from_to("log enable lldb expr -f " + src_dir, [src_dir + os.sep])
# <rdar://problem/11052829>
def test_infinite_loop_while_completing(self):
"""Test that 'process print hello\' completes to itself and does not infinite loop."""
- self.complete_from_to(
- "process print hello\\", "process print hello\\")
+ self.complete_from_to("process print hello\\", "process print hello\\")
def test_watchpoint_co(self):
"""Test that 'watchpoint co' completes to 'watchpoint command '."""
@@ -723,8 +720,8 @@ def test_symbol_name(self):
self.build()
self.dbg.CreateTarget(self.getBuildArtifact("a.out"))
self.complete_from_to(
- "breakpoint set -n Fo",
- "breakpoint set -n Foo::Bar(int,\\ int)")
+ "breakpoint set -n Fo", "breakpoint set -n Foo::Bar(int,\\ int)"
+ )
# No completion for Qu because the candidate is
# (anonymous namespace)::Quux().
self.complete_from_to("breakpoint set -n Qu", "")
@@ -817,7 +814,8 @@ def test_common_completion_target_stophook_ids(self):
for subcommand in subcommands:
self.complete_from_to(
"target stop-hook " + subcommand + " 1 ",
- "target stop-hook " + subcommand + " 1 ")
+ "target stop-hook " + subcommand + " 1 ",
+ )
def test_common_completion_type_language(self):
self.complete_from_to("type category -l ", ["c"])
>From d9dee5407ec2ef8f76c82b4aef62b3b324335966 Mon Sep 17 00:00:00 2001
From: David Spickett <david.spickett at linaro.org>
Date: Mon, 11 Sep 2023 17:24:29 +0000
Subject: [PATCH 3/3] Move comment to docstring.
---
lldb/packages/Python/lldbsuite/test/lldbtest.py | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/lldb/packages/Python/lldbsuite/test/lldbtest.py b/lldb/packages/Python/lldbsuite/test/lldbtest.py
index 4f8bdcd7263dc35..50e8ad08a9d8e89 100644
--- a/lldb/packages/Python/lldbsuite/test/lldbtest.py
+++ b/lldb/packages/Python/lldbsuite/test/lldbtest.py
@@ -2225,7 +2225,13 @@ def check_completion_with_desc(
def complete_from_to(self, str_input, patterns):
"""Test that the completion mechanism completes str_input to patterns,
- where patterns could be a pattern-string or a list of pattern-strings"""
+ where patterns could be a single pattern-string or a list of
+ pattern-strings.
+
+ If there is only one pattern and it is exactly equal to str_input, this
+ assumes that there should be no completions provided and that the result
+ should be the same as the input."""
+
# Patterns should not be None in order to proceed.
self.assertFalse(patterns is None)
# And should be either a string or list of strings. Check for list type
@@ -2251,8 +2257,6 @@ def complete_from_to(self, str_input, patterns):
for idx in range(1, num_matches + 1):
compare_string += match_strings.GetStringAtIndex(idx) + "\n"
- # If the singular pattern is the same as the input, assume that we
- # shouldn't have any completions.
if len(patterns) == 1 and str_input == patterns[0] and num_matches:
self.fail("Expected no completions but got:\n" + compare_string)
More information about the lldb-commits
mailing list