dotest: improvements to the pexpect tests

Summary:
While working on r370054, i've found it frustrating that the test output
was compeletely unhelpful in case of failures. Therefore I've decided to
improve that. In this I reuse the PExpectTest class, which was one of
our mechanisms for running pexpect tests, but which has gotten orhpaned
in the mean time.

I've replaced the existing send methods with a "expect" method, which
I've tried to design so that it has a similar interface to the expect
method in regular non-pexpect dotest tests (as it essentially does
something very similar). I've kept the ability to dump the transcript of
the pexpect communication to stdout in the "trace" mode, as that is a
very handy way to figure out what the test is doing. I've also removed
the "expect_string" method used in the existing tests -- I've found this
to be unhelpful because it hides the message that would be normally
displayed by the EOF exception. Although vebose, this message includes
some important information, like what strings we were searching for,
what were the last bits of lldb output, etc. I've also beefed up the
class to automatically disable the debug info test duplication, and
auto-skip tests when the host platform does not support pexpect.

This patch ports TestMultilineCompletion and TestIOHandlerCompletion to
the new class. It also deletes TestFormats as it is not testing anything
(definitely not formats) -- it was committed with the test code
commented out (r228207), and then the testing code was deleted in
r356000.

Reviewers: teemperor, JDevlieghere, davide

Subscribers: aprantl, lldb-commits

Differential Revision: https://reviews.llvm.org/D66954

llvm-svn: 370449

1 files changed, 13 insertions, 37 deletions

diff --git a/lldb/packages/Python/lldbsuite/test/iohandler/completion/TestIOHandlerCompletion.py b/lldb/packages/Python/lldbsuite/test/iohandler/completion/TestIOHandlerCompletion.py
index a1c07a3b045..d202887902e 100644
--- a/lldb/packages/Python/lldbsuite/test/iohandler/completion/TestIOHandlerCompletion.py
+++ b/lldb/packages/Python/lldbsuite/test/iohandler/completion/TestIOHandlerCompletion.py
@@ -7,70 +7,46 @@ import os
 import lldb
 from lldbsuite.test.decorators import *
 from lldbsuite.test.lldbtest import *
+from lldbsuite.test.lldbpexpect import PExpectTest
 
-class IOHandlerCompletionTest(TestBase):
+class IOHandlerCompletionTest(PExpectTest):
 
     mydir = TestBase.compute_mydir(__file__)
-    NO_DEBUG_INFO_TESTCASE = True
 
-    def setUp(self):
-        TestBase.setUp(self)
-
-    def expect_string(self, string):
-        import pexpect
-        """This expects for "string", with timeout & EOF being test fails."""
-        try:
-            self.child.expect_exact(string)
-        except pexpect.EOF:
-            self.fail("Got EOF waiting for '%s'" % (string))
-        except pexpect.TIMEOUT:
-            self.fail("Timed out waiting for '%s'" % (string))
-
-    @expectedFailureAll(
-        oslist=["windows"],
-        bugnumber="llvm.org/pr22274: need a pexpect replacement for windows")
     def test_completion(self):
-        self.setTearDownCleanup()
-
-        import pexpect
-        exe = self.getBuildArtifact("a.out")
-        prompt = "(lldb) "
-
-        self.child = pexpect.spawn(
-            '%s %s %s %s' %
-            (lldbtest_config.lldbExec, self.lldbOption, "", exe),
-            dimensions=(100, 500))
+        self.launch(dimensions=(100,500))
 
-        self.expect_string(prompt)
         # Start tab completion, go to the next page and then display all with 'a'.
         self.child.send("\t\ta")
-        self.expect_string("register")
+        self.child.expect_exact("register")
 
         # Try tab completing regi to register.
         self.child.send("regi\t")
-        self.expect_string(prompt + "register")
+        self.child.expect_exact(self.PROMPT + "register")
         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.expect_string("iohandler/completion/")
+        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")
-        self.expect_string("TestIOHandlerCompletion.py")
+        self.child.expect_exact("TestIOHandlerCompletion.py")
         self.child.send("\n")
+        self.expect_prompt()
 
         # Start tab completion and abort showing more commands with 'n'.
         self.child.send("\t")
-        self.expect_string("More (Y/n/a)")
+        self.child.expect_exact("More (Y/n/a)")
         self.child.send("n")
-        self.expect_string(prompt)
+        self.expect_prompt()
 
         # Shouldn't crash or anything like that.
         self.child.send("regoinvalid\t")
-        self.expect_string(prompt)
+        self.expect_prompt()
 
-        self.deletePexpectChild()
+        self.quit()