Files
clang-p2996/lldb/test/API/iohandler/completion/TestIOHandlerCompletion.py
Hiroki ffcf571107 [LLDB] Fix 'std::out_of_range' crashing bug when file name completion using file path.
When I run a lldb command that uses filename completion, if I enter a string
that is not only a filename but also a string with a non-file name string added,
such as "./" that is relative path string , it will crash as soon as I press the
[Tab] key. For example, debugging an executable file named "hello" that is
compiled from a file named "hello.c" , and I’ll put a breakpoint on line 3 of
hello.c.

```
$ lldb ./hello
(lldb) breakpoint set --file hello.c --line 3
```

This is not a problem, but if I set "--file ./hello."  and then press [Tab] key
to complete file name, lldb crashes.

```
$ lldb ./hello
(lldb) breakpoint set --file ./hello.terminate called after throwing an instance of 'std::out_of_range'
  what():  basic_string::substr: __pos (which is 8) > this->size() (which is 7)
```

The crash was caused because substr() (in lldb/source/Host/common/Editline.cpp)
cut out string which size is user's input string from the completion string.

I modified the code that erase the user's intput string from current line and
then add the completion string.

Differential Revision: https://reviews.llvm.org/D108817
2021-08-30 15:14:09 +02:00

73 lines
2.8 KiB
Python

"""
Test completion in our IOHandlers.
"""
import os
import lldb
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test.lldbpexpect import PExpectTest
class IOHandlerCompletionTest(PExpectTest):
mydir = TestBase.compute_mydir(__file__)
# PExpect uses many timeouts internally and doesn't play well
# under ASAN on a loaded machine..
@skipIfAsan
@skipIfEditlineSupportMissing
@expectedFailureAll(oslist=['freebsd'], bugnumber='llvm.org/pr49408')
@skipIf(oslist=["linux"], archs=["arm", "aarch64"])
def test_completion(self):
self.build()
self.launch(dimensions=(100,500), executable=self.getBuildArtifact("a.out"))
# Start tab completion, go to the next page and then display all with 'a'.
self.child.send("\t\ta")
self.child.expect_exact("register")
# Try tab completing regi to register.
self.child.send("regi\t")
# editline might move the cursor back to the start of the line and
# then back to its original position.
self.child.expect(re.compile(b"regi(\r" + self.cursor_forward_escape_seq(len(self.PROMPT + "regi")) + b")?ster"))
self.child.send("\n")
self.expect_prompt()
# Try tab completing directories and files. Also tests the partial
# completion where LLDB shouldn't print a space after the directory
# completion (as it didn't completed the full token).
dir_without_slashes = os.path.realpath(os.path.dirname(__file__)).rstrip("/")
self.child.send("file " + dir_without_slashes + "\t")
self.child.expect_exact("iohandler/completion/")
# If we get a correct partial completion without a trailing space, then this
# should complete the current test file.
self.child.send("TestIOHandler\t")
# As above, editline might move the cursor to the start of the line and
# then back to its original position. We only care about the fact
# that this is completing a partial completion, so skip the exact cursor
# position calculation.
self.child.expect(re.compile(b"TestIOHandler(\r" + self.cursor_forward_escape_seq("\d+") + b")?Completion.py"))
self.child.send("\n")
self.expect_prompt()
# Complete a file path.
# FIXME: This should complete to './main.c' and not 'main.c'
self.child.send("breakpoint set --file ./main\t")
self.child.expect_exact("main.c")
self.child.send("\n")
self.expect_prompt()
# Start tab completion and abort showing more commands with 'n'.
self.child.send("\t")
self.child.expect_exact("More (Y/n/a)")
self.child.send("n")
self.expect_prompt()
# Shouldn't crash or anything like that.
self.child.send("regoinvalid\t")
self.expect_prompt()
self.quit()